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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines