ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.165 by root, Fri Jan 12 22:09:22 2007 UTC vs.
Revision 1.474 by root, Thu Jul 16 21:42:56 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
478 $path
479}
480
481# the original (read-only) location
482sub load_path {
483 my ($self) = @_;
484
485 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
486}
487
488# the temporary/swap location
489sub save_path {
490 my ($self) = @_;
491
492 $self->{user_rel}
493 ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
494 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
495}
496
497# the unique path, undef == no special unique path
498sub uniq_path {
499 my ($self) = @_;
500
501 $self->{user_rel} || $self->{ext}
502 ? undef
503 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
504}
505
506sub customise_for {
507 my ($self, $map, $ob) = @_;
508
509 if ($map->per_player) {
510 return cf::map::find ("~" . $ob->name . "/" . $map->{path}{path});
511 }
512
513 $map
514}
515
516# this is somewhat ugly, but style maps do need special treatment
517sub is_style_map {
518 $_[0]{path} =~ m{^/styles/}
519}
520
521sub load_orig {
522 my ($self) = @_;
523
524 &cf::map::load_map_header ($self->load_path)
525}
526
527sub load_temp {
528 my ($self) = @_;
529
530 &cf::map::load_map_header ($self->save_path)
531}
532
533sub unlink_save {
534 my ($self) = @_;
535
536 utf8::encode (my $save = $self->save_path);
537 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;
538 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";
539}
540
541package cf;
542
543#############################################################################
544
545=head2 ATTACHABLE OBJECTS 738=head2 ATTACHABLE OBJECTS
546 739
547Many 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
548attach callbacks/event handlers (a collection of which is called an "attachment") 741attach callbacks/event handlers (a collection of which is called an "attachment")
549to it. All such attachable objects support the following methods. 742to it. All such attachable objects support the following methods.
550 743
551In 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>
552C<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
553crossfire+). 746Deliantra).
554 747
555=over 4 748=over 4
556 749
557=item $attachable->attach ($attachment, key => $value...) 750=item $attachable->attach ($attachment, key => $value...)
558 751
602=item cf::CLASS::attachment $name, ... 795=item cf::CLASS::attachment $name, ...
603 796
604Register an attachment by C<$name> through which attachable objects of the 797Register an attachment by C<$name> through which attachable objects of the
605given CLASS can refer to this attachment. 798given CLASS can refer to this attachment.
606 799
607Some classes such as crossfire maps and objects can specify attachments 800Some classes such as deliantra maps and objects can specify attachments
608that 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.
609 802
610These calls expect any number of the following handler/hook descriptions: 803These calls expect any number of the following handler/hook descriptions:
611 804
612=over 4 805=over 4
672our @CB_TYPE = (); # registry for type (cf-object class) based events 865our @CB_TYPE = (); # registry for type (cf-object class) based events
673our @CB_MAP = (); 866our @CB_MAP = ();
674 867
675my %attachment; 868my %attachment;
676 869
870sub cf::attachable::thawer_merge {
871 # simply override everything except _meta
872 local $_[0]{_meta};
873 %{$_[0]} = %{$_[1]};
874}
875
677sub _attach_cb($$$$) { 876sub _attach_cb($$$$) {
678 my ($registry, $event, $prio, $cb) = @_; 877 my ($registry, $event, $prio, $cb) = @_;
679 878
680 use sort 'stable'; 879 use sort 'stable';
681 880
715 $registry = $CB_TYPE[$object_type] ||= []; 914 $registry = $CB_TYPE[$object_type] ||= [];
716 915
717 } elsif ($type eq "subtype") { 916 } elsif ($type eq "subtype") {
718 defined $object_type or Carp::croak "subtype specified without type"; 917 defined $object_type or Carp::croak "subtype specified without type";
719 my $object_subtype = shift @arg; 918 my $object_subtype = shift @arg;
720 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 919 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
721 920
722 } elsif ($type eq "package") { 921 } elsif ($type eq "package") {
723 my $pkg = shift @arg; 922 my $pkg = shift @arg;
724 923
725 while (my ($name, $id) = each %cb_id) { 924 while (my ($name, $id) = each %cb_id) {
754 _attach $registry, $klass, @attach; 953 _attach $registry, $klass, @attach;
755 } 954 }
756 955
757 $obj->{$name} = \%arg; 956 $obj->{$name} = \%arg;
758 } else { 957 } else {
759 warn "object uses attachment '$name' that is not available, postponing.\n"; 958 warn "object uses attachment '$name' which is not available, postponing.\n";
760 } 959 }
761 960
762 $obj->{_attachment}{$name} = undef; 961 $obj->{_attachment}{$name} = undef;
763} 962}
764 963
766 if (ref $_[0]) { 965 if (ref $_[0]) {
767 _object_attach @_; 966 _object_attach @_;
768 } else { 967 } else {
769 _attach shift->_attach_registry, @_; 968 _attach shift->_attach_registry, @_;
770 } 969 }
970 _recalc_want;
771}; 971};
772 972
773# all those should be optimised 973# all those should be optimised
774sub cf::attachable::detach { 974sub cf::attachable::detach {
775 my ($obj, $name) = @_; 975 my ($obj, $name) = @_;
778 delete $obj->{_attachment}{$name}; 978 delete $obj->{_attachment}{$name};
779 reattach ($obj); 979 reattach ($obj);
780 } else { 980 } else {
781 Carp::croak "cannot, currently, detach class attachments"; 981 Carp::croak "cannot, currently, detach class attachments";
782 } 982 }
983 _recalc_want;
783}; 984};
784 985
785sub cf::attachable::attached { 986sub cf::attachable::attached {
786 my ($obj, $name) = @_; 987 my ($obj, $name) = @_;
787 988
802 "; 1003 ";
803 die if $@; 1004 die if $@;
804} 1005}
805 1006
806our $override; 1007our $override;
807our @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?
808 1009
809sub override { 1010sub override {
810 $override = 1; 1011 $override = 1;
811 @invoke_results = (); 1012 @INVOKE_RESULTS = (@_);
812} 1013}
813 1014
814sub do_invoke { 1015sub do_invoke {
815 my $event = shift; 1016 my $event = shift;
816 my $callbacks = shift; 1017 my $callbacks = shift;
817 1018
818 @invoke_results = (); 1019 @INVOKE_RESULTS = ();
819 1020
820 local $override; 1021 local $override;
821 1022
822 for (@$callbacks) { 1023 for (@$callbacks) {
823 eval { &{$_->[1]} }; 1024 eval { &{$_->[1]} };
832 } 1033 }
833 1034
834 0 1035 0
835} 1036}
836 1037
837=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1038=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
838 1039
839=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1040=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
840 1041
841Generate an object-specific event with the given arguments. 1042Generate an object-specific event with the given arguments.
842 1043
843This 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
844removed 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
845results (if you must, access C<@cf::invoke_results> directly). 1046results (if you must, access C<@cf::INVOKE_RESULTS> directly).
846 1047
847=back 1048=back
848 1049
849=cut 1050=cut
850 1051
851############################################################################# 1052#############################################################################
852# 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}
853 1096
854sub reattach { 1097sub reattach {
855 # basically do the same as instantiate, without calling instantiate 1098 # basically do the same as instantiate, without calling instantiate
856 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
857 1103
858 my $registry = $obj->registry; 1104 my $registry = $obj->registry;
859 1105
860 @$registry = (); 1106 @$registry = ();
861 1107
876cf::attachable->attach ( 1122cf::attachable->attach (
877 prio => -1000000, 1123 prio => -1000000,
878 on_instantiate => sub { 1124 on_instantiate => sub {
879 my ($obj, $data) = @_; 1125 my ($obj, $data) = @_;
880 1126
881 $data = from_json $data; 1127 $data = decode_json $data;
882 1128
883 for (@$data) { 1129 for (@$data) {
884 my ($name, $args) = @$_; 1130 my ($name, $args) = @$_;
885 1131
886 $obj->attach ($name, %{$args || {} }); 1132 $obj->attach ($name, %{$args || {} });
902sub object_freezer_save { 1148sub object_freezer_save {
903 my ($filename, $rdata, $objs) = @_; 1149 my ($filename, $rdata, $objs) = @_;
904 1150
905 sync_job { 1151 sync_job {
906 if (length $$rdata) { 1152 if (length $$rdata) {
1153 utf8::decode (my $decname = $filename);
907 warn sprintf "saving %s (%d,%d)\n", 1154 warn sprintf "saving %s (%d,%d)\n",
908 $filename, length $$rdata, scalar @$objs; 1155 $decname, length $$rdata, scalar @$objs;
909 1156
910 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1157 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
911 chmod SAVE_MODE, $fh; 1158 aio_chmod $fh, SAVE_MODE;
912 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;
913 aio_fsync $fh; 1162 aio_fsync $fh;
1163 }
914 close $fh; 1164 aio_close $fh;
915 1165
916 if (@$objs) { 1166 if (@$objs) {
917 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) {
918 chmod SAVE_MODE, $fh; 1168 aio_chmod $fh, SAVE_MODE;
919 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1169 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
920 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;
921 aio_fsync $fh; 1173 aio_fsync $fh;
1174 }
922 close $fh; 1175 aio_close $fh;
923 aio_rename "$filename.pst~", "$filename.pst"; 1176 aio_rename "$filename.pst~", "$filename.pst";
924 } 1177 }
925 } else { 1178 } else {
926 aio_unlink "$filename.pst"; 1179 aio_unlink "$filename.pst";
927 } 1180 }
928 1181
929 aio_rename "$filename~", $filename; 1182 aio_rename "$filename~", $filename;
1183
1184 $filename =~ s%/[^/]+$%%;
1185 aio_pathsync $filename if $cf::USE_FSYNC;
930 } else { 1186 } else {
931 warn "FATAL: $filename~: $!\n"; 1187 warn "unable to save objects: $filename~: $!\n";
932 } 1188 }
933 } else { 1189 } else {
934 aio_unlink $filename; 1190 aio_unlink $filename;
935 aio_unlink "$filename.pst"; 1191 aio_unlink "$filename.pst";
936 } 1192 }
937 } 1193 };
938} 1194}
939 1195
940sub object_freezer_as_string { 1196sub object_freezer_as_string {
941 my ($rdata, $objs) = @_; 1197 my ($rdata, $objs) = @_;
942 1198
954 or return; 1210 or return;
955 1211
956 unless (aio_stat "$filename.pst") { 1212 unless (aio_stat "$filename.pst") {
957 (aio_load "$filename.pst", $av) >= 0 1213 (aio_load "$filename.pst", $av) >= 0
958 or return; 1214 or return;
1215
959 $av = eval { (Storable::thaw $av)->{objs} }; 1216 my $st = eval { Coro::Storable::thaw $av };
1217 $av = $st->{objs};
960 } 1218 }
961 1219
1220 utf8::decode (my $decname = $filename);
962 warn sprintf "loading %s (%d)\n", 1221 warn sprintf "loading %s (%d,%d)\n",
963 $filename, length $data, scalar @{$av || []};#d# 1222 $decname, length $data, scalar @{$av || []};
1223
964 return ($data, $av); 1224 ($data, $av)
965} 1225}
1226
1227=head2 COMMAND CALLBACKS
1228
1229=over 4
1230
1231=cut
966 1232
967############################################################################# 1233#############################################################################
968# command handling &c 1234# command handling &c
969 1235
970=item cf::register_command $name => \&callback($ob,$args); 1236=item cf::register_command $name => \&callback($ob,$args);
983 push @{ $COMMAND{$name} }, [$caller, $cb]; 1249 push @{ $COMMAND{$name} }, [$caller, $cb];
984} 1250}
985 1251
986=item cf::register_extcmd $name => \&callback($pl,$packet); 1252=item cf::register_extcmd $name => \&callback($pl,$packet);
987 1253
988Register 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.
989 1259
990If 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
991called. 1261called.
992 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
993=cut 1274=cut
994 1275
995sub register_extcmd { 1276sub register_extcmd {
996 my ($name, $cb) = @_; 1277 my ($name, $cb) = @_;
997 1278
998 $EXTCMD{$name} = $cb; 1279 $EXTCMD{$name} = $cb;
999} 1280}
1281
1282sub register_exticmd {
1283 my ($name, $cb) = @_;
1284
1285 $EXTICMD{$name} = $cb;
1286}
1287
1288use File::Glob ();
1000 1289
1001cf::player->attach ( 1290cf::player->attach (
1002 on_command => sub { 1291 on_command => sub {
1003 my ($pl, $name, $params) = @_; 1292 my ($pl, $name, $params) = @_;
1004 1293
1012 cf::override; 1301 cf::override;
1013 }, 1302 },
1014 on_extcmd => sub { 1303 on_extcmd => sub {
1015 my ($pl, $buf) = @_; 1304 my ($pl, $buf) = @_;
1016 1305
1017 my $msg = eval { from_json $buf }; 1306 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
1018 1307
1019 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
1020 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1316 if (my $cb = $EXTCMD{$type}) {
1021 if (my %reply = $cb->($pl, $msg)) { 1317 @reply = $cb->($pl, @payload);
1022 $pl->ext_reply ($msg->{msgid}, %reply);
1023 }
1024 } 1318 }
1319
1320 $pl->ext_reply ($reply, @reply)
1321 if $reply;
1322
1025 } else { 1323 } else {
1026 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1324 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
1027 } 1325 }
1028 1326
1029 cf::override; 1327 cf::override;
1030 }, 1328 },
1031); 1329);
1032 1330
1331# "readahead" all extensions
1033sub load_extension { 1332sub cache_extensions {
1034 my ($path) = @_; 1333 my $grp = IO::AIO::aio_group;
1035 1334
1036 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1335 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
1037 my $base = $1; 1336 for (grep /\.ext$/, @{$_[0]}) {
1038 my $pkg = $1; 1337 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
1039 $pkg =~ s/[^[:word:]]/_/g; 1338 }
1040 $pkg = "ext::$pkg"; 1339 };
1041 1340
1042 warn "... loading '$path' into '$pkg'\n"; 1341 $grp
1043
1044 open my $fh, "<:utf8", $path
1045 or die "$path: $!";
1046
1047 my $source =
1048 "package $pkg; use strict; use utf8;\n"
1049 . "#line 1 \"$path\"\n{\n"
1050 . (do { local $/; <$fh> })
1051 . "\n};\n1";
1052
1053 eval $source
1054 or die $@ ? "$path: $@\n"
1055 : "extension disabled.\n";
1056
1057 push @EXTS, $pkg;
1058} 1342}
1059 1343
1060sub load_extensions { 1344sub load_extensions {
1345 cf::sync_job {
1346 my %todo;
1347
1061 for my $ext (<$LIBDIR/*.ext>) { 1348 for my $path (<$LIBDIR/*.ext>) {
1062 next unless -r $ext; 1349 next unless -r $path;
1063 eval { 1350
1064 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;
1065 1 1407 }
1066 } or warn "$ext not loaded: $@"; 1408
1409 skip:
1410 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1411 unless $progress;
1412 }
1067 } 1413 };
1068} 1414}
1069 1415
1070############################################################################# 1416#############################################################################
1071# load/save/clean perl data associated with a map
1072 1417
1073*cf::mapsupport::on_clean = sub { 1418=back
1074 my ($map) = @_;
1075
1076 my $path = $map->tmpname;
1077 defined $path or return;
1078
1079 unlink "$path.pst";
1080};
1081
1082cf::map->attach (prio => -10000, package => cf::mapsupport::);
1083
1084#############################################################################
1085 1419
1086=head2 CORE EXTENSIONS 1420=head2 CORE EXTENSIONS
1087 1421
1088Functions and methods that extend core crossfire objects. 1422Functions and methods that extend core deliantra objects.
1089 1423
1090=cut 1424=cut
1091 1425
1092package cf::player; 1426package cf::player;
1093 1427
1095 1429
1096=head3 cf::player 1430=head3 cf::player
1097 1431
1098=over 4 1432=over 4
1099 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
1100=item cf::player::find $login 1448=item cf::player::find $login
1101 1449
1102Returns the given player object, loading it if necessary (might block). 1450Returns the given player object, loading it if necessary (might block).
1103 1451
1104=cut 1452=cut
1105 1453
1106sub playerdir($) { 1454sub playerdir($) {
1107 cf::localdir 1455 "$PLAYERDIR/"
1108 . "/"
1109 . cf::playerdir
1110 . "/"
1111 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1456 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1112} 1457}
1113 1458
1114sub path($) { 1459sub path($) {
1115 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1460 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1116 1461
1117 (playerdir $login) . "/$login.pl" 1462 (playerdir $login) . "/playerdata"
1118} 1463}
1119 1464
1120sub find_active($) { 1465sub find_active($) {
1121 $cf::PLAYER{$_[0]} 1466 $cf::PLAYER{$_[0]}
1122 and $cf::PLAYER{$_[0]}->active 1467 and $cf::PLAYER{$_[0]}->active
1125 1470
1126sub exists($) { 1471sub exists($) {
1127 my ($login) = @_; 1472 my ($login) = @_;
1128 1473
1129 $cf::PLAYER{$login} 1474 $cf::PLAYER{$login}
1130 or cf::sync_job { !aio_stat $login } 1475 or !aio_stat path $login
1131} 1476}
1132 1477
1133sub find($) { 1478sub find($) {
1134 return $cf::PLAYER{$_[0]} || do { 1479 return $cf::PLAYER{$_[0]} || do {
1135 my $login = $_[0]; 1480 my $login = $_[0];
1136 1481
1137 my $guard = cf::lock_acquire "user_find:$login"; 1482 my $guard = cf::lock_acquire "user_find:$login";
1138 1483
1139 $cf::PLAYER{$_[0]} || do { 1484 $cf::PLAYER{$_[0]} || do {
1140 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
1141 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;
1142 $cf::PLAYER{$login} = $pl 1500 $cf::PLAYER{$login} = $pl
1143 } 1501 }
1144 } 1502 }
1145} 1503}
1146 1504
1155 return if $pl->{deny_save}; 1513 return if $pl->{deny_save};
1156 1514
1157 aio_mkdir playerdir $pl, 0770; 1515 aio_mkdir playerdir $pl, 0770;
1158 $pl->{last_save} = $cf::RUNTIME; 1516 $pl->{last_save} = $cf::RUNTIME;
1159 1517
1518 cf::get_slot 0.01;
1519
1160 $pl->save_pl ($path); 1520 $pl->save_pl ($path);
1161 Coro::cede; 1521 cf::cede_to_tick;
1162} 1522}
1163 1523
1164sub new($) { 1524sub new($) {
1165 my ($login) = @_; 1525 my ($login) = @_;
1166 1526
1172 $cf::PLAYER{$login} = $self; 1532 $cf::PLAYER{$login} = $self;
1173 1533
1174 $self 1534 $self
1175} 1535}
1176 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
1177=item $pl->quit_character 1547=item $pl->quit_character
1178 1548
1179Nukes the player without looking back. If logged in, the connection will 1549Nukes the player without looking back. If logged in, the connection will
1180be destroyed. May block for a long time. 1550be destroyed. May block for a long time.
1181 1551
1182=cut 1552=cut
1183 1553
1184sub quit_character { 1554sub quit_character {
1185 my ($pl) = @_; 1555 my ($pl) = @_;
1186 1556
1557 my $name = $pl->ob->name;
1558
1187 $pl->{deny_save} = 1; 1559 $pl->{deny_save} = 1;
1188 $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
1189 1561
1190 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1562 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1191 $pl->deactivate; 1563 $pl->deactivate;
1564 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1565 $pl->ob->check_score;
1192 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1566 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1193 $pl->ns->destroy if $pl->ns; 1567 $pl->ns->destroy if $pl->ns;
1194 1568
1195 my $path = playerdir $pl; 1569 my $path = playerdir $pl;
1196 my $temp = "$path~$cf::RUNTIME~deleting~"; 1570 my $temp = "$path~$cf::RUNTIME~deleting~";
1197 aio_rename $path, $temp; 1571 aio_rename $path, $temp;
1198 delete $cf::PLAYER{$pl->ob->name}; 1572 delete $cf::PLAYER{$pl->ob->name};
1199 $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
1200 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;
1201} 1595}
1202 1596
1203=item cf::player::list_logins 1597=item cf::player::list_logins
1204 1598
1205Returns 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
1206while and may block, so not sync_job-capable, ever. 1600while and may block, so not sync_job-capable, ever.
1207 1601
1208=cut 1602=cut
1209 1603
1210sub list_logins { 1604sub list_logins {
1211 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1605 my $dirs = aio_readdir $PLAYERDIR
1212 or return []; 1606 or return [];
1213 1607
1214 my @logins; 1608 my @logins;
1215 1609
1216 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") {
1217 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1616 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1218 aio_read $fh, 0, 512, my $buf, 0 or next; 1617 aio_read $fh, 0, 512, my $buf, 0 or next;
1219 $buf !~ /^password -------------$/m or next; # official not-valid tag 1618 $buf !~ /^password -------------$/m or next; # official not-valid tag
1619 }
1220 1620
1221 utf8::decode $login; 1621 utf8::decode $login;
1222 push @logins, $login; 1622 push @logins, $login;
1223 } 1623 }
1224 1624
1225 \@logins 1625 \@logins
1226} 1626}
1227 1627
1228=item $player->maps 1628=item $player->maps
1229 1629
1230Returns 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
1231player. May block. 1631player. May block.
1232 1632
1233=cut 1633=cut
1234 1634
1235sub maps($) { 1635sub maps($) {
1236 my ($pl) = @_; 1636 my ($pl) = @_;
1637
1638 $pl = ref $pl ? $pl->ob->name : $pl;
1237 1639
1238 my $files = aio_readdir playerdir $pl 1640 my $files = aio_readdir playerdir $pl
1239 or return; 1641 or return;
1240 1642
1241 my @paths; 1643 my @paths;
1243 for (@$files) { 1645 for (@$files) {
1244 utf8::decode $_; 1646 utf8::decode $_;
1245 next if /\.(?:pl|pst)$/; 1647 next if /\.(?:pl|pst)$/;
1246 next unless /^$PATH_SEP/o; 1648 next unless /^$PATH_SEP/o;
1247 1649
1248 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_; 1650 push @paths, cf::map::normalise "~$pl/$_";
1249 } 1651 }
1250 1652
1251 \@paths 1653 \@paths
1252} 1654}
1253 1655
1656=item $protocol_xml = $player->expand_cfpod ($cfpod)
1657
1658Expand deliantra pod fragments into protocol xml.
1659
1254=item $player->ext_reply ($msgid, $msgtype, %msg) 1660=item $player->ext_reply ($msgid, @msg)
1255 1661
1256Sends an ext reply to the player. 1662Sends an ext reply to the player.
1257 1663
1258=cut 1664=cut
1259 1665
1260sub ext_reply($$$%) { 1666sub ext_reply($$@) {
1261 my ($self, $id, %msg) = @_; 1667 my ($self, $id, @msg) = @_;
1262 1668
1263 $msg{msgid} = $id; 1669 $self->ns->ext_reply ($id, @msg)
1264
1265 $self->send ("ext " . cf::to_json \%msg);
1266} 1670}
1267 1671
1268package 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}
1269 1712
1270=back 1713=back
1271
1272 1714
1273=head3 cf::map 1715=head3 cf::map
1274 1716
1275=over 4 1717=over 4
1276 1718
1279package cf::map; 1721package cf::map;
1280 1722
1281use Fcntl; 1723use Fcntl;
1282use Coro::AIO; 1724use Coro::AIO;
1283 1725
1726use overload
1727 '""' => \&as_string,
1728 fallback => 1;
1729
1284our $MAX_RESET = 3600; 1730our $MAX_RESET = 3600;
1285our $DEFAULT_RESET = 3000; 1731our $DEFAULT_RESET = 3000;
1286 1732
1287sub generate_random_map { 1733sub generate_random_map {
1288 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
1289 1737
1290 # mit "rum" bekleckern, nicht 1738 # mit "rum" bekleckern, nicht
1291 cf::map::_create_random_map ( 1739 $self->_create_random_map (
1292 $path,
1293 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1740 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1294 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1741 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1295 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1742 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1296 $rmp->{exit_on_final_map}, 1743 $rmp->{exit_on_final_map},
1297 $rmp->{xsize}, $rmp->{ysize}, 1744 $rmp->{xsize}, $rmp->{ysize},
1302 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1749 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1303 (cf::region::find $rmp->{region}), $rmp->{custom} 1750 (cf::region::find $rmp->{region}), $rmp->{custom}
1304 ) 1751 )
1305} 1752}
1306 1753
1307# and all this just because we cannot iterate over 1754=item cf::map->register ($regex, $prio)
1308# all maps in C++...
1309sub change_all_map_light {
1310 my ($change) = @_;
1311 1755
1312 $_->change_map_light ($change) 1756Register a handler for the map path matching the given regex at the
1313 for grep $_->outdoor, values %cf::MAP; 1757givne priority (higher is better, built-in handlers have priority 0, the
1314} 1758default).
1315 1759
1316sub 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 {
1317 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) = @_;
1318 1899
1319 utf8::encode $path; 1900 utf8::encode $path;
1320 aio_open $path, O_RDONLY, 0 1901 my $f = new_from_file cf::object::thawer $path
1321 or return; 1902 or return;
1322 1903
1323 my $map = cf::map::new 1904 $self->_load_header ($f)
1324 or return; 1905 or return;
1325 1906
1326 # for better error messages only, will be overwritten later 1907 local $MAP_LOADING{$self->{path}} = $self;
1327 $map->path ($path); 1908 $f->resolve_delayed_derefs;
1328 1909
1329 $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
1330 or return; 1953 or return;
1954 $self->prepare_orig;
1955 }
1331 1956
1332 $map->{load_path} = $path; 1957 $self->{deny_reset} = 1
1958 if $self->no_reset;
1333 1959
1334 $map 1960 $self->default_region (cf::region::find_by_path $self->{path})
1961 unless $self->default_region;
1962
1963 1
1335} 1964}
1336 1965
1337sub find; 1966sub find;
1338sub find { 1967sub find {
1339 my ($path, $origin) = @_; 1968 my ($path, $origin) = @_;
1340 1969
1341 #warn "find<$path,$origin>\n";#d#
1342
1343 $path = new cf::path $path, $origin && $origin->path; 1970 $path = normalise $path, $origin && $origin->path;
1344 my $key = $path->as_string;
1345 1971
1346 cf::lock_wait "map_find:$key"; 1972 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1347
1348 $cf::MAP{$key} || do {
1349 my $guard = cf::lock_acquire "map_find:$key"; 1973 my $guard2 = cf::lock_acquire "map_find:$path";
1350 1974
1351 # do it the slow way 1975 $cf::MAP{$path} || do {
1352 my $map = $path->load_temp; 1976 my $map = new_from_path cf::map $path
1353
1354 Coro::cede;
1355
1356 if ($map) {
1357 $map->last_access ((delete $map->{last_access})
1358 || $cf::RUNTIME); #d#
1359 # safety
1360 $map->{instantiate_time} = $cf::RUNTIME
1361 if $map->{instantiate_time} > $cf::RUNTIME;
1362 } else {
1363 $map = $path->load_orig
1364 or return; 1977 or return;
1365 1978
1366 $map->{load_original} = 1;
1367 $map->{instantiate_time} = $cf::RUNTIME;
1368 $map->last_access ($cf::RUNTIME);
1369 $map->instantiate;
1370
1371 # per-player maps become, after loading, normal maps
1372 $map->per_player (0) if $path->{user_rel};
1373 }
1374
1375 $map->path ($key);
1376 $map->{path} = $path;
1377 $map->{last_save} = $cf::RUNTIME; 1979 $map->{last_save} = $cf::RUNTIME;
1378 1980
1379 Coro::cede; 1981 $map->load_header
1982 or return;
1380 1983
1381 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;
1382 $map->reset; 1989 $map->reset;
1383 undef $guard;
1384 $map = find $path 1990 return find $path;
1385 or return;
1386 } 1991 }
1387 1992
1388 $cf::MAP{$key} = $map 1993 $cf::MAP{$path} = $map
1389 } 1994 }
1390} 1995}
1996
1997sub pre_load { }
1998sub post_load { }
1391 1999
1392sub load { 2000sub load {
1393 my ($self) = @_; 2001 my ($self) = @_;
1394 2002
2003 local $self->{deny_reset} = 1; # loading can take a long time
2004
1395 my $path = $self->{path}; 2005 my $path = $self->{path};
2006
2007 {
1396 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 2008 my $guard = cf::lock_acquire "map_data:$path";
1397 2009
2010 return unless $self->valid;
1398 return if $self->in_memory != cf::MAP_SWAPPED; 2011 return unless $self->in_memory == cf::MAP_SWAPPED;
1399 2012
1400 $self->in_memory (cf::MAP_LOADING); 2013 $self->in_memory (cf::MAP_LOADING);
1401 2014
1402 $self->alloc; 2015 $self->alloc;
1403 $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)
1404 or return; 2023 or return;
1405 2024
1406 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2025 $self->post_load_original
1407 if delete $self->{load_original}; 2026 if delete $self->{load_original};
1408 2027
1409 if (my $uniq = $path->uniq_path) { 2028 if (my $uniq = $self->uniq_path) {
1410 utf8::encode $uniq; 2029 utf8::encode $uniq;
1411 if (aio_open $uniq, O_RDONLY, 0) { 2030 unless (aio_stat $uniq) {
2031 if (my $f = new_from_file cf::object::thawer $uniq) {
1412 $self->clear_unique_items; 2032 $self->clear_unique_items;
1413 $self->load_objects ($uniq, 0); 2033 $self->_load_objects ($f);
2034 $f->resolve_delayed_derefs;
2035 }
1414 } 2036 }
1415 } 2037 }
1416 2038
1417 Coro::cede; 2039 $f->resolve_delayed_derefs;
1418 2040
2041 cf::cede_to_tick;
1419 # now do the right thing for maps 2042 # now do the right thing for maps
1420 $self->link_multipart_objects; 2043 $self->link_multipart_objects;
1421
1422 if ($self->{path}->is_style_map) {
1423 $self->{deny_save} = 1;
1424 $self->{deny_reset} = 1;
1425 } else {
1426 $self->decay_objects;
1427 $self->fix_auto_apply;
1428 $self->update_buttons;
1429 $self->set_darkness_map;
1430 $self->difficulty ($self->estimate_difficulty) 2044 $self->difficulty ($self->estimate_difficulty)
1431 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;
1432 $self->activate; 2053 $self->activate;
1433 } 2054 }
1434 2055
1435 Coro::cede; 2056 $self->{last_save} = $cf::RUNTIME;
2057 $self->last_access ($cf::RUNTIME);
1436 2058
1437 $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
1438} 2075}
1439 2076
1440# 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
1441sub load_diag { 2078sub load_neighbours {
1442 my ($map) = @_; 2079 my ($map) = @_;
1443 2080
1444 my @diag; # diagonal neighbours 2081 my @neigh; # diagonal neighbours
1445 2082
1446 for (0 .. 3) { 2083 for (0 .. 3) {
1447 my $neigh = $map->tile_path ($_) 2084 my $neigh = $map->tile_path ($_)
1448 or next; 2085 or next;
1449 $neigh = find $neigh, $map 2086 $neigh = find $neigh, $map
1450 or next; 2087 or next;
1451 $neigh->load; 2088 $neigh->load;
1452 2089
2090 push @neigh,
1453 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2091 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1454 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2092 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1455 } 2093 }
1456 2094
1457 for (@diag) { 2095 for (grep defined $_->[0], @neigh) {
2096 my ($path, $origin) = @$_;
1458 my $neigh = find @$_ 2097 my $neigh = find $path, $origin
1459 or next; 2098 or next;
1460 $neigh->load; 2099 $neigh->load;
1461 } 2100 }
1462} 2101}
1463 2102
1468} 2107}
1469 2108
1470sub do_load_sync { 2109sub do_load_sync {
1471 my ($map) = @_; 2110 my ($map) = @_;
1472 2111
2112 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2113 if $Coro::current == $Coro::main;
2114
1473 cf::sync_job { $map->load }; 2115 cf::sync_job { $map->load };
1474} 2116}
1475 2117
1476our %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
1477our $MAP_PREFETCHER = Coro::async { 2132 $MAP_PREFETCHER ||= cf::async {
1478 while () { 2133 $Coro::current->{desc} = "map prefetcher";
2134
1479 while (%MAP_PREFETCH) { 2135 while (%MAP_PREFETCH) {
1480 my $key = each %MAP_PREFETCH 2136 while (my ($k, $v) = each %MAP_PREFETCH) {
1481 or next; 2137 if (my $map = find $k) {
2138 $map->load if $v;
2139 }
2140
1482 my $path = delete $MAP_PREFETCH{$key}; 2141 delete $MAP_PREFETCH{$k};
1483
1484 my $map = find $path
1485 or next;
1486 $map->load;
1487 } 2142 }
1488 Coro::schedule; 2143 }
2144 undef $MAP_PREFETCHER;
1489 } 2145 };
1490};
1491
1492sub find_async {
1493 my ($path, $origin) = @_;
1494
1495 $path = new cf::path $path, $origin && $origin->path;
1496 my $key = $path->as_string;
1497
1498 if (my $map = $cf::MAP{$key}) {
1499 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1500 }
1501
1502 $MAP_PREFETCH{$key} = $path;
1503 $MAP_PREFETCHER->ready; 2146 $MAP_PREFETCHER->prio (6);
1504 2147
1505 () 2148 ()
1506} 2149}
1507 2150
1508sub save { 2151sub save {
1509 my ($self) = @_; 2152 my ($self) = @_;
1510 2153
1511 my $lock = cf::lock_acquire "map_data:" . $self->path; 2154 my $lock = cf::lock_acquire "map_data:$self->{path}";
1512 2155
1513 $self->{last_save} = $cf::RUNTIME; 2156 $self->{last_save} = $cf::RUNTIME;
1514 2157
1515 return unless $self->dirty; 2158 return unless $self->dirty;
1516 2159
1517 my $save = $self->{path}->save_path; utf8::encode $save; 2160 my $save = $self->save_path; utf8::encode $save;
1518 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2161 my $uniq = $self->uniq_path; utf8::encode $uniq;
1519 2162
1520 $self->{load_path} = $save; 2163 $self->{load_path} = $save;
1521 2164
1522 return if $self->{deny_save}; 2165 return if $self->{deny_save};
1523 2166
1524 local $self->{last_access} = $self->last_access;#d# 2167 local $self->{last_access} = $self->last_access;#d#
1525 2168
1526 cf::async { 2169 cf::async {
2170 $Coro::current->{desc} = "map player save";
1527 $_->contr->save for $self->players; 2171 $_->contr->save for $self->players;
1528 }; 2172 };
1529 2173
2174 cf::get_slot 0.02;
2175
1530 if ($uniq) { 2176 if ($uniq) {
1531 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2177 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1532 $self->save_objects ($uniq, cf::IO_UNIQUES); 2178 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1533 } else { 2179 } else {
1534 $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);
1535 } 2181 }
1536} 2182}
1537 2183
1538sub swap_out { 2184sub swap_out {
1539 my ($self) = @_; 2185 my ($self) = @_;
1540 2186
1541 # save first because save cedes 2187 # save first because save cedes
1542 $self->save; 2188 $self->save;
1543 2189
1544 my $lock = cf::lock_acquire "map_data:" . $self->path; 2190 my $lock = cf::lock_acquire "map_data:$self->{path}";
1545 2191
1546 return if $self->players; 2192 return if $self->players;
1547 return if $self->in_memory != cf::MAP_IN_MEMORY; 2193 return if $self->in_memory != cf::MAP_ACTIVE;
1548 return if $self->{deny_save}; 2194 return if $self->{deny_save};
1549 2195
2196 $self->in_memory (cf::MAP_SWAPPED);
2197
2198 $self->deactivate;
2199 $_->clear_links_to ($self) for values %cf::MAP;
1550 $self->clear; 2200 $self->clear;
1551 $self->in_memory (cf::MAP_SWAPPED);
1552} 2201}
1553 2202
1554sub reset_at { 2203sub reset_at {
1555 my ($self) = @_; 2204 my ($self) = @_;
1556 2205
1557 # TODO: safety, remove and allow resettable per-player maps 2206 # TODO: safety, remove and allow resettable per-player maps
1558 return 1e99 if $self->{path}{user_rel};
1559 return 1e99 if $self->{deny_reset}; 2207 return 1e99 if $self->{deny_reset};
1560 2208
1561 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2209 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1562 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;
1563 2211
1568 my ($self) = @_; 2216 my ($self) = @_;
1569 2217
1570 $self->reset_at <= $cf::RUNTIME 2218 $self->reset_at <= $cf::RUNTIME
1571} 2219}
1572 2220
1573sub rename {
1574 my ($self, $new_path) = @_;
1575
1576 $self->{path}->unlink_save;
1577
1578 delete $cf::MAP{$self->path};
1579 $self->{path} = new cf::path $new_path;
1580 $self->path ($self->{path}->as_string);
1581 $cf::MAP{$self->path} = $self;
1582
1583 $self->save;
1584}
1585
1586sub reset { 2221sub reset {
1587 my ($self) = @_; 2222 my ($self) = @_;
1588 2223
1589 my $lock = cf::lock_acquire "map_data:" . $self->path; 2224 my $lock = cf::lock_acquire "map_data:$self->{path}";
1590 2225
1591 return if $self->players; 2226 return if $self->players;
1592 return if $self->{path}{user_rel};#d#
1593 2227
1594 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 }
1595 2239
1596 delete $cf::MAP{$self->path}; 2240 delete $cf::MAP{$self->path};
1597 2241
2242 $self->deactivate;
1598 $_->clear_links_to ($self) for values %cf::MAP; 2243 $_->clear_links_to ($self) for values %cf::MAP;
2244 $self->clear;
1599 2245
1600 $self->{path}->unlink_save; 2246 $self->unlink_save;
1601 $self->destroy; 2247 $self->destroy;
1602} 2248}
1603 2249
1604my $nuke_counter = "aaaa"; 2250my $nuke_counter = "aaaa";
1605 2251
1606sub nuke { 2252sub nuke {
1607 my ($self) = @_; 2253 my ($self) = @_;
1608 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};
1609 $self->{deny_save} = 1; 2264 $self->{deny_save} = 1;
1610 $self->reset_timeout (1); 2265 $self->reset_timeout (1);
1611 $self->rename ("{nuke}/" . ($nuke_counter++)); 2266 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2267
2268 $cf::MAP{$self->path} = $self;
2269 }
2270
1612 $self->reset; # polite request, might not happen 2271 $self->reset; # polite request, might not happen
1613} 2272}
1614 2273
2274=item $maps = cf::map::tmp_maps
2275
2276Returns an arrayref with all map paths of currently instantiated and saved
2277maps. May block.
2278
2279=cut
2280
2281sub tmp_maps() {
2282 [
2283 map {
2284 utf8::decode $_;
2285 /\.map$/
2286 ? normalise $_
2287 : ()
2288 } @{ aio_readdir $TMPDIR or [] }
2289 ]
2290}
2291
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 ]
2308}
2309
1615=item cf::map::unique_maps 2310=item cf::map::unique_maps
1616 2311
1617Returns an arrayref of cf::path's of all shared maps that have 2312Returns an arrayref of paths of all shared maps that have
1618instantiated unique items. May block. 2313instantiated unique items. May block.
1619 2314
1620=cut 2315=cut
1621 2316
1622sub unique_maps() { 2317sub unique_maps() {
1623 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2318 [
1624 or return; 2319 map {
1625
1626 my @paths;
1627
1628 for (@$files) {
1629 utf8::decode $_; 2320 utf8::decode $_;
1630 next if /\.pst$/; 2321 s/\.map$//; # TODO future compatibility hack
1631 next unless /^$PATH_SEP/o; 2322 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1632 2323 ? ()
1633 push @paths, new cf::path $_; 2324 : normalise $_
2325 } @{ aio_readdir $UNIQUEDIR or [] }
1634 } 2326 ]
1635
1636 \@paths
1637} 2327}
1638
1639package cf;
1640 2328
1641=back 2329=back
1642 2330
1643=head3 cf::object 2331=head3 cf::object
1644 2332
1648 2336
1649=over 4 2337=over 4
1650 2338
1651=item $ob->inv_recursive 2339=item $ob->inv_recursive
1652 2340
1653Returns 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.
1654 2343
1655=cut 2344=cut
1656 2345
1657sub inv_recursive_; 2346sub inv_recursive_;
1658sub inv_recursive_ { 2347sub inv_recursive_ {
1661 2350
1662sub inv_recursive { 2351sub inv_recursive {
1663 inv_recursive_ inv $_[0] 2352 inv_recursive_ inv $_[0]
1664} 2353}
1665 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
1666package cf; 2383package cf;
1667 2384
1668=back 2385=back
1669 2386
1670=head3 cf::object::player 2387=head3 cf::object::player
1676Sends 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>
1677can 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
1678dialogue with the given NPC character. 2395dialogue with the given NPC character.
1679 2396
1680=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};
1681 2412
1682# rough implementation of a future "reply" method that works 2413# rough implementation of a future "reply" method that works
1683# with dialog boxes. 2414# with dialog boxes.
1684#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
1685sub cf::object::player::reply($$$;$) { 2416sub cf::object::player::reply($$$;$) {
1687 2418
1688 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2419 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1689 2420
1690 if ($self->{record_replies}) { 2421 if ($self->{record_replies}) {
1691 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2422 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2423
1692 } 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 {
1693 $msg = $npc->name . " says: $msg" if $npc; 2432 $msg = $npc->name . " says: $msg" if $npc;
1694 $self->message ($msg, $flags); 2433 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2434 }
1695 } 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 (@_);
1696} 2446}
1697 2447
1698=item $player_object->may ("access") 2448=item $player_object->may ("access")
1699 2449
1700Returns wether the given player is authorized to access resource "access" 2450Returns wether the given player is authorized to access resource "access"
1713 2463
1714=item $player_object->enter_link 2464=item $player_object->enter_link
1715 2465
1716Freezes 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}>).
1717 2467
1718The 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.
1719I<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.
1720 2474
1721=item $player_object->leave_link ($map, $x, $y) 2475=item $player_object->leave_link ($map, $x, $y)
1722 2476
1723Moves 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
1724map 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
1725location 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
1726to the emergency map position. 2480fails, to the emergency map position.
1727 2481
1728Might block. 2482Might block.
1729 2483
1730=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}
1731 2495
1732sub cf::object::player::enter_link { 2496sub cf::object::player::enter_link {
1733 my ($self) = @_; 2497 my ($self) = @_;
1734 2498
1735 $self->deactivate_recursive; 2499 $self->deactivate_recursive;
1736 2500
1737 return if $self->map == $LINK_MAP; 2501 return if UNIVERSAL::isa $self->map, "ext::map_link";
1738 2502
1739 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2503 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1740 if $self->map; 2504 if $self->map && $self->map->{path} ne "{link}";
1741 2505
1742 $self->enter_map ($LINK_MAP, 20, 20); 2506 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1743} 2507}
1744 2508
1745sub cf::object::player::leave_link { 2509sub cf::object::player::leave_link {
1746 my ($self, $map, $x, $y) = @_; 2510 my ($self, $map, $x, $y) = @_;
2511
2512 return unless $self->contr->active;
1747 2513
1748 my $link_pos = delete $self->{_link_pos}; 2514 my $link_pos = delete $self->{_link_pos};
1749 2515
1750 unless ($map) { 2516 unless ($map) {
1751 # restore original map position 2517 # restore original map position
1765 # use -1 or undef as default coordinates, not 0, 0 2531 # use -1 or undef as default coordinates, not 0, 0
1766 ($x, $y) = ($map->enter_x, $map->enter_y) 2532 ($x, $y) = ($map->enter_x, $map->enter_y)
1767 if $x <=0 && $y <= 0; 2533 if $x <=0 && $y <= 0;
1768 2534
1769 $map->load; 2535 $map->load;
1770 $map->load_diag; 2536 $map->load_neighbours;
1771 2537
1772 return unless $self->contr->active; 2538 return unless $self->contr->active;
2539 $self->flag (cf::FLAG_DEBUG, 0);#d# temp
1773 $self->activate_recursive; 2540 $self->activate_recursive;
2541
2542 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1774 $self->enter_map ($map, $x, $y); 2543 $self->enter_map ($map, $x, $y);
1775} 2544}
1776 2545
1777cf::player->attach ( 2546=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1778 on_logout => sub {
1779 my ($pl) = @_;
1780 2547
1781 # abort map switching before logout 2548Moves the player to the given map-path and coordinates by first freezing
1782 if ($pl->ob->{_link_pos}) { 2549her, loading and preparing them map, calling the provided $check callback
1783 cf::sync_job { 2550that has to return the map if sucecssful, and then unfreezes the player on
1784 $pl->ob->leave_link 2551the new (success) or old (failed) map position. In either case, $done will
1785 }; 2552be called at the end of this process.
1786 }
1787 },
1788 on_login => sub {
1789 my ($pl) = @_;
1790 2553
1791 # try to abort aborted map switching on player login :) 2554Note that $check will be called with a potentially non-loaded map, so if
1792 # should happen only on crashes 2555it needs a loaded map it has to call C<< ->load >>.
1793 if ($pl->ob->{_link_pos}) {
1794 $pl->ob->enter_link;
1795 (async {
1796 # we need this sleep as the login has a concurrent enter_exit running
1797 # and this sleep increases chances of the player not ending up in scorn
1798 $pl->ob->reply (undef,
1799 "There was an internal problem at your last logout, "
1800 . "the server will try to bring you to your intended destination in a second.",
1801 cf::NDI_RED);
1802 Coro::Timer::sleep 1;
1803 $pl->ob->leave_link;
1804 })->prio (2);
1805 }
1806 },
1807);
1808 2556
1809=item $player_object->goto ($path, $x, $y)
1810
1811=cut 2557=cut
2558
2559our $GOTOGEN;
1812 2560
1813sub cf::object::player::goto { 2561sub cf::object::player::goto {
1814 my ($self, $path, $x, $y) = @_; 2562 my ($self, $path, $x, $y, $check, $done) = @_;
1815 2563
1816 $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;
1817 2566
1818 $self->enter_link; 2567 $self->enter_link;
1819 2568
1820 (async { 2569 (async {
1821 my $map = cf::map::find $path->as_string; 2570 $Coro::current->{desc} = "player::goto $path $x $y";
1822 $map = $map->{path}->customise_for ($map, $self) if $map;
1823 2571
1824# warn "entering ", $map->path, " at ($x, $y)\n" 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
1825# if $map; 2594 if ($map) {
1826 2595 $map = $map->customise_for ($self);
2596 $map = $check->($map) if $check && $map;
2597 } else {
1827 $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 }
1828 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};
1829 $self->leave_link ($map, $x, $y); 2611 $self->leave_link ($map, $x, $y);
2612 }
2613
2614 $done->() if $done;
1830 })->prio (1); 2615 })->prio (1);
1831} 2616}
1832 2617
1833=item $player_object->enter_exit ($exit_object) 2618=item $player_object->enter_exit ($exit_object)
1834 2619
1836 2621
1837sub parse_random_map_params { 2622sub parse_random_map_params {
1838 my ($spec) = @_; 2623 my ($spec) = @_;
1839 2624
1840 my $rmp = { # defaults 2625 my $rmp = { # defaults
1841 xsize => 10, 2626 xsize => (cf::rndm 15, 40),
1842 ysize => 10, 2627 ysize => (cf::rndm 15, 40),
2628 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2629 #layout => string,
1843 }; 2630 };
1844 2631
1845 for (split /\n/, $spec) { 2632 for (split /\n/, $spec) {
1846 my ($k, $v) = split /\s+/, $_, 2; 2633 my ($k, $v) = split /\s+/, $_, 2;
1847 2634
1859 # that depends on the exit object 2646 # that depends on the exit object
1860 2647
1861 my $rmp = parse_random_map_params $exit->msg; 2648 my $rmp = parse_random_map_params $exit->msg;
1862 2649
1863 if ($exit->map) { 2650 if ($exit->map) {
1864 $rmp->{region} = $exit->map->region_name; 2651 $rmp->{region} = $exit->region->name;
1865 $rmp->{origin_map} = $exit->map->path; 2652 $rmp->{origin_map} = $exit->map->path;
1866 $rmp->{origin_x} = $exit->x; 2653 $rmp->{origin_x} = $exit->x;
1867 $rmp->{origin_y} = $exit->y; 2654 $rmp->{origin_y} = $exit->y;
2655
2656 $exit->map->touch;
1868 } 2657 }
1869 2658
1870 $rmp->{random_seed} ||= $exit->random_seed; 2659 $rmp->{random_seed} ||= $exit->random_seed;
1871 2660
1872 my $data = cf::to_json $rmp; 2661 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1873 my $md5 = Digest::MD5::md5_hex $data; 2662 my $md5 = Digest::MD5::md5_hex $data;
2663 my $meta = "$RANDOMDIR/$md5.meta";
1874 2664
1875 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) {
1876 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;
1877 2669
2670 my $slaying = "?random/$md5";
2671
2672 if ($exit->valid) {
1878 $exit->slaying ("?random/$md5"); 2673 $exit->slaying ("?random/$md5");
1879 $exit->msg (undef); 2674 $exit->msg (undef);
2675 }
1880 } 2676 }
1881} 2677}
1882 2678
1883sub cf::object::player::enter_exit { 2679sub cf::object::player::enter_exit {
1884 my ($self, $exit) = @_; 2680 my ($self, $exit) = @_;
1886 return unless $self->type == cf::PLAYER; 2682 return unless $self->type == cf::PLAYER;
1887 2683
1888 $self->enter_link; 2684 $self->enter_link;
1889 2685
1890 (async { 2686 (async {
1891 $self->deactivate_recursive; # just to be sure 2687 $Coro::current->{desc} = "enter_exit";
2688
1892 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
1893 prepare_random_map $exit 2696 prepare_random_map $exit
1894 if $exit->slaying eq "/!"; 2697 if $exit->slaying eq "/!";
2698 }
1895 2699
1896 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;
1897 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 2701 my $x = $exit->stats->hp;
2702 my $y = $exit->stats->sp;
1898 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
1899 1; 2710 1
1900 }) { 2711 }) {
1901 $self->message ("Something went wrong deep within the crossfire server. " 2712 $self->message ("Something went wrong deep within the deliantra server. "
1902 . "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. "
1903 . "Please report this to the dungeon master!", 2714 . "Please report this to the dungeon master!",
1904 cf::NDI_UNIQUE | cf::NDI_RED); 2715 cf::NDI_UNIQUE | cf::NDI_RED);
1905 2716
1906 warn "ERROR in enter_exit: $@"; 2717 warn "ERROR in enter_exit: $@";
1907 $self->leave_link; 2718 $self->leave_link;
1908 } 2719 }
1909 })->prio (1); 2720 })->prio (1);
1922 2733
1923sub cf::client::send_drawinfo { 2734sub cf::client::send_drawinfo {
1924 my ($self, $text, $flags) = @_; 2735 my ($self, $text, $flags) = @_;
1925 2736
1926 utf8::encode $text; 2737 utf8::encode $text;
1927 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2738 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1928} 2739}
1929 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}
1930 2935
1931=item $success = $client->query ($flags, "text", \&cb) 2936=item $success = $client->query ($flags, "text", \&cb)
1932 2937
1933Queues a query to the client, calling the given callback with 2938Queues a query to the client, calling the given callback with
1934the 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>,
1935C<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>.
1936 2941
1937Queries 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
1938reliable at some point in the future. 2943become reliable at some point in the future.
1939 2944
1940=cut 2945=cut
1941 2946
1942sub cf::client::query { 2947sub cf::client::query {
1943 my ($self, $flags, $text, $cb) = @_; 2948 my ($self, $flags, $text, $cb) = @_;
1951 utf8::encode $text; 2956 utf8::encode $text;
1952 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2957 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1953 2958
1954 $self->send_packet ($self->{query_queue}[0][0]) 2959 $self->send_packet ($self->{query_queue}[0][0])
1955 if @{ $self->{query_queue} } == 1; 2960 if @{ $self->{query_queue} } == 1;
2961
2962 1
1956} 2963}
1957 2964
1958cf::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 },
1959 on_reply => sub { 2971 on_reply => sub {
1960 my ($ns, $msg) = @_; 2972 my ($ns, $msg) = @_;
1961 2973
1962 # this weird shuffling is so that direct followup queries 2974 # this weird shuffling is so that direct followup queries
1963 # get handled first 2975 # get handled first
1964 my $queue = delete $ns->{query_queue} 2976 my $queue = delete $ns->{query_queue}
1965 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
1966 2978
1967 (shift @$queue)->[1]->($msg); 2979 (shift @$queue)->[1]->($msg);
2980 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1968 2981
1969 push @{ $ns->{query_queue} }, @$queue; 2982 push @{ $ns->{query_queue} }, @$queue;
1970 2983
1971 if (@{ $ns->{query_queue} } == @$queue) { 2984 if (@{ $ns->{query_queue} } == @$queue) {
1972 if (@$queue) { 2985 if (@$queue) {
1974 } else { 2987 } else {
1975 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2988 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1976 } 2989 }
1977 } 2990 }
1978 }, 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 },
1979); 3018);
1980 3019
1981=item $client->async (\&cb) 3020=item $client->async (\&cb)
1982 3021
1983Create a new coroutine, running the specified callback. The coroutine will 3022Create a new coroutine, running the specified callback. The coroutine will
2024our $safe = new Safe "safe"; 3063our $safe = new Safe "safe";
2025our $safe_hole = new Safe::Hole; 3064our $safe_hole = new Safe::Hole;
2026 3065
2027$SIG{FPE} = 'IGNORE'; 3066$SIG{FPE} = 'IGNORE';
2028 3067
2029$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));
2030 3073
2031# here we export the classes and methods available to script code 3074# here we export the classes and methods available to script code
2032 3075
2033=pod 3076=pod
2034 3077
2035The following fucntions and emthods are available within a safe environment: 3078The following functions and methods are available within a safe environment:
2036 3079
2037 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
2038 cf::object::player player 3085 cf::object::player
2039 cf::player peaceful 3086 player
2040 cf::map trigger 3087
3088 cf::player
3089 peaceful
3090
3091 cf::map
3092 trigger
2041 3093
2042=cut 3094=cut
2043 3095
2044for ( 3096for (
2045 ["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)],
2046 ["cf::object::player" => qw(player)], 3100 ["cf::object::player" => qw(player)],
2047 ["cf::player" => qw(peaceful)], 3101 ["cf::player" => qw(peaceful send_msg)],
2048 ["cf::map" => qw(trigger)], 3102 ["cf::map" => qw(trigger)],
2049) { 3103) {
2050 no strict 'refs'; 3104 no strict 'refs';
2051 my ($pkg, @funs) = @$_; 3105 my ($pkg, @funs) = @$_;
2052 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3106 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2069 my ($code, %vars) = @_; 3123 my ($code, %vars) = @_;
2070 3124
2071 my $qcode = $code; 3125 my $qcode = $code;
2072 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3126 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2073 $qcode =~ s/\n/\\n/g; 3127 $qcode =~ s/\n/\\n/g;
3128
3129 %vars = (_dummy => 0) unless %vars;
2074 3130
2075 local $_; 3131 local $_;
2076 local @safe::cf::_safe_eval_args = values %vars; 3132 local @safe::cf::_safe_eval_args = values %vars;
2077 3133
2078 my $eval = 3134 my $eval =
2121=back 3177=back
2122 3178
2123=cut 3179=cut
2124 3180
2125############################################################################# 3181#############################################################################
3182# the server's init and main functions
2126 3183
2127=head2 EXTENSION DATABASE SUPPORT 3184sub load_facedata($) {
3185 my ($path) = @_;
2128 3186
2129Crossfire maintains a very simple database for extension use. It can 3187 # HACK to clear player env face cache, we need some signal framework
2130currently store anything that can be serialised using Storable, which 3188 # for this (global event?)
2131excludes objects. 3189 %ext::player_env::MUSIC_FACE_CACHE = ();
2132 3190
2133The parameter C<$family> should best start with the name of the extension 3191 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2134using it, it should be unique.
2135 3192
2136=over 4 3193 warn "loading facedata from $path\n";
2137 3194
2138=item $hashref = cf::db_get $family 3195 my $facedata;
3196 0 < aio_load $path, $facedata
3197 or die "$path: $!";
2139 3198
2140Return a hashref for use by the extension C<$family>, which can be 3199 $facedata = Coro::Storable::thaw $facedata;
2141modified. After modifications, you have to call C<cf::db_dirty> or
2142C<cf::db_sync>.
2143 3200
2144=item $value = cf::db_get $family => $key 3201 $facedata->{version} == 2
3202 or cf::cleanup "$path: version mismatch, cannot proceed.";
2145 3203
2146Returns a single value from the database 3204 # patch in the exptable
2147 3205 $facedata->{resource}{"res/exp_table"} = {
2148=item cf::db_put $family => $hashref 3206 type => FT_RSRC,
2149 3207 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2150Stores the given family hashref into the database. Updates are delayed, if
2151you want the data to be synced to disk immediately, use C<cf::db_sync>.
2152
2153=item cf::db_put $family => $key => $value
2154
2155Stores the given C<$value> in the family hash. Updates are delayed, if you
2156want the data to be synced to disk immediately, use C<cf::db_sync>.
2157
2158=item cf::db_dirty
2159
2160Marks the database as dirty, to be updated at a later time.
2161
2162=item cf::db_sync
2163
2164Immediately write the database to disk I<if it is dirty>.
2165
2166=cut
2167
2168our $DB;
2169
2170{
2171 my $path = cf::localdir . "/database.pst";
2172
2173 sub db_load() {
2174 $DB = stat $path ? Storable::retrieve $path : { };
2175 }
2176
2177 my $pid;
2178
2179 sub db_save() {
2180 waitpid $pid, 0 if $pid;
2181 if (0 == ($pid = fork)) {
2182 $DB->{_meta}{version} = 1;
2183 Storable::nstore $DB, "$path~";
2184 rename "$path~", $path;
2185 cf::_exit 0 if defined $pid;
2186 }
2187 }
2188
2189 my $dirty;
2190
2191 sub db_sync() {
2192 db_save if $dirty;
2193 undef $dirty;
2194 }
2195
2196 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2197 db_sync;
2198 }); 3208 };
3209 cf::cede_to_tick;
2199 3210
2200 sub db_dirty() {
2201 $dirty = 1;
2202 $idle->start;
2203 } 3211 {
3212 my $faces = $facedata->{faceinfo};
2204 3213
2205 sub db_get($;$) { 3214 while (my ($face, $info) = each %$faces) {
2206 @_ >= 2 3215 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2207 ? $DB->{$_[0]}{$_[1]}
2208 : ($DB->{$_[0]} ||= { })
2209 }
2210 3216
2211 sub db_put($$;$) { 3217 cf::face::set_visibility $idx, $info->{visibility};
2212 if (@_ >= 3) { 3218 cf::face::set_magicmap $idx, $info->{magicmap};
2213 $DB->{$_[0]}{$_[1]} = $_[2]; 3219 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2214 } else { 3220 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2215 $DB->{$_[0]} = $_[1];
2216 }
2217 db_dirty;
2218 }
2219 3221
2220 cf::global->attach ( 3222 cf::cede_to_tick;
2221 prio => 10000,
2222 on_cleanup => sub {
2223 db_sync;
2224 }, 3223 }
2225 );
2226}
2227 3224
2228############################################################################# 3225 while (my ($face, $info) = each %$faces) {
2229# the server's main() 3226 next unless $info->{smooth};
2230 3227
2231sub 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 {
2232 open my $fh, "<:utf8", cf::confdir . "/config" 3370 open my $fh, "<:utf8", "$CONFDIR/config"
2233 or return; 3371 or return;
2234 3372
2235 local $/; 3373 local $/;
2236 *CFG = YAML::Syck::Load <$fh>; 3374 *CFG = YAML::Load <$fh>;
2237 3375
2238 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3376 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2239 3377
2240 $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};
2241 $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};
2247 }; 3385 };
2248 warn $@ if $@; 3386 warn $@ if $@;
2249 } 3387 }
2250} 3388}
2251 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
2252sub 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
2253 # we must not ever block the main coroutine 3433 # we must not ever block the main coroutine
2254 local $Coro::idle = sub { 3434 local $Coro::idle = sub {
2255 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#
2256 async { Event::one_event }; 3436 (async {
3437 $Coro::current->{desc} = "IDLE BUG HANDLER";
3438 EV::loop EV::LOOP_ONESHOT;
3439 })->prio (Coro::PRIO_MAX);
2257 }; 3440 };
2258 3441
2259 cfg_load; 3442 evthread_start IO::AIO::poll_fileno;
2260 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
2261 load_extensions; 3460 load_extensions;
2262 Event::loop; 3461
3462 utime time, time, $RUNTIMEFILE;
3463
3464 # no (long-running) fork's whatsoever before this point(!)
3465 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3466
3467 (pop @POST_INIT)->(0) while @POST_INIT;
3468 };
3469
3470 main_loop;
2263} 3471}
2264 3472
2265############################################################################# 3473#############################################################################
2266# initialisation and cleanup 3474# initialisation and cleanup
2267 3475
2268# install some emergency cleanup handlers 3476# install some emergency cleanup handlers
2269BEGIN { 3477BEGIN {
3478 our %SIGWATCHER = ();
2270 for my $signal (qw(INT HUP TERM)) { 3479 for my $signal (qw(INT HUP TERM)) {
2271 Event->signal ( 3480 $SIGWATCHER{$signal} = EV::signal $signal, sub {
2272 data => WF_AUTOCANCEL,
2273 signal => $signal,
2274 cb => sub {
2275 cf::cleanup "SIG$signal"; 3481 cf::cleanup "SIG$signal";
2276 },
2277 ); 3482 };
3483 }
3484}
3485
3486sub write_runtime_sync {
3487 # first touch the runtime file to show we are still running:
3488 # the fsync below can take a very very long time.
3489
3490 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3491
3492 my $guard = cf::lock_acquire "write_runtime";
3493
3494 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3495 or return;
3496
3497 my $value = $cf::RUNTIME + 90 + 10;
3498 # 10 is the runtime save interval, for a monotonic clock
3499 # 60 allows for the watchdog to kill the server.
3500
3501 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3502 and return;
3503
3504 # always fsync - this file is important
3505 aio_fsync $fh
3506 and return;
3507
3508 # touch it again to show we are up-to-date
3509 aio_utime $fh, undef, undef;
3510
3511 close $fh
3512 or return;
3513
3514 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3515 and return;
3516
3517 warn "runtime file written.\n";
3518
2278 } 3519 1
3520}
3521
3522our $uuid_lock;
3523our $uuid_skip;
3524
3525sub write_uuid_sync($) {
3526 $uuid_skip ||= $_[0];
3527
3528 return if $uuid_lock;
3529 local $uuid_lock = 1;
3530
3531 my $uuid = "$LOCALDIR/uuid";
3532
3533 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3534 or return;
3535
3536 my $value = uuid_seq uuid_cur;
3537
3538 unless ($value) {
3539 warn "cowardly refusing to write zero uuid value!\n";
3540 return;
3541 }
3542
3543 my $value = uuid_str $value + $uuid_skip;
3544 $uuid_skip = 0;
3545
3546 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3547 and return;
3548
3549 # always fsync - this file is important
3550 aio_fsync $fh
3551 and return;
3552
3553 close $fh
3554 or return;
3555
3556 aio_rename "$uuid~", $uuid
3557 and return;
3558
3559 warn "uuid file written ($value).\n";
3560
3561 1
3562
3563}
3564
3565sub write_uuid($$) {
3566 my ($skip, $sync) = @_;
3567
3568 $sync ? write_uuid_sync $skip
3569 : async { write_uuid_sync $skip };
2279} 3570}
2280 3571
2281sub emergency_save() { 3572sub emergency_save() {
2282 my $freeze_guard = cf::freeze_mainloop; 3573 my $freeze_guard = cf::freeze_mainloop;
2283 3574
2284 warn "enter emergency perl save\n"; 3575 warn "emergency_perl_save: enter\n";
2285 3576
2286 cf::sync_job { 3577 cf::sync_job {
3578 # this is a trade-off: we want to be very quick here, so
3579 # save all maps without fsync, and later call a global sync
3580 # (which in turn might be very very slow)
3581 local $USE_FSYNC = 0;
3582
2287 # use a peculiar iteration method to avoid tripping on perl 3583 # use a peculiar iteration method to avoid tripping on perl
2288 # refcount bugs in for. also avoids problems with players 3584 # refcount bugs in for. also avoids problems with players
2289 # and maps saved/Destroyed asynchronously. 3585 # and maps saved/destroyed asynchronously.
2290 warn "begin emergency player save\n"; 3586 warn "emergency_perl_save: begin player save\n";
2291 for my $login (keys %cf::PLAYER) { 3587 for my $login (keys %cf::PLAYER) {
2292 my $pl = $cf::PLAYER{$login} or next; 3588 my $pl = $cf::PLAYER{$login} or next;
2293 $pl->valid or next; 3589 $pl->valid or next;
3590 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2294 $pl->save; 3591 $pl->save;
2295 } 3592 }
2296 warn "end emergency player save\n"; 3593 warn "emergency_perl_save: end player save\n";
2297 3594
2298 warn "begin emergency map save\n"; 3595 warn "emergency_perl_save: begin map save\n";
2299 for my $path (keys %cf::MAP) { 3596 for my $path (keys %cf::MAP) {
2300 my $map = $cf::MAP{$path} or next; 3597 my $map = $cf::MAP{$path} or next;
2301 $map->valid or next; 3598 $map->valid or next;
2302 $map->save; 3599 $map->save;
2303 } 3600 }
2304 warn "end emergency map save\n"; 3601 warn "emergency_perl_save: end map save\n";
3602
3603 warn "emergency_perl_save: begin database checkpoint\n";
3604 BDB::db_env_txn_checkpoint $DB_ENV;
3605 warn "emergency_perl_save: end database checkpoint\n";
3606
3607 warn "emergency_perl_save: begin write uuid\n";
3608 write_uuid_sync 1;
3609 warn "emergency_perl_save: end write uuid\n";
2305 }; 3610 };
2306 3611
3612 warn "emergency_perl_save: starting sync()\n";
3613 IO::AIO::aio_sync sub {
3614 warn "emergency_perl_save: finished sync()\n";
3615 };
3616
2307 warn "leave emergency perl save\n"; 3617 warn "emergency_perl_save: leave\n";
2308} 3618}
2309 3619
3620sub post_cleanup {
3621 my ($make_core) = @_;
3622
3623 warn Carp::longmess "post_cleanup backtrace"
3624 if $make_core;
3625
3626 my $fh = pidfile;
3627 unlink $PIDFILE if <$fh> == $$;
3628}
3629
3630# a safer delete_package, copied from Symbol
3631sub clear_package($) {
3632 my $pkg = shift;
3633
3634 # expand to full symbol table name if needed
3635 unless ($pkg =~ /^main::.*::$/) {
3636 $pkg = "main$pkg" if $pkg =~ /^::/;
3637 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3638 $pkg .= '::' unless $pkg =~ /::$/;
3639 }
3640
3641 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3642 my $stem_symtab = *{$stem}{HASH};
3643
3644 defined $stem_symtab and exists $stem_symtab->{$leaf}
3645 or return;
3646
3647 # clear all symbols
3648 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3649 for my $name (keys %$leaf_symtab) {
3650 _gv_clear *{"$pkg$name"};
3651# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3652 }
3653 warn "cleared package $pkg\n";#d#
3654}
3655
2310sub reload() { 3656sub do_reload_perl() {
2311 # can/must only be called in main 3657 # can/must only be called in main
2312 if ($Coro::current != $Coro::main) { 3658 if ($Coro::current != $Coro::main) {
2313 warn "can only reload from main coroutine\n"; 3659 warn "can only reload from main coroutine";
2314 return; 3660 return;
2315 } 3661 }
2316 3662
3663 return if $RELOAD++;
3664
3665 my $t1 = EV::time;
3666
3667 while ($RELOAD) {
2317 warn "reloading..."; 3668 warn "reloading...";
2318 3669
2319 warn "freezing server"; 3670 warn "entering sync_job";
2320 my $guard = freeze_mainloop; 3671
3672 cf::sync_job {
3673 cf::write_runtime_sync; # external watchdog should not bark
2321 cf::emergency_save; 3674 cf::emergency_save;
3675 cf::write_runtime_sync; # external watchdog should not bark
2322 3676
2323 warn "sync database to disk"; 3677 warn "syncing database to disk";
2324 cf::db_sync; 3678 BDB::db_env_txn_checkpoint $DB_ENV;
2325 IO::AIO::flush;
2326 3679
2327 eval {
2328 # if anything goes wrong in here, we should simply crash as we already saved 3680 # if anything goes wrong in here, we should simply crash as we already saved
2329 3681
2330 warn "cancel all watchers"; 3682 warn "flushing outstanding aio requests";
2331 for (Event::all_watchers) { 3683 while (IO::AIO::nreqs || BDB::nreqs) {
2332 $_->cancel if $_->data & WF_AUTOCANCEL; 3684 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2333 }
2334
2335 warn "cancel all extension coros";
2336 $_->cancel for values %EXT_CORO;
2337 %EXT_CORO = ();
2338
2339 warn "remove commands";
2340 %COMMAND = ();
2341
2342 warn "remove ext commands";
2343 %EXTCMD = ();
2344
2345 warn "unload/nuke all extensions";
2346 for my $pkg (@EXTS) {
2347 warn "... unloading $pkg";
2348
2349 if (my $cb = $pkg->can ("unload")) {
2350 eval {
2351 $cb->($pkg);
2352 1
2353 } or warn "$pkg unloaded, but with errors: $@";
2354 } 3685 }
2355 3686
3687 warn "cancelling all extension coros";
3688 $_->cancel for values %EXT_CORO;
3689 %EXT_CORO = ();
3690
3691 warn "removing commands";
3692 %COMMAND = ();
3693
3694 warn "removing ext/exti commands";
3695 %EXTCMD = ();
3696 %EXTICMD = ();
3697
3698 warn "unloading/nuking all extensions";
3699 for my $pkg (@EXTS) {
2356 warn "... nuking $pkg"; 3700 warn "... unloading $pkg";
2357 Symbol::delete_package $pkg;
2358 }
2359 3701
2360 warn "unload all perl modules loaded from $LIBDIR";
2361 while (my ($k, $v) = each %INC) {
2362 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2363
2364 warn "removing <$k>";
2365 delete $INC{$k};
2366
2367 $k =~ s/\.pm$//;
2368 $k =~ s/\//::/g;
2369
2370 if (my $cb = $k->can ("unload_module")) { 3702 if (my $cb = $pkg->can ("unload")) {
3703 eval {
2371 $cb->(); 3704 $cb->($pkg);
3705 1
3706 } or warn "$pkg unloaded, but with errors: $@";
3707 }
3708
3709 warn "... clearing $pkg";
3710 clear_package $pkg;
2372 } 3711 }
2373 3712
2374 Symbol::delete_package $k; 3713 warn "unloading all perl modules loaded from $LIBDIR";
3714 while (my ($k, $v) = each %INC) {
3715 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
3716
3717 warn "... unloading $k";
3718 delete $INC{$k};
3719
3720 $k =~ s/\.pm$//;
3721 $k =~ s/\//::/g;
3722
3723 if (my $cb = $k->can ("unload_module")) {
3724 $cb->();
3725 }
3726
3727 clear_package $k;
2375 } 3728 }
2376 3729
2377 warn "get rid of safe::, as good as possible"; 3730 warn "getting rid of safe::, as good as possible";
2378 Symbol::delete_package "safe::$_" 3731 clear_package "safe::$_"
2379 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3732 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2380 3733
2381 warn "unload cf.pm \"a bit\""; 3734 warn "unloading cf.pm \"a bit\"";
2382 delete $INC{"cf.pm"}; 3735 delete $INC{"cf.pm"};
3736 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2383 3737
2384 # don't, removes xs symbols, too, 3738 # don't, removes xs symbols, too,
2385 # and global variables created in xs 3739 # and global variables created in xs
2386 #Symbol::delete_package __PACKAGE__; 3740 #clear_package __PACKAGE__;
2387 3741
3742 warn "unload completed, starting to reload now";
3743
2388 warn "reloading cf.pm"; 3744 warn "reloading cf.pm";
2389 require cf; 3745 require cf;
2390 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3746 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2391 3747
2392 warn "load config and database again"; 3748 warn "loading config and database again";
2393 cf::cfg_load; 3749 cf::reload_config;
2394 cf::db_load;
2395 3750
2396 warn "load extensions"; 3751 warn "loading extensions";
2397 cf::load_extensions; 3752 cf::load_extensions;
2398 3753
3754 if ($REATTACH_ON_RELOAD) {
2399 warn "reattach attachments to objects/players"; 3755 warn "reattaching attachments to objects/players";
2400 _global_reattach; 3756 _global_reattach; # objects, sockets
2401 warn "reattach attachments to maps"; 3757 warn "reattaching attachments to maps";
2402 reattach $_ for values %MAP; 3758 reattach $_ for values %MAP;
3759 warn "reattaching attachments to players";
3760 reattach $_ for values %PLAYER;
3761 }
3762
3763 warn "running post_init jobs";
3764 (pop @POST_INIT)->(1) while @POST_INIT;
3765
3766 warn "leaving sync_job";
3767
3768 1
3769 } or do {
3770 warn $@;
3771 cf::cleanup "error while reloading, exiting.";
3772 };
3773
3774 warn "reloaded";
3775 --$RELOAD;
3776 }
3777
3778 $t1 = EV::time - $t1;
3779 warn "reload completed in ${t1}s\n";
3780};
3781
3782our $RELOAD_WATCHER; # used only during reload
3783
3784sub reload_perl() {
3785 # doing reload synchronously and two reloads happen back-to-back,
3786 # coro crashes during coro_state_free->destroy here.
3787
3788 $RELOAD_WATCHER ||= cf::async {
3789 Coro::AIO::aio_wait cache_extensions;
3790
3791 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3792 do_reload_perl;
3793 undef $RELOAD_WATCHER;
3794 };
2403 }; 3795 };
2404
2405 if ($@) {
2406 warn $@;
2407 warn "error while reloading, exiting.";
2408 exit 1;
2409 }
2410
2411 warn "reloaded";
2412};
2413
2414#############################################################################
2415
2416unless ($LINK_MAP) {
2417 $LINK_MAP = cf::map::new;
2418
2419 $LINK_MAP->width (41);
2420 $LINK_MAP->height (41);
2421 $LINK_MAP->alloc;
2422 $LINK_MAP->path ("{link}");
2423 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2424 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2425
2426 # dirty hack because... archetypes are not yet loaded
2427 Event->timer (
2428 after => 10,
2429 cb => sub {
2430 $_[0]->w->cancel;
2431
2432 # provide some exits "home"
2433 my $exit = cf::object::new "exit";
2434
2435 $exit->slaying ($EMERGENCY_POSITION->[0]);
2436 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2437 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2438
2439 $LINK_MAP->insert ($exit->clone, 19, 19);
2440 $LINK_MAP->insert ($exit->clone, 19, 20);
2441 $LINK_MAP->insert ($exit->clone, 19, 21);
2442 $LINK_MAP->insert ($exit->clone, 20, 19);
2443 $LINK_MAP->insert ($exit->clone, 20, 21);
2444 $LINK_MAP->insert ($exit->clone, 21, 19);
2445 $LINK_MAP->insert ($exit->clone, 21, 20);
2446 $LINK_MAP->insert ($exit->clone, 21, 21);
2447
2448 $exit->destroy;
2449 });
2450
2451 $LINK_MAP->{deny_save} = 1;
2452 $LINK_MAP->{deny_reset} = 1;
2453
2454 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2455} 3796}
2456 3797
2457register_command "reload" => sub { 3798register_command "reload" => sub {
2458 my ($who, $arg) = @_; 3799 my ($who, $arg) = @_;
2459 3800
2460 if ($who->flag (FLAG_WIZ)) { 3801 if ($who->flag (FLAG_WIZ)) {
2461 $who->message ("start of reload.");
2462 reload;
2463 $who->message ("end of reload."); 3802 $who->message ("reloading server.");
3803 async {
3804 $Coro::current->{desc} = "perl_reload";
3805 reload_perl;
3806 };
2464 } 3807 }
2465}; 3808};
2466 3809
2467unshift @INC, $LIBDIR; 3810unshift @INC, $LIBDIR;
2468 3811
2469$TICK_WATCHER = Event->timer ( 3812my $bug_warning = 0;
2470 reentrant => 0,
2471 prio => 0,
2472 at => $NEXT_TICK || $TICK,
2473 data => WF_AUTOCANCEL,
2474 cb => sub {
2475 $NOW = Event::time;
2476 3813
3814our @WAIT_FOR_TICK;
3815our @WAIT_FOR_TICK_BEGIN;
3816
3817sub wait_for_tick {
3818 return if tick_inhibit || $Coro::current == $Coro::main;
3819
3820 my $signal = new Coro::Signal;
3821 push @WAIT_FOR_TICK, $signal;
3822 $signal->wait;
3823}
3824
3825sub wait_for_tick_begin {
3826 return if tick_inhibit || $Coro::current == $Coro::main;
3827
3828 my $signal = new Coro::Signal;
3829 push @WAIT_FOR_TICK_BEGIN, $signal;
3830 $signal->wait;
3831}
3832
3833sub tick {
3834 if ($Coro::current != $Coro::main) {
3835 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3836 unless ++$bug_warning > 10;
3837 return;
3838 }
3839
2477 cf::server_tick; # one server iteration 3840 cf::server_tick; # one server iteration
2478 $RUNTIME += $TICK;
2479 $NEXT_TICK += $TICK;
2480 3841
2481 $WAIT_FOR_TICK->broadcast; 3842 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2482 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3843 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2483 3844 Coro::async_pool {
2484 # if we are delayed by four ticks or more, skip them all 3845 $Coro::current->{desc} = "runtime saver";
2485 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2486
2487 $TICK_WATCHER->at ($NEXT_TICK);
2488 $TICK_WATCHER->start;
2489 },
2490);
2491
2492IO::AIO::max_poll_time $TICK * 0.2;
2493
2494Event->io (
2495 fd => IO::AIO::poll_fileno,
2496 poll => 'r',
2497 prio => 5,
2498 data => WF_AUTOCANCEL,
2499 cb => \&IO::AIO::poll_cb,
2500);
2501
2502Event->timer (
2503 data => WF_AUTOCANCEL,
2504 after => 0,
2505 interval => 10,
2506 cb => sub {
2507 (Coro::unblock_sub {
2508 write_runtime 3846 write_runtime_sync
2509 or warn "ERROR: unable to write runtime file: $!"; 3847 or warn "ERROR: unable to write runtime file: $!";
2510 })->(); 3848 };
2511 }, 3849 }
2512); 3850
3851 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3852 $sig->send;
3853 }
3854 while (my $sig = shift @WAIT_FOR_TICK) {
3855 $sig->send;
3856 }
3857
3858 $LOAD = ($NOW - $TICK_START) / $TICK;
3859 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3860
3861 if (0) {
3862 if ($NEXT_TICK) {
3863 my $jitter = $TICK_START - $NEXT_TICK;
3864 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3865 warn "jitter $JITTER\n";#d#
3866 }
3867 }
3868}
3869
3870{
3871 # configure BDB
3872
3873 BDB::min_parallel 8;
3874 BDB::max_poll_reqs $TICK * 0.1;
3875 $AnyEvent::BDB::WATCHER->priority (1);
3876
3877 unless ($DB_ENV) {
3878 $DB_ENV = BDB::db_env_create;
3879 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3880 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3881 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3882 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3883 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3884
3885 cf::sync_job {
3886 eval {
3887 BDB::db_env_open
3888 $DB_ENV,
3889 $BDBDIR,
3890 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3891 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3892 0666;
3893
3894 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3895 };
3896
3897 cf::cleanup "db_env_open(db): $@" if $@;
3898 };
3899 }
3900
3901 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3902 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3903 };
3904 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3905 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3906 };
3907 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3908 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3909 };
3910}
3911
3912{
3913 # configure IO::AIO
3914
3915 IO::AIO::min_parallel 8;
3916 IO::AIO::max_poll_time $TICK * 0.1;
3917 undef $AnyEvent::AIO::WATCHER;
3918}
3919
3920my $_log_backtrace;
3921
3922sub _log_backtrace {
3923 my ($msg, @addr) = @_;
3924
3925 $msg =~ s/\n//;
3926
3927 # limit the # of concurrent backtraces
3928 if ($_log_backtrace < 2) {
3929 ++$_log_backtrace;
3930 my $perl_bt = Carp::longmess $msg;
3931 async {
3932 $Coro::current->{desc} = "abt $msg";
3933
3934 my @bt = fork_call {
3935 @addr = map { sprintf "%x", $_ } @addr;
3936 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3937 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3938 or die "addr2line: $!";
3939
3940 my @funcs;
3941 my @res = <$fh>;
3942 chomp for @res;
3943 while (@res) {
3944 my ($func, $line) = splice @res, 0, 2, ();
3945 push @funcs, "[$func] $line";
3946 }
3947
3948 @funcs
3949 };
3950
3951 LOG llevInfo, "[ABT] $perl_bt\n";
3952 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3953 LOG llevInfo, "[ABT] $_\n" for @bt;
3954 --$_log_backtrace;
3955 };
3956 } else {
3957 LOG llevInfo, "[ABT] $msg\n";
3958 LOG llevInfo, "[ABT] [suppressed]\n";
3959 }
3960}
3961
3962# load additional modules
3963require "cf/$_.pm" for @EXTRA_MODULES;
2513 3964
2514END { cf::emergency_save } 3965END { cf::emergency_save }
2515 3966
25161 39671
2517 3968

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines