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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines