--- deliantra/server/lib/cf.pm 2007/01/14 22:54:18 1.177 +++ deliantra/server/lib/cf.pm 2012/11/11 02:38:10 1.598 @@ -1,90 +1,202 @@ +# +# This file is part of Deliantra, the Roguelike Realtime MMORPG. +# +# Copyright (©) 2006,2007,2008,2009,2010,2011,2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team +# +# Deliantra is free software: you can redistribute it and/or modify it under +# the terms of the Affero GNU General Public License as published by the +# Free Software Foundation, either version 3 of the License, or (at your +# option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the Affero GNU General Public License +# and the GNU General Public License along with this program. If not, see +# . +# +# The authors can be reached via e-mail to +# + package cf; -use utf8; -use strict; +use common::sense; use Symbol; use List::Util; -use Storable; +use Socket; +use EV; use Opcode; use Safe; use Safe::Hole; +use Storable (); +use Carp (); -use Coro 3.4 (); -use Coro::Event; +use AnyEvent (); +use AnyEvent::IO (); +use AnyEvent::DNS (); + +use Coro (); +use Coro::State; +use Coro::Handle; +use Coro::EV; +use Coro::AnyEvent; use Coro::Timer; use Coro::Signal; use Coro::Semaphore; +use Coro::SemaphoreSet; +use Coro::AnyEvent; use Coro::AIO; - +use Coro::BDB 1.6; +use Coro::Storable; +use Coro::Util (); + +use Guard (); +use JSON::XS 2.01 (); +use BDB (); use Data::Dumper; -use Digest::MD5; use Fcntl; -use IO::AIO 2.32 (); -use YAML::Syck (); -use Time::HiRes; +use YAML::XS (); +use IO::AIO (); +use Compress::LZF; +use Digest::MD5 (); + +AnyEvent::detect; + +# configure various modules to our taste +# +$Storable::canonical = 1; # reduce rsync transfers +Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator -use Event; $Event::Eval = 1; # no idea why this is required, but it is +$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority -sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload +# make sure c-lzf reinitialises itself +Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve"; +Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later -# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? -$YAML::Syck::ImplicitUnicode = 1; +# strictly for debugging +$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" }; -$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority +sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload + +our @ORIG_INC; our %COMMAND = (); our %COMMAND_TIME = (); our @EXTS = (); # list of extension package names our %EXTCMD = (); +our %EXTACMD = (); +our %EXTICMD = (); +our %EXTIACMD = (); our %EXT_CORO = (); # coroutines bound to extensions our %EXT_MAP = (); # pluggable maps +our $RELOAD; # number of reloads so far, non-zero while in reload our @EVENT; -our $LIBDIR = datadir . "/ext"; +our @REFLECT; # set by XS +our %REFLECT; # set by us + +our $CONFDIR = confdir; -our $TICK = MAX_TIME * 1e-6; -our $TICK_WATCHER; -our $AIO_POLL_WATCHER; -our $WRITE_RUNTIME_WATCHER; +our $DATADIR = datadir; +our $LIBDIR = "$DATADIR/ext"; +our $PODDIR = "$DATADIR/pod"; +our $MAPDIR = "$DATADIR/" . mapdir; + +our $LOCALDIR = localdir; +our $TMPDIR = "$LOCALDIR/" . tmpdir; +our $UNIQUEDIR = "$LOCALDIR/" . uniquedir; +our $PLAYERDIR = "$LOCALDIR/" . playerdir; +our $RANDOMDIR = "$LOCALDIR/random"; +our $BDBDIR = "$LOCALDIR/db"; +our $PIDFILE = "$LOCALDIR/pid"; +our $RUNTIMEFILE = "$LOCALDIR/runtime"; + +#our %RESOURCE; # unused + +our $OUTPUT_RATE_MIN = 3000; +our $OUTPUT_RATE_MAX = 1000000; + +our $MAX_LINKS = 32; # how many chained exits to follow +our $VERBOSE_IO = 1; + +our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!) +our $NEXT_RUNTIME_WRITE; # when should the runtime file be written our $NEXT_TICK; -our $NOW; +our $USE_FSYNC = 1; # use fsync to write maps - default on + +our $BDB_DEADLOCK_WATCHER; +our $BDB_CHECKPOINT_WATCHER; +our $BDB_TRICKLE_WATCHER; +our $DB_ENV; + +our @EXTRA_MODULES = qw(pod match mapscript incloader); our %CFG; +our %EXT_CFG; # cfgkeyname => [var-ref, defaultvalue] our $UPTIME; $UPTIME ||= time; -our $RUNTIME; +our $RUNTIME = 0; +our $SERVER_TICK = 0; +our $NOW; -our %PLAYER; # all users -our %MAP; # all maps +our (%PLAYER, %PLAYER_LOADING); # all users +our (%MAP, %MAP_LOADING ); # all maps our $LINK_MAP; # the special {link} map, which is always available -our $RANDOM_MAPS = cf::localdir . "/random"; - -our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal; -our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal; # used to convert map paths into valid unix filenames by replacing / by ∕ our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons +our $LOAD; # a number between 0 (idle) and 1 (too many objects) +our $LOADAVG; # same thing, but with alpha-smoothing +our $JITTER; # average jitter +our $TICK_START; # for load detecting purposes + +our @POST_INIT; + +our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow) +our $REALLY_UNLOOP; # never set to true, please :) + +our $WAIT_FOR_TICK = new Coro::Signal; +our @WAIT_FOR_TICK_BEGIN; + binmode STDOUT; binmode STDERR; # read virtual server time, if available -unless ($RUNTIME || !-e cf::localdir . "/runtime") { - open my $fh, "<", cf::localdir . "/runtime" - or die "unable to read runtime file: $!"; +unless ($RUNTIME || !-e $RUNTIMEFILE) { + open my $fh, "<", $RUNTIMEFILE + or die "unable to read $RUNTIMEFILE file: $!"; $RUNTIME = <$fh> + 0.; } -mkdir cf::localdir; -mkdir cf::localdir . "/" . cf::playerdir; -mkdir cf::localdir . "/" . cf::tmpdir; -mkdir cf::localdir . "/" . cf::uniquedir; -mkdir $RANDOM_MAPS; +eval "sub TICK() { $TICK } 1" or die; + +mkdir $_ + for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR; our $EMERGENCY_POSITION; +sub cf::map::normalise; + +sub in_main() { + $Coro::current == $Coro::main +} + +############################################################################# + +%REFLECT = (); +for (@REFLECT) { + my $reflect = JSON::XS::decode_json $_; + $REFLECT{$reflect->{class}} = $reflect; +} + +# this is decidedly evil +$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} }; + ############################################################################# =head2 GLOBAL VARIABLES @@ -93,60 +205,129 @@ =item $cf::UPTIME -The timestamp of the server start (so not actually an uptime). +The timestamp of the server start (so not actually an "uptime"). + +=item $cf::SERVER_TICK + +An unsigned integer that starts at zero when the server is started and is +incremented on every tick. + +=item $cf::NOW + +The (real) time of the last (current) server tick - updated before and +after tick processing, so this is useful only as a rough "what time is it +now" estimate. + +=item $cf::TICK + +The interval between each server tick, in seconds. =item $cf::RUNTIME The time this server has run, starts at 0 and is increased by $cf::TICK on every server tick. -=item $cf::LIBDIR +=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR +$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR +$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR -The perl library directory, where extensions and cf-specific modules can -be found. It will be added to C<@INC> automatically. +Various directories - "/etc", read-only install directory, perl-library +directory, pod-directory, read-only maps directory, "/var", "/var/tmp", +unique-items directory, player file directory, random maps directory and +database environment. -=item $cf::NOW +=item $cf::LOADAVG -The time of the last (current) server tick. +The current CPU load on the server (alpha-smoothed), as a value between 0 +(none) and 1 (overloaded), indicating how much time is spent on processing +objects per tick. Healthy values are < 0.5. -=item $cf::TICK +=item $cf::LOAD -The interval between server ticks, in seconds. +The raw value load value from the last tick. =item %cf::CFG -Configuration for the server, loaded from C, or +Configuration for the server, loaded from C, or from wherever your confdir points to. -=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE +=item cf::wait_for_tick, cf::wait_for_tick_begin + +These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only +returns directly I the tick processing (and consequently, can only wake one thread +per tick), while cf::wait_for_tick wakes up all waiters after tick processing. + +Note that cf::Wait_for_tick will immediately return when the server is not +ticking, making it suitable for small pauses in threads that need to run +when the server is paused. If that is not applicable (i.e. you I +want to wait, use C<$cf::WAIT_FOR_TICK>). + +=item $cf::WAIT_FOR_TICK + +Note that C is probably the correct thing to use. This +variable contains a L that is broadcats after every server +tick. Calling C<< ->wait >> on it will suspend the caller until after the +next server tick. + +=cut + +sub wait_for_tick(); +sub wait_for_tick_begin(); + +=item @cf::INVOKE_RESULTS + +This array contains the results of the last C call. When +C is called C<@cf::INVOKE_RESULTS> is set to the parameters of +that call. -These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) -or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick -processing has been done. Call C<< ->wait >> on them to maximise the -window of cpu time available, or simply to synchronise to the server tick. +=item %cf::REFLECT + +Contains, for each (C++) class name, a hash reference with information +about object members (methods, scalars, arrays and flags) and other +metadata, which is useful for introspection. =back =cut -BEGIN { - *CORE::GLOBAL::warn = sub { - my $msg = join "", @_; - utf8::encode $msg; +sub error(@) { LOG llevError, join "", @_ } +sub warn (@) { LOG llevWarn , join "", @_ } +sub info (@) { LOG llevInfo , join "", @_ } +sub debug(@) { LOG llevDebug, join "", @_ } +sub trace(@) { LOG llevTrace, join "", @_ } - $msg .= "\n" - unless $msg =~ /\n$/; +$Coro::State::WARNHOOK = sub { + my $msg = join "", @_; - LOG llevError, $msg; - }; -} + $msg .= "\n" + unless $msg =~ /\n$/; + + $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge; + + LOG llevWarn, $msg; +}; + +$Coro::State::DIEHOOK = sub { + return unless $^S eq 0; # "eq", not "==" + + error Carp::longmess $_[0]; + + if (in_main) {#d# + error "DIEHOOK called in main context, Coro bug?\n";#d# + return;#d# + }#d# + + # kill coroutine otherwise + Coro::terminate +}; @safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; @safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; @safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; @safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; @safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; -@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; +@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object'; +@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet) # we bless all objects into (empty) derived classes to force a method lookup # within the Safe compartment. @@ -155,16 +336,23 @@ cf::object cf::object::player cf::client cf::player cf::arch cf::living - cf::map cf::party cf::region + cf::map cf::mapspace + cf::party cf::region )) { - no strict 'refs'; @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; } -$Event::DIED = sub { - warn "error in event callback: @_"; +$EV::DIED = sub { + warn "error in event callback: $@"; }; +############################################################################# + +sub fork_call(&@); +sub get_slot($;$$); + +############################################################################# + =head2 UTILITY FUNCTIONS =over 4 @@ -192,28 +380,133 @@ } || "[unable to dump $_[0]: '$@']"; } -use JSON::Syck (); # TODO# replace by JSON::PC once working +=item $scalar = cf::load_file $path -=item $ref = cf::from_json $json +Loads the given file from path and returns its contents. Croaks on error +and can block. -Converts a JSON string into the corresponding perl data structure. +=cut + +sub load_file($) { + 0 <= aio_load $_[0], my $data + or Carp::croak "$_[0]: $!"; + + $data +} + +=item $success = cf::replace_file $path, $data, $sync + +Atomically replaces the file at the given $path with new $data, and +optionally $sync the data to disk before replacing the file. =cut -sub from_json($) { - $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs - JSON::Syck::Load $_[0] +sub replace_file($$;$) { + my ($path, $data, $sync) = @_; + + my $lock = cf::lock_acquire ("replace_file:$path"); + + my $fh = aio_open "$path~", Fcntl::O_WRONLY | Fcntl::O_CREAT | Fcntl::O_TRUNC, 0644 + or return; + + $data = $data->() if ref $data; + + length $data == aio_write $fh, 0, (length $data), $data, 0 + or return; + + !$sync + or !aio_fsync $fh + or return; + + aio_close $fh + and return; + + aio_rename "$path~", $path + and return; + + if ($sync) { + $path =~ s%/[^/]*$%%; + aio_pathsync $path; + } + + 1 } -=item $json = cf::to_json $ref +=item $ref = cf::decode_json $json + +Converts a JSON string into the corresponding perl data structure. + +=item $json = cf::encode_json $ref Converts a perl data structure into its JSON representation. =cut -sub to_json($) { - $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs - JSON::Syck::Dump $_[0] +our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max + +sub encode_json($) { $json_coder->encode ($_[0]) } +sub decode_json($) { $json_coder->decode ($_[0]) } + +=item $ref = cf::decode_storable $scalar + +Same as Coro::Storable::thaw, so blocks. + +=cut + +BEGIN { *decode_storable = \&Coro::Storable::thaw } + +=item $ref = cf::decode_yaml $scalar + +Same as YAML::XS::Load, but doesn't leak, because it forks (and thus blocks). + +=cut + +sub decode_yaml($) { + fork_call { YAML::XS::Load $_[0] } @_ +} + +=item $scalar = cf::unlzf $scalar + +Same as Compress::LZF::compress, but takes server ticks into account, so +blocks. + +=cut + +sub unlzf($) { + # we assume 100mb/s minimum decompression speed (noncompressible data on a ~2ghz machine) + cf::get_slot +(length $_[0]) / 100_000_000, 0, "unlzf"; + Compress::LZF::decompress $_[0] +} + +=item cf::post_init { BLOCK } + +Execute the given codeblock, I all extensions have been (re-)loaded, +but I the server starts ticking again. + +The codeblock will have a single boolean argument to indicate whether this +is a reload or not. + +=cut + +sub post_init(&) { + push @POST_INIT, shift; +} + +sub _post_init { + trace "running post_init jobs"; + + # run them in parallel... + + my @join; + + while () { + push @join, map &Coro::async ($_, 0), @POST_INIT; + @POST_INIT = (); + + @join or last; + + (pop @join)->join; + } } =item cf::lock_wait $string @@ -223,51 +516,125 @@ =item my $lock = cf::lock_acquire $string Wait until the given lock is available and then acquires it and returns -a Coro::guard object. If the guard object gets destroyed (goes out of scope, +a L object. If the guard object gets destroyed (goes out of scope, for example when the coroutine gets canceled), the lock is automatically returned. +Locks are *not* recursive, locking from the same coro twice results in a +deadlocked coro. + Lock names should begin with a unique identifier (for example, cf::map::find uses map_find and cf::map::load uses map_load). +=item $locked = cf::lock_active $string + +Return true if the lock is currently active, i.e. somebody has locked it. + =cut -our %LOCK; +our $LOCKS = new Coro::SemaphoreSet; sub lock_wait($) { - my ($key) = @_; - - # wait for lock, if any - while ($LOCK{$key}) { - push @{ $LOCK{$key} }, $Coro::current; - Coro::schedule; - } + $LOCKS->wait ($_[0]); } sub lock_acquire($) { - my ($key) = @_; + $LOCKS->guard ($_[0]) +} - # wait, to be sure we are not locked - lock_wait $key; +sub lock_active($) { + $LOCKS->count ($_[0]) < 1 +} - $LOCK{$key} = []; +sub freeze_mainloop { + tick_inhibit_inc; - Coro::guard { - # wake up all waiters, to be on the safe side - $_->ready for @{ delete $LOCK{$key} }; - } + &Guard::guard (\&tick_inhibit_dec); } -sub freeze_mainloop { - return unless $TICK_WATCHER->is_active; +=item cf::periodic $interval, $cb - my $guard = Coro::guard { - $TICK_WATCHER->start; - $WRITE_RUNTIME_WATCHER->start; - }; - $WRITE_RUNTIME_WATCHER->stop; - $TICK_WATCHER->stop; - $guard +Like EV::periodic, but randomly selects a starting point so that the actions +get spread over time. + +=cut + +sub periodic($$) { + my ($interval, $cb) = @_; + + my $start = rand List::Util::min 180, $interval; + + EV::periodic $start, $interval, 0, $cb +} + +=item cf::get_slot $time[, $priority[, $name]] + +Allocate $time seconds of blocking CPU time at priority C<$priority> +(default: 0): This call blocks and returns only when you have at least +C<$time> seconds of cpu time till the next tick. The slot is only valid +till the next cede. + +Background jobs should use a priority les than zero, interactive jobs +should use 100 or more. + +The optional C<$name> can be used to identify the job to run. It might be +used for statistical purposes and should identify the same time-class. + +Useful for short background jobs. + +=cut + +our @SLOT_QUEUE; +our $SLOT_QUEUE; +our $SLOT_DECAY = 0.9; + +$SLOT_QUEUE->cancel if $SLOT_QUEUE; +$SLOT_QUEUE = Coro::async { + $Coro::current->desc ("timeslot manager"); + + my $signal = new Coro::Signal; + my $busy; + + while () { + next_job: + + my $avail = cf::till_tick; + + for (0 .. $#SLOT_QUEUE) { + if ($SLOT_QUEUE[$_][0] <= $avail) { + $busy = 0; + my $job = splice @SLOT_QUEUE, $_, 1, (); + $job->[2]->send; + Coro::cede; + goto next_job; + } else { + $SLOT_QUEUE[$_][0] *= $SLOT_DECAY; + } + } + + if (@SLOT_QUEUE) { + # we do not use wait_for_tick() as it returns immediately when tick is inactive + $WAIT_FOR_TICK->wait; + } else { + $busy = 0; + Coro::schedule; + } + } +}; + +sub get_slot($;$$) { + return if tick_inhibit || $Coro::current == $Coro::main; + + my ($time, $pri, $name) = @_; + + $time = clamp $time, 0.01, $TICK * .6; + + my $sig = new Coro::Signal; + + push @SLOT_QUEUE, [$time, $pri, $sig, $name]; + @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE; + $SLOT_QUEUE->ready; + $sig->wait; } =item cf::async { BLOCK } @@ -282,9 +649,10 @@ =item cf::sync_job { BLOCK } -The design of crossfire+ requires that the main coro ($Coro::main) is -always able to handle events or runnable, as crossfire+ is only partly -reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. +The design of Deliantra requires that the main coroutine ($Coro::main) +is always able to handle events or runnable, as Deliantra is only +partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not +acceptable. If it must be done, put the blocking parts into C. This will run the given BLOCK in another coroutine while waiting for the result. The @@ -296,27 +664,38 @@ sub sync_job(&) { my ($job) = @_; - if ($Coro::current == $Coro::main) { + if (in_main) { + my $time = AE::time; + # this is the main coro, too bad, we have to block # till the operation succeeds, freezing the server :/ - # TODO: use suspend/resume instead - # (but this is cancel-safe) + #LOG llevError, Carp::longmess "sync job";#d# + my $freeze_guard = freeze_mainloop; my $busy = 1; my @res; (async { + $Coro::current->desc ("sync job coro"); @res = eval { $job->() }; - warn $@ if $@; + error $@ if $@; undef $busy; })->prio (Coro::PRIO_MAX); while ($busy) { - Coro::cede or Event::one_event; + if (Coro::nready) { + Coro::cede_notself; + } else { + EV::loop EV::LOOP_ONESHOT; + } } + my $time = AE::time - $time; + + $TICK_START += $time; # do not account sync jobs to server load + wantarray ? @res : $res[0] } else { # we are in another coroutine, how wonderful, everything just works @@ -345,26 +724,209 @@ $coro } -sub write_runtime { - my $runtime = cf::localdir . "/runtime"; +=item fork_call { }, @args - my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 - or return; +Executes the given code block with the given arguments in a seperate +process, returning the results. Everything must be serialisable with +Coro::Storable. May, of course, block. Note that the executed sub may +never block itself or use any form of event handling. - my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock - (aio_write $fh, 0, (length $value), $value, 0) <= 0 - and return; +=cut - aio_fsync $fh - and return; +sub post_fork { + reset_signals; +} - close $fh - or return; +sub fork_call(&@) { + my ($cb, @args) = @_; - aio_rename "$runtime~", $runtime - and return; + # we seemingly have to make a local copy of the whole thing, + # otherwise perl prematurely frees the stuff :/ + # TODO: investigate and fix (likely this will be rather laborious) - 1 + my @res = Coro::Util::fork_eval { + cf::post_fork; + &$cb + } @args; + + wantarray ? @res : $res[-1] +} + +sub objinfo { + ( + "counter value" => cf::object::object_count, + "objects created" => cf::object::create_count, + "objects destroyed" => cf::object::destroy_count, + "freelist size" => cf::object::free_count, + "allocated objects" => cf::object::objects_size, + "active objects" => cf::object::actives_size, + ) +} + +=item $coin = coin_from_name $name + +=cut + +our %coin_alias = ( + "silver" => "silvercoin", + "silvercoin" => "silvercoin", + "silvercoins" => "silvercoin", + "gold" => "goldcoin", + "goldcoin" => "goldcoin", + "goldcoins" => "goldcoin", + "platinum" => "platinacoin", + "platinumcoin" => "platinacoin", + "platinumcoins" => "platinacoin", + "platina" => "platinacoin", + "platinacoin" => "platinacoin", + "platinacoins" => "platinacoin", + "royalty" => "royalty", + "royalties" => "royalty", +); + +sub coin_from_name($) { + $coin_alias{$_[0]} + ? cf::arch::find $coin_alias{$_[0]} + : undef +} + +=item $value = cf::db_get $family => $key + +Returns a single value from the environment database. + +=item cf::db_put $family => $key => $value + +Stores the given C<$value> in the family. It can currently store binary +data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary). + +=item $db = cf::db_table "name" + +Create and/or open a new database table. The string must not be "db" and must be unique +within each server. + +=cut + +sub db_table($) { + cf::error "db_get called from main context" + if $Coro::current == $Coro::main; + + my ($name) = @_; + my $db = BDB::db_create $DB_ENV; + + eval { + $db->set_flags (BDB::CHKSUM); + + utf8::encode $name; + BDB::db_open $db, undef, $name, undef, BDB::BTREE, + BDB::CREATE | BDB::AUTO_COMMIT, 0666; + cf::cleanup "db_open(db): $!" if $!; + }; + cf::cleanup "db_open(db): $@" if $@; + + $db +} + +our $DB; + +sub db_init { + $DB ||= db_table "db"; +} + +sub db_get($$) { + my $key = "$_[0]/$_[1]"; + + cf::error "db_get called from main context" + if $Coro::current == $Coro::main; + + BDB::db_get $DB, undef, $key, my $data; + + $! ? () + : $data +} + +sub db_put($$$) { + BDB::dbreq_pri 4; + BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { }; +} + +=item cf::cache $id => [$paths...], $processversion => $process + +Generic caching function that returns the value of the resource $id, +caching and regenerating as required. + +This function can block. + +=cut + +sub cache { + my ($id, $src, $processversion, $process) = @_; + + my $meta = + join "\x00", + $processversion, + map { + aio_stat $_ + and Carp::croak "$_: $!"; + + ($_, (stat _)[7,9]) + } @$src; + + my $dbmeta = db_get cache => "$id/meta"; + if ($dbmeta ne $meta) { + # changed, we may need to process + + my @data; + my $md5; + + for (0 .. $#$src) { + $data[$_] = load_file $src->[$_]; + } + + # if processing is expensive, check + # checksum first + if (1) { + $md5 = + join "\x00", + $processversion, + map { + cf::cede_to_tick; + ($src->[$_], Digest::MD5::md5_hex $data[$_]) + } 0.. $#$src; + + + my $dbmd5 = db_get cache => "$id/md5"; + if ($dbmd5 eq $md5) { + db_put cache => "$id/meta", $meta; + + return db_get cache => "$id/data"; + } + } + + my $t1 = EV::time; + my $data = $process->(\@data); + my $t2 = EV::time; + + info "cache: '$id' processed in ", $t2 - $t1, "s\n"; + + db_put cache => "$id/data", $data; + db_put cache => "$id/md5" , $md5; + db_put cache => "$id/meta", $meta; + + return $data; + } + + db_get cache => "$id/data" +} + +=item cf::datalog type => key => value, ... + +Log a datalog packet of the given type with the given key-value pairs. + +=cut + +sub datalog($@) { + my ($type, %kv) = @_; + info "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type }); } =back @@ -375,13 +937,13 @@ =head2 ATTACHABLE OBJECTS -Many objects in crossfire are so-called attachable objects. That means you can +Many objects in deliantra are so-called attachable objects. That means you can attach callbacks/event handlers (a collection of which is called an "attachment") to it. All such attachable objects support the following methods. In the following description, CLASS can be any of C, C C, C or C (i.e. the attachable objects in -crossfire+). +Deliantra). =over 4 @@ -435,7 +997,7 @@ Register an attachment by C<$name> through which attachable objects of the given CLASS can refer to this attachment. -Some classes such as crossfire maps and objects can specify attachments +Some classes such as deliantra maps and objects can specify attachments that are attached at load/instantiate time, thus the need for a name. These calls expect any number of the following handler/hook descriptions: @@ -554,7 +1116,7 @@ } elsif ($type eq "subtype") { defined $object_type or Carp::croak "subtype specified without type"; my $object_subtype = shift @arg; - $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; + $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= []; } elsif ($type eq "package") { my $pkg = shift @arg; @@ -569,11 +1131,11 @@ _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; } elsif (ref $type) { - warn "attaching objects not supported, ignoring.\n"; + error "attaching objects not supported, ignoring.\n"; } else { shift @arg; - warn "attach argument '$type' not supported, ignoring.\n"; + error "attach argument '$type' not supported, ignoring.\n"; } } } @@ -593,7 +1155,7 @@ $obj->{$name} = \%arg; } else { - warn "object uses attachment '$name' that is not available, postponing.\n"; + info "object uses attachment '$name' which is not available, postponing.\n"; } $obj->{_attachment}{$name} = undef; @@ -605,6 +1167,7 @@ } else { _attach shift->_attach_registry, @_; } + _recalc_want; }; # all those should be optimised @@ -617,6 +1180,7 @@ } else { Carp::croak "cannot, currently, detach class attachments"; } + _recalc_want; }; sub cf::attachable::attached { @@ -641,18 +1205,18 @@ } our $override; -our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? +our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals? sub override { $override = 1; - @invoke_results = (); + @INVOKE_RESULTS = (@_); } sub do_invoke { my $event = shift; my $callbacks = shift; - @invoke_results = (); + @INVOKE_RESULTS = (); local $override; @@ -660,8 +1224,7 @@ eval { &{$_->[1]} }; if ($@) { - warn "$@"; - warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; + error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; override; } @@ -671,7 +1234,7 @@ 0 } -=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) +=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...) =item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) @@ -679,7 +1242,7 @@ This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be removed in future versions), and there is no public API to access override -results (if you must, access C<@cf::invoke_results> directly). +results (if you must, access C<@cf::INVOKE_RESULTS> directly). =back @@ -688,11 +1251,54 @@ ############################################################################# # object support +sub _object_equal($$); +sub _object_equal($$) { + my ($a, $b) = @_; + + return 0 unless (ref $a) eq (ref $b); + + if ("HASH" eq ref $a) { + my @ka = keys %$a; + my @kb = keys %$b; + + return 0 if @ka != @kb; + + for (0 .. $#ka) { + return 0 unless $ka[$_] eq $kb[$_]; + return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]}; + } + + } elsif ("ARRAY" eq ref $a) { + + return 0 if @$a != @$b; + + for (0 .. $#$a) { + return 0 unless _object_equal $a->[$_], $b->[$_]; + } + + } elsif ($a ne $b) { + return 0; + } + + 1 +} + +our $SLOW_MERGES;#d# +sub _can_merge { + my ($ob1, $ob2) = @_; + + ++$SLOW_MERGES;#d# + + # we do the slow way here + return _object_equal $ob1, $ob2 +} + sub reattach { # basically do the same as instantiate, without calling instantiate my ($obj) = @_; - bless $obj, ref $obj; # re-bless in case extensions have been reloaded + # no longer needed after getting rid of delete_package? + #bless $obj, ref $obj; # re-bless in case extensions have been reloaded my $registry = $obj->registry; @@ -707,7 +1313,7 @@ _attach $registry, $klass, @attach; } } else { - warn "object uses attachment '$name' that is not available, postponing.\n"; + info "object uses attachment '$name' that is not available, postponing.\n"; } } } @@ -717,7 +1323,7 @@ on_instantiate => sub { my ($obj, $data) = @_; - $data = from_json $data; + $data = decode_json $data; for (@$data) { my ($name, $args) = @$_; @@ -743,22 +1349,30 @@ sync_job { if (length $$rdata) { - warn sprintf "saving %s (%d,%d)\n", - $filename, length $$rdata, scalar @$objs; + utf8::decode (my $decname = $filename); + trace sprintf "saving %s (%d,%d)\n", + $decname, length $$rdata, scalar @$objs + if $VERBOSE_IO; if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { - chmod SAVE_MODE, $fh; + aio_chmod $fh, SAVE_MODE; aio_write $fh, 0, (length $$rdata), $$rdata, 0; - aio_fsync $fh; - close $fh; + if ($cf::USE_FSYNC) { + aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER; + aio_fsync $fh; + } + aio_close $fh; if (@$objs) { if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { - chmod SAVE_MODE, $fh; - my $data = Storable::nfreeze { version => 1, objs => $objs }; + aio_chmod $fh, SAVE_MODE; + my $data = Coro::Storable::nfreeze { version => 1, objs => $objs }; aio_write $fh, 0, (length $data), $data, 0; - aio_fsync $fh; - close $fh; + if ($cf::USE_FSYNC) { + aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER; + aio_fsync $fh; + } + aio_close $fh; aio_rename "$filename.pst~", "$filename.pst"; } } else { @@ -766,14 +1380,17 @@ } aio_rename "$filename~", $filename; + + $filename =~ s%/[^/]+$%%; + aio_pathsync $filename if $cf::USE_FSYNC; } else { - warn "FATAL: $filename~: $!\n"; + error "unable to save objects: $filename~: $!\n"; } } else { aio_unlink $filename; aio_unlink "$filename.pst"; } - } + }; } sub object_freezer_as_string { @@ -795,18 +1412,29 @@ unless (aio_stat "$filename.pst") { (aio_load "$filename.pst", $av) >= 0 or return; - $av = eval { (Storable::thaw $av)->{objs} }; + + my $st = eval { Coro::Storable::thaw $av }; + $av = $st->{objs}; } - warn sprintf "loading %s (%d)\n", - $filename, length $data, scalar @{$av || []};#d# - return ($data, $av); + utf8::decode (my $decname = $filename); + trace sprintf "loading %s (%d,%d)\n", + $decname, length $data, scalar @{$av || []} + if $VERBOSE_IO; + + ($data, $av) } +=head2 COMMAND CALLBACKS + +=over 4 + +=cut + ############################################################################# # command handling &c -=item cf::register_command $name => \&callback($ob,$args); +=item cf::register_command $name => \&callback($ob,$args) Register a callback for execution when the client sends the user command $name. @@ -822,23 +1450,66 @@ push @{ $COMMAND{$name} }, [$caller, $cb]; } -=item cf::register_extcmd $name => \&callback($pl,$packet); +=item cf::register_extcmd $name => \&callback($pl,@args) + +Register a callback for execution when the client sends an (synchronous) +extcmd packet. Ext commands will be processed in the order they are +received by the server, like other user commands. The first argument is +the logged-in player. Ext commands can only be processed after a player +has logged in successfully. + +The values will be sent back to the client. -Register a callbackf ro execution when the client sends an extcmd packet. +=item cf::register_async_extcmd $name => \&callback($pl,$reply->(...),@args) -If the callback returns something, it is sent back as if reply was being -called. +Same as C, but instead of returning values, the +callback needs to clal the C<$reply> function. + +=item cf::register_exticmd $name => \&callback($ns,@args) + +Register a callback for execution when the client sends an (asynchronous) +exticmd packet. Exti commands are processed by the server as soon as they +are received, i.e. out of order w.r.t. other commands. The first argument +is a client socket. Exti commands can be received anytime, even before +log-in. + +The values will be sent back to the client. + +=item cf::register_async_exticmd $name => \&callback($ns,$reply->(...),@args) + +Same as C, but instead of returning values, the +callback needs to clal the C<$reply> function. =cut -sub register_extcmd { +sub register_extcmd($$) { my ($name, $cb) = @_; $EXTCMD{$name} = $cb; } +sub register_async_extcmd($$) { + my ($name, $cb) = @_; + + $EXTACMD{$name} = $cb; +} + +sub register_exticmd($$) { + my ($name, $cb) = @_; + + $EXTICMD{$name} = $cb; +} + +sub register_async_exticmd($$) { + my ($name, $cb) = @_; + + $EXTIACMD{$name} = $cb; +} + +use File::Glob (); + cf::player->attach ( - on_command => sub { + on_unknown_command => sub { my ($pl, $name, $params) = @_; my $cb = $COMMAND{$name} @@ -853,71 +1524,169 @@ on_extcmd => sub { my ($pl, $buf) = @_; - my $msg = eval { from_json $buf }; + my $msg = eval { $pl->ns->{json_coder}->decode ($buf) }; if (ref $msg) { - if (my $cb = $EXTCMD{$msg->{msgtype}}) { - if (my %reply = $cb->($pl, $msg)) { - $pl->ext_reply ($msg->{msgid}, %reply); + my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash + + if (my $cb = $EXTACMD{$type}) { + $cb->( + $pl, + sub { + $pl->ext_msg ("reply-$reply", @_) + if $reply; + }, + @payload + ); + } else { + my @reply; + + if (my $cb = $EXTCMD{$type}) { + @reply = $cb->($pl, @payload); } + + $pl->ext_msg ("reply-$reply", @reply) + if $reply; } + } else { - warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; + error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; } cf::override; }, ); -sub load_extension { - my ($path) = @_; - - $path =~ /([^\/\\]+)\.ext$/ or die "$path"; - my $base = $1; - my $pkg = $1; - $pkg =~ s/[^[:word:]]/_/g; - $pkg = "ext::$pkg"; - - warn "... loading '$path' into '$pkg'\n"; - - open my $fh, "<:utf8", $path - or die "$path: $!"; - - my $source = - "package $pkg; use strict; use utf8;\n" - . "#line 1 \"$path\"\n{\n" - . (do { local $/; <$fh> }) - . "\n};\n1"; - - unless (eval $source) { - my $msg = $@ ? "$path: $@\n" - : "extension disabled.\n"; - if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match - warn $@; - warn "mandatory extension failed to load, exiting.\n"; - exit 1; +# "readahead" all extensions +sub cache_extensions { + my $grp = IO::AIO::aio_group; + + add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub { + for (grep /\.ext$/, @{$_[0]}) { + add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data; } - die $@; - } + }; + + $grp +} - push @EXTS, $pkg; +sub _ext_cfg_reg($$$$) { + my ($rvar, $varname, $cfgname, $default) = @_; + + $cfgname = lc $varname + unless length $cfgname; + + $EXT_CFG{$cfgname} = [$rvar, $default]; + + $$rvar = exists $CFG{$cfgname} ? $CFG{$cfgname} : $default; } sub load_extensions { - for my $ext (<$LIBDIR/*.ext>) { - next unless -r $ext; - eval { - load_extension $ext; - 1 - } or warn "$ext not loaded: $@"; - } + info "loading extensions..."; + + %EXT_CFG = (); + + cf::sync_job { + my %todo; + + for my $path (<$LIBDIR/*.ext>) { + next unless -r $path; + + $path =~ /([^\/\\]+)\.ext$/ or die "$path"; + my $base = $1; + my $pkg = $1; + $pkg =~ s/[^[:word:]]/_/g; + $pkg = "ext::$pkg"; + + open my $fh, "<:utf8", $path + or die "$path: $!"; + + my $source = do { local $/; <$fh> }; + + my %ext = ( + path => $path, + base => $base, + pkg => $pkg, + ); + + $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 } + if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m; + + $ext{source} = + "package $pkg; use common::sense;\n" + . "#line 1 \"$path\"\n{\n" + . $source + . "\n};\n1"; + + $todo{$base} = \%ext; + } + + my $pass = 0; + my %done; + while (%todo) { + my $progress; + + ++$pass; + + ext: + while (my ($k, $v) = each %todo) { + for (split /,\s*/, $v->{meta}{depends}) { + next ext + unless exists $done{$_}; + } + + trace "... pass $pass, loading '$k' into '$v->{pkg}'\n"; + + my $source = $v->{source}; + + # support "CONF varname :confname = default" pseudo-statements + $source =~ s{ + ^ CONF \s+ ([^\s:=]+) \s* (?:: \s* ([^\s:=]+) \s* )? = ([^\n#]+) + }{ + "our \$$1; BEGIN { cf::_ext_cfg_reg \\\$$1, q\x00$1\x00, q\x00$2\x00, $3 }"; + }gmxe; + + my $active = eval $source; + + if (length $@) { + error "$v->{path}: $@\n"; + + cf::cleanup "mandatory extension '$k' failed to load, exiting." + if exists $v->{meta}{mandatory}; + + warn "$v->{base}: optional extension cannot be loaded, skipping.\n"; + delete $todo{$k}; + } else { + $done{$k} = delete $todo{$k}; + push @EXTS, $v->{pkg}; + $progress = 1; + + info "$v->{base}: extension inactive.\n" + unless $active; + } + } + + unless ($progress) { + warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"; + + while (my ($k, $v) = each %todo) { + cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting." + if exists $v->{meta}{mandatory}; + } + + last; + } + } + }; } ############################################################################# +=back + =head2 CORE EXTENSIONS -Functions and methods that extend core crossfire objects. +Functions and methods that extend core deliantra objects. =cut @@ -929,6 +1698,20 @@ =over 4 +=item cf::player::num_playing + +Returns the official number of playing players, as per the Crossfire metaserver rules. + +=cut + +sub num_playing { + scalar grep + $_->ob->map + && !$_->hidden + && !$_->ob->flag (cf::FLAG_WIZ), + cf::player::list +} + =item cf::player::find $login Returns the given player object, loading it if necessary (might block). @@ -936,17 +1719,14 @@ =cut sub playerdir($) { - cf::localdir - . "/" - . cf::playerdir - . "/" + "$PLAYERDIR/" . (ref $_[0] ? $_[0]->ob->name : $_[0]) } sub path($) { my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; - (playerdir $login) . "/$login.pl" + (playerdir $login) . "/playerdata" } sub find_active($) { @@ -959,7 +1739,7 @@ my ($login) = @_; $cf::PLAYER{$login} - or cf::sync_job { !aio_stat $login } + or !aio_stat path $login } sub find($) { @@ -969,13 +1749,39 @@ my $guard = cf::lock_acquire "user_find:$login"; $cf::PLAYER{$_[0]} || do { - my $pl = load_pl path $login + # rename old playerfiles to new ones + #TODO: remove when no longer required + aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst"; + aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata"; + aio_unlink +(playerdir $login) . "/$login.pl.pst"; + aio_unlink +(playerdir $login) . "/$login.pl"; + + my $f = new_from_file cf::object::thawer path $login + or return; + + my $pl = cf::player::load_pl $f or return; + + local $cf::PLAYER_LOADING{$login} = $pl; + $f->resolve_delayed_derefs; $cf::PLAYER{$login} = $pl } } } +cf::player->attach ( + on_load => sub { + my ($pl, $path) = @_; + + # restore slots saved in save, below + my $slots = delete $pl->{_slots}; + + $pl->ob->current_weapon ($slots->[0]); + $pl->combat_ob ($slots->[1]); + $pl->ranged_ob ($slots->[2]); + }, +); + sub save($) { my ($pl) = @_; @@ -989,8 +1795,13 @@ aio_mkdir playerdir $pl, 0770; $pl->{last_save} = $cf::RUNTIME; + cf::get_slot 0.01; + + # save slots, to be restored later + local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob]; + $pl->save_pl ($path); - Coro::cede; + cf::cede_to_tick; } sub new($) { @@ -1006,6 +1817,16 @@ $self } +=item $player->send_msg ($channel, $msg, $color, [extra...]) + +=cut + +sub send_msg { + my $ns = shift->ns + or return; + $ns->send_msg (@_); +} + =item $pl->quit_character Nukes the player without looking back. If logged in, the connection will @@ -1016,12 +1837,18 @@ sub quit_character { my ($pl) = @_; + my $name = $pl->ob->name; + $pl->{deny_save} = 1; - $pl->password ("*"); # this should lock out the player until we nuked the dir + $pl->password ("*"); # this should lock out the player until we have nuked the dir - $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; + $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->ns; $pl->deactivate; - $pl->invoke (cf::EVENT_PLAYER_QUIT); + + my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy; + $pl->invoke (cf::EVENT_PLAYER_QUIT) if $pl->ns; + ext::highscore::check ($pl->ob); + $pl->ns->destroy if $pl->ns; my $path = playerdir $pl; @@ -1029,9 +1856,29 @@ aio_rename $path, $temp; delete $cf::PLAYER{$pl->ob->name}; $pl->destroy; + + my $prefix = qr<^~\Q$name\E/>; + + # nuke player maps + $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP; + IO::AIO::aio_rmtree $temp; } +=item $pl->kick + +Kicks a player out of the game. This destroys the connection. + +=cut + +sub kick { + my ($pl, $kicker) = @_; + + $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker); + $pl->killer ("kicked"); + $pl->ns->destroy; +} + =item cf::player::list_logins Returns am arrayref of all valid playernames in the system, can take a @@ -1040,15 +1887,21 @@ =cut sub list_logins { - my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir + my $dirs = aio_readdir $PLAYERDIR or return []; my @logins; for my $login (@$dirs) { - my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; - aio_read $fh, 0, 512, my $buf, 0 or next; - $buf !~ /^password -------------$/m or next; # official not-valid tag + my $path = path $login; + + # a .pst is a dead give-away for a valid player + # if no pst file found, open and chekc for blocked users + if (aio_stat "$path.pst") { + my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next; + aio_read $fh, 0, 512, my $buf, 0 or next; + $buf !~ /^password -------------$/m or next; # official not-valid tag + } utf8::decode $login; push @logins, $login; @@ -1059,6 +1912,8 @@ =item $player->maps +=item cf::player::maps $login + Returns an arrayref of map paths that are private for this player. May block. @@ -1067,6 +1922,8 @@ sub maps($) { my ($pl) = @_; + $pl = ref $pl ? $pl->ob->name : $pl; + my $files = aio_readdir playerdir $pl or return; @@ -1077,31 +1934,60 @@ next if /\.(?:pl|pst)$/; next unless /^$PATH_SEP/o; - s/\.map$//; - push @paths, "~" . $pl->ob->name . "/" . $_; + push @paths, cf::map::normalise "~$pl/$_"; } \@paths } -=item $player->ext_reply ($msgid, $msgtype, %msg) +=item $protocol_xml = $player->expand_cfpod ($cfpod) -Sends an ext reply to the player. +Expand deliantra pod fragments into protocol xml. -=cut +=item $player->ext_msg ($type, @msg) + +Sends an ext event to the client. -sub ext_reply($$$%) { - my ($self, $id, %msg) = @_; +=cut - $msg{msgid} = $id; +sub ext_msg($$@) { + my ($self, $type, @msg) = @_; - $self->send ("ext " . cf::to_json \%msg); + $self->ns->ext_msg ($type, @msg); } -package cf; +=head3 cf::region -=back +=over 4 +=cut + +package cf::region; + +=item cf::region::find_by_path $path + +Tries to decuce the likely region for a map knowing only its path. + +=cut + +sub find_by_path($) { + my ($path) = @_; + + $path =~ s/^~[^\/]*//; # skip ~login + + my ($match, $specificity); + + for my $region (list) { + if ($region->{match} && $path =~ $region->{match}) { + ($match, $specificity) = ($region, $region->specificity) + if $region->specificity > $specificity; + } + } + + $match +} + +=back =head3 cf::map @@ -1124,34 +2010,30 @@ sub generate_random_map { my ($self, $rmp) = @_; - # mit "rum" bekleckern, nicht - $self->_create_random_map ( - $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, - $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, - $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, - $rmp->{exit_on_final_map}, - $rmp->{xsize}, $rmp->{ysize}, - $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, - $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, - $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, - $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, - $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, - (cf::region::find $rmp->{region}), $rmp->{custom} - ) + my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM + + $self->_create_random_map ($rmp); } +=item cf::map->register ($regex, $prio) + +Register a handler for the map path matching the given regex at the +givne priority (higher is better, built-in handlers have priority 0, the +default). + +=cut + sub register { - my (undef, $regex) = @_; + my (undef, $regex, $prio) = @_; my $pkg = caller; - no strict; push @{"$pkg\::ISA"}, __PACKAGE__; - $EXT_MAP{$pkg} = qr<$regex>; + $EXT_MAP{$pkg} = [$prio, qr<$regex>]; } # also paths starting with '/' -$EXT_MAP{"cf::map"} = qr{^(?=/)}; +$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}]; sub thawer_merge { my ($self, $merge) = @_; @@ -1159,8 +2041,6 @@ # we have to keep some variables in memory intact local $self->{path}; local $self->{load_path}; - local $self->{deny_save}; - local $self->{deny_reset}; $self->SUPER::thawer_merge ($merge); } @@ -1168,6 +2048,10 @@ sub normalise { my ($path, $base) = @_; + $path = "$path"; # make sure it's a string + + $path =~ s/\.map$//; + # map plan: # # /! non-realised random map exit (special hack!) @@ -1189,7 +2073,6 @@ } for ($path) { - redo if s{//}{/}; redo if s{/\.?/}{/}; redo if s{/[^/]+/\.\./}{/}; } @@ -1204,8 +2087,8 @@ $path = normalise $path, $base; - for my $pkg (keys %EXT_MAP) { - if ($path =~ $EXT_MAP{$pkg}) { + for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) { + if ($path =~ $EXT_MAP{$pkg}[1]) { my $self = bless cf::map::new, $pkg; $self->{path} = $path; $self->path ($path); $self->init; # pass $1 etc. @@ -1213,10 +2096,11 @@ } } - Carp::carp "unable to resolve path '$path'."; + Carp::cluck "unable to resolve path '$path' (base '$base')"; () } +# may re-bless or do other evil things sub init { my ($self) = @_; @@ -1238,32 +2122,31 @@ sub load_path { my ($self) = @_; - sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} + "$MAPDIR/$self->{path}.map" } # the temporary/swap location sub save_path { my ($self) = @_; - (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; - sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path + (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go; + "$TMPDIR/$path.map" } # the unique path, undef == no special unique path sub uniq_path { my ($self) = @_; - (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; - sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path + (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go; + "$UNIQUEDIR/$path" } -# and all this just because we cannot iterate over -# all maps in C++... -sub change_all_map_light { - my ($change) = @_; +sub decay_objects { + my ($self) = @_; + + return if $self->{deny_reset}; - $_->change_map_light ($change) - for grep $_->outdoor, values %cf::MAP; + $self->do_decay_objects; } sub unlink_save { @@ -1278,48 +2161,72 @@ my ($self, $path) = @_; utf8::encode $path; - aio_open $path, O_RDONLY, 0 + my $f = new_from_file cf::object::thawer $path or return; - $self->_load_header ($path) + $self->_load_header ($f) or return; + local $MAP_LOADING{$self->{path}} = $self; + $f->resolve_delayed_derefs; + $self->{load_path} = $path; 1 } -sub load_orig { +# used to laod the header of an original map +sub load_header_orig { my ($self) = @_; $self->load_header_from ($self->load_path) } -sub load_temp { +# used to laod the header of an instantiated map +sub load_header_temp { my ($self) = @_; $self->load_header_from ($self->save_path) } +# called after loading the header from an instantiated map +sub prepare_temp { + my ($self) = @_; + + $self->last_access ((delete $self->{last_access}) + || $cf::RUNTIME); #d# + # safety + $self->{instantiate_time} = $cf::RUNTIME + if $self->{instantiate_time} > $cf::RUNTIME; +} + +# called after loading the header from an original map +sub prepare_orig { + my ($self) = @_; + + $self->{load_original} = 1; + $self->{instantiate_time} = $cf::RUNTIME; + $self->last_access ($cf::RUNTIME); + $self->instantiate; +} + sub load_header { my ($self) = @_; - if ($self->load_temp) { - $self->last_access ((delete $self->{last_access}) - || $cf::RUNTIME); #d# - # safety - $self->{instantiate_time} = $cf::RUNTIME - if $self->{instantiate_time} > $cf::RUNTIME; + if ($self->load_header_temp) { + $self->prepare_temp; } else { - $self->load_orig + $self->load_header_orig or return; - - $self->{load_original} = 1; - $self->{instantiate_time} = $cf::RUNTIME; - $self->last_access ($cf::RUNTIME); - $self->instantiate; + $self->prepare_orig; } + $self->{deny_reset} = 1 + if $self->no_reset; + + $self->default_region (cf::region::find_by_path $self->{path}) + unless $self->default_region; + 1 } @@ -1327,12 +2234,14 @@ sub find { my ($path, $origin) = @_; - $path = normalise $path, $origin && $origin->path; + cf::cede_to_tick; - cf::lock_wait "map_find:$path"; + $path = normalise $path, $origin; + + my $guard1 = cf::lock_acquire "map_data:$path";#d#remove + my $guard2 = cf::lock_acquire "map_find:$path"; $cf::MAP{$path} || do { - my $guard = cf::lock_acquire "map_find:$path"; my $map = new_from_path cf::map $path or return; @@ -1341,142 +2250,164 @@ $map->load_header or return; - if ($map->should_reset) { - $cf::WAIT_FOR_TICK->wait; + if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?) + # doing this can freeze the server in a sync job, obviously + #$cf::WAIT_FOR_TICK->wait; + undef $guard2; + undef $guard1; $map->reset; - undef $guard; - $map = find $path - or return; + return find $path; } $cf::MAP{$path} = $map } } +sub pre_load { } +#sub post_load { } # XS + sub load { my ($self) = @_; + local $self->{deny_reset} = 1; # loading can take a long time + my $path = $self->{path}; - my $guard = cf::lock_acquire "map_load:$path"; - return if $self->in_memory != cf::MAP_SWAPPED; + { + my $guard = cf::lock_acquire "map_data:$path"; - $self->in_memory (cf::MAP_LOADING); + return unless $self->valid; + return unless $self->state == cf::MAP_SWAPPED; - $self->alloc; - $self->_load_objects ($self->{load_path}, 1) - or return; + $self->alloc; - $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) - if delete $self->{load_original}; + $self->pre_load; + cf::cede_to_tick; - if (my $uniq = $self->uniq_path) { - utf8::encode $uniq; - if (aio_open $uniq, O_RDONLY, 0) { - $self->clear_unique_items; - $self->_load_objects ($uniq, 0); - } - } + if (exists $self->{load_path}) { + my $f = new_from_file cf::object::thawer $self->{load_path}; + $f->skip_block; + $self->_load_objects ($f) + or return; + + $self->post_load_original + if delete $self->{load_original}; + + if (my $uniq = $self->uniq_path) { + utf8::encode $uniq; + unless (aio_stat $uniq) { + if (my $f = new_from_file cf::object::thawer $uniq) { + $self->clear_unique_items; + $self->_load_objects ($f); + $f->resolve_delayed_derefs; + } + } + } - Coro::cede; + $f->resolve_delayed_derefs; + } else { + $self->post_load_original + if delete $self->{load_original}; + } - # now do the right thing for maps - $self->link_multipart_objects; + $self->state (cf::MAP_INACTIVE); - unless ($self->{deny_activate}) { - $self->decay_objects; - $self->fix_auto_apply; - $self->update_buttons; - Coro::cede; - $self->set_darkness_map; + cf::cede_to_tick; + # now do the right thing for maps + $self->link_multipart_objects; $self->difficulty ($self->estimate_difficulty) unless $self->difficulty; - Coro::cede; - $self->activate; + cf::cede_to_tick; + + unless ($self->{deny_activate}) { + $self->decay_objects; + $self->fix_auto_apply; + $self->update_buttons; + cf::cede_to_tick; + #$self->activate; # no longer activate maps automatically + } + + $self->{last_save} = $cf::RUNTIME; + $self->last_access ($cf::RUNTIME); } - $self->in_memory (cf::MAP_IN_MEMORY); + $self->post_load; + + 1 } +# customize the map for a given player, i.e. +# return the _real_ map. used by e.g. per-player +# maps to change the path to ~playername/mappath sub customise_for { my ($self, $ob) = @_; return find "~" . $ob->name . "/" . $self->{path} if $self->per_player; - $self -} - -# find and load all maps in the 3x3 area around a map -sub load_diag { - my ($map) = @_; +# return find "?party/" . $ob->name . "/" . $self->{path} +# if $self->per_party; - my @diag; # diagonal neighbours - - for (0 .. 3) { - my $neigh = $map->tile_path ($_) - or next; - $neigh = find $neigh, $map - or next; - $neigh->load; - - push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], - [$neigh->tile_path (($_ + 1) % 4), $neigh]; - } - - for (@diag) { - my $neigh = find @$_ - or next; - $neigh->load; - } + $self } sub find_sync { my ($path, $origin) = @_; - cf::sync_job { find $path, $origin } + # it's a bug to call this from the main context + return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync" + if $Coro::current == $Coro::main; + + find $path, $origin } sub do_load_sync { my ($map) = @_; - cf::sync_job { $map->load }; + # it's a bug to call this from the main context + return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync" + if $Coro::current == $Coro::main; + + $map->load; } our %MAP_PREFETCH; -our $MAP_PREFETCHER = Coro::async { - while () { - for my $path (keys %MAP_PREFETCH) { - my $map = find $path - or next; - $map->load; - - delete $MAP_PREFETCH{$path}; - } - Coro::schedule; - } -}; +our $MAP_PREFETCHER = undef; sub find_async { - my ($path, $origin) = @_; + my ($path, $origin, $load) = @_; - $path = normalise $path, $origin && $origin->{path}; + $path = normalise $path, $origin; if (my $map = $cf::MAP{$path}) { - return $map if $map->in_memory == cf::MAP_IN_MEMORY; + return $map if !$load || $map->linkable; } - $MAP_PREFETCH{$path} = 0; - $MAP_PREFETCHER->ready; + $MAP_PREFETCH{$path} |= $load; + + $MAP_PREFETCHER ||= cf::async { + $Coro::current->{desc} = "map prefetcher"; + + while (%MAP_PREFETCH) { + while (my ($k, $v) = each %MAP_PREFETCH) { + if (my $map = find $k) { + $map->load if $v; + } + + delete $MAP_PREFETCH{$k}; + } + } + undef $MAP_PREFETCHER; + }; + $MAP_PREFETCHER->prio (6); () } -sub save { +# common code, used by both ->save and ->swapout +sub _save { my ($self) = @_; - my $lock = cf::lock_acquire "map_data:" . $self->path; - $self->{last_save} = $cf::RUNTIME; return unless $self->dirty; @@ -1491,9 +2422,12 @@ local $self->{last_access} = $self->last_access;#d# cf::async { + $Coro::current->{desc} = "map player save"; $_->contr->save for $self->players; }; + cf::get_slot 0.02; + if ($uniq) { $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); $self->_save_objects ($uniq, cf::IO_UNIQUES); @@ -1502,27 +2436,39 @@ } } -sub swap_out { +sub save { my ($self) = @_; - # save first because save cedes - $self->save; + my $lock = cf::lock_acquire "map_data:$self->{path}"; + + $self->_save; +} - my $lock = cf::lock_acquire "map_data:" . $self->path; +sub swap_out { + my ($self) = @_; - return if $self->players; - return if $self->in_memory != cf::MAP_IN_MEMORY; + my $lock = cf::lock_acquire "map_data:$self->{path}"; + + return if !$self->linkable; return if $self->{deny_save}; + return if $self->players; + # first deactivate the map and "unlink" it from the core + $self->deactivate; + $_->clear_links_to ($self) for values %cf::MAP; + $self->state (cf::MAP_SWAPPED); + + # then atomically save + $self->_save; + + # then free the map $self->clear; - $self->in_memory (cf::MAP_SWAPPED); } sub reset_at { my ($self) = @_; # TODO: safety, remove and allow resettable per-player maps - return 1e99 if $self->isa ("ext::map_per_player");#d# return 1e99 if $self->{deny_reset}; my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; @@ -1543,16 +2489,24 @@ my $lock = cf::lock_acquire "map_data:$self->{path}"; return if $self->players; - return if $self->isa ("ext::map_per_player");#d# - warn "resetting map ", $self->path;#d# + cf::trace "resetting map ", $self->path, "\n"; - delete $cf::MAP{$self->path}; + $self->state (cf::MAP_SWAPPED); - $self->in_memory (cf::MAP_SWAPPED); - $self->clear; + # need to save uniques path + unless ($self->{deny_save}) { + my $uniq = $self->uniq_path; utf8::encode $uniq; + + $self->_save_objects ($uniq, cf::IO_UNIQUES) + if $uniq; + } + + delete $cf::MAP{$self->path}; + $self->deactivate; $_->clear_links_to ($self) for values %cf::MAP; + $self->clear; $self->unlink_save; $self->destroy; @@ -1563,21 +2517,61 @@ sub nuke { my ($self) = @_; - delete $cf::MAP{$self->path}; + { + my $lock = cf::lock_acquire "map_data:$self->{path}"; - $self->unlink_save; + delete $cf::MAP{$self->path}; - bless $self, "cf::map"; - delete $self->{deny_reset}; - $self->{deny_save} = 1; - $self->reset_timeout (1); - $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); + $self->unlink_save; + + bless $self, "cf::map::wrap"; + delete $self->{deny_reset}; + $self->{deny_save} = 1; + $self->reset_timeout (1); + $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); - $cf::MAP{$self->path} = $self; + $cf::MAP{$self->path} = $self; + } $self->reset; # polite request, might not happen } +=item $maps = cf::map::tmp_maps + +Returns an arrayref with all map paths of currently instantiated and saved +maps. May block. + +=cut + +sub tmp_maps() { + [ + map { + utf8::decode $_; + /\.map$/ + ? normalise $_ + : () + } @{ aio_readdir $TMPDIR or [] } + ] +} + +=item $maps = cf::map::random_maps + +Returns an arrayref with all map paths of currently instantiated and saved +random maps. May block. + +=cut + +sub random_maps() { + [ + map { + utf8::decode $_; + /\.map$/ + ? normalise "?random/$_" + : () + } @{ aio_readdir $RANDOMDIR or [] } + ] +} + =item cf::map::unique_maps Returns an arrayref of paths of all shared maps that have @@ -1586,25 +2580,49 @@ =cut sub unique_maps() { - my $files = aio_readdir cf::localdir . "/" . cf::uniquedir - or return; + [ + map { + utf8::decode $_; + s/\.map$//; # TODO future compatibility hack + /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/ + ? () + : normalise $_ + } @{ aio_readdir $UNIQUEDIR or [] } + ] +} + +=item cf::map::static_maps + +Returns an arrayref if paths of all static maps (all preinstalled F<.map> +file in the shared directory excluding F and F). May +block. - my @paths; +=cut - for (@$files) { - utf8::decode $_; - next if /\.pst$/; - next unless /^$PATH_SEP/o; +sub static_maps() { + my @dirs = ""; + my @maps; - s/\.map$//; - push @paths, $_; + while (@dirs) { + my $dir = shift @dirs; + + next if $dir eq "/styles" || $dir eq "/editor"; + + my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2 + or return; + + for (@$files) { + s/\.map$// or next; + utf8::decode $_; + push @maps, "$dir/$_"; + } + + push @dirs, map "$dir/$_", @$dirs; } - \@paths + \@maps } -package cf; - =back =head3 cf::object @@ -1617,7 +2635,8 @@ =item $ob->inv_recursive -Returns the inventory of the object _and_ their inventories, recursively. +Returns the inventory of the object I their inventories, recursively, +but I the object itself. =cut @@ -1630,6 +2649,34 @@ inv_recursive_ inv $_[0] } +=item $ref = $ob->ref + +Creates and returns a persistent reference to an object that can be stored as a string. + +=item $ob = cf::object::deref ($refstring) + +returns the objetc referenced by refstring. may return undef when it cnanot find the object, +even if the object actually exists. May block. + +=cut + +sub deref { + my ($ref) = @_; + + if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) { + my ($uuid, $name) = ($1, $2); + my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name + or return; + $pl->ob->uuid eq $uuid + or return; + + $pl->ob + } else { + warn "$ref: cannot resolve object reference\n"; + undef + } +} + package cf; =back @@ -1646,6 +2693,20 @@ =cut +our $SAY_CHANNEL = { + id => "say", + title => "Map", + reply => "say ", + tooltip => "Things said to and replied from NPCs near you and other players on the same map only.", +}; + +our $CHAT_CHANNEL = { + id => "chat", + title => "Chat", + reply => "chat ", + tooltip => "Player chat and shouts, global to the server.", +}; + # rough implementation of a future "reply" method that works # with dialog boxes. #TODO: the first argument must go, split into a $npc->reply_to ( method @@ -1656,12 +2717,31 @@ if ($self->{record_replies}) { push @{ $self->{record_replies} }, [$npc, $msg, $flags]; + } else { - $msg = $npc->name . " says: $msg" if $npc; - $self->message ($msg, $flags); + my $pl = $self->contr; + + if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) { + my $dialog = $pl->{npc_dialog}; + $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg)); + + } else { + $msg = $npc->name . " says: $msg" if $npc; + $self->send_msg ($SAY_CHANNEL => $msg, $flags); + } } } +=item $object->send_msg ($channel, $msg, $color, [extra...]) + +=cut + +sub cf::object::send_msg { + my $pl = shift->contr + or return; + $pl->send_msg (@_); +} + =item $player_object->may ("access") Returns wether the given player is authorized to access resource "access" @@ -1682,8 +2762,10 @@ Freezes the player and moves him/her to a special map (C<{link}>). -The player should be reasonably safe there for short amounts of time. You -I call C as soon as possible, though. +The player should be reasonably safe there for short amounts of time (e.g. +for loading a map). You I call C as soon as possible, +though, as the player cannot control the character while it is on the link +map. Will never block. @@ -1701,7 +2783,7 @@ sub link_map { unless ($LINK_MAP) { $LINK_MAP = cf::map::find "{link}" - or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; + or cf::cleanup "FATAL: unable to provide {link} map, exiting."; $LINK_MAP->load; } @@ -1713,17 +2795,21 @@ $self->deactivate_recursive; + ++$self->{_link_recursion}; + return if UNIVERSAL::isa $self->map, "ext::map_link"; $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] - if $self->map; + if $self->map && $self->map->{path} ne "{link}"; - $self->enter_map ($LINK_MAP || link_map, 20, 20); + $self->enter_map ($LINK_MAP || link_map, 3, 3); } sub cf::object::player::leave_link { my ($self, $map, $x, $y) = @_; + return unless $self->contr->active; + my $link_pos = delete $self->{_link_pos}; unless ($map) { @@ -1743,67 +2829,97 @@ # use -1 or undef as default coordinates, not 0, 0 ($x, $y) = ($map->enter_x, $map->enter_y) - if $x <=0 && $y <= 0; + if $x <= 0 && $y <= 0; $map->load; - $map->load_diag; return unless $self->contr->active; - $self->activate_recursive; - $self->enter_map ($map, $x, $y); -} -cf::player->attach ( - on_logout => sub { - my ($pl) = @_; + local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext + if ($self->enter_map ($map, $x, $y)) { + # entering was successful + delete $self->{_link_recursion}; + # only activate afterwards, to support waiting in hooks + $self->activate_recursive; + } - # abort map switching before logout - if ($pl->ob->{_link_pos}) { - cf::sync_job { - $pl->ob->leave_link - }; - } - }, - on_login => sub { - my ($pl) = @_; +} - # try to abort aborted map switching on player login :) - # should happen only on crashes - if ($pl->ob->{_link_pos}) { - $pl->ob->enter_link; - (async { - # we need this sleep as the login has a concurrent enter_exit running - # and this sleep increases chances of the player not ending up in scorn - $pl->ob->reply (undef, - "There was an internal problem at your last logout, " - . "the server will try to bring you to your intended destination in a second.", - cf::NDI_RED); - Coro::Timer::sleep 1; - $pl->ob->leave_link; - })->prio (2); - } - }, -); +=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]]) + +Moves the player to the given map-path and coordinates by first freezing +her, loading and preparing them map, calling the provided $check callback +that has to return the map if sucecssful, and then unfreezes the player on +the new (success) or old (failed) map position. In either case, $done will +be called at the end of this process. -=item $player_object->goto ($path, $x, $y) +Note that $check will be called with a potentially non-loaded map, so if +it needs a loaded map it has to call C<< ->load >>. =cut +our $GOTOGEN; + sub cf::object::player::goto { - my ($self, $path, $x, $y) = @_; + my ($self, $path, $x, $y, $check, $done) = @_; + + if ($self->{_link_recursion} >= $MAX_LINKS) { + error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting."; + $self->failmsg ("Something went wrong inside the server - please contact an administrator!"); + ($path, $x, $y) = @$EMERGENCY_POSITION; + } + + # do generation counting so two concurrent goto's will be executed in-order + my $gen = $self->{_goto_generation} = ++$GOTOGEN; $self->enter_link; (async { - my $map = cf::map::find $path; - $map = $map->customise_for ($self) if $map; + $Coro::current->{desc} = "player::goto $path $x $y"; -# warn "entering ", $map->path, " at ($x, $y)\n" -# if $map; + # *tag paths override both path and x|y + if ($path =~ /^\*(.*)$/) { + if (my @obs = grep $_->map, ext::map_tags::find $1) { + my $ob = $obs[rand @obs]; + + # see if we actually can go there + if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) { + $ob = $obs[rand @obs]; + } else { + $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED); + } + # else put us there anyways for now #d# - $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); + ($path, $x, $y) = ($ob->map, $ob->x, $ob->y); + } else { + ($path, $x, $y) = (undef, undef, undef); + } + } + + my $map = eval { + my $map = defined $path ? cf::map::find $path, $self->map : undef; + + if ($map) { + $map = $map->customise_for ($self); + $map = $check->($map, $x, $y, $self) if $check && $map; + } else { + $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED); + } + + $map + }; - $self->leave_link ($map, $x, $y); + if ($@) { + $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED); + LOG llevError | logBacktrace, Carp::longmess $@; + } + + if ($gen == $self->{_goto_generation}) { + delete $self->{_goto_generation}; + $self->leave_link ($map, $x, $y); + } + + $done->($self) if $done; })->prio (1); } @@ -1815,8 +2931,10 @@ my ($spec) = @_; my $rmp = { # defaults - xsize => 10, - ysize => 10, + xsize => (cf::rndm 15, 40), + ysize => (cf::rndm 15, 40), + symmetry => (cf::rndm 1, cf::SYMMETRY_XY), + #layout => string, }; for (split /\n/, $spec) { @@ -1838,25 +2956,31 @@ my $rmp = parse_random_map_params $exit->msg; if ($exit->map) { - $rmp->{region} = $exit->map->region_name; + $rmp->{region} = $exit->region->name; $rmp->{origin_map} = $exit->map->path; $rmp->{origin_x} = $exit->x; $rmp->{origin_y} = $exit->y; + + $exit->map->touch; } $rmp->{random_seed} ||= $exit->random_seed; - my $data = cf::to_json $rmp; + my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp); my $md5 = Digest::MD5::md5_hex $data; - my $meta = "$cf::RANDOM_MAPS/$md5.meta"; + my $meta = "$RANDOMDIR/$md5.meta"; if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { aio_write $fh, 0, (length $data), $data, 0; undef $fh; aio_rename "$meta~", $meta; - $exit->slaying ("?random/$md5"); - $exit->msg (undef); + my $slaying = "?random/$md5"; + + if ($exit->valid) { + $exit->slaying ("?random/$md5"); + $exit->msg (undef); + } } } @@ -1868,22 +2992,52 @@ $self->enter_link; (async { - $self->deactivate_recursive; # just to be sure + $Coro::current->{desc} = "enter_exit"; + unless (eval { - prepare_random_map $exit - if $exit->slaying eq "/!"; + $self->deactivate_recursive; # just to be sure + + my $map = cf::map::normalise $exit->slaying, $exit->map; + my $x = $exit->stats->hp; + my $y = $exit->stats->sp; + + # special map handling + my $slaying = $exit->slaying; - my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path; - $self->goto ($path, $exit->stats->hp, $exit->stats->sp); + # special map handling + if ($slaying eq "/!") { + my $guard = cf::lock_acquire "exit_prepare:$exit"; - 1; + prepare_random_map $exit + if $exit->slaying eq "/!"; # need to re-check after getting the lock + + $map = $exit->slaying; + + } elsif ($slaying eq '!up') { + $map = $exit->map->tile_path (cf::TILE_UP); + $x = $exit->x; + $y = $exit->y; + + } elsif ($slaying eq '!down') { + $map = $exit->map->tile_path (cf::TILE_DOWN); + $x = $exit->x; + $y = $exit->y; + } + + $self->goto ($map, $x, $y); + + # if exit is damned, update players death & WoR home-position + $self->contr->savebed ($map, $x, $y) + if $exit->flag (cf::FLAG_DAMNED); + + 1 }) { - $self->message ("Something went wrong deep within the crossfire server. " - . "I'll try to bring you back to the map you were before. " - . "Please report this to the dungeon master!", - cf::NDI_UNIQUE | cf::NDI_RED); + $self->message ("Something went wrong deep within the deliantra server. " + . "I'll try to bring you back to the map you were before. " + . "Please report this to the dungeon master!", + cf::NDI_UNIQUE | cf::NDI_RED); - warn "ERROR in enter_exit: $@"; + error "ERROR in enter_exit: $@"; $self->leave_link; } })->prio (1); @@ -1904,9 +3058,207 @@ my ($self, $text, $flags) = @_; utf8::encode $text; - $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); + $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); } +=item $client->send_big_packet ($pkt) + +Like C, but tries to compress large packets, and fragments +them as required. + +=cut + +our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64; + +sub cf::client::send_big_packet { + my ($self, $pkt) = @_; + + # try lzf for large packets + $pkt = "lzf " . Compress::LZF::compress $pkt + if 1024 <= length $pkt and $self->{can_lzf}; + + # split very large packets + if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) { + $self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt; + $pkt = "frag"; + } + + $self->send_packet ($pkt); +} + +=item $client->send_msg ($channel, $msg, $color, [extra...]) + +Send a drawinfo or msg packet to the client, formatting the msg for the +client if neccessary. C<$type> should be a string identifying the type of +the message, with C being the default. If C<$color> is negative, suppress +the message unless the client supports the msg packet. + +=cut + +# non-persistent channels (usually the info channel) +our %CHANNEL = ( + "c/motd" => { + id => "infobox", + title => "MOTD", + reply => undef, + tooltip => "The message of the day", + }, + "c/identify" => { + id => "infobox", + title => "Identify", + reply => undef, + tooltip => "Items recently identified", + }, + "c/examine" => { + id => "infobox", + title => "Examine", + reply => undef, + tooltip => "Signs and other items you examined", + }, + "c/shopinfo" => { + id => "infobox", + title => "Shop Info", + reply => undef, + tooltip => "What your bargaining skill tells you about the shop", + }, + "c/book" => { + id => "infobox", + title => "Book", + reply => undef, + tooltip => "The contents of a note or book", + }, + "c/lookat" => { + id => "infobox", + title => "Look", + reply => undef, + tooltip => "What you saw there", + }, + "c/who" => { + id => "infobox", + title => "Players", + reply => undef, + tooltip => "Shows players who are currently online", + }, + "c/body" => { + id => "infobox", + title => "Body Parts", + reply => undef, + tooltip => "Shows which body parts you posess and are available", + }, + "c/statistics" => { + id => "infobox", + title => "Statistics", + reply => undef, + tooltip => "Shows your primary statistics", + }, + "c/skills" => { + id => "infobox", + title => "Skills", + reply => undef, + tooltip => "Shows your experience per skill and item power", + }, + "c/shopitems" => { + id => "infobox", + title => "Shop Items", + reply => undef, + tooltip => "Shows the items currently for sale in this shop", + }, + "c/resistances" => { + id => "infobox", + title => "Resistances", + reply => undef, + tooltip => "Shows your resistances", + }, + "c/pets" => { + id => "infobox", + title => "Pets", + reply => undef, + tooltip => "Shows information abotu your pets/a specific pet", + }, + "c/perceiveself" => { + id => "infobox", + title => "Perceive Self", + reply => undef, + tooltip => "You gained detailed knowledge about yourself", + }, + "c/uptime" => { + id => "infobox", + title => "Uptime", + reply => undef, + tooltip => "How long the server has been running since last restart", + }, + "c/mapinfo" => { + id => "infobox", + title => "Map Info", + reply => undef, + tooltip => "Information related to the maps", + }, + "c/party" => { + id => "party", + title => "Party", + reply => "gsay ", + tooltip => "Messages and chat related to your party", + }, + "c/death" => { + id => "death", + title => "Death", + reply => undef, + tooltip => "Reason for and more info about your most recent death", + }, + "c/say" => $SAY_CHANNEL, + "c/chat" => $CHAT_CHANNEL, +); + +sub cf::client::send_msg { + my ($self, $channel, $msg, $color, @extra) = @_; + + $msg = $self->pl->expand_cfpod ($msg) + unless $color & cf::NDI_VERBATIM; + + $color &= cf::NDI_CLIENT_MASK; # just in case... + + # check predefined channels, for the benefit of C + if ($CHANNEL{$channel}) { + $channel = $CHANNEL{$channel}; + + $self->ext_msg (channel_info => $channel); + $channel = $channel->{id}; + + } elsif (ref $channel) { + # send meta info to client, if not yet sent + unless (exists $self->{channel}{$channel->{id}}) { + $self->{channel}{$channel->{id}} = $channel; + $self->ext_msg (channel_info => $channel); + } + + $channel = $channel->{id}; + } + + return unless @extra || length $msg; + + # default colour, mask it out + $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF) + if $color & cf::NDI_DEF; + + my $pkt = "msg " + . $self->{json_coder}->encode ( + [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra] + ); + + $self->send_big_packet ($pkt); +} + +=item $client->ext_msg ($type, @msg) + +Sends an ext event to the client. + +=cut + +sub cf::client::ext_msg($$@) { + my ($self, $type, @msg) = @_; + + $self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg])); +} =item $success = $client->query ($flags, "text", \&cb) @@ -1914,8 +3266,8 @@ the reply text on a reply. flags can be C, C or C or C<0>. -Queries can fail, so check the return code. Or don't, as queries will become -reliable at some point in the future. +Queries can fail, so check the return code. Or don't, as queries will +become reliable at some point in the future. =cut @@ -1933,9 +3285,16 @@ $self->send_packet ($self->{query_queue}[0][0]) if @{ $self->{query_queue} } == 1; + + 1 } cf::client->attach ( + on_connect => sub { + my ($ns) = @_; + + $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed; + }, on_reply => sub { my ($ns, $msg) = @_; @@ -1945,6 +3304,7 @@ or return; # be conservative, not sure how that can happen, but we saw a crash here (shift @$queue)->[1]->($msg); + return unless $ns->valid; # temporary(?) workaround for callback destroying socket push @{ $ns->{query_queue} }, @$queue; @@ -1956,6 +3316,39 @@ } } }, + on_exticmd => sub { + my ($ns, $buf) = @_; + + my $msg = eval { $ns->{json_coder}->decode ($buf) }; + + if (ref $msg) { + my ($type, $reply, @payload) = @$msg; # version 1 used %type, $id, %$hash + + if (my $cb = $EXTIACMD{$type}) { + $cb->( + $ns, + sub { + $ns->ext_msg ("reply-$reply", @_) + if $reply; + }, + @payload + ); + } else { + my @reply; + + if (my $cb = $EXTICMD{$type}) { + @reply = $cb->($ns, @payload); + } + + $ns->ext_msg ("reply-$reply", @reply) + if $reply; + } + } else { + error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n"; + } + + cf::override; + }, ); =item $client->async (\&cb) @@ -1981,7 +3374,7 @@ } cf::client->attach ( - on_destroy => sub { + on_client_destroy => sub { my ($ns) = @_; $_->cancel for values %{ (delete $ns->{_coro}) || {} }; @@ -2006,28 +3399,42 @@ $SIG{FPE} = 'IGNORE'; -$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); +$safe->permit_only (Opcode::opset qw( + :base_core :base_mem :base_orig :base_math :base_loop + grepstart grepwhile mapstart mapwhile + sort time +)); # here we export the classes and methods available to script code =pod -The following fucntions and emthods are available within a safe environment: +The following functions and methods are available within a safe environment: + + cf::object + contr pay_amount pay_player map x y force_find force_add destroy + insert remove name archname title slaying race decrease split + value - cf::object contr pay_amount pay_player map - cf::object::player player - cf::player peaceful - cf::map trigger + cf::object::player + player + + cf::player + peaceful + + cf::map + trigger =cut for ( - ["cf::object" => qw(contr pay_amount pay_player map)], + ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y + insert remove inv nrof name archname title slaying race + decrease split destroy change_exp value msg lore send_msg)], ["cf::object::player" => qw(player)], - ["cf::player" => qw(peaceful)], + ["cf::player" => qw(peaceful send_msg)], ["cf::map" => qw(trigger)], ) { - no strict 'refs'; my ($pkg, @funs) = @$_; *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) for @funs; @@ -2052,8 +3459,10 @@ $qcode =~ s/"/‟/g; # not allowed in #line filenames $qcode =~ s/\n/\\n/g; + %vars = (_dummy => 0) unless %vars; + + my @res; local $_; - local @safe::cf::_safe_eval_args = values %vars; my $eval = "do {\n" @@ -2063,14 +3472,20 @@ . "\n}" ; - sub_generation_inc; - my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); - sub_generation_inc; + if ($CFG{safe_eval}) { + sub_generation_inc; + local @safe::cf::_safe_eval_args = values %vars; + @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); + sub_generation_inc; + } else { + local @cf::_safe_eval_args = values %vars; + @res = wantarray ? eval eval : scalar eval $eval; + } if ($@) { - warn "$@"; - warn "while executing safe code '$code'\n"; - warn "with arguments " . (join " ", %vars) . "\n"; + warn "$@", + "while executing safe code '$code'\n", + "with arguments " . (join " ", %vars) . "\n"; } wantarray ? @res : $res[0] @@ -2094,8 +3509,8 @@ sub register_script_function { my ($fun, $cb) = @_; - no strict 'refs'; - *{"safe::$fun"} = $safe_hole->wrap ($cb); + $fun = "safe::$fun" if $CFG{safe_eval}; + *$fun = $safe_hole->wrap ($cb); } =back @@ -2103,119 +3518,231 @@ =cut ############################################################################# +# the server's init and main functions -=head2 EXTENSION DATABASE SUPPORT +our %FACEHASH; # hash => idx, #d# HACK for http server -Crossfire maintains a very simple database for extension use. It can -currently store anything that can be serialised using Storable, which -excludes objects. +# internal api, not fianlised +sub set_face { + my ($name, $type, $data) = @_; -The parameter C<$family> should best start with the name of the extension -using it, it should be unique. + my $idx = cf::face::find $name; -=over 4 + if ($idx) { + delete $FACEHASH{cf::face::get_chksum $idx}; + } else { + $idx = cf::face::alloc $name; + } -=item $hashref = cf::db_get $family + my $hash = cf::face::mangle_chksum Digest::MD5::md5 $data; -Return a hashref for use by the extension C<$family>, which can be -modified. After modifications, you have to call C or -C. + cf::face::set_type $idx, $type; + cf::face::set_data $idx, 0, $data, $hash; + cf::face::set_meta $idx, $type & 1 ? undef : undef; + $FACEHASH{$hash} = $idx;#d# -=item $value = cf::db_get $family => $key + $idx +} -Returns a single value from the database +sub load_facedata($) { + my ($path) = @_; -=item cf::db_put $family => $hashref + # HACK to clear player env face cache, we need some signal framework + # for this (global event?) + %ext::player_env::MUSIC_FACE_CACHE = (); -Stores the given family hashref into the database. Updates are delayed, if -you want the data to be synced to disk immediately, use C. + my $enc = JSON::XS->new->utf8->canonical->relaxed; -=item cf::db_put $family => $key => $value + trace "loading facedata from $path\n"; -Stores the given C<$value> in the family hash. Updates are delayed, if you -want the data to be synced to disk immediately, use C. + my $facedata = decode_storable load_file $path; -=item cf::db_dirty + $facedata->{version} == 2 + or cf::cleanup "$path: version mismatch, cannot proceed."; -Marks the database as dirty, to be updated at a later time. + cf::cede_to_tick; -=item cf::db_sync + { + my $faces = delete $facedata->{faceinfo}; -Immediately write the database to disk I. + for my $face (sort keys %$faces) { + my $info = $faces->{$face}; + my $idx = (cf::face::find $face) || cf::face::alloc $face; -=cut + cf::face::set_visibility $idx, $info->{visibility}; + cf::face::set_magicmap $idx, $info->{magicmap}; + cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32}; + cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64}; + cf::face::set_data $idx, 2, $info->{glyph} , $info->{glyph} ; + $FACEHASH{$info->{hash64}} = $idx;#d# + + cf::cede_to_tick; + } -our $DB; + while (my ($face, $info) = each %$faces) { + next unless $info->{smooth}; -{ - my $path = cf::localdir . "/database.pst"; + my $idx = cf::face::find $face + or next; - sub db_load() { - $DB = stat $path ? Storable::retrieve $path : { }; + if (my $smooth = cf::face::find $info->{smooth}) { + cf::face::set_smooth $idx, $smooth; + cf::face::set_smoothlevel $idx, $info->{smoothlevel}; + } else { + error "smooth face '$info->{smooth}' not found for face '$face'"; + } + + cf::cede_to_tick; + } } - my $pid; + { + my $anims = delete $facedata->{animinfo}; - sub db_save() { - waitpid $pid, 0 if $pid; - if (0 == ($pid = fork)) { - $DB->{_meta}{version} = 1; - Storable::nstore $DB, "$path~"; - rename "$path~", $path; - cf::_exit 0 if defined $pid; + while (my ($anim, $info) = each %$anims) { + cf::anim::set $anim, $info->{frames}, $info->{facings}; + cf::cede_to_tick; } + + cf::anim::invalidate_all; # d'oh } - my $dirty; + { + my $res = delete $facedata->{resource}; + + while (my ($name, $info) = each %$res) { + if (defined (my $type = $info->{type})) { + # TODO: different hash - must free and use new index, or cache ixface data queue + my $idx = (cf::face::find $name) || cf::face::alloc $name; - sub db_sync() { - db_save if $dirty; - undef $dirty; + cf::face::set_type $idx, $type; + cf::face::set_data $idx, 0, $info->{data}, $info->{hash}; + cf::face::set_meta $idx, $type & 1 ? undef : $info->{meta}; # preserve meta unless prepended already + $FACEHASH{$info->{hash}} = $idx;#d# + } else { +# $RESOURCE{$name} = $info; # unused + } + + cf::cede_to_tick; + } } - my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { - db_sync; - }); + cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE); + + 1 +} + +register_exticmd fx_want => sub { + my ($ns, $want) = @_; - sub db_dirty() { - $dirty = 1; - $idle->start; + while (my ($k, $v) = each %$want) { + $ns->fx_want ($k, $v); } +}; + +sub load_resource_file($) { + my $guard = lock_acquire "load_resource_file"; + + my $status = load_resource_file_ $_[0]; + get_slot 0.1, 100; + cf::arch::commit_load; + + $status +} + +sub reload_exp_table { + _reload_exp_table; + + set_face "res/exp_table" => FT_RSRC, + JSON::XS->new->utf8->canonical->encode ( + [map cf::level_to_min_exp $_, 1 .. cf::settings->max_level] + ); +} - sub db_get($;$) { - @_ >= 2 - ? $DB->{$_[0]}{$_[1]} - : ($DB->{$_[0]} ||= { }) +sub reload_materials { + _reload_materials; +} + +sub reload_regions { + # HACK to clear player env face cache, we need some signal framework + # for this (global event?) + %ext::player_env::MUSIC_FACE_CACHE = (); + + load_resource_file "$MAPDIR/regions" + or die "unable to load regions file\n"; + + for (cf::region::list) { + $_->{match} = qr/$_->{match}/ + if exists $_->{match}; } +} - sub db_put($$;$) { - if (@_ >= 3) { - $DB->{$_[0]}{$_[1]} = $_[2]; - } else { - $DB->{$_[0]} = $_[1]; - } - db_dirty; +sub reload_facedata { + load_facedata "$DATADIR/facedata" + or die "unable to load facedata\n"; +} + +sub reload_archetypes { + load_resource_file "$DATADIR/archetypes" + or die "unable to load archetypes\n"; + + set_face "res/skill_info" => FT_RSRC, + JSON::XS->new->utf8->canonical->encode ( + [map [cf::arch::skillvec ($_)->name], 0 .. cf::arch::skillvec_size - 1] + ); + set_face "res/spell_paths" => FT_RSRC, + JSON::XS->new->utf8->canonical->encode ( + [map [cf::spellpathnames ($_)], 0 .. NRSPELLPATHS - 1] + ); +} + +sub reload_treasures { + load_resource_file "$DATADIR/treasures" + or die "unable to load treasurelists\n"; +} + +sub reload_sound { + trace "loading sound config from $DATADIR/sound\n"; + + my $soundconf = JSON::XS->new->utf8->relaxed->decode (load_file "$DATADIR/sound"); + + for (0 .. SOUND_CAST_SPELL_0 - 1) { + my $sound = $soundconf->{compat}[$_] + or next; + + my $face = cf::face::find "sound/$sound->[1]"; + cf::sound::set $sound->[0] => $face; + cf::sound::old_sound_index $_, $face; # gcfclient-compat } - cf::global->attach ( - prio => 10000, - on_cleanup => sub { - db_sync; - }, - ); + while (my ($k, $v) = each %{$soundconf->{event}}) { + my $face = cf::face::find "sound/$v"; + cf::sound::set $k => $face; + } } -############################################################################# -# the server's main() +sub reload_resources { + trace "reloading resource files...\n"; -sub cfg_load { - open my $fh, "<:utf8", cf::confdir . "/config" - or return; + reload_materials; + reload_facedata; + reload_exp_table; + reload_sound; + reload_archetypes; + reload_regions; + reload_treasures; + + trace "finished reloading resource files\n"; +} + +sub reload_config { + trace "reloading config file...\n"; - local $/; - *CFG = YAML::Syck::Load <$fh>; + my $config = load_file "$CONFDIR/config"; + utf8::decode $config; + *CFG = decode_yaml $config; - $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; + $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38]; $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; @@ -2229,19 +3756,96 @@ } } +sub pidfile() { + sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT + or die "$PIDFILE: $!"; + flock $fh, &Fcntl::LOCK_EX + or die "$PIDFILE: flock: $!"; + $fh +} + +# make sure only one server instance is running at any one time +sub atomic { + my $fh = pidfile; + + my $pid = <$fh>; + kill 9, $pid if $pid > 0; + + seek $fh, 0, 0; + print $fh $$; +} + +sub main_loop { + trace "EV::loop starting\n"; + if (1) { + EV::loop; + } + trace "EV::loop returned\n"; + goto &main_loop unless $REALLY_UNLOOP; +} + sub main { + cf::init_globals; # initialise logging + + LOG llevInfo, "Welcome to Deliantra, v" . VERSION; + LOG llevInfo, "Copyright (C) 2005-2012 Marc Alexander Lehmann / Robin Redeker / the Deliantra team."; + LOG llevInfo, "Copyright (C) 1994 Mark Wedel."; + LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen."; + + $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority + # we must not ever block the main coroutine - local $Coro::idle = sub { + $Coro::idle = sub { Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# (async { - Event::one_event; + $Coro::current->{desc} = "IDLE BUG HANDLER"; + EV::loop EV::LOOP_ONESHOT; })->prio (Coro::PRIO_MAX); }; - cfg_load; - db_load; - load_extensions; - Event::loop; + evthread_start IO::AIO::poll_fileno; + + cf::sync_job { + cf::incloader::init (); + + db_init; + + cf::init_anim; + cf::init_attackmess; + cf::init_dynamic; + + cf::load_settings; + + reload_resources; + reload_config; + + cf::init_uuid; + cf::init_signals; + cf::init_skills; + + cf::init_beforeplay; + + atomic; + + load_extensions; + + utime time, time, $RUNTIMEFILE; + + # no (long-running) fork's whatsoever before this point(!) + use POSIX (); + POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD}; + + cf::_post_init 0; + }; + + cf::object::thawer::errors_are_fatal 0; + info "parse errors in files are no longer fatal from this point on.\n"; + + AE::postpone { + undef &main; # free gobs of memory :) + }; + + goto &main_loop; } ############################################################################# @@ -2249,214 +3853,508 @@ # install some emergency cleanup handlers BEGIN { + our %SIGWATCHER = (); for my $signal (qw(INT HUP TERM)) { - Event->signal ( - data => WF_AUTOCANCEL, - signal => $signal, - cb => sub { - cf::cleanup "SIG$signal"; - }, - ); + $SIGWATCHER{$signal} = AE::signal $signal, sub { + cf::cleanup "SIG$signal"; + }; } } +sub write_runtime_sync { + my $t0 = AE::time; + + # first touch the runtime file to show we are still running: + # the fsync below can take a very very long time. + + IO::AIO::aio_utime $RUNTIMEFILE, undef, undef; + + my $guard = cf::lock_acquire "write_runtime"; + + my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644 + or return; + + my $value = $cf::RUNTIME + 90 + 10; + # 10 is the runtime save interval, for a monotonic clock + # 60 allows for the watchdog to kill the server. + + (aio_write $fh, 0, (length $value), $value, 0) <= 0 + and return; + + # always fsync - this file is important + aio_fsync $fh + and return; + + # touch it again to show we are up-to-date + aio_utime $fh, undef, undef; + + close $fh + or return; + + aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE + and return; + + trace sprintf "runtime file written (%gs).\n", AE::time - $t0; + + 1 +} + +our $uuid_lock; +our $uuid_skip; + +sub write_uuid_sync($) { + $uuid_skip ||= $_[0]; + + return if $uuid_lock; + local $uuid_lock = 1; + + my $uuid = "$LOCALDIR/uuid"; + + my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644 + or return; + + my $value = uuid_seq uuid_cur; + + unless ($value) { + info "cowardly refusing to write zero uuid value!\n"; + return; + } + + my $value = uuid_str $value + $uuid_skip; + $uuid_skip = 0; + + (aio_write $fh, 0, (length $value), $value, 0) <= 0 + and return; + + # always fsync - this file is important + aio_fsync $fh + and return; + + close $fh + or return; + + aio_rename "$uuid~", $uuid + and return; + + trace "uuid file written ($value).\n"; + + 1 + +} + +sub write_uuid($$) { + my ($skip, $sync) = @_; + + $sync ? write_uuid_sync $skip + : async { write_uuid_sync $skip }; +} + sub emergency_save() { my $freeze_guard = cf::freeze_mainloop; - warn "enter emergency perl save\n"; + info "emergency_perl_save: enter\n"; + + # this is a trade-off: we want to be very quick here, so + # save all maps without fsync, and later call a global sync + # (which in turn might be very very slow) + local $USE_FSYNC = 0; cf::sync_job { + cf::write_runtime_sync; # external watchdog should not bark + # use a peculiar iteration method to avoid tripping on perl # refcount bugs in for. also avoids problems with players # and maps saved/destroyed asynchronously. - warn "begin emergency player save\n"; + info "emergency_perl_save: begin player save\n"; for my $login (keys %cf::PLAYER) { my $pl = $cf::PLAYER{$login} or next; $pl->valid or next; + delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt $pl->save; } - warn "end emergency player save\n"; + info "emergency_perl_save: end player save\n"; - warn "begin emergency map save\n"; + cf::write_runtime_sync; # external watchdog should not bark + + info "emergency_perl_save: begin map save\n"; for my $path (keys %cf::MAP) { my $map = $cf::MAP{$path} or next; $map->valid or next; $map->save; } - warn "end emergency map save\n"; + info "emergency_perl_save: end map save\n"; + + cf::write_runtime_sync; # external watchdog should not bark + + info "emergency_perl_save: begin database checkpoint\n"; + BDB::db_env_txn_checkpoint $DB_ENV; + info "emergency_perl_save: end database checkpoint\n"; + + info "emergency_perl_save: begin write uuid\n"; + write_uuid_sync 1; + info "emergency_perl_save: end write uuid\n"; + + cf::write_runtime_sync; # external watchdog should not bark + + trace "emergency_perl_save: syncing database to disk"; + BDB::db_env_txn_checkpoint $DB_ENV; + + info "emergency_perl_save: starting sync\n"; + IO::AIO::aio_sync sub { + info "emergency_perl_save: finished sync\n"; + }; + + cf::write_runtime_sync; # external watchdog should not bark + + trace "emergency_perl_save: flushing outstanding aio requests"; + while (IO::AIO::nreqs || BDB::nreqs) { + Coro::AnyEvent::sleep 0.01; # let the sync_job do it's thing + } + + cf::write_runtime_sync; # external watchdog should not bark }; - warn "leave emergency perl save\n"; + info "emergency_perl_save: leave\n"; } -sub reload() { - # can/must only be called in main - if ($Coro::current != $Coro::main) { - warn "can only reload from main coroutine\n"; - return; +sub post_cleanup { + my ($make_core) = @_; + + IO::AIO::flush; + + error Carp::longmess "post_cleanup backtrace" + if $make_core; + + my $fh = pidfile; + unlink $PIDFILE if <$fh> == $$; +} + +# a safer delete_package, copied from Symbol +sub clear_package($) { + my $pkg = shift; + + # expand to full symbol table name if needed + unless ($pkg =~ /^main::.*::$/) { + $pkg = "main$pkg" if $pkg =~ /^::/; + $pkg = "main::$pkg" unless $pkg =~ /^main::/; + $pkg .= '::' unless $pkg =~ /::$/; } - warn "reloading..."; + my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/; + my $stem_symtab = *{$stem}{HASH}; - warn "freezing server"; - my $guard = freeze_mainloop; - cf::emergency_save; + defined $stem_symtab and exists $stem_symtab->{$leaf} + or return; - warn "sync database to disk"; - cf::db_sync; - IO::AIO::flush; + # clear all symbols + my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH}; + for my $name (keys %$leaf_symtab) { + _gv_clear *{"$pkg$name"}; +# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"}; + } +} - eval { - # if anything goes wrong in here, we should simply crash as we already saved +sub do_reload_perl() { + # can/must only be called in main + unless (in_main) { + error "can only reload from main coroutine"; + return; + } - warn "cancel all watchers"; - for (Event::all_watchers) { - $_->cancel if $_->data & WF_AUTOCANCEL; - } + return if $RELOAD++; - warn "cancel all extension coros"; - $_->cancel for values %EXT_CORO; - %EXT_CORO = (); + my $t1 = AE::time; - warn "remove commands"; - %COMMAND = (); + while ($RELOAD) { + cf::get_slot 0.1, -1, "reload_perl"; + info "perl_reload: reloading..."; - warn "remove ext commands"; - %EXTCMD = (); + trace "perl_reload: entering sync_job"; - warn "unload/nuke all extensions"; - for my $pkg (@EXTS) { - warn "... unloading $pkg"; + cf::sync_job { + #cf::emergency_save; - if (my $cb = $pkg->can ("unload")) { - eval { - $cb->($pkg); - 1 - } or warn "$pkg unloaded, but with errors: $@"; - } + trace "perl_reload: cancelling all extension coros"; + $_->cancel for values %EXT_CORO; + %EXT_CORO = (); - warn "... nuking $pkg"; - Symbol::delete_package $pkg; - } + trace "perl_reload: removing commands"; + %COMMAND = (); - warn "unload all perl modules loaded from $LIBDIR"; - while (my ($k, $v) = each %INC) { - next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; + trace "perl_reload: removing ext/exti commands"; + %EXTCMD = (); + %EXTICMD = (); - warn "removing <$k>"; - delete $INC{$k}; + trace "perl_reload: unloading/nuking all extensions"; + for my $pkg (@EXTS) { + trace "... unloading $pkg"; - $k =~ s/\.pm$//; - $k =~ s/\//::/g; + if (my $cb = $pkg->can ("unload")) { + eval { + $cb->($pkg); + 1 + } or error "$pkg unloaded, but with errors: $@"; + } - if (my $cb = $k->can ("unload_module")) { - $cb->(); + trace "... clearing $pkg"; + clear_package $pkg; } - Symbol::delete_package $k; - } + trace "perl_reload: unloading all perl modules loaded from $LIBDIR"; + while (my ($k, $v) = each %INC) { + next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; - warn "get rid of safe::, as good as possible"; - Symbol::delete_package "safe::$_" - for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); + trace "... unloading $k"; + delete $INC{$k}; - warn "unload cf.pm \"a bit\""; - delete $INC{"cf.pm"}; + $k =~ s/\.pm$//; + $k =~ s/\//::/g; - # don't, removes xs symbols, too, - # and global variables created in xs - #Symbol::delete_package __PACKAGE__; + if (my $cb = $k->can ("unload_module")) { + $cb->(); + } - warn "reloading cf.pm"; - require cf; - cf::_connect_to_perl; # nominally unnecessary, but cannot hurt + clear_package $k; + } - warn "load config and database again"; - cf::cfg_load; - cf::db_load; + trace "perl_reload: getting rid of safe::, as good as possible"; + clear_package "safe::$_" + for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); + + trace "perl_reload: unloading cf.pm \"a bit\""; + delete $INC{"cf.pm"}; + delete $INC{"cf/$_.pm"} for @EXTRA_MODULES; + + # don't, removes xs symbols, too, + # and global variables created in xs + #clear_package __PACKAGE__; + + info "perl_reload: unload completed, starting to reload now"; + + trace "perl_reload: reloading cf.pm"; + require cf; + cf::_connect_to_perl_1; + + trace "perl_reload: loading config and database again"; + cf::reload_config; + + trace "perl_reload: loading extensions"; + cf::load_extensions; + + if ($REATTACH_ON_RELOAD) { + trace "perl_reload: reattaching attachments to objects/players"; + _global_reattach; # objects, sockets + trace "perl_reload: reattaching attachments to maps"; + reattach $_ for values %MAP; + trace "perl_reload: reattaching attachments to players"; + reattach $_ for values %PLAYER; + } - warn "load extensions"; - cf::load_extensions; + cf::_post_init 1; - warn "reattach attachments to objects/players"; - _global_reattach; - warn "reattach attachments to maps"; - reattach $_ for values %MAP; - }; + trace "perl_reload: leaving sync_job"; - if ($@) { - warn $@; - warn "error while reloading, exiting."; - exit 1; + 1 + } or do { + error $@; + cf::cleanup "perl_reload: error, exiting."; + }; + + --$RELOAD; } - warn "reloaded"; + $t1 = AE::time - $t1; + info "perl_reload: completed in ${t1}s\n"; }; our $RELOAD_WATCHER; # used only during reload +sub reload_perl() { + # doing reload synchronously and two reloads happen back-to-back, + # coro crashes during coro_state_free->destroy here. + + $RELOAD_WATCHER ||= cf::async { + Coro::AIO::aio_wait cache_extensions; + + $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub { + do_reload_perl; + undef $RELOAD_WATCHER; + }; + }; +} + register_command "reload" => sub { my ($who, $arg) = @_; if ($who->flag (FLAG_WIZ)) { $who->message ("reloading server."); + async { + $Coro::current->{desc} = "perl_reload"; + reload_perl; + }; + } +}; - # doing reload synchronously and two reloads happen back-to-back, - # coro crashes during coro_state_free->destroy here. +############################################################################# - $RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub { - reload; - undef $RELOAD_WATCHER; - }); +my $bug_warning = 0; + +sub wait_for_tick() { + return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main; + + $WAIT_FOR_TICK->wait; +} + +sub wait_for_tick_begin() { + return Coro::AnyEvent::poll if tick_inhibit || $Coro::current == $Coro::main; + + my $signal = new Coro::Signal; + push @WAIT_FOR_TICK_BEGIN, $signal; + $signal->wait; +} + +sub tick { + if ($Coro::current != $Coro::main) { + Carp::cluck "major BUG: server tick called outside of main coro, skipping it" + unless ++$bug_warning > 10; + return; } -}; -unshift @INC, $LIBDIR; + cf::one_tick; # one server iteration -$TICK_WATCHER = Event->timer ( - reentrant => 0, - prio => 0, - at => $NEXT_TICK || $TICK, - data => WF_AUTOCANCEL, - cb => sub { - $NOW = Event::time; - - cf::server_tick; # one server iteration - $RUNTIME += $TICK; - $NEXT_TICK += $TICK; + #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d# - $WAIT_FOR_TICK->broadcast; - $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; + if ($NOW >= $NEXT_RUNTIME_WRITE) { + $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.; + Coro::async_pool { + $Coro::current->{desc} = "runtime saver"; + write_runtime_sync + or error "ERROR: unable to write runtime file: $!"; + }; + } - # if we are delayed by four ticks or more, skip them all - $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; + if (my $sig = shift @WAIT_FOR_TICK_BEGIN) { + $sig->send; + } + $WAIT_FOR_TICK->broadcast; - $TICK_WATCHER->at ($NEXT_TICK); - $TICK_WATCHER->start; - }, -); + $LOAD = ($NOW - $TICK_START) / $TICK; + $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25; + + if (0) { + if ($NEXT_TICK) { + my $jitter = $TICK_START - $NEXT_TICK; + $JITTER = $JITTER * 0.75 + $jitter * 0.25; + debug "jitter $JITTER\n";#d# + } + } +} -IO::AIO::max_poll_time $TICK * 0.2; +{ + # configure BDB + info "initialising database"; -$AIO_POLL_WATCHER = Event->io ( - fd => IO::AIO::poll_fileno, - poll => 'r', - prio => 5, - data => WF_AUTOCANCEL, - cb => \&IO::AIO::poll_cb, -); + BDB::min_parallel 16; + BDB::max_poll_reqs $TICK * 0.1; + #$AnyEvent::BDB::WATCHER->priority (1); + + unless ($DB_ENV) { + $DB_ENV = BDB::db_env_create; + $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT); + $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7; + $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7; + $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT); + $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT); + + cf::sync_job { + eval { + BDB::db_env_open + $DB_ENV, + $BDBDIR, + BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN + | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, + 0666; -$WRITE_RUNTIME_WATCHER = Event->timer ( - data => WF_AUTOCANCEL, - after => 0, - interval => 10, - cb => sub { - (Coro::unblock_sub { - write_runtime - or warn "ERROR: unable to write runtime file: $!"; - })->(); - }, -); + cf::cleanup "db_env_open($BDBDIR): $!" if $!; + }; + + cf::cleanup "db_env_open(db): $@" if $@; + }; + } + + $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub { + BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { }; + }; + $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub { + BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { }; + }; + $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub { + BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { }; + }; + + info "database initialised"; +} + +{ + # configure IO::AIO + + info "initialising aio"; + IO::AIO::min_parallel 8; + IO::AIO::max_poll_time $TICK * 0.1; + undef $AnyEvent::AIO::WATCHER; + info "aio initialised"; +} + +our $_log_backtrace; +our $_log_backtrace_last; + +sub _log_backtrace { + my ($msg, @addr) = @_; + + $msg =~ s/\n$//; + + if ($_log_backtrace_last eq $msg) { + LOG llevInfo, "[ABT] $msg\n"; + LOG llevInfo, "[ABT] [duplicate, suppressed]\n"; + # limit the # of concurrent backtraces + } elsif ($_log_backtrace < 2) { + $_log_backtrace_last = $msg; + ++$_log_backtrace; + my $perl_bt = Carp::longmess $msg; + async { + $Coro::current->{desc} = "abt $msg"; + + my @bt = fork_call { + @addr = map { sprintf "%x", $_ } @addr; + my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X; + open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |" + or die "addr2line: $!"; + + my @funcs; + my @res = <$fh>; + chomp for @res; + while (@res) { + my ($func, $line) = splice @res, 0, 2, (); + push @funcs, "[$func] $line"; + } + + @funcs + }; + + LOG llevInfo, "[ABT] $perl_bt\n"; + LOG llevInfo, "[ABT] --- C backtrace follows ---\n"; + LOG llevInfo, "[ABT] $_\n" for @bt; + --$_log_backtrace; + }; + } else { + LOG llevInfo, "[ABT] $msg\n"; + LOG llevInfo, "[ABT] [overload, suppressed]\n"; + } +} + +# load additional modules +require "cf/$_.pm" for @EXTRA_MODULES; +cf::_connect_to_perl_2; END { cf::emergency_save }