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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines