--- deliantra/server/lib/cf.pm 2006/08/27 16:15:12 1.46 +++ deliantra/server/lib/cf.pm 2007/01/20 23:30:16 1.188 @@ -1,5 +1,8 @@ package cf; +use utf8; +use strict; + use Symbol; use List::Util; use Storable; @@ -7,72 +10,153 @@ use Safe; use Safe::Hole; +use Coro 3.4 (); +use Coro::Event; +use Coro::Timer; +use Coro::Signal; +use Coro::Semaphore; +use Coro::AIO; + +use Data::Dumper; +use Digest::MD5; +use Fcntl; +use IO::AIO 2.32 (); +use YAML::Syck (); use Time::HiRes; -use Event; -$Event::Eval = 1; # no idea why this is required, but it is -use strict; +use Event; $Event::Eval = 1; # no idea why this is required, but it is + +sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload + +# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? +$YAML::Syck::ImplicitUnicode = 1; + +$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority + +our %COMMAND = (); +our %COMMAND_TIME = (); + +our @EXTS = (); # list of extension package names +our %EXTCMD = (); +our %EXT_CORO = (); # coroutines bound to extensions +our %EXT_MAP = (); # pluggable maps -our %COMMAND = (); our @EVENT; -our %PROP_TYPE; -our %PROP_IDX; -our $LIBDIR = maps_directory "perl"; +our $LIBDIR = datadir . "/ext"; our $TICK = MAX_TIME * 1e-6; our $TICK_WATCHER; +our $AIO_POLL_WATCHER; +our $WRITE_RUNTIME_WATCHER; our $NEXT_TICK; +our $NOW; -BEGIN { - *CORE::GLOBAL::warn = sub { - my $msg = join "", @_; - $msg .= "\n" - unless $msg =~ /\n$/; +our %CFG; - print STDERR "cfperl: $msg"; - LOG llevError, "cfperl: $msg"; - }; +our $UPTIME; $UPTIME ||= time; +our $RUNTIME; + +our %PLAYER; # all users +our %MAP; # 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 + +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: $!"; + $RUNTIME = <$fh> + 0.; } -my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! +mkdir cf::localdir; +mkdir cf::localdir . "/" . cf::playerdir; +mkdir cf::localdir . "/" . cf::tmpdir; +mkdir cf::localdir . "/" . cf::uniquedir; +mkdir $RANDOM_MAPS; -# generate property mutators -sub prop_gen { - my ($prefix, $class) = @_; +our $EMERGENCY_POSITION; - no strict 'refs'; +############################################################################# - for my $prop (keys %PROP_TYPE) { - $prop =~ /^\Q$prefix\E_(.*$)/ or next; - my $sub = lc $1; +=head2 GLOBAL VARIABLES - my $type = $PROP_TYPE{$prop}; - my $idx = $PROP_IDX {$prop}; +=over 4 - *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub { - $_[0]->get_property ($type, $idx) - }; +=item $cf::UPTIME - *{"$class\::set_$sub"} = sub { - $_[0]->set_property ($type, $idx, $_[1]); - } unless $ignore_set{$prop}; - } -} +The timestamp of the server start (so not actually an uptime). + +=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 -# auto-generate most of the API +The perl library directory, where extensions and cf-specific modules can +be found. It will be added to C<@INC> automatically. -prop_gen OBJECT_PROP => "cf::object"; -# CFAPI_OBJECT_ANIMATION? -prop_gen PLAYER_PROP => "cf::object::player"; +=item $cf::NOW -prop_gen MAP_PROP => "cf::map"; -prop_gen ARCH_PROP => "cf::arch"; +The time of the last (current) server tick. +=item $cf::TICK + +The interval between server ticks, in seconds. + +=item %cf::CFG + +Configuration for the server, loaded from C, or +from wherever your confdir points to. + +=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE + +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. + +=back + +=cut + +BEGIN { + *CORE::GLOBAL::warn = sub { + my $msg = join "", @_; + utf8::encode $msg; + + $msg .= "\n" + unless $msg =~ /\n$/; + + LOG llevError, $msg; + }; +} + +@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'; # we bless all objects into (empty) derived classes to force a method lookup # within the Safe compartment. -for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch)) { +for my $pkg (qw( + cf::global cf::attachable + cf::object cf::object::player + cf::client cf::player + cf::arch cf::living + cf::map cf::party cf::region +)) { no strict 'refs'; @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; } @@ -81,48 +165,283 @@ warn "error in event callback: @_"; }; -my %ext_pkg; -my @exts; -my @hook; -my %command; -my %extcmd; +=head2 UTILITY FUNCTIONS -############################################################################# -# utility functions +=over 4 + +=item dumpval $ref + +=cut + +sub dumpval { + eval { + local $SIG{__DIE__}; + my $d; + if (1) { + $d = new Data::Dumper([$_[0]], ["*var"]); + $d->Terse(1); + $d->Indent(2); + $d->Quotekeys(0); + $d->Useqq(1); + #$d->Bless(...); + $d->Seen($_[1]) if @_ > 1; + $d = $d->Dump(); + } + $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; + $d + } || "[unable to dump $_[0]: '$@']"; +} use JSON::Syck (); # TODO# replace by JSON::PC once working +=item $ref = cf::from_json $json + +Converts a JSON string into the corresponding perl data structure. + +=cut + sub from_json($) { $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs JSON::Syck::Load $_[0] } +=item $json = cf::to_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] } +=item cf::lock_wait $string + +Wait until the given lock is available. See cf::lock_acquire. + +=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, +for example when the coroutine gets canceled), the lock is automatically +returned. + +Lock names should begin with a unique identifier (for example, cf::map::find +uses map_find and cf::map::load uses map_load). + +=cut + +our %LOCK; + +sub lock_wait($) { + my ($key) = @_; + + # wait for lock, if any + while ($LOCK{$key}) { + push @{ $LOCK{$key} }, $Coro::current; + Coro::schedule; + } +} + +sub lock_acquire($) { + my ($key) = @_; + + # wait, to be sure we are not locked + lock_wait $key; + + $LOCK{$key} = []; + + Coro::guard { + # wake up all waiters, to be on the safe side + $_->ready for @{ delete $LOCK{$key} }; + } +} + +sub freeze_mainloop { + return unless $TICK_WATCHER->is_active; + + my $guard = Coro::guard { + $TICK_WATCHER->start; + $WRITE_RUNTIME_WATCHER->start; + }; + $WRITE_RUNTIME_WATCHER->stop; + $TICK_WATCHER->stop; + $guard +} + +=item cf::async { BLOCK } + +Currently the same as Coro::async_pool, meaning you cannot use +C, C or other gimmicks on these coroutines. The only +thing you are allowed to do is call C on it. + +=cut + +BEGIN { *async = \&Coro::async_pool } + +=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. + +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 +server will be frozen during this time, so the block should either finish +fast or be very important. + +=cut + +sub sync_job(&) { + my ($job) = @_; + + if ($Coro::current == $Coro::main) { + # 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) + my $freeze_guard = freeze_mainloop; + + my $busy = 1; + my @res; + + (async { + @res = eval { $job->() }; + warn $@ if $@; + undef $busy; + })->prio (Coro::PRIO_MAX); + + while ($busy) { + Coro::cede or Event::one_event; + } + + wantarray ? @res : $res[0] + } else { + # we are in another coroutine, how wonderful, everything just works + + $job->() + } +} + +=item $coro = cf::async_ext { BLOCK } + +Like async, but this coro is automatically being canceled when the +extension calling this is being unloaded. + +=cut + +sub async_ext(&) { + my $cb = shift; + + my $coro = &Coro::async ($cb); + + $coro->on_destroy (sub { + delete $EXT_CORO{$coro+0}; + }); + $EXT_CORO{$coro+0} = $coro; + + $coro +} + +sub write_runtime { + my $runtime = cf::localdir . "/runtime"; + + my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 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; + + aio_fsync $fh + and return; + + close $fh + or return; + + aio_rename "$runtime~", $runtime + and return; + + 1 +} + +=back + +=cut + ############################################################################# -# "new" plug-in system -=item $object->attach ($attachment, ...) +=head2 ATTACHABLE OBJECTS + +Many objects in crossfire 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+). + +=over 4 + +=item $attachable->attach ($attachment, key => $value...) + +=item $attachable->detach ($attachment) + +Attach/detach a pre-registered attachment to a specific object and give it +the specified key/value pairs as arguments. + +Example, attach a minesweeper attachment to the given object, making it a +10x10 minesweeper game: + + $obj->attach (minesweeper => width => 10, height => 10); + +=item $bool = $attachable->attached ($name) -Attach a pre-registered attachment to an object. +Checks wether the named attachment is currently attached to the object. -=item $player->attach ($attachment, ...) +=item cf::CLASS->attach ... -Attach a pre-registered attachment to a player. +=item cf::CLASS->detach ... -=item $map->attach ($attachment, ...) # not yet persistent +Define an anonymous attachment and attach it to all objects of the given +CLASS. See the next function for an explanation of its arguments. -Attach a pre-registered attachment to a map. +You can attach to global events by using the C class. -=item cf::attach_global ... +Example, log all player logins: -Attach handlers for global events. + cf::player->attach ( + on_login => sub { + my ($pl) = @_; + ... + }, + ); + +Example, attach to the jeweler skill: + + cf::object->attach ( + type => cf::SKILL, + subtype => cf::SK_JEWELER, + on_use_skill => sub { + my ($sk, $ob, $part, $dir, $msg) = @_; + ... + }, + ); + +=item cf::CLASS::attachment $name, ... + +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 +that are attached at load/instantiate time, thus the need for a name. -This and all following C-functions expect any number of the -following handler/hook descriptions: +These calls expect any number of the following handler/hook descriptions: =over 4 @@ -134,6 +453,12 @@ registered at priority C<-1000>, so lower priorities should not be used unless you know what you are doing. +=item type => $type + +(Only for C<< cf::object->attach >> calls), limits the attachment to the +given type of objects only (the additional parameter C can be +used to further limit to the given subtype). + =item on_I => \&cb Call the given code reference whenever the named event happens (event is @@ -152,39 +477,45 @@ =back -=item cf::attach_to_type $object_type, ... - -Attach handlers for a specific object type (e.g. TRANSPORT). - -=item cf::attach_to_objects ... - -Attach handlers to all objects. Do not use this except for debugging or -very rare events, as handlers are (obviously) called for I objects in -the game. - -=item cf::attach_to_players ... - -Attach handlers to all players. +Example, define an attachment called "sockpuppet" that calls the given +event handler when a monster attacks: -=item cf::attach_to_maps ... + cf::object::attachment sockpuppet => + on_skill_attack => sub { + my ($self, $victim) = @_; + ... + } + } -Attach handlers to all maps. +=item $attachable->valid -=item cf:register_attachment $name, ... +Just because you have a perl object does not mean that the corresponding +C-level object still exists. If you try to access an object that has no +valid C counterpart anymore you get an exception at runtime. This method +can be used to test for existence of the C object part without causing an +exception. =cut # the following variables are defined in .xs and must not be re-created -our @CB_GLOBAL = (); # registry for all global events -our @CB_OBJECT = (); # all objects (should not be used except in emergency) -our @CB_PLAYER = (); -our @CB_TYPE = (); # registry for type (cf-object class) based events -our @CB_MAP = (); +our @CB_GLOBAL = (); # registry for all global events +our @CB_ATTACHABLE = (); # registry for all attachables +our @CB_OBJECT = (); # all objects (should not be used except in emergency) +our @CB_PLAYER = (); +our @CB_CLIENT = (); +our @CB_TYPE = (); # registry for type (cf-object class) based events +our @CB_MAP = (); my %attachment; -sub _attach_cb($\%$$$) { - my ($registry, $undo, $event, $prio, $cb) = @_; +sub cf::attachable::thawer_merge { + # simply override everything except _meta + local $_[0]{_meta}; + %{$_[0]} = %{$_[1]}; +} + +sub _attach_cb($$$$) { + my ($registry, $event, $prio, $cb) = @_; use sort 'stable'; @@ -193,42 +524,52 @@ @{$registry->[$event]} = sort { $a->[0] cmp $b->[0] } @{$registry->[$event] || []}, $cb; - - push @{$undo->{cb}}, [$event, $cb]; } +# hack +my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP; + # attach handles attaching event callbacks # the only thing the caller has to do is pass the correct # registry (== where the callback attaches to). -sub _attach(\@$@) { +sub _attach { my ($registry, $klass, @arg) = @_; + my $object_type; my $prio = 0; - - my %undo = ( - registry => $registry, - cb => [], - ); - my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; + #TODO: get rid of this hack + if ($attachable_klass{$klass}) { + %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT); + } + while (@arg) { my $type = shift @arg; if ($type eq "prio") { $prio = shift @arg; + } elsif ($type eq "type") { + $object_type = shift @arg; + $registry = $CB_TYPE[$object_type] ||= []; + + } 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] ||= []; + } elsif ($type eq "package") { my $pkg = shift @arg; while (my ($name, $id) = each %cb_id) { if (my $cb = $pkg->can ($name)) { - _attach_cb $registry, %undo, $id, $prio, $cb; + _attach_cb $registry, $id, $prio, $cb; } } } elsif (exists $cb_id{$type}) { - _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; + _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; } elsif (ref $type) { warn "attaching objects not supported, ignoring.\n"; @@ -238,83 +579,68 @@ warn "attach argument '$type' not supported, ignoring.\n"; } } - - \%undo } -sub _attach_attachment { - my ($klass, $obj, $name, @args) = q_; +sub _object_attach { + my ($obj, $name, %arg) = @_; - my $res; + return if exists $obj->{_attachment}{$name}; if (my $attach = $attachment{$name}) { my $registry = $obj->registry; - $res = _attach @$registry, $klass, @$attach; - - if (my $cb = delete $registry->[EVENT_OBJECT_INSTANTIATE]) { - for (@$cb) { - eval { $_->[1]->($obj, @args); }; - if ($@) { - warn "$@"; - warn "... while processing '$name' instantiate with args <@args>.\n"; - } - } + for (@$attach) { + my ($klass, @attach) = @$_; + _attach $registry, $klass, @attach; } + + $obj->{$name} = \%arg; } else { warn "object uses attachment '$name' that is not available, postponing.\n"; } - push @{$obj->{_attachment}}, $name; - - $res->{attachment} = $name; - $res -} - -sub cf::object::attach { - my ($obj, $name, @args) = @_; - - _attach_attachment KLASS_OBJECT, $obj, $name, @args; -} - -sub cf::player::attach { - my ($obj, $name, @args) = @_; - - _attach_attachment KLASS_PLAYER, $obj, $name, @args; -} - -sub cf::map::attach { - my ($obj, $name, @args) = @_; - - _attach_attachment KLASS_MAP, $obj, $name, @args; -} - -sub attach_global { - _attach @CB_GLOBAL, KLASS_GLOBAL, @_ + $obj->{_attachment}{$name} = undef; } -sub attach_to_type { - my $type = shift; +sub cf::attachable::attach { + if (ref $_[0]) { + _object_attach @_; + } else { + _attach shift->_attach_registry, @_; + } +}; - _attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_ -} +# all those should be optimised +sub cf::attachable::detach { + my ($obj, $name) = @_; + + if (ref $obj) { + delete $obj->{_attachment}{$name}; + reattach ($obj); + } else { + Carp::croak "cannot, currently, detach class attachments"; + } +}; -sub attach_to_objects { - _attach @CB_OBJECT, KLASS_OBJECT, @_ -} +sub cf::attachable::attached { + my ($obj, $name) = @_; -sub attach_to_players { - _attach @CB_PLAYER, KLASS_PLAYER, @_ + exists $obj->{_attachment}{$name} } -sub attach_to_maps { - _attach @CB_MAP, KLASS_MAP, @_ -} +for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) { + eval "#line " . __LINE__ . " 'cf.pm' + sub cf::\L$klass\E::_attach_registry { + (\\\@CB_$klass, KLASS_$klass) + } -sub register_attachment { - my $name = shift; + sub cf::\L$klass\E::attachment { + my \$name = shift; - $attachment{$name} = [@_]; + \$attachment{\$name} = [[KLASS_$klass, \@_]]; + } + "; + die if $@; } our $override; @@ -338,7 +664,7 @@ if ($@) { warn "$@"; - warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; + warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; override; } @@ -348,139 +674,203 @@ 0 } -############################################################################# -# object support +=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) -sub instantiate { - my ($obj, $data) = @_; +=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) - $data = from_json $data; +Generate an object-specific event with the given arguments. - for (@$data) { - my ($name, $args) = @$_; - attach $obj, $name, @{$args || [] }; - } -} +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). + +=back + +=cut + +############################################################################# +# object support -# basically do the same as instantiate, without calling instantiate sub reattach { - warn "reattach<@_>\n";#d# + # basically do the same as instantiate, without calling instantiate my ($obj) = @_; + + bless $obj, ref $obj; # re-bless in case extensions have been reloaded + my $registry = $obj->registry; - for my $name (@{ $obj->{_attachment} }) { + @$registry = (); + + delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; + + for my $name (keys %{ $obj->{_attachment} || {} }) { if (my $attach = $attachment{$name}) { - _attach @$registry, KLASS_OBJECT, @$attach; + for (@$attach) { + my ($klass, @attach) = @$_; + _attach $registry, $klass, @attach; + } } else { warn "object uses attachment '$name' that is not available, postponing.\n"; } } - - warn "reattach<@_, $_>\n"; } -sub object_freezer_save { - my ($filename, $objs) = @_; - warn "freeze $filename\n";#d# - use Data::Dumper; print Dumper $objs; - - $filename .= ".pst"; - - if (@$objs) { - open my $fh, ">:raw", "$filename~"; - chmod $fh, SAVE_MODE; - syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; - close $fh; - rename "$filename~", $filename; - } else { - unlink $filename; - } -} +cf::attachable->attach ( + prio => -1000000, + on_instantiate => sub { + my ($obj, $data) = @_; -sub object_thawer_load { - my ($filename) = @_; + $data = from_json $data; - warn "thaw $filename\n";#d# + for (@$data) { + my ($name, $args) = @$_; - open my $fh, "<:raw:perlio", "$filename.pst" - or return; - - eval { local $/; (Storable::thaw <$fh>)->{objs} } -} - -attach_to_objects - prio => -1000000, + $obj->attach ($name, %{$args || {} }); + } + }, + on_reattach => \&reattach, on_clone => sub { my ($src, $dst) = @_; @{$dst->registry} = @{$src->registry}; - warn "registry clone ", join ":", @{$src->registry};#d# %$dst = %$src; - $dst->{_attachment} = [@{ $src->{_attachment} }] + %{$dst->{_attachment}} = %{$src->{_attachment}} if exists $src->{_attachment}; - - warn "clone<@_>\n";#d# }, -; - -############################################################################# -# old plug-in events +); -sub inject_event { - my $extension = shift; - my $event_code = shift; +sub object_freezer_save { + my ($filename, $rdata, $objs) = @_; - my $cb = $hook[$event_code]{$extension} - or return; + sync_job { + if (length $$rdata) { + warn sprintf "saving %s (%d,%d)\n", + $filename, length $$rdata, scalar @$objs; + + if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { + chmod SAVE_MODE, $fh; + aio_write $fh, 0, (length $$rdata), $$rdata, 0; + aio_fsync $fh; + 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_write $fh, 0, (length $data), $data, 0; + aio_fsync $fh; + close $fh; + aio_rename "$filename.pst~", "$filename.pst"; + } + } else { + aio_unlink "$filename.pst"; + } - &$cb + aio_rename "$filename~", $filename; + } else { + warn "FATAL: $filename~: $!\n"; + } + } else { + aio_unlink $filename; + aio_unlink "$filename.pst"; + } + } } -sub inject_global_event { - my $event = shift; +sub object_freezer_as_string { + my ($rdata, $objs) = @_; - my $cb = $hook[$event] - or return; + use Data::Dumper; - List::Util::max map &$_, values %$cb + $$rdata . Dumper $objs } -sub inject_command { - my ($name, $obj, $params) = @_; +sub object_thawer_load { + my ($filename) = @_; + + my ($data, $av); + + (aio_load $filename, $data) >= 0 + or return; - for my $cmd (@{ $command{$name} }) { - $cmd->[1]->($obj, $params); + unless (aio_stat "$filename.pst") { + (aio_load "$filename.pst", $av) >= 0 + or return; + $av = eval { (Storable::thaw $av)->{objs} }; } - -1 + warn sprintf "loading %s (%d)\n", + $filename, length $data, scalar @{$av || []};#d# + return ($data, $av); } +############################################################################# +# command handling &c + +=item cf::register_command $name => \&callback($ob,$args); + +Register a callback for execution when the client sends the user command +$name. + +=cut + sub register_command { - my ($name, $time, $cb) = @_; + my ($name, $cb) = @_; my $caller = caller; #warn "registering command '$name/$time' to '$caller'"; - push @{ $command{$name} }, [$time, $cb, $caller]; - $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; + push @{ $COMMAND{$name} }, [$caller, $cb]; } +=item cf::register_extcmd $name => \&callback($pl,$packet); + +Register a callbackf ro execution when the client sends an extcmd packet. + +If the callback returns something, it is sent back as if reply was being +called. + +=cut + sub register_extcmd { my ($name, $cb) = @_; - my $caller = caller; - #warn "registering extcmd '$name' to '$caller'"; - - $extcmd{$name} = [$cb, $caller]; + $EXTCMD{$name} = $cb; } -sub register { - my ($base, $pkg) = @_; +cf::player->attach ( + on_command => sub { + my ($pl, $name, $params) = @_; - #TODO -} + my $cb = $COMMAND{$name} + or return; + + for my $cmd (@$cb) { + $cmd->[1]->($pl->ob, $params); + } + + cf::override; + }, + on_extcmd => sub { + my ($pl, $buf) = @_; + + my $msg = eval { from_json $buf }; + + if (ref $msg) { + if (my $cb = $EXTCMD{$msg->{msgtype}}) { + if (my %reply = $cb->($pl, $msg)) { + $pl->ext_reply ($msg->{msgid}, %reply); + } + } + } else { + warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; + } + + cf::override; + }, +); sub load_extension { my ($path) = @_; @@ -491,7 +881,7 @@ $pkg =~ s/[^[:word:]]/_/g; $pkg = "ext::$pkg"; - warn "loading '$path' into '$pkg'\n"; + warn "... loading '$path' into '$pkg'\n"; open my $fh, "<:utf8", $path or die "$path: $!"; @@ -502,235 +892,783 @@ . (do { local $/; <$fh> }) . "\n};\n1"; - eval $source - or die "$path: $@"; + 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; + } + die $@; + } + + push @EXTS, $pkg; +} + +sub load_extensions { + for my $ext (<$LIBDIR/*.ext>) { + next unless -r $ext; + eval { + load_extension $ext; + 1 + } or warn "$ext not loaded: $@"; + } +} + +############################################################################# + +=head2 CORE EXTENSIONS + +Functions and methods that extend core crossfire objects. + +=cut + +package cf::player; + +use Coro::AIO; - push @exts, $pkg; - $ext_pkg{$base} = $pkg; +=head3 cf::player -# no strict 'refs'; -# @{"$pkg\::ISA"} = ext::; +=over 4 + +=item cf::player::find $login - register $base, $pkg; +Returns the given player object, loading it if necessary (might block). + +=cut + +sub playerdir($) { + cf::localdir + . "/" + . cf::playerdir + . "/" + . (ref $_[0] ? $_[0]->ob->name : $_[0]) } -sub unload_extension { - my ($pkg) = @_; +sub path($) { + my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; - warn "removing extension $pkg\n"; + (playerdir $login) . "/$login.pl" +} - # remove hooks - #TODO -# for my $idx (0 .. $#PLUGIN_EVENT) { -# delete $hook[$idx]{$pkg}; -# } +sub find_active($) { + $cf::PLAYER{$_[0]} + and $cf::PLAYER{$_[0]}->active + and $cf::PLAYER{$_[0]} +} - # remove commands - for my $name (keys %command) { - my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; +sub exists($) { + my ($login) = @_; - if (@cb) { - $command{$name} = \@cb; - $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; - } else { - delete $command{$name}; - delete $COMMAND{"$name\000"}; + $cf::PLAYER{$login} + or cf::sync_job { !aio_stat path $login } +} + +sub find($) { + return $cf::PLAYER{$_[0]} || do { + my $login = $_[0]; + + my $guard = cf::lock_acquire "user_find:$login"; + + $cf::PLAYER{$_[0]} || do { + my $pl = load_pl path $login + or return; + $cf::PLAYER{$login} = $pl } } +} + +sub save($) { + my ($pl) = @_; + + return if $pl->{deny_save}; + + my $path = path $pl; + my $guard = cf::lock_acquire "user_save:$path"; + + return if $pl->{deny_save}; + + aio_mkdir playerdir $pl, 0770; + $pl->{last_save} = $cf::RUNTIME; + + $pl->save_pl ($path); + Coro::cede; +} + +sub new($) { + my ($login) = @_; + + my $self = create; + + $self->ob->name ($login); + $self->{deny_save} = 1; + + $cf::PLAYER{$login} = $self; + + $self +} + +=item $pl->quit_character + +Nukes the player without looking back. If logged in, the connection will +be destroyed. May block for a long time. + +=cut + +sub quit_character { + my ($pl) = @_; + + $pl->{deny_save} = 1; + $pl->password ("*"); # this should lock out the player until we nuked the dir + + $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; + $pl->deactivate; + $pl->invoke (cf::EVENT_PLAYER_QUIT); + $pl->ns->destroy if $pl->ns; + + my $path = playerdir $pl; + my $temp = "$path~$cf::RUNTIME~deleting~"; + aio_rename $path, $temp; + delete $cf::PLAYER{$pl->ob->name}; + $pl->destroy; + IO::AIO::aio_rmtree $temp; +} + +=item cf::player::list_logins - # remove extcmds - for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { - delete $extcmd{$name}; +Returns am arrayref of all valid playernames in the system, can take a +while and may block, so not sync_job-capable, ever. + +=cut + +sub list_logins { + my $dirs = aio_readdir cf::localdir . "/" . cf::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 + + utf8::decode $login; + push @logins, $login; } - if (my $cb = $pkg->can ("unload")) { - eval { - $cb->($pkg); - 1 - } or warn "$pkg unloaded, but with errors: $@"; + \@logins +} + +=item $player->maps + +Returns an arrayref of map paths that are private for this +player. May block. + +=cut + +sub maps($) { + my ($pl) = @_; + + my $files = aio_readdir playerdir $pl + or return; + + my @paths; + + for (@$files) { + utf8::decode $_; + next if /\.(?:pl|pst)$/; + next unless /^$PATH_SEP/o; + + s/\.map$//; + push @paths, "~" . $pl->ob->name . "/" . $_; } - Symbol::delete_package $pkg; + \@paths } -sub load_extensions { - my $LIBDIR = maps_directory "perl"; +=item $player->ext_reply ($msgid, $msgtype, %msg) - for my $ext (<$LIBDIR/*.ext>) { - next unless -r $ext; - eval { - load_extension $ext; - 1 - } or warn "$ext not loaded: $@"; +Sends an ext reply to the player. + +=cut + +sub ext_reply($$$%) { + my ($self, $id, %msg) = @_; + + $msg{msgid} = $id; + + $self->send ("ext " . cf::to_json \%msg); +} + +package cf; + +=back + + +=head3 cf::map + +=over 4 + +=cut + +package cf::map; + +use Fcntl; +use Coro::AIO; + +use overload + '""' => \&as_string, + fallback => 1; + +our $MAX_RESET = 3600; +our $DEFAULT_RESET = 3000; + +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} + ) +} + +=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, $prio) = @_; + my $pkg = caller; + + no strict; + push @{"$pkg\::ISA"}, __PACKAGE__; + + $EXT_MAP{$pkg} = [$prio, qr<$regex>]; +} + +# also paths starting with '/' +$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; + +sub thawer_merge { + my ($self, $merge) = @_; + + # 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); +} + +sub normalise { + my ($path, $base) = @_; + + # map plan: + # + # /! non-realised random map exit (special hack!) + # {... are special paths that are not being touched + # ?xxx/... are special absolute paths + # ?random/... random maps + # /... normal maps + # ~user/... per-player map of a specific user + + $path =~ s/$PATH_SEP/\//go; + + # treat it as relative path if it starts with + # something that looks reasonable + if ($path =~ m{^(?:\./|\.\./|\w)}) { + $base or Carp::carp "normalise called with relative path and no base: '$path'"; + + $base =~ s{[^/]+/?$}{}; + $path = "$base/$path"; } + + for ($path) { + redo if s{//}{/}; + redo if s{/\.?/}{/}; + redo if s{/[^/]+/\.\./}{/}; + } + + $path } -sub _perl_reload(&) { - my ($msg) = @_; +sub new_from_path { + my (undef, $path, $base) = @_; - $msg->("reloading..."); + return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object - eval { - # 1. cancel all watchers - $_->cancel for Event::all_watchers; + $path = normalise $path, $base; - # 2. unload all extensions - for (@exts) { - $msg->("unloading <$_>"); - unload_extension $_; + 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. + return $self; } + } - # 3. unload all modules loaded from $LIBDIR - while (my ($k, $v) = each %INC) { - next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; + Carp::carp "unable to resolve path '$path'."; + () +} - $msg->("removing <$k>"); - delete $INC{$k}; +sub init { + my ($self) = @_; - $k =~ s/\.pm$//; - $k =~ s/\//::/g; + $self +} - if (my $cb = $k->can ("unload_module")) { - $cb->(); - } +sub as_string { + my ($self) = @_; - Symbol::delete_package $k; - } + "$self->{path}" +} - # 4. get rid of safe::, as good as possible - Symbol::delete_package "safe::$_" - for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); +# the displayed name, this is a one way mapping +sub visible_name { + &as_string +} - # 5. remove register_script_function callbacks - # TODO - - # 6. unload cf.pm "a bit" - delete $INC{"cf.pm"}; +# the original (read-only) location +sub load_path { + my ($self) = @_; - # don't, removes xs symbols, too, - # and global variables created in xs - #Symbol::delete_package __PACKAGE__; + sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} +} - # 7. reload cf.pm - $msg->("reloading cf.pm"); - require cf; - }; - $msg->($@) if $@; +# the temporary/swap location +sub save_path { + my ($self) = @_; - $msg->("reloaded"); -}; + (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; + sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path +} -sub perl_reload() { - _perl_reload { - warn $_[0]; - print "$_[0]\n"; - }; +# 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 } -register_command "perl-reload", 0, sub { - my ($who, $arg) = @_; +# and all this just because we cannot iterate over +# all maps in C++... +sub change_all_map_light { + my ($change) = @_; - if ($who->flag (FLAG_WIZ)) { - _perl_reload { - warn $_[0]; - $who->message ($_[0]); - }; + $_->change_map_light ($change) + for grep $_->outdoor, values %cf::MAP; +} + +sub unlink_save { + my ($self) = @_; + + utf8::encode (my $save = $self->save_path); + IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; + IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; +} + +sub load_header_from($) { + my ($self, $path) = @_; + + utf8::encode $path; + aio_open $path, O_RDONLY, 0 + or return; + + $self->_load_header ($path) + or return; + + $self->{load_path} = $path; + + 1 +} + +sub load_header_orig { + my ($self) = @_; + + $self->load_header_from ($self->load_path) +} + +sub load_header_temp { + my ($self) = @_; + + $self->load_header_from ($self->save_path) +} + +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; +} + +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_header_temp) { + $self->prepare_temp; + } else { + $self->load_header_orig + or return; + $self->prepare_orig; } -}; -############################################################################# -# extcmd framework, basically convert ext -# into pkg::->on_extcmd_arg1 (...) while shortcutting a few + 1 +} -attach_to_players - on_extcmd => sub { - my ($pl, $buf) = @_; +sub find; +sub find { + my ($path, $origin) = @_; - my $msg = eval { from_json $buf }; + $path = normalise $path, $origin && $origin->path; - if (ref $msg) { - if (my $cb = $extcmd{$msg->{msgtype}}) { - if (my %reply = $cb->[0]->($pl, $msg)) { - $pl->ext_reply ($msg->{msgid}, %reply); - } - } - } else { - warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; + cf::lock_wait "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; + + $map->{last_save} = $cf::RUNTIME; + + $map->load_header + or return; + + if ($map->should_reset) { + # doing this can freeze the server in a sync job, obviously + #$cf::WAIT_FOR_TICK->wait; + $map->reset; + undef $guard; + $map = find $path + or return; } - cf::override; - }, -; + $cf::MAP{$path} = $map + } +} -############################################################################# -# load/save/clean perl data associated with a map +sub pre_load { } +sub post_load { } -*cf::mapsupport::on_clean = sub { - my ($map) = @_; +sub load { + my ($self) = @_; - my $path = $map->tmpname; - defined $path or return; + my $path = $self->{path}; + my $guard = cf::lock_acquire "map_load:$path"; - unlink "$path.cfperl"; - unlink "$path.pst"; -}; + return if $self->in_memory != cf::MAP_SWAPPED; + + $self->in_memory (cf::MAP_LOADING); + + $self->alloc; + + $self->pre_load; + + $self->_load_objects ($self->{load_path}, 1) + or return; + + $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) + if delete $self->{load_original}; + + 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); + } + } + + Coro::cede; + + # now do the right thing for maps + $self->link_multipart_objects; + + unless ($self->{deny_activate}) { + $self->decay_objects; + $self->fix_auto_apply; + $self->update_buttons; + Coro::cede; + $self->set_darkness_map; + $self->difficulty ($self->estimate_difficulty) + unless $self->difficulty; + Coro::cede; + $self->activate; + } + + $self->post_load; + + $self->in_memory (cf::MAP_IN_MEMORY); +} -*cf::mapsupport::on_swapin = -*cf::mapsupport::on_load = sub { +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) = @_; - my $path = $map->tmpname; - $path = $map->path unless defined $path; + my @diag; # diagonal neighbours - open my $fh, "<:raw", "$path.cfperl" - or return; # no perl data + for (0 .. 3) { + my $neigh = $map->tile_path ($_) + or next; + $neigh = find $neigh, $map + or next; + $neigh->load; - my $data = Storable::thaw do { local $/; <$fh> }; + push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], + [$neigh->tile_path (($_ + 1) % 4), $neigh]; + } - $data->{version} <= 1 - or return; # too new + for (@diag) { + my $neigh = find @$_ + or next; + $neigh->load; + } +} - $map->_set_obs ($data->{obs}); -}; +sub find_sync { + my ($path, $origin) = @_; -attach_to_maps prio => -10000, package => cf::mapsupport::; + cf::sync_job { find $path, $origin } +} -############################################################################# -# load/save perl data associated with player->ob objects +sub do_load_sync { + my ($map) = @_; -sub all_objects(@) { - @_, map all_objects ($_->inv), @_ + cf::sync_job { $map->load }; } -attach_to_players - on_load => sub { - my ($pl, $path) = @_; +our %MAP_PREFETCH; +our $MAP_PREFETCHER = undef; + +sub find_async { + my ($path, $origin) = @_; + + $path = normalise $path, $origin && $origin->{path}; + + if (my $map = $cf::MAP{$path}) { + return $map if $map->in_memory == cf::MAP_IN_MEMORY; + } - for my $o (all_objects $pl->ob) { - if (my $value = $o->get_ob_key_value ("_perl_data")) { - $o->set_ob_key_value ("_perl_data"); + undef $MAP_PREFETCH{$path}; + $MAP_PREFETCHER ||= cf::async { + while (%MAP_PREFETCH) { + for my $path (keys %MAP_PREFETCH) { + my $map = find $path + or next; + $map->load; - %$o = %{ Storable::thaw pack "H*", $value }; + delete $MAP_PREFETCH{$path}; } } - }, -; + undef $MAP_PREFETCHER; + }; -############################################################################# -# core extensions - in perl + () +} + +sub save { + my ($self) = @_; + + my $lock = cf::lock_acquire "map_data:" . $self->path; + + $self->{last_save} = $cf::RUNTIME; + + return unless $self->dirty; + + my $save = $self->save_path; utf8::encode $save; + my $uniq = $self->uniq_path; utf8::encode $uniq; + + $self->{load_path} = $save; + + return if $self->{deny_save}; + + local $self->{last_access} = $self->last_access;#d# + + cf::async { + $_->contr->save for $self->players; + }; + + if ($uniq) { + $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); + $self->_save_objects ($uniq, cf::IO_UNIQUES); + } else { + $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); + } +} + +sub swap_out { + my ($self) = @_; + + # save first because save cedes + $self->save; + + my $lock = cf::lock_acquire "map_data:" . $self->path; + + return if $self->players; + return if $self->in_memory != cf::MAP_IN_MEMORY; + return if $self->{deny_save}; + + $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; + my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; + + $time + $to +} + +sub should_reset { + my ($self) = @_; + + $self->reset_at <= $cf::RUNTIME +} + +sub reset { + my ($self) = @_; + + 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# + + delete $cf::MAP{$self->path}; + + $self->in_memory (cf::MAP_SWAPPED); + $self->clear; + + $_->clear_links_to ($self) for values %cf::MAP; + + $self->unlink_save; + $self->destroy; +} + +my $nuke_counter = "aaaa"; + +sub nuke { + my ($self) = @_; + + delete $cf::MAP{$self->path}; + + $self->unlink_save; + + bless $self, "cf::map"; + delete $self->{deny_reset}; + $self->{deny_save} = 1; + $self->reset_timeout (1); + $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); + + $cf::MAP{$self->path} = $self; + + $self->reset; # polite request, might not happen +} + +=item cf::map::unique_maps + +Returns an arrayref of paths of all shared maps that have +instantiated unique items. May block. + +=cut + +sub unique_maps() { + my $files = aio_readdir cf::localdir . "/" . cf::uniquedir + or return; + + my @paths; + + for (@$files) { + utf8::decode $_; + next if /\.pst$/; + next unless /^$PATH_SEP/o; + + s/\.map$//; + push @paths, $_; + } + + \@paths +} + +package cf; + +=back + +=head3 cf::object + +=cut -=item cf::player::exists $login +package cf::object; -Returns true when the given account exists. +=over 4 + +=item $ob->inv_recursive + +Returns the inventory of the object _and_ their inventories, recursively. =cut -sub cf::player::exists($) { - cf::player::find $_[0] - or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; +sub inv_recursive_; +sub inv_recursive_ { + map { $_, inv_recursive_ $_->inv } @_ } -=item $player->reply ($npc, $msg[, $flags]) +sub inv_recursive { + inv_recursive_ inv $_[0] +} + +package cf; + +=back + +=head3 cf::object::player + +=over 4 + +=item $player_object->reply ($npc, $msg[, $flags]) Sends a message to the player, as if the npc C<$npc> replied. C<$npc> can be C. Does the right thing when the player is currently in a @@ -740,6 +1678,7 @@ # 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 sub cf::object::player::reply($$$;$) { my ($self, $npc, $msg, $flags) = @_; @@ -753,22 +1692,348 @@ } } -=item $player->ext_reply ($msgid, $msgtype, %msg) +=item $player_object->may ("access") -Sends an ext reply to the player. +Returns wether the given player is authorized to access resource "access" +(e.g. "command_wizcast"). =cut -sub cf::player::ext_reply($$$%) { - my ($self, $id, %msg) = @_; +sub cf::object::player::may { + my ($self, $access) = @_; - $msg{msgid} = $id; + $self->flag (cf::FLAG_WIZ) || + (ref $cf::CFG{"may_$access"} + ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} + : $cf::CFG{"may_$access"}) +} + +=item $player_object->enter_link + +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. + +Will never block. + +=item $player_object->leave_link ($map, $x, $y) + +Moves the player out of the special C<{link}> map onto the specified +map. If the map is not valid (or omitted), the player will be moved back +to the location he/she was before the call to C, or, if that +fails, to the emergency map position. + +Might block. + +=cut + +sub link_map { + unless ($LINK_MAP) { + $LINK_MAP = cf::map::find "{link}" + or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; + $LINK_MAP->load; + } - $self->send ("ext " . to_json \%msg); + $LINK_MAP } -############################################################################# -# map scripting support +sub cf::object::player::enter_link { + my ($self) = @_; + + $self->deactivate_recursive; + + return if UNIVERSAL::isa $self->map, "ext::map_link"; + + $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] + if $self->map; + + $self->enter_map ($LINK_MAP || link_map, 20, 20); +} + +sub cf::object::player::leave_link { + my ($self, $map, $x, $y) = @_; + + my $link_pos = delete $self->{_link_pos}; + + unless ($map) { + # restore original map position + ($map, $x, $y) = @{ $link_pos || [] }; + $map = cf::map::find $map; + + unless ($map) { + ($map, $x, $y) = @$EMERGENCY_POSITION; + $map = cf::map::find $map + or die "FATAL: cannot load emergency map\n"; + } + } + + ($x, $y) = (-1, -1) + unless (defined $x) && (defined $y); + + # use -1 or undef as default coordinates, not 0, 0 + ($x, $y) = ($map->enter_x, $map->enter_y) + 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) = @_; + + # 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) + +=cut + +sub cf::object::player::goto { + my ($self, $path, $x, $y) = @_; + + $self->enter_link; + + (async { + my $map = cf::map::find $path; + $map = $map->customise_for ($self) if $map; + +# warn "entering ", $map->path, " at ($x, $y)\n" +# if $map; + + $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); + + $self->leave_link ($map, $x, $y); + })->prio (1); +} + +=item $player_object->enter_exit ($exit_object) + +=cut + +sub parse_random_map_params { + my ($spec) = @_; + + my $rmp = { # defaults + xsize => (cf::rndm 15, 40), + ysize => (cf::rndm 15, 40), + symmetry => (cf::rndm 1, cf::SYMMETRY_XY), + #layout => string, + }; + + for (split /\n/, $spec) { + my ($k, $v) = split /\s+/, $_, 2; + + $rmp->{lc $k} = $v if (length $k) && (length $v); + } + + $rmp +} + +sub prepare_random_map { + my ($exit) = @_; + + my $guard = cf::lock_acquire "exit_prepare:$exit"; + + # all this does is basically replace the /! path by + # a new random map path (?random/...) with a seed + # that depends on the exit object + + my $rmp = parse_random_map_params $exit->msg; + + if ($exit->map) { + $rmp->{region} = $exit->map->region_name; + $rmp->{origin_map} = $exit->map->path; + $rmp->{origin_x} = $exit->x; + $rmp->{origin_y} = $exit->y; + } + + $rmp->{random_seed} ||= $exit->random_seed; + + my $data = cf::to_json $rmp; + my $md5 = Digest::MD5::md5_hex $data; + my $meta = "$cf::RANDOM_MAPS/$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); + } +} + +sub cf::object::player::enter_exit { + my ($self, $exit) = @_; + + return unless $self->type == cf::PLAYER; + + $self->enter_link; + + (async { + $self->deactivate_recursive; # just to be sure + unless (eval { + prepare_random_map $exit + if $exit->slaying eq "/!"; + + my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path; + $self->goto ($path, $exit->stats->hp, $exit->stats->sp); + + 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); + + warn "ERROR in enter_exit: $@"; + $self->leave_link; + } + })->prio (1); +} + +=head3 cf::client + +=over 4 + +=item $client->send_drawinfo ($text, $flags) + +Sends a drawinfo packet to the client. Circumvents output buffering so +should not be used under normal circumstances. + +=cut + +sub cf::client::send_drawinfo { + my ($self, $text, $flags) = @_; + + utf8::encode $text; + $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); +} + + +=item $success = $client->query ($flags, "text", \&cb) + +Queues a query to the client, calling the given callback with +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. + +=cut + +sub cf::client::query { + my ($self, $flags, $text, $cb) = @_; + + return unless $self->state == ST_PLAYING + || $self->state == ST_SETUP + || $self->state == ST_CUSTOM; + + $self->state (ST_CUSTOM); + + utf8::encode $text; + push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; + + $self->send_packet ($self->{query_queue}[0][0]) + if @{ $self->{query_queue} } == 1; +} + +cf::client->attach ( + on_reply => sub { + my ($ns, $msg) = @_; + + # this weird shuffling is so that direct followup queries + # get handled first + my $queue = delete $ns->{query_queue} + or return; # be conservative, not sure how that can happen, but we saw a crash here + + (shift @$queue)->[1]->($msg); + + push @{ $ns->{query_queue} }, @$queue; + + if (@{ $ns->{query_queue} } == @$queue) { + if (@$queue) { + $ns->send_packet ($ns->{query_queue}[0][0]); + } else { + $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; + } + } + }, +); + +=item $client->async (\&cb) + +Create a new coroutine, running the specified callback. The coroutine will +be automatically cancelled when the client gets destroyed (e.g. on logout, +or loss of connection). + +=cut + +sub cf::client::async { + my ($self, $cb) = @_; + + my $coro = &Coro::async ($cb); + + $coro->on_destroy (sub { + delete $self->{_coro}{$coro+0}; + }); + + $self->{_coro}{$coro+0} = $coro; + + $coro +} + +cf::client->attach ( + on_destroy => sub { + my ($ns) = @_; + + $_->cancel for values %{ (delete $ns->{_coro}) || {} }; + }, +); + +=back + + +=head2 SAFE SCRIPTING + +Functions that provide a safe environment to compile and execute +snippets of perl code without them endangering the safety of the server +itself. Looping constructs, I/O operators and other built-in functionality +is not available in the safe scripting environment, and the number of +functions and methods that can be called is greatly reduced. + +=cut our $safe = new Safe "safe"; our $safe_hole = new Safe::Hole; @@ -779,10 +2044,22 @@ # here we export the classes and methods available to script code +=pod + +The following fucntions and emthods are available within a safe environment: + + cf::object contr pay_amount pay_player map + cf::object::player player + cf::player peaceful + cf::map trigger + +=cut + for ( - ["cf::object" => qw(contr pay_amount pay_player)], + ["cf::object" => qw(contr pay_amount pay_player map)], ["cf::object::player" => qw(player)], ["cf::player" => qw(peaceful)], + ["cf::map" => qw(trigger)], ) { no strict 'refs'; my ($pkg, @funs) = @$_; @@ -790,6 +2067,18 @@ for @funs; } +=over 4 + +=item @retval = safe_eval $code, [var => value, ...] + +Compiled and executes the given perl code snippet. additional var/value +pairs result in temporary local (my) scalar variables of the given name +that are available in the code snippet. Example: + + my $five = safe_eval '$first + $second', first => 1, second => 4; + +=cut + sub safe_eval($;@) { my ($code, %vars) = @_; @@ -821,6 +2110,21 @@ wantarray ? @res : $res[0] } +=item cf::register_script_function $function => $cb + +Register a function that can be called from within map/npc scripts. The +function should be reasonably secure and should be put into a package name +like the extension. + +Example: register a function that gets called whenever a map script calls +C, as used by the C extension. + + cf::register_script_function "rent::overview" => sub { + ... + }; + +=cut + sub register_script_function { my ($fun, $cb) = @_; @@ -828,38 +2132,391 @@ *{"safe::$fun"} = $safe_hole->wrap ($cb); } +=back + +=cut + +############################################################################# + +=head2 EXTENSION DATABASE SUPPORT + +Crossfire maintains a very simple database for extension use. It can +currently store anything that can be serialised using Storable, which +excludes objects. + +The parameter C<$family> should best start with the name of the extension +using it, it should be unique. + +=over 4 + +=item $hashref = cf::db_get $family + +Return a hashref for use by the extension C<$family>, which can be +modified. After modifications, you have to call C or +C. + +=item $value = cf::db_get $family => $key + +Returns a single value from the database + +=item cf::db_put $family => $hashref + +Stores the given family hashref into the database. Updates are delayed, if +you want the data to be synced to disk immediately, use C. + +=item cf::db_put $family => $key => $value + +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. + +=item cf::db_dirty + +Marks the database as dirty, to be updated at a later time. + +=item cf::db_sync + +Immediately write the database to disk I. + +=cut + +our $DB; + +{ + my $path = cf::localdir . "/database.pst"; + + sub db_load() { + $DB = stat $path ? Storable::retrieve $path : { }; + } + + my $pid; + + 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; + } + } + + my $dirty; + + sub db_sync() { + db_save if $dirty; + undef $dirty; + } + + my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub { + db_sync; + }); + + sub db_dirty() { + $dirty = 1; + $idle->start; + } + + sub db_get($;$) { + @_ >= 2 + ? $DB->{$_[0]}{$_[1]} + : ($DB->{$_[0]} ||= { }) + } + + sub db_put($$;$) { + if (@_ >= 3) { + $DB->{$_[0]}{$_[1]} = $_[2]; + } else { + $DB->{$_[0]} = $_[1]; + } + db_dirty; + } + + cf::global->attach ( + prio => 10000, + on_cleanup => sub { + db_sync; + }, + ); +} + ############################################################################# # the server's main() +sub cfg_load { + open my $fh, "<:utf8", cf::confdir . "/config" + or return; + + local $/; + *CFG = YAML::Syck::Load <$fh>; + + $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; + + $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}; + + if (exists $CFG{mlockall}) { + eval { + $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" + and die "WARNING: m(un)lockall failed: $!\n"; + }; + warn $@ if $@; + } +} + sub main { + # we must not ever block the main coroutine + local $Coro::idle = sub { + Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# + (async { + Event::one_event; + })->prio (Coro::PRIO_MAX); + }; + + cfg_load; + db_load; + load_extensions; + + $TICK_WATCHER->start; Event::loop; } ############################################################################# -# initialisation +# initialisation and cleanup + +# install some emergency cleanup handlers +BEGIN { + for my $signal (qw(INT HUP TERM)) { + Event->signal ( + data => WF_AUTOCANCEL, + signal => $signal, + cb => sub { + cf::cleanup "SIG$signal"; + }, + ); + } +} -register "", __PACKAGE__; +sub emergency_save() { + my $freeze_guard = cf::freeze_mainloop; + + warn "enter emergency perl save\n"; + + cf::sync_job { + # 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"; + for my $login (keys %cf::PLAYER) { + my $pl = $cf::PLAYER{$login} or next; + $pl->valid or next; + $pl->save; + } + warn "end emergency player save\n"; + + warn "begin emergency 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"; + }; + + warn "leave emergency perl save\n"; +} + +sub reload() { + # can/must only be called in main + if ($Coro::current != $Coro::main) { + warn "can only reload from main coroutine"; + return; + } + + warn "reloading..."; + + warn "cancelling server ticker"; + $TICK_WATCHER->cancel; + + cf::emergency_save; + + eval { + # if anything goes wrong in here, we should simply crash as we already saved + + warn "syncing database to disk"; + cf::db_sync; + + warn "cancelling all WF_AUTOCANCEL watchers"; + for (Event::all_watchers) { + $_->cancel if $_->data & WF_AUTOCANCEL; + } + + warn "flushing outstanding aio requests"; + for (;;) { + IO::AIO::flush; + Coro::cede; + last unless IO::AIO::nreqs; + warn "iterate..."; + } + + warn "cancelling all extension coros"; + $_->cancel for values %EXT_CORO; + %EXT_CORO = (); + + warn "removing commands"; + %COMMAND = (); + + warn "removing ext commands"; + %EXTCMD = (); + + warn "unloading/nuking all extensions"; + for my $pkg (@EXTS) { + warn "... unloading $pkg"; + + if (my $cb = $pkg->can ("unload")) { + eval { + $cb->($pkg); + 1 + } or warn "$pkg unloaded, but with errors: $@"; + } + + warn "... nuking $pkg"; + Symbol::delete_package $pkg; + } + + warn "unloading all perl modules loaded from $LIBDIR"; + while (my ($k, $v) = each %INC) { + next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; + + warn "... unloading $k"; + delete $INC{$k}; + + $k =~ s/\.pm$//; + $k =~ s/\//::/g; + + if (my $cb = $k->can ("unload_module")) { + $cb->(); + } + + Symbol::delete_package $k; + } + + warn "getting 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); + + warn "unloading cf.pm \"a bit\""; + delete $INC{"cf.pm"}; + + # don't, removes xs symbols, too, + # and global variables created in xs + #Symbol::delete_package __PACKAGE__; + + warn "unload completed, starting to reload now"; + + warn "reloading cf.pm"; + require cf; + cf::_connect_to_perl; # nominally unnecessary, but cannot hurt + + warn "loading config and database again"; + cf::cfg_load; + cf::db_load; + + warn "loading extensions"; + cf::load_extensions; + + warn "reattaching attachments to objects/players"; + _global_reattach; + warn "reattaching attachments to maps"; + reattach $_ for values %MAP; + + warn "restarting server ticker"; + + $TICK_WATCHER->start; + }; + + if ($@) { + warn $@; + warn "error while reloading, exiting."; + exit 1; + } + + warn "reloaded"; +}; + +our $RELOAD_WATCHER; # used only during reload + +register_command "reload" => sub { + my ($who, $arg) = @_; + + if ($who->flag (FLAG_WIZ)) { + $who->message ("reloading server."); + + # 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; + }); + } +}; unshift @INC, $LIBDIR; -load_extensions; +my $bug_warning = 0; $TICK_WATCHER = Event->timer ( - prio => 1, - at => $NEXT_TICK || 1, - cb => sub { - cf::server_tick; # one server iteration + reentrant => 0, + parked => 1, + prio => 0, + at => $NEXT_TICK || $TICK, + data => WF_AUTOCANCEL, + cb => sub { + if ($Coro::current != $Coro::main) { + Carp::cluck "major BUG: server tick called outside of main coro, skipping it" + unless ++$bug_warning > 10; + return; + } + + $NOW = Event::time; - my $NOW = Event::time; + cf::server_tick; # one server iteration + $RUNTIME += $TICK; $NEXT_TICK += $TICK; - # if we are delayed by four ticks, skip them all - $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; + $WAIT_FOR_TICK->broadcast; + $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; + + # if we are delayed by four ticks or more, skip them all + $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; $TICK_WATCHER->at ($NEXT_TICK); $TICK_WATCHER->start; }, ); +IO::AIO::max_poll_time $TICK * 0.2; + +$AIO_POLL_WATCHER = Event->io ( + fd => IO::AIO::poll_fileno, + poll => 'r', + prio => 5, + data => WF_AUTOCANCEL, + cb => \&IO::AIO::poll_cb, +); + +$WRITE_RUNTIME_WATCHER = Event->timer ( + data => WF_AUTOCANCEL, + after => 1, + interval => 10, + prio => 6, # keep it lowest so it acts like a watchdog + cb => Coro::unblock_sub { + write_runtime + or warn "ERROR: unable to write runtime file: $!"; + }, +); + +END { cf::emergency_save } + 1