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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines