--- deliantra/server/lib/cf.pm 2006/10/01 15:59:29 1.74 +++ deliantra/server/lib/cf.pm 2006/12/21 23:02:54 1.94 @@ -7,6 +7,7 @@ use Safe; use Safe::Hole; +use IO::AIO (); use YAML::Syck (); use Time::HiRes; use Event; @@ -17,11 +18,16 @@ use strict; +sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload + +our %COMMAND = (); +our %COMMAND_TIME = (); +our %EXTCMD = (); + _init_vars; -our %COMMAND = (); our @EVENT; -our $LIBDIR = maps_directory "perl"; +our $LIBDIR = datadir . "/ext"; our $TICK = MAX_TIME * 1e-6; our $TICK_WATCHER; @@ -29,12 +35,18 @@ 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 @@ -64,11 +76,22 @@ }; } +@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 cf::living)) { +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; } @@ -80,8 +103,6 @@ my %ext_pkg; my @exts; my @hook; -my %command; -my %extcmd; =head2 UTILITY FUNCTIONS @@ -119,42 +140,72 @@ ############################################################################# -=head2 EVENTS AND OBJECT ATTACHMENTS +=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 $object->attach ($attachment, key => $value...) +=item $attachable->attach ($attachment, key => $value...) -=item $object->detach ($attachment) +=item $attachable->detach ($attachment) -Attach/detach a pre-registered attachment to an object. +Attach/detach a pre-registered attachment to a specific object and give it +the specified key/value pairs as arguments. -=item $player->attach ($attachment, key => $value...) +Example, attach a minesweeper attachment to the given object, making it a +10x10 minesweeper game: -=item $player->detach ($attachment) + $obj->attach (minesweeper => width => 10, height => 10); -Attach/detach a pre-registered attachment to a player. +=item $bool = $attachable->attached ($name) -=item $map->attach ($attachment, key => $value...) +Checks wether the named attachment is currently attached to the object. -=item $map->detach ($attachment) +=item cf::CLASS->attach ... -Attach/detach a pre-registered attachment to a map. +=item cf::CLASS->detach ... -=item $bool = $object->attached ($name) +Define an anonymous attachment and attach it to all objects of the given +CLASS. See the next function for an explanation of its arguments. -=item $bool = $player->attached ($name) +You can attach to global events by using the C class. -=item $bool = $map->attached ($name) +Example, log all player logins: -Checks wether the named attachment is currently attached to the object. + cf::player->attach ( + on_login => sub { + my ($pl) = @_; + ... + }, + ); -=item cf::attach_global ... +Example, attach to the jeweler skill: -Attach handlers for global events. + 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 @@ -166,6 +217,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 @@ -184,40 +241,15 @@ =back -=item cf::attach_to_type $object_type, $subtype, ... - -Attach handlers for a specific object type (e.g. TRANSPORT) and -subtype. If C<$subtype> is zero or undef, matches all objects of the given -type. - -=item cf::attach_to_objects ... +Example, define an attachment called "sockpuppet" that calls the given +event handler when a monster attacks: -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. - -=item cf::attach_to_maps ... - -Attach handlers to all maps. - -=item cf:register_attachment $name, ... - -Register an attachment by name through which objects can refer to this -attachment. - -=item cf:register_player_attachment $name, ... - -Register an attachment by name through which players can refer to this -attachment. - -=item cf:register_map_attachment $name, ... - -Register an attachment by name through which maps can refer to this -attachment. + cf::object::attachment sockpuppet => + on_skill_attack => sub { + my ($self, $victim) = @_; + ... + } + } =cut @@ -225,13 +257,14 @@ 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, $undo, $event, $prio, $cb) = @_; +sub _attach_cb($$$$) { + my ($registry, $event, $prio, $cb) = @_; use sort 'stable'; @@ -240,23 +273,16 @@ @{$registry->[$event]} = sort { $a->[0] cmp $b->[0] } @{$registry->[$event] || []}, $cb; - - push @{$undo->{cb}}, [$event, $cb]; } # 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; while (@arg) { @@ -265,17 +291,26 @@ 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"; @@ -285,23 +320,19 @@ warn "attach argument '$type' not supported, ignoring.\n"; } } - - \%undo } -sub _attach_attachment { +sub _object_attach { my ($obj, $name, %arg) = @_; return if exists $obj->{_attachment}{$name}; - my $res; - if (my $attach = $attachment{$name}) { my $registry = $obj->registry; for (@$attach) { my ($klass, @attach) = @$_; - $res = _attach @$registry, $klass, @attach; + _attach $registry, $klass, @attach; } $obj->{$name} = \%arg; @@ -310,76 +341,47 @@ } $obj->{_attachment}{$name} = undef; - - $res->{attachment} = $name; - $res } -*cf::object::attach = -*cf::player::attach = -*cf::map::attach = sub { - my ($obj, $name, %arg) = @_; - - _attach_attachment $obj, $name, %arg; +sub cf::attachable::attach { + if (ref $_[0]) { + _object_attach @_; + } else { + _attach shift->_attach_registry, @_; + } }; # all those should be optimised -*cf::object::detach = -*cf::player::detach = -*cf::map::detach = sub { +sub cf::attachable::detach { my ($obj, $name) = @_; - delete $obj->{_attachment}{$name}; - reattach ($obj); + if (ref $obj) { + delete $obj->{_attachment}{$name}; + reattach ($obj); + } else { + Carp::croak "cannot, currently, detach class attachments"; + } }; -*cf::object::attached = -*cf::player::attached = -*cf::map::attached = sub { +sub cf::attachable::attached { my ($obj, $name) = @_; exists $obj->{_attachment}{$name} -}; - -sub attach_global { - _attach @CB_GLOBAL, KLASS_GLOBAL, @_ -} - -sub attach_to_type { - my $type = shift; - my $subtype = shift; - - _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ -} - -sub attach_to_objects { - _attach @CB_OBJECT, KLASS_OBJECT, @_ -} - -sub attach_to_players { - _attach @CB_PLAYER, KLASS_PLAYER, @_ -} - -sub attach_to_maps { - _attach @CB_MAP, KLASS_MAP, @_ -} - -sub register_attachment { - my $name = shift; - - $attachment{$name} = [[KLASS_OBJECT, @_]]; } -sub register_player_attachment { - my $name = shift; - - $attachment{$name} = [[KLASS_PLAYER, @_]]; -} +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 register_map_attachment { - my $name = shift; + sub cf::\L$klass\E::attachment { + my \$name = shift; - $attachment{$name} = [[KLASS_MAP, @_]]; + \$attachment{\$name} = [[KLASS_$klass, \@_]]; + } + "; + die if $@; } our $override; @@ -419,6 +421,8 @@ =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. @@ -433,11 +437,13 @@ ############################################################################# -=head2 METHODS VALID FOR ALL CORE OBJECTS +=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS + +Attachable objects includes objects, players, clients and maps. =over 4 -=item $object->valid, $player->valid, $map->valid +=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 @@ -449,10 +455,6 @@ =cut -*cf::object::valid = -*cf::player::valid = -*cf::map::valid = \&cf::_valid; - ############################################################################# # object support @@ -481,7 +483,7 @@ if (my $attach = $attachment{$name}) { for (@$attach) { my ($klass, @attach) = @$_; - _attach @$registry, $klass, @attach; + _attach $registry, $klass, @attach; } } else { warn "object uses attachment '$name' that is not available, postponing.\n"; @@ -520,6 +522,14 @@ } } +sub object_freezer_as_string { + my ($rdata, $objs) = @_; + + use Data::Dumper; + + $$rdata . Dumper $objs +} + sub object_thawer_load { my ($filename) = @_; @@ -539,7 +549,7 @@ () } -attach_to_objects +cf::object->attach ( prio => -1000000, on_clone => sub { my ($src, $dst) = @_; @@ -551,49 +561,35 @@ %{$dst->{_attachment}} = %{$src->{_attachment}} if exists $src->{_attachment}; }, -; +); ############################################################################# -# old plug-in events +# command handling &c -sub inject_event { - my $extension = shift; - my $event_code = shift; +=item cf::register_command $name => \&callback($ob,$args); - my $cb = $hook[$event_code]{$extension} - or return; +Register a callback for execution when the client sends the user command +$name. - &$cb -} +=cut -sub inject_global_event { - my $event = shift; +sub register_command { + my ($name, $cb) = @_; - my $cb = $hook[$event] - or return; + my $caller = caller; + #warn "registering command '$name/$time' to '$caller'"; - List::Util::max map &$_, values %$cb + push @{ $COMMAND{$name} }, [$caller, $cb]; } -sub inject_command { - my ($name, $obj, $params) = @_; - - for my $cmd (@{ $command{$name} }) { - $cmd->[1]->($obj, $params); - } +=item cf::register_extcmd $name => \&callback($pl,$packet); - -1 -} +Register a callbackf ro execution when the client sends an extcmd packet. -sub register_command { - my ($name, $time, $cb) = @_; +If the callback returns something, it is sent back as if reply was being +called. - 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} }; -} +=cut sub register_extcmd { my ($name, $cb) = @_; @@ -601,9 +597,41 @@ my $caller = caller; #warn "registering extcmd '$name' to '$caller'"; - $extcmd{$name} = [$cb, $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) = @_; @@ -631,7 +659,8 @@ . "\n};\n1"; eval $source - or die "$path: $@"; + or die $@ ? "$path: $@\n" + : "extension disabled.\n"; push @exts, $pkg; $ext_pkg{$base} = $pkg; @@ -654,21 +683,19 @@ # } # 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}; + for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { + delete $EXTCMD{$name}; } if (my $cb = $pkg->can ("unload")) { @@ -682,8 +709,6 @@ } sub load_extensions { - my $LIBDIR = maps_directory "perl"; - for my $ext (<$LIBDIR/*.ext>) { next unless -r $ext; eval { @@ -694,30 +719,6 @@ } ############################################################################# -# extcmd framework, basically convert ext -# into pkg::->on_extcmd_arg1 (...) while shortcutting a few - -attach_to_players - 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; - }, -; - -############################################################################# # load/save/clean perl data associated with a map *cf::mapsupport::on_clean = sub { @@ -729,7 +730,7 @@ unlink "$path.pst"; }; -attach_to_maps prio => -10000, package => cf::mapsupport::; +cf::map->attach (prio => -10000, package => cf::mapsupport::); ############################################################################# # load/save perl data associated with player->ob objects @@ -739,7 +740,7 @@ } # TODO: compatibility cruft, remove when no longer needed -attach_to_players +cf::player->attach ( on_load => sub { my ($pl, $path) = @_; @@ -751,7 +752,7 @@ } } }, -; +); ############################################################################# @@ -772,7 +773,7 @@ or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; } -=item $player->reply ($npc, $msg[, $flags]) +=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 @@ -809,7 +810,21 @@ $self->send ("ext " . to_json \%msg); } -=back +=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"}) +} =cut @@ -821,7 +836,7 @@ 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 cna be called is greatly reduced. +functions and methods that can be called is greatly reduced. =cut @@ -838,16 +853,18 @@ The following fucntions and emthods are available within a safe environment: - cf::object contr pay_amount pay_player + 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) = @$_; @@ -967,13 +984,14 @@ =cut +our $DB; + { - my $db; my $path = cf::localdir . "/database.pst"; sub db_load() { warn "loading database $path\n";#d# remove later - $db = stat $path ? Storable::retrieve $path : { }; + $DB = stat $path ? Storable::retrieve $path : { }; } my $pid; @@ -982,8 +1000,8 @@ 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~"; + $DB->{_meta}{version} = 1; + Storable::nstore $DB, "$path~"; rename "$path~", $path; cf::_exit 0 if defined $pid; } @@ -996,7 +1014,7 @@ undef $dirty; } - my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { + my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { db_sync; }); @@ -1007,25 +1025,25 @@ sub db_get($;$) { @_ >= 2 - ? $db->{$_[0]}{$_[1]} - : ($db->{$_[0]} ||= { }) + ? $DB->{$_[0]}{$_[1]} + : ($DB->{$_[0]} ||= { }) } sub db_put($$;$) { if (@_ >= 3) { - $db->{$_[0]}{$_[1]} = $_[2]; + $DB->{$_[0]}{$_[1]} = $_[2]; } else { - $db->{$_[0]} = $_[1]; + $DB->{$_[0]} = $_[1]; } db_dirty; } - attach_global - prio => 10000, + cf::global->attach ( + prio => 10000, on_cleanup => sub { db_sync; }, - ; + ); } ############################################################################# @@ -1056,7 +1074,9 @@ eval { # cancel all watchers - $_->cancel for Event::all_watchers; + for (Event::all_watchers) { + $_->cancel if $_->data & WF_AUTOCANCEL; + } # unload all extensions for (@exts) { @@ -1126,7 +1146,9 @@ }; } -register_command "perl-reload", 0, sub { +register "", __PACKAGE__; + +register_command "perl-reload" => sub { my ($who, $arg) = @_; if ($who->flag (FLAG_WIZ)) { @@ -1137,20 +1159,19 @@ } }; -register "", __PACKAGE__; - unshift @INC, $LIBDIR; $TICK_WATCHER = Event->timer ( - prio => 1, - at => $NEXT_TICK || 1, - cb => sub { + 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, skip them all + # 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); @@ -1158,5 +1179,13 @@ }, ); +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