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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines