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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines