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.143 by root, Sun Jan 7 02:39:14 2007 UTC vs.
Revision 1.494 by root, Mon Oct 26 05:18:00 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 (Coro::PRIO_MAX); # 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 %PLAYER; # all users 132our (%PLAYER, %PLAYER_LOADING); # all users
53our %MAP; # all maps 133our (%MAP, %MAP_LOADING ); # all maps
54our $LINK_MAP; # the special {link} map 134our $LINK_MAP; # the special {link} map, which is always available
55our $RANDOM_MAPS = cf::localdir . "/random"; 135
56our %EXT_CORO; # coroutines bound to extensions 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 :)
57 148
58binmode STDOUT; 149binmode STDOUT;
59binmode STDERR; 150binmode STDERR;
60 151
61# read virtual server time, if available 152# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") { 153unless ($RUNTIME || !-e $RUNTIMEFILE) {
63 open my $fh, "<", cf::localdir . "/runtime" 154 open my $fh, "<", $RUNTIMEFILE
64 or die "unable to read runtime file: $!"; 155 or die "unable to read $RUNTIMEFILE file: $!";
65 $RUNTIME = <$fh> + 0.; 156 $RUNTIME = <$fh> + 0.;
66} 157}
67 158
68mkdir cf::localdir; 159eval "sub TICK() { $TICK } 1" or die;
69mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73 160
74# a special map that is always available 161mkdir $_
75our $LINK_MAP; 162 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
163
76our $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::"} };
77 178
78############################################################################# 179#############################################################################
79 180
80=head2 GLOBAL VARIABLES 181=head2 GLOBAL VARIABLES
81 182
88=item $cf::RUNTIME 189=item $cf::RUNTIME
89 190
90The 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
91every server tick. 192every server tick.
92 193
93=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
94 197
95The perl library directory, where extensions and cf-specific modules can 198Various directories - "/etc", read-only install directory, perl-library
96be 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.
97 202
98=item $cf::NOW 203=item $cf::NOW
99 204
100The time of the last (current) server tick. 205The time of the last (current) server tick.
101 206
102=item $cf::TICK 207=item $cf::TICK
103 208
104The interval between server ticks, in seconds. 209The interval between server ticks, in seconds.
105 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
106=item %cf::CFG 221=item %cf::CFG
107 222
108Configuration for the server, loaded from C</etc/crossfire/config>, or 223Configuration for the server, loaded from C</etc/deliantra-server/config>, or
109from wherever your confdir points to. 224from wherever your confdir points to.
110 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
111=back 244=back
112 245
113=cut 246=cut
114 247
115BEGIN { 248$Coro::State::WARNHOOK = sub {
116 *CORE::GLOBAL::warn = sub {
117 my $msg = join "", @_; 249 my $msg = join "", @_;
118 utf8::encode $msg;
119 250
120 $msg .= "\n" 251 $msg .= "\n"
121 unless $msg =~ /\n$/; 252 unless $msg =~ /\n$/;
122 253
254 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
255
123 LOG llevError, "cfperl: $msg"; 256 LOG llevError, $msg;
124 }; 257};
125} 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};
126 272
127@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 273@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
128@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 274@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
129@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 275@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
130@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 276@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
131@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';
132@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)
133 280
134# 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
135# within the Safe compartment. 282# within the Safe compartment.
136for my $pkg (qw( 283for my $pkg (qw(
137 cf::global cf::attachable 284 cf::global cf::attachable
138 cf::object cf::object::player 285 cf::object cf::object::player
139 cf::client cf::player 286 cf::client cf::player
140 cf::arch cf::living 287 cf::arch cf::living
288 cf::map cf::mapspace
141 cf::map cf::party cf::region 289 cf::party cf::region
142)) { 290)) {
143 no strict 'refs';
144 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 291 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
145} 292}
146 293
147$Event::DIED = sub { 294$EV::DIED = sub {
148 warn "error in event callback: @_"; 295 Carp::cluck "error in event callback: @_";
149}; 296};
150 297
151my %ext_pkg; 298#############################################################################
152my @exts;
153my @hook;
154 299
155=head2 UTILITY FUNCTIONS 300=head2 UTILITY FUNCTIONS
156 301
157=over 4 302=over 4
158 303
159=cut 304=item dumpval $ref
160 305
161use JSON::Syck (); # TODO# replace by JSON::PC once working 306=cut
162 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
163=item $ref = cf::from_json $json 327=item $ref = cf::decode_json $json
164 328
165Converts a JSON string into the corresponding perl data structure. 329Converts a JSON string into the corresponding perl data structure.
166 330
167=cut
168
169sub from_json($) {
170 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
171 JSON::Syck::Load $_[0]
172}
173
174=item $json = cf::to_json $ref 331=item $json = cf::encode_json $ref
175 332
176Converts a perl data structure into its JSON representation. 333Converts a perl data structure into its JSON representation.
177 334
178=cut 335=cut
179 336
180sub to_json($) { 337our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
181 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 338
182 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;
183} 354}
184 355
185=item cf::lock_wait $string 356=item cf::lock_wait $string
186 357
187Wait until the given lock is available. See cf::lock_acquire. 358Wait until the given lock is available. See cf::lock_acquire.
188 359
189=item my $lock = cf::lock_acquire $string 360=item my $lock = cf::lock_acquire $string
190 361
191Wait 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
192a 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,
193for example when the coroutine gets canceled), the lock is automatically 364for example when the coroutine gets canceled), the lock is automatically
194returned. 365returned.
195 366
367Locks are *not* recursive, locking from the same coro twice results in a
368deadlocked coro.
369
196Lock 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
197uses map_find and cf::map::load uses map_load). 371uses map_find and cf::map::load uses map_load).
198 372
199=cut 373=item $locked = cf::lock_active $string
200 374
201our %LOCK; 375Return true if the lock is currently active, i.e. somebody has locked it.
376
377=cut
378
379our $LOCKS = new Coro::SemaphoreSet;
202 380
203sub lock_wait($) { 381sub lock_wait($) {
204 my ($key) = @_; 382 $LOCKS->wait ($_[0]);
205
206 # wait for lock, if any
207 while ($LOCK{$key}) {
208 push @{ $LOCK{$key} }, $Coro::current;
209 Coro::schedule;
210 }
211} 383}
212 384
213sub lock_acquire($) { 385sub lock_acquire($) {
214 my ($key) = @_; 386 $LOCKS->guard ($_[0])
387}
215 388
216 # wait, to be sure we are not locked 389sub lock_active($) {
217 lock_wait $key; 390 $LOCKS->count ($_[0]) < 1
218
219 $LOCK{$key} = [];
220
221 Coro::guard {
222 # wake up all waiters, to be on the safe side
223 $_->ready for @{ delete $LOCK{$key} };
224 }
225} 391}
226 392
227sub freeze_mainloop { 393sub freeze_mainloop {
228 return unless $TICK_WATCHER->is_active; 394 tick_inhibit_inc;
229 395
230 my $guard = Coro::guard { $TICK_WATCHER->start }; 396 &Guard::guard (\&tick_inhibit_dec);
231 $TICK_WATCHER->stop; 397}
232 $guard 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;
233} 472}
234 473
235=item cf::async { BLOCK } 474=item cf::async { BLOCK }
236 475
237Currently the same as Coro::async_pool, meaning you cannot use 476Currently the same as Coro::async_pool, meaning you cannot use
242 481
243BEGIN { *async = \&Coro::async_pool } 482BEGIN { *async = \&Coro::async_pool }
244 483
245=item cf::sync_job { BLOCK } 484=item cf::sync_job { BLOCK }
246 485
247The design of crossfire+ requires that the main coro ($Coro::main) is 486The design of Deliantra requires that the main coroutine ($Coro::main)
248always able to handle events or runnable, as crossfire+ is only partly 487is always able to handle events or runnable, as Deliantra is only
249reentrant. 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.
250 490
251If 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
252the given BLOCK in another coroutine while waiting for the result. The 492the given BLOCK in another coroutine while waiting for the result. The
253server 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
254fast or be very important. 494fast or be very important.
257 497
258sub sync_job(&) { 498sub sync_job(&) {
259 my ($job) = @_; 499 my ($job) = @_;
260 500
261 if ($Coro::current == $Coro::main) { 501 if ($Coro::current == $Coro::main) {
502 my $time = EV::time;
503
262 # this is the main coro, too bad, we have to block 504 # this is the main coro, too bad, we have to block
263 # till the operation succeeds, freezing the server :/ 505 # till the operation succeeds, freezing the server :/
264 506
265 # TODO: use suspend/resume instead 507 LOG llevError, Carp::longmess "sync job";#d#
266 # (but this is cancel-safe) 508
267 my $freeze_guard = freeze_mainloop; 509 my $freeze_guard = freeze_mainloop;
268 510
269 my $busy = 1; 511 my $busy = 1;
270 my @res; 512 my @res;
271 513
272 (async { 514 (async {
515 $Coro::current->desc ("sync job coro");
273 @res = eval { $job->() }; 516 @res = eval { $job->() };
274 warn $@ if $@; 517 warn $@ if $@;
275 undef $busy; 518 undef $busy;
276 })->prio (Coro::PRIO_MAX); 519 })->prio (Coro::PRIO_MAX);
277 520
278 while ($busy) { 521 while ($busy) {
279 Coro::cede or Event::one_event; 522 if (Coro::nready) {
523 Coro::cede_notself;
524 } else {
525 EV::loop EV::LOOP_ONESHOT;
280 } 526 }
527 }
528
529 my $time = EV::time - $time;
530
531 $TICK_START += $time; # do not account sync jobs to server load
281 532
282 wantarray ? @res : $res[0] 533 wantarray ? @res : $res[0]
283 } else { 534 } else {
284 # we are in another coroutine, how wonderful, everything just works 535 # we are in another coroutine, how wonderful, everything just works
285 536
287 } 538 }
288} 539}
289 540
290=item $coro = cf::async_ext { BLOCK } 541=item $coro = cf::async_ext { BLOCK }
291 542
292Like async, but this coro is automcatially being canceled when the 543Like async, but this coro is automatically being canceled when the
293extension calling this is being unloaded. 544extension calling this is being unloaded.
294 545
295=cut 546=cut
296 547
297sub async_ext(&) { 548sub async_ext(&) {
305 $EXT_CORO{$coro+0} = $coro; 556 $EXT_CORO{$coro+0} = $coro;
306 557
307 $coro 558 $coro
308} 559}
309 560
310sub write_runtime { 561=item fork_call { }, $args
311 my $runtime = cf::localdir . "/runtime";
312 562
313 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 563Executes the given code block with the given arguments in a seperate
314 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.
315 567
316 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 568=cut
317 (aio_write $fh, 0, (length $value), $value, 0) <= 0
318 and return;
319 569
320 aio_fsync $fh 570sub fork_call(&@) {
321 and return; 571 my ($cb, @args) = @_;
322 572
323 close $fh 573 # we seemingly have to make a local copy of the whole thing,
324 or return; 574 # otherwise perl prematurely frees the stuff :/
575 # TODO: investigate and fix (likely this will be rather laborious)
325 576
326 aio_rename "$runtime~", $runtime 577 my @res = Coro::Util::fork_eval {
327 and return; 578 reset_signals;
579 &$cb
580 }, @args;
328 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
329 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 });
330} 748}
331 749
332=back 750=back
333 751
334=cut 752=cut
335 753
336############################################################################# 754#############################################################################
337 755
338package cf::path;
339
340sub new {
341 my ($class, $path, $base) = @_;
342
343 $path = $path->as_string if ref $path;
344
345 my $self = bless { }, $class;
346
347 # {... are special paths that are not touched
348 # ?xxx/... are special absolute paths
349 # ?random/... random maps
350 # /! non-realised random map exit
351 # /... normal maps
352 # ~/... per-player maps without a specific player (DO NOT USE)
353 # ~user/... per-player map of a specific user
354
355 if ($path =~ /^{/) {
356 # fine as it is
357 } elsif ($path =~ s{^\?random/}{}) {
358 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
359 $self->{random} = cf::from_json $data;
360 } else {
361 if ($path =~ s{^~([^/]+)?}{}) {
362 $self->{user_rel} = 1;
363
364 if (defined $1) {
365 $self->{user} = $1;
366 } elsif ($base =~ m{^~([^/]+)/}) {
367 $self->{user} = $1;
368 } else {
369 warn "cannot resolve user-relative path without user <$path,$base>\n";
370 }
371 } elsif ($path =~ /^\//) {
372 # already absolute
373 } else {
374 $base =~ s{[^/]+/?$}{};
375 return $class->new ("$base/$path");
376 }
377
378 for ($path) {
379 redo if s{/\.?/}{/};
380 redo if s{/[^/]+/\.\./}{/};
381 }
382 }
383
384 $self->{path} = $path;
385
386 $self
387}
388
389# the name / primary key / in-game path
390sub as_string {
391 my ($self) = @_;
392
393 $self->{user_rel} ? "~$self->{user}$self->{path}"
394 : $self->{random} ? "?random/$self->{path}"
395 : $self->{path}
396}
397
398# the displayed name, this is a one way mapping
399sub visible_name {
400 my ($self) = @_;
401
402# if (my $rmp = $self->{random}) {
403# # todo: be more intelligent about this
404# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
405# } else {
406 $self->as_string
407# }
408}
409
410# escape the /'s in the path
411sub _escaped_path {
412 # ∕ is U+2215
413 (my $path = $_[0]{path}) =~ s/\//∕/g;
414 $path
415}
416
417# the original (read-only) location
418sub load_path {
419 my ($self) = @_;
420
421 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
422}
423
424# the temporary/swap location
425sub save_path {
426 my ($self) = @_;
427
428 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
429 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
430 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
431}
432
433# the unique path, might be eq to save_path
434sub uniq_path {
435 my ($self) = @_;
436
437 $self->{user_rel} || $self->{random}
438 ? undef
439 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
440}
441
442# return random map parameters, or undef
443sub random_map_params {
444 my ($self) = @_;
445
446 $self->{random}
447}
448
449# this is somewhat ugly, but style maps do need special treatment
450sub is_style_map {
451 $_[0]{path} =~ m{^/styles/}
452}
453
454package cf;
455
456#############################################################################
457
458=head2 ATTACHABLE OBJECTS 756=head2 ATTACHABLE OBJECTS
459 757
460Many 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
461attach callbacks/event handlers (a collection of which is called an "attachment") 759attach callbacks/event handlers (a collection of which is called an "attachment")
462to it. All such attachable objects support the following methods. 760to it. All such attachable objects support the following methods.
463 761
464In 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>
465C<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
466crossfire+). 764Deliantra).
467 765
468=over 4 766=over 4
469 767
470=item $attachable->attach ($attachment, key => $value...) 768=item $attachable->attach ($attachment, key => $value...)
471 769
515=item cf::CLASS::attachment $name, ... 813=item cf::CLASS::attachment $name, ...
516 814
517Register an attachment by C<$name> through which attachable objects of the 815Register an attachment by C<$name> through which attachable objects of the
518given CLASS can refer to this attachment. 816given CLASS can refer to this attachment.
519 817
520Some classes such as crossfire maps and objects can specify attachments 818Some classes such as deliantra maps and objects can specify attachments
521that 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.
522 820
523These calls expect any number of the following handler/hook descriptions: 821These calls expect any number of the following handler/hook descriptions:
524 822
525=over 4 823=over 4
585our @CB_TYPE = (); # registry for type (cf-object class) based events 883our @CB_TYPE = (); # registry for type (cf-object class) based events
586our @CB_MAP = (); 884our @CB_MAP = ();
587 885
588my %attachment; 886my %attachment;
589 887
888sub cf::attachable::thawer_merge {
889 # simply override everything except _meta
890 local $_[0]{_meta};
891 %{$_[0]} = %{$_[1]};
892}
893
590sub _attach_cb($$$$) { 894sub _attach_cb($$$$) {
591 my ($registry, $event, $prio, $cb) = @_; 895 my ($registry, $event, $prio, $cb) = @_;
592 896
593 use sort 'stable'; 897 use sort 'stable';
594 898
628 $registry = $CB_TYPE[$object_type] ||= []; 932 $registry = $CB_TYPE[$object_type] ||= [];
629 933
630 } elsif ($type eq "subtype") { 934 } elsif ($type eq "subtype") {
631 defined $object_type or Carp::croak "subtype specified without type"; 935 defined $object_type or Carp::croak "subtype specified without type";
632 my $object_subtype = shift @arg; 936 my $object_subtype = shift @arg;
633 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 937 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
634 938
635 } elsif ($type eq "package") { 939 } elsif ($type eq "package") {
636 my $pkg = shift @arg; 940 my $pkg = shift @arg;
637 941
638 while (my ($name, $id) = each %cb_id) { 942 while (my ($name, $id) = each %cb_id) {
667 _attach $registry, $klass, @attach; 971 _attach $registry, $klass, @attach;
668 } 972 }
669 973
670 $obj->{$name} = \%arg; 974 $obj->{$name} = \%arg;
671 } else { 975 } else {
672 warn "object uses attachment '$name' that is not available, postponing.\n"; 976 warn "object uses attachment '$name' which is not available, postponing.\n";
673 } 977 }
674 978
675 $obj->{_attachment}{$name} = undef; 979 $obj->{_attachment}{$name} = undef;
676} 980}
677 981
679 if (ref $_[0]) { 983 if (ref $_[0]) {
680 _object_attach @_; 984 _object_attach @_;
681 } else { 985 } else {
682 _attach shift->_attach_registry, @_; 986 _attach shift->_attach_registry, @_;
683 } 987 }
988 _recalc_want;
684}; 989};
685 990
686# all those should be optimised 991# all those should be optimised
687sub cf::attachable::detach { 992sub cf::attachable::detach {
688 my ($obj, $name) = @_; 993 my ($obj, $name) = @_;
691 delete $obj->{_attachment}{$name}; 996 delete $obj->{_attachment}{$name};
692 reattach ($obj); 997 reattach ($obj);
693 } else { 998 } else {
694 Carp::croak "cannot, currently, detach class attachments"; 999 Carp::croak "cannot, currently, detach class attachments";
695 } 1000 }
1001 _recalc_want;
696}; 1002};
697 1003
698sub cf::attachable::attached { 1004sub cf::attachable::attached {
699 my ($obj, $name) = @_; 1005 my ($obj, $name) = @_;
700 1006
715 "; 1021 ";
716 die if $@; 1022 die if $@;
717} 1023}
718 1024
719our $override; 1025our $override;
720our @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?
721 1027
722sub override { 1028sub override {
723 $override = 1; 1029 $override = 1;
724 @invoke_results = (); 1030 @INVOKE_RESULTS = (@_);
725} 1031}
726 1032
727sub do_invoke { 1033sub do_invoke {
728 my $event = shift; 1034 my $event = shift;
729 my $callbacks = shift; 1035 my $callbacks = shift;
730 1036
731 @invoke_results = (); 1037 @INVOKE_RESULTS = ();
732 1038
733 local $override; 1039 local $override;
734 1040
735 for (@$callbacks) { 1041 for (@$callbacks) {
736 eval { &{$_->[1]} }; 1042 eval { &{$_->[1]} };
745 } 1051 }
746 1052
747 0 1053 0
748} 1054}
749 1055
750=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1056=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
751 1057
752=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1058=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
753 1059
754Generate an object-specific event with the given arguments. 1060Generate an object-specific event with the given arguments.
755 1061
756This 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
757removed 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
758results (if you must, access C<@cf::invoke_results> directly). 1064results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 1065
760=back 1066=back
761 1067
762=cut 1068=cut
763 1069
764############################################################################# 1070#############################################################################
765# 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}
766 1114
767sub reattach { 1115sub reattach {
768 # basically do the same as instantiate, without calling instantiate 1116 # basically do the same as instantiate, without calling instantiate
769 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
770 1121
771 my $registry = $obj->registry; 1122 my $registry = $obj->registry;
772 1123
773 @$registry = (); 1124 @$registry = ();
774 1125
789cf::attachable->attach ( 1140cf::attachable->attach (
790 prio => -1000000, 1141 prio => -1000000,
791 on_instantiate => sub { 1142 on_instantiate => sub {
792 my ($obj, $data) = @_; 1143 my ($obj, $data) = @_;
793 1144
794 $data = from_json $data; 1145 $data = decode_json $data;
795 1146
796 for (@$data) { 1147 for (@$data) {
797 my ($name, $args) = @$_; 1148 my ($name, $args) = @$_;
798 1149
799 $obj->attach ($name, %{$args || {} }); 1150 $obj->attach ($name, %{$args || {} });
815sub object_freezer_save { 1166sub object_freezer_save {
816 my ($filename, $rdata, $objs) = @_; 1167 my ($filename, $rdata, $objs) = @_;
817 1168
818 sync_job { 1169 sync_job {
819 if (length $$rdata) { 1170 if (length $$rdata) {
1171 utf8::decode (my $decname = $filename);
820 warn sprintf "saving %s (%d,%d)\n", 1172 warn sprintf "saving %s (%d,%d)\n",
821 $filename, length $$rdata, scalar @$objs; 1173 $decname, length $$rdata, scalar @$objs;
822 1174
823 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1175 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
824 chmod SAVE_MODE, $fh; 1176 aio_chmod $fh, SAVE_MODE;
825 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;
826 aio_fsync $fh; 1180 aio_fsync $fh;
1181 }
827 close $fh; 1182 aio_close $fh;
828 1183
829 if (@$objs) { 1184 if (@$objs) {
830 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) {
831 chmod SAVE_MODE, $fh; 1186 aio_chmod $fh, SAVE_MODE;
832 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1187 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
833 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;
834 aio_fsync $fh; 1191 aio_fsync $fh;
1192 }
835 close $fh; 1193 aio_close $fh;
836 aio_rename "$filename.pst~", "$filename.pst"; 1194 aio_rename "$filename.pst~", "$filename.pst";
837 } 1195 }
838 } else { 1196 } else {
839 aio_unlink "$filename.pst"; 1197 aio_unlink "$filename.pst";
840 } 1198 }
841 1199
842 aio_rename "$filename~", $filename; 1200 aio_rename "$filename~", $filename;
1201
1202 $filename =~ s%/[^/]+$%%;
1203 aio_pathsync $filename if $cf::USE_FSYNC;
843 } else { 1204 } else {
844 warn "FATAL: $filename~: $!\n"; 1205 warn "unable to save objects: $filename~: $!\n";
845 } 1206 }
846 } else { 1207 } else {
847 aio_unlink $filename; 1208 aio_unlink $filename;
848 aio_unlink "$filename.pst"; 1209 aio_unlink "$filename.pst";
849 } 1210 }
850 } 1211 };
851} 1212}
852 1213
853sub object_freezer_as_string { 1214sub object_freezer_as_string {
854 my ($rdata, $objs) = @_; 1215 my ($rdata, $objs) = @_;
855 1216
867 or return; 1228 or return;
868 1229
869 unless (aio_stat "$filename.pst") { 1230 unless (aio_stat "$filename.pst") {
870 (aio_load "$filename.pst", $av) >= 0 1231 (aio_load "$filename.pst", $av) >= 0
871 or return; 1232 or return;
1233
872 $av = eval { (Storable::thaw $av)->{objs} }; 1234 my $st = eval { Coro::Storable::thaw $av };
1235 $av = $st->{objs};
873 } 1236 }
874 1237
1238 utf8::decode (my $decname = $filename);
875 warn sprintf "loading %s (%d)\n", 1239 warn sprintf "loading %s (%d,%d)\n",
876 $filename, length $data, scalar @{$av || []};#d# 1240 $decname, length $data, scalar @{$av || []};
1241
877 return ($data, $av); 1242 ($data, $av)
878} 1243}
1244
1245=head2 COMMAND CALLBACKS
1246
1247=over 4
1248
1249=cut
879 1250
880############################################################################# 1251#############################################################################
881# command handling &c 1252# command handling &c
882 1253
883=item cf::register_command $name => \&callback($ob,$args); 1254=item cf::register_command $name => \&callback($ob,$args);
896 push @{ $COMMAND{$name} }, [$caller, $cb]; 1267 push @{ $COMMAND{$name} }, [$caller, $cb];
897} 1268}
898 1269
899=item cf::register_extcmd $name => \&callback($pl,$packet); 1270=item cf::register_extcmd $name => \&callback($pl,$packet);
900 1271
901Register 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.
902 1277
903If 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
904called. 1279called.
905 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
906=cut 1292=cut
907 1293
908sub register_extcmd { 1294sub register_extcmd {
909 my ($name, $cb) = @_; 1295 my ($name, $cb) = @_;
910 1296
911 my $caller = caller;
912 #warn "registering extcmd '$name' to '$caller'";
913
914 $EXTCMD{$name} = [$cb, $caller]; 1297 $EXTCMD{$name} = $cb;
915} 1298}
1299
1300sub register_exticmd {
1301 my ($name, $cb) = @_;
1302
1303 $EXTICMD{$name} = $cb;
1304}
1305
1306use File::Glob ();
916 1307
917cf::player->attach ( 1308cf::player->attach (
918 on_command => sub { 1309 on_command => sub {
919 my ($pl, $name, $params) = @_; 1310 my ($pl, $name, $params) = @_;
920 1311
928 cf::override; 1319 cf::override;
929 }, 1320 },
930 on_extcmd => sub { 1321 on_extcmd => sub {
931 my ($pl, $buf) = @_; 1322 my ($pl, $buf) = @_;
932 1323
933 my $msg = eval { from_json $buf }; 1324 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934 1325
935 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
936 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1334 if (my $cb = $EXTCMD{$type}) {
937 if (my %reply = $cb->[0]->($pl, $msg)) { 1335 @reply = $cb->($pl, @payload);
938 $pl->ext_reply ($msg->{msgid}, %reply);
939 }
940 } 1336 }
1337
1338 $pl->ext_reply ($reply, @reply)
1339 if $reply;
1340
941 } else { 1341 } else {
942 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1342 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943 } 1343 }
944 1344
945 cf::override; 1345 cf::override;
946 }, 1346 },
947); 1347);
948 1348
949sub register { 1349# "readahead" all extensions
950 my ($base, $pkg) = @_;
951
952 #TODO
953}
954
955sub load_extension { 1350sub cache_extensions {
956 my ($path) = @_; 1351 my $grp = IO::AIO::aio_group;
957 1352
958 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1353 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
959 my $base = $1; 1354 for (grep /\.ext$/, @{$_[0]}) {
960 my $pkg = $1; 1355 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
961 $pkg =~ s/[^[:word:]]/_/g;
962 $pkg = "ext::$pkg";
963
964 warn "loading '$path' into '$pkg'\n";
965
966 open my $fh, "<:utf8", $path
967 or die "$path: $!";
968
969 my $source =
970 "package $pkg; use strict; use utf8;\n"
971 . "#line 1 \"$path\"\n{\n"
972 . (do { local $/; <$fh> })
973 . "\n};\n1";
974
975 eval $source
976 or die $@ ? "$path: $@\n"
977 : "extension disabled.\n";
978
979 push @exts, $pkg;
980 $ext_pkg{$base} = $pkg;
981
982# no strict 'refs';
983# @{"$pkg\::ISA"} = ext::;
984
985 register $base, $pkg;
986}
987
988sub unload_extension {
989 my ($pkg) = @_;
990
991 warn "removing extension $pkg\n";
992
993 # remove hooks
994 #TODO
995# for my $idx (0 .. $#PLUGIN_EVENT) {
996# delete $hook[$idx]{$pkg};
997# }
998
999 # remove commands
1000 for my $name (keys %COMMAND) {
1001 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1002
1003 if (@cb) {
1004 $COMMAND{$name} = \@cb;
1005 } else {
1006 delete $COMMAND{$name};
1007 } 1356 }
1008 } 1357 };
1009 1358
1010 # remove extcmds 1359 $grp
1011 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1012 delete $EXTCMD{$name};
1013 }
1014
1015 if (my $cb = $pkg->can ("unload")) {
1016 eval {
1017 $cb->($pkg);
1018 1
1019 } or warn "$pkg unloaded, but with errors: $@";
1020 }
1021
1022 Symbol::delete_package $pkg;
1023} 1360}
1024 1361
1025sub load_extensions { 1362sub load_extensions {
1363 cf::sync_job {
1364 my %todo;
1365
1026 for my $ext (<$LIBDIR/*.ext>) { 1366 for my $path (<$LIBDIR/*.ext>) {
1027 next unless -r $ext; 1367 next unless -r $path;
1028 eval { 1368
1029 load_extension $ext; 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;
1030 1 1425 }
1031 } or warn "$ext not loaded: $@"; 1426
1427 skip:
1428 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1429 unless $progress;
1430 }
1032 } 1431 };
1033} 1432}
1034 1433
1035############################################################################# 1434#############################################################################
1036# load/save/clean perl data associated with a map
1037 1435
1038*cf::mapsupport::on_clean = sub { 1436=back
1039 my ($map) = @_;
1040
1041 my $path = $map->tmpname;
1042 defined $path or return;
1043
1044 unlink "$path.pst";
1045};
1046
1047cf::map->attach (prio => -10000, package => cf::mapsupport::);
1048
1049#############################################################################
1050# load/save perl data associated with player->ob objects
1051
1052sub all_objects(@) {
1053 @_, map all_objects ($_->inv), @_
1054}
1055
1056# TODO: compatibility cruft, remove when no longer needed
1057cf::player->attach (
1058 on_load => sub {
1059 my ($pl, $path) = @_;
1060
1061 for my $o (all_objects $pl->ob) {
1062 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1063 $o->set_ob_key_value ("_perl_data");
1064
1065 %$o = %{ Storable::thaw pack "H*", $value };
1066 }
1067 }
1068 },
1069);
1070
1071#############################################################################
1072 1437
1073=head2 CORE EXTENSIONS 1438=head2 CORE EXTENSIONS
1074 1439
1075Functions and methods that extend core crossfire objects. 1440Functions and methods that extend core deliantra objects.
1076 1441
1077=cut 1442=cut
1078 1443
1079package cf::player; 1444package cf::player;
1080 1445
1446use Coro::AIO;
1447
1081=head3 cf::player 1448=head3 cf::player
1082 1449
1083=over 4 1450=over 4
1084 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
1085=item cf::player::find $login 1466=item cf::player::find $login
1086 1467
1087Returns the given player object, loading it if necessary (might block). 1468Returns the given player object, loading it if necessary (might block).
1088 1469
1089=cut 1470=cut
1090 1471
1472sub playerdir($) {
1473 "$PLAYERDIR/"
1474 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1475}
1476
1091sub path($) { 1477sub path($) {
1092 sprintf "%s/%s/%s/%s.pl", 1478 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1093 cf::localdir, cf::playerdir, 1479
1094 (ref $_[0] ? $_[0]->ob->name : $_[0]) x 2 1480 (playerdir $login) . "/playerdata"
1095} 1481}
1096 1482
1097sub find_active($) { 1483sub find_active($) {
1098 $cf::PLAYER{$_[0]} 1484 $cf::PLAYER{$_[0]}
1099 and $cf::PLAYER{$_[0]}->active 1485 and $cf::PLAYER{$_[0]}->active
1102 1488
1103sub exists($) { 1489sub exists($) {
1104 my ($login) = @_; 1490 my ($login) = @_;
1105 1491
1106 $cf::PLAYER{$login} 1492 $cf::PLAYER{$login}
1107 or cf::sync_job { !aio_stat $login } 1493 or !aio_stat path $login
1108} 1494}
1109 1495
1110sub find($) { 1496sub find($) {
1111 return $cf::PLAYER{$_[0]} || do { 1497 return $cf::PLAYER{$_[0]} || do {
1112 my $login = $_[0]; 1498 my $login = $_[0];
1113 1499
1114 my $guard = cf::lock_acquire "user_find:$login"; 1500 my $guard = cf::lock_acquire "user_find:$login";
1115 1501
1116 $cf::PLAYER{$login} ||= (load_pl path $login or return); 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 }
1117 }; 1520 }
1118} 1521}
1119 1522
1120sub save($) { 1523sub save($) {
1121 my ($pl) = @_; 1524 my ($pl) = @_;
1122 1525
1124 1527
1125 my $path = path $pl; 1528 my $path = path $pl;
1126 my $guard = cf::lock_acquire "user_save:$path"; 1529 my $guard = cf::lock_acquire "user_save:$path";
1127 1530
1128 return if $pl->{deny_save}; 1531 return if $pl->{deny_save};
1532
1533 aio_mkdir playerdir $pl, 0770;
1129 $pl->{last_save} = $cf::RUNTIME; 1534 $pl->{last_save} = $cf::RUNTIME;
1130 1535
1131 Coro::cede; 1536 cf::get_slot 0.01;
1537
1132 $pl->save_pl ($path); 1538 $pl->save_pl ($path);
1133 Coro::cede; 1539 cf::cede_to_tick;
1134} 1540}
1135 1541
1136sub new($) { 1542sub new($) {
1137 my ($login) = @_; 1543 my ($login) = @_;
1138 1544
1144 $cf::PLAYER{$login} = $self; 1550 $cf::PLAYER{$login} = $self;
1145 1551
1146 $self 1552 $self
1147} 1553}
1148 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
1149=item $player->ext_reply ($msgid, $msgtype, %msg) 1678=item $player->ext_reply ($msgid, @msg)
1150 1679
1151Sends an ext reply to the player. 1680Sends an ext reply to the player.
1152 1681
1153=cut 1682=cut
1154 1683
1155sub ext_reply($$$%) { 1684sub ext_reply($$@) {
1156 my ($self, $id, %msg) = @_; 1685 my ($self, $id, @msg) = @_;
1157 1686
1158 $msg{msgid} = $id; 1687 $self->ns->ext_reply ($id, @msg)
1159
1160 $self->send ("ext " . cf::to_json \%msg);
1161} 1688}
1162 1689
1163package cf; 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($) {
1717 my ($path) = @_;
1718
1719 my ($match, $specificity);
1720
1721 for my $region (list) {
1722 if ($region->{match} && $path =~ $region->{match}) {
1723 ($match, $specificity) = ($region, $region->specificity)
1724 if $region->specificity > $specificity;
1725 }
1726 }
1727
1728 $match
1729}
1164 1730
1165=back 1731=back
1166
1167 1732
1168=head3 cf::map 1733=head3 cf::map
1169 1734
1170=over 4 1735=over 4
1171 1736
1174package cf::map; 1739package cf::map;
1175 1740
1176use Fcntl; 1741use Fcntl;
1177use Coro::AIO; 1742use Coro::AIO;
1178 1743
1744use overload
1745 '""' => \&as_string,
1746 fallback => 1;
1747
1179our $MAX_RESET = 3600; 1748our $MAX_RESET = 3600;
1180our $DEFAULT_RESET = 3000; 1749our $DEFAULT_RESET = 3000;
1181 1750
1182sub generate_random_map { 1751sub generate_random_map {
1183 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
1184 1755
1185 # mit "rum" bekleckern, nicht 1756 # mit "rum" bekleckern, nicht
1186 cf::map::_create_random_map 1757 $self->_create_random_map (
1187 $path,
1188 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1758 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1189 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1759 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1190 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1760 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1191 $rmp->{exit_on_final_map}, 1761 $rmp->{exit_on_final_map},
1192 $rmp->{xsize}, $rmp->{ysize}, 1762 $rmp->{xsize}, $rmp->{ysize},
1193 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1763 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1194 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1764 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1195 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1765 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1196 $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},
1197 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1767 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1198 (cf::region::find $rmp->{region}) 1768 (cf::region::find $rmp->{region}), $rmp->{custom}
1769 )
1199} 1770}
1200 1771
1201# and all this just because we cannot iterate over 1772=item cf::map->register ($regex, $prio)
1202# all maps in C++...
1203sub change_all_map_light {
1204 my ($change) = @_;
1205 1773
1206 $_->change_map_light ($change) 1774Register a handler for the map path matching the given regex at the
1207 for grep $_->outdoor, values %cf::MAP; 1775givne priority (higher is better, built-in handlers have priority 0, the
1208} 1776default).
1209 1777
1210sub 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 {
1211 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) = @_;
1212 1917
1213 utf8::encode $path; 1918 utf8::encode $path;
1214 aio_open $path, O_RDONLY, 0 1919 my $f = new_from_file cf::object::thawer $path
1215 or return; 1920 or return;
1216 1921
1217 my $map = cf::map::new 1922 $self->_load_header ($f)
1218 or return; 1923 or return;
1219 1924
1220 # for better error messages only, will be overwritten 1925 local $MAP_LOADING{$self->{path}} = $self;
1221 $map->path ($path); 1926 $f->resolve_delayed_derefs;
1222 1927
1223 $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
1224 or return; 1971 or return;
1972 $self->prepare_orig;
1973 }
1225 1974
1226 $map->{load_path} = $path; 1975 $self->{deny_reset} = 1
1976 if $self->no_reset;
1227 1977
1228 $map 1978 $self->default_region (cf::region::find_by_path $self->{path})
1979 unless $self->default_region;
1980
1981 1
1229} 1982}
1230 1983
1231sub find; 1984sub find;
1232sub find { 1985sub find {
1233 my ($path, $origin) = @_; 1986 my ($path, $origin) = @_;
1234 1987
1235 #warn "find<$path,$origin>\n";#d#
1236
1237 $path = new cf::path $path, $origin && $origin->path; 1988 $path = normalise $path, $origin && $origin->path;
1238 my $key = $path->as_string;
1239 1989
1240 cf::lock_wait "map_find:$key"; 1990 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1241
1242 $cf::MAP{$key} || do {
1243 my $guard = cf::lock_acquire "map_find:$key"; 1991 my $guard2 = cf::lock_acquire "map_find:$path";
1244 1992
1245 # do it the slow way 1993 $cf::MAP{$path} || do {
1246 my $map = try_load_header $path->save_path; 1994 my $map = new_from_path cf::map $path
1247
1248 Coro::cede;
1249
1250 if ($map) {
1251 $map->last_access ((delete $map->{last_access})
1252 || $cf::RUNTIME); #d#
1253 # safety
1254 $map->{instantiate_time} = $cf::RUNTIME
1255 if $map->{instantiate_time} > $cf::RUNTIME;
1256 } else {
1257 if (my $rmp = $path->random_map_params) {
1258 $map = generate_random_map $key, $rmp;
1259 } else {
1260 $map = try_load_header $path->load_path;
1261 }
1262
1263 $map or return; 1995 or return;
1264 1996
1265 $map->{load_original} = 1;
1266 $map->{instantiate_time} = $cf::RUNTIME;
1267 $map->last_access ($cf::RUNTIME);
1268 $map->instantiate;
1269
1270 # per-player maps become, after loading, normal maps
1271 $map->per_player (0) if $path->{user_rel};
1272 }
1273
1274 $map->path ($key);
1275 $map->{path} = $path;
1276 $map->{last_save} = $cf::RUNTIME; 1997 $map->{last_save} = $cf::RUNTIME;
1277 1998
1278 Coro::cede; 1999 $map->load_header
2000 or return;
1279 2001
1280 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;
1281 $map->reset; 2007 $map->reset;
1282 undef $guard;
1283 $map = find $path 2008 return find $path;
1284 or return;
1285 } 2009 }
1286 2010
1287 $cf::MAP{$key} = $map 2011 $cf::MAP{$path} = $map
1288 } 2012 }
1289} 2013}
2014
2015sub pre_load { }
2016sub post_load { }
1290 2017
1291sub load { 2018sub load {
1292 my ($self) = @_; 2019 my ($self) = @_;
1293 2020
2021 local $self->{deny_reset} = 1; # loading can take a long time
2022
1294 my $path = $self->{path}; 2023 my $path = $self->{path};
2024
2025 {
1295 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 2026 my $guard = cf::lock_acquire "map_data:$path";
1296 2027
2028 return unless $self->valid;
1297 return if $self->in_memory != cf::MAP_SWAPPED; 2029 return unless $self->in_memory == cf::MAP_SWAPPED;
1298 2030
1299 $self->in_memory (cf::MAP_LOADING); 2031 $self->in_memory (cf::MAP_LOADING);
1300 2032
1301 $self->alloc; 2033 $self->alloc;
1302 $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)
1303 or return; 2041 or return;
1304 2042
1305 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2043 $self->post_load_original
1306 if delete $self->{load_original}; 2044 if delete $self->{load_original};
1307 2045
1308 if (my $uniq = $path->uniq_path) { 2046 if (my $uniq = $self->uniq_path) {
1309 utf8::encode $uniq; 2047 utf8::encode $uniq;
1310 if (aio_open $uniq, O_RDONLY, 0) { 2048 unless (aio_stat $uniq) {
2049 if (my $f = new_from_file cf::object::thawer $uniq) {
1311 $self->clear_unique_items; 2050 $self->clear_unique_items;
1312 $self->load_objects ($uniq, 0); 2051 $self->_load_objects ($f);
2052 $f->resolve_delayed_derefs;
2053 }
1313 } 2054 }
1314 } 2055 }
1315 2056
1316 Coro::cede; 2057 $f->resolve_delayed_derefs;
1317 2058
2059 cf::cede_to_tick;
1318 # now do the right thing for maps 2060 # now do the right thing for maps
1319 $self->link_multipart_objects; 2061 $self->link_multipart_objects;
1320
1321 if ($self->{path}->is_style_map) {
1322 $self->{deny_save} = 1;
1323 $self->{deny_reset} = 1;
1324 } else {
1325 $self->fix_auto_apply;
1326 $self->decay_objects;
1327 $self->update_buttons;
1328 $self->set_darkness_map;
1329 $self->difficulty ($self->estimate_difficulty) 2062 $self->difficulty ($self->estimate_difficulty)
1330 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;
1331 $self->activate; 2071 $self->activate;
1332 } 2072 }
1333 2073
1334 Coro::cede; 2074 $self->{last_save} = $cf::RUNTIME;
2075 $self->last_access ($cf::RUNTIME);
1335 2076
1336 $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 }
1337} 2119}
1338 2120
1339sub find_sync { 2121sub find_sync {
1340 my ($path, $origin) = @_; 2122 my ($path, $origin) = @_;
1341 2123
1342 cf::sync_job { cf::map::find $path, $origin } 2124 cf::sync_job { find $path, $origin }
1343} 2125}
1344 2126
1345sub do_load_sync { 2127sub do_load_sync {
1346 my ($map) = @_; 2128 my ($map) = @_;
1347 2129
2130 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2131 if $Coro::current == $Coro::main;
2132
1348 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 ()
1349} 2167}
1350 2168
1351sub save { 2169sub save {
1352 my ($self) = @_; 2170 my ($self) = @_;
1353 2171
1354 my $lock = cf::lock_acquire "map_data:" . $self->path; 2172 my $lock = cf::lock_acquire "map_data:$self->{path}";
1355 2173
1356 $self->{last_save} = $cf::RUNTIME; 2174 $self->{last_save} = $cf::RUNTIME;
1357 2175
1358 return unless $self->dirty; 2176 return unless $self->dirty;
1359 2177
1360 my $save = $self->{path}->save_path; utf8::encode $save; 2178 my $save = $self->save_path; utf8::encode $save;
1361 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2179 my $uniq = $self->uniq_path; utf8::encode $uniq;
1362 2180
1363 $self->{load_path} = $save; 2181 $self->{load_path} = $save;
1364 2182
1365 return if $self->{deny_save}; 2183 return if $self->{deny_save};
1366 2184
1367 local $self->{last_access} = $self->last_access;#d# 2185 local $self->{last_access} = $self->last_access;#d#
1368 2186
1369 cf::async { 2187 cf::async {
2188 $Coro::current->{desc} = "map player save";
1370 $_->contr->save for $self->players; 2189 $_->contr->save for $self->players;
1371 }; 2190 };
1372 2191
2192 cf::get_slot 0.02;
2193
1373 if ($uniq) { 2194 if ($uniq) {
1374 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2195 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1375 $self->save_objects ($uniq, cf::IO_UNIQUES); 2196 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1376 } else { 2197 } else {
1377 $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);
1378 } 2199 }
1379} 2200}
1380 2201
1381sub swap_out { 2202sub swap_out {
1382 my ($self) = @_; 2203 my ($self) = @_;
1383 2204
1384 # save first because save cedes 2205 # save first because save cedes
1385 $self->save; 2206 $self->save;
1386 2207
1387 my $lock = cf::lock_acquire "map_data:" . $self->path; 2208 my $lock = cf::lock_acquire "map_data:$self->{path}";
1388 2209
1389 return if $self->players; 2210 return if $self->players;
1390 return if $self->in_memory != cf::MAP_IN_MEMORY; 2211 return if $self->in_memory != cf::MAP_ACTIVE;
1391 return if $self->{deny_save}; 2212 return if $self->{deny_save};
1392 2213
2214 $self->in_memory (cf::MAP_SWAPPED);
2215
2216 $self->deactivate;
2217 $_->clear_links_to ($self) for values %cf::MAP;
1393 $self->clear; 2218 $self->clear;
1394 $self->in_memory (cf::MAP_SWAPPED);
1395} 2219}
1396 2220
1397sub reset_at { 2221sub reset_at {
1398 my ($self) = @_; 2222 my ($self) = @_;
1399 2223
1400 # TODO: safety, remove and allow resettable per-player maps 2224 # TODO: safety, remove and allow resettable per-player maps
1401 return 1e99 if $self->{path}{user_rel};
1402 return 1e99 if $self->{deny_reset}; 2225 return 1e99 if $self->{deny_reset};
1403 2226
1404 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2227 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1405 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;
1406 2229
1411 my ($self) = @_; 2234 my ($self) = @_;
1412 2235
1413 $self->reset_at <= $cf::RUNTIME 2236 $self->reset_at <= $cf::RUNTIME
1414} 2237}
1415 2238
1416sub unlink_save {
1417 my ($self) = @_;
1418
1419 utf8::encode (my $save = $self->{path}->save_path);
1420 aioreq_pri 3; IO::AIO::aio_unlink $save;
1421 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1422}
1423
1424sub rename {
1425 my ($self, $new_path) = @_;
1426
1427 $self->unlink_save;
1428
1429 delete $cf::MAP{$self->path};
1430 $self->{path} = new cf::path $new_path;
1431 $self->path ($self->{path}->as_string);
1432 $cf::MAP{$self->path} = $self;
1433
1434 $self->save;
1435}
1436
1437sub reset { 2239sub reset {
1438 my ($self) = @_; 2240 my ($self) = @_;
1439 2241
1440 my $lock = cf::lock_acquire "map_data:" . $self->path; 2242 my $lock = cf::lock_acquire "map_data:$self->{path}";
1441 2243
1442 return if $self->players; 2244 return if $self->players;
1443 return if $self->{path}{user_rel};#d#
1444 2245
1445 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 }
1446 2257
1447 delete $cf::MAP{$self->path}; 2258 delete $cf::MAP{$self->path};
1448 2259
2260 $self->deactivate;
1449 $_->clear_links_to ($self) for values %cf::MAP; 2261 $_->clear_links_to ($self) for values %cf::MAP;
2262 $self->clear;
1450 2263
1451 $self->unlink_save; 2264 $self->unlink_save;
1452 $self->destroy; 2265 $self->destroy;
1453} 2266}
1454 2267
1455my $nuke_counter = "aaaa"; 2268my $nuke_counter = "aaaa";
1456 2269
1457sub nuke { 2270sub nuke {
1458 my ($self) = @_; 2271 my ($self) = @_;
1459 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};
1460 $self->{deny_save} = 1; 2282 $self->{deny_save} = 1;
1461 $self->reset_timeout (1); 2283 $self->reset_timeout (1);
1462 $self->rename ("{nuke}/" . ($nuke_counter++)); 2284 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2285
2286 $cf::MAP{$self->path} = $self;
2287 }
2288
1463 $self->reset; # polite request, might not happen 2289 $self->reset; # polite request, might not happen
1464} 2290}
1465 2291
1466sub customise_for { 2292=item $maps = cf::map::tmp_maps
1467 my ($map, $ob) = @_;
1468 2293
1469 if ($map->per_player) { 2294Returns an arrayref with all map paths of currently instantiated and saved
1470 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2295maps. May block.
2296
2297=cut
2298
2299sub tmp_maps() {
1471 } 2300 [
1472 2301 map {
1473 $map 2302 utf8::decode $_;
2303 /\.map$/
2304 ? normalise $_
2305 : ()
2306 } @{ aio_readdir $TMPDIR or [] }
2307 ]
1474} 2308}
1475 2309
1476sub emergency_save { 2310=item $maps = cf::map::random_maps
1477 my $freeze_guard = cf::freeze_mainloop;
1478 2311
1479 warn "enter emergency map save\n"; 2312Returns an arrayref with all map paths of currently instantiated and saved
2313random maps. May block.
1480 2314
1481 cf::sync_job { 2315=cut
1482 warn "begin emergency map save\n"; 2316
1483 $_->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;
1484 }; 2374 }
1485 2375
1486 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 }
1487} 2431}
1488 2432
1489package cf; 2433package cf;
1490 2434
1491=back 2435=back
1492
1493 2436
1494=head3 cf::object::player 2437=head3 cf::object::player
1495 2438
1496=over 4 2439=over 4
1497 2440
1500Sends 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>
1501can 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
1502dialogue with the given NPC character. 2445dialogue with the given NPC character.
1503 2446
1504=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};
1505 2462
1506# rough implementation of a future "reply" method that works 2463# rough implementation of a future "reply" method that works
1507# with dialog boxes. 2464# with dialog boxes.
1508#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
1509sub cf::object::player::reply($$$;$) { 2466sub cf::object::player::reply($$$;$) {
1511 2468
1512 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2469 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1513 2470
1514 if ($self->{record_replies}) { 2471 if ($self->{record_replies}) {
1515 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2472 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2473
1516 } 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 {
1517 $msg = $npc->name . " says: $msg" if $npc; 2482 $msg = $npc->name . " says: $msg" if $npc;
1518 $self->message ($msg, $flags); 2483 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2484 }
1519 } 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 (@_);
1520} 2496}
1521 2497
1522=item $player_object->may ("access") 2498=item $player_object->may ("access")
1523 2499
1524Returns wether the given player is authorized to access resource "access" 2500Returns wether the given player is authorized to access resource "access"
1537 2513
1538=item $player_object->enter_link 2514=item $player_object->enter_link
1539 2515
1540Freezes 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}>).
1541 2517
1542The 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.
1543I<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.
1544 2524
1545=item $player_object->leave_link ($map, $x, $y) 2525=item $player_object->leave_link ($map, $x, $y)
1546 2526
1547Moves 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
1548map 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
1549location 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
1550to the emergency map position. 2530fails, to the emergency map position.
1551 2531
1552Might block. 2532Might block.
1553 2533
1554=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}
1555 2545
1556sub cf::object::player::enter_link { 2546sub cf::object::player::enter_link {
1557 my ($self) = @_; 2547 my ($self) = @_;
1558 2548
1559 $self->deactivate_recursive; 2549 $self->deactivate_recursive;
1560 2550
1561 return if $self->map == $LINK_MAP; 2551 return if UNIVERSAL::isa $self->map, "ext::map_link";
1562 2552
1563 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2553 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1564 if $self->map; 2554 if $self->map && $self->map->{path} ne "{link}";
1565 2555
1566 $self->enter_map ($LINK_MAP, 20, 20); 2556 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1567} 2557}
1568 2558
1569sub cf::object::player::leave_link { 2559sub cf::object::player::leave_link {
1570 my ($self, $map, $x, $y) = @_; 2560 my ($self, $map, $x, $y) = @_;
2561
2562 return unless $self->contr->active;
1571 2563
1572 my $link_pos = delete $self->{_link_pos}; 2564 my $link_pos = delete $self->{_link_pos};
1573 2565
1574 unless ($map) { 2566 unless ($map) {
1575 # restore original map position 2567 # restore original map position
1586 ($x, $y) = (-1, -1) 2578 ($x, $y) = (-1, -1)
1587 unless (defined $x) && (defined $y); 2579 unless (defined $x) && (defined $y);
1588 2580
1589 # use -1 or undef as default coordinates, not 0, 0 2581 # use -1 or undef as default coordinates, not 0, 0
1590 ($x, $y) = ($map->enter_x, $map->enter_y) 2582 ($x, $y) = ($map->enter_x, $map->enter_y)
1591 if $x <=0 && $y <= 0; 2583 if $x <= 0 && $y <= 0;
1592 2584
1593 $map->load; 2585 $map->load;
2586 $map->load_neighbours;
1594 2587
1595 return unless $self->contr->active; 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
1596 $self->activate_recursive; 2594 $self->activate_recursive;
1597 $self->enter_map ($map, $x, $y);
1598} 2595}
1599 2596
1600cf::player->attach ( 2597=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1601 on_logout => sub {
1602 my ($pl) = @_;
1603 2598
1604 # abort map switching before logout 2599Moves the player to the given map-path and coordinates by first freezing
1605 if ($pl->ob->{_link_pos}) { 2600her, loading and preparing them map, calling the provided $check callback
1606 cf::sync_job { 2601that has to return the map if sucecssful, and then unfreezes the player on
1607 $pl->ob->leave_link 2602the new (success) or old (failed) map position. In either case, $done will
1608 }; 2603be called at the end of this process.
1609 }
1610 },
1611 on_login => sub {
1612 my ($pl) = @_;
1613 2604
1614 # try to abort aborted map switching on player login :) 2605Note that $check will be called with a potentially non-loaded map, so if
1615 # should happen only on crashes 2606it needs a loaded map it has to call C<< ->load >>.
1616 if ($pl->ob->{_link_pos}) {
1617 $pl->ob->enter_link;
1618 (async {
1619 # we need this sleep as the login has a concurrent enter_exit running
1620 # and this sleep increases chances of the player not ending up in scorn
1621 $pl->ob->reply (undef,
1622 "There was an internal problem at your last logout, "
1623 . "the server will try to bring you to your intended destination in a second.",
1624 cf::NDI_RED);
1625 Coro::Timer::sleep 1;
1626 $pl->ob->leave_link;
1627 })->prio (2);
1628 }
1629 },
1630);
1631 2607
1632=item $player_object->goto ($path, $x, $y)
1633
1634=cut 2608=cut
2609
2610our $GOTOGEN;
1635 2611
1636sub cf::object::player::goto { 2612sub cf::object::player::goto {
1637 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;
1638 2617
1639 $self->enter_link; 2618 $self->enter_link;
1640 2619
1641 (async { 2620 (async {
1642 $path = new cf::path $path; 2621 $Coro::current->{desc} = "player::goto $path $x $y";
1643 2622
1644 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) {
1645 $map = $map->customise_for ($self) if $map; 2646 $map = $map->customise_for ($self);
1646 2647 $map = $check->($map) if $check && $map;
1647# warn "entering ", $map->path, " at ($x, $y)\n" 2648 } else {
1648# if $map;
1649
1650 $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 }
1651 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};
1652 $self->leave_link ($map, $x, $y); 2662 $self->leave_link ($map, $x, $y);
2663 }
2664
2665 $done->() if $done;
1653 })->prio (1); 2666 })->prio (1);
1654} 2667}
1655 2668
1656=item $player_object->enter_exit ($exit_object) 2669=item $player_object->enter_exit ($exit_object)
1657 2670
1659 2672
1660sub parse_random_map_params { 2673sub parse_random_map_params {
1661 my ($spec) = @_; 2674 my ($spec) = @_;
1662 2675
1663 my $rmp = { # defaults 2676 my $rmp = { # defaults
1664 xsize => 10, 2677 xsize => (cf::rndm 15, 40),
1665 ysize => 10, 2678 ysize => (cf::rndm 15, 40),
2679 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2680 #layout => string,
1666 }; 2681 };
1667 2682
1668 for (split /\n/, $spec) { 2683 for (split /\n/, $spec) {
1669 my ($k, $v) = split /\s+/, $_, 2; 2684 my ($k, $v) = split /\s+/, $_, 2;
1670 2685
1682 # that depends on the exit object 2697 # that depends on the exit object
1683 2698
1684 my $rmp = parse_random_map_params $exit->msg; 2699 my $rmp = parse_random_map_params $exit->msg;
1685 2700
1686 if ($exit->map) { 2701 if ($exit->map) {
1687 $rmp->{region} = $exit->map->region_name; 2702 $rmp->{region} = $exit->region->name;
1688 $rmp->{origin_map} = $exit->map->path; 2703 $rmp->{origin_map} = $exit->map->path;
1689 $rmp->{origin_x} = $exit->x; 2704 $rmp->{origin_x} = $exit->x;
1690 $rmp->{origin_y} = $exit->y; 2705 $rmp->{origin_y} = $exit->y;
2706
2707 $exit->map->touch;
1691 } 2708 }
1692 2709
1693 $rmp->{random_seed} ||= $exit->random_seed; 2710 $rmp->{random_seed} ||= $exit->random_seed;
1694 2711
1695 my $data = cf::to_json $rmp; 2712 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1696 my $md5 = Digest::MD5::md5_hex $data; 2713 my $md5 = Digest::MD5::md5_hex $data;
2714 my $meta = "$RANDOMDIR/$md5.meta";
1697 2715
1698 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) {
1699 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;
1700 2720
2721 my $slaying = "?random/$md5";
2722
2723 if ($exit->valid) {
1701 $exit->slaying ("?random/$md5"); 2724 $exit->slaying ("?random/$md5");
1702 $exit->msg (undef); 2725 $exit->msg (undef);
2726 }
1703 } 2727 }
1704} 2728}
1705 2729
1706sub cf::object::player::enter_exit { 2730sub cf::object::player::enter_exit {
1707 my ($self, $exit) = @_; 2731 my ($self, $exit) = @_;
1709 return unless $self->type == cf::PLAYER; 2733 return unless $self->type == cf::PLAYER;
1710 2734
1711 $self->enter_link; 2735 $self->enter_link;
1712 2736
1713 (async { 2737 (async {
1714 $self->deactivate_recursive; # just to be sure 2738 $Coro::current->{desc} = "enter_exit";
2739
1715 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
1716 prepare_random_map $exit 2747 prepare_random_map $exit
1717 if $exit->slaying eq "/!"; 2748 if $exit->slaying eq "/!";
2749 }
1718 2750
1719 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;
1720 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 2752 my $x = $exit->stats->hp;
2753 my $y = $exit->stats->sp;
1721 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
1722 1; 2761 1
1723 }) { 2762 }) {
1724 $self->message ("Something went wrong deep within the crossfire server. " 2763 $self->message ("Something went wrong deep within the deliantra server. "
1725 . "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. "
1726 . "Please report this to the dungeon master", 2765 . "Please report this to the dungeon master!",
1727 cf::NDI_UNIQUE | cf::NDI_RED); 2766 cf::NDI_UNIQUE | cf::NDI_RED);
1728 2767
1729 warn "ERROR in enter_exit: $@"; 2768 warn "ERROR in enter_exit: $@";
1730 $self->leave_link; 2769 $self->leave_link;
1731 } 2770 }
1732 })->prio (1); 2771 })->prio (1);
1745 2784
1746sub cf::client::send_drawinfo { 2785sub cf::client::send_drawinfo {
1747 my ($self, $text, $flags) = @_; 2786 my ($self, $text, $flags) = @_;
1748 2787
1749 utf8::encode $text; 2788 utf8::encode $text;
1750 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2789 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1751} 2790}
1752 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}
1753 3013
1754=item $success = $client->query ($flags, "text", \&cb) 3014=item $success = $client->query ($flags, "text", \&cb)
1755 3015
1756Queues a query to the client, calling the given callback with 3016Queues a query to the client, calling the given callback with
1757the 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>,
1758C<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>.
1759 3019
1760Queries 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
1761reliable at some point in the future. 3021become reliable at some point in the future.
1762 3022
1763=cut 3023=cut
1764 3024
1765sub cf::client::query { 3025sub cf::client::query {
1766 my ($self, $flags, $text, $cb) = @_; 3026 my ($self, $flags, $text, $cb) = @_;
1774 utf8::encode $text; 3034 utf8::encode $text;
1775 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3035 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1776 3036
1777 $self->send_packet ($self->{query_queue}[0][0]) 3037 $self->send_packet ($self->{query_queue}[0][0])
1778 if @{ $self->{query_queue} } == 1; 3038 if @{ $self->{query_queue} } == 1;
3039
3040 1
1779} 3041}
1780 3042
1781cf::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 },
1782 on_reply => sub { 3049 on_reply => sub {
1783 my ($ns, $msg) = @_; 3050 my ($ns, $msg) = @_;
1784 3051
1785 # this weird shuffling is so that direct followup queries 3052 # this weird shuffling is so that direct followup queries
1786 # get handled first 3053 # get handled first
1787 my $queue = delete $ns->{query_queue} 3054 my $queue = delete $ns->{query_queue}
1788 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
1789 3056
1790 (shift @$queue)->[1]->($msg); 3057 (shift @$queue)->[1]->($msg);
3058 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1791 3059
1792 push @{ $ns->{query_queue} }, @$queue; 3060 push @{ $ns->{query_queue} }, @$queue;
1793 3061
1794 if (@{ $ns->{query_queue} } == @$queue) { 3062 if (@{ $ns->{query_queue} } == @$queue) {
1795 if (@$queue) { 3063 if (@$queue) {
1797 } else { 3065 } else {
1798 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3066 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1799 } 3067 }
1800 } 3068 }
1801 }, 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 },
1802); 3096);
1803 3097
1804=item $client->async (\&cb) 3098=item $client->async (\&cb)
1805 3099
1806Create a new coroutine, running the specified callback. The coroutine will 3100Create a new coroutine, running the specified callback. The coroutine will
1847our $safe = new Safe "safe"; 3141our $safe = new Safe "safe";
1848our $safe_hole = new Safe::Hole; 3142our $safe_hole = new Safe::Hole;
1849 3143
1850$SIG{FPE} = 'IGNORE'; 3144$SIG{FPE} = 'IGNORE';
1851 3145
1852$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));
1853 3151
1854# here we export the classes and methods available to script code 3152# here we export the classes and methods available to script code
1855 3153
1856=pod 3154=pod
1857 3155
1858The following fucntions and emthods are available within a safe environment: 3156The following functions and methods are available within a safe environment:
1859 3157
1860 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
1861 cf::object::player player 3163 cf::object::player
1862 cf::player peaceful 3164 player
1863 cf::map trigger 3165
3166 cf::player
3167 peaceful
3168
3169 cf::map
3170 trigger
1864 3171
1865=cut 3172=cut
1866 3173
1867for ( 3174for (
1868 ["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)],
1869 ["cf::object::player" => qw(player)], 3178 ["cf::object::player" => qw(player)],
1870 ["cf::player" => qw(peaceful)], 3179 ["cf::player" => qw(peaceful send_msg)],
1871 ["cf::map" => qw(trigger)], 3180 ["cf::map" => qw(trigger)],
1872) { 3181) {
1873 no strict 'refs'; 3182 no strict 'refs';
1874 my ($pkg, @funs) = @$_; 3183 my ($pkg, @funs) = @$_;
1875 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3184 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1892 my ($code, %vars) = @_; 3201 my ($code, %vars) = @_;
1893 3202
1894 my $qcode = $code; 3203 my $qcode = $code;
1895 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3204 $qcode =~ s/"/‟/g; # not allowed in #line filenames
1896 $qcode =~ s/\n/\\n/g; 3205 $qcode =~ s/\n/\\n/g;
3206
3207 %vars = (_dummy => 0) unless %vars;
1897 3208
1898 local $_; 3209 local $_;
1899 local @safe::cf::_safe_eval_args = values %vars; 3210 local @safe::cf::_safe_eval_args = values %vars;
1900 3211
1901 my $eval = 3212 my $eval =
1944=back 3255=back
1945 3256
1946=cut 3257=cut
1947 3258
1948############################################################################# 3259#############################################################################
3260# the server's init and main functions
1949 3261
1950=head2 EXTENSION DATABASE SUPPORT 3262sub load_facedata($) {
3263 my ($path) = @_;
1951 3264
1952Crossfire maintains a very simple database for extension use. It can 3265 # HACK to clear player env face cache, we need some signal framework
1953currently store anything that can be serialised using Storable, which 3266 # for this (global event?)
1954excludes objects. 3267 %ext::player_env::MUSIC_FACE_CACHE = ();
1955 3268
1956The parameter C<$family> should best start with the name of the extension 3269 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1957using it, it should be unique.
1958 3270
1959=over 4 3271 warn "loading facedata from $path\n";
1960 3272
1961=item $hashref = cf::db_get $family 3273 my $facedata;
3274 0 < aio_load $path, $facedata
3275 or die "$path: $!";
1962 3276
1963Return a hashref for use by the extension C<$family>, which can be 3277 $facedata = Coro::Storable::thaw $facedata;
1964modified. After modifications, you have to call C<cf::db_dirty> or
1965C<cf::db_sync>.
1966 3278
1967=item $value = cf::db_get $family => $key 3279 $facedata->{version} == 2
3280 or cf::cleanup "$path: version mismatch, cannot proceed.";
1968 3281
1969Returns a single value from the database 3282 # patch in the exptable
1970 3283 $facedata->{resource}{"res/exp_table"} = {
1971=item cf::db_put $family => $hashref 3284 type => FT_RSRC,
1972 3285 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1973Stores the given family hashref into the database. Updates are delayed, if
1974you want the data to be synced to disk immediately, use C<cf::db_sync>.
1975
1976=item cf::db_put $family => $key => $value
1977
1978Stores the given C<$value> in the family hash. Updates are delayed, if you
1979want the data to be synced to disk immediately, use C<cf::db_sync>.
1980
1981=item cf::db_dirty
1982
1983Marks the database as dirty, to be updated at a later time.
1984
1985=item cf::db_sync
1986
1987Immediately write the database to disk I<if it is dirty>.
1988
1989=cut
1990
1991our $DB;
1992
1993{
1994 my $path = cf::localdir . "/database.pst";
1995
1996 sub db_load() {
1997 $DB = stat $path ? Storable::retrieve $path : { };
1998 }
1999
2000 my $pid;
2001
2002 sub db_save() {
2003 waitpid $pid, 0 if $pid;
2004 if (0 == ($pid = fork)) {
2005 $DB->{_meta}{version} = 1;
2006 Storable::nstore $DB, "$path~";
2007 rename "$path~", $path;
2008 cf::_exit 0 if defined $pid;
2009 }
2010 }
2011
2012 my $dirty;
2013
2014 sub db_sync() {
2015 db_save if $dirty;
2016 undef $dirty;
2017 }
2018
2019 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2020 db_sync;
2021 }); 3286 };
3287 cf::cede_to_tick;
2022 3288
2023 sub db_dirty() {
2024 $dirty = 1;
2025 $idle->start;
2026 } 3289 {
3290 my $faces = $facedata->{faceinfo};
2027 3291
2028 sub db_get($;$) { 3292 while (my ($face, $info) = each %$faces) {
2029 @_ >= 2 3293 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2030 ? $DB->{$_[0]}{$_[1]}
2031 : ($DB->{$_[0]} ||= { })
2032 }
2033 3294
2034 sub db_put($$;$) { 3295 cf::face::set_visibility $idx, $info->{visibility};
2035 if (@_ >= 3) { 3296 cf::face::set_magicmap $idx, $info->{magicmap};
2036 $DB->{$_[0]}{$_[1]} = $_[2]; 3297 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2037 } else { 3298 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2038 $DB->{$_[0]} = $_[1];
2039 }
2040 db_dirty;
2041 }
2042 3299
2043 cf::global->attach ( 3300 cf::cede_to_tick;
2044 prio => 10000,
2045 on_cleanup => sub {
2046 db_sync;
2047 }, 3301 }
2048 );
2049}
2050 3302
2051############################################################################# 3303 while (my ($face, $info) = each %$faces) {
2052# the server's main() 3304 next unless $info->{smooth};
2053 3305
2054sub 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
2055 open my $fh, "<:utf8", cf::confdir . "/config" 3450 open my $fh, "<:utf8", "$CONFDIR/config"
2056 or return; 3451 or return;
2057 3452
2058 local $/; 3453 local $/;
2059 *CFG = YAML::Syck::Load <$fh>; 3454 *CFG = YAML::XS::Load scalar <$fh>;
2060 3455
2061 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3456 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2062 3457
2063 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3458 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2064 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3459 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2065 3460
2066 if (exists $CFG{mlockall}) { 3461 if (exists $CFG{mlockall}) {
2067 eval { 3462 eval {
2068 $CFG{mlockall} ? &mlockall : &munlockall 3463 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2069 and die "WARNING: m(un)lockall failed: $!\n"; 3464 and die "WARNING: m(un)lockall failed: $!\n";
2070 }; 3465 };
2071 warn $@ if $@; 3466 warn $@ if $@;
2072 } 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;
2073} 3498}
2074 3499
2075sub 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
2076 # we must not ever block the main coroutine 3515 # we must not ever block the main coroutine
2077 local $Coro::idle = sub { 3516 local $Coro::idle = sub {
2078 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#
2079 async { Event::one_event }; 3518 (async {
3519 $Coro::current->{desc} = "IDLE BUG HANDLER";
3520 EV::loop EV::LOOP_ONESHOT;
3521 })->prio (Coro::PRIO_MAX);
2080 }; 3522 };
2081 3523
2082 cfg_load; 3524 evthread_start IO::AIO::poll_fileno;
2083 db_load; 3525
3526 cf::sync_job {
3527 reload_resources;
3528 reload_config;
3529 db_init;
3530
3531 cf::load_settings;
3532 cf::load_materials;
3533 cf::init_uuid;
3534 cf::init_signals;
3535 cf::init_commands;
3536 cf::init_skills;
3537
3538 cf::init_beforeplay;
3539
3540 atomic;
3541
2084 load_extensions; 3542 load_extensions;
2085 Event::loop; 3543
3544 utime time, time, $RUNTIMEFILE;
3545
3546 # no (long-running) fork's whatsoever before this point(!)
3547 use POSIX ();
3548 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3549
3550 (pop @POST_INIT)->(0) while @POST_INIT;
3551 };
3552
3553 main_loop;
2086} 3554}
2087 3555
2088############################################################################# 3556#############################################################################
2089# initialisation 3557# initialisation and cleanup
2090 3558
3559# install some emergency cleanup handlers
3560BEGIN {
3561 our %SIGWATCHER = ();
3562 for my $signal (qw(INT HUP TERM)) {
3563 $SIGWATCHER{$signal} = EV::signal $signal, sub {
3564 cf::cleanup "SIG$signal";
3565 };
3566 }
3567}
3568
3569sub write_runtime_sync {
3570 # first touch the runtime file to show we are still running:
3571 # the fsync below can take a very very long time.
3572
3573 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3574
3575 my $guard = cf::lock_acquire "write_runtime";
3576
3577 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3578 or return;
3579
3580 my $value = $cf::RUNTIME + 90 + 10;
3581 # 10 is the runtime save interval, for a monotonic clock
3582 # 60 allows for the watchdog to kill the server.
3583
3584 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3585 and return;
3586
3587 # always fsync - this file is important
3588 aio_fsync $fh
3589 and return;
3590
3591 # touch it again to show we are up-to-date
3592 aio_utime $fh, undef, undef;
3593
3594 close $fh
3595 or return;
3596
3597 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3598 and return;
3599
3600 warn "runtime file written.\n";
3601
3602 1
3603}
3604
3605our $uuid_lock;
3606our $uuid_skip;
3607
3608sub write_uuid_sync($) {
3609 $uuid_skip ||= $_[0];
3610
3611 return if $uuid_lock;
3612 local $uuid_lock = 1;
3613
3614 my $uuid = "$LOCALDIR/uuid";
3615
3616 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3617 or return;
3618
3619 my $value = uuid_seq uuid_cur;
3620
3621 unless ($value) {
3622 warn "cowardly refusing to write zero uuid value!\n";
3623 return;
3624 }
3625
3626 my $value = uuid_str $value + $uuid_skip;
3627 $uuid_skip = 0;
3628
3629 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3630 and return;
3631
3632 # always fsync - this file is important
3633 aio_fsync $fh
3634 and return;
3635
3636 close $fh
3637 or return;
3638
3639 aio_rename "$uuid~", $uuid
3640 and return;
3641
3642 warn "uuid file written ($value).\n";
3643
3644 1
3645
3646}
3647
3648sub write_uuid($$) {
3649 my ($skip, $sync) = @_;
3650
3651 $sync ? write_uuid_sync $skip
3652 : async { write_uuid_sync $skip };
3653}
3654
3655sub emergency_save() {
3656 my $freeze_guard = cf::freeze_mainloop;
3657
3658 warn "emergency_perl_save: enter\n";
3659
3660 cf::sync_job {
3661 # this is a trade-off: we want to be very quick here, so
3662 # save all maps without fsync, and later call a global sync
3663 # (which in turn might be very very slow)
3664 local $USE_FSYNC = 0;
3665
3666 # use a peculiar iteration method to avoid tripping on perl
3667 # refcount bugs in for. also avoids problems with players
3668 # and maps saved/destroyed asynchronously.
3669 warn "emergency_perl_save: begin player save\n";
3670 for my $login (keys %cf::PLAYER) {
3671 my $pl = $cf::PLAYER{$login} or next;
3672 $pl->valid or next;
3673 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3674 $pl->save;
3675 }
3676 warn "emergency_perl_save: end player save\n";
3677
3678 warn "emergency_perl_save: begin map save\n";
3679 for my $path (keys %cf::MAP) {
3680 my $map = $cf::MAP{$path} or next;
3681 $map->valid or next;
3682 $map->save;
3683 }
3684 warn "emergency_perl_save: end map save\n";
3685
3686 warn "emergency_perl_save: begin database checkpoint\n";
3687 BDB::db_env_txn_checkpoint $DB_ENV;
3688 warn "emergency_perl_save: end database checkpoint\n";
3689
3690 warn "emergency_perl_save: begin write uuid\n";
3691 write_uuid_sync 1;
3692 warn "emergency_perl_save: end write uuid\n";
3693 };
3694
3695 warn "emergency_perl_save: starting sync()\n";
3696 IO::AIO::aio_sync sub {
3697 warn "emergency_perl_save: finished sync()\n";
3698 };
3699
3700 warn "emergency_perl_save: leave\n";
3701}
3702
3703sub post_cleanup {
3704 my ($make_core) = @_;
3705
3706 warn Carp::longmess "post_cleanup backtrace"
3707 if $make_core;
3708
3709 my $fh = pidfile;
3710 unlink $PIDFILE if <$fh> == $$;
3711}
3712
3713# a safer delete_package, copied from Symbol
3714sub clear_package($) {
3715 my $pkg = shift;
3716
3717 # expand to full symbol table name if needed
3718 unless ($pkg =~ /^main::.*::$/) {
3719 $pkg = "main$pkg" if $pkg =~ /^::/;
3720 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3721 $pkg .= '::' unless $pkg =~ /::$/;
3722 }
3723
3724 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3725 my $stem_symtab = *{$stem}{HASH};
3726
3727 defined $stem_symtab and exists $stem_symtab->{$leaf}
3728 or return;
3729
3730 # clear all symbols
3731 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3732 for my $name (keys %$leaf_symtab) {
3733 _gv_clear *{"$pkg$name"};
3734# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3735 }
3736 warn "cleared package $pkg\n";#d#
3737}
3738
2091sub reload() { 3739sub do_reload_perl() {
2092 # can/must only be called in main 3740 # can/must only be called in main
2093 if ($Coro::current != $Coro::main) { 3741 if ($Coro::current != $Coro::main) {
2094 warn "can only reload from main coroutine\n"; 3742 warn "can only reload from main coroutine";
2095 return; 3743 return;
2096 } 3744 }
2097 3745
3746 return if $RELOAD++;
3747
3748 my $t1 = EV::time;
3749
3750 while ($RELOAD) {
2098 warn "reloading..."; 3751 warn "reloading...";
2099 3752
2100 my $guard = freeze_mainloop; 3753 warn "entering sync_job";
3754
3755 cf::sync_job {
3756 cf::write_runtime_sync; # external watchdog should not bark
2101 cf::emergency_save; 3757 cf::emergency_save;
3758 cf::write_runtime_sync; # external watchdog should not bark
2102 3759
2103 eval { 3760 warn "syncing database to disk";
3761 BDB::db_env_txn_checkpoint $DB_ENV;
3762
2104 # if anything goes wrong in here, we should simply crash as we already saved 3763 # if anything goes wrong in here, we should simply crash as we already saved
2105 3764
2106 # cancel all watchers 3765 warn "flushing outstanding aio requests";
2107 for (Event::all_watchers) { 3766 while (IO::AIO::nreqs || BDB::nreqs) {
2108 $_->cancel if $_->data & WF_AUTOCANCEL; 3767 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2109 }
2110
2111 # cancel all extension coros
2112 $_->cancel for values %EXT_CORO;
2113 %EXT_CORO = ();
2114
2115 # unload all extensions
2116 for (@exts) {
2117 warn "unloading <$_>";
2118 unload_extension $_;
2119 }
2120
2121 # unload all modules loaded from $LIBDIR
2122 while (my ($k, $v) = each %INC) {
2123 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2124
2125 warn "removing <$k>";
2126 delete $INC{$k};
2127
2128 $k =~ s/\.pm$//;
2129 $k =~ s/\//::/g;
2130
2131 if (my $cb = $k->can ("unload_module")) {
2132 $cb->();
2133 } 3768 }
2134 3769
2135 Symbol::delete_package $k; 3770 warn "cancelling all extension coros";
3771 $_->cancel for values %EXT_CORO;
3772 %EXT_CORO = ();
3773
3774 warn "removing commands";
3775 %COMMAND = ();
3776
3777 warn "removing ext/exti commands";
3778 %EXTCMD = ();
3779 %EXTICMD = ();
3780
3781 warn "unloading/nuking all extensions";
3782 for my $pkg (@EXTS) {
3783 warn "... unloading $pkg";
3784
3785 if (my $cb = $pkg->can ("unload")) {
3786 eval {
3787 $cb->($pkg);
3788 1
3789 } or warn "$pkg unloaded, but with errors: $@";
3790 }
3791
3792 warn "... clearing $pkg";
3793 clear_package $pkg;
2136 } 3794 }
2137 3795
2138 # sync database to disk 3796 warn "unloading all perl modules loaded from $LIBDIR";
2139 cf::db_sync; 3797 while (my ($k, $v) = each %INC) {
2140 IO::AIO::flush; 3798 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2141 3799
3800 warn "... unloading $k";
3801 delete $INC{$k};
3802
3803 $k =~ s/\.pm$//;
3804 $k =~ s/\//::/g;
3805
3806 if (my $cb = $k->can ("unload_module")) {
3807 $cb->();
3808 }
3809
3810 clear_package $k;
3811 }
3812
2142 # get rid of safe::, as good as possible 3813 warn "getting rid of safe::, as good as possible";
2143 Symbol::delete_package "safe::$_" 3814 clear_package "safe::$_"
2144 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3815 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2145 3816
2146 # remove register_script_function callbacks 3817 warn "unloading cf.pm \"a bit\"";
2147 # TODO
2148
2149 # unload cf.pm "a bit"
2150 delete $INC{"cf.pm"}; 3818 delete $INC{"cf.pm"};
3819 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2151 3820
2152 # don't, removes xs symbols, too, 3821 # don't, removes xs symbols, too,
2153 # and global variables created in xs 3822 # and global variables created in xs
2154 #Symbol::delete_package __PACKAGE__; 3823 #clear_package __PACKAGE__;
2155 3824
2156 # reload cf.pm 3825 warn "unload completed, starting to reload now";
3826
2157 warn "reloading cf.pm"; 3827 warn "reloading cf.pm";
2158 require cf; 3828 require cf;
2159 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3829 cf::_connect_to_perl_1;
2160 3830
2161 # load config and database again 3831 warn "loading config and database again";
2162 cf::cfg_load; 3832 cf::reload_config;
2163 cf::db_load;
2164 3833
2165 # load extensions
2166 warn "load extensions"; 3834 warn "loading extensions";
2167 cf::load_extensions; 3835 cf::load_extensions;
2168 3836
2169 # reattach attachments to objects 3837 if ($REATTACH_ON_RELOAD) {
3838 warn "reattaching attachments to objects/players";
3839 _global_reattach; # objects, sockets
3840 warn "reattaching attachments to maps";
3841 reattach $_ for values %MAP;
3842 warn "reattaching attachments to players";
3843 reattach $_ for values %PLAYER;
3844 }
3845
3846 warn "running post_init jobs";
3847 (pop @POST_INIT)->(1) while @POST_INIT;
3848
3849 warn "leaving sync_job";
3850
3851 1
3852 } or do {
3853 warn $@;
3854 cf::cleanup "error while reloading, exiting.";
3855 };
3856
2170 warn "reattach"; 3857 warn "reloaded";
2171 _global_reattach; 3858 --$RELOAD;
3859 }
3860
3861 $t1 = EV::time - $t1;
3862 warn "reload completed in ${t1}s\n";
3863};
3864
3865our $RELOAD_WATCHER; # used only during reload
3866
3867sub reload_perl() {
3868 # doing reload synchronously and two reloads happen back-to-back,
3869 # coro crashes during coro_state_free->destroy here.
3870
3871 $RELOAD_WATCHER ||= cf::async {
3872 Coro::AIO::aio_wait cache_extensions;
3873
3874 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3875 do_reload_perl;
3876 undef $RELOAD_WATCHER;
3877 };
2172 }; 3878 };
2173
2174 if ($@) {
2175 warn $@;
2176 warn "error while reloading, exiting.";
2177 exit 1;
2178 }
2179
2180 warn "reloaded successfully";
2181};
2182
2183#############################################################################
2184
2185unless ($LINK_MAP) {
2186 $LINK_MAP = cf::map::new;
2187
2188 $LINK_MAP->width (41);
2189 $LINK_MAP->height (41);
2190 $LINK_MAP->alloc;
2191 $LINK_MAP->path ("{link}");
2192 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2193 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2194
2195 # dirty hack because... archetypes are not yet loaded
2196 Event->timer (
2197 after => 10,
2198 cb => sub {
2199 $_[0]->w->cancel;
2200
2201 # provide some exits "home"
2202 my $exit = cf::object::new "exit";
2203
2204 $exit->slaying ($EMERGENCY_POSITION->[0]);
2205 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2206 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2207
2208 $LINK_MAP->insert ($exit->clone, 19, 19);
2209 $LINK_MAP->insert ($exit->clone, 19, 20);
2210 $LINK_MAP->insert ($exit->clone, 19, 21);
2211 $LINK_MAP->insert ($exit->clone, 20, 19);
2212 $LINK_MAP->insert ($exit->clone, 20, 21);
2213 $LINK_MAP->insert ($exit->clone, 21, 19);
2214 $LINK_MAP->insert ($exit->clone, 21, 20);
2215 $LINK_MAP->insert ($exit->clone, 21, 21);
2216
2217 $exit->destroy;
2218 });
2219
2220 $LINK_MAP->{deny_save} = 1;
2221 $LINK_MAP->{deny_reset} = 1;
2222
2223 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2224} 3879}
2225
2226register "<global>", __PACKAGE__;
2227 3880
2228register_command "reload" => sub { 3881register_command "reload" => sub {
2229 my ($who, $arg) = @_; 3882 my ($who, $arg) = @_;
2230 3883
2231 if ($who->flag (FLAG_WIZ)) { 3884 if ($who->flag (FLAG_WIZ)) {
2232 $who->message ("start of reload.");
2233 reload;
2234 $who->message ("end of reload."); 3885 $who->message ("reloading server.");
3886 async {
3887 $Coro::current->{desc} = "perl_reload";
3888 reload_perl;
3889 };
2235 } 3890 }
2236}; 3891};
2237 3892
2238unshift @INC, $LIBDIR; 3893unshift @INC, $LIBDIR;
2239 3894
2240$TICK_WATCHER = Event->timer ( 3895my $bug_warning = 0;
2241 reentrant => 0, 3896
2242 prio => 0, 3897our @WAIT_FOR_TICK;
2243 at => $NEXT_TICK || $TICK, 3898our @WAIT_FOR_TICK_BEGIN;
2244 data => WF_AUTOCANCEL, 3899
2245 cb => sub { 3900sub wait_for_tick {
3901 return if tick_inhibit || $Coro::current == $Coro::main;
3902
3903 my $signal = new Coro::Signal;
3904 push @WAIT_FOR_TICK, $signal;
3905 $signal->wait;
3906}
3907
3908sub wait_for_tick_begin {
3909 return if tick_inhibit || $Coro::current == $Coro::main;
3910
3911 my $signal = new Coro::Signal;
3912 push @WAIT_FOR_TICK_BEGIN, $signal;
3913 $signal->wait;
3914}
3915
3916sub tick {
3917 if ($Coro::current != $Coro::main) {
3918 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3919 unless ++$bug_warning > 10;
3920 return;
3921 }
3922
2246 cf::server_tick; # one server iteration 3923 cf::server_tick; # one server iteration
2247 $RUNTIME += $TICK;
2248 $NEXT_TICK += $TICK;
2249 3924
2250 # if we are delayed by four ticks or more, skip them all 3925 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2251 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3926 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2252 3927 Coro::async_pool {
2253 $TICK_WATCHER->at ($NEXT_TICK); 3928 $Coro::current->{desc} = "runtime saver";
2254 $TICK_WATCHER->start;
2255 },
2256);
2257
2258IO::AIO::max_poll_time $TICK * 0.2;
2259
2260Event->io (
2261 fd => IO::AIO::poll_fileno,
2262 poll => 'r',
2263 prio => 5,
2264 data => WF_AUTOCANCEL,
2265 cb => \&IO::AIO::poll_cb,
2266);
2267
2268Event->timer (
2269 data => WF_AUTOCANCEL,
2270 after => 0,
2271 interval => 10,
2272 cb => sub {
2273 (Coro::unblock_sub {
2274 write_runtime 3929 write_runtime_sync
2275 or warn "ERROR: unable to write runtime file: $!"; 3930 or warn "ERROR: unable to write runtime file: $!";
2276 })->(); 3931 };
2277 }, 3932 }
2278); 3933
3934 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3935 $sig->send;
3936 }
3937 while (my $sig = shift @WAIT_FOR_TICK) {
3938 $sig->send;
3939 }
3940
3941 $LOAD = ($NOW - $TICK_START) / $TICK;
3942 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3943
3944 if (0) {
3945 if ($NEXT_TICK) {
3946 my $jitter = $TICK_START - $NEXT_TICK;
3947 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3948 warn "jitter $JITTER\n";#d#
3949 }
3950 }
3951}
3952
3953{
3954 # configure BDB
3955
3956 BDB::min_parallel 8;
3957 BDB::max_poll_reqs $TICK * 0.1;
3958 $AnyEvent::BDB::WATCHER->priority (1);
3959
3960 unless ($DB_ENV) {
3961 $DB_ENV = BDB::db_env_create;
3962 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3963 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3964 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3965 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3966 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3967
3968 cf::sync_job {
3969 eval {
3970 BDB::db_env_open
3971 $DB_ENV,
3972 $BDBDIR,
3973 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3974 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3975 0666;
3976
3977 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3978 };
3979
3980 cf::cleanup "db_env_open(db): $@" if $@;
3981 };
3982 }
3983
3984 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3985 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3986 };
3987 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3988 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3989 };
3990 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3991 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3992 };
3993}
3994
3995{
3996 # configure IO::AIO
3997
3998 IO::AIO::min_parallel 8;
3999 IO::AIO::max_poll_time $TICK * 0.1;
4000 undef $AnyEvent::AIO::WATCHER;
4001}
4002
4003my $_log_backtrace;
4004
4005sub _log_backtrace {
4006 my ($msg, @addr) = @_;
4007
4008 $msg =~ s/\n//;
4009
4010 # limit the # of concurrent backtraces
4011 if ($_log_backtrace < 2) {
4012 ++$_log_backtrace;
4013 my $perl_bt = Carp::longmess $msg;
4014 async {
4015 $Coro::current->{desc} = "abt $msg";
4016
4017 my @bt = fork_call {
4018 @addr = map { sprintf "%x", $_ } @addr;
4019 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4020 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4021 or die "addr2line: $!";
4022
4023 my @funcs;
4024 my @res = <$fh>;
4025 chomp for @res;
4026 while (@res) {
4027 my ($func, $line) = splice @res, 0, 2, ();
4028 push @funcs, "[$func] $line";
4029 }
4030
4031 @funcs
4032 };
4033
4034 LOG llevInfo, "[ABT] $perl_bt\n";
4035 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4036 LOG llevInfo, "[ABT] $_\n" for @bt;
4037 --$_log_backtrace;
4038 };
4039 } else {
4040 LOG llevInfo, "[ABT] $msg\n";
4041 LOG llevInfo, "[ABT] [suppressed]\n";
4042 }
4043}
4044
4045# load additional modules
4046require "cf/$_.pm" for @EXTRA_MODULES;
4047cf::_connect_to_perl_2;
2279 4048
2280END { cf::emergency_save } 4049END { cf::emergency_save }
2281 4050
22821 40511
2283 4052

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines