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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines