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.154 by root, Tue Jan 9 15:36:19 2007 UTC vs.
Revision 1.474 by root, Thu Jul 16 21:42:56 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines