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.137 by root, Fri Jan 5 10:23:05 2007 UTC vs.
Revision 1.493 by root, Mon Oct 26 02:34:37 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines