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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines