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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines