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.135 by root, Thu Jan 4 20:29:46 2007 UTC vs.
Revision 1.506 by root, Wed Feb 3 20:48:22 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines