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.161 by root, Thu Jan 11 00:16:58 2007 UTC vs.
Revision 1.475 by root, Tue Jul 21 06:17:00 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines