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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines