--- deliantra/server/lib/cf.pm	2006/03/17 03:22:00	1.9
+++ deliantra/server/lib/cf.pm	2006/12/22 02:04:20	1.95
@@ -3,17 +3,69 @@
 use Symbol;
 use List::Util;
 use Storable;
+use Opcode;
+use Safe;
+use Safe::Hole;
+
+use IO::AIO ();
+use YAML::Syck ();
+use Time::HiRes;
+use Event;
+$Event::Eval = 1; # no idea why this is required, but it is
+
+# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
+$YAML::Syck::ImplicitUnicode = 1;
 
 use strict;
 
-our %COMMAND;
+sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
+
+our %COMMAND      = ();
+our %COMMAND_TIME = ();
+our %EXTCMD       = ();
+
+_init_vars;
+
 our @EVENT;
-our %PROP_TYPE;
-our %PROP_IDX;
+our $LIBDIR = datadir . "/ext";
 
-BEGIN {
-   @EVENT = map lc, @EVENT;
+our $TICK = MAX_TIME * 1e-6;
+our $TICK_WATCHER;
+our $NEXT_TICK;
+
+our %CFG;
+
+our $UPTIME; $UPTIME ||= time;
+
+#############################################################################
+
+=head2 GLOBAL VARIABLES
+
+=over 4
+
+=item $cf::UPTIME
 
+The timestamp of the server start (so not actually an uptime).
+
+=item $cf::LIBDIR
+
+The perl library directory, where extensions and cf-specific modules can
+be found. It will be added to C<@INC> automatically.
+
+=item $cf::TICK
+
+The interval between server ticks, in seconds.
+
+=item %cf::CFG
+
+Configuration for the server, loaded from C</etc/crossfire/config>, or
+from wherever your confdir points to.
+
+=back
+
+=cut
+
+BEGIN {
    *CORE::GLOBAL::warn = sub {
       my $msg = join "", @_;
       $msg .= "\n"
@@ -24,100 +76,566 @@
    };
 }
 
-my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
+@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::global
+   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;
+}
+
+$Event::DIED = sub {
+   warn "error in event callback: @_";
+};
 
-# generate property mutators
-sub prop_gen {
-   my ($prefix, $class) = @_;
+my %ext_pkg;
+my @exts;
+my @hook;
 
-   no strict 'refs';
+=head2 UTILITY FUNCTIONS
 
-   for my $prop (keys %PROP_TYPE) {
-      $prop =~ /^\Q$prefix\E_(.*$)/ or next;
-      my $sub = lc $1;
+=over 4
 
-      my $type = $PROP_TYPE{$prop};
-      my $idx  = $PROP_IDX {$prop};
+=cut
 
-      *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
-         $_[0]->get_property ($type, $idx)
-      };
+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]
+}
+
+=back
+
+=cut
+
+#############################################################################
+
+=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<global>, C<object>
+C<player>, C<client> or C<map> (i.e. the attachable objects in
+crossfire+).
 
-      *{"$class\::set_$sub"} = sub {
-         $_[0]->set_property ($type, $idx, $_[1]);
-      } unless $ignore_set{$prop};
+=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)
+
+Checks wether the named attachment is currently attached to the object.
+
+=item cf::CLASS->attach ...
+
+=item cf::CLASS->detach ...
+
+Define an anonymous attachment and attach it to all objects of the given
+CLASS. See the next function for an explanation of its arguments.
+
+You can attach to global events by using the C<cf::global> class.
+
+Example, log all player logins:
+
+   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.
+
+These calls expect any number of the following handler/hook descriptions:
+
+=over 4
+
+=item prio => $number
+
+Set the priority for all following handlers/hooks (unless overwritten
+by another C<prio> setting). Lower priority handlers get executed
+earlier. The default priority is C<0>, and many built-in handlers are
+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<subtype> can be
+used to further limit to the given subtype).
+
+=item on_I<event> => \&cb
+
+Call the given code reference whenever the named event happens (event is
+something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
+handlers are recognised generally depends on the type of object these
+handlers attach to).
+
+See F<include/eventinc.h> for the full list of events supported, and their
+class.
+
+=item package => package::
+
+Look for sub functions of the name C<< on_I<event> >> in the given
+package and register them.  Only handlers for eevents supported by the
+object/class are recognised.
+
+=back
+
+Example, define an attachment called "sockpuppet" that calls the given
+event handler when a monster attacks:
+
+   cf::object::attachment sockpuppet =>
+      on_skill_attack => sub {
+         my ($self, $victim) = @_;
+         ...
+      }
    }
+
+=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_CLIENT = ();
+our @CB_TYPE   = (); # registry for type (cf-object class) based events
+our @CB_MAP    = ();
+
+my %attachment;
+
+sub _attach_cb($$$$) {
+   my ($registry, $event, $prio, $cb) = @_;
+
+   use sort 'stable';
+
+   $cb = [$prio, $cb];
+
+   @{$registry->[$event]} = sort
+                           { $a->[0] cmp $b->[0] }
+                           @{$registry->[$event] || []}, $cb;
 }
 
-# auto-generate most of the API
+# 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 {
+   my ($registry, $klass, @arg) = @_;
+
+   my $object_type;
+   my $prio = 0;
+   my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 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, $id, $prio, $cb;
+            }
+         }
 
-prop_gen OBJECT_PROP => "cf::object";
-# CFAPI_OBJECT_ANIMATION?
-prop_gen PLAYER_PROP => "cf::object::player";
+      } elsif (exists $cb_id{$type}) {
+         _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
 
-prop_gen MAP_PROP    => "cf::map";
-prop_gen ARCH_PROP   => "cf::arch";
+      } elsif (ref $type) {
+         warn "attaching objects not supported, ignoring.\n";
 
-# guessed hierarchies
+      } else {
+         shift @arg;
+         warn "attach argument '$type' not supported, ignoring.\n";
+      }
+   }
+}
 
-@cf::object::player::ISA = 'cf::object';
-@cf::object::map::ISA    = 'cf::object';
+sub _object_attach {
+   my ($obj, $name, %arg) = @_;
 
-my %ext_pkg;
-my @exts;
-my @hook;
-my %command;
+   return if exists $obj->{_attachment}{$name};
 
-sub inject_event {
-   my ($data) = @_;
+   if (my $attach = $attachment{$name}) {
+      my $registry = $obj->registry;
 
-   my $cb = $hook[$data->{event_code}]{$data->{extension}}
-      or return;
+      for (@$attach) {
+         my ($klass, @attach) = @$_;
+         _attach $registry, $klass, @attach;
+      }
+
+      $obj->{$name} = \%arg;
+   } else {
+      warn "object uses attachment '$name' that is not available, postponing.\n";
+   }
 
-   $cb->($data)
+   $obj->{_attachment}{$name} = undef;
 }
 
-sub inject_global_event {
-   my ($data) = @_;
+sub cf::attachable::attach {
+   if (ref $_[0]) {
+      _object_attach @_;
+   } else {
+      _attach shift->_attach_registry, @_;
+   }
+};
 
-   my $cb = $hook[$data->{event_code}]
-      or return;
+# 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";
+   }
+};
 
-   $_->($data) for values %$cb;
+sub cf::attachable::attached {
+   my ($obj, $name) = @_;
 
-   ()
+   exists $obj->{_attachment}{$name}
 }
 
-sub inject_command {
-   my ($name, $obj, $params) = @_;
+for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {
+   eval "#line " . __LINE__ . " 'cf.pm'
+      sub cf::\L$klass\E::_attach_registry {
+         (\\\@CB_$klass, KLASS_$klass)
+      }
+
+      sub cf::\L$klass\E::attachment {
+         my \$name = shift;
+
+         \$attachment{\$name} = [[KLASS_$klass, \@_]];
+      }
+   ";
+   die if $@;
+}
+
+our $override;
+our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
+
+sub override {
+   $override = 1;
+   @invoke_results = ();
+}
+
+sub do_invoke {
+   my $event = shift;
+   my $callbacks = shift;
+
+   @invoke_results = ();
+
+   local $override;
+
+   for (@$callbacks) {
+      eval { &{$_->[1]} };
 
-   for my $cmd (@{ $command{$name} }) {
-      $cmd->[1]->($obj, $params);
+      if ($@) {
+         warn "$@";
+         warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
+         override;
+      }
+
+      return 1 if $override;
    }
 
-   -1
+   0
 }
 
+=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
+
+=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
+
+=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
+
+=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
+
+=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
+
+Generate a global/object/player/map-specific event with the given arguments.
+
+This API is preliminary (most likely, the EVENT_KLASS_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
+
+#############################################################################
+
+=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
+
+Attachable objects includes objects, players, clients and maps.
+
+=over 4
+
+=item $object->valid
+
+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.
+
+=back
+
+=cut
+
+#############################################################################
+# object support
+
+sub instantiate {
+   my ($obj, $data) = @_;
+
+   $data = from_json $data;
+
+   for (@$data) {
+      my ($name, $args) = @$_;
+
+      $obj->attach ($name, %{$args || {} });
+   }
+}
+
+# basically do the same as instantiate, without calling instantiate
+sub reattach {
+   my ($obj) = @_;
+   my $registry = $obj->registry;
+
+   @$registry = ();
+
+   delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
+
+   for my $name (keys %{ $obj->{_attachment} || {} }) {
+      if (my $attach = $attachment{$name}) {
+         for (@$attach) {
+            my ($klass, @attach) = @$_;
+            _attach $registry, $klass, @attach;
+         }
+      } else {
+         warn "object uses attachment '$name' that is not available, postponing.\n";
+      }
+   }
+}
+
+sub object_freezer_save {
+   my ($filename, $rdata, $objs) = @_;
+
+   if (length $$rdata) {
+      warn sprintf "saving %s (%d,%d)\n",
+         $filename, length $$rdata, scalar @$objs;
+
+      if (open my $fh, ">:raw", "$filename~") {
+         chmod SAVE_MODE, $fh;
+         syswrite $fh, $$rdata;
+         close $fh;
+
+         if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
+            chmod SAVE_MODE, $fh;
+            syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
+            close $fh;
+            rename "$filename.pst~", "$filename.pst";
+         } else {
+            unlink "$filename.pst";
+         }
+
+         rename "$filename~", $filename;
+      } else {
+         warn "FATAL: $filename~: $!\n";
+      }
+   } else {
+      unlink $filename;
+      unlink "$filename.pst";
+   }
+}
+
+sub object_freezer_as_string {
+   my ($rdata, $objs) = @_;
+
+   use Data::Dumper;
+
+   $$rdata . Dumper $objs
+}
+
+sub object_thawer_load {
+   my ($filename) = @_;
+
+   local $/;
+
+   my $av;
+
+   #TODO: use sysread etc.
+   if (open my $data, "<:raw:perlio", $filename) {
+      $data = <$data>;
+      if (open my $pst, "<:raw:perlio", "$filename.pst") {
+         $av = eval { (Storable::thaw <$pst>)->{objs} };
+      }
+      return ($data, $av);
+   }
+
+   ()
+}
+
+cf::object->attach (
+   prio     => -1000000,
+   on_clone => sub {
+      my ($src, $dst) = @_;
+
+      @{$dst->registry} = @{$src->registry};
+
+      %$dst = %$src;
+
+      %{$dst->{_attachment}} = %{$src->{_attachment}}
+         if exists $src->{_attachment};
+   },
+);
+
+#############################################################################
+# 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'";
 
-   warn "registering command '$name/$time' to '$caller'";
+   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) = @_;
 
-   push @{ $command{$name} }, [$time, $cb, $caller];
-   $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
+   my $caller = caller;
+   #warn "registering extcmd '$name' to '$caller'";
+
+   $EXTCMD{$name} = [$cb, $caller];
 }
 
+cf::player->attach (
+   on_command => sub {
+      my ($pl, $name, $params) = @_;
+
+      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->[0]->($pl, $msg)) {
+               $pl->ext_reply ($msg->{msgid}, %reply);
+            }
+         }
+      } else {
+         warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
+      }
+
+      cf::override;
+   },
+);
+
 sub register {
    my ($base, $pkg) = @_;
 
-   for my $idx (0 .. $#EVENT) {
-      if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
-         warn "registering $EVENT[$idx] hook to '$pkg'\n";
-         $hook[$idx]{$base} = $ref;
-      }
-   }
+   #TODO
 }
 
 sub load_extension {
@@ -127,7 +645,7 @@
    my $base = $1;
    my $pkg = $1;
    $pkg =~ s/[^[:word:]]/_/g;
-   $pkg = "cf::ext::$pkg";
+   $pkg = "ext::$pkg";
 
    warn "loading '$path' into '$pkg'\n";
 
@@ -141,13 +659,14 @@
       . "\n};\n1";
 
    eval $source
-      or die "$path: $@";
+      or die $@ ? "$path: $@\n"
+                : "extension disabled.\n";
 
    push @exts, $pkg;
    $ext_pkg{$base} = $pkg;
 
 #   no strict 'refs';
-#   @{"$pkg\::ISA"} = cf::ext::;
+#   @{"$pkg\::ISA"} = ext::;
 
    register $base, $pkg;
 }
@@ -158,29 +677,38 @@
    warn "removing extension $pkg\n";
 
    # remove hooks
-   for my $idx (0 .. $#EVENT) {
-      delete $hook[$idx]{$pkg};
-   }
+   #TODO
+#   for my $idx (0 .. $#PLUGIN_EVENT) {
+#      delete $hook[$idx]{$pkg};
+#   }
 
    # remove commands
-   for my $name (keys %command) {
-      my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
+   for my $name (keys %COMMAND) {
+      my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
 
       if (@cb) {
-         $command{$name} = \@cb;
-         $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
+         $COMMAND{$name} = \@cb;
       } else {
-         delete $command{$name};
-         delete $COMMAND{"$name\000"};
+         delete $COMMAND{$name};
       }
    }
 
+   # remove extcmds
+   for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
+      delete $EXTCMD{$name};
+   }
+
+   if (my $cb = $pkg->can ("unload")) {
+      eval {
+         $cb->($pkg);
+         1
+      } or warn "$pkg unloaded, but with errors: $@";
+   }
+
    Symbol::delete_package $pkg;
 }
 
 sub load_extensions {
-   my $LIBDIR = maps_directory "perl";
-
    for my $ext (<$LIBDIR/*.ext>) {
       next unless -r $ext;
       eval {
@@ -190,135 +718,550 @@
    }
 }
 
-register_command "perl-reload", 0, sub {
-   my ($who, $arg) = @_;
+#############################################################################
+# load/save/clean perl data associated with a map
 
-   if ($who->flag (FLAG_WIZ)) {
-      $who->message ("reloading...");
+*cf::mapsupport::on_clean = sub {
+   my ($map) = @_;
 
-      warn "reloading...\n";
-      eval {
-         unload_extension $_ for @exts;
-         delete $INC{"cf.pm"};
+   my $path = $map->tmpname;
+   defined $path or return;
 
-         # don't, removes xs symbols, too
-         #Symbol::delete_package $pkg;
+   unlink "$path.pst";
+};
 
-         require cf;
-      };
-      warn $@ if $@;
-      $who->message ($@) if $@;
-      warn "reloaded\n";
+cf::map->attach (prio => -10000, package => cf::mapsupport::);
+
+#############################################################################
+# load/save perl data associated with player->ob objects
+
+sub all_objects(@) {
+   @_, map all_objects ($_->inv), @_
+}
+
+# TODO: compatibility cruft, remove when no longer needed
+cf::player->attach (
+   on_load => sub {
+      my ($pl, $path) = @_;
+
+      for my $o (all_objects $pl->ob) {
+         if (my $value = $o->get_ob_key_value ("_perl_data")) {
+            $o->set_ob_key_value ("_perl_data");
+
+            %$o = %{ Storable::thaw pack "H*", $value };
+         }
+      }
+   },
+);
+
+#############################################################################
+
+=head2 CORE EXTENSIONS
+
+Functions and methods that extend core crossfire objects.
+
+=head3 cf::player
+
+=over 4
+
+=item cf::player::exists $login
+
+Returns true when the given account exists.
+
+=cut
+
+sub cf::player::exists($) {
+   cf::player::find $_[0]
+      or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
+}
+
+=item $player->ext_reply ($msgid, $msgtype, %msg)
+
+Sends an ext reply to the player.
+
+=cut
+
+sub cf::player::ext_reply($$$%) {
+   my ($self, $id, %msg) = @_;
+
+   $msg{msgid} = $id;
 
-      $who->message ("reloaded");
+   $self->send ("ext " . to_json \%msg);
+}
+
+=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<undef>. Does the right thing when the player is currently in a
+dialogue with the given NPC character.
+
+=cut
+
+# 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) = @_;
+
+   $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
+
+   if ($self->{record_replies}) {
+      push @{ $self->{record_replies} }, [$npc, $msg, $flags];
    } else {
-      $who->message ("Intruder Alert!");
+      $msg = $npc->name . " says: $msg" if $npc;
+      $self->message ($msg, $flags);
    }
-};
+}
+
+=item $player_object->may ("access")
+
+Returns wether the given player is authorized to access resource "access"
+(e.g. "command_wizcast").
+
+=cut
+
+sub cf::object::player::may {
+   my ($self, $access) = @_;
+
+   $self->flag (cf::FLAG_WIZ) || 
+      (ref $cf::CFG{"may_$access"}
+         ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
+         : $cf::CFG{"may_$access"})
+}
+
+=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<cf::CS_QUERY_YESNO>,
+C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> 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};
+
+      (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);
+         }
+      }
+   },
+);
+
+=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;
+
+$SIG{FPE} = 'IGNORE';
+
+$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math 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:
+
+  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 map)],
+   ["cf::object::player" => qw(player)],
+   ["cf::player"         => qw(peaceful)],
+   ["cf::map"            => qw(trigger)],
+) {
+   no strict 'refs';
+   my ($pkg, @funs) = @$_;
+   *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
+      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) = @_;
+
+   my $qcode = $code;
+   $qcode =~ s/"/‟/g; # not allowed in #line filenames
+   $qcode =~ s/\n/\\n/g;
+
+   local $_;
+   local @safe::cf::_safe_eval_args = values %vars;
+
+   my $eval =
+      "do {\n"
+      . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
+      . "#line 0 \"{$qcode}\"\n"
+      . $code
+      . "\n}"
+   ;
+
+   sub_generation_inc;
+   my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
+   sub_generation_inc;
+
+   if ($@) {
+      warn "$@";
+      warn "while executing safe code '$code'\n";
+      warn "with arguments " . (join " ", %vars) . "\n";
+   }
+
+   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<rent::overview>, as used by the C<rent> extension.
+
+   cf::register_script_function "rent::overview" => sub {
+     ...
+   };
+
+=cut
+
+sub register_script_function {
+   my ($fun, $cb) = @_;
+
+   no strict 'refs';
+   *{"safe::$fun"} = $safe_hole->wrap ($cb);
+}
+
+=back
+
+=cut
 
 #############################################################################
-# load/save/clean perl data associated with a map
 
-*on_mapclean = sub {
-   my $map = shift->{map};
+=head2 EXTENSION DATABASE SUPPORT
 
-   my $path = $map->tmpname;
-   defined $path or return;
+Crossfire maintains a very simple database for extension use. It can
+currently store anything that can be serialised using Storable, which
+excludes objects.
 
-   unlink "$path.cfperl";
-};
+The parameter C<$family> should best start with the name of the extension
+using it, it should be unique.
 
-*on_mapin =
-*on_mapload = sub {
-   my $map = shift->{map};
+=over 4
 
-   my $path = $map->tmpname;
-   $path = $map->path unless defined $path;
+=item $hashref = cf::db_get $family
 
-   open my $fh, "<:raw", "$path.cfperl"
-      or return; # no perl data
+Return a hashref for use by the extension C<$family>, which can be
+modified. After modifications, you have to call C<cf::db_dirty> or
+C<cf::db_sync>.
 
-   my $data = Storable::thaw do { local $/; <$fh> };
+=item $value = cf::db_get $family => $key
 
-   $data->{version} <= 1
-      or return; # too new
+Returns a single value from the database
 
-   $map->_set_obs ($data->{obs});
-};
+=item cf::db_put $family => $hashref
 
-*on_mapout = sub {
-   my $map = shift->{map};
+Stores the given family hashref into the database. Updates are delayed, if
+you want the data to be synced to disk immediately, use C<cf::db_sync>.
 
-   my $path = $map->tmpname;
-   $path = $map->path unless defined $path;
+=item cf::db_put $family => $key => $value
 
-   my $obs = $map->_get_obs;
+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<cf::db_sync>.
 
-   if (defined $obs) {
-      open my $fh, ">:raw", "$path.cfperl"
-         or die "$path.cfperl: $!";
+=item cf::db_dirty
 
-      stat $path;
+Marks the database as dirty, to be updated at a later time.
 
-      print $fh Storable::nfreeze {
-         size    => (stat _)[7],
-         time    => (stat _)[9],
-         version => 1,
-         obs     => $obs,
-      };
+=item cf::db_sync
 
-      chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
-   } else {
-      unlink "$path.cfperl";
+Immediately write the database to disk I<if it is dirty>.
+
+=cut
+
+our $DB;
+
+{
+   my $path = cf::localdir . "/database.pst";
+
+   sub db_load() {
+      warn "loading database $path\n";#d# remove later
+      $DB = stat $path ? Storable::retrieve $path : { };
    }
-};
+
+   my $pid;
+
+   sub db_save() {
+      warn "saving database $path\n";#d# remove later
+      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 => $TICK * 2.8, max => 10, 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;
+      },
+   );
+}
 
 #############################################################################
-# load/save perl data associated with player->ob objects
+# the server's main()
+
+sub cfg_load {
+   open my $fh, "<:utf8", cf::confdir . "/config"
+      or return;
+
+   local $/;
+   *CFG = YAML::Syck::Load <$fh>;
+}
 
-*on_player_load = sub {
-   my ($event) = @_;
-   my $path = $event->{message};
-   my $ob = $event->{who};
+sub main {
+   cfg_load;
+   db_load;
+   load_extensions;
+   Event::loop;
+}
 
-   open my $fh, "<:raw", "$path.cfperl"
-      or return; # no perl data
+#############################################################################
+# initialisation
 
-   my $data = Storable::thaw do { local $/; <$fh> };
+sub _perl_reload(&) {
+   my ($msg) = @_;
 
-   $data->{version} <= 1
-      or return; # too new
+   $msg->("reloading...");
 
-   %$ob = %{$data->{ob}};
+   eval {
+      # cancel all watchers
+      for (Event::all_watchers) {
+         $_->cancel if $_->data & WF_AUTOCANCEL;
+      }
+
+      # unload all extensions
+      for (@exts) {
+         $msg->("unloading <$_>");
+         unload_extension $_;
+      }
+
+      # unload all modules loaded from $LIBDIR
+      while (my ($k, $v) = each %INC) {
+         next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
+
+         $msg->("removing <$k>");
+         delete $INC{$k};
+
+         $k =~ s/\.pm$//;
+         $k =~ s/\//::/g;
+
+         if (my $cb = $k->can ("unload_module")) {
+            $cb->();
+         }
+
+         Symbol::delete_package $k;
+      }
+
+      # sync database to disk
+      cf::db_sync;
+
+      # 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);
+
+      # remove register_script_function callbacks
+      # TODO
+      
+      # unload cf.pm "a bit"
+      delete $INC{"cf.pm"};
+
+      # don't, removes xs symbols, too,
+      # and global variables created in xs
+      #Symbol::delete_package __PACKAGE__;
+
+      # reload cf.pm
+      $msg->("reloading cf.pm");
+      require cf;
+
+      # load config and database again
+      cf::cfg_load;
+      cf::db_load;
+
+      # load extensions
+      $msg->("load extensions");
+      cf::load_extensions;
+
+      # reattach attachments to objects
+      $msg->("reattach");
+      _global_reattach;
+   };
+   $msg->($@) if $@;
+
+   $msg->("reloaded");
 };
 
-*on_player_save = sub {
-   my ($event) = @_;
-   my $path = $event->{message};
-   my $ob = $event->{who};
-
-   if (keys %$ob) {
-      open my $fh, ">:raw", "$path.cfperl"
-         or die "$path.cfperl: $!";
-
-      stat $path;
-
-      print $fh Storable::nfreeze {
-         size    => (stat _)[7],
-         time    => (stat _)[9],
-         version => 1,
-         ob      => $ob,
-      };
+sub perl_reload() {
+   _perl_reload {
+      warn $_[0];
+      print "$_[0]\n";
+   };
+}
 
-      chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
-   } else {
-      unlink "$path.cfperl";
+register "<global>", __PACKAGE__;
+
+register_command "perl-reload" => sub {
+   my ($who, $arg) = @_;
+
+   if ($who->flag (FLAG_WIZ)) {
+      _perl_reload {
+         warn $_[0];
+         $who->message ($_[0]);
+      };
    }
 };
 
-register "<global>", __PACKAGE__;
+unshift @INC, $LIBDIR;
 
-load_extensions;
+$TICK_WATCHER = Event->timer (
+   prio  => 0,
+   at    => $NEXT_TICK || 1,
+   data  => WF_AUTOCANCEL,
+   cb    => sub {
+      cf::server_tick; # one server iteration
+
+      my $NOW = Event::time;
+      $NEXT_TICK += $TICK;
+
+      # if we are delayed by four ticks or more, skip them all
+      $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
+
+      $TICK_WATCHER->at ($NEXT_TICK);
+      $TICK_WATCHER->start;
+   },
+);
+
+IO::AIO::max_poll_time $TICK * 0.2;
+
+Event->io (fd   => IO::AIO::poll_fileno,
+           poll => 'r',
+           prio => 5,
+           data => WF_AUTOCANCEL,
+           cb   => \&IO::AIO::poll_cb);
 
 1