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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines