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.158 by root, Wed Jan 10 19:52:43 2007 UTC vs.
Revision 1.488 by root, Wed Oct 21 00:44:39 2009 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify 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 ();
12 37
38use Guard ();
13use Coro 3.3 (); 39use Coro ();
40use Coro::State;
41use Coro::Handle;
42use Coro::EV;
14use Coro::Event; 43use Coro::AnyEvent;
15use Coro::Timer; 44use Coro::Timer;
16use Coro::Signal; 45use Coro::Signal;
17use Coro::Semaphore; 46use Coro::Semaphore;
47use Coro::SemaphoreSet;
48use Coro::AnyEvent;
18use Coro::AIO; 49use Coro::AIO;
50use Coro::BDB 1.6;
51use Coro::Storable;
52use Coro::Util ();
19 53
54use JSON::XS 2.01 ();
55use BDB ();
20use Data::Dumper; 56use Data::Dumper;
21use Digest::MD5; 57use 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 warn "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
372use overload
373 '""' => \&as_string;
374
375# used to convert map paths into valid unix filenames by repalcing / by ∕
376our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
377
378sub new {
379 my ($class, $path, $base) = @_;
380
381 $path = $path->as_string if ref $path;
382
383 my $self = bless { }, $class;
384
385 # {... are special paths that are not touched
386 # ?xxx/... are special absolute paths
387 # ?random/... random maps
388 # /! non-realised random map exit
389 # /... normal maps
390 # ~/... per-player maps without a specific player (DO NOT USE)
391 # ~user/... per-player map of a specific user
392
393 $path =~ s/$PATH_SEP/\//go;
394
395 if ($path =~ /^{/) {
396 # fine as it is
397 } elsif ($path =~ s{^\?random/}{}) {
398 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
399 $self->{random} = cf::from_json $data;
400 } else {
401 if ($path =~ s{^~([^/]+)?}{}) {
402 $self->{user_rel} = 1;
403
404 if (defined $1) {
405 $self->{user} = $1;
406 } elsif ($base =~ m{^~([^/]+)/}) {
407 $self->{user} = $1;
408 } else {
409 warn "cannot resolve user-relative path without user <$path,$base>\n";
410 }
411 } elsif ($path =~ /^\//) {
412 # already absolute
413 } else {
414 $base =~ s{[^/]+/?$}{};
415 return $class->new ("$base/$path");
416 }
417
418 for ($path) {
419 redo if s{/\.?/}{/};
420 redo if s{/[^/]+/\.\./}{/};
421 }
422 }
423
424 $self->{path} = $path;
425
426 $self
427}
428
429# the name / primary key / in-game path
430sub as_string {
431 my ($self) = @_;
432
433 $self->{user_rel} ? "~$self->{user}$self->{path}"
434 : $self->{random} ? "?random/$self->{path}"
435 : $self->{path}
436}
437
438# the displayed name, this is a one way mapping
439sub visible_name {
440 my ($self) = @_;
441
442# if (my $rmp = $self->{random}) {
443# # todo: be more intelligent about this
444# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
445# } else {
446 $self->as_string
447# }
448}
449
450# escape the /'s in the path
451sub _escaped_path {
452 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
453 $path
454}
455
456# the original (read-only) location
457sub load_path {
458 my ($self) = @_;
459
460 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
461}
462
463# the temporary/swap location
464sub save_path {
465 my ($self) = @_;
466
467 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
468 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
469 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
470}
471
472# the unique path, might be eq to save_path
473sub uniq_path {
474 my ($self) = @_;
475
476 $self->{user_rel} || $self->{random}
477 ? undef
478 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
479}
480
481# return random map parameters, or undef
482sub random_map_params {
483 my ($self) = @_;
484
485 $self->{random}
486}
487
488# this is somewhat ugly, but style maps do need special treatment
489sub is_style_map {
490 $_[0]{path} =~ m{^/styles/}
491}
492
493package cf;
494
495#############################################################################
496
497=head2 ATTACHABLE OBJECTS 755=head2 ATTACHABLE OBJECTS
498 756
499Many 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
500attach callbacks/event handlers (a collection of which is called an "attachment") 758attach callbacks/event handlers (a collection of which is called an "attachment")
501to it. All such attachable objects support the following methods. 759to it. All such attachable objects support the following methods.
502 760
503In 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>
504C<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
505crossfire+). 763Deliantra).
506 764
507=over 4 765=over 4
508 766
509=item $attachable->attach ($attachment, key => $value...) 767=item $attachable->attach ($attachment, key => $value...)
510 768
554=item cf::CLASS::attachment $name, ... 812=item cf::CLASS::attachment $name, ...
555 813
556Register an attachment by C<$name> through which attachable objects of the 814Register an attachment by C<$name> through which attachable objects of the
557given CLASS can refer to this attachment. 815given CLASS can refer to this attachment.
558 816
559Some classes such as crossfire maps and objects can specify attachments 817Some classes such as deliantra maps and objects can specify attachments
560that 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.
561 819
562These calls expect any number of the following handler/hook descriptions: 820These calls expect any number of the following handler/hook descriptions:
563 821
564=over 4 822=over 4
624our @CB_TYPE = (); # registry for type (cf-object class) based events 882our @CB_TYPE = (); # registry for type (cf-object class) based events
625our @CB_MAP = (); 883our @CB_MAP = ();
626 884
627my %attachment; 885my %attachment;
628 886
887sub cf::attachable::thawer_merge {
888 # simply override everything except _meta
889 local $_[0]{_meta};
890 %{$_[0]} = %{$_[1]};
891}
892
629sub _attach_cb($$$$) { 893sub _attach_cb($$$$) {
630 my ($registry, $event, $prio, $cb) = @_; 894 my ($registry, $event, $prio, $cb) = @_;
631 895
632 use sort 'stable'; 896 use sort 'stable';
633 897
667 $registry = $CB_TYPE[$object_type] ||= []; 931 $registry = $CB_TYPE[$object_type] ||= [];
668 932
669 } elsif ($type eq "subtype") { 933 } elsif ($type eq "subtype") {
670 defined $object_type or Carp::croak "subtype specified without type"; 934 defined $object_type or Carp::croak "subtype specified without type";
671 my $object_subtype = shift @arg; 935 my $object_subtype = shift @arg;
672 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 936 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
673 937
674 } elsif ($type eq "package") { 938 } elsif ($type eq "package") {
675 my $pkg = shift @arg; 939 my $pkg = shift @arg;
676 940
677 while (my ($name, $id) = each %cb_id) { 941 while (my ($name, $id) = each %cb_id) {
706 _attach $registry, $klass, @attach; 970 _attach $registry, $klass, @attach;
707 } 971 }
708 972
709 $obj->{$name} = \%arg; 973 $obj->{$name} = \%arg;
710 } else { 974 } else {
711 warn "object uses attachment '$name' that is not available, postponing.\n"; 975 warn "object uses attachment '$name' which is not available, postponing.\n";
712 } 976 }
713 977
714 $obj->{_attachment}{$name} = undef; 978 $obj->{_attachment}{$name} = undef;
715} 979}
716 980
718 if (ref $_[0]) { 982 if (ref $_[0]) {
719 _object_attach @_; 983 _object_attach @_;
720 } else { 984 } else {
721 _attach shift->_attach_registry, @_; 985 _attach shift->_attach_registry, @_;
722 } 986 }
987 _recalc_want;
723}; 988};
724 989
725# all those should be optimised 990# all those should be optimised
726sub cf::attachable::detach { 991sub cf::attachable::detach {
727 my ($obj, $name) = @_; 992 my ($obj, $name) = @_;
730 delete $obj->{_attachment}{$name}; 995 delete $obj->{_attachment}{$name};
731 reattach ($obj); 996 reattach ($obj);
732 } else { 997 } else {
733 Carp::croak "cannot, currently, detach class attachments"; 998 Carp::croak "cannot, currently, detach class attachments";
734 } 999 }
1000 _recalc_want;
735}; 1001};
736 1002
737sub cf::attachable::attached { 1003sub cf::attachable::attached {
738 my ($obj, $name) = @_; 1004 my ($obj, $name) = @_;
739 1005
754 "; 1020 ";
755 die if $@; 1021 die if $@;
756} 1022}
757 1023
758our $override; 1024our $override;
759our @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?
760 1026
761sub override { 1027sub override {
762 $override = 1; 1028 $override = 1;
763 @invoke_results = (); 1029 @INVOKE_RESULTS = (@_);
764} 1030}
765 1031
766sub do_invoke { 1032sub do_invoke {
767 my $event = shift; 1033 my $event = shift;
768 my $callbacks = shift; 1034 my $callbacks = shift;
769 1035
770 @invoke_results = (); 1036 @INVOKE_RESULTS = ();
771 1037
772 local $override; 1038 local $override;
773 1039
774 for (@$callbacks) { 1040 for (@$callbacks) {
775 eval { &{$_->[1]} }; 1041 eval { &{$_->[1]} };
784 } 1050 }
785 1051
786 0 1052 0
787} 1053}
788 1054
789=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1055=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
790 1056
791=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1057=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
792 1058
793Generate an object-specific event with the given arguments. 1059Generate an object-specific event with the given arguments.
794 1060
795This 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
796removed 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
797results (if you must, access C<@cf::invoke_results> directly). 1063results (if you must, access C<@cf::INVOKE_RESULTS> directly).
798 1064
799=back 1065=back
800 1066
801=cut 1067=cut
802 1068
803############################################################################# 1069#############################################################################
804# 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}
805 1113
806sub reattach { 1114sub reattach {
807 # basically do the same as instantiate, without calling instantiate 1115 # basically do the same as instantiate, without calling instantiate
808 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
809 1120
810 my $registry = $obj->registry; 1121 my $registry = $obj->registry;
811 1122
812 @$registry = (); 1123 @$registry = ();
813 1124
828cf::attachable->attach ( 1139cf::attachable->attach (
829 prio => -1000000, 1140 prio => -1000000,
830 on_instantiate => sub { 1141 on_instantiate => sub {
831 my ($obj, $data) = @_; 1142 my ($obj, $data) = @_;
832 1143
833 $data = from_json $data; 1144 $data = decode_json $data;
834 1145
835 for (@$data) { 1146 for (@$data) {
836 my ($name, $args) = @$_; 1147 my ($name, $args) = @$_;
837 1148
838 $obj->attach ($name, %{$args || {} }); 1149 $obj->attach ($name, %{$args || {} });
854sub object_freezer_save { 1165sub object_freezer_save {
855 my ($filename, $rdata, $objs) = @_; 1166 my ($filename, $rdata, $objs) = @_;
856 1167
857 sync_job { 1168 sync_job {
858 if (length $$rdata) { 1169 if (length $$rdata) {
1170 utf8::decode (my $decname = $filename);
859 warn sprintf "saving %s (%d,%d)\n", 1171 warn sprintf "saving %s (%d,%d)\n",
860 $filename, length $$rdata, scalar @$objs; 1172 $decname, length $$rdata, scalar @$objs;
861 1173
862 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1174 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
863 chmod SAVE_MODE, $fh; 1175 aio_chmod $fh, SAVE_MODE;
864 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;
865 aio_fsync $fh; 1179 aio_fsync $fh;
1180 }
866 close $fh; 1181 aio_close $fh;
867 1182
868 if (@$objs) { 1183 if (@$objs) {
869 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) {
870 chmod SAVE_MODE, $fh; 1185 aio_chmod $fh, SAVE_MODE;
871 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1186 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
872 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;
873 aio_fsync $fh; 1190 aio_fsync $fh;
1191 }
874 close $fh; 1192 aio_close $fh;
875 aio_rename "$filename.pst~", "$filename.pst"; 1193 aio_rename "$filename.pst~", "$filename.pst";
876 } 1194 }
877 } else { 1195 } else {
878 aio_unlink "$filename.pst"; 1196 aio_unlink "$filename.pst";
879 } 1197 }
880 1198
881 aio_rename "$filename~", $filename; 1199 aio_rename "$filename~", $filename;
1200
1201 $filename =~ s%/[^/]+$%%;
1202 aio_pathsync $filename if $cf::USE_FSYNC;
882 } else { 1203 } else {
883 warn "FATAL: $filename~: $!\n"; 1204 warn "unable to save objects: $filename~: $!\n";
884 } 1205 }
885 } else { 1206 } else {
886 aio_unlink $filename; 1207 aio_unlink $filename;
887 aio_unlink "$filename.pst"; 1208 aio_unlink "$filename.pst";
888 } 1209 }
889 } 1210 };
890} 1211}
891 1212
892sub object_freezer_as_string { 1213sub object_freezer_as_string {
893 my ($rdata, $objs) = @_; 1214 my ($rdata, $objs) = @_;
894 1215
906 or return; 1227 or return;
907 1228
908 unless (aio_stat "$filename.pst") { 1229 unless (aio_stat "$filename.pst") {
909 (aio_load "$filename.pst", $av) >= 0 1230 (aio_load "$filename.pst", $av) >= 0
910 or return; 1231 or return;
1232
911 $av = eval { (Storable::thaw $av)->{objs} }; 1233 my $st = eval { Coro::Storable::thaw $av };
1234 $av = $st->{objs};
912 } 1235 }
913 1236
1237 utf8::decode (my $decname = $filename);
914 warn sprintf "loading %s (%d)\n", 1238 warn sprintf "loading %s (%d,%d)\n",
915 $filename, length $data, scalar @{$av || []};#d# 1239 $decname, length $data, scalar @{$av || []};
1240
916 return ($data, $av); 1241 ($data, $av)
917} 1242}
1243
1244=head2 COMMAND CALLBACKS
1245
1246=over 4
1247
1248=cut
918 1249
919############################################################################# 1250#############################################################################
920# command handling &c 1251# command handling &c
921 1252
922=item cf::register_command $name => \&callback($ob,$args); 1253=item cf::register_command $name => \&callback($ob,$args);
935 push @{ $COMMAND{$name} }, [$caller, $cb]; 1266 push @{ $COMMAND{$name} }, [$caller, $cb];
936} 1267}
937 1268
938=item cf::register_extcmd $name => \&callback($pl,$packet); 1269=item cf::register_extcmd $name => \&callback($pl,$packet);
939 1270
940Register 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.
941 1276
942If 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
943called. 1278called.
944 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
945=cut 1291=cut
946 1292
947sub register_extcmd { 1293sub register_extcmd {
948 my ($name, $cb) = @_; 1294 my ($name, $cb) = @_;
949 1295
950 my $caller = caller;
951 #warn "registering extcmd '$name' to '$caller'";
952
953 $EXTCMD{$name} = [$cb, $caller]; 1296 $EXTCMD{$name} = $cb;
954} 1297}
1298
1299sub register_exticmd {
1300 my ($name, $cb) = @_;
1301
1302 $EXTICMD{$name} = $cb;
1303}
1304
1305use File::Glob ();
955 1306
956cf::player->attach ( 1307cf::player->attach (
957 on_command => sub { 1308 on_command => sub {
958 my ($pl, $name, $params) = @_; 1309 my ($pl, $name, $params) = @_;
959 1310
967 cf::override; 1318 cf::override;
968 }, 1319 },
969 on_extcmd => sub { 1320 on_extcmd => sub {
970 my ($pl, $buf) = @_; 1321 my ($pl, $buf) = @_;
971 1322
972 my $msg = eval { from_json $buf }; 1323 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
973 1324
974 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
975 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1333 if (my $cb = $EXTCMD{$type}) {
976 if (my %reply = $cb->[0]->($pl, $msg)) { 1334 @reply = $cb->($pl, @payload);
977 $pl->ext_reply ($msg->{msgid}, %reply);
978 }
979 } 1335 }
1336
1337 $pl->ext_reply ($reply, @reply)
1338 if $reply;
1339
980 } else { 1340 } else {
981 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1341 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
982 } 1342 }
983 1343
984 cf::override; 1344 cf::override;
985 }, 1345 },
986); 1346);
987 1347
988sub register { 1348# "readahead" all extensions
989 my ($base, $pkg) = @_;
990
991 #TODO
992}
993
994sub load_extension { 1349sub cache_extensions {
995 my ($path) = @_; 1350 my $grp = IO::AIO::aio_group;
996 1351
997 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1352 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
998 my $base = $1; 1353 for (grep /\.ext$/, @{$_[0]}) {
999 my $pkg = $1; 1354 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
1000 $pkg =~ s/[^[:word:]]/_/g;
1001 $pkg = "ext::$pkg";
1002
1003 warn "loading '$path' into '$pkg'\n";
1004
1005 open my $fh, "<:utf8", $path
1006 or die "$path: $!";
1007
1008 my $source =
1009 "package $pkg; use strict; use utf8;\n"
1010 . "#line 1 \"$path\"\n{\n"
1011 . (do { local $/; <$fh> })
1012 . "\n};\n1";
1013
1014 eval $source
1015 or die $@ ? "$path: $@\n"
1016 : "extension disabled.\n";
1017
1018 push @exts, $pkg;
1019 $ext_pkg{$base} = $pkg;
1020
1021# no strict 'refs';
1022# @{"$pkg\::ISA"} = ext::;
1023
1024 register $base, $pkg;
1025}
1026
1027sub unload_extension {
1028 my ($pkg) = @_;
1029
1030 warn "removing extension $pkg\n";
1031
1032 # remove hooks
1033 #TODO
1034# for my $idx (0 .. $#PLUGIN_EVENT) {
1035# delete $hook[$idx]{$pkg};
1036# }
1037
1038 # remove commands
1039 for my $name (keys %COMMAND) {
1040 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1041
1042 if (@cb) {
1043 $COMMAND{$name} = \@cb;
1044 } else {
1045 delete $COMMAND{$name};
1046 } 1355 }
1047 } 1356 };
1048 1357
1049 # remove extcmds 1358 $grp
1050 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1051 delete $EXTCMD{$name};
1052 }
1053
1054 if (my $cb = $pkg->can ("unload")) {
1055 eval {
1056 $cb->($pkg);
1057 1
1058 } or warn "$pkg unloaded, but with errors: $@";
1059 }
1060
1061 Symbol::delete_package $pkg;
1062} 1359}
1063 1360
1064sub load_extensions { 1361sub load_extensions {
1362 cf::sync_job {
1363 my %todo;
1364
1065 for my $ext (<$LIBDIR/*.ext>) { 1365 for my $path (<$LIBDIR/*.ext>) {
1066 next unless -r $ext; 1366 next unless -r $path;
1067 eval { 1367
1068 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;
1069 1 1424 }
1070 } or warn "$ext not loaded: $@"; 1425
1426 skip:
1427 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1428 unless $progress;
1429 }
1071 } 1430 };
1072} 1431}
1073 1432
1074############################################################################# 1433#############################################################################
1075# load/save/clean perl data associated with a map
1076 1434
1077*cf::mapsupport::on_clean = sub { 1435=back
1078 my ($map) = @_;
1079
1080 my $path = $map->tmpname;
1081 defined $path or return;
1082
1083 unlink "$path.pst";
1084};
1085
1086cf::map->attach (prio => -10000, package => cf::mapsupport::);
1087
1088#############################################################################
1089 1436
1090=head2 CORE EXTENSIONS 1437=head2 CORE EXTENSIONS
1091 1438
1092Functions and methods that extend core crossfire objects. 1439Functions and methods that extend core deliantra objects.
1093 1440
1094=cut 1441=cut
1095 1442
1096package cf::player; 1443package cf::player;
1097 1444
1099 1446
1100=head3 cf::player 1447=head3 cf::player
1101 1448
1102=over 4 1449=over 4
1103 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
1104=item cf::player::find $login 1465=item cf::player::find $login
1105 1466
1106Returns the given player object, loading it if necessary (might block). 1467Returns the given player object, loading it if necessary (might block).
1107 1468
1108=cut 1469=cut
1109 1470
1110sub playerdir($) { 1471sub playerdir($) {
1111 cf::localdir 1472 "$PLAYERDIR/"
1112 . "/"
1113 . cf::playerdir
1114 . "/"
1115 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1473 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1116} 1474}
1117 1475
1118sub path($) { 1476sub path($) {
1119 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1477 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1120 1478
1121 (playerdir $login) . "/$login.pl" 1479 (playerdir $login) . "/playerdata"
1122} 1480}
1123 1481
1124sub find_active($) { 1482sub find_active($) {
1125 $cf::PLAYER{$_[0]} 1483 $cf::PLAYER{$_[0]}
1126 and $cf::PLAYER{$_[0]}->active 1484 and $cf::PLAYER{$_[0]}->active
1129 1487
1130sub exists($) { 1488sub exists($) {
1131 my ($login) = @_; 1489 my ($login) = @_;
1132 1490
1133 $cf::PLAYER{$login} 1491 $cf::PLAYER{$login}
1134 or cf::sync_job { !aio_stat $login } 1492 or !aio_stat path $login
1135} 1493}
1136 1494
1137sub find($) { 1495sub find($) {
1138 return $cf::PLAYER{$_[0]} || do { 1496 return $cf::PLAYER{$_[0]} || do {
1139 my $login = $_[0]; 1497 my $login = $_[0];
1140 1498
1141 my $guard = cf::lock_acquire "user_find:$login"; 1499 my $guard = cf::lock_acquire "user_find:$login";
1142 1500
1143 $cf::PLAYER{$_[0]} || do { 1501 $cf::PLAYER{$_[0]} || do {
1144 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
1145 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;
1146 $cf::PLAYER{$login} = $pl 1517 $cf::PLAYER{$login} = $pl
1147 } 1518 }
1148 } 1519 }
1149} 1520}
1150 1521
1159 return if $pl->{deny_save}; 1530 return if $pl->{deny_save};
1160 1531
1161 aio_mkdir playerdir $pl, 0770; 1532 aio_mkdir playerdir $pl, 0770;
1162 $pl->{last_save} = $cf::RUNTIME; 1533 $pl->{last_save} = $cf::RUNTIME;
1163 1534
1535 cf::get_slot 0.01;
1536
1164 $pl->save_pl ($path); 1537 $pl->save_pl ($path);
1165 Coro::cede; 1538 cf::cede_to_tick;
1166} 1539}
1167 1540
1168sub new($) { 1541sub new($) {
1169 my ($login) = @_; 1542 my ($login) = @_;
1170 1543
1176 $cf::PLAYER{$login} = $self; 1549 $cf::PLAYER{$login} = $self;
1177 1550
1178 $self 1551 $self
1179} 1552}
1180 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
1181=item $pl->quit_character 1564=item $pl->quit_character
1182 1565
1183Nukes the player without looking back. If logged in, the connection will 1566Nukes the player without looking back. If logged in, the connection will
1184be destroyed. May block for a long time. 1567be destroyed. May block for a long time.
1185 1568
1186=cut 1569=cut
1187 1570
1188sub quit_character { 1571sub quit_character {
1189 my ($pl) = @_; 1572 my ($pl) = @_;
1190 1573
1574 my $name = $pl->ob->name;
1575
1191 $pl->{deny_save} = 1; 1576 $pl->{deny_save} = 1;
1192 $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
1193 1578
1194 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1579 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1195 $pl->deactivate; 1580 $pl->deactivate;
1581 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1582 $pl->ob->check_score;
1196 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1583 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1197 $pl->ns->destroy if $pl->ns; 1584 $pl->ns->destroy if $pl->ns;
1198 1585
1199 my $path = playerdir $pl; 1586 my $path = playerdir $pl;
1200 my $temp = "$path~$cf::RUNTIME~deleting~"; 1587 my $temp = "$path~$cf::RUNTIME~deleting~";
1201 aio_rename $path, $temp; 1588 aio_rename $path, $temp;
1202 delete $cf::PLAYER{$pl->ob->name}; 1589 delete $cf::PLAYER{$pl->ob->name};
1203 $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
1204 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;
1205} 1612}
1206 1613
1207=item cf::player::list_logins 1614=item cf::player::list_logins
1208 1615
1209Returns 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
1210while and may block, so not sync_job-capable, ever. 1617while and may block, so not sync_job-capable, ever.
1211 1618
1212=cut 1619=cut
1213 1620
1214sub list_logins { 1621sub list_logins {
1215 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1622 my $dirs = aio_readdir $PLAYERDIR
1216 or return []; 1623 or return [];
1217 1624
1218 my @logins; 1625 my @logins;
1219 1626
1220 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") {
1221 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1633 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1222 aio_read $fh, 0, 512, my $buf, 0 or next; 1634 aio_read $fh, 0, 512, my $buf, 0 or next;
1223 $buf !~ /^password -------------$/m or next; # official not-valid tag 1635 $buf !~ /^password -------------$/m or next; # official not-valid tag
1636 }
1224 1637
1225 utf8::decode $login; 1638 utf8::decode $login;
1226 push @logins, $login; 1639 push @logins, $login;
1227 } 1640 }
1228 1641
1229 \@logins 1642 \@logins
1230} 1643}
1231 1644
1232=item $player->maps 1645=item $player->maps
1233 1646
1234Returns 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
1235player. May block. 1648player. May block.
1236 1649
1237=cut 1650=cut
1238 1651
1239sub maps($) { 1652sub maps($) {
1240 my ($pl) = @_; 1653 my ($pl) = @_;
1654
1655 $pl = ref $pl ? $pl->ob->name : $pl;
1241 1656
1242 my $files = aio_readdir playerdir $pl 1657 my $files = aio_readdir playerdir $pl
1243 or return; 1658 or return;
1244 1659
1245 my @paths; 1660 my @paths;
1247 for (@$files) { 1662 for (@$files) {
1248 utf8::decode $_; 1663 utf8::decode $_;
1249 next if /\.(?:pl|pst)$/; 1664 next if /\.(?:pl|pst)$/;
1250 next unless /^$PATH_SEP/o; 1665 next unless /^$PATH_SEP/o;
1251 1666
1252 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_; 1667 push @paths, cf::map::normalise "~$pl/$_";
1253 } 1668 }
1254 1669
1255 \@paths 1670 \@paths
1256} 1671}
1257 1672
1673=item $protocol_xml = $player->expand_cfpod ($cfpod)
1674
1675Expand deliantra pod fragments into protocol xml.
1676
1258=item $player->ext_reply ($msgid, $msgtype, %msg) 1677=item $player->ext_reply ($msgid, @msg)
1259 1678
1260Sends an ext reply to the player. 1679Sends an ext reply to the player.
1261 1680
1262=cut 1681=cut
1263 1682
1264sub ext_reply($$$%) { 1683sub ext_reply($$@) {
1265 my ($self, $id, %msg) = @_; 1684 my ($self, $id, @msg) = @_;
1266 1685
1267 $msg{msgid} = $id; 1686 $self->ns->ext_reply ($id, @msg)
1268
1269 $self->send ("ext " . cf::to_json \%msg);
1270} 1687}
1271 1688
1272package 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}
1273 1729
1274=back 1730=back
1275
1276 1731
1277=head3 cf::map 1732=head3 cf::map
1278 1733
1279=over 4 1734=over 4
1280 1735
1283package cf::map; 1738package cf::map;
1284 1739
1285use Fcntl; 1740use Fcntl;
1286use Coro::AIO; 1741use Coro::AIO;
1287 1742
1743use overload
1744 '""' => \&as_string,
1745 fallback => 1;
1746
1288our $MAX_RESET = 3600; 1747our $MAX_RESET = 3600;
1289our $DEFAULT_RESET = 3000; 1748our $DEFAULT_RESET = 3000;
1290 1749
1291sub generate_random_map { 1750sub generate_random_map {
1292 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
1293 1754
1294 # mit "rum" bekleckern, nicht 1755 # mit "rum" bekleckern, nicht
1295 cf::map::_create_random_map 1756 $self->_create_random_map (
1296 $path,
1297 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1757 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1298 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1758 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1299 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1759 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1300 $rmp->{exit_on_final_map}, 1760 $rmp->{exit_on_final_map},
1301 $rmp->{xsize}, $rmp->{ysize}, 1761 $rmp->{xsize}, $rmp->{ysize},
1302 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1762 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1303 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1763 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1304 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1764 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1305 $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},
1306 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1766 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1307 (cf::region::find $rmp->{region}) 1767 (cf::region::find $rmp->{region}), $rmp->{custom}
1768 )
1308} 1769}
1309 1770
1310# and all this just because we cannot iterate over 1771=item cf::map->register ($regex, $prio)
1311# all maps in C++...
1312sub change_all_map_light {
1313 my ($change) = @_;
1314 1772
1315 $_->change_map_light ($change) 1773Register a handler for the map path matching the given regex at the
1316 for grep $_->outdoor, values %cf::MAP; 1774givne priority (higher is better, built-in handlers have priority 0, the
1317} 1775default).
1318 1776
1319sub 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 {
1320 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) = @_;
1321 1916
1322 utf8::encode $path; 1917 utf8::encode $path;
1323 aio_open $path, O_RDONLY, 0 1918 my $f = new_from_file cf::object::thawer $path
1324 or return; 1919 or return;
1325 1920
1326 my $map = cf::map::new 1921 $self->_load_header ($f)
1327 or return; 1922 or return;
1328 1923
1329 # for better error messages only, will be overwritten 1924 local $MAP_LOADING{$self->{path}} = $self;
1330 $map->path ($path); 1925 $f->resolve_delayed_derefs;
1331 1926
1332 $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
1333 or return; 1970 or return;
1971 $self->prepare_orig;
1972 }
1334 1973
1335 $map->{load_path} = $path; 1974 $self->{deny_reset} = 1
1975 if $self->no_reset;
1336 1976
1337 $map 1977 $self->default_region (cf::region::find_by_path $self->{path})
1978 unless $self->default_region;
1979
1980 1
1338} 1981}
1339 1982
1340sub find; 1983sub find;
1341sub find { 1984sub find {
1342 my ($path, $origin) = @_; 1985 my ($path, $origin) = @_;
1343 1986
1344 #warn "find<$path,$origin>\n";#d#
1345
1346 $path = new cf::path $path, $origin && $origin->path; 1987 $path = normalise $path, $origin && $origin->path;
1347 my $key = $path->as_string;
1348 1988
1349 cf::lock_wait "map_find:$key"; 1989 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1350
1351 $cf::MAP{$key} || do {
1352 my $guard = cf::lock_acquire "map_find:$key"; 1990 my $guard2 = cf::lock_acquire "map_find:$path";
1353 1991
1354 # do it the slow way 1992 $cf::MAP{$path} || do {
1355 my $map = try_load_header $path->save_path; 1993 my $map = new_from_path cf::map $path
1356
1357 Coro::cede;
1358
1359 if ($map) {
1360 $map->last_access ((delete $map->{last_access})
1361 || $cf::RUNTIME); #d#
1362 # safety
1363 $map->{instantiate_time} = $cf::RUNTIME
1364 if $map->{instantiate_time} > $cf::RUNTIME;
1365 } else {
1366 if (my $rmp = $path->random_map_params) {
1367 $map = generate_random_map $key, $rmp;
1368 } else {
1369 $map = try_load_header $path->load_path;
1370 }
1371
1372 $map or return; 1994 or return;
1373 1995
1374 $map->{load_original} = 1;
1375 $map->{instantiate_time} = $cf::RUNTIME;
1376 $map->last_access ($cf::RUNTIME);
1377 $map->instantiate;
1378
1379 # per-player maps become, after loading, normal maps
1380 $map->per_player (0) if $path->{user_rel};
1381 }
1382
1383 $map->path ($key);
1384 $map->{path} = $path;
1385 $map->{last_save} = $cf::RUNTIME; 1996 $map->{last_save} = $cf::RUNTIME;
1386 1997
1387 Coro::cede; 1998 $map->load_header
1999 or return;
1388 2000
1389 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;
1390 $map->reset; 2006 $map->reset;
1391 undef $guard;
1392 $map = find $path 2007 return find $path;
1393 or return;
1394 } 2008 }
1395 2009
1396 $cf::MAP{$key} = $map 2010 $cf::MAP{$path} = $map
1397 } 2011 }
1398} 2012}
2013
2014sub pre_load { }
2015sub post_load { }
1399 2016
1400sub load { 2017sub load {
1401 my ($self) = @_; 2018 my ($self) = @_;
1402 2019
2020 local $self->{deny_reset} = 1; # loading can take a long time
2021
1403 my $path = $self->{path}; 2022 my $path = $self->{path};
2023
2024 {
1404 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 2025 my $guard = cf::lock_acquire "map_data:$path";
1405 2026
2027 return unless $self->valid;
1406 return if $self->in_memory != cf::MAP_SWAPPED; 2028 return unless $self->in_memory == cf::MAP_SWAPPED;
1407 2029
1408 $self->in_memory (cf::MAP_LOADING); 2030 $self->in_memory (cf::MAP_LOADING);
1409 2031
1410 $self->alloc; 2032 $self->alloc;
1411 $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)
1412 or return; 2040 or return;
1413 2041
1414 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2042 $self->post_load_original
1415 if delete $self->{load_original}; 2043 if delete $self->{load_original};
1416 2044
1417 if (my $uniq = $path->uniq_path) { 2045 if (my $uniq = $self->uniq_path) {
1418 utf8::encode $uniq; 2046 utf8::encode $uniq;
1419 if (aio_open $uniq, O_RDONLY, 0) { 2047 unless (aio_stat $uniq) {
2048 if (my $f = new_from_file cf::object::thawer $uniq) {
1420 $self->clear_unique_items; 2049 $self->clear_unique_items;
1421 $self->load_objects ($uniq, 0); 2050 $self->_load_objects ($f);
2051 $f->resolve_delayed_derefs;
2052 }
1422 } 2053 }
1423 } 2054 }
1424 2055
1425 Coro::cede; 2056 $f->resolve_delayed_derefs;
1426 2057
2058 cf::cede_to_tick;
1427 # now do the right thing for maps 2059 # now do the right thing for maps
1428 $self->link_multipart_objects; 2060 $self->link_multipart_objects;
1429
1430 if ($self->{path}->is_style_map) {
1431 $self->{deny_save} = 1;
1432 $self->{deny_reset} = 1;
1433 } else {
1434 $self->fix_auto_apply;
1435 $self->decay_objects;
1436 $self->update_buttons;
1437 $self->set_darkness_map;
1438 $self->difficulty ($self->estimate_difficulty) 2061 $self->difficulty ($self->estimate_difficulty)
1439 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;
1440 $self->activate; 2070 $self->activate;
1441 } 2071 }
1442 2072
1443 Coro::cede; 2073 $self->{last_save} = $cf::RUNTIME;
2074 $self->last_access ($cf::RUNTIME);
1444 2075
1445 $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
1446} 2092}
1447 2093
1448# 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
1449sub load_diag { 2095sub load_neighbours {
1450 my ($map) = @_; 2096 my ($map) = @_;
1451 2097
1452 my @diag; # diagonal neighbours 2098 my @neigh; # diagonal neighbours
1453 2099
1454 for (0 .. 3) { 2100 for (0 .. 3) {
1455 my $neigh = $map->tile_path ($_) 2101 my $neigh = $map->tile_path ($_)
1456 or next; 2102 or next;
1457 $neigh = find $neigh, $map 2103 $neigh = find $neigh, $map
1458 or next; 2104 or next;
1459 $neigh->load; 2105 $neigh->load;
1460 2106
2107 push @neigh,
1461 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2108 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1462 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2109 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1463 } 2110 }
1464 2111
1465 for (@diag) { 2112 for (grep defined $_->[0], @neigh) {
2113 my ($path, $origin) = @$_;
1466 my $neigh = find @$_ 2114 my $neigh = find $path, $origin
1467 or next; 2115 or next;
1468 $neigh->load; 2116 $neigh->load;
1469 } 2117 }
1470} 2118}
1471 2119
1476} 2124}
1477 2125
1478sub do_load_sync { 2126sub do_load_sync {
1479 my ($map) = @_; 2127 my ($map) = @_;
1480 2128
2129 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2130 if $Coro::current == $Coro::main;
2131
1481 cf::sync_job { $map->load }; 2132 cf::sync_job { $map->load };
1482} 2133}
1483 2134
1484our %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
1485our $MAP_PREFETCHER = Coro::async { 2149 $MAP_PREFETCHER ||= cf::async {
1486 while () { 2150 $Coro::current->{desc} = "map prefetcher";
2151
1487 while (%MAP_PREFETCH) { 2152 while (%MAP_PREFETCH) {
1488 my $key = each %MAP_PREFETCH 2153 while (my ($k, $v) = each %MAP_PREFETCH) {
1489 or next; 2154 if (my $map = find $k) {
2155 $map->load if $v;
2156 }
2157
1490 my $path = delete $MAP_PREFETCH{$key}; 2158 delete $MAP_PREFETCH{$k};
1491
1492 my $map = find $path
1493 or next;
1494 $map->load;
1495 } 2159 }
1496 Coro::schedule; 2160 }
2161 undef $MAP_PREFETCHER;
1497 } 2162 };
1498};
1499
1500sub find_async {
1501 my ($path, $origin) = @_;
1502
1503 $path = new cf::path $path, $origin && $origin->path;
1504 my $key = $path->as_string;
1505
1506 if (my $map = $cf::MAP{$key}) {
1507 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1508 }
1509
1510 $MAP_PREFETCH{$key} = $path;
1511 $MAP_PREFETCHER->ready; 2163 $MAP_PREFETCHER->prio (6);
1512 2164
1513 () 2165 ()
1514} 2166}
1515 2167
1516sub save { 2168sub save {
1517 my ($self) = @_; 2169 my ($self) = @_;
1518 2170
1519 my $lock = cf::lock_acquire "map_data:" . $self->path; 2171 my $lock = cf::lock_acquire "map_data:$self->{path}";
1520 2172
1521 $self->{last_save} = $cf::RUNTIME; 2173 $self->{last_save} = $cf::RUNTIME;
1522 2174
1523 return unless $self->dirty; 2175 return unless $self->dirty;
1524 2176
1525 my $save = $self->{path}->save_path; utf8::encode $save; 2177 my $save = $self->save_path; utf8::encode $save;
1526 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2178 my $uniq = $self->uniq_path; utf8::encode $uniq;
1527 2179
1528 $self->{load_path} = $save; 2180 $self->{load_path} = $save;
1529 2181
1530 return if $self->{deny_save}; 2182 return if $self->{deny_save};
1531 2183
1532 local $self->{last_access} = $self->last_access;#d# 2184 local $self->{last_access} = $self->last_access;#d#
1533 2185
1534 cf::async { 2186 cf::async {
2187 $Coro::current->{desc} = "map player save";
1535 $_->contr->save for $self->players; 2188 $_->contr->save for $self->players;
1536 }; 2189 };
1537 2190
2191 cf::get_slot 0.02;
2192
1538 if ($uniq) { 2193 if ($uniq) {
1539 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2194 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1540 $self->save_objects ($uniq, cf::IO_UNIQUES); 2195 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1541 } else { 2196 } else {
1542 $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);
1543 } 2198 }
1544} 2199}
1545 2200
1546sub swap_out { 2201sub swap_out {
1547 my ($self) = @_; 2202 my ($self) = @_;
1548 2203
1549 # save first because save cedes 2204 # save first because save cedes
1550 $self->save; 2205 $self->save;
1551 2206
1552 my $lock = cf::lock_acquire "map_data:" . $self->path; 2207 my $lock = cf::lock_acquire "map_data:$self->{path}";
1553 2208
1554 return if $self->players; 2209 return if $self->players;
1555 return if $self->in_memory != cf::MAP_IN_MEMORY; 2210 return if $self->in_memory != cf::MAP_ACTIVE;
1556 return if $self->{deny_save}; 2211 return if $self->{deny_save};
1557 2212
2213 $self->in_memory (cf::MAP_SWAPPED);
2214
2215 $self->deactivate;
2216 $_->clear_links_to ($self) for values %cf::MAP;
1558 $self->clear; 2217 $self->clear;
1559 $self->in_memory (cf::MAP_SWAPPED);
1560} 2218}
1561 2219
1562sub reset_at { 2220sub reset_at {
1563 my ($self) = @_; 2221 my ($self) = @_;
1564 2222
1565 # TODO: safety, remove and allow resettable per-player maps 2223 # TODO: safety, remove and allow resettable per-player maps
1566 return 1e99 if $self->{path}{user_rel};
1567 return 1e99 if $self->{deny_reset}; 2224 return 1e99 if $self->{deny_reset};
1568 2225
1569 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2226 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1570 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;
1571 2228
1576 my ($self) = @_; 2233 my ($self) = @_;
1577 2234
1578 $self->reset_at <= $cf::RUNTIME 2235 $self->reset_at <= $cf::RUNTIME
1579} 2236}
1580 2237
1581sub unlink_save {
1582 my ($self) = @_;
1583
1584 utf8::encode (my $save = $self->{path}->save_path);
1585 aioreq_pri 3; IO::AIO::aio_unlink $save;
1586 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1587}
1588
1589sub rename {
1590 my ($self, $new_path) = @_;
1591
1592 $self->unlink_save;
1593
1594 delete $cf::MAP{$self->path};
1595 $self->{path} = new cf::path $new_path;
1596 $self->path ($self->{path}->as_string);
1597 $cf::MAP{$self->path} = $self;
1598
1599 $self->save;
1600}
1601
1602sub reset { 2238sub reset {
1603 my ($self) = @_; 2239 my ($self) = @_;
1604 2240
1605 my $lock = cf::lock_acquire "map_data:" . $self->path; 2241 my $lock = cf::lock_acquire "map_data:$self->{path}";
1606 2242
1607 return if $self->players; 2243 return if $self->players;
1608 return if $self->{path}{user_rel};#d#
1609 2244
1610 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 }
1611 2256
1612 delete $cf::MAP{$self->path}; 2257 delete $cf::MAP{$self->path};
1613 2258
2259 $self->deactivate;
1614 $_->clear_links_to ($self) for values %cf::MAP; 2260 $_->clear_links_to ($self) for values %cf::MAP;
2261 $self->clear;
1615 2262
1616 $self->unlink_save; 2263 $self->unlink_save;
1617 $self->destroy; 2264 $self->destroy;
1618} 2265}
1619 2266
1620my $nuke_counter = "aaaa"; 2267my $nuke_counter = "aaaa";
1621 2268
1622sub nuke { 2269sub nuke {
1623 my ($self) = @_; 2270 my ($self) = @_;
1624 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};
1625 $self->{deny_save} = 1; 2281 $self->{deny_save} = 1;
1626 $self->reset_timeout (1); 2282 $self->reset_timeout (1);
1627 $self->rename ("{nuke}/" . ($nuke_counter++)); 2283 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2284
2285 $cf::MAP{$self->path} = $self;
2286 }
2287
1628 $self->reset; # polite request, might not happen 2288 $self->reset; # polite request, might not happen
1629} 2289}
1630 2290
1631sub customise_for { 2291=item $maps = cf::map::tmp_maps
1632 my ($map, $ob) = @_;
1633 2292
1634 if ($map->per_player) { 2293Returns an arrayref with all map paths of currently instantiated and saved
1635 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2294maps. May block.
2295
2296=cut
2297
2298sub tmp_maps() {
1636 } 2299 [
2300 map {
2301 utf8::decode $_;
2302 /\.map$/
2303 ? normalise $_
2304 : ()
2305 } @{ aio_readdir $TMPDIR or [] }
2306 ]
2307}
1637 2308
1638 $map 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 ]
1639} 2325}
1640 2326
1641=item cf::map::unique_maps 2327=item cf::map::unique_maps
1642 2328
1643Returns an arrayref of cf::path's of all shared maps that have 2329Returns an arrayref of paths of all shared maps that have
1644instantiated unique items. May block. 2330instantiated unique items. May block.
1645 2331
1646=cut 2332=cut
1647 2333
1648sub unique_maps() { 2334sub unique_maps() {
1649 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2335 [
1650 or return; 2336 map {
1651
1652 my @paths;
1653
1654 for (@$files) {
1655 utf8::decode $_; 2337 utf8::decode $_;
1656 next if /\.pst$/; 2338 s/\.map$//; # TODO future compatibility hack
1657 next unless /^$PATH_SEP/o; 2339 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1658 2340 ? ()
1659 push @paths, new cf::path $_; 2341 : normalise $_
2342 } @{ aio_readdir $UNIQUEDIR or [] }
1660 } 2343 ]
1661
1662 \@paths
1663} 2344}
1664
1665package cf;
1666 2345
1667=back 2346=back
1668 2347
1669=head3 cf::object 2348=head3 cf::object
1670 2349
1674 2353
1675=over 4 2354=over 4
1676 2355
1677=item $ob->inv_recursive 2356=item $ob->inv_recursive
1678 2357
1679Returns the inventory of the object _and_ their inventories, recursively. 2358Returns the inventory of the object I<and> their inventories, recursively,
2359but I<not> the object itself.
1680 2360
1681=cut 2361=cut
1682 2362
1683sub inv_recursive_; 2363sub inv_recursive_;
1684sub inv_recursive_ { 2364sub inv_recursive_ {
1687 2367
1688sub inv_recursive { 2368sub inv_recursive {
1689 inv_recursive_ inv $_[0] 2369 inv_recursive_ inv $_[0]
1690} 2370}
1691 2371
2372=item $ref = $ob->ref
2373
2374Creates and returns a persistent reference to an object that can be stored as a string.
2375
2376=item $ob = cf::object::deref ($refstring)
2377
2378returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2379even if the object actually exists. May block.
2380
2381=cut
2382
2383sub deref {
2384 my ($ref) = @_;
2385
2386 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2387 my ($uuid, $name) = ($1, $2);
2388 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2389 or return;
2390 $pl->ob->uuid eq $uuid
2391 or return;
2392
2393 $pl->ob
2394 } else {
2395 warn "$ref: cannot resolve object reference\n";
2396 undef
2397 }
2398}
2399
1692package cf; 2400package cf;
1693 2401
1694=back 2402=back
1695 2403
1696=head3 cf::object::player 2404=head3 cf::object::player
1702Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2410Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1703can be C<undef>. Does the right thing when the player is currently in a 2411can be C<undef>. Does the right thing when the player is currently in a
1704dialogue with the given NPC character. 2412dialogue with the given NPC character.
1705 2413
1706=cut 2414=cut
2415
2416our $SAY_CHANNEL = {
2417 id => "say",
2418 title => "Map",
2419 reply => "say ",
2420 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2421};
2422
2423our $CHAT_CHANNEL = {
2424 id => "chat",
2425 title => "Chat",
2426 reply => "chat ",
2427 tooltip => "Player chat and shouts, global to the server.",
2428};
1707 2429
1708# rough implementation of a future "reply" method that works 2430# rough implementation of a future "reply" method that works
1709# with dialog boxes. 2431# with dialog boxes.
1710#TODO: the first argument must go, split into a $npc->reply_to ( method 2432#TODO: the first argument must go, split into a $npc->reply_to ( method
1711sub cf::object::player::reply($$$;$) { 2433sub cf::object::player::reply($$$;$) {
1713 2435
1714 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2436 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1715 2437
1716 if ($self->{record_replies}) { 2438 if ($self->{record_replies}) {
1717 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2439 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2440
1718 } else { 2441 } else {
2442 my $pl = $self->contr;
2443
2444 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2445 my $dialog = $pl->{npc_dialog};
2446 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2447
2448 } else {
1719 $msg = $npc->name . " says: $msg" if $npc; 2449 $msg = $npc->name . " says: $msg" if $npc;
1720 $self->message ($msg, $flags); 2450 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2451 }
1721 } 2452 }
2453}
2454
2455=item $object->send_msg ($channel, $msg, $color, [extra...])
2456
2457=cut
2458
2459sub cf::object::send_msg {
2460 my $pl = shift->contr
2461 or return;
2462 $pl->send_msg (@_);
1722} 2463}
1723 2464
1724=item $player_object->may ("access") 2465=item $player_object->may ("access")
1725 2466
1726Returns wether the given player is authorized to access resource "access" 2467Returns wether the given player is authorized to access resource "access"
1739 2480
1740=item $player_object->enter_link 2481=item $player_object->enter_link
1741 2482
1742Freezes the player and moves him/her to a special map (C<{link}>). 2483Freezes the player and moves him/her to a special map (C<{link}>).
1743 2484
1744The player should be reaosnably safe there for short amounts of time. You 2485The player should be reasonably safe there for short amounts of time (e.g.
1745I<MUST> call C<leave_link> as soon as possible, though. 2486for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2487though, as the palyer cannot control the character while it is on the link
2488map.
2489
2490Will never block.
1746 2491
1747=item $player_object->leave_link ($map, $x, $y) 2492=item $player_object->leave_link ($map, $x, $y)
1748 2493
1749Moves the player out of the specila link map onto the given map. If the 2494Moves the player out of the special C<{link}> map onto the specified
1750map is not valid (or omitted), the player will be moved back to the 2495map. If the map is not valid (or omitted), the player will be moved back
1751location he/she was before the call to C<enter_link>, or, if that fails, 2496to the location he/she was before the call to C<enter_link>, or, if that
1752to the emergency map position. 2497fails, to the emergency map position.
1753 2498
1754Might block. 2499Might block.
1755 2500
1756=cut 2501=cut
2502
2503sub link_map {
2504 unless ($LINK_MAP) {
2505 $LINK_MAP = cf::map::find "{link}"
2506 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2507 $LINK_MAP->load;
2508 }
2509
2510 $LINK_MAP
2511}
1757 2512
1758sub cf::object::player::enter_link { 2513sub cf::object::player::enter_link {
1759 my ($self) = @_; 2514 my ($self) = @_;
1760 2515
1761 $self->deactivate_recursive; 2516 $self->deactivate_recursive;
1762 2517
1763 return if $self->map == $LINK_MAP; 2518 return if UNIVERSAL::isa $self->map, "ext::map_link";
1764 2519
1765 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2520 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1766 if $self->map; 2521 if $self->map && $self->map->{path} ne "{link}";
1767 2522
1768 $self->enter_map ($LINK_MAP, 20, 20); 2523 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1769} 2524}
1770 2525
1771sub cf::object::player::leave_link { 2526sub cf::object::player::leave_link {
1772 my ($self, $map, $x, $y) = @_; 2527 my ($self, $map, $x, $y) = @_;
2528
2529 return unless $self->contr->active;
1773 2530
1774 my $link_pos = delete $self->{_link_pos}; 2531 my $link_pos = delete $self->{_link_pos};
1775 2532
1776 unless ($map) { 2533 unless ($map) {
1777 # restore original map position 2534 # restore original map position
1791 # use -1 or undef as default coordinates, not 0, 0 2548 # use -1 or undef as default coordinates, not 0, 0
1792 ($x, $y) = ($map->enter_x, $map->enter_y) 2549 ($x, $y) = ($map->enter_x, $map->enter_y)
1793 if $x <=0 && $y <= 0; 2550 if $x <=0 && $y <= 0;
1794 2551
1795 $map->load; 2552 $map->load;
1796 $map->load_diag; 2553 $map->load_neighbours;
1797 2554
1798 return unless $self->contr->active; 2555 return unless $self->contr->active;
2556
2557 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2558 $self->enter_map ($map, $x, $y);
2559
2560 # only activate afterwards, to support waiting in hooks
1799 $self->activate_recursive; 2561 $self->activate_recursive;
1800 $self->enter_map ($map, $x, $y);
1801} 2562}
1802 2563
1803cf::player->attach ( 2564=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1804 on_logout => sub {
1805 my ($pl) = @_;
1806 2565
1807 # abort map switching before logout 2566Moves the player to the given map-path and coordinates by first freezing
1808 if ($pl->ob->{_link_pos}) { 2567her, loading and preparing them map, calling the provided $check callback
1809 cf::sync_job { 2568that has to return the map if sucecssful, and then unfreezes the player on
1810 $pl->ob->leave_link 2569the new (success) or old (failed) map position. In either case, $done will
1811 }; 2570be called at the end of this process.
1812 }
1813 },
1814 on_login => sub {
1815 my ($pl) = @_;
1816 2571
1817 # try to abort aborted map switching on player login :) 2572Note that $check will be called with a potentially non-loaded map, so if
1818 # should happen only on crashes 2573it needs a loaded map it has to call C<< ->load >>.
1819 if ($pl->ob->{_link_pos}) {
1820 $pl->ob->enter_link;
1821 (async {
1822 # we need this sleep as the login has a concurrent enter_exit running
1823 # and this sleep increases chances of the player not ending up in scorn
1824 $pl->ob->reply (undef,
1825 "There was an internal problem at your last logout, "
1826 . "the server will try to bring you to your intended destination in a second.",
1827 cf::NDI_RED);
1828 Coro::Timer::sleep 1;
1829 $pl->ob->leave_link;
1830 })->prio (2);
1831 }
1832 },
1833);
1834 2574
1835=item $player_object->goto ($path, $x, $y)
1836
1837=cut 2575=cut
2576
2577our $GOTOGEN;
1838 2578
1839sub cf::object::player::goto { 2579sub cf::object::player::goto {
1840 my ($self, $path, $x, $y) = @_; 2580 my ($self, $path, $x, $y, $check, $done) = @_;
1841 2581
1842 $path = new cf::path $path; 2582 # do generation counting so two concurrent goto's will be executed in-order
2583 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1843 2584
1844 $self->enter_link; 2585 $self->enter_link;
1845 2586
1846 (async { 2587 (async {
1847 my $map = cf::map::find $path->as_string; 2588 $Coro::current->{desc} = "player::goto $path $x $y";
2589
2590 # *tag paths override both path and x|y
2591 if ($path =~ /^\*(.*)$/) {
2592 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2593 my $ob = $obs[rand @obs];
2594
2595 # see if we actually can go there
2596 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2597 $ob = $obs[rand @obs];
2598 } else {
2599 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2600 }
2601 # else put us there anyways for now #d#
2602
2603 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2604 } else {
2605 ($path, $x, $y) = (undef, undef, undef);
2606 }
2607 }
2608
2609 my $map = eval {
2610 my $map = defined $path ? cf::map::find $path : undef;
2611
2612 if ($map) {
1848 $map = $map->customise_for ($self) if $map; 2613 $map = $map->customise_for ($self);
1849 2614 $map = $check->($map) if $check && $map;
1850# warn "entering ", $map->path, " at ($x, $y)\n" 2615 } else {
1851# if $map;
1852
1853 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2616 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2617 }
1854 2618
2619 $map
2620 };
2621
2622 if ($@) {
2623 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2624 LOG llevError | logBacktrace, Carp::longmess $@;
2625 }
2626
2627 if ($gen == $self->{_goto_generation}) {
2628 delete $self->{_goto_generation};
1855 $self->leave_link ($map, $x, $y); 2629 $self->leave_link ($map, $x, $y);
2630 }
2631
2632 $done->() if $done;
1856 })->prio (1); 2633 })->prio (1);
1857} 2634}
1858 2635
1859=item $player_object->enter_exit ($exit_object) 2636=item $player_object->enter_exit ($exit_object)
1860 2637
1862 2639
1863sub parse_random_map_params { 2640sub parse_random_map_params {
1864 my ($spec) = @_; 2641 my ($spec) = @_;
1865 2642
1866 my $rmp = { # defaults 2643 my $rmp = { # defaults
1867 xsize => 10, 2644 xsize => (cf::rndm 15, 40),
1868 ysize => 10, 2645 ysize => (cf::rndm 15, 40),
2646 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2647 #layout => string,
1869 }; 2648 };
1870 2649
1871 for (split /\n/, $spec) { 2650 for (split /\n/, $spec) {
1872 my ($k, $v) = split /\s+/, $_, 2; 2651 my ($k, $v) = split /\s+/, $_, 2;
1873 2652
1885 # that depends on the exit object 2664 # that depends on the exit object
1886 2665
1887 my $rmp = parse_random_map_params $exit->msg; 2666 my $rmp = parse_random_map_params $exit->msg;
1888 2667
1889 if ($exit->map) { 2668 if ($exit->map) {
1890 $rmp->{region} = $exit->map->region_name; 2669 $rmp->{region} = $exit->region->name;
1891 $rmp->{origin_map} = $exit->map->path; 2670 $rmp->{origin_map} = $exit->map->path;
1892 $rmp->{origin_x} = $exit->x; 2671 $rmp->{origin_x} = $exit->x;
1893 $rmp->{origin_y} = $exit->y; 2672 $rmp->{origin_y} = $exit->y;
2673
2674 $exit->map->touch;
1894 } 2675 }
1895 2676
1896 $rmp->{random_seed} ||= $exit->random_seed; 2677 $rmp->{random_seed} ||= $exit->random_seed;
1897 2678
1898 my $data = cf::to_json $rmp; 2679 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1899 my $md5 = Digest::MD5::md5_hex $data; 2680 my $md5 = Digest::MD5::md5_hex $data;
2681 my $meta = "$RANDOMDIR/$md5.meta";
1900 2682
1901 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2683 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1902 aio_write $fh, 0, (length $data), $data, 0; 2684 aio_write $fh, 0, (length $data), $data, 0;
2685 undef $fh;
2686 aio_rename "$meta~", $meta;
1903 2687
2688 my $slaying = "?random/$md5";
2689
2690 if ($exit->valid) {
1904 $exit->slaying ("?random/$md5"); 2691 $exit->slaying ("?random/$md5");
1905 $exit->msg (undef); 2692 $exit->msg (undef);
2693 }
1906 } 2694 }
1907} 2695}
1908 2696
1909sub cf::object::player::enter_exit { 2697sub cf::object::player::enter_exit {
1910 my ($self, $exit) = @_; 2698 my ($self, $exit) = @_;
1912 return unless $self->type == cf::PLAYER; 2700 return unless $self->type == cf::PLAYER;
1913 2701
1914 $self->enter_link; 2702 $self->enter_link;
1915 2703
1916 (async { 2704 (async {
1917 $self->deactivate_recursive; # just to be sure 2705 $Coro::current->{desc} = "enter_exit";
2706
1918 unless (eval { 2707 unless (eval {
2708 $self->deactivate_recursive; # just to be sure
2709
2710 # random map handling
2711 {
2712 my $guard = cf::lock_acquire "exit_prepare:$exit";
2713
1919 prepare_random_map $exit 2714 prepare_random_map $exit
1920 if $exit->slaying eq "/!"; 2715 if $exit->slaying eq "/!";
2716 }
1921 2717
1922 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path; 2718 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1923 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 2719 my $x = $exit->stats->hp;
2720 my $y = $exit->stats->sp;
1924 2721
2722 $self->goto ($map, $x, $y);
2723
2724 # if exit is damned, update players death & WoR home-position
2725 $self->contr->savebed ($map, $x, $y)
2726 if $exit->flag (cf::FLAG_DAMNED);
2727
1925 1; 2728 1
1926 }) { 2729 }) {
1927 $self->message ("Something went wrong deep within the crossfire server. " 2730 $self->message ("Something went wrong deep within the deliantra server. "
1928 . "I'll try to bring you back to the map you were before. " 2731 . "I'll try to bring you back to the map you were before. "
1929 . "Please report this to the dungeon master!", 2732 . "Please report this to the dungeon master!",
1930 cf::NDI_UNIQUE | cf::NDI_RED); 2733 cf::NDI_UNIQUE | cf::NDI_RED);
1931 2734
1932 warn "ERROR in enter_exit: $@"; 2735 warn "ERROR in enter_exit: $@";
1933 $self->leave_link; 2736 $self->leave_link;
1934 } 2737 }
1935 })->prio (1); 2738 })->prio (1);
1948 2751
1949sub cf::client::send_drawinfo { 2752sub cf::client::send_drawinfo {
1950 my ($self, $text, $flags) = @_; 2753 my ($self, $text, $flags) = @_;
1951 2754
1952 utf8::encode $text; 2755 utf8::encode $text;
1953 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2756 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1954} 2757}
1955 2758
2759=item $client->send_msg ($channel, $msg, $color, [extra...])
2760
2761Send a drawinfo or msg packet to the client, formatting the msg for the
2762client if neccessary. C<$type> should be a string identifying the type of
2763the message, with C<log> being the default. If C<$color> is negative, suppress
2764the message unless the client supports the msg packet.
2765
2766=cut
2767
2768# non-persistent channels (usually the info channel)
2769our %CHANNEL = (
2770 "c/motd" => {
2771 id => "infobox",
2772 title => "MOTD",
2773 reply => undef,
2774 tooltip => "The message of the day",
2775 },
2776 "c/identify" => {
2777 id => "infobox",
2778 title => "Identify",
2779 reply => undef,
2780 tooltip => "Items recently identified",
2781 },
2782 "c/examine" => {
2783 id => "infobox",
2784 title => "Examine",
2785 reply => undef,
2786 tooltip => "Signs and other items you examined",
2787 },
2788 "c/shopinfo" => {
2789 id => "infobox",
2790 title => "Shop Info",
2791 reply => undef,
2792 tooltip => "What your bargaining skill tells you about the shop",
2793 },
2794 "c/book" => {
2795 id => "infobox",
2796 title => "Book",
2797 reply => undef,
2798 tooltip => "The contents of a note or book",
2799 },
2800 "c/lookat" => {
2801 id => "infobox",
2802 title => "Look",
2803 reply => undef,
2804 tooltip => "What you saw there",
2805 },
2806 "c/who" => {
2807 id => "infobox",
2808 title => "Players",
2809 reply => undef,
2810 tooltip => "Shows players who are currently online",
2811 },
2812 "c/body" => {
2813 id => "infobox",
2814 title => "Body Parts",
2815 reply => undef,
2816 tooltip => "Shows which body parts you posess and are available",
2817 },
2818 "c/statistics" => {
2819 id => "infobox",
2820 title => "Statistics",
2821 reply => undef,
2822 tooltip => "Shows your primary statistics",
2823 },
2824 "c/skills" => {
2825 id => "infobox",
2826 title => "Skills",
2827 reply => undef,
2828 tooltip => "Shows your experience per skill and item power",
2829 },
2830 "c/shopitems" => {
2831 id => "infobox",
2832 title => "Shop Items",
2833 reply => undef,
2834 tooltip => "Shows the items currently for sale in this shop",
2835 },
2836 "c/resistances" => {
2837 id => "infobox",
2838 title => "Resistances",
2839 reply => undef,
2840 tooltip => "Shows your resistances",
2841 },
2842 "c/pets" => {
2843 id => "infobox",
2844 title => "Pets",
2845 reply => undef,
2846 tooltip => "Shows information abotu your pets/a specific pet",
2847 },
2848 "c/perceiveself" => {
2849 id => "infobox",
2850 title => "Perceive Self",
2851 reply => undef,
2852 tooltip => "You gained detailed knowledge about yourself",
2853 },
2854 "c/uptime" => {
2855 id => "infobox",
2856 title => "Uptime",
2857 reply => undef,
2858 tooltip => "How long the server has been running since last restart",
2859 },
2860 "c/mapinfo" => {
2861 id => "infobox",
2862 title => "Map Info",
2863 reply => undef,
2864 tooltip => "Information related to the maps",
2865 },
2866 "c/party" => {
2867 id => "party",
2868 title => "Party",
2869 reply => "gsay ",
2870 tooltip => "Messages and chat related to your party",
2871 },
2872 "c/death" => {
2873 id => "death",
2874 title => "Death",
2875 reply => undef,
2876 tooltip => "Reason for and more info about your most recent death",
2877 },
2878 "c/say" => $SAY_CHANNEL,
2879 "c/chat" => $CHAT_CHANNEL,
2880);
2881
2882sub cf::client::send_msg {
2883 my ($self, $channel, $msg, $color, @extra) = @_;
2884
2885 $msg = $self->pl->expand_cfpod ($msg)
2886 unless $color & cf::NDI_VERBATIM;
2887
2888 $color &= cf::NDI_CLIENT_MASK; # just in case...
2889
2890 # check predefined channels, for the benefit of C
2891 if ($CHANNEL{$channel}) {
2892 $channel = $CHANNEL{$channel};
2893
2894 $self->ext_msg (channel_info => $channel);
2895 $channel = $channel->{id};
2896
2897 } elsif (ref $channel) {
2898 # send meta info to client, if not yet sent
2899 unless (exists $self->{channel}{$channel->{id}}) {
2900 $self->{channel}{$channel->{id}} = $channel;
2901 $self->ext_msg (channel_info => $channel);
2902 }
2903
2904 $channel = $channel->{id};
2905 }
2906
2907 return unless @extra || length $msg;
2908
2909 # default colour, mask it out
2910 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2911 if $color & cf::NDI_DEF;
2912
2913 my $pkt = "msg "
2914 . $self->{json_coder}->encode (
2915 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
2916 );
2917
2918 # try lzf for large packets
2919 $pkt = "lzf " . Compress::LZF::compress $pkt
2920 if 1024 <= length $pkt and $self->{can_lzf};
2921
2922 # split very large packets
2923 if (8192 < length $pkt and $self->{can_lzf}) {
2924 $self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
2925 $pkt = "frag";
2926 }
2927
2928 $self->send_packet ($pkt);
2929}
2930
2931=item $client->ext_msg ($type, @msg)
2932
2933Sends an ext event to the client.
2934
2935=cut
2936
2937sub cf::client::ext_msg($$@) {
2938 my ($self, $type, @msg) = @_;
2939
2940 if ($self->extcmd == 2) {
2941 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2942 } elsif ($self->extcmd == 1) { # TODO: remove
2943 push @msg, msgtype => "event_$type";
2944 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2945 }
2946}
2947
2948=item $client->ext_reply ($msgid, @msg)
2949
2950Sends an ext reply to the client.
2951
2952=cut
2953
2954sub cf::client::ext_reply($$@) {
2955 my ($self, $id, @msg) = @_;
2956
2957 if ($self->extcmd == 2) {
2958 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2959 } elsif ($self->extcmd == 1) {
2960 #TODO: version 1, remove
2961 unshift @msg, msgtype => "reply", msgid => $id;
2962 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2963 }
2964}
1956 2965
1957=item $success = $client->query ($flags, "text", \&cb) 2966=item $success = $client->query ($flags, "text", \&cb)
1958 2967
1959Queues a query to the client, calling the given callback with 2968Queues a query to the client, calling the given callback with
1960the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2969the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1961C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2970C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1962 2971
1963Queries can fail, so check the return code. Or don't, as queries will become 2972Queries can fail, so check the return code. Or don't, as queries will
1964reliable at some point in the future. 2973become reliable at some point in the future.
1965 2974
1966=cut 2975=cut
1967 2976
1968sub cf::client::query { 2977sub cf::client::query {
1969 my ($self, $flags, $text, $cb) = @_; 2978 my ($self, $flags, $text, $cb) = @_;
1977 utf8::encode $text; 2986 utf8::encode $text;
1978 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2987 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1979 2988
1980 $self->send_packet ($self->{query_queue}[0][0]) 2989 $self->send_packet ($self->{query_queue}[0][0])
1981 if @{ $self->{query_queue} } == 1; 2990 if @{ $self->{query_queue} } == 1;
2991
2992 1
1982} 2993}
1983 2994
1984cf::client->attach ( 2995cf::client->attach (
2996 on_connect => sub {
2997 my ($ns) = @_;
2998
2999 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3000 },
1985 on_reply => sub { 3001 on_reply => sub {
1986 my ($ns, $msg) = @_; 3002 my ($ns, $msg) = @_;
1987 3003
1988 # this weird shuffling is so that direct followup queries 3004 # this weird shuffling is so that direct followup queries
1989 # get handled first 3005 # get handled first
1990 my $queue = delete $ns->{query_queue} 3006 my $queue = delete $ns->{query_queue}
1991 or return; # be conservative, not sure how that can happen, but we saw a crash here 3007 or return; # be conservative, not sure how that can happen, but we saw a crash here
1992 3008
1993 (shift @$queue)->[1]->($msg); 3009 (shift @$queue)->[1]->($msg);
3010 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1994 3011
1995 push @{ $ns->{query_queue} }, @$queue; 3012 push @{ $ns->{query_queue} }, @$queue;
1996 3013
1997 if (@{ $ns->{query_queue} } == @$queue) { 3014 if (@{ $ns->{query_queue} } == @$queue) {
1998 if (@$queue) { 3015 if (@$queue) {
2000 } else { 3017 } else {
2001 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3018 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2002 } 3019 }
2003 } 3020 }
2004 }, 3021 },
3022 on_exticmd => sub {
3023 my ($ns, $buf) = @_;
3024
3025 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3026
3027 if (ref $msg) {
3028 my ($type, $reply, @payload) =
3029 "ARRAY" eq ref $msg
3030 ? @$msg
3031 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3032
3033 my @reply;
3034
3035 if (my $cb = $EXTICMD{$type}) {
3036 @reply = $cb->($ns, @payload);
3037 }
3038
3039 $ns->ext_reply ($reply, @reply)
3040 if $reply;
3041
3042 } else {
3043 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3044 }
3045
3046 cf::override;
3047 },
2005); 3048);
2006 3049
2007=item $client->async (\&cb) 3050=item $client->async (\&cb)
2008 3051
2009Create a new coroutine, running the specified callback. The coroutine will 3052Create a new coroutine, running the specified callback. The coroutine will
2050our $safe = new Safe "safe"; 3093our $safe = new Safe "safe";
2051our $safe_hole = new Safe::Hole; 3094our $safe_hole = new Safe::Hole;
2052 3095
2053$SIG{FPE} = 'IGNORE'; 3096$SIG{FPE} = 'IGNORE';
2054 3097
2055$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3098$safe->permit_only (Opcode::opset qw(
3099 :base_core :base_mem :base_orig :base_math
3100 grepstart grepwhile mapstart mapwhile
3101 sort time
3102));
2056 3103
2057# here we export the classes and methods available to script code 3104# here we export the classes and methods available to script code
2058 3105
2059=pod 3106=pod
2060 3107
2061The following fucntions and emthods are available within a safe environment: 3108The following functions and methods are available within a safe environment:
2062 3109
2063 cf::object contr pay_amount pay_player map 3110 cf::object
3111 contr pay_amount pay_player map x y force_find force_add destroy
3112 insert remove name archname title slaying race decrease split
3113 value
3114
2064 cf::object::player player 3115 cf::object::player
2065 cf::player peaceful 3116 player
2066 cf::map trigger 3117
3118 cf::player
3119 peaceful
3120
3121 cf::map
3122 trigger
2067 3123
2068=cut 3124=cut
2069 3125
2070for ( 3126for (
2071 ["cf::object" => qw(contr pay_amount pay_player map)], 3127 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3128 insert remove inv nrof name archname title slaying race
3129 decrease split destroy change_exp value msg lore send_msg)],
2072 ["cf::object::player" => qw(player)], 3130 ["cf::object::player" => qw(player)],
2073 ["cf::player" => qw(peaceful)], 3131 ["cf::player" => qw(peaceful send_msg)],
2074 ["cf::map" => qw(trigger)], 3132 ["cf::map" => qw(trigger)],
2075) { 3133) {
2076 no strict 'refs'; 3134 no strict 'refs';
2077 my ($pkg, @funs) = @$_; 3135 my ($pkg, @funs) = @$_;
2078 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3136 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2095 my ($code, %vars) = @_; 3153 my ($code, %vars) = @_;
2096 3154
2097 my $qcode = $code; 3155 my $qcode = $code;
2098 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3156 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2099 $qcode =~ s/\n/\\n/g; 3157 $qcode =~ s/\n/\\n/g;
3158
3159 %vars = (_dummy => 0) unless %vars;
2100 3160
2101 local $_; 3161 local $_;
2102 local @safe::cf::_safe_eval_args = values %vars; 3162 local @safe::cf::_safe_eval_args = values %vars;
2103 3163
2104 my $eval = 3164 my $eval =
2147=back 3207=back
2148 3208
2149=cut 3209=cut
2150 3210
2151############################################################################# 3211#############################################################################
3212# the server's init and main functions
2152 3213
2153=head2 EXTENSION DATABASE SUPPORT 3214sub load_facedata($) {
3215 my ($path) = @_;
2154 3216
2155Crossfire maintains a very simple database for extension use. It can 3217 # HACK to clear player env face cache, we need some signal framework
2156currently store anything that can be serialised using Storable, which 3218 # for this (global event?)
2157excludes objects. 3219 %ext::player_env::MUSIC_FACE_CACHE = ();
2158 3220
2159The parameter C<$family> should best start with the name of the extension 3221 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2160using it, it should be unique.
2161 3222
2162=over 4 3223 warn "loading facedata from $path\n";
2163 3224
2164=item $hashref = cf::db_get $family 3225 my $facedata;
3226 0 < aio_load $path, $facedata
3227 or die "$path: $!";
2165 3228
2166Return a hashref for use by the extension C<$family>, which can be 3229 $facedata = Coro::Storable::thaw $facedata;
2167modified. After modifications, you have to call C<cf::db_dirty> or
2168C<cf::db_sync>.
2169 3230
2170=item $value = cf::db_get $family => $key 3231 $facedata->{version} == 2
3232 or cf::cleanup "$path: version mismatch, cannot proceed.";
2171 3233
2172Returns a single value from the database 3234 # patch in the exptable
2173 3235 $facedata->{resource}{"res/exp_table"} = {
2174=item cf::db_put $family => $hashref 3236 type => FT_RSRC,
2175 3237 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2176Stores the given family hashref into the database. Updates are delayed, if
2177you want the data to be synced to disk immediately, use C<cf::db_sync>.
2178
2179=item cf::db_put $family => $key => $value
2180
2181Stores the given C<$value> in the family hash. Updates are delayed, if you
2182want the data to be synced to disk immediately, use C<cf::db_sync>.
2183
2184=item cf::db_dirty
2185
2186Marks the database as dirty, to be updated at a later time.
2187
2188=item cf::db_sync
2189
2190Immediately write the database to disk I<if it is dirty>.
2191
2192=cut
2193
2194our $DB;
2195
2196{
2197 my $path = cf::localdir . "/database.pst";
2198
2199 sub db_load() {
2200 $DB = stat $path ? Storable::retrieve $path : { };
2201 }
2202
2203 my $pid;
2204
2205 sub db_save() {
2206 waitpid $pid, 0 if $pid;
2207 if (0 == ($pid = fork)) {
2208 $DB->{_meta}{version} = 1;
2209 Storable::nstore $DB, "$path~";
2210 rename "$path~", $path;
2211 cf::_exit 0 if defined $pid;
2212 }
2213 }
2214
2215 my $dirty;
2216
2217 sub db_sync() {
2218 db_save if $dirty;
2219 undef $dirty;
2220 }
2221
2222 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2223 db_sync;
2224 }); 3238 };
3239 cf::cede_to_tick;
2225 3240
2226 sub db_dirty() {
2227 $dirty = 1;
2228 $idle->start;
2229 } 3241 {
3242 my $faces = $facedata->{faceinfo};
2230 3243
2231 sub db_get($;$) { 3244 while (my ($face, $info) = each %$faces) {
2232 @_ >= 2 3245 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2233 ? $DB->{$_[0]}{$_[1]}
2234 : ($DB->{$_[0]} ||= { })
2235 }
2236 3246
2237 sub db_put($$;$) { 3247 cf::face::set_visibility $idx, $info->{visibility};
2238 if (@_ >= 3) { 3248 cf::face::set_magicmap $idx, $info->{magicmap};
2239 $DB->{$_[0]}{$_[1]} = $_[2]; 3249 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2240 } else { 3250 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2241 $DB->{$_[0]} = $_[1];
2242 }
2243 db_dirty;
2244 }
2245 3251
2246 cf::global->attach ( 3252 cf::cede_to_tick;
2247 prio => 10000,
2248 on_cleanup => sub {
2249 db_sync;
2250 }, 3253 }
2251 );
2252}
2253 3254
2254############################################################################# 3255 while (my ($face, $info) = each %$faces) {
2255# the server's main() 3256 next unless $info->{smooth};
2256 3257
2257sub cfg_load { 3258 my $idx = cf::face::find $face
3259 or next;
3260
3261 if (my $smooth = cf::face::find $info->{smooth}) {
3262 cf::face::set_smooth $idx, $smooth;
3263 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3264 } else {
3265 warn "smooth face '$info->{smooth}' not found for face '$face'";
3266 }
3267
3268 cf::cede_to_tick;
3269 }
3270 }
3271
3272 {
3273 my $anims = $facedata->{animinfo};
3274
3275 while (my ($anim, $info) = each %$anims) {
3276 cf::anim::set $anim, $info->{frames}, $info->{facings};
3277 cf::cede_to_tick;
3278 }
3279
3280 cf::anim::invalidate_all; # d'oh
3281 }
3282
3283 {
3284 # TODO: for gcfclient pleasure, we should give resources
3285 # that gcfclient doesn't grok a >10000 face index.
3286 my $res = $facedata->{resource};
3287
3288 while (my ($name, $info) = each %$res) {
3289 if (defined $info->{type}) {
3290 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3291 my $data;
3292
3293 if ($info->{type} & 1) {
3294 # prepend meta info
3295
3296 my $meta = $enc->encode ({
3297 name => $name,
3298 %{ $info->{meta} || {} },
3299 });
3300
3301 $data = pack "(w/a*)*", $meta, $info->{data};
3302 } else {
3303 $data = $info->{data};
3304 }
3305
3306 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3307 cf::face::set_type $idx, $info->{type};
3308 } else {
3309 $RESOURCE{$name} = $info;
3310 }
3311
3312 cf::cede_to_tick;
3313 }
3314 }
3315
3316 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3317
3318 1
3319}
3320
3321cf::global->attach (on_resource_update => sub {
3322 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3323 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3324
3325 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3326 my $sound = $soundconf->{compat}[$_]
3327 or next;
3328
3329 my $face = cf::face::find "sound/$sound->[1]";
3330 cf::sound::set $sound->[0] => $face;
3331 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3332 }
3333
3334 while (my ($k, $v) = each %{$soundconf->{event}}) {
3335 my $face = cf::face::find "sound/$v";
3336 cf::sound::set $k => $face;
3337 }
3338 }
3339});
3340
3341register_exticmd fx_want => sub {
3342 my ($ns, $want) = @_;
3343
3344 while (my ($k, $v) = each %$want) {
3345 $ns->fx_want ($k, $v);
3346 }
3347};
3348
3349sub load_resource_file($) {
3350 my $guard = lock_acquire "load_resource_file";
3351
3352 my $status = load_resource_file_ $_[0];
3353 get_slot 0.1, 100;
3354 cf::arch::commit_load;
3355
3356 $status
3357}
3358
3359sub reload_regions {
3360 # HACK to clear player env face cache, we need some signal framework
3361 # for this (global event?)
3362 %ext::player_env::MUSIC_FACE_CACHE = ();
3363
3364 load_resource_file "$MAPDIR/regions"
3365 or die "unable to load regions file\n";
3366
3367 for (cf::region::list) {
3368 $_->{match} = qr/$_->{match}/
3369 if exists $_->{match};
3370 }
3371}
3372
3373sub reload_facedata {
3374 load_facedata "$DATADIR/facedata"
3375 or die "unable to load facedata\n";
3376}
3377
3378sub reload_archetypes {
3379 load_resource_file "$DATADIR/archetypes"
3380 or die "unable to load archetypes\n";
3381}
3382
3383sub reload_treasures {
3384 load_resource_file "$DATADIR/treasures"
3385 or die "unable to load treasurelists\n";
3386}
3387
3388sub reload_resources {
3389 warn "reloading resource files...\n";
3390
3391 reload_facedata;
3392 reload_archetypes;
3393 reload_regions;
3394 reload_treasures;
3395
3396 warn "finished reloading resource files\n";
3397}
3398
3399sub reload_config {
3400 warn "reloading config file...\n";
3401
2258 open my $fh, "<:utf8", cf::confdir . "/config" 3402 open my $fh, "<:utf8", "$CONFDIR/config"
2259 or return; 3403 or return;
2260 3404
2261 local $/; 3405 local $/;
2262 *CFG = YAML::Syck::Load <$fh>; 3406 *CFG = YAML::XS::Load scalar <$fh>;
2263 3407
2264 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3408 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2265 3409
2266 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3410 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2267 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3411 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2271 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3415 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2272 and die "WARNING: m(un)lockall failed: $!\n"; 3416 and die "WARNING: m(un)lockall failed: $!\n";
2273 }; 3417 };
2274 warn $@ if $@; 3418 warn $@ if $@;
2275 } 3419 }
3420
3421 warn "finished reloading resource files\n";
3422}
3423
3424sub pidfile() {
3425 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3426 or die "$PIDFILE: $!";
3427 flock $fh, &Fcntl::LOCK_EX
3428 or die "$PIDFILE: flock: $!";
3429 $fh
3430}
3431
3432# make sure only one server instance is running at any one time
3433sub atomic {
3434 my $fh = pidfile;
3435
3436 my $pid = <$fh>;
3437 kill 9, $pid if $pid > 0;
3438
3439 seek $fh, 0, 0;
3440 print $fh $$;
3441}
3442
3443sub main_loop {
3444 warn "EV::loop starting\n";
3445 if (1) {
3446 EV::loop;
3447 }
3448 warn "EV::loop returned\n";
3449 goto &main_loop unless $REALLY_UNLOOP;
2276} 3450}
2277 3451
2278sub main { 3452sub main {
3453 cf::init_globals; # initialise logging
3454
3455 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3456 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3457 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3458 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3459
3460 cf::init_experience;
3461 cf::init_anim;
3462 cf::init_attackmess;
3463 cf::init_dynamic;
3464
3465 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3466
2279 # we must not ever block the main coroutine 3467 # we must not ever block the main coroutine
2280 local $Coro::idle = sub { 3468 local $Coro::idle = sub {
2281 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3469 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2282 async { Event::one_event }; 3470 (async {
3471 $Coro::current->{desc} = "IDLE BUG HANDLER";
3472 EV::loop EV::LOOP_ONESHOT;
3473 })->prio (Coro::PRIO_MAX);
2283 }; 3474 };
2284 3475
2285 cfg_load; 3476 evthread_start IO::AIO::poll_fileno;
2286 db_load; 3477
3478 cf::sync_job {
3479 reload_resources;
3480 reload_config;
3481 db_init;
3482
3483 cf::load_settings;
3484 cf::load_materials;
3485 cf::init_uuid;
3486 cf::init_signals;
3487 cf::init_commands;
3488 cf::init_skills;
3489
3490 cf::init_beforeplay;
3491
3492 atomic;
3493
2287 load_extensions; 3494 load_extensions;
2288 Event::loop; 3495
3496 utime time, time, $RUNTIMEFILE;
3497
3498 # no (long-running) fork's whatsoever before this point(!)
3499 use POSIX ();
3500 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3501
3502 (pop @POST_INIT)->(0) while @POST_INIT;
3503 };
3504
3505 main_loop;
2289} 3506}
2290 3507
2291############################################################################# 3508#############################################################################
2292# initialisation and cleanup 3509# initialisation and cleanup
2293 3510
2294# install some emergency cleanup handlers 3511# install some emergency cleanup handlers
2295BEGIN { 3512BEGIN {
3513 our %SIGWATCHER = ();
2296 for my $signal (qw(INT HUP TERM)) { 3514 for my $signal (qw(INT HUP TERM)) {
2297 Event->signal ( 3515 $SIGWATCHER{$signal} = EV::signal $signal, sub {
2298 data => WF_AUTOCANCEL,
2299 signal => $signal,
2300 cb => sub {
2301 cf::cleanup "SIG$signal"; 3516 cf::cleanup "SIG$signal";
2302 },
2303 ); 3517 };
3518 }
3519}
3520
3521sub write_runtime_sync {
3522 # first touch the runtime file to show we are still running:
3523 # the fsync below can take a very very long time.
3524
3525 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3526
3527 my $guard = cf::lock_acquire "write_runtime";
3528
3529 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3530 or return;
3531
3532 my $value = $cf::RUNTIME + 90 + 10;
3533 # 10 is the runtime save interval, for a monotonic clock
3534 # 60 allows for the watchdog to kill the server.
3535
3536 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3537 and return;
3538
3539 # always fsync - this file is important
3540 aio_fsync $fh
3541 and return;
3542
3543 # touch it again to show we are up-to-date
3544 aio_utime $fh, undef, undef;
3545
3546 close $fh
3547 or return;
3548
3549 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3550 and return;
3551
3552 warn "runtime file written.\n";
3553
2304 } 3554 1
3555}
3556
3557our $uuid_lock;
3558our $uuid_skip;
3559
3560sub write_uuid_sync($) {
3561 $uuid_skip ||= $_[0];
3562
3563 return if $uuid_lock;
3564 local $uuid_lock = 1;
3565
3566 my $uuid = "$LOCALDIR/uuid";
3567
3568 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3569 or return;
3570
3571 my $value = uuid_seq uuid_cur;
3572
3573 unless ($value) {
3574 warn "cowardly refusing to write zero uuid value!\n";
3575 return;
3576 }
3577
3578 my $value = uuid_str $value + $uuid_skip;
3579 $uuid_skip = 0;
3580
3581 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3582 and return;
3583
3584 # always fsync - this file is important
3585 aio_fsync $fh
3586 and return;
3587
3588 close $fh
3589 or return;
3590
3591 aio_rename "$uuid~", $uuid
3592 and return;
3593
3594 warn "uuid file written ($value).\n";
3595
3596 1
3597
3598}
3599
3600sub write_uuid($$) {
3601 my ($skip, $sync) = @_;
3602
3603 $sync ? write_uuid_sync $skip
3604 : async { write_uuid_sync $skip };
2305} 3605}
2306 3606
2307sub emergency_save() { 3607sub emergency_save() {
2308 my $freeze_guard = cf::freeze_mainloop; 3608 my $freeze_guard = cf::freeze_mainloop;
2309 3609
2310 warn "enter emergency perl save\n"; 3610 warn "emergency_perl_save: enter\n";
2311 3611
2312 cf::sync_job { 3612 cf::sync_job {
3613 # this is a trade-off: we want to be very quick here, so
3614 # save all maps without fsync, and later call a global sync
3615 # (which in turn might be very very slow)
3616 local $USE_FSYNC = 0;
3617
2313 # use a peculiar iteration method to avoid tripping on perl 3618 # use a peculiar iteration method to avoid tripping on perl
2314 # refcount bugs in for. also avoids problems with players 3619 # refcount bugs in for. also avoids problems with players
2315 # and maps saved/Destroyed asynchronously. 3620 # and maps saved/destroyed asynchronously.
2316 warn "begin emergency player save\n"; 3621 warn "emergency_perl_save: begin player save\n";
2317 for my $login (keys %cf::PLAYER) { 3622 for my $login (keys %cf::PLAYER) {
2318 my $pl = $cf::PLAYER{$login} or next; 3623 my $pl = $cf::PLAYER{$login} or next;
2319 $pl->valid or next; 3624 $pl->valid or next;
3625 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2320 $pl->save; 3626 $pl->save;
2321 } 3627 }
2322 warn "end emergency player save\n"; 3628 warn "emergency_perl_save: end player save\n";
2323 3629
2324 warn "begin emergency map save\n"; 3630 warn "emergency_perl_save: begin map save\n";
2325 for my $path (keys %cf::MAP) { 3631 for my $path (keys %cf::MAP) {
2326 my $map = $cf::MAP{$path} or next; 3632 my $map = $cf::MAP{$path} or next;
2327 $map->valid or next; 3633 $map->valid or next;
2328 $map->save; 3634 $map->save;
2329 } 3635 }
2330 warn "end emergency map save\n"; 3636 warn "emergency_perl_save: end map save\n";
3637
3638 warn "emergency_perl_save: begin database checkpoint\n";
3639 BDB::db_env_txn_checkpoint $DB_ENV;
3640 warn "emergency_perl_save: end database checkpoint\n";
3641
3642 warn "emergency_perl_save: begin write uuid\n";
3643 write_uuid_sync 1;
3644 warn "emergency_perl_save: end write uuid\n";
2331 }; 3645 };
2332 3646
3647 warn "emergency_perl_save: starting sync()\n";
3648 IO::AIO::aio_sync sub {
3649 warn "emergency_perl_save: finished sync()\n";
3650 };
3651
2333 warn "leave emergency perl save\n"; 3652 warn "emergency_perl_save: leave\n";
2334} 3653}
2335 3654
3655sub post_cleanup {
3656 my ($make_core) = @_;
3657
3658 warn Carp::longmess "post_cleanup backtrace"
3659 if $make_core;
3660
3661 my $fh = pidfile;
3662 unlink $PIDFILE if <$fh> == $$;
3663}
3664
3665# a safer delete_package, copied from Symbol
3666sub clear_package($) {
3667 my $pkg = shift;
3668
3669 # expand to full symbol table name if needed
3670 unless ($pkg =~ /^main::.*::$/) {
3671 $pkg = "main$pkg" if $pkg =~ /^::/;
3672 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3673 $pkg .= '::' unless $pkg =~ /::$/;
3674 }
3675
3676 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3677 my $stem_symtab = *{$stem}{HASH};
3678
3679 defined $stem_symtab and exists $stem_symtab->{$leaf}
3680 or return;
3681
3682 # clear all symbols
3683 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3684 for my $name (keys %$leaf_symtab) {
3685 _gv_clear *{"$pkg$name"};
3686# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3687 }
3688 warn "cleared package $pkg\n";#d#
3689}
3690
2336sub reload() { 3691sub do_reload_perl() {
2337 # can/must only be called in main 3692 # can/must only be called in main
2338 if ($Coro::current != $Coro::main) { 3693 if ($Coro::current != $Coro::main) {
2339 warn "can only reload from main coroutine\n"; 3694 warn "can only reload from main coroutine";
2340 return; 3695 return;
2341 } 3696 }
2342 3697
3698 return if $RELOAD++;
3699
3700 my $t1 = EV::time;
3701
3702 while ($RELOAD) {
2343 warn "reloading..."; 3703 warn "reloading...";
2344 3704
2345 my $guard = freeze_mainloop; 3705 warn "entering sync_job";
3706
3707 cf::sync_job {
3708 cf::write_runtime_sync; # external watchdog should not bark
2346 cf::emergency_save; 3709 cf::emergency_save;
3710 cf::write_runtime_sync; # external watchdog should not bark
2347 3711
2348 eval { 3712 warn "syncing database to disk";
3713 BDB::db_env_txn_checkpoint $DB_ENV;
3714
2349 # if anything goes wrong in here, we should simply crash as we already saved 3715 # if anything goes wrong in here, we should simply crash as we already saved
2350 3716
2351 # cancel all watchers 3717 warn "flushing outstanding aio requests";
2352 for (Event::all_watchers) { 3718 while (IO::AIO::nreqs || BDB::nreqs) {
2353 $_->cancel if $_->data & WF_AUTOCANCEL; 3719 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2354 }
2355
2356 # cancel all extension coros
2357 $_->cancel for values %EXT_CORO;
2358 %EXT_CORO = ();
2359
2360 # unload all extensions
2361 for (@exts) {
2362 warn "unloading <$_>";
2363 unload_extension $_;
2364 }
2365
2366 # unload all modules loaded from $LIBDIR
2367 while (my ($k, $v) = each %INC) {
2368 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2369
2370 warn "removing <$k>";
2371 delete $INC{$k};
2372
2373 $k =~ s/\.pm$//;
2374 $k =~ s/\//::/g;
2375
2376 if (my $cb = $k->can ("unload_module")) {
2377 $cb->();
2378 } 3720 }
2379 3721
2380 Symbol::delete_package $k; 3722 warn "cancelling all extension coros";
3723 $_->cancel for values %EXT_CORO;
3724 %EXT_CORO = ();
3725
3726 warn "removing commands";
3727 %COMMAND = ();
3728
3729 warn "removing ext/exti commands";
3730 %EXTCMD = ();
3731 %EXTICMD = ();
3732
3733 warn "unloading/nuking all extensions";
3734 for my $pkg (@EXTS) {
3735 warn "... unloading $pkg";
3736
3737 if (my $cb = $pkg->can ("unload")) {
3738 eval {
3739 $cb->($pkg);
3740 1
3741 } or warn "$pkg unloaded, but with errors: $@";
3742 }
3743
3744 warn "... clearing $pkg";
3745 clear_package $pkg;
2381 } 3746 }
2382 3747
2383 # sync database to disk 3748 warn "unloading all perl modules loaded from $LIBDIR";
2384 cf::db_sync; 3749 while (my ($k, $v) = each %INC) {
2385 IO::AIO::flush; 3750 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2386 3751
3752 warn "... unloading $k";
3753 delete $INC{$k};
3754
3755 $k =~ s/\.pm$//;
3756 $k =~ s/\//::/g;
3757
3758 if (my $cb = $k->can ("unload_module")) {
3759 $cb->();
3760 }
3761
3762 clear_package $k;
3763 }
3764
2387 # get rid of safe::, as good as possible 3765 warn "getting rid of safe::, as good as possible";
2388 Symbol::delete_package "safe::$_" 3766 clear_package "safe::$_"
2389 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3767 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2390 3768
2391 # remove register_script_function callbacks 3769 warn "unloading cf.pm \"a bit\"";
2392 # TODO
2393
2394 # unload cf.pm "a bit"
2395 delete $INC{"cf.pm"}; 3770 delete $INC{"cf.pm"};
3771 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2396 3772
2397 # don't, removes xs symbols, too, 3773 # don't, removes xs symbols, too,
2398 # and global variables created in xs 3774 # and global variables created in xs
2399 #Symbol::delete_package __PACKAGE__; 3775 #clear_package __PACKAGE__;
2400 3776
2401 # reload cf.pm 3777 warn "unload completed, starting to reload now";
3778
2402 warn "reloading cf.pm"; 3779 warn "reloading cf.pm";
2403 require cf; 3780 require cf;
2404 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3781 cf::_connect_to_perl_1;
2405 3782
2406 # load config and database again 3783 warn "loading config and database again";
2407 cf::cfg_load; 3784 cf::reload_config;
2408 cf::db_load;
2409 3785
2410 # load extensions
2411 warn "load extensions"; 3786 warn "loading extensions";
2412 cf::load_extensions; 3787 cf::load_extensions;
2413 3788
2414 # reattach attachments to objects 3789 if ($REATTACH_ON_RELOAD) {
2415 warn "reattach"; 3790 warn "reattaching attachments to objects/players";
2416 _global_reattach; 3791 _global_reattach; # objects, sockets
3792 warn "reattaching attachments to maps";
2417 reattach $_ for values %MAP; 3793 reattach $_ for values %MAP;
3794 warn "reattaching attachments to players";
3795 reattach $_ for values %PLAYER;
3796 }
3797
3798 warn "running post_init jobs";
3799 (pop @POST_INIT)->(1) while @POST_INIT;
3800
3801 warn "leaving sync_job";
3802
3803 1
3804 } or do {
3805 warn $@;
3806 cf::cleanup "error while reloading, exiting.";
3807 };
3808
3809 warn "reloaded";
3810 --$RELOAD;
3811 }
3812
3813 $t1 = EV::time - $t1;
3814 warn "reload completed in ${t1}s\n";
3815};
3816
3817our $RELOAD_WATCHER; # used only during reload
3818
3819sub reload_perl() {
3820 # doing reload synchronously and two reloads happen back-to-back,
3821 # coro crashes during coro_state_free->destroy here.
3822
3823 $RELOAD_WATCHER ||= cf::async {
3824 Coro::AIO::aio_wait cache_extensions;
3825
3826 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3827 do_reload_perl;
3828 undef $RELOAD_WATCHER;
3829 };
2418 }; 3830 };
2419
2420 if ($@) {
2421 warn $@;
2422 warn "error while reloading, exiting.";
2423 exit 1;
2424 }
2425
2426 warn "reloaded successfully";
2427};
2428
2429#############################################################################
2430
2431unless ($LINK_MAP) {
2432 $LINK_MAP = cf::map::new;
2433
2434 $LINK_MAP->width (41);
2435 $LINK_MAP->height (41);
2436 $LINK_MAP->alloc;
2437 $LINK_MAP->path ("{link}");
2438 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2439 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2440
2441 # dirty hack because... archetypes are not yet loaded
2442 Event->timer (
2443 after => 10,
2444 cb => sub {
2445 $_[0]->w->cancel;
2446
2447 # provide some exits "home"
2448 my $exit = cf::object::new "exit";
2449
2450 $exit->slaying ($EMERGENCY_POSITION->[0]);
2451 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2452 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2453
2454 $LINK_MAP->insert ($exit->clone, 19, 19);
2455 $LINK_MAP->insert ($exit->clone, 19, 20);
2456 $LINK_MAP->insert ($exit->clone, 19, 21);
2457 $LINK_MAP->insert ($exit->clone, 20, 19);
2458 $LINK_MAP->insert ($exit->clone, 20, 21);
2459 $LINK_MAP->insert ($exit->clone, 21, 19);
2460 $LINK_MAP->insert ($exit->clone, 21, 20);
2461 $LINK_MAP->insert ($exit->clone, 21, 21);
2462
2463 $exit->destroy;
2464 });
2465
2466 $LINK_MAP->{deny_save} = 1;
2467 $LINK_MAP->{deny_reset} = 1;
2468
2469 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2470} 3831}
2471
2472register "<global>", __PACKAGE__;
2473 3832
2474register_command "reload" => sub { 3833register_command "reload" => sub {
2475 my ($who, $arg) = @_; 3834 my ($who, $arg) = @_;
2476 3835
2477 if ($who->flag (FLAG_WIZ)) { 3836 if ($who->flag (FLAG_WIZ)) {
2478 $who->message ("start of reload.");
2479 reload;
2480 $who->message ("end of reload."); 3837 $who->message ("reloading server.");
3838 async {
3839 $Coro::current->{desc} = "perl_reload";
3840 reload_perl;
3841 };
2481 } 3842 }
2482}; 3843};
2483 3844
2484unshift @INC, $LIBDIR; 3845unshift @INC, $LIBDIR;
2485 3846
2486$TICK_WATCHER = Event->timer ( 3847my $bug_warning = 0;
2487 reentrant => 0, 3848
2488 prio => 0, 3849our @WAIT_FOR_TICK;
2489 at => $NEXT_TICK || $TICK, 3850our @WAIT_FOR_TICK_BEGIN;
2490 data => WF_AUTOCANCEL, 3851
2491 cb => sub { 3852sub wait_for_tick {
3853 return if tick_inhibit || $Coro::current == $Coro::main;
3854
3855 my $signal = new Coro::Signal;
3856 push @WAIT_FOR_TICK, $signal;
3857 $signal->wait;
3858}
3859
3860sub wait_for_tick_begin {
3861 return if tick_inhibit || $Coro::current == $Coro::main;
3862
3863 my $signal = new Coro::Signal;
3864 push @WAIT_FOR_TICK_BEGIN, $signal;
3865 $signal->wait;
3866}
3867
3868sub tick {
3869 if ($Coro::current != $Coro::main) {
3870 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3871 unless ++$bug_warning > 10;
3872 return;
3873 }
3874
2492 cf::server_tick; # one server iteration 3875 cf::server_tick; # one server iteration
2493 $RUNTIME += $TICK;
2494 $NEXT_TICK += $TICK;
2495 3876
2496 $WAIT_FOR_TICK->broadcast; 3877 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2497 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3878 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2498 3879 Coro::async_pool {
2499 # if we are delayed by four ticks or more, skip them all 3880 $Coro::current->{desc} = "runtime saver";
2500 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2501
2502 $TICK_WATCHER->at ($NEXT_TICK);
2503 $TICK_WATCHER->start;
2504 },
2505);
2506
2507IO::AIO::max_poll_time $TICK * 0.2;
2508
2509Event->io (
2510 fd => IO::AIO::poll_fileno,
2511 poll => 'r',
2512 prio => 5,
2513 data => WF_AUTOCANCEL,
2514 cb => \&IO::AIO::poll_cb,
2515);
2516
2517Event->timer (
2518 data => WF_AUTOCANCEL,
2519 after => 0,
2520 interval => 10,
2521 cb => sub {
2522 (Coro::unblock_sub {
2523 write_runtime 3881 write_runtime_sync
2524 or warn "ERROR: unable to write runtime file: $!"; 3882 or warn "ERROR: unable to write runtime file: $!";
2525 })->(); 3883 };
2526 }, 3884 }
2527); 3885
3886 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3887 $sig->send;
3888 }
3889 while (my $sig = shift @WAIT_FOR_TICK) {
3890 $sig->send;
3891 }
3892
3893 $LOAD = ($NOW - $TICK_START) / $TICK;
3894 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3895
3896 if (0) {
3897 if ($NEXT_TICK) {
3898 my $jitter = $TICK_START - $NEXT_TICK;
3899 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3900 warn "jitter $JITTER\n";#d#
3901 }
3902 }
3903}
3904
3905{
3906 # configure BDB
3907
3908 BDB::min_parallel 8;
3909 BDB::max_poll_reqs $TICK * 0.1;
3910 $AnyEvent::BDB::WATCHER->priority (1);
3911
3912 unless ($DB_ENV) {
3913 $DB_ENV = BDB::db_env_create;
3914 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3915 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3916 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3917 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3918 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3919
3920 cf::sync_job {
3921 eval {
3922 BDB::db_env_open
3923 $DB_ENV,
3924 $BDBDIR,
3925 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3926 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3927 0666;
3928
3929 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3930 };
3931
3932 cf::cleanup "db_env_open(db): $@" if $@;
3933 };
3934 }
3935
3936 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3937 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3938 };
3939 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3940 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3941 };
3942 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3943 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3944 };
3945}
3946
3947{
3948 # configure IO::AIO
3949
3950 IO::AIO::min_parallel 8;
3951 IO::AIO::max_poll_time $TICK * 0.1;
3952 undef $AnyEvent::AIO::WATCHER;
3953}
3954
3955my $_log_backtrace;
3956
3957sub _log_backtrace {
3958 my ($msg, @addr) = @_;
3959
3960 $msg =~ s/\n//;
3961
3962 # limit the # of concurrent backtraces
3963 if ($_log_backtrace < 2) {
3964 ++$_log_backtrace;
3965 my $perl_bt = Carp::longmess $msg;
3966 async {
3967 $Coro::current->{desc} = "abt $msg";
3968
3969 my @bt = fork_call {
3970 @addr = map { sprintf "%x", $_ } @addr;
3971 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3972 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3973 or die "addr2line: $!";
3974
3975 my @funcs;
3976 my @res = <$fh>;
3977 chomp for @res;
3978 while (@res) {
3979 my ($func, $line) = splice @res, 0, 2, ();
3980 push @funcs, "[$func] $line";
3981 }
3982
3983 @funcs
3984 };
3985
3986 LOG llevInfo, "[ABT] $perl_bt\n";
3987 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3988 LOG llevInfo, "[ABT] $_\n" for @bt;
3989 --$_log_backtrace;
3990 };
3991 } else {
3992 LOG llevInfo, "[ABT] $msg\n";
3993 LOG llevInfo, "[ABT] [suppressed]\n";
3994 }
3995}
3996
3997# load additional modules
3998require "cf/$_.pm" for @EXTRA_MODULES;
3999cf::_connect_to_perl_2;
2528 4000
2529END { cf::emergency_save } 4001END { cf::emergency_save }
2530 4002
25311 40031
2532 4004

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines