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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines