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.165 by root, Fri Jan 12 22:09:22 2007 UTC vs.
Revision 1.502 by root, Sat Jan 23 20:24:50 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines