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.156 by root, Tue Jan 9 22:07:08 2007 UTC vs.
Revision 1.459 by root, Sat Dec 13 21:46:12 2008 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 "FATAL: $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 )
1738}
1739
1740=item cf::map->register ($regex, $prio)
1741
1742Register a handler for the map path matching the given regex at the
1743givne priority (higher is better, built-in handlers have priority 0, the
1744default).
1745
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 {
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"
1304} 1865}
1305 1866
1306# and all this just because we cannot iterate over 1867# and all this just because we cannot iterate over
1307# all maps in C++... 1868# all maps in C++...
1308sub change_all_map_light { 1869sub change_all_map_light {
1310 1871
1311 $_->change_map_light ($change) 1872 $_->change_map_light ($change)
1312 for grep $_->outdoor, values %cf::MAP; 1873 for grep $_->outdoor, values %cf::MAP;
1313} 1874}
1314 1875
1876sub decay_objects {
1877 my ($self) = @_;
1878
1879 return if $self->{deny_reset};
1880
1881 $self->do_decay_objects;
1882}
1883
1884sub unlink_save {
1885 my ($self) = @_;
1886
1887 utf8::encode (my $save = $self->save_path);
1888 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1889 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1890}
1891
1315sub try_load_header($) { 1892sub load_header_from($) {
1316 my ($path) = @_; 1893 my ($self, $path) = @_;
1317 1894
1318 utf8::encode $path; 1895 utf8::encode $path;
1319 aio_open $path, O_RDONLY, 0 1896 my $f = new_from_file cf::object::thawer $path
1320 or return; 1897 or return;
1321 1898
1322 my $map = cf::map::new 1899 $self->_load_header ($f)
1323 or return; 1900 or return;
1324 1901
1325 # for better error messages only, will be overwritten 1902 local $MAP_LOADING{$self->{path}} = $self;
1326 $map->path ($path); 1903 $f->resolve_delayed_derefs;
1327 1904
1328 $map->load_header ($path) 1905 $self->{load_path} = $path;
1906
1907 1
1908}
1909
1910sub load_header_orig {
1911 my ($self) = @_;
1912
1913 $self->load_header_from ($self->load_path)
1914}
1915
1916sub load_header_temp {
1917 my ($self) = @_;
1918
1919 $self->load_header_from ($self->save_path)
1920}
1921
1922sub prepare_temp {
1923 my ($self) = @_;
1924
1925 $self->last_access ((delete $self->{last_access})
1926 || $cf::RUNTIME); #d#
1927 # safety
1928 $self->{instantiate_time} = $cf::RUNTIME
1929 if $self->{instantiate_time} > $cf::RUNTIME;
1930}
1931
1932sub prepare_orig {
1933 my ($self) = @_;
1934
1935 $self->{load_original} = 1;
1936 $self->{instantiate_time} = $cf::RUNTIME;
1937 $self->last_access ($cf::RUNTIME);
1938 $self->instantiate;
1939}
1940
1941sub load_header {
1942 my ($self) = @_;
1943
1944 if ($self->load_header_temp) {
1945 $self->prepare_temp;
1946 } else {
1947 $self->load_header_orig
1329 or return; 1948 or return;
1949 $self->prepare_orig;
1950 }
1330 1951
1331 $map->{load_path} = $path; 1952 $self->{deny_reset} = 1
1953 if $self->no_reset;
1332 1954
1333 $map 1955 $self->default_region (cf::region::find_by_path $self->{path})
1956 unless $self->default_region;
1957
1958 1
1334} 1959}
1335 1960
1336sub find; 1961sub find;
1337sub find { 1962sub find {
1338 my ($path, $origin) = @_; 1963 my ($path, $origin) = @_;
1339 1964
1340 #warn "find<$path,$origin>\n";#d#
1341
1342 $path = new cf::path $path, $origin && $origin->path; 1965 $path = normalise $path, $origin && $origin->path;
1343 my $key = $path->as_string;
1344 1966
1345 cf::lock_wait "map_find:$key"; 1967 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"; 1968 my $guard2 = cf::lock_acquire "map_find:$path";
1349 1969
1350 # do it the slow way 1970 $cf::MAP{$path} || do {
1351 my $map = try_load_header $path->save_path; 1971 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; 1972 or return;
1369 1973
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; 1974 $map->{last_save} = $cf::RUNTIME;
1382 1975
1383 Coro::cede; 1976 $map->load_header
1977 or return;
1384 1978
1385 if ($map->should_reset) { 1979 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1980 # doing this can freeze the server in a sync job, obviously
1981 #$cf::WAIT_FOR_TICK->wait;
1982 undef $guard2;
1983 undef $guard1;
1386 $map->reset; 1984 $map->reset;
1387 undef $guard;
1388 $map = find $path 1985 return find $path;
1389 or return;
1390 } 1986 }
1391 1987
1392 $cf::MAP{$key} = $map 1988 $cf::MAP{$path} = $map
1393 } 1989 }
1394} 1990}
1991
1992sub pre_load { }
1993sub post_load { }
1395 1994
1396sub load { 1995sub load {
1397 my ($self) = @_; 1996 my ($self) = @_;
1398 1997
1998 local $self->{deny_reset} = 1; # loading can take a long time
1999
1399 my $path = $self->{path}; 2000 my $path = $self->{path};
2001
2002 {
1400 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 2003 my $guard = cf::lock_acquire "map_data:$path";
1401 2004
2005 return unless $self->valid;
1402 return if $self->in_memory != cf::MAP_SWAPPED; 2006 return unless $self->in_memory == cf::MAP_SWAPPED;
1403 2007
1404 $self->in_memory (cf::MAP_LOADING); 2008 $self->in_memory (cf::MAP_LOADING);
1405 2009
1406 $self->alloc; 2010 $self->alloc;
1407 $self->load_objects ($self->{load_path}, 1) 2011
2012 $self->pre_load;
2013 cf::cede_to_tick;
2014
2015 my $f = new_from_file cf::object::thawer $self->{load_path};
2016 $f->skip_block;
2017 $self->_load_objects ($f)
1408 or return; 2018 or return;
1409 2019
1410 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2020 $self->post_load_original
1411 if delete $self->{load_original}; 2021 if delete $self->{load_original};
1412 2022
1413 if (my $uniq = $path->uniq_path) { 2023 if (my $uniq = $self->uniq_path) {
1414 utf8::encode $uniq; 2024 utf8::encode $uniq;
1415 if (aio_open $uniq, O_RDONLY, 0) { 2025 unless (aio_stat $uniq) {
2026 if (my $f = new_from_file cf::object::thawer $uniq) {
1416 $self->clear_unique_items; 2027 $self->clear_unique_items;
1417 $self->load_objects ($uniq, 0); 2028 $self->_load_objects ($f);
2029 $f->resolve_delayed_derefs;
2030 }
1418 } 2031 }
1419 } 2032 }
1420 2033
1421 Coro::cede; 2034 $f->resolve_delayed_derefs;
1422 2035
2036 cf::cede_to_tick;
1423 # now do the right thing for maps 2037 # now do the right thing for maps
1424 $self->link_multipart_objects; 2038 $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) 2039 $self->difficulty ($self->estimate_difficulty)
1435 unless $self->difficulty; 2040 unless $self->difficulty;
2041 cf::cede_to_tick;
2042
2043 unless ($self->{deny_activate}) {
2044 $self->decay_objects;
2045 $self->fix_auto_apply;
2046 $self->update_buttons;
2047 cf::cede_to_tick;
2048 $self->set_darkness_map;
2049 cf::cede_to_tick;
1436 $self->activate; 2050 $self->activate;
1437 } 2051 }
1438 2052
1439 Coro::cede; 2053 $self->{last_save} = $cf::RUNTIME;
2054 $self->last_access ($cf::RUNTIME);
1440 2055
1441 $self->in_memory (cf::MAP_IN_MEMORY); 2056 $self->in_memory (cf::MAP_ACTIVE);
2057 }
2058
2059 $self->post_load;
2060}
2061
2062sub customise_for {
2063 my ($self, $ob) = @_;
2064
2065 return find "~" . $ob->name . "/" . $self->{path}
2066 if $self->per_player;
2067
2068# return find "?party/" . $ob->name . "/" . $self->{path}
2069# if $self->per_party;
2070
2071 $self
2072}
2073
2074# find and load all maps in the 3x3 area around a map
2075sub load_neighbours {
2076 my ($map) = @_;
2077
2078 my @neigh; # diagonal neighbours
2079
2080 for (0 .. 3) {
2081 my $neigh = $map->tile_path ($_)
2082 or next;
2083 $neigh = find $neigh, $map
2084 or next;
2085 $neigh->load;
2086
2087 push @neigh,
2088 [$neigh->tile_path (($_ + 3) % 4), $neigh],
2089 [$neigh->tile_path (($_ + 1) % 4), $neigh];
2090 }
2091
2092 for (grep defined $_->[0], @neigh) {
2093 my ($path, $origin) = @$_;
2094 my $neigh = find $path, $origin
2095 or next;
2096 $neigh->load;
2097 }
1442} 2098}
1443 2099
1444sub find_sync { 2100sub find_sync {
1445 my ($path, $origin) = @_; 2101 my ($path, $origin) = @_;
1446 2102
1447 cf::sync_job { cf::map::find $path, $origin } 2103 cf::sync_job { find $path, $origin }
1448} 2104}
1449 2105
1450sub do_load_sync { 2106sub do_load_sync {
1451 my ($map) = @_; 2107 my ($map) = @_;
1452 2108
2109 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2110 if $Coro::current == $Coro::main;
2111
1453 cf::sync_job { $map->load }; 2112 cf::sync_job { $map->load };
2113}
2114
2115our %MAP_PREFETCH;
2116our $MAP_PREFETCHER = undef;
2117
2118sub find_async {
2119 my ($path, $origin, $load) = @_;
2120
2121 $path = normalise $path, $origin && $origin->{path};
2122
2123 if (my $map = $cf::MAP{$path}) {
2124 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
2125 }
2126
2127 $MAP_PREFETCH{$path} |= $load;
2128
2129 $MAP_PREFETCHER ||= cf::async {
2130 $Coro::current->{desc} = "map prefetcher";
2131
2132 while (%MAP_PREFETCH) {
2133 while (my ($k, $v) = each %MAP_PREFETCH) {
2134 if (my $map = find $k) {
2135 $map->load if $v;
2136 }
2137
2138 delete $MAP_PREFETCH{$k};
2139 }
2140 }
2141 undef $MAP_PREFETCHER;
2142 };
2143 $MAP_PREFETCHER->prio (6);
2144
2145 ()
1454} 2146}
1455 2147
1456sub save { 2148sub save {
1457 my ($self) = @_; 2149 my ($self) = @_;
1458 2150
1459 my $lock = cf::lock_acquire "map_data:" . $self->path; 2151 my $lock = cf::lock_acquire "map_data:$self->{path}";
1460 2152
1461 $self->{last_save} = $cf::RUNTIME; 2153 $self->{last_save} = $cf::RUNTIME;
1462 2154
1463 return unless $self->dirty; 2155 return unless $self->dirty;
1464 2156
1465 my $save = $self->{path}->save_path; utf8::encode $save; 2157 my $save = $self->save_path; utf8::encode $save;
1466 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2158 my $uniq = $self->uniq_path; utf8::encode $uniq;
1467 2159
1468 $self->{load_path} = $save; 2160 $self->{load_path} = $save;
1469 2161
1470 return if $self->{deny_save}; 2162 return if $self->{deny_save};
1471 2163
1472 local $self->{last_access} = $self->last_access;#d# 2164 local $self->{last_access} = $self->last_access;#d#
1473 2165
1474 cf::async { 2166 cf::async {
2167 $Coro::current->{desc} = "map player save";
1475 $_->contr->save for $self->players; 2168 $_->contr->save for $self->players;
1476 }; 2169 };
1477 2170
2171 cf::get_slot 0.02;
2172
1478 if ($uniq) { 2173 if ($uniq) {
1479 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2174 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1480 $self->save_objects ($uniq, cf::IO_UNIQUES); 2175 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1481 } else { 2176 } else {
1482 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2177 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1483 } 2178 }
1484} 2179}
1485 2180
1486sub swap_out { 2181sub swap_out {
1487 my ($self) = @_; 2182 my ($self) = @_;
1488 2183
1489 # save first because save cedes 2184 # save first because save cedes
1490 $self->save; 2185 $self->save;
1491 2186
1492 my $lock = cf::lock_acquire "map_data:" . $self->path; 2187 my $lock = cf::lock_acquire "map_data:$self->{path}";
1493 2188
1494 return if $self->players; 2189 return if $self->players;
1495 return if $self->in_memory != cf::MAP_IN_MEMORY; 2190 return if $self->in_memory != cf::MAP_ACTIVE;
1496 return if $self->{deny_save}; 2191 return if $self->{deny_save};
1497 2192
2193 $self->in_memory (cf::MAP_SWAPPED);
2194
2195 $self->deactivate;
2196 $_->clear_links_to ($self) for values %cf::MAP;
1498 $self->clear; 2197 $self->clear;
1499 $self->in_memory (cf::MAP_SWAPPED);
1500} 2198}
1501 2199
1502sub reset_at { 2200sub reset_at {
1503 my ($self) = @_; 2201 my ($self) = @_;
1504 2202
1505 # TODO: safety, remove and allow resettable per-player maps 2203 # TODO: safety, remove and allow resettable per-player maps
1506 return 1e99 if $self->{path}{user_rel};
1507 return 1e99 if $self->{deny_reset}; 2204 return 1e99 if $self->{deny_reset};
1508 2205
1509 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2206 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1510 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2207 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1511 2208
1516 my ($self) = @_; 2213 my ($self) = @_;
1517 2214
1518 $self->reset_at <= $cf::RUNTIME 2215 $self->reset_at <= $cf::RUNTIME
1519} 2216}
1520 2217
1521sub unlink_save {
1522 my ($self) = @_;
1523
1524 utf8::encode (my $save = $self->{path}->save_path);
1525 aioreq_pri 3; IO::AIO::aio_unlink $save;
1526 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1527}
1528
1529sub rename {
1530 my ($self, $new_path) = @_;
1531
1532 $self->unlink_save;
1533
1534 delete $cf::MAP{$self->path};
1535 $self->{path} = new cf::path $new_path;
1536 $self->path ($self->{path}->as_string);
1537 $cf::MAP{$self->path} = $self;
1538
1539 $self->save;
1540}
1541
1542sub reset { 2218sub reset {
1543 my ($self) = @_; 2219 my ($self) = @_;
1544 2220
1545 my $lock = cf::lock_acquire "map_data:" . $self->path; 2221 my $lock = cf::lock_acquire "map_data:$self->{path}";
1546 2222
1547 return if $self->players; 2223 return if $self->players;
1548 return if $self->{path}{user_rel};#d#
1549 2224
1550 warn "resetting map ", $self->path;#d# 2225 warn "resetting map ", $self->path;
2226
2227 $self->in_memory (cf::MAP_SWAPPED);
2228
2229 # need to save uniques path
2230 unless ($self->{deny_save}) {
2231 my $uniq = $self->uniq_path; utf8::encode $uniq;
2232
2233 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2234 if $uniq;
2235 }
1551 2236
1552 delete $cf::MAP{$self->path}; 2237 delete $cf::MAP{$self->path};
1553 2238
2239 $self->deactivate;
1554 $_->clear_links_to ($self) for values %cf::MAP; 2240 $_->clear_links_to ($self) for values %cf::MAP;
2241 $self->clear;
1555 2242
1556 $self->unlink_save; 2243 $self->unlink_save;
1557 $self->destroy; 2244 $self->destroy;
1558} 2245}
1559 2246
1560my $nuke_counter = "aaaa"; 2247my $nuke_counter = "aaaa";
1561 2248
1562sub nuke { 2249sub nuke {
1563 my ($self) = @_; 2250 my ($self) = @_;
1564 2251
2252 {
2253 my $lock = cf::lock_acquire "map_data:$self->{path}";
2254
2255 delete $cf::MAP{$self->path};
2256
2257 $self->unlink_save;
2258
2259 bless $self, "cf::map";
2260 delete $self->{deny_reset};
1565 $self->{deny_save} = 1; 2261 $self->{deny_save} = 1;
1566 $self->reset_timeout (1); 2262 $self->reset_timeout (1);
1567 $self->rename ("{nuke}/" . ($nuke_counter++)); 2263 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2264
2265 $cf::MAP{$self->path} = $self;
2266 }
2267
1568 $self->reset; # polite request, might not happen 2268 $self->reset; # polite request, might not happen
1569} 2269}
1570 2270
1571sub customise_for { 2271=item $maps = cf::map::tmp_maps
1572 my ($map, $ob) = @_;
1573 2272
1574 if ($map->per_player) { 2273Returns an arrayref with all map paths of currently instantiated and saved
1575 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2274maps. May block.
2275
2276=cut
2277
2278sub tmp_maps() {
1576 } 2279 [
1577 2280 map {
1578 $map 2281 utf8::decode $_;
2282 /\.map$/
2283 ? normalise $_
2284 : ()
2285 } @{ aio_readdir $TMPDIR or [] }
2286 ]
1579} 2287}
1580 2288
1581package cf; 2289=item $maps = cf::map::random_maps
2290
2291Returns an arrayref with all map paths of currently instantiated and saved
2292random maps. May block.
2293
2294=cut
2295
2296sub random_maps() {
2297 [
2298 map {
2299 utf8::decode $_;
2300 /\.map$/
2301 ? normalise "?random/$_"
2302 : ()
2303 } @{ aio_readdir $RANDOMDIR or [] }
2304 ]
2305}
2306
2307=item cf::map::unique_maps
2308
2309Returns an arrayref of paths of all shared maps that have
2310instantiated unique items. May block.
2311
2312=cut
2313
2314sub unique_maps() {
2315 [
2316 map {
2317 utf8::decode $_;
2318 s/\.map$//; # TODO future compatibility hack
2319 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
2320 ? ()
2321 : normalise $_
2322 } @{ aio_readdir $UNIQUEDIR or [] }
2323 ]
2324}
1582 2325
1583=back 2326=back
1584 2327
1585=head3 cf::object 2328=head3 cf::object
1586 2329
1590 2333
1591=over 4 2334=over 4
1592 2335
1593=item $ob->inv_recursive 2336=item $ob->inv_recursive
1594 2337
1595Returns the inventory of the object _and_ their inventories, recursively. 2338Returns the inventory of the object I<and> their inventories, recursively,
2339but I<not> the object itself.
1596 2340
1597=cut 2341=cut
1598 2342
1599sub inv_recursive_; 2343sub inv_recursive_;
1600sub inv_recursive_ { 2344sub inv_recursive_ {
1603 2347
1604sub inv_recursive { 2348sub inv_recursive {
1605 inv_recursive_ inv $_[0] 2349 inv_recursive_ inv $_[0]
1606} 2350}
1607 2351
2352=item $ref = $ob->ref
2353
2354Creates and returns a persistent reference to an object that can be stored as a string.
2355
2356=item $ob = cf::object::deref ($refstring)
2357
2358returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2359even if the object actually exists. May block.
2360
2361=cut
2362
2363sub deref {
2364 my ($ref) = @_;
2365
2366 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2367 my ($uuid, $name) = ($1, $2);
2368 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2369 or return;
2370 $pl->ob->uuid eq $uuid
2371 or return;
2372
2373 $pl->ob
2374 } else {
2375 warn "$ref: cannot resolve object reference\n";
2376 undef
2377 }
2378}
2379
1608package cf; 2380package cf;
1609 2381
1610=back 2382=back
1611 2383
1612=head3 cf::object::player 2384=head3 cf::object::player
1618Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2390Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1619can be C<undef>. Does the right thing when the player is currently in a 2391can be C<undef>. Does the right thing when the player is currently in a
1620dialogue with the given NPC character. 2392dialogue with the given NPC character.
1621 2393
1622=cut 2394=cut
2395
2396our $SAY_CHANNEL = {
2397 id => "say",
2398 title => "Map",
2399 reply => "say ",
2400 tooltip => "Things said to and replied from npcs near you and other players on the same map only.",
2401};
2402
2403our $CHAT_CHANNEL = {
2404 id => "chat",
2405 title => "Chat",
2406 reply => "chat ",
2407 tooltip => "Player chat and shouts, global to the server.",
2408};
1623 2409
1624# rough implementation of a future "reply" method that works 2410# rough implementation of a future "reply" method that works
1625# with dialog boxes. 2411# with dialog boxes.
1626#TODO: the first argument must go, split into a $npc->reply_to ( method 2412#TODO: the first argument must go, split into a $npc->reply_to ( method
1627sub cf::object::player::reply($$$;$) { 2413sub cf::object::player::reply($$$;$) {
1629 2415
1630 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2416 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1631 2417
1632 if ($self->{record_replies}) { 2418 if ($self->{record_replies}) {
1633 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2419 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2420
1634 } else { 2421 } else {
2422 my $pl = $self->contr;
2423
2424 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2425 my $dialog = $pl->{npc_dialog};
2426 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2427
2428 } else {
1635 $msg = $npc->name . " says: $msg" if $npc; 2429 $msg = $npc->name . " says: $msg" if $npc;
1636 $self->message ($msg, $flags); 2430 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2431 }
1637 } 2432 }
2433}
2434
2435=item $object->send_msg ($channel, $msg, $color, [extra...])
2436
2437=cut
2438
2439sub cf::object::send_msg {
2440 my $pl = shift->contr
2441 or return;
2442 $pl->send_msg (@_);
1638} 2443}
1639 2444
1640=item $player_object->may ("access") 2445=item $player_object->may ("access")
1641 2446
1642Returns wether the given player is authorized to access resource "access" 2447Returns wether the given player is authorized to access resource "access"
1655 2460
1656=item $player_object->enter_link 2461=item $player_object->enter_link
1657 2462
1658Freezes the player and moves him/her to a special map (C<{link}>). 2463Freezes the player and moves him/her to a special map (C<{link}>).
1659 2464
1660The player should be reaosnably safe there for short amounts of time. You 2465The player should be reasonably safe there for short amounts of time (e.g.
1661I<MUST> call C<leave_link> as soon as possible, though. 2466for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2467though, as the palyer cannot control the character while it is on the link
2468map.
2469
2470Will never block.
1662 2471
1663=item $player_object->leave_link ($map, $x, $y) 2472=item $player_object->leave_link ($map, $x, $y)
1664 2473
1665Moves the player out of the specila link map onto the given map. If the 2474Moves the player out of the special C<{link}> map onto the specified
1666map is not valid (or omitted), the player will be moved back to the 2475map. If the map is not valid (or omitted), the player will be moved back
1667location he/she was before the call to C<enter_link>, or, if that fails, 2476to the location he/she was before the call to C<enter_link>, or, if that
1668to the emergency map position. 2477fails, to the emergency map position.
1669 2478
1670Might block. 2479Might block.
1671 2480
1672=cut 2481=cut
2482
2483sub link_map {
2484 unless ($LINK_MAP) {
2485 $LINK_MAP = cf::map::find "{link}"
2486 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2487 $LINK_MAP->load;
2488 }
2489
2490 $LINK_MAP
2491}
1673 2492
1674sub cf::object::player::enter_link { 2493sub cf::object::player::enter_link {
1675 my ($self) = @_; 2494 my ($self) = @_;
1676 2495
1677 $self->deactivate_recursive; 2496 $self->deactivate_recursive;
1678 2497
1679 return if $self->map == $LINK_MAP; 2498 return if UNIVERSAL::isa $self->map, "ext::map_link";
1680 2499
1681 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2500 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1682 if $self->map; 2501 if $self->map && $self->map->{path} ne "{link}";
1683 2502
1684 $self->enter_map ($LINK_MAP, 20, 20); 2503 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1685} 2504}
1686 2505
1687sub cf::object::player::leave_link { 2506sub cf::object::player::leave_link {
1688 my ($self, $map, $x, $y) = @_; 2507 my ($self, $map, $x, $y) = @_;
2508
2509 return unless $self->contr->active;
1689 2510
1690 my $link_pos = delete $self->{_link_pos}; 2511 my $link_pos = delete $self->{_link_pos};
1691 2512
1692 unless ($map) { 2513 unless ($map) {
1693 # restore original map position 2514 # restore original map position
1707 # use -1 or undef as default coordinates, not 0, 0 2528 # use -1 or undef as default coordinates, not 0, 0
1708 ($x, $y) = ($map->enter_x, $map->enter_y) 2529 ($x, $y) = ($map->enter_x, $map->enter_y)
1709 if $x <=0 && $y <= 0; 2530 if $x <=0 && $y <= 0;
1710 2531
1711 $map->load; 2532 $map->load;
2533 $map->load_neighbours;
1712 2534
1713 return unless $self->contr->active; 2535 return unless $self->contr->active;
2536 $self->flag (cf::FLAG_DEBUG, 0);#d# temp
1714 $self->activate_recursive; 2537 $self->activate_recursive;
2538
2539 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1715 $self->enter_map ($map, $x, $y); 2540 $self->enter_map ($map, $x, $y);
1716} 2541}
1717 2542
1718cf::player->attach ( 2543=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1719 on_logout => sub {
1720 my ($pl) = @_;
1721 2544
1722 # abort map switching before logout 2545Moves the player to the given map-path and coordinates by first freezing
1723 if ($pl->ob->{_link_pos}) { 2546her, loading and preparing them map, calling the provided $check callback
1724 cf::sync_job { 2547that has to return the map if sucecssful, and then unfreezes the player on
1725 $pl->ob->leave_link 2548the new (success) or old (failed) map position. In either case, $done will
1726 }; 2549be called at the end of this process.
1727 }
1728 },
1729 on_login => sub {
1730 my ($pl) = @_;
1731 2550
1732 # try to abort aborted map switching on player login :) 2551Note that $check will be called with a potentially non-loaded map, so if
1733 # should happen only on crashes 2552it needs a loaded map it has to call C<< ->load >>.
1734 if ($pl->ob->{_link_pos}) {
1735 $pl->ob->enter_link;
1736 (async {
1737 # we need this sleep as the login has a concurrent enter_exit running
1738 # and this sleep increases chances of the player not ending up in scorn
1739 $pl->ob->reply (undef,
1740 "There was an internal problem at your last logout, "
1741 . "the server will try to bring you to your intended destination in a second.",
1742 cf::NDI_RED);
1743 Coro::Timer::sleep 1;
1744 $pl->ob->leave_link;
1745 })->prio (2);
1746 }
1747 },
1748);
1749 2553
1750=item $player_object->goto ($path, $x, $y)
1751
1752=cut 2554=cut
2555
2556our $GOTOGEN;
1753 2557
1754sub cf::object::player::goto { 2558sub cf::object::player::goto {
1755 my ($self, $path, $x, $y) = @_; 2559 my ($self, $path, $x, $y, $check, $done) = @_;
1756 2560
1757 $path = new cf::path $path; 2561 # do generation counting so two concurrent goto's will be executed in-order
1758 $path ne "/" or Carp::cluck ("oy");#d# 2562 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1759 2563
1760 $self->enter_link; 2564 $self->enter_link;
1761 2565
1762 (async { 2566 (async {
1763 my $map = cf::map::find $path->as_string; 2567 $Coro::current->{desc} = "player::goto $path $x $y";
2568
2569 # *tag paths override both path and x|y
2570 if ($path =~ /^\*(.*)$/) {
2571 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2572 my $ob = $obs[rand @obs];
2573
2574 # see if we actually can go there
2575 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2576 $ob = $obs[rand @obs];
2577 } else {
2578 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2579 }
2580 # else put us there anyways for now #d#
2581
2582 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2583 } else {
2584 ($path, $x, $y) = (undef, undef, undef);
2585 }
2586 }
2587
2588 my $map = eval {
2589 my $map = defined $path ? cf::map::find $path : undef;
2590
2591 if ($map) {
1764 $map = $map->customise_for ($self) if $map; 2592 $map = $map->customise_for ($self);
1765 2593 $map = $check->($map) if $check && $map;
1766# warn "entering ", $map->path, " at ($x, $y)\n" 2594 } else {
1767# if $map;
1768
1769 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2595 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2596 }
1770 2597
2598 $map
2599 };
2600
2601 if ($@) {
2602 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2603 LOG llevError | logBacktrace, Carp::longmess $@;
2604 }
2605
2606 if ($gen == $self->{_goto_generation}) {
2607 delete $self->{_goto_generation};
1771 $self->leave_link ($map, $x, $y); 2608 $self->leave_link ($map, $x, $y);
2609 }
2610
2611 $done->() if $done;
1772 })->prio (1); 2612 })->prio (1);
1773} 2613}
1774 2614
1775=item $player_object->enter_exit ($exit_object) 2615=item $player_object->enter_exit ($exit_object)
1776 2616
1778 2618
1779sub parse_random_map_params { 2619sub parse_random_map_params {
1780 my ($spec) = @_; 2620 my ($spec) = @_;
1781 2621
1782 my $rmp = { # defaults 2622 my $rmp = { # defaults
1783 xsize => 10, 2623 xsize => (cf::rndm 15, 40),
1784 ysize => 10, 2624 ysize => (cf::rndm 15, 40),
2625 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2626 #layout => string,
1785 }; 2627 };
1786 2628
1787 for (split /\n/, $spec) { 2629 for (split /\n/, $spec) {
1788 my ($k, $v) = split /\s+/, $_, 2; 2630 my ($k, $v) = split /\s+/, $_, 2;
1789 2631
1801 # that depends on the exit object 2643 # that depends on the exit object
1802 2644
1803 my $rmp = parse_random_map_params $exit->msg; 2645 my $rmp = parse_random_map_params $exit->msg;
1804 2646
1805 if ($exit->map) { 2647 if ($exit->map) {
1806 $rmp->{region} = $exit->map->region_name; 2648 $rmp->{region} = $exit->region->name;
1807 $rmp->{origin_map} = $exit->map->path; 2649 $rmp->{origin_map} = $exit->map->path;
1808 $rmp->{origin_x} = $exit->x; 2650 $rmp->{origin_x} = $exit->x;
1809 $rmp->{origin_y} = $exit->y; 2651 $rmp->{origin_y} = $exit->y;
2652
2653 $exit->map->touch;
1810 } 2654 }
1811 2655
1812 $rmp->{random_seed} ||= $exit->random_seed; 2656 $rmp->{random_seed} ||= $exit->random_seed;
1813 2657
1814 my $data = cf::to_json $rmp; 2658 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1815 my $md5 = Digest::MD5::md5_hex $data; 2659 my $md5 = Digest::MD5::md5_hex $data;
2660 my $meta = "$RANDOMDIR/$md5.meta";
1816 2661
1817 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2662 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1818 aio_write $fh, 0, (length $data), $data, 0; 2663 aio_write $fh, 0, (length $data), $data, 0;
2664 undef $fh;
2665 aio_rename "$meta~", $meta;
1819 2666
2667 my $slaying = "?random/$md5";
2668
2669 if ($exit->valid) {
1820 $exit->slaying ("?random/$md5"); 2670 $exit->slaying ("?random/$md5");
1821 $exit->msg (undef); 2671 $exit->msg (undef);
2672 }
1822 } 2673 }
1823} 2674}
1824 2675
1825sub cf::object::player::enter_exit { 2676sub cf::object::player::enter_exit {
1826 my ($self, $exit) = @_; 2677 my ($self, $exit) = @_;
1828 return unless $self->type == cf::PLAYER; 2679 return unless $self->type == cf::PLAYER;
1829 2680
1830 $self->enter_link; 2681 $self->enter_link;
1831 2682
1832 (async { 2683 (async {
1833 $self->deactivate_recursive; # just to be sure 2684 $Coro::current->{desc} = "enter_exit";
2685
1834 unless (eval { 2686 unless (eval {
2687 $self->deactivate_recursive; # just to be sure
2688
2689 # random map handling
2690 {
2691 my $guard = cf::lock_acquire "exit_prepare:$exit";
2692
1835 prepare_random_map $exit 2693 prepare_random_map $exit
1836 if $exit->slaying eq "/!"; 2694 if $exit->slaying eq "/!";
2695 }
1837 2696
1838 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path; 2697 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1839 $self->goto ($path, $exit->stats->hp, $exit->stats->sp); 2698 my $x = $exit->stats->hp;
2699 my $y = $exit->stats->sp;
1840 2700
2701 $self->goto ($map, $x, $y);
2702
2703 # if exit is damned, update players death & WoR home-position
2704 $self->contr->savebed ($map, $x, $y)
2705 if $exit->flag (cf::FLAG_DAMNED);
2706
1841 1; 2707 1
1842 }) { 2708 }) {
1843 $self->message ("Something went wrong deep within the crossfire server. " 2709 $self->message ("Something went wrong deep within the deliantra server. "
1844 . "I'll try to bring you back to the map you were before. " 2710 . "I'll try to bring you back to the map you were before. "
1845 . "Please report this to the dungeon master", 2711 . "Please report this to the dungeon master!",
1846 cf::NDI_UNIQUE | cf::NDI_RED); 2712 cf::NDI_UNIQUE | cf::NDI_RED);
1847 2713
1848 warn "ERROR in enter_exit: $@"; 2714 warn "ERROR in enter_exit: $@";
1849 $self->leave_link; 2715 $self->leave_link;
1850 } 2716 }
1851 })->prio (1); 2717 })->prio (1);
1864 2730
1865sub cf::client::send_drawinfo { 2731sub cf::client::send_drawinfo {
1866 my ($self, $text, $flags) = @_; 2732 my ($self, $text, $flags) = @_;
1867 2733
1868 utf8::encode $text; 2734 utf8::encode $text;
1869 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2735 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1870} 2736}
1871 2737
2738=item $client->send_msg ($channel, $msg, $color, [extra...])
2739
2740Send a drawinfo or msg packet to the client, formatting the msg for the
2741client if neccessary. C<$type> should be a string identifying the type of
2742the message, with C<log> being the default. If C<$color> is negative, suppress
2743the message unless the client supports the msg packet.
2744
2745=cut
2746
2747# non-persistent channels (usually the info channel)
2748our %CHANNEL = (
2749 "c/identify" => {
2750 id => "infobox",
2751 title => "Identify",
2752 reply => undef,
2753 tooltip => "Items recently identified",
2754 },
2755 "c/examine" => {
2756 id => "infobox",
2757 title => "Examine",
2758 reply => undef,
2759 tooltip => "Signs and other items you examined",
2760 },
2761 "c/book" => {
2762 id => "infobox",
2763 title => "Book",
2764 reply => undef,
2765 tooltip => "The contents of a note or book",
2766 },
2767 "c/lookat" => {
2768 id => "infobox",
2769 title => "Look",
2770 reply => undef,
2771 tooltip => "What you saw there",
2772 },
2773 "c/who" => {
2774 id => "infobox",
2775 title => "Players",
2776 reply => undef,
2777 tooltip => "Shows players who are currently online",
2778 },
2779 "c/body" => {
2780 id => "infobox",
2781 title => "Body Parts",
2782 reply => undef,
2783 tooltip => "Shows which body parts you posess and are available",
2784 },
2785 "c/skills" => {
2786 id => "infobox",
2787 title => "Skills",
2788 reply => undef,
2789 tooltip => "Shows your experience per skill and item power",
2790 },
2791 "c/uptime" => {
2792 id => "infobox",
2793 title => "Uptime",
2794 reply => undef,
2795 tooltip => "How long the server has been running since last restart",
2796 },
2797 "c/mapinfo" => {
2798 id => "infobox",
2799 title => "Map Info",
2800 reply => undef,
2801 tooltip => "Information related to the maps",
2802 },
2803 "c/party" => {
2804 id => "party",
2805 title => "Party",
2806 reply => "gsay ",
2807 tooltip => "Messages and chat related to your party",
2808 },
2809);
2810
2811sub cf::client::send_msg {
2812 my ($self, $channel, $msg, $color, @extra) = @_;
2813
2814 $msg = $self->pl->expand_cfpod ($msg)
2815 unless $color & cf::NDI_VERBATIM;
2816
2817 $color &= cf::NDI_CLIENT_MASK; # just in case...
2818
2819 # check predefined channels, for the benefit of C
2820 if ($CHANNEL{$channel}) {
2821 $channel = $CHANNEL{$channel};
2822
2823 $self->ext_msg (channel_info => $channel)
2824 if $self->can_msg;
2825
2826 $channel = $channel->{id};
2827
2828 } elsif (ref $channel) {
2829 # send meta info to client, if not yet sent
2830 unless (exists $self->{channel}{$channel->{id}}) {
2831 $self->{channel}{$channel->{id}} = $channel;
2832 $self->ext_msg (channel_info => $channel)
2833 if $self->can_msg;
2834 }
2835
2836 $channel = $channel->{id};
2837 }
2838
2839 return unless @extra || length $msg;
2840
2841 if ($self->can_msg) {
2842 # default colour, mask it out
2843 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2844 if $color & cf::NDI_DEF;
2845
2846 my $pkt = "msg "
2847 . $self->{json_coder}->encode (
2848 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
2849 );
2850
2851 # try lzf for large packets
2852 $pkt = "lzf " . Compress::LZF::compress $pkt
2853 if 1024 <= length $pkt and $self->{can_lzf};
2854
2855 # split very large packets
2856 if (8192 < length $pkt and $self->{can_lzf}) {
2857 $self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
2858 $pkt = "frag";
2859 }
2860
2861 $self->send_packet ($pkt);
2862 } else {
2863 if ($color >= 0) {
2864 # replace some tags by gcfclient-compatible ones
2865 for ($msg) {
2866 1 while
2867 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2868 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2869 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2870 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2871 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2872 }
2873
2874 $color &= cf::NDI_COLOR_MASK;
2875
2876 utf8::encode $msg;
2877
2878 if (0 && $msg =~ /\[/) {
2879 # COMMAND/INFO
2880 $self->send_packet ("drawextinfo $color 10 8 $msg")
2881 } else {
2882 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2883 $self->send_packet ("drawinfo $color $msg")
2884 }
2885 }
2886 }
2887}
2888
2889=item $client->ext_msg ($type, @msg)
2890
2891Sends an ext event to the client.
2892
2893=cut
2894
2895sub cf::client::ext_msg($$@) {
2896 my ($self, $type, @msg) = @_;
2897
2898 if ($self->extcmd == 2) {
2899 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2900 } elsif ($self->extcmd == 1) { # TODO: remove
2901 push @msg, msgtype => "event_$type";
2902 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2903 }
2904}
2905
2906=item $client->ext_reply ($msgid, @msg)
2907
2908Sends an ext reply to the client.
2909
2910=cut
2911
2912sub cf::client::ext_reply($$@) {
2913 my ($self, $id, @msg) = @_;
2914
2915 if ($self->extcmd == 2) {
2916 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2917 } elsif ($self->extcmd == 1) {
2918 #TODO: version 1, remove
2919 unshift @msg, msgtype => "reply", msgid => $id;
2920 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2921 }
2922}
1872 2923
1873=item $success = $client->query ($flags, "text", \&cb) 2924=item $success = $client->query ($flags, "text", \&cb)
1874 2925
1875Queues a query to the client, calling the given callback with 2926Queues a query to the client, calling the given callback with
1876the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2927the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1877C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2928C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1878 2929
1879Queries can fail, so check the return code. Or don't, as queries will become 2930Queries can fail, so check the return code. Or don't, as queries will
1880reliable at some point in the future. 2931become reliable at some point in the future.
1881 2932
1882=cut 2933=cut
1883 2934
1884sub cf::client::query { 2935sub cf::client::query {
1885 my ($self, $flags, $text, $cb) = @_; 2936 my ($self, $flags, $text, $cb) = @_;
1893 utf8::encode $text; 2944 utf8::encode $text;
1894 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2945 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1895 2946
1896 $self->send_packet ($self->{query_queue}[0][0]) 2947 $self->send_packet ($self->{query_queue}[0][0])
1897 if @{ $self->{query_queue} } == 1; 2948 if @{ $self->{query_queue} } == 1;
2949
2950 1
1898} 2951}
1899 2952
1900cf::client->attach ( 2953cf::client->attach (
2954 on_connect => sub {
2955 my ($ns) = @_;
2956
2957 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2958 },
1901 on_reply => sub { 2959 on_reply => sub {
1902 my ($ns, $msg) = @_; 2960 my ($ns, $msg) = @_;
1903 2961
1904 # this weird shuffling is so that direct followup queries 2962 # this weird shuffling is so that direct followup queries
1905 # get handled first 2963 # get handled first
1906 my $queue = delete $ns->{query_queue} 2964 my $queue = delete $ns->{query_queue}
1907 or return; # be conservative, not sure how that can happen, but we saw a crash here 2965 or return; # be conservative, not sure how that can happen, but we saw a crash here
1908 2966
1909 (shift @$queue)->[1]->($msg); 2967 (shift @$queue)->[1]->($msg);
2968 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1910 2969
1911 push @{ $ns->{query_queue} }, @$queue; 2970 push @{ $ns->{query_queue} }, @$queue;
1912 2971
1913 if (@{ $ns->{query_queue} } == @$queue) { 2972 if (@{ $ns->{query_queue} } == @$queue) {
1914 if (@$queue) { 2973 if (@$queue) {
1916 } else { 2975 } else {
1917 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2976 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1918 } 2977 }
1919 } 2978 }
1920 }, 2979 },
2980 on_exticmd => sub {
2981 my ($ns, $buf) = @_;
2982
2983 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2984
2985 if (ref $msg) {
2986 my ($type, $reply, @payload) =
2987 "ARRAY" eq ref $msg
2988 ? @$msg
2989 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2990
2991 my @reply;
2992
2993 if (my $cb = $EXTICMD{$type}) {
2994 @reply = $cb->($ns, @payload);
2995 }
2996
2997 $ns->ext_reply ($reply, @reply)
2998 if $reply;
2999
3000 } else {
3001 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3002 }
3003
3004 cf::override;
3005 },
1921); 3006);
1922 3007
1923=item $client->async (\&cb) 3008=item $client->async (\&cb)
1924 3009
1925Create a new coroutine, running the specified callback. The coroutine will 3010Create a new coroutine, running the specified callback. The coroutine will
1966our $safe = new Safe "safe"; 3051our $safe = new Safe "safe";
1967our $safe_hole = new Safe::Hole; 3052our $safe_hole = new Safe::Hole;
1968 3053
1969$SIG{FPE} = 'IGNORE'; 3054$SIG{FPE} = 'IGNORE';
1970 3055
1971$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3056$safe->permit_only (Opcode::opset qw(
3057 :base_core :base_mem :base_orig :base_math
3058 grepstart grepwhile mapstart mapwhile
3059 sort time
3060));
1972 3061
1973# here we export the classes and methods available to script code 3062# here we export the classes and methods available to script code
1974 3063
1975=pod 3064=pod
1976 3065
1977The following fucntions and emthods are available within a safe environment: 3066The following functions and methods are available within a safe environment:
1978 3067
1979 cf::object contr pay_amount pay_player map 3068 cf::object
3069 contr pay_amount pay_player map x y force_find force_add destroy
3070 insert remove name archname title slaying race decrease split
3071
1980 cf::object::player player 3072 cf::object::player
1981 cf::player peaceful 3073 player
1982 cf::map trigger 3074
3075 cf::player
3076 peaceful
3077
3078 cf::map
3079 trigger
1983 3080
1984=cut 3081=cut
1985 3082
1986for ( 3083for (
1987 ["cf::object" => qw(contr pay_amount pay_player map)], 3084 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3085 insert remove inv nrof name archname title slaying race
3086 decrease split destroy change_exp)],
1988 ["cf::object::player" => qw(player)], 3087 ["cf::object::player" => qw(player)],
1989 ["cf::player" => qw(peaceful)], 3088 ["cf::player" => qw(peaceful)],
1990 ["cf::map" => qw(trigger)], 3089 ["cf::map" => qw(trigger)],
1991) { 3090) {
1992 no strict 'refs'; 3091 no strict 'refs';
2063=back 3162=back
2064 3163
2065=cut 3164=cut
2066 3165
2067############################################################################# 3166#############################################################################
3167# the server's init and main functions
2068 3168
2069=head2 EXTENSION DATABASE SUPPORT 3169sub load_facedata($) {
3170 my ($path) = @_;
2070 3171
2071Crossfire maintains a very simple database for extension use. It can 3172 # HACK to clear player env face cache, we need some signal framework
2072currently store anything that can be serialised using Storable, which 3173 # for this (global event?)
2073excludes objects. 3174 %ext::player_env::MUSIC_FACE_CACHE = ();
2074 3175
2075The parameter C<$family> should best start with the name of the extension 3176 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2076using it, it should be unique.
2077 3177
2078=over 4 3178 warn "loading facedata from $path\n";
2079 3179
2080=item $hashref = cf::db_get $family 3180 my $facedata;
3181 0 < aio_load $path, $facedata
3182 or die "$path: $!";
2081 3183
2082Return a hashref for use by the extension C<$family>, which can be 3184 $facedata = Coro::Storable::thaw $facedata;
2083modified. After modifications, you have to call C<cf::db_dirty> or
2084C<cf::db_sync>.
2085 3185
2086=item $value = cf::db_get $family => $key 3186 $facedata->{version} == 2
3187 or cf::cleanup "$path: version mismatch, cannot proceed.";
2087 3188
2088Returns a single value from the database 3189 # patch in the exptable
2089 3190 $facedata->{resource}{"res/exp_table"} = {
2090=item cf::db_put $family => $hashref 3191 type => FT_RSRC,
2091 3192 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2092Stores the given family hashref into the database. Updates are delayed, if
2093you want the data to be synced to disk immediately, use C<cf::db_sync>.
2094
2095=item cf::db_put $family => $key => $value
2096
2097Stores the given C<$value> in the family hash. Updates are delayed, if you
2098want the data to be synced to disk immediately, use C<cf::db_sync>.
2099
2100=item cf::db_dirty
2101
2102Marks the database as dirty, to be updated at a later time.
2103
2104=item cf::db_sync
2105
2106Immediately write the database to disk I<if it is dirty>.
2107
2108=cut
2109
2110our $DB;
2111
2112{
2113 my $path = cf::localdir . "/database.pst";
2114
2115 sub db_load() {
2116 $DB = stat $path ? Storable::retrieve $path : { };
2117 }
2118
2119 my $pid;
2120
2121 sub db_save() {
2122 waitpid $pid, 0 if $pid;
2123 if (0 == ($pid = fork)) {
2124 $DB->{_meta}{version} = 1;
2125 Storable::nstore $DB, "$path~";
2126 rename "$path~", $path;
2127 cf::_exit 0 if defined $pid;
2128 }
2129 }
2130
2131 my $dirty;
2132
2133 sub db_sync() {
2134 db_save if $dirty;
2135 undef $dirty;
2136 }
2137
2138 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2139 db_sync;
2140 }); 3193 };
3194 cf::cede_to_tick;
2141 3195
2142 sub db_dirty() {
2143 $dirty = 1;
2144 $idle->start;
2145 } 3196 {
3197 my $faces = $facedata->{faceinfo};
2146 3198
2147 sub db_get($;$) { 3199 while (my ($face, $info) = each %$faces) {
2148 @_ >= 2 3200 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2149 ? $DB->{$_[0]}{$_[1]}
2150 : ($DB->{$_[0]} ||= { })
2151 }
2152 3201
2153 sub db_put($$;$) { 3202 cf::face::set_visibility $idx, $info->{visibility};
2154 if (@_ >= 3) { 3203 cf::face::set_magicmap $idx, $info->{magicmap};
2155 $DB->{$_[0]}{$_[1]} = $_[2]; 3204 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2156 } else { 3205 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2157 $DB->{$_[0]} = $_[1];
2158 }
2159 db_dirty;
2160 }
2161 3206
2162 cf::global->attach ( 3207 cf::cede_to_tick;
2163 prio => 10000,
2164 on_cleanup => sub {
2165 db_sync;
2166 }, 3208 }
2167 );
2168}
2169 3209
2170############################################################################# 3210 while (my ($face, $info) = each %$faces) {
2171# the server's main() 3211 next unless $info->{smooth};
2172 3212
2173sub cfg_load { 3213 my $idx = cf::face::find $face
3214 or next;
3215
3216 if (my $smooth = cf::face::find $info->{smooth}) {
3217 cf::face::set_smooth $idx, $smooth;
3218 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3219 } else {
3220 warn "smooth face '$info->{smooth}' not found for face '$face'";
3221 }
3222
3223 cf::cede_to_tick;
3224 }
3225 }
3226
3227 {
3228 my $anims = $facedata->{animinfo};
3229
3230 while (my ($anim, $info) = each %$anims) {
3231 cf::anim::set $anim, $info->{frames}, $info->{facings};
3232 cf::cede_to_tick;
3233 }
3234
3235 cf::anim::invalidate_all; # d'oh
3236 }
3237
3238 {
3239 # TODO: for gcfclient pleasure, we should give resources
3240 # that gcfclient doesn't grok a >10000 face index.
3241 my $res = $facedata->{resource};
3242
3243 while (my ($name, $info) = each %$res) {
3244 if (defined $info->{type}) {
3245 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3246 my $data;
3247
3248 if ($info->{type} & 1) {
3249 # prepend meta info
3250
3251 my $meta = $enc->encode ({
3252 name => $name,
3253 %{ $info->{meta} || {} },
3254 });
3255
3256 $data = pack "(w/a*)*", $meta, $info->{data};
3257 } else {
3258 $data = $info->{data};
3259 }
3260
3261 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3262 cf::face::set_type $idx, $info->{type};
3263 } else {
3264 $RESOURCE{$name} = $info;
3265 }
3266
3267 cf::cede_to_tick;
3268 }
3269 }
3270
3271 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3272
3273 1
3274}
3275
3276cf::global->attach (on_resource_update => sub {
3277 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3278 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3279
3280 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3281 my $sound = $soundconf->{compat}[$_]
3282 or next;
3283
3284 my $face = cf::face::find "sound/$sound->[1]";
3285 cf::sound::set $sound->[0] => $face;
3286 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3287 }
3288
3289 while (my ($k, $v) = each %{$soundconf->{event}}) {
3290 my $face = cf::face::find "sound/$v";
3291 cf::sound::set $k => $face;
3292 }
3293 }
3294});
3295
3296register_exticmd fx_want => sub {
3297 my ($ns, $want) = @_;
3298
3299 while (my ($k, $v) = each %$want) {
3300 $ns->fx_want ($k, $v);
3301 }
3302};
3303
3304sub load_resource_file($) {
3305 my $guard = lock_acquire "load_resource_file";
3306
3307 my $status = load_resource_file_ $_[0];
3308 get_slot 0.1, 100;
3309 cf::arch::commit_load;
3310
3311 $status
3312}
3313
3314sub reload_regions {
3315 # HACK to clear player env face cache, we need some signal framework
3316 # for this (global event?)
3317 %ext::player_env::MUSIC_FACE_CACHE = ();
3318
3319 load_resource_file "$MAPDIR/regions"
3320 or die "unable to load regions file\n";
3321
3322 for (cf::region::list) {
3323 $_->{match} = qr/$_->{match}/
3324 if exists $_->{match};
3325 }
3326}
3327
3328sub reload_facedata {
3329 load_facedata "$DATADIR/facedata"
3330 or die "unable to load facedata\n";
3331}
3332
3333sub reload_archetypes {
3334 load_resource_file "$DATADIR/archetypes"
3335 or die "unable to load archetypes\n";
3336}
3337
3338sub reload_treasures {
3339 load_resource_file "$DATADIR/treasures"
3340 or die "unable to load treasurelists\n";
3341}
3342
3343sub reload_resources {
3344 warn "reloading resource files...\n";
3345
3346 reload_facedata;
3347 reload_archetypes;
3348 reload_regions;
3349 reload_treasures;
3350
3351 warn "finished reloading resource files\n";
3352}
3353
3354sub reload_config {
2174 open my $fh, "<:utf8", cf::confdir . "/config" 3355 open my $fh, "<:utf8", "$CONFDIR/config"
2175 or return; 3356 or return;
2176 3357
2177 local $/; 3358 local $/;
2178 *CFG = YAML::Syck::Load <$fh>; 3359 *CFG = YAML::Load <$fh>;
2179 3360
2180 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3361 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2181 3362
2182 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3363 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2183 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3364 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2189 }; 3370 };
2190 warn $@ if $@; 3371 warn $@ if $@;
2191 } 3372 }
2192} 3373}
2193 3374
3375sub pidfile() {
3376 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3377 or die "$PIDFILE: $!";
3378 flock $fh, &Fcntl::LOCK_EX
3379 or die "$PIDFILE: flock: $!";
3380 $fh
3381}
3382
3383# make sure only one server instance is running at any one time
3384sub atomic {
3385 my $fh = pidfile;
3386
3387 my $pid = <$fh>;
3388 kill 9, $pid if $pid > 0;
3389
3390 seek $fh, 0, 0;
3391 print $fh $$;
3392}
3393
2194sub main { 3394sub main {
3395 cf::init_globals; # initialise logging
3396
3397 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3398 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3399 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3400 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3401
3402 cf::init_experience;
3403 cf::init_anim;
3404 cf::init_attackmess;
3405 cf::init_dynamic;
3406 cf::init_block;
3407
3408 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3409
2195 # we must not ever block the main coroutine 3410 # we must not ever block the main coroutine
2196 local $Coro::idle = sub { 3411 local $Coro::idle = sub {
2197 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3412 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2198 async { Event::one_event }; 3413 (async {
3414 $Coro::current->{desc} = "IDLE BUG HANDLER";
3415 EV::loop EV::LOOP_ONESHOT;
3416 })->prio (Coro::PRIO_MAX);
2199 }; 3417 };
2200 3418
2201 cfg_load; 3419 evthread_start IO::AIO::poll_fileno;
2202 db_load; 3420
3421 cf::sync_job {
3422 reload_resources;
3423 reload_config;
3424 db_init;
3425
3426 cf::load_settings;
3427 cf::load_materials;
3428 cf::init_uuid;
3429 cf::init_signals;
3430 cf::init_commands;
3431 cf::init_skills;
3432
3433 cf::init_beforeplay;
3434
3435 atomic;
3436
2203 load_extensions; 3437 load_extensions;
3438
3439 utime time, time, $RUNTIMEFILE;
3440
3441 # no (long-running) fork's whatsoever before this point(!)
3442 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3443
3444 (pop @POST_INIT)->(0) while @POST_INIT;
3445 };
3446
2204 Event::loop; 3447 EV::loop;
2205} 3448}
2206 3449
2207############################################################################# 3450#############################################################################
2208# initialisation and cleanup 3451# initialisation and cleanup
2209 3452
2210# install some emergency cleanup handlers 3453# install some emergency cleanup handlers
2211BEGIN { 3454BEGIN {
3455 our %SIGWATCHER = ();
2212 for my $signal (qw(INT HUP TERM)) { 3456 for my $signal (qw(INT HUP TERM)) {
2213 Event->signal ( 3457 $SIGWATCHER{$signal} = EV::signal $signal, sub {
2214 data => WF_AUTOCANCEL,
2215 signal => $signal,
2216 cb => sub {
2217 cf::cleanup "SIG$signal"; 3458 cf::cleanup "SIG$signal";
2218 },
2219 ); 3459 };
3460 }
3461}
3462
3463sub write_runtime_sync {
3464 # first touch the runtime file to show we are still running:
3465 # the fsync below can take a very very long time.
3466
3467 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3468
3469 my $guard = cf::lock_acquire "write_runtime";
3470
3471 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3472 or return;
3473
3474 my $value = $cf::RUNTIME + 90 + 10;
3475 # 10 is the runtime save interval, for a monotonic clock
3476 # 60 allows for the watchdog to kill the server.
3477
3478 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3479 and return;
3480
3481 # always fsync - this file is important
3482 aio_fsync $fh
3483 and return;
3484
3485 # touch it again to show we are up-to-date
3486 aio_utime $fh, undef, undef;
3487
3488 close $fh
3489 or return;
3490
3491 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3492 and return;
3493
3494 warn "runtime file written.\n";
3495
2220 } 3496 1
3497}
3498
3499our $uuid_lock;
3500our $uuid_skip;
3501
3502sub write_uuid_sync($) {
3503 $uuid_skip ||= $_[0];
3504
3505 return if $uuid_lock;
3506 local $uuid_lock = 1;
3507
3508 my $uuid = "$LOCALDIR/uuid";
3509
3510 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3511 or return;
3512
3513 my $value = uuid_seq uuid_cur;
3514
3515 unless ($value) {
3516 warn "cowardly refusing to write zero uuid value!\n";
3517 return;
3518 }
3519
3520 my $value = uuid_str $value + $uuid_skip;
3521 $uuid_skip = 0;
3522
3523 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3524 and return;
3525
3526 # always fsync - this file is important
3527 aio_fsync $fh
3528 and return;
3529
3530 close $fh
3531 or return;
3532
3533 aio_rename "$uuid~", $uuid
3534 and return;
3535
3536 warn "uuid file written ($value).\n";
3537
3538 1
3539
3540}
3541
3542sub write_uuid($$) {
3543 my ($skip, $sync) = @_;
3544
3545 $sync ? write_uuid_sync $skip
3546 : async { write_uuid_sync $skip };
2221} 3547}
2222 3548
2223sub emergency_save() { 3549sub emergency_save() {
2224 my $freeze_guard = cf::freeze_mainloop; 3550 my $freeze_guard = cf::freeze_mainloop;
2225 3551
2226 warn "enter emergency perl save\n"; 3552 warn "emergency_perl_save: enter\n";
2227 3553
2228 cf::sync_job { 3554 cf::sync_job {
3555 # this is a trade-off: we want to be very quick here, so
3556 # save all maps without fsync, and later call a global sync
3557 # (which in turn might be very very slow)
3558 local $USE_FSYNC = 0;
3559
2229 # use a peculiar iteration method to avoid tripping on perl 3560 # use a peculiar iteration method to avoid tripping on perl
2230 # refcount bugs in for. also avoids problems with players 3561 # refcount bugs in for. also avoids problems with players
2231 # and maps saved/Destroyed asynchronously. 3562 # and maps saved/destroyed asynchronously.
2232 warn "begin emergency player save\n"; 3563 warn "emergency_perl_save: begin player save\n";
2233 for my $login (keys %cf::PLAYER) { 3564 for my $login (keys %cf::PLAYER) {
2234 my $pl = $cf::PLAYER{$login} or next; 3565 my $pl = $cf::PLAYER{$login} or next;
2235 $pl->valid or next; 3566 $pl->valid or next;
3567 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2236 $pl->save; 3568 $pl->save;
2237 } 3569 }
2238 warn "end emergency player save\n"; 3570 warn "emergency_perl_save: end player save\n";
2239 3571
2240 warn "begin emergency map save\n"; 3572 warn "emergency_perl_save: begin map save\n";
2241 for my $path (keys %cf::MAP) { 3573 for my $path (keys %cf::MAP) {
2242 my $map = $cf::MAP{$path} or next; 3574 my $map = $cf::MAP{$path} or next;
2243 $map->valid or next; 3575 $map->valid or next;
2244 $map->save; 3576 $map->save;
2245 } 3577 }
2246 warn "end emergency map save\n"; 3578 warn "emergency_perl_save: end map save\n";
3579
3580 warn "emergency_perl_save: begin database checkpoint\n";
3581 BDB::db_env_txn_checkpoint $DB_ENV;
3582 warn "emergency_perl_save: end database checkpoint\n";
3583
3584 warn "emergency_perl_save: begin write uuid\n";
3585 write_uuid_sync 1;
3586 warn "emergency_perl_save: end write uuid\n";
2247 }; 3587 };
2248 3588
3589 warn "emergency_perl_save: starting sync()\n";
3590 IO::AIO::aio_sync sub {
3591 warn "emergency_perl_save: finished sync()\n";
3592 };
3593
2249 warn "leave emergency perl save\n"; 3594 warn "emergency_perl_save: leave\n";
2250} 3595}
2251 3596
3597sub post_cleanup {
3598 my ($make_core) = @_;
3599
3600 warn Carp::longmess "post_cleanup backtrace"
3601 if $make_core;
3602
3603 my $fh = pidfile;
3604 unlink $PIDFILE if <$fh> == $$;
3605}
3606
3607# a safer delete_package, copied from Symbol
3608sub clear_package($) {
3609 my $pkg = shift;
3610
3611 # expand to full symbol table name if needed
3612 unless ($pkg =~ /^main::.*::$/) {
3613 $pkg = "main$pkg" if $pkg =~ /^::/;
3614 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3615 $pkg .= '::' unless $pkg =~ /::$/;
3616 }
3617
3618 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3619 my $stem_symtab = *{$stem}{HASH};
3620
3621 defined $stem_symtab and exists $stem_symtab->{$leaf}
3622 or return;
3623
3624 # clear all symbols
3625 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3626 for my $name (keys %$leaf_symtab) {
3627 _gv_clear *{"$pkg$name"};
3628# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3629 }
3630 warn "cleared package $pkg\n";#d#
3631}
3632
2252sub reload() { 3633sub do_reload_perl() {
2253 # can/must only be called in main 3634 # can/must only be called in main
2254 if ($Coro::current != $Coro::main) { 3635 if ($Coro::current != $Coro::main) {
2255 warn "can only reload from main coroutine\n"; 3636 warn "can only reload from main coroutine";
2256 return; 3637 return;
2257 } 3638 }
2258 3639
3640 return if $RELOAD++;
3641
3642 my $t1 = EV::time;
3643
3644 while ($RELOAD) {
2259 warn "reloading..."; 3645 warn "reloading...";
2260 3646
2261 my $guard = freeze_mainloop; 3647 warn "entering sync_job";
3648
3649 cf::sync_job {
3650 cf::write_runtime_sync; # external watchdog should not bark
2262 cf::emergency_save; 3651 cf::emergency_save;
3652 cf::write_runtime_sync; # external watchdog should not bark
2263 3653
2264 eval { 3654 warn "syncing database to disk";
3655 BDB::db_env_txn_checkpoint $DB_ENV;
3656
2265 # if anything goes wrong in here, we should simply crash as we already saved 3657 # if anything goes wrong in here, we should simply crash as we already saved
2266 3658
2267 # cancel all watchers 3659 warn "flushing outstanding aio requests";
2268 for (Event::all_watchers) { 3660 while (IO::AIO::nreqs || BDB::nreqs) {
2269 $_->cancel if $_->data & WF_AUTOCANCEL; 3661 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
2270 }
2271
2272 # cancel all extension coros
2273 $_->cancel for values %EXT_CORO;
2274 %EXT_CORO = ();
2275
2276 # unload all extensions
2277 for (@exts) {
2278 warn "unloading <$_>";
2279 unload_extension $_;
2280 }
2281
2282 # unload all modules loaded from $LIBDIR
2283 while (my ($k, $v) = each %INC) {
2284 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2285
2286 warn "removing <$k>";
2287 delete $INC{$k};
2288
2289 $k =~ s/\.pm$//;
2290 $k =~ s/\//::/g;
2291
2292 if (my $cb = $k->can ("unload_module")) {
2293 $cb->();
2294 } 3662 }
2295 3663
2296 Symbol::delete_package $k; 3664 warn "cancelling all extension coros";
3665 $_->cancel for values %EXT_CORO;
3666 %EXT_CORO = ();
3667
3668 warn "removing commands";
3669 %COMMAND = ();
3670
3671 warn "removing ext/exti commands";
3672 %EXTCMD = ();
3673 %EXTICMD = ();
3674
3675 warn "unloading/nuking all extensions";
3676 for my $pkg (@EXTS) {
3677 warn "... unloading $pkg";
3678
3679 if (my $cb = $pkg->can ("unload")) {
3680 eval {
3681 $cb->($pkg);
3682 1
3683 } or warn "$pkg unloaded, but with errors: $@";
3684 }
3685
3686 warn "... clearing $pkg";
3687 clear_package $pkg;
2297 } 3688 }
2298 3689
2299 # sync database to disk 3690 warn "unloading all perl modules loaded from $LIBDIR";
2300 cf::db_sync; 3691 while (my ($k, $v) = each %INC) {
2301 IO::AIO::flush; 3692 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2302 3693
3694 warn "... unloading $k";
3695 delete $INC{$k};
3696
3697 $k =~ s/\.pm$//;
3698 $k =~ s/\//::/g;
3699
3700 if (my $cb = $k->can ("unload_module")) {
3701 $cb->();
3702 }
3703
3704 clear_package $k;
3705 }
3706
2303 # get rid of safe::, as good as possible 3707 warn "getting rid of safe::, as good as possible";
2304 Symbol::delete_package "safe::$_" 3708 clear_package "safe::$_"
2305 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3709 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2306 3710
2307 # remove register_script_function callbacks 3711 warn "unloading cf.pm \"a bit\"";
2308 # TODO
2309
2310 # unload cf.pm "a bit"
2311 delete $INC{"cf.pm"}; 3712 delete $INC{"cf.pm"};
3713 delete $INC{"cf/pod.pm"};
2312 3714
2313 # don't, removes xs symbols, too, 3715 # don't, removes xs symbols, too,
2314 # and global variables created in xs 3716 # and global variables created in xs
2315 #Symbol::delete_package __PACKAGE__; 3717 #clear_package __PACKAGE__;
2316 3718
2317 # reload cf.pm 3719 warn "unload completed, starting to reload now";
3720
2318 warn "reloading cf.pm"; 3721 warn "reloading cf.pm";
2319 require cf; 3722 require cf;
2320 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3723 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2321 3724
2322 # load config and database again 3725 warn "loading config and database again";
2323 cf::cfg_load; 3726 cf::reload_config;
2324 cf::db_load;
2325 3727
2326 # load extensions
2327 warn "load extensions"; 3728 warn "loading extensions";
2328 cf::load_extensions; 3729 cf::load_extensions;
2329 3730
2330 # reattach attachments to objects 3731 if ($REATTACH_ON_RELOAD) {
2331 warn "reattach"; 3732 warn "reattaching attachments to objects/players";
2332 _global_reattach; 3733 _global_reattach; # objects, sockets
3734 warn "reattaching attachments to maps";
2333 reattach $_ for values %MAP; 3735 reattach $_ for values %MAP;
3736 warn "reattaching attachments to players";
3737 reattach $_ for values %PLAYER;
3738 }
3739
3740 warn "running post_init jobs";
3741 (pop @POST_INIT)->(1) while @POST_INIT;
3742
3743 warn "leaving sync_job";
3744
3745 1
3746 } or do {
3747 warn $@;
3748 cf::cleanup "error while reloading, exiting.";
3749 };
3750
3751 warn "reloaded";
3752 --$RELOAD;
3753 }
3754
3755 $t1 = EV::time - $t1;
3756 warn "reload completed in ${t1}s\n";
3757};
3758
3759our $RELOAD_WATCHER; # used only during reload
3760
3761sub reload_perl() {
3762 # doing reload synchronously and two reloads happen back-to-back,
3763 # coro crashes during coro_state_free->destroy here.
3764
3765 $RELOAD_WATCHER ||= cf::async {
3766 Coro::AIO::aio_wait cache_extensions;
3767
3768 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3769 do_reload_perl;
3770 undef $RELOAD_WATCHER;
3771 };
2334 }; 3772 };
2335
2336 if ($@) {
2337 warn $@;
2338 warn "error while reloading, exiting.";
2339 exit 1;
2340 }
2341
2342 warn "reloaded successfully";
2343};
2344
2345#############################################################################
2346
2347unless ($LINK_MAP) {
2348 $LINK_MAP = cf::map::new;
2349
2350 $LINK_MAP->width (41);
2351 $LINK_MAP->height (41);
2352 $LINK_MAP->alloc;
2353 $LINK_MAP->path ("{link}");
2354 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2355 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2356
2357 # dirty hack because... archetypes are not yet loaded
2358 Event->timer (
2359 after => 10,
2360 cb => sub {
2361 $_[0]->w->cancel;
2362
2363 # provide some exits "home"
2364 my $exit = cf::object::new "exit";
2365
2366 $exit->slaying ($EMERGENCY_POSITION->[0]);
2367 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2368 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2369
2370 $LINK_MAP->insert ($exit->clone, 19, 19);
2371 $LINK_MAP->insert ($exit->clone, 19, 20);
2372 $LINK_MAP->insert ($exit->clone, 19, 21);
2373 $LINK_MAP->insert ($exit->clone, 20, 19);
2374 $LINK_MAP->insert ($exit->clone, 20, 21);
2375 $LINK_MAP->insert ($exit->clone, 21, 19);
2376 $LINK_MAP->insert ($exit->clone, 21, 20);
2377 $LINK_MAP->insert ($exit->clone, 21, 21);
2378
2379 $exit->destroy;
2380 });
2381
2382 $LINK_MAP->{deny_save} = 1;
2383 $LINK_MAP->{deny_reset} = 1;
2384
2385 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2386} 3773}
2387
2388register "<global>", __PACKAGE__;
2389 3774
2390register_command "reload" => sub { 3775register_command "reload" => sub {
2391 my ($who, $arg) = @_; 3776 my ($who, $arg) = @_;
2392 3777
2393 if ($who->flag (FLAG_WIZ)) { 3778 if ($who->flag (FLAG_WIZ)) {
2394 $who->message ("start of reload.");
2395 reload;
2396 $who->message ("end of reload."); 3779 $who->message ("reloading server.");
3780 async {
3781 $Coro::current->{desc} = "perl_reload";
3782 reload_perl;
3783 };
2397 } 3784 }
2398}; 3785};
2399 3786
2400unshift @INC, $LIBDIR; 3787unshift @INC, $LIBDIR;
2401 3788
2402$TICK_WATCHER = Event->timer ( 3789my $bug_warning = 0;
2403 reentrant => 0, 3790
2404 prio => 0, 3791our @WAIT_FOR_TICK;
2405 at => $NEXT_TICK || $TICK, 3792our @WAIT_FOR_TICK_BEGIN;
2406 data => WF_AUTOCANCEL, 3793
2407 cb => sub { 3794sub wait_for_tick {
3795 return if tick_inhibit || $Coro::current == $Coro::main;
3796
3797 my $signal = new Coro::Signal;
3798 push @WAIT_FOR_TICK, $signal;
3799 $signal->wait;
3800}
3801
3802sub wait_for_tick_begin {
3803 return if tick_inhibit || $Coro::current == $Coro::main;
3804
3805 my $signal = new Coro::Signal;
3806 push @WAIT_FOR_TICK_BEGIN, $signal;
3807 $signal->wait;
3808}
3809
3810sub tick {
3811 if ($Coro::current != $Coro::main) {
3812 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3813 unless ++$bug_warning > 10;
3814 return;
3815 }
3816
2408 cf::server_tick; # one server iteration 3817 cf::server_tick; # one server iteration
2409 $RUNTIME += $TICK;
2410 $NEXT_TICK += $TICK;
2411 3818
2412 $WAIT_FOR_TICK->broadcast; 3819 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2413 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3820 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2414 3821 Coro::async_pool {
2415 # if we are delayed by four ticks or more, skip them all 3822 $Coro::current->{desc} = "runtime saver";
2416 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2417
2418 $TICK_WATCHER->at ($NEXT_TICK);
2419 $TICK_WATCHER->start;
2420 },
2421);
2422
2423IO::AIO::max_poll_time $TICK * 0.2;
2424
2425Event->io (
2426 fd => IO::AIO::poll_fileno,
2427 poll => 'r',
2428 prio => 5,
2429 data => WF_AUTOCANCEL,
2430 cb => \&IO::AIO::poll_cb,
2431);
2432
2433Event->timer (
2434 data => WF_AUTOCANCEL,
2435 after => 0,
2436 interval => 10,
2437 cb => sub {
2438 (Coro::unblock_sub {
2439 write_runtime 3823 write_runtime_sync
2440 or warn "ERROR: unable to write runtime file: $!"; 3824 or warn "ERROR: unable to write runtime file: $!";
2441 })->(); 3825 };
2442 }, 3826 }
2443); 3827
3828 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3829 $sig->send;
3830 }
3831 while (my $sig = shift @WAIT_FOR_TICK) {
3832 $sig->send;
3833 }
3834
3835 $LOAD = ($NOW - $TICK_START) / $TICK;
3836 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3837
3838 if (0) {
3839 if ($NEXT_TICK) {
3840 my $jitter = $TICK_START - $NEXT_TICK;
3841 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3842 warn "jitter $JITTER\n";#d#
3843 }
3844 }
3845}
3846
3847{
3848 # configure BDB
3849
3850 BDB::min_parallel 8;
3851 BDB::max_poll_reqs $TICK * 0.1;
3852 $AnyEvent::BDB::WATCHER->priority (1);
3853
3854 unless ($DB_ENV) {
3855 $DB_ENV = BDB::db_env_create;
3856 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3857 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3858 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3859 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3860 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3861
3862 cf::sync_job {
3863 eval {
3864 BDB::db_env_open
3865 $DB_ENV,
3866 $BDBDIR,
3867 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3868 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3869 0666;
3870
3871 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3872 };
3873
3874 cf::cleanup "db_env_open(db): $@" if $@;
3875 };
3876 }
3877
3878 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3879 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3880 };
3881 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3882 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3883 };
3884 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3885 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3886 };
3887}
3888
3889{
3890 # configure IO::AIO
3891
3892 IO::AIO::min_parallel 8;
3893 IO::AIO::max_poll_time $TICK * 0.1;
3894 undef $AnyEvent::AIO::WATCHER;
3895}
3896
3897my $_log_backtrace;
3898
3899sub _log_backtrace {
3900 my ($msg, @addr) = @_;
3901
3902 $msg =~ s/\n//;
3903
3904 # limit the # of concurrent backtraces
3905 if ($_log_backtrace < 2) {
3906 ++$_log_backtrace;
3907 my $perl_bt = Carp::longmess $msg;
3908 async {
3909 $Coro::current->{desc} = "abt $msg";
3910
3911 my @bt = fork_call {
3912 @addr = map { sprintf "%x", $_ } @addr;
3913 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3914 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3915 or die "addr2line: $!";
3916
3917 my @funcs;
3918 my @res = <$fh>;
3919 chomp for @res;
3920 while (@res) {
3921 my ($func, $line) = splice @res, 0, 2, ();
3922 push @funcs, "[$func] $line";
3923 }
3924
3925 @funcs
3926 };
3927
3928 LOG llevInfo, "[ABT] $perl_bt\n";
3929 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3930 LOG llevInfo, "[ABT] $_\n" for @bt;
3931 --$_log_backtrace;
3932 };
3933 } else {
3934 LOG llevInfo, "[ABT] $msg\n";
3935 LOG llevInfo, "[ABT] [suppressed]\n";
3936 }
3937}
3938
3939# load additional modules
3940use cf::pod;
2444 3941
2445END { cf::emergency_save } 3942END { cf::emergency_save }
2446 3943
24471 39441
2448 3945

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines