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.131 by root, Thu Jan 4 00:53:54 2007 UTC vs.
Revision 1.515 by root, Thu Apr 15 04:56:47 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines