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.490 by root, Sat Oct 24 06:16:40 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines