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.135 by root, Thu Jan 4 20:29:46 2007 UTC vs.
Revision 1.516 by root, Thu Apr 15 06:05:52 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 $RANDOM_MAPS = cf::localdir . "/random"; 136our $LINK_MAP; # the special {link} map, which is always available
55our %EXT_CORO; 137
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 :)
56 150
57binmode STDOUT; 151binmode STDOUT;
58binmode STDERR; 152binmode STDERR;
59 153
60# read virtual server time, if available 154# read virtual server time, if available
61unless ($RUNTIME || !-e cf::localdir . "/runtime") { 155unless ($RUNTIME || !-e $RUNTIMEFILE) {
62 open my $fh, "<", cf::localdir . "/runtime" 156 open my $fh, "<", $RUNTIMEFILE
63 or die "unable to read runtime file: $!"; 157 or die "unable to read $RUNTIMEFILE file: $!";
64 $RUNTIME = <$fh> + 0.; 158 $RUNTIME = <$fh> + 0.;
65} 159}
66 160
67mkdir cf::localdir; 161eval "sub TICK() { $TICK } 1" or die;
68mkdir cf::localdir . "/" . cf::playerdir;
69mkdir cf::localdir . "/" . cf::tmpdir;
70mkdir cf::localdir . "/" . cf::uniquedir;
71mkdir $RANDOM_MAPS;
72 162
73# a special map that is always available 163mkdir $_
74our $LINK_MAP; 164 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
165
75our $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::"} };
76 180
77############################################################################# 181#############################################################################
78 182
79=head2 GLOBAL VARIABLES 183=head2 GLOBAL VARIABLES
80 184
87=item $cf::RUNTIME 191=item $cf::RUNTIME
88 192
89The 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
90every server tick. 194every server tick.
91 195
92=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
93 199
94The perl library directory, where extensions and cf-specific modules can 200Various directories - "/etc", read-only install directory, perl-library
95be 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.
96 204
97=item $cf::NOW 205=item $cf::NOW
98 206
99The time of the last (current) server tick. 207The time of the last (current) server tick.
100 208
101=item $cf::TICK 209=item $cf::TICK
102 210
103The interval between server ticks, in seconds. 211The interval between server ticks, in seconds.
104 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
105=item %cf::CFG 223=item %cf::CFG
106 224
107Configuration for the server, loaded from C</etc/crossfire/config>, or 225Configuration for the server, loaded from C</etc/deliantra-server/config>, or
108from wherever your confdir points to. 226from wherever your confdir points to.
109 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
110=back 246=back
111 247
112=cut 248=cut
113 249
114BEGIN { 250$Coro::State::WARNHOOK = sub {
115 *CORE::GLOBAL::warn = sub {
116 my $msg = join "", @_; 251 my $msg = join "", @_;
117 utf8::encode $msg;
118 252
119 $msg .= "\n" 253 $msg .= "\n"
120 unless $msg =~ /\n$/; 254 unless $msg =~ /\n$/;
121 255
256 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
257
122 LOG llevError, "cfperl: $msg"; 258 LOG llevError, $msg;
123 }; 259};
124} 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};
125 274
126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 275@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 276@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 277@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 278@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130@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';
131@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)
132 282
133# 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
134# within the Safe compartment. 284# within the Safe compartment.
135for my $pkg (qw( 285for my $pkg (qw(
136 cf::global cf::attachable 286 cf::global cf::attachable
137 cf::object cf::object::player 287 cf::object cf::object::player
138 cf::client cf::player 288 cf::client cf::player
139 cf::arch cf::living 289 cf::arch cf::living
290 cf::map cf::mapspace
140 cf::map cf::party cf::region 291 cf::party cf::region
141)) { 292)) {
142 no strict 'refs';
143 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 293 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
144} 294}
145 295
146$Event::DIED = sub { 296$EV::DIED = sub {
147 warn "error in event callback: @_"; 297 Carp::cluck "error in event callback: @_";
148}; 298};
149 299
150my %ext_pkg; 300#############################################################################
151my @exts;
152my @hook;
153 301
154=head2 UTILITY FUNCTIONS 302=head2 UTILITY FUNCTIONS
155 303
156=over 4 304=over 4
157 305
158=cut 306=item dumpval $ref
159 307
160use JSON::Syck (); # TODO# replace by JSON::PC once working 308=cut
161 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
162=item $ref = cf::from_json $json 329=item $ref = cf::decode_json $json
163 330
164Converts a JSON string into the corresponding perl data structure. 331Converts a JSON string into the corresponding perl data structure.
165 332
166=cut
167
168sub from_json($) {
169 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170 JSON::Syck::Load $_[0]
171}
172
173=item $json = cf::to_json $ref 333=item $json = cf::encode_json $ref
174 334
175Converts a perl data structure into its JSON representation. 335Converts a perl data structure into its JSON representation.
176 336
177=cut 337=cut
178 338
179sub to_json($) { 339our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 340
181 JSON::Syck::Dump $_[0] 341sub encode_json($) { $json_coder->encode ($_[0]) }
342sub decode_json($) { $json_coder->decode ($_[0]) }
343
344=item cf::post_init { BLOCK }
345
346Execute the given codeblock, I<after> all extensions have been (re-)loaded,
347but I<before> the server starts ticking again.
348
349The cdoeblock will have a single boolean argument to indicate whether this
350is a reload or not.
351
352=cut
353
354sub post_init(&) {
355 push @POST_INIT, shift;
182} 356}
183 357
184=item cf::lock_wait $string 358=item cf::lock_wait $string
185 359
186Wait until the given lock is available. See cf::lock_acquire. 360Wait until the given lock is available. See cf::lock_acquire.
187 361
188=item my $lock = cf::lock_acquire $string 362=item my $lock = cf::lock_acquire $string
189 363
190Wait 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
191a Coro::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,
192for example when the coroutine gets canceled), the lock is automatically 366for example when the coroutine gets canceled), the lock is automatically
193returned. 367returned.
194 368
369Locks are *not* recursive, locking from the same coro twice results in a
370deadlocked coro.
371
195Lock names should begin with a unique identifier (for example, cf::map::find 372Lock names should begin with a unique identifier (for example, cf::map::find
196uses map_find and cf::map::load uses map_load). 373uses map_find and cf::map::load uses map_load).
197 374
198=cut 375=item $locked = cf::lock_active $string
199 376
200our %LOCK; 377Return true if the lock is currently active, i.e. somebody has locked it.
378
379=cut
380
381our $LOCKS = new Coro::SemaphoreSet;
201 382
202sub lock_wait($) { 383sub lock_wait($) {
203 my ($key) = @_; 384 $LOCKS->wait ($_[0]);
204
205 # wait for lock, if any
206 while ($LOCK{$key}) {
207 push @{ $LOCK{$key} }, $Coro::current;
208 Coro::schedule;
209 }
210} 385}
211 386
212sub lock_acquire($) { 387sub lock_acquire($) {
213 my ($key) = @_; 388 $LOCKS->guard ($_[0])
389}
214 390
215 # wait, to be sure we are not locked 391sub lock_active($) {
216 lock_wait $key; 392 $LOCKS->count ($_[0]) < 1
393}
217 394
218 $LOCK{$key} = []; 395sub freeze_mainloop {
396 tick_inhibit_inc;
219 397
220 Coro::guard { 398 &Guard::guard (\&tick_inhibit_dec);
221 # wake up all waiters, to be on the safe side 399}
222 $_->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 }
223 } 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;
224} 481}
225 482
226=item cf::async { BLOCK } 483=item cf::async { BLOCK }
227 484
228Like 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
229error 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.
230 488
231=cut 489=cut
232 490
233sub async(&) { 491BEGIN { *async = \&Coro::async_pool }
234 my ($cb) = @_;
235
236 Coro::async {
237 eval { $cb->() };
238 warn $@ if $@;
239 }
240}
241
242sub freeze_mainloop {
243 return unless $TICK_WATCHER->is_active;
244
245 my $guard = Coro::guard { $TICK_WATCHER->start };
246 $TICK_WATCHER->stop;
247 $guard
248}
249 492
250=item cf::sync_job { BLOCK } 493=item cf::sync_job { BLOCK }
251 494
252The design of crossfire+ requires that the main coro ($Coro::main) is 495The design of Deliantra requires that the main coroutine ($Coro::main)
253always able to handle events or runnable, as crossfire+ is only partly 496is always able to handle events or runnable, as Deliantra is only
254reentrant. 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.
255 499
256If 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
257the given BLOCK in another coroutine while waiting for the result. The 501the given BLOCK in another coroutine while waiting for the result. The
258server 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
259fast or be very important. 503fast or be very important.
262 506
263sub sync_job(&) { 507sub sync_job(&) {
264 my ($job) = @_; 508 my ($job) = @_;
265 509
266 if ($Coro::current == $Coro::main) { 510 if ($Coro::current == $Coro::main) {
511 my $time = AE::time;
512
267 # this is the main coro, too bad, we have to block 513 # this is the main coro, too bad, we have to block
268 # till the operation succeeds, freezing the server :/ 514 # till the operation succeeds, freezing the server :/
269 515
270 # TODO: use suspend/resume instead 516 LOG llevError, Carp::longmess "sync job";#d#
271 # (but this is cancel-safe) 517
272 my $freeze_guard = freeze_mainloop; 518 my $freeze_guard = freeze_mainloop;
273 519
274 my $busy = 1; 520 my $busy = 1;
275 my @res; 521 my @res;
276 522
277 (Coro::async { 523 (async {
524 $Coro::current->desc ("sync job coro");
278 @res = eval { $job->() }; 525 @res = eval { $job->() };
279 warn $@ if $@; 526 warn $@ if $@;
280 undef $busy; 527 undef $busy;
281 })->prio (Coro::PRIO_MAX); 528 })->prio (Coro::PRIO_MAX);
282 529
283 while ($busy) { 530 while ($busy) {
531 if (Coro::nready) {
284 Coro::cede_notself; 532 Coro::cede_notself;
285 Event::one_event unless Coro::nready; 533 } else {
534 EV::loop EV::LOOP_ONESHOT;
286 } 535 }
536 }
537
538 my $time = AE::time - $time;
539
540 $TICK_START += $time; # do not account sync jobs to server load
287 541
288 wantarray ? @res : $res[0] 542 wantarray ? @res : $res[0]
289 } else { 543 } else {
290 # we are in another coroutine, how wonderful, everything just works 544 # we are in another coroutine, how wonderful, everything just works
291 545
292 $job->() 546 $job->()
293 } 547 }
294} 548}
295 549
296=item $coro = cf::coro { BLOCK } 550=item $coro = cf::async_ext { BLOCK }
297 551
298Creates and returns a new coro. This coro is automcatially being canceled 552Like async, but this coro is automatically being canceled when the
299when the extension calling this is being unloaded. 553extension calling this is being unloaded.
300 554
301=cut 555=cut
302 556
303sub coro(&) { 557sub async_ext(&) {
304 my $cb = shift; 558 my $cb = shift;
305 559
306 my $coro = &cf::async ($cb); 560 my $coro = &Coro::async ($cb);
307 561
308 $coro->on_destroy (sub { 562 $coro->on_destroy (sub {
309 delete $EXT_CORO{$coro+0}; 563 delete $EXT_CORO{$coro+0};
310 }); 564 });
311 $EXT_CORO{$coro+0} = $coro; 565 $EXT_CORO{$coro+0} = $coro;
312 566
313 $coro 567 $coro
314} 568}
315 569
316sub write_runtime { 570=item fork_call { }, $args
317 my $runtime = cf::localdir . "/runtime";
318 571
319 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 572Executes the given code block with the given arguments in a seperate
320 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.
321 576
322 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 577=cut
323 (aio_write $fh, 0, (length $value), $value, 0) <= 0
324 and return;
325 578
326 aio_fsync $fh 579sub fork_call(&@) {
327 and return; 580 my ($cb, @args) = @_;
328 581
329 close $fh 582 # we seemingly have to make a local copy of the whole thing,
330 or return; 583 # otherwise perl prematurely frees the stuff :/
584 # TODO: investigate and fix (likely this will be rather laborious)
331 585
332 aio_rename "$runtime~", $runtime 586 my @res = Coro::Util::fork_eval {
333 and return; 587 reset_signals;
588 &$cb
589 }, @args;
334 590
591 wantarray ? @res : $res[-1]
592}
593
594sub objinfo {
335 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 });
336} 768}
337 769
338=back 770=back
339 771
340=cut 772=cut
341 773
342############################################################################# 774#############################################################################
343 775
344package cf::path;
345
346sub new {
347 my ($class, $path, $base) = @_;
348
349 $path = $path->as_string if ref $path;
350
351 my $self = bless { }, $class;
352
353 # {... are special paths that are not touched
354 # ?xxx/... are special absolute paths
355 # ?random/... random maps
356 # /! non-realised random map exit
357 # /... normal maps
358 # ~/... per-player maps without a specific player (DO NOT USE)
359 # ~user/... per-player map of a specific user
360
361 if ($path =~ /^{/) {
362 # fine as it is
363 } elsif ($path =~ s{^\?random/}{}) {
364 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
365 $self->{random} = cf::from_json $data;
366 } else {
367 if ($path =~ s{^~([^/]+)?}{}) {
368 $self->{user_rel} = 1;
369
370 if (defined $1) {
371 $self->{user} = $1;
372 } elsif ($base =~ m{^~([^/]+)/}) {
373 $self->{user} = $1;
374 } else {
375 warn "cannot resolve user-relative path without user <$path,$base>\n";
376 }
377 } elsif ($path =~ /^\//) {
378 # already absolute
379 } else {
380 $base =~ s{[^/]+/?$}{};
381 return $class->new ("$base/$path");
382 }
383
384 for ($path) {
385 redo if s{/\.?/}{/};
386 redo if s{/[^/]+/\.\./}{/};
387 }
388 }
389
390 $self->{path} = $path;
391
392 $self
393}
394
395# the name / primary key / in-game path
396sub as_string {
397 my ($self) = @_;
398
399 $self->{user_rel} ? "~$self->{user}$self->{path}"
400 : $self->{random} ? "?random/$self->{path}"
401 : $self->{path}
402}
403
404# the displayed name, this is a one way mapping
405sub visible_name {
406 my ($self) = @_;
407
408# if (my $rmp = $self->{random}) {
409# # todo: be more intelligent about this
410# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
411# } else {
412 $self->as_string
413# }
414}
415
416# escape the /'s in the path
417sub _escaped_path {
418 # ∕ is U+2215
419 (my $path = $_[0]{path}) =~ s/\//∕/g;
420 $path
421}
422
423# the original (read-only) location
424sub load_path {
425 my ($self) = @_;
426
427 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
428}
429
430# the temporary/swap location
431sub save_path {
432 my ($self) = @_;
433
434 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
435 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
436 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
437}
438
439# the unique path, might be eq to save_path
440sub uniq_path {
441 my ($self) = @_;
442
443 $self->{user_rel} || $self->{random}
444 ? undef
445 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
446}
447
448# return random map parameters, or undef
449sub random_map_params {
450 my ($self) = @_;
451
452 $self->{random}
453}
454
455# this is somewhat ugly, but style maps do need special treatment
456sub is_style_map {
457 $_[0]{path} =~ m{^/styles/}
458}
459
460package cf;
461
462#############################################################################
463
464=head2 ATTACHABLE OBJECTS 776=head2 ATTACHABLE OBJECTS
465 777
466Many 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
467attach callbacks/event handlers (a collection of which is called an "attachment") 779attach callbacks/event handlers (a collection of which is called an "attachment")
468to it. All such attachable objects support the following methods. 780to it. All such attachable objects support the following methods.
469 781
470In 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>
471C<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
472crossfire+). 784Deliantra).
473 785
474=over 4 786=over 4
475 787
476=item $attachable->attach ($attachment, key => $value...) 788=item $attachable->attach ($attachment, key => $value...)
477 789
521=item cf::CLASS::attachment $name, ... 833=item cf::CLASS::attachment $name, ...
522 834
523Register an attachment by C<$name> through which attachable objects of the 835Register an attachment by C<$name> through which attachable objects of the
524given CLASS can refer to this attachment. 836given CLASS can refer to this attachment.
525 837
526Some classes such as crossfire maps and objects can specify attachments 838Some classes such as deliantra maps and objects can specify attachments
527that 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.
528 840
529These calls expect any number of the following handler/hook descriptions: 841These calls expect any number of the following handler/hook descriptions:
530 842
531=over 4 843=over 4
591our @CB_TYPE = (); # registry for type (cf-object class) based events 903our @CB_TYPE = (); # registry for type (cf-object class) based events
592our @CB_MAP = (); 904our @CB_MAP = ();
593 905
594my %attachment; 906my %attachment;
595 907
908sub cf::attachable::thawer_merge {
909 # simply override everything except _meta
910 local $_[0]{_meta};
911 %{$_[0]} = %{$_[1]};
912}
913
596sub _attach_cb($$$$) { 914sub _attach_cb($$$$) {
597 my ($registry, $event, $prio, $cb) = @_; 915 my ($registry, $event, $prio, $cb) = @_;
598 916
599 use sort 'stable'; 917 use sort 'stable';
600 918
634 $registry = $CB_TYPE[$object_type] ||= []; 952 $registry = $CB_TYPE[$object_type] ||= [];
635 953
636 } elsif ($type eq "subtype") { 954 } elsif ($type eq "subtype") {
637 defined $object_type or Carp::croak "subtype specified without type"; 955 defined $object_type or Carp::croak "subtype specified without type";
638 my $object_subtype = shift @arg; 956 my $object_subtype = shift @arg;
639 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 957 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
640 958
641 } elsif ($type eq "package") { 959 } elsif ($type eq "package") {
642 my $pkg = shift @arg; 960 my $pkg = shift @arg;
643 961
644 while (my ($name, $id) = each %cb_id) { 962 while (my ($name, $id) = each %cb_id) {
673 _attach $registry, $klass, @attach; 991 _attach $registry, $klass, @attach;
674 } 992 }
675 993
676 $obj->{$name} = \%arg; 994 $obj->{$name} = \%arg;
677 } else { 995 } else {
678 warn "object uses attachment '$name' that is not available, postponing.\n"; 996 warn "object uses attachment '$name' which is not available, postponing.\n";
679 } 997 }
680 998
681 $obj->{_attachment}{$name} = undef; 999 $obj->{_attachment}{$name} = undef;
682} 1000}
683 1001
685 if (ref $_[0]) { 1003 if (ref $_[0]) {
686 _object_attach @_; 1004 _object_attach @_;
687 } else { 1005 } else {
688 _attach shift->_attach_registry, @_; 1006 _attach shift->_attach_registry, @_;
689 } 1007 }
1008 _recalc_want;
690}; 1009};
691 1010
692# all those should be optimised 1011# all those should be optimised
693sub cf::attachable::detach { 1012sub cf::attachable::detach {
694 my ($obj, $name) = @_; 1013 my ($obj, $name) = @_;
697 delete $obj->{_attachment}{$name}; 1016 delete $obj->{_attachment}{$name};
698 reattach ($obj); 1017 reattach ($obj);
699 } else { 1018 } else {
700 Carp::croak "cannot, currently, detach class attachments"; 1019 Carp::croak "cannot, currently, detach class attachments";
701 } 1020 }
1021 _recalc_want;
702}; 1022};
703 1023
704sub cf::attachable::attached { 1024sub cf::attachable::attached {
705 my ($obj, $name) = @_; 1025 my ($obj, $name) = @_;
706 1026
721 "; 1041 ";
722 die if $@; 1042 die if $@;
723} 1043}
724 1044
725our $override; 1045our $override;
726our @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?
727 1047
728sub override { 1048sub override {
729 $override = 1; 1049 $override = 1;
730 @invoke_results = (); 1050 @INVOKE_RESULTS = (@_);
731} 1051}
732 1052
733sub do_invoke { 1053sub do_invoke {
734 my $event = shift; 1054 my $event = shift;
735 my $callbacks = shift; 1055 my $callbacks = shift;
736 1056
737 @invoke_results = (); 1057 @INVOKE_RESULTS = ();
738 1058
739 local $override; 1059 local $override;
740 1060
741 for (@$callbacks) { 1061 for (@$callbacks) {
742 eval { &{$_->[1]} }; 1062 eval { &{$_->[1]} };
751 } 1071 }
752 1072
753 0 1073 0
754} 1074}
755 1075
756=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1076=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
757 1077
758=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1078=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
759 1079
760Generate an object-specific event with the given arguments. 1080Generate an object-specific event with the given arguments.
761 1081
762This 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
763removed 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
764results (if you must, access C<@cf::invoke_results> directly). 1084results (if you must, access C<@cf::INVOKE_RESULTS> directly).
765 1085
766=back 1086=back
767 1087
768=cut 1088=cut
769 1089
770############################################################################# 1090#############################################################################
771# 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}
772 1134
773sub reattach { 1135sub reattach {
774 # basically do the same as instantiate, without calling instantiate 1136 # basically do the same as instantiate, without calling instantiate
775 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
776 1141
777 my $registry = $obj->registry; 1142 my $registry = $obj->registry;
778 1143
779 @$registry = (); 1144 @$registry = ();
780 1145
795cf::attachable->attach ( 1160cf::attachable->attach (
796 prio => -1000000, 1161 prio => -1000000,
797 on_instantiate => sub { 1162 on_instantiate => sub {
798 my ($obj, $data) = @_; 1163 my ($obj, $data) = @_;
799 1164
800 $data = from_json $data; 1165 $data = decode_json $data;
801 1166
802 for (@$data) { 1167 for (@$data) {
803 my ($name, $args) = @$_; 1168 my ($name, $args) = @$_;
804 1169
805 $obj->attach ($name, %{$args || {} }); 1170 $obj->attach ($name, %{$args || {} });
821sub object_freezer_save { 1186sub object_freezer_save {
822 my ($filename, $rdata, $objs) = @_; 1187 my ($filename, $rdata, $objs) = @_;
823 1188
824 sync_job { 1189 sync_job {
825 if (length $$rdata) { 1190 if (length $$rdata) {
1191 utf8::decode (my $decname = $filename);
826 warn sprintf "saving %s (%d,%d)\n", 1192 warn sprintf "saving %s (%d,%d)\n",
827 $filename, length $$rdata, scalar @$objs; 1193 $decname, length $$rdata, scalar @$objs;
828 1194
829 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1195 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
830 chmod SAVE_MODE, $fh; 1196 aio_chmod $fh, SAVE_MODE;
831 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;
832 aio_fsync $fh; 1200 aio_fsync $fh;
1201 }
833 close $fh; 1202 aio_close $fh;
834 1203
835 if (@$objs) { 1204 if (@$objs) {
836 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) {
837 chmod SAVE_MODE, $fh; 1206 aio_chmod $fh, SAVE_MODE;
838 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1207 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
839 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;
840 aio_fsync $fh; 1211 aio_fsync $fh;
1212 }
841 close $fh; 1213 aio_close $fh;
842 aio_rename "$filename.pst~", "$filename.pst"; 1214 aio_rename "$filename.pst~", "$filename.pst";
843 } 1215 }
844 } else { 1216 } else {
845 aio_unlink "$filename.pst"; 1217 aio_unlink "$filename.pst";
846 } 1218 }
847 1219
848 aio_rename "$filename~", $filename; 1220 aio_rename "$filename~", $filename;
1221
1222 $filename =~ s%/[^/]+$%%;
1223 aio_pathsync $filename if $cf::USE_FSYNC;
849 } else { 1224 } else {
850 warn "FATAL: $filename~: $!\n"; 1225 warn "unable to save objects: $filename~: $!\n";
851 } 1226 }
852 } else { 1227 } else {
853 aio_unlink $filename; 1228 aio_unlink $filename;
854 aio_unlink "$filename.pst"; 1229 aio_unlink "$filename.pst";
855 } 1230 }
856 } 1231 };
857} 1232}
858 1233
859sub object_freezer_as_string { 1234sub object_freezer_as_string {
860 my ($rdata, $objs) = @_; 1235 my ($rdata, $objs) = @_;
861 1236
873 or return; 1248 or return;
874 1249
875 unless (aio_stat "$filename.pst") { 1250 unless (aio_stat "$filename.pst") {
876 (aio_load "$filename.pst", $av) >= 0 1251 (aio_load "$filename.pst", $av) >= 0
877 or return; 1252 or return;
1253
878 $av = eval { (Storable::thaw $av)->{objs} }; 1254 my $st = eval { Coro::Storable::thaw $av };
1255 $av = $st->{objs};
879 } 1256 }
880 1257
1258 utf8::decode (my $decname = $filename);
881 warn sprintf "loading %s (%d)\n", 1259 warn sprintf "loading %s (%d,%d)\n",
882 $filename, length $data, scalar @{$av || []};#d# 1260 $decname, length $data, scalar @{$av || []};
1261
883 return ($data, $av); 1262 ($data, $av)
884} 1263}
1264
1265=head2 COMMAND CALLBACKS
1266
1267=over 4
1268
1269=cut
885 1270
886############################################################################# 1271#############################################################################
887# command handling &c 1272# command handling &c
888 1273
889=item cf::register_command $name => \&callback($ob,$args); 1274=item cf::register_command $name => \&callback($ob,$args);
902 push @{ $COMMAND{$name} }, [$caller, $cb]; 1287 push @{ $COMMAND{$name} }, [$caller, $cb];
903} 1288}
904 1289
905=item cf::register_extcmd $name => \&callback($pl,$packet); 1290=item cf::register_extcmd $name => \&callback($pl,$packet);
906 1291
907Register 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.
908 1297
909If 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
910called. 1299called.
911 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
912=cut 1312=cut
913 1313
914sub register_extcmd { 1314sub register_extcmd {
915 my ($name, $cb) = @_; 1315 my ($name, $cb) = @_;
916 1316
917 my $caller = caller;
918 #warn "registering extcmd '$name' to '$caller'";
919
920 $EXTCMD{$name} = [$cb, $caller]; 1317 $EXTCMD{$name} = $cb;
921} 1318}
1319
1320sub register_exticmd {
1321 my ($name, $cb) = @_;
1322
1323 $EXTICMD{$name} = $cb;
1324}
1325
1326use File::Glob ();
922 1327
923cf::player->attach ( 1328cf::player->attach (
924 on_command => sub { 1329 on_unknown_command => sub {
925 my ($pl, $name, $params) = @_; 1330 my ($pl, $name, $params) = @_;
926 1331
927 my $cb = $COMMAND{$name} 1332 my $cb = $COMMAND{$name}
928 or return; 1333 or return;
929 1334
934 cf::override; 1339 cf::override;
935 }, 1340 },
936 on_extcmd => sub { 1341 on_extcmd => sub {
937 my ($pl, $buf) = @_; 1342 my ($pl, $buf) = @_;
938 1343
939 my $msg = eval { from_json $buf }; 1344 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
940 1345
941 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
942 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1354 if (my $cb = $EXTCMD{$type}) {
943 if (my %reply = $cb->[0]->($pl, $msg)) { 1355 @reply = $cb->($pl, @payload);
944 $pl->ext_reply ($msg->{msgid}, %reply);
945 }
946 } 1356 }
1357
1358 $pl->ext_reply ($reply, @reply)
1359 if $reply;
1360
947 } else { 1361 } else {
948 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1362 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
949 } 1363 }
950 1364
951 cf::override; 1365 cf::override;
952 }, 1366 },
953); 1367);
954 1368
955sub register { 1369# "readahead" all extensions
956 my ($base, $pkg) = @_;
957
958 #TODO
959}
960
961sub load_extension { 1370sub cache_extensions {
962 my ($path) = @_; 1371 my $grp = IO::AIO::aio_group;
963 1372
964 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1373 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
965 my $base = $1; 1374 for (grep /\.ext$/, @{$_[0]}) {
966 my $pkg = $1; 1375 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
967 $pkg =~ s/[^[:word:]]/_/g;
968 $pkg = "ext::$pkg";
969
970 warn "loading '$path' into '$pkg'\n";
971
972 open my $fh, "<:utf8", $path
973 or die "$path: $!";
974
975 my $source =
976 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n"
978 . (do { local $/; <$fh> })
979 . "\n};\n1";
980
981 eval $source
982 or die $@ ? "$path: $@\n"
983 : "extension disabled.\n";
984
985 push @exts, $pkg;
986 $ext_pkg{$base} = $pkg;
987
988# no strict 'refs';
989# @{"$pkg\::ISA"} = ext::;
990
991 register $base, $pkg;
992}
993
994sub unload_extension {
995 my ($pkg) = @_;
996
997 warn "removing extension $pkg\n";
998
999 # remove hooks
1000 #TODO
1001# for my $idx (0 .. $#PLUGIN_EVENT) {
1002# delete $hook[$idx]{$pkg};
1003# }
1004
1005 # remove commands
1006 for my $name (keys %COMMAND) {
1007 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1008
1009 if (@cb) {
1010 $COMMAND{$name} = \@cb;
1011 } else {
1012 delete $COMMAND{$name};
1013 } 1376 }
1014 } 1377 };
1015 1378
1016 # remove extcmds 1379 $grp
1017 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1018 delete $EXTCMD{$name};
1019 }
1020
1021 if (my $cb = $pkg->can ("unload")) {
1022 eval {
1023 $cb->($pkg);
1024 1
1025 } or warn "$pkg unloaded, but with errors: $@";
1026 }
1027
1028 Symbol::delete_package $pkg;
1029} 1380}
1030 1381
1031sub load_extensions { 1382sub load_extensions {
1383 cf::sync_job {
1384 my %todo;
1385
1032 for my $ext (<$LIBDIR/*.ext>) { 1386 for my $path (<$LIBDIR/*.ext>) {
1033 next unless -r $ext; 1387 next unless -r $path;
1034 eval { 1388
1035 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 }
1036 1 1449 }
1037 } 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 }
1038 } 1460 };
1039} 1461}
1040 1462
1041############################################################################# 1463#############################################################################
1042# load/save/clean perl data associated with a map
1043 1464
1044*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($) {
1045 my ($map) = @_; 1519 my ($login) = @_;
1046 1520
1047 my $path = $map->tmpname; 1521 $cf::PLAYER{$login}
1048 defined $path or return; 1522 or !aio_stat path $login
1049
1050 unlink "$path.pst";
1051};
1052
1053cf::map->attach (prio => -10000, package => cf::mapsupport::);
1054
1055#############################################################################
1056# load/save perl data associated with player->ob objects
1057
1058sub all_objects(@) {
1059 @_, map all_objects ($_->inv), @_
1060} 1523}
1061 1524
1062# 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
1063cf::player->attach ( 1552cf::player->attach (
1064 on_load => sub { 1553 on_load => sub {
1065 my ($pl, $path) = @_; 1554 my ($pl, $path) = @_;
1066 1555
1067 for my $o (all_objects $pl->ob) { 1556 # restore slots saved in save, below
1068 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1557 my $slots = delete $pl->{_slots};
1069 $o->set_ob_key_value ("_perl_data");
1070 1558
1071 %$o = %{ Storable::thaw pack "H*", $value }; 1559 $pl->ob->current_weapon ($slots->[0]);
1072 } 1560 $pl->combat_ob ($slots->[1]);
1073 } 1561 $pl->ranged_ob ($slots->[2]);
1074 }, 1562 },
1075); 1563);
1076 1564
1077############################################################################# 1565sub save($) {
1566 my ($pl) = @_;
1078 1567
1079=head2 CORE EXTENSIONS 1568 return if $pl->{deny_save};
1080 1569
1081Functions and methods that extend core crossfire objects. 1570 my $path = path $pl;
1571 my $guard = cf::lock_acquire "user_save:$path";
1082 1572
1083=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
1084 1748
1085=over 4 1749=over 4
1086 1750
1087=item cf::player::exists $login
1088
1089Returns true when the given account exists.
1090
1091=cut 1751=cut
1092 1752
1093sub cf::player::exists($) { 1753package cf::region;
1094 cf::player::find $_[0]
1095 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1096}
1097 1754
1098=item $player->ext_reply ($msgid, $msgtype, %msg) 1755=item cf::region::find_by_path $path
1099 1756
1100Sends an ext reply to the player. 1757Tries to decuce the likely region for a map knowing only its path.
1101 1758
1102=cut 1759=cut
1103 1760
1104sub cf::player::ext_reply($$$%) { 1761sub find_by_path($) {
1105 my ($self, $id, %msg) = @_; 1762 my ($path) = @_;
1106 1763
1107 $msg{msgid} = $id; 1764 my ($match, $specificity);
1108 1765
1109 $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
1110} 1774}
1111 1775
1112=back 1776=back
1113
1114 1777
1115=head3 cf::map 1778=head3 cf::map
1116 1779
1117=over 4 1780=over 4
1118 1781
1121package cf::map; 1784package cf::map;
1122 1785
1123use Fcntl; 1786use Fcntl;
1124use Coro::AIO; 1787use Coro::AIO;
1125 1788
1789use overload
1790 '""' => \&as_string,
1791 fallback => 1;
1792
1126our $MAX_RESET = 3600; 1793our $MAX_RESET = 3600;
1127our $DEFAULT_RESET = 3000; 1794our $DEFAULT_RESET = 3000;
1128 1795
1129sub generate_random_map { 1796sub generate_random_map {
1130 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
1131 1800
1132 # mit "rum" bekleckern, nicht 1801 # mit "rum" bekleckern, nicht
1133 cf::map::_create_random_map 1802 $self->_create_random_map (
1134 $path,
1135 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1803 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1136 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1804 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1137 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1805 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1138 $rmp->{exit_on_final_map}, 1806 $rmp->{exit_on_final_map},
1139 $rmp->{xsize}, $rmp->{ysize}, 1807 $rmp->{xsize}, $rmp->{ysize},
1140 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1808 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1141 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1809 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1142 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1810 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1143 $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},
1144 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1812 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1145 (cf::region::find $rmp->{region}) 1813 (cf::region::find $rmp->{region}), $rmp->{custom}
1814 )
1146} 1815}
1147 1816
1148# and all this just because we cannot iterate over 1817=item cf::map->register ($regex, $prio)
1149# all maps in C++...
1150sub change_all_map_light {
1151 my ($change) = @_;
1152 1818
1153 $_->change_map_light ($change) 1819Register a handler for the map path matching the given regex at the
1154 for grep $_->outdoor, values %cf::MAP; 1820givne priority (higher is better, built-in handlers have priority 0, the
1155} 1821default).
1156 1822
1157sub 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 {
1158 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) = @_;
1159 1962
1160 utf8::encode $path; 1963 utf8::encode $path;
1161 aio_open $path, O_RDONLY, 0 1964 my $f = new_from_file cf::object::thawer $path
1162 or return; 1965 or return;
1163 1966
1164 my $map = cf::map::new 1967 $self->_load_header ($f)
1165 or return; 1968 or return;
1166 1969
1167 # for better error messages only, will be overwritten 1970 local $MAP_LOADING{$self->{path}} = $self;
1168 $map->path ($path); 1971 $f->resolve_delayed_derefs;
1169 1972
1170 $map->load_header ($path) 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
1171 or return; 2016 or return;
2017 $self->prepare_orig;
2018 }
1172 2019
1173 $map->{load_path} = $path; 2020 $self->{deny_reset} = 1
2021 if $self->no_reset;
1174 2022
1175 $map 2023 $self->default_region (cf::region::find_by_path $self->{path})
2024 unless $self->default_region;
2025
2026 1
1176} 2027}
1177 2028
1178sub find; 2029sub find;
1179sub find { 2030sub find {
1180 my ($path, $origin) = @_; 2031 my ($path, $origin) = @_;
1181 2032
1182 #warn "find<$path,$origin>\n";#d#
1183
1184 $path = new cf::path $path, $origin && $origin->path; 2033 $path = normalise $path, $origin && $origin->path;
1185 my $key = $path->as_string;
1186 2034
1187 cf::lock_wait "map_find:$key"; 2035 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1188
1189 $cf::MAP{$key} || do {
1190 my $guard = cf::lock_acquire "map_find:$key"; 2036 my $guard2 = cf::lock_acquire "map_find:$path";
1191 2037
1192 # do it the slow way 2038 $cf::MAP{$path} || do {
1193 my $map = try_load_header $path->save_path; 2039 my $map = new_from_path cf::map $path
1194
1195 Coro::cede;
1196
1197 if ($map) {
1198 $map->last_access ((delete $map->{last_access})
1199 || $cf::RUNTIME); #d#
1200 # safety
1201 $map->{instantiate_time} = $cf::RUNTIME
1202 if $map->{instantiate_time} > $cf::RUNTIME;
1203 } else {
1204 if (my $rmp = $path->random_map_params) {
1205 $map = generate_random_map $key, $rmp;
1206 } else {
1207 $map = try_load_header $path->load_path;
1208 }
1209
1210 $map or return; 2040 or return;
1211 2041
1212 $map->{load_original} = 1;
1213 $map->{instantiate_time} = $cf::RUNTIME;
1214 $map->last_access ($cf::RUNTIME);
1215 $map->instantiate;
1216
1217 # per-player maps become, after loading, normal maps
1218 $map->per_player (0) if $path->{user_rel};
1219 }
1220
1221 $map->path ($key);
1222 $map->{path} = $path;
1223 $map->{last_save} = $cf::RUNTIME; 2042 $map->{last_save} = $cf::RUNTIME;
1224 2043
1225 Coro::cede; 2044 $map->load_header
2045 or return;
1226 2046
1227 if ($map->should_reset) { 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;
1228 $map->reset; 2052 $map->reset;
1229 undef $guard;
1230 $map = find $path 2053 return find $path;
1231 or return;
1232 } 2054 }
1233 2055
1234 $cf::MAP{$key} = $map 2056 $cf::MAP{$path} = $map
1235 } 2057 }
1236} 2058}
2059
2060sub pre_load { }
2061#sub post_load { } # XS
1237 2062
1238sub load { 2063sub load {
1239 my ($self) = @_; 2064 my ($self) = @_;
1240 2065
2066 local $self->{deny_reset} = 1; # loading can take a long time
2067
1241 my $path = $self->{path}; 2068 my $path = $self->{path};
2069
2070 {
1242 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 2071 my $guard = cf::lock_acquire "map_data:$path";
1243 2072
2073 return unless $self->valid;
1244 return if $self->in_memory != cf::MAP_SWAPPED; 2074 return unless $self->in_memory == cf::MAP_SWAPPED;
1245 2075
1246 $self->in_memory (cf::MAP_LOADING); 2076 $self->in_memory (cf::MAP_LOADING);
1247 2077
1248 $self->alloc; 2078 $self->alloc;
1249 $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)
1250 or return; 2086 or return;
1251 2087
1252 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2088 $self->post_load_original
1253 if delete $self->{load_original}; 2089 if delete $self->{load_original};
1254 2090
1255 if (my $uniq = $path->uniq_path) { 2091 if (my $uniq = $self->uniq_path) {
1256 utf8::encode $uniq; 2092 utf8::encode $uniq;
1257 if (aio_open $uniq, O_RDONLY, 0) { 2093 unless (aio_stat $uniq) {
2094 if (my $f = new_from_file cf::object::thawer $uniq) {
1258 $self->clear_unique_items; 2095 $self->clear_unique_items;
1259 $self->load_objects ($uniq, 0); 2096 $self->_load_objects ($f);
2097 $f->resolve_delayed_derefs;
2098 }
1260 } 2099 }
1261 } 2100 }
1262 2101
1263 Coro::cede; 2102 $f->resolve_delayed_derefs;
1264 2103
2104 cf::cede_to_tick;
1265 # now do the right thing for maps 2105 # now do the right thing for maps
1266 $self->link_multipart_objects; 2106 $self->link_multipart_objects;
1267
1268 if ($self->{path}->is_style_map) {
1269 $self->{deny_save} = 1;
1270 $self->{deny_reset} = 1;
1271 } else {
1272 $self->fix_auto_apply;
1273 $self->decay_objects;
1274 $self->update_buttons;
1275 $self->set_darkness_map;
1276 $self->difficulty ($self->estimate_difficulty) 2107 $self->difficulty ($self->estimate_difficulty)
1277 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;
1278 $self->activate; 2116 $self->activate;
1279 } 2117 }
1280 2118
1281 Coro::cede; 2119 $self->{last_save} = $cf::RUNTIME;
2120 $self->last_access ($cf::RUNTIME);
1282 2121
1283 $self->in_memory (cf::MAP_IN_MEMORY); 2122 $self->in_memory (cf::MAP_ACTIVE);
2123 }
2124
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 }
1284} 2167}
1285 2168
1286sub find_sync { 2169sub find_sync {
1287 my ($path, $origin) = @_; 2170 my ($path, $origin) = @_;
1288 2171
1289 cf::sync_job { cf::map::find $path, $origin } 2172 cf::sync_job { find $path, $origin }
1290} 2173}
1291 2174
1292sub do_load_sync { 2175sub do_load_sync {
1293 my ($map) = @_; 2176 my ($map) = @_;
1294 2177
2178 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2179 if $Coro::current == $Coro::main;
2180
1295 cf::sync_job { $map->load }; 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;
2211 };
2212 $MAP_PREFETCHER->prio (6);
2213
2214 ()
1296} 2215}
1297 2216
1298sub save { 2217sub save {
1299 my ($self) = @_; 2218 my ($self) = @_;
1300 2219
2220 my $lock = cf::lock_acquire "map_data:$self->{path}";
2221
1301 $self->{last_save} = $cf::RUNTIME; 2222 $self->{last_save} = $cf::RUNTIME;
1302 2223
1303 return unless $self->dirty; 2224 return unless $self->dirty;
1304 2225
1305 my $save = $self->{path}->save_path; utf8::encode $save; 2226 my $save = $self->save_path; utf8::encode $save;
1306 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2227 my $uniq = $self->uniq_path; utf8::encode $uniq;
1307 2228
1308 $self->{load_path} = $save; 2229 $self->{load_path} = $save;
1309 2230
1310 return if $self->{deny_save}; 2231 return if $self->{deny_save};
1311 2232
1312 local $self->{last_access} = $self->last_access;#d# 2233 local $self->{last_access} = $self->last_access;#d#
1313 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
1314 if ($uniq) { 2242 if ($uniq) {
1315 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2243 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1316 $self->save_objects ($uniq, cf::IO_UNIQUES); 2244 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1317 } else { 2245 } else {
1318 $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);
1319 } 2247 }
1320} 2248}
1321 2249
1322sub swap_out { 2250sub swap_out {
1323 my ($self) = @_; 2251 my ($self) = @_;
1324 2252
1325 # save first because save cedes 2253 # save first because save cedes
1326 $self->save; 2254 $self->save;
1327 2255
2256 my $lock = cf::lock_acquire "map_data:$self->{path}";
2257
1328 return if $self->players; 2258 return if $self->players;
1329 return if $self->in_memory != cf::MAP_IN_MEMORY; 2259 return if $self->in_memory != cf::MAP_ACTIVE;
1330 return if $self->{deny_save}; 2260 return if $self->{deny_save};
1331 2261
2262 $self->in_memory (cf::MAP_SWAPPED);
2263
2264 $self->deactivate;
2265 $_->clear_links_to ($self) for values %cf::MAP;
1332 $self->clear; 2266 $self->clear;
1333 $self->in_memory (cf::MAP_SWAPPED);
1334} 2267}
1335 2268
1336sub reset_at { 2269sub reset_at {
1337 my ($self) = @_; 2270 my ($self) = @_;
1338 2271
1339 # TODO: safety, remove and allow resettable per-player maps 2272 # TODO: safety, remove and allow resettable per-player maps
1340 return 1e99 if $self->{path}{user_rel};
1341 return 1e99 if $self->{deny_reset}; 2273 return 1e99 if $self->{deny_reset};
1342 2274
1343 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2275 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1344 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;
1345 2277
1350 my ($self) = @_; 2282 my ($self) = @_;
1351 2283
1352 $self->reset_at <= $cf::RUNTIME 2284 $self->reset_at <= $cf::RUNTIME
1353} 2285}
1354 2286
1355sub unlink_save {
1356 my ($self) = @_;
1357
1358 utf8::encode (my $save = $self->{path}->save_path);
1359 aioreq_pri 3; IO::AIO::aio_unlink $save;
1360 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1361}
1362
1363sub rename {
1364 my ($self, $new_path) = @_;
1365
1366 $self->unlink_save;
1367
1368 delete $cf::MAP{$self->path};
1369 $self->{path} = new cf::path $new_path;
1370 $self->path ($self->{path}->as_string);
1371 $cf::MAP{$self->path} = $self;
1372
1373 $self->save;
1374}
1375
1376sub reset { 2287sub reset {
1377 my ($self) = @_; 2288 my ($self) = @_;
1378 2289
2290 my $lock = cf::lock_acquire "map_data:$self->{path}";
2291
1379 return if $self->players; 2292 return if $self->players;
1380 return if $self->{path}{user_rel};#d#
1381 2293
1382 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 }
1383 2305
1384 delete $cf::MAP{$self->path}; 2306 delete $cf::MAP{$self->path};
1385 2307
2308 $self->deactivate;
1386 $_->clear_links_to ($self) for values %cf::MAP; 2309 $_->clear_links_to ($self) for values %cf::MAP;
2310 $self->clear;
1387 2311
1388 $self->unlink_save; 2312 $self->unlink_save;
1389 $self->destroy; 2313 $self->destroy;
1390} 2314}
1391 2315
1392my $nuke_counter = "aaaa"; 2316my $nuke_counter = "aaaa";
1393 2317
1394sub nuke { 2318sub nuke {
1395 my ($self) = @_; 2319 my ($self) = @_;
1396 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};
1397 $self->{deny_save} = 1; 2330 $self->{deny_save} = 1;
1398 $self->reset_timeout (1); 2331 $self->reset_timeout (1);
1399 $self->rename ("{nuke}/" . ($nuke_counter++)); 2332 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2333
2334 $cf::MAP{$self->path} = $self;
2335 }
2336
1400 $self->reset; # polite request, might not happen 2337 $self->reset; # polite request, might not happen
1401} 2338}
1402 2339
1403sub customise_for { 2340=item $maps = cf::map::tmp_maps
1404 my ($map, $ob) = @_;
1405 2341
1406 if ($map->per_player) { 2342Returns an arrayref with all map paths of currently instantiated and saved
1407 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2343maps. May block.
2344
2345=cut
2346
2347sub tmp_maps() {
1408 } 2348 [
1409 2349 map {
1410 $map 2350 utf8::decode $_;
2351 /\.map$/
2352 ? normalise $_
2353 : ()
2354 } @{ aio_readdir $TMPDIR or [] }
2355 ]
1411} 2356}
1412 2357
1413sub emergency_save { 2358=item $maps = cf::map::random_maps
1414 my $freeze_guard = cf::freeze_mainloop;
1415 2359
1416 warn "enter emergency map save\n"; 2360Returns an arrayref with all map paths of currently instantiated and saved
2361random maps. May block.
1417 2362
1418 cf::sync_job { 2363=cut
1419 warn "begin emergency map save\n"; 2364
1420 $_->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;
1421 }; 2422 }
1422 2423
1423 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 }
1424} 2479}
1425 2480
1426package cf; 2481package cf;
1427 2482
1428=back 2483=back
1429
1430 2484
1431=head3 cf::object::player 2485=head3 cf::object::player
1432 2486
1433=over 4 2487=over 4
1434 2488
1437Sends 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>
1438can 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
1439dialogue with the given NPC character. 2493dialogue with the given NPC character.
1440 2494
1441=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};
1442 2510
1443# rough implementation of a future "reply" method that works 2511# rough implementation of a future "reply" method that works
1444# with dialog boxes. 2512# with dialog boxes.
1445#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
1446sub cf::object::player::reply($$$;$) { 2514sub cf::object::player::reply($$$;$) {
1448 2516
1449 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2517 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1450 2518
1451 if ($self->{record_replies}) { 2519 if ($self->{record_replies}) {
1452 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2520 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2521
1453 } 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 {
1454 $msg = $npc->name . " says: $msg" if $npc; 2530 $msg = $npc->name . " says: $msg" if $npc;
1455 $self->message ($msg, $flags); 2531 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2532 }
1456 } 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 (@_);
1457} 2544}
1458 2545
1459=item $player_object->may ("access") 2546=item $player_object->may ("access")
1460 2547
1461Returns wether the given player is authorized to access resource "access" 2548Returns wether the given player is authorized to access resource "access"
1474 2561
1475=item $player_object->enter_link 2562=item $player_object->enter_link
1476 2563
1477Freezes 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}>).
1478 2565
1479The 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.
1480I<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.
1481 2572
1482=item $player_object->leave_link ($map, $x, $y) 2573=item $player_object->leave_link ($map, $x, $y)
1483 2574
1484Moves 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
1485map 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
1486location 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
1487to the emergency map position. 2578fails, to the emergency map position.
1488 2579
1489Might block. 2580Might block.
1490 2581
1491=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}
1492 2593
1493sub cf::object::player::enter_link { 2594sub cf::object::player::enter_link {
1494 my ($self) = @_; 2595 my ($self) = @_;
1495 2596
1496 $self->deactivate_recursive; 2597 $self->deactivate_recursive;
1497 2598
1498 return if $self->map == $LINK_MAP; 2599 return if UNIVERSAL::isa $self->map, "ext::map_link";
1499 2600
1500 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2601 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1501 if $self->map; 2602 if $self->map && $self->map->{path} ne "{link}";
1502 2603
1503 $self->enter_map ($LINK_MAP, 20, 20); 2604 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1504} 2605}
1505 2606
1506sub cf::object::player::leave_link { 2607sub cf::object::player::leave_link {
1507 my ($self, $map, $x, $y) = @_; 2608 my ($self, $map, $x, $y) = @_;
2609
2610 return unless $self->contr->active;
1508 2611
1509 my $link_pos = delete $self->{_link_pos}; 2612 my $link_pos = delete $self->{_link_pos};
1510 2613
1511 unless ($map) { 2614 unless ($map) {
1512 # restore original map position 2615 # restore original map position
1523 ($x, $y) = (-1, -1) 2626 ($x, $y) = (-1, -1)
1524 unless (defined $x) && (defined $y); 2627 unless (defined $x) && (defined $y);
1525 2628
1526 # use -1 or undef as default coordinates, not 0, 0 2629 # use -1 or undef as default coordinates, not 0, 0
1527 ($x, $y) = ($map->enter_x, $map->enter_y) 2630 ($x, $y) = ($map->enter_x, $map->enter_y)
1528 if $x <=0 && $y <= 0; 2631 if $x <= 0 && $y <= 0;
1529 2632
1530 $map->load; 2633 $map->load;
2634 $map->load_neighbours;
1531 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
1532 $self->activate_recursive; 2642 $self->activate_recursive;
1533 $self->enter_map ($map, $x, $y);
1534} 2643}
1535 2644
1536cf::player->attach ( 2645=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1537 on_logout => sub {
1538 my ($pl) = @_;
1539 2646
1540 # abort map switching before logout 2647Moves the player to the given map-path and coordinates by first freezing
1541 if ($pl->ob->{_link_pos}) { 2648her, loading and preparing them map, calling the provided $check callback
1542 cf::sync_job { 2649that has to return the map if sucecssful, and then unfreezes the player on
1543 $pl->ob->leave_link 2650the new (success) or old (failed) map position. In either case, $done will
1544 }; 2651be called at the end of this process.
1545 }
1546 },
1547 on_login => sub {
1548 my ($pl) = @_;
1549 2652
1550 # try to abort aborted map switching on player login :) 2653Note that $check will be called with a potentially non-loaded map, so if
1551 # should happen only on crashes 2654it needs a loaded map it has to call C<< ->load >>.
1552 if ($pl->ob->{_link_pos}) {
1553 $pl->ob->enter_link;
1554 cf::async {
1555 # we need this sleep as the login has a concurrent enter_exit running
1556 # and this sleep increases chances of the player not ending up in scorn
1557 Coro::Timer::sleep 1;
1558 $pl->ob->leave_link;
1559 };
1560 }
1561 },
1562);
1563 2655
1564=item $player_object->goto_map ($path, $x, $y)
1565
1566=cut 2656=cut
1567 2657
2658our $GOTOGEN;
2659
1568sub cf::object::player::goto_map { 2660sub cf::object::player::goto {
1569 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;
1570 2665
1571 $self->enter_link; 2666 $self->enter_link;
1572 2667
1573 (cf::async { 2668 (async {
1574 $path = new cf::path $path; 2669 $Coro::current->{desc} = "player::goto $path $x $y";
1575 2670
1576 my $map = cf::map::find $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) {
1577 $map = $map->customise_for ($self) if $map; 2694 $map = $map->customise_for ($self);
1578 2695 $map = $check->($map) if $check && $map;
1579# warn "entering ", $map->path, " at ($x, $y)\n" 2696 } else {
1580# if $map;
1581
1582 $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 }
1583 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};
1584 $self->leave_link ($map, $x, $y); 2710 $self->leave_link ($map, $x, $y);
2711 }
2712
2713 $done->() if $done;
1585 })->prio (1); 2714 })->prio (1);
1586} 2715}
1587 2716
1588=item $player_object->enter_exit ($exit_object) 2717=item $player_object->enter_exit ($exit_object)
1589 2718
1591 2720
1592sub parse_random_map_params { 2721sub parse_random_map_params {
1593 my ($spec) = @_; 2722 my ($spec) = @_;
1594 2723
1595 my $rmp = { # defaults 2724 my $rmp = { # defaults
1596 xsize => 10, 2725 xsize => (cf::rndm 15, 40),
1597 ysize => 10, 2726 ysize => (cf::rndm 15, 40),
2727 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2728 #layout => string,
1598 }; 2729 };
1599 2730
1600 for (split /\n/, $spec) { 2731 for (split /\n/, $spec) {
1601 my ($k, $v) = split /\s+/, $_, 2; 2732 my ($k, $v) = split /\s+/, $_, 2;
1602 2733
1614 # that depends on the exit object 2745 # that depends on the exit object
1615 2746
1616 my $rmp = parse_random_map_params $exit->msg; 2747 my $rmp = parse_random_map_params $exit->msg;
1617 2748
1618 if ($exit->map) { 2749 if ($exit->map) {
1619 $rmp->{region} = $exit->map->region_name; 2750 $rmp->{region} = $exit->region->name;
1620 $rmp->{origin_map} = $exit->map->path; 2751 $rmp->{origin_map} = $exit->map->path;
1621 $rmp->{origin_x} = $exit->x; 2752 $rmp->{origin_x} = $exit->x;
1622 $rmp->{origin_y} = $exit->y; 2753 $rmp->{origin_y} = $exit->y;
2754
2755 $exit->map->touch;
1623 } 2756 }
1624 2757
1625 $rmp->{random_seed} ||= $exit->random_seed; 2758 $rmp->{random_seed} ||= $exit->random_seed;
1626 2759
1627 my $data = cf::to_json $rmp; 2760 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1628 my $md5 = Digest::MD5::md5_hex $data; 2761 my $md5 = Digest::MD5::md5_hex $data;
2762 my $meta = "$RANDOMDIR/$md5.meta";
1629 2763
1630 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) {
1631 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;
1632 2768
2769 my $slaying = "?random/$md5";
2770
2771 if ($exit->valid) {
1633 $exit->slaying ("?random/$md5"); 2772 $exit->slaying ("?random/$md5");
1634 $exit->msg (undef); 2773 $exit->msg (undef);
2774 }
1635 } 2775 }
1636} 2776}
1637 2777
1638sub cf::object::player::enter_exit { 2778sub cf::object::player::enter_exit {
1639 my ($self, $exit) = @_; 2779 my ($self, $exit) = @_;
1640 2780
1641 return unless $self->type == cf::PLAYER; 2781 return unless $self->type == cf::PLAYER;
1642 2782
1643 $self->enter_link; 2783 $self->enter_link;
1644 2784
1645 (cf::async { 2785 (async {
1646 $self->deactivate_recursive; # just to be sure 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 cf::object::thawer::errors_are_fatal 0;
3594
3595 main_loop;
2017} 3596}
2018 3597
2019############################################################################# 3598#############################################################################
2020# initialisation 3599# initialisation and cleanup
2021 3600
3601# install some emergency cleanup handlers
3602BEGIN {
3603 our %SIGWATCHER = ();
3604 for my $signal (qw(INT HUP TERM)) {
3605 $SIGWATCHER{$signal} = AE::signal $signal, sub {
3606 cf::cleanup "SIG$signal";
3607 };
3608 }
3609}
3610
3611sub write_runtime_sync {
3612 my $t0 = AE::time;
3613
3614 # first touch the runtime file to show we are still running:
3615 # the fsync below can take a very very long time.
3616
3617 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3618
3619 my $guard = cf::lock_acquire "write_runtime";
3620
3621 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
3622 or return;
3623
3624 my $value = $cf::RUNTIME + 90 + 10;
3625 # 10 is the runtime save interval, for a monotonic clock
3626 # 60 allows for the watchdog to kill the server.
3627
3628 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3629 and return;
3630
3631 # always fsync - this file is important
3632 aio_fsync $fh
3633 and return;
3634
3635 # touch it again to show we are up-to-date
3636 aio_utime $fh, undef, undef;
3637
3638 close $fh
3639 or return;
3640
3641 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3642 and return;
3643
3644 warn sprintf "runtime file written (%gs).\n", AE::time - $t0;
3645
3646 1
3647}
3648
3649our $uuid_lock;
3650our $uuid_skip;
3651
3652sub write_uuid_sync($) {
3653 $uuid_skip ||= $_[0];
3654
3655 return if $uuid_lock;
3656 local $uuid_lock = 1;
3657
3658 my $uuid = "$LOCALDIR/uuid";
3659
3660 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3661 or return;
3662
3663 my $value = uuid_seq uuid_cur;
3664
3665 unless ($value) {
3666 warn "cowardly refusing to write zero uuid value!\n";
3667 return;
3668 }
3669
3670 my $value = uuid_str $value + $uuid_skip;
3671 $uuid_skip = 0;
3672
3673 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3674 and return;
3675
3676 # always fsync - this file is important
3677 aio_fsync $fh
3678 and return;
3679
3680 close $fh
3681 or return;
3682
3683 aio_rename "$uuid~", $uuid
3684 and return;
3685
3686 warn "uuid file written ($value).\n";
3687
3688 1
3689
3690}
3691
3692sub write_uuid($$) {
3693 my ($skip, $sync) = @_;
3694
3695 $sync ? write_uuid_sync $skip
3696 : async { write_uuid_sync $skip };
3697}
3698
3699sub emergency_save() {
3700 my $freeze_guard = cf::freeze_mainloop;
3701
3702 warn "emergency_perl_save: enter\n";
3703
3704 cf::sync_job {
3705 # this is a trade-off: we want to be very quick here, so
3706 # save all maps without fsync, and later call a global sync
3707 # (which in turn might be very very slow)
3708 local $USE_FSYNC = 0;
3709
3710 # use a peculiar iteration method to avoid tripping on perl
3711 # refcount bugs in for. also avoids problems with players
3712 # and maps saved/destroyed asynchronously.
3713 warn "emergency_perl_save: begin player save\n";
3714 for my $login (keys %cf::PLAYER) {
3715 my $pl = $cf::PLAYER{$login} or next;
3716 $pl->valid or next;
3717 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3718 $pl->save;
3719 }
3720 warn "emergency_perl_save: end player save\n";
3721
3722 warn "emergency_perl_save: begin map save\n";
3723 for my $path (keys %cf::MAP) {
3724 my $map = $cf::MAP{$path} or next;
3725 $map->valid or next;
3726 $map->save;
3727 }
3728 warn "emergency_perl_save: end map save\n";
3729
3730 warn "emergency_perl_save: begin database checkpoint\n";
3731 BDB::db_env_txn_checkpoint $DB_ENV;
3732 warn "emergency_perl_save: end database checkpoint\n";
3733
3734 warn "emergency_perl_save: begin write uuid\n";
3735 write_uuid_sync 1;
3736 warn "emergency_perl_save: end write uuid\n";
3737 };
3738
3739 warn "emergency_perl_save: starting sync()\n";
3740 IO::AIO::aio_sync sub {
3741 warn "emergency_perl_save: finished sync()\n";
3742 };
3743
3744 warn "emergency_perl_save: leave\n";
3745}
3746
3747sub post_cleanup {
3748 my ($make_core) = @_;
3749
3750 warn Carp::longmess "post_cleanup backtrace"
3751 if $make_core;
3752
3753 my $fh = pidfile;
3754 unlink $PIDFILE if <$fh> == $$;
3755}
3756
3757# a safer delete_package, copied from Symbol
3758sub clear_package($) {
3759 my $pkg = shift;
3760
3761 # expand to full symbol table name if needed
3762 unless ($pkg =~ /^main::.*::$/) {
3763 $pkg = "main$pkg" if $pkg =~ /^::/;
3764 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3765 $pkg .= '::' unless $pkg =~ /::$/;
3766 }
3767
3768 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3769 my $stem_symtab = *{$stem}{HASH};
3770
3771 defined $stem_symtab and exists $stem_symtab->{$leaf}
3772 or return;
3773
3774 # clear all symbols
3775 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3776 for my $name (keys %$leaf_symtab) {
3777 _gv_clear *{"$pkg$name"};
3778# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3779 }
3780 warn "cleared package $pkg\n";#d#
3781}
3782
2022sub reload() { 3783sub do_reload_perl() {
2023 # can/must only be called in main 3784 # can/must only be called in main
2024 if ($Coro::current != $Coro::main) { 3785 if ($Coro::current != $Coro::main) {
2025 warn "can only reload from main coroutine\n"; 3786 warn "can only reload from main coroutine";
2026 return; 3787 return;
2027 } 3788 }
2028 3789
3790 return if $RELOAD++;
3791
3792 my $t1 = AE::time;
3793
3794 while ($RELOAD) {
2029 warn "reloading..."; 3795 warn "reloading...";
2030 3796
2031 my $guard = freeze_mainloop; 3797 warn "entering sync_job";
3798
3799 cf::sync_job {
3800 cf::write_runtime_sync; # external watchdog should not bark
2032 cf::emergency_save; 3801 cf::emergency_save;
3802 cf::write_runtime_sync; # external watchdog should not bark
2033 3803
2034 eval { 3804 warn "syncing database to disk";
3805 BDB::db_env_txn_checkpoint $DB_ENV;
3806
2035 # if anything goes wrong in here, we should simply crash as we already saved 3807 # if anything goes wrong in here, we should simply crash as we already saved
2036 3808
2037 # cancel all watchers 3809 warn "flushing outstanding aio requests";
2038 for (Event::all_watchers) { 3810 while (IO::AIO::nreqs || BDB::nreqs) {
2039 $_->cancel if $_->data & WF_AUTOCANCEL; 3811 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 } 3812 }
2065 3813
2066 Symbol::delete_package $k; 3814 warn "cancelling all extension coros";
3815 $_->cancel for values %EXT_CORO;
3816 %EXT_CORO = ();
3817
3818 warn "removing commands";
3819 %COMMAND = ();
3820
3821 warn "removing ext/exti commands";
3822 %EXTCMD = ();
3823 %EXTICMD = ();
3824
3825 warn "unloading/nuking all extensions";
3826 for my $pkg (@EXTS) {
3827 warn "... unloading $pkg";
3828
3829 if (my $cb = $pkg->can ("unload")) {
3830 eval {
3831 $cb->($pkg);
3832 1
3833 } or warn "$pkg unloaded, but with errors: $@";
3834 }
3835
3836 warn "... clearing $pkg";
3837 clear_package $pkg;
2067 } 3838 }
2068 3839
2069 # sync database to disk 3840 warn "unloading all perl modules loaded from $LIBDIR";
2070 cf::db_sync; 3841 while (my ($k, $v) = each %INC) {
2071 IO::AIO::flush; 3842 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2072 3843
3844 warn "... unloading $k";
3845 delete $INC{$k};
3846
3847 $k =~ s/\.pm$//;
3848 $k =~ s/\//::/g;
3849
3850 if (my $cb = $k->can ("unload_module")) {
3851 $cb->();
3852 }
3853
3854 clear_package $k;
3855 }
3856
2073 # get rid of safe::, as good as possible 3857 warn "getting rid of safe::, as good as possible";
2074 Symbol::delete_package "safe::$_" 3858 clear_package "safe::$_"
2075 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3859 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2076 3860
2077 # remove register_script_function callbacks 3861 warn "unloading cf.pm \"a bit\"";
2078 # TODO
2079
2080 # unload cf.pm "a bit"
2081 delete $INC{"cf.pm"}; 3862 delete $INC{"cf.pm"};
3863 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2082 3864
2083 # don't, removes xs symbols, too, 3865 # don't, removes xs symbols, too,
2084 # and global variables created in xs 3866 # and global variables created in xs
2085 #Symbol::delete_package __PACKAGE__; 3867 #clear_package __PACKAGE__;
2086 3868
2087 # reload cf.pm 3869 warn "unload completed, starting to reload now";
3870
2088 warn "reloading cf.pm"; 3871 warn "reloading cf.pm";
2089 require cf; 3872 require cf;
2090 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3873 cf::_connect_to_perl_1;
2091 3874
2092 # load config and database again 3875 warn "loading config and database again";
2093 cf::cfg_load; 3876 cf::reload_config;
2094 cf::db_load;
2095 3877
2096 # load extensions
2097 warn "load extensions"; 3878 warn "loading extensions";
2098 cf::load_extensions; 3879 cf::load_extensions;
2099 3880
2100 # reattach attachments to objects 3881 if ($REATTACH_ON_RELOAD) {
3882 warn "reattaching attachments to objects/players";
3883 _global_reattach; # objects, sockets
3884 warn "reattaching attachments to maps";
3885 reattach $_ for values %MAP;
3886 warn "reattaching attachments to players";
3887 reattach $_ for values %PLAYER;
3888 }
3889
3890 warn "running post_init jobs";
3891 (pop @POST_INIT)->(1) while @POST_INIT;
3892
3893 warn "leaving sync_job";
3894
3895 1
3896 } or do {
3897 warn $@;
3898 cf::cleanup "error while reloading, exiting.";
3899 };
3900
2101 warn "reattach"; 3901 warn "reloaded";
2102 _global_reattach; 3902 --$RELOAD;
3903 }
3904
3905 $t1 = AE::time - $t1;
3906 warn "reload completed in ${t1}s\n";
3907};
3908
3909our $RELOAD_WATCHER; # used only during reload
3910
3911sub reload_perl() {
3912 # doing reload synchronously and two reloads happen back-to-back,
3913 # coro crashes during coro_state_free->destroy here.
3914
3915 $RELOAD_WATCHER ||= cf::async {
3916 Coro::AIO::aio_wait cache_extensions;
3917
3918 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
3919 do_reload_perl;
3920 undef $RELOAD_WATCHER;
3921 };
2103 }; 3922 };
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} 3923}
2156
2157register "<global>", __PACKAGE__;
2158 3924
2159register_command "reload" => sub { 3925register_command "reload" => sub {
2160 my ($who, $arg) = @_; 3926 my ($who, $arg) = @_;
2161 3927
2162 if ($who->flag (FLAG_WIZ)) { 3928 if ($who->flag (FLAG_WIZ)) {
2163 $who->message ("start of reload.");
2164 reload;
2165 $who->message ("end of reload."); 3929 $who->message ("reloading server.");
3930 async {
3931 $Coro::current->{desc} = "perl_reload";
3932 reload_perl;
3933 };
2166 } 3934 }
2167}; 3935};
2168 3936
2169unshift @INC, $LIBDIR; 3937unshift @INC, $LIBDIR;
2170 3938
2171$TICK_WATCHER = Event->timer ( 3939my $bug_warning = 0;
2172 reentrant => 0, 3940
2173 prio => 0, 3941our @WAIT_FOR_TICK;
2174 at => $NEXT_TICK || $TICK, 3942our @WAIT_FOR_TICK_BEGIN;
2175 data => WF_AUTOCANCEL, 3943
2176 cb => sub { 3944sub wait_for_tick {
3945 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
3946
3947 my $signal = new Coro::Signal;
3948 push @WAIT_FOR_TICK, $signal;
3949 $signal->wait;
3950}
3951
3952sub wait_for_tick_begin {
3953 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
3954
3955 my $signal = new Coro::Signal;
3956 push @WAIT_FOR_TICK_BEGIN, $signal;
3957 $signal->wait;
3958}
3959
3960sub tick {
3961 if ($Coro::current != $Coro::main) {
3962 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3963 unless ++$bug_warning > 10;
3964 return;
3965 }
3966
2177 cf::server_tick; # one server iteration 3967 cf::server_tick; # one server iteration
2178 $RUNTIME += $TICK;
2179 $NEXT_TICK += $TICK;
2180 3968
2181 # if we are delayed by four ticks or more, skip them all 3969 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2182 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2183 3970
2184 $TICK_WATCHER->at ($NEXT_TICK); 3971 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2185 $TICK_WATCHER->start; 3972 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2186 }, 3973 Coro::async_pool {
2187); 3974 $Coro::current->{desc} = "runtime saver";
2188
2189IO::AIO::max_poll_time $TICK * 0.2;
2190
2191Event->io (
2192 fd => IO::AIO::poll_fileno,
2193 poll => 'r',
2194 prio => 5,
2195 data => WF_AUTOCANCEL,
2196 cb => \&IO::AIO::poll_cb,
2197);
2198
2199Event->timer (
2200 data => WF_AUTOCANCEL,
2201 after => 0,
2202 interval => 10,
2203 cb => sub {
2204 (Coro::unblock_sub {
2205 write_runtime 3975 write_runtime_sync
2206 or warn "ERROR: unable to write runtime file: $!"; 3976 or warn "ERROR: unable to write runtime file: $!";
2207 })->(); 3977 };
2208 }, 3978 }
2209); 3979
3980 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3981 $sig->send;
3982 }
3983 while (my $sig = shift @WAIT_FOR_TICK) {
3984 $sig->send;
3985 }
3986
3987 $LOAD = ($NOW - $TICK_START) / $TICK;
3988 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3989
3990 if (0) {
3991 if ($NEXT_TICK) {
3992 my $jitter = $TICK_START - $NEXT_TICK;
3993 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3994 warn "jitter $JITTER\n";#d#
3995 }
3996 }
3997}
3998
3999{
4000 # configure BDB
4001
4002 BDB::min_parallel 16;
4003 BDB::max_poll_reqs $TICK * 0.1;
4004 $AnyEvent::BDB::WATCHER->priority (1);
4005
4006 unless ($DB_ENV) {
4007 $DB_ENV = BDB::db_env_create;
4008 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4009 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4010 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4011 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4012 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
4013
4014 cf::sync_job {
4015 eval {
4016 BDB::db_env_open
4017 $DB_ENV,
4018 $BDBDIR,
4019 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
4020 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
4021 0666;
4022
4023 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
4024 };
4025
4026 cf::cleanup "db_env_open(db): $@" if $@;
4027 };
4028 }
4029
4030 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
4031 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
4032 };
4033 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
4034 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
4035 };
4036 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4037 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4038 };
4039}
4040
4041{
4042 # configure IO::AIO
4043
4044 IO::AIO::min_parallel 8;
4045 IO::AIO::max_poll_time $TICK * 0.1;
4046 undef $AnyEvent::AIO::WATCHER;
4047}
4048
4049my $_log_backtrace;
4050
4051sub _log_backtrace {
4052 my ($msg, @addr) = @_;
4053
4054 $msg =~ s/\n//;
4055
4056 # limit the # of concurrent backtraces
4057 if ($_log_backtrace < 2) {
4058 ++$_log_backtrace;
4059 my $perl_bt = Carp::longmess $msg;
4060 async {
4061 $Coro::current->{desc} = "abt $msg";
4062
4063 my @bt = fork_call {
4064 @addr = map { sprintf "%x", $_ } @addr;
4065 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4066 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4067 or die "addr2line: $!";
4068
4069 my @funcs;
4070 my @res = <$fh>;
4071 chomp for @res;
4072 while (@res) {
4073 my ($func, $line) = splice @res, 0, 2, ();
4074 push @funcs, "[$func] $line";
4075 }
4076
4077 @funcs
4078 };
4079
4080 LOG llevInfo, "[ABT] $perl_bt\n";
4081 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4082 LOG llevInfo, "[ABT] $_\n" for @bt;
4083 --$_log_backtrace;
4084 };
4085 } else {
4086 LOG llevInfo, "[ABT] $msg\n";
4087 LOG llevInfo, "[ABT] [suppressed]\n";
4088 }
4089}
4090
4091# load additional modules
4092require "cf/$_.pm" for @EXTRA_MODULES;
4093cf::_connect_to_perl_2;
2210 4094
2211END { cf::emergency_save } 4095END { cf::emergency_save }
2212 4096
22131 40971
2214 4098

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines