server/lib/cf.pm

package cf;

use Symbol;
use List::Util;
use Storable;
use Opcode;
use Safe;
use Safe::Hole;

use Event;
$Event::Eval = 1; # no idea why this is required, but it is

use strict;

our %COMMAND;
our @EVENT;
our %PROP_TYPE;
our %PROP_IDX;

BEGIN {
   @EVENT = map lc, @EVENT;

   *CORE::GLOBAL::warn = sub {
      my $msg = join "", @_;
      $msg .= "\n"
         unless $msg =~ /\n$/;

      print STDERR "cfperl: $msg";
      LOG llevError, "cfperl: $msg";
   };
}

my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!

# generate property mutators
sub prop_gen {
   my ($prefix, $class) = @_;

   no strict 'refs';

   for my $prop (keys %PROP_TYPE) {
      $prop =~ /^\Q$prefix\E_(.*$)/ or next;
      my $sub = lc $1;

      my $type = $PROP_TYPE{$prop};
      my $idx  = $PROP_IDX {$prop};

      *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
         $_[0]->get_property ($type, $idx)
      };

      *{"$class\::set_$sub"} = sub {
         $_[0]->set_property ($type, $idx, $_[1]);
      } unless $ignore_set{$prop};
   }
}

# auto-generate most of the API

prop_gen OBJECT_PROP => "cf::object";
# CFAPI_OBJECT_ANIMATION?
prop_gen PLAYER_PROP => "cf::object::player";

prop_gen MAP_PROP    => "cf::map";
prop_gen ARCH_PROP   => "cf::arch";

# guessed hierarchies

@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
@ext::cf::object::map::ISA    = @cf::object::map::ISA    = 'cf::object';

# we bless all objects into derived classes to force a method lookup
# within the Safe compartment.
for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region)) {
   no strict 'refs';
   @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
}

$Event::DIED = sub {
   warn "error in event callback: @_";
};

my %ext_pkg;
my @exts;
my @hook;
my %command;
my %extcmd;

sub inject_event {
   my $extension = shift;
   my $event_code = shift;

   my $cb = $hook[$event_code]{$extension}
      or return;

   &$cb
}

sub inject_global_event {
   my $event = shift;

   my $cb = $hook[$event]
      or return;

   List::Util::max map &$_, values %$cb
}

sub inject_command {
   my ($name, $obj, $params) = @_;

   for my $cmd (@{ $command{$name} }) {
      $cmd->[1]->($obj, $params);
   }

   -1
}

sub register_command {
   my ($name, $time, $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} };
}

sub register_extcmd {
   my ($name, $cb) = @_;

   my $caller = caller;
   #warn "registering extcmd '$name' to '$caller'";

   $extcmd{$name} = [$cb, $caller];
}

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;
      }
   }
}

sub load_extension {
   my ($path) = @_;

   $path =~ /([^\/\\]+)\.ext$/ or die "$path";
   my $base = $1;
   my $pkg = $1;
   $pkg =~ s/[^[:word:]]/_/g;
   $pkg = "cf::ext::$pkg";

   warn "loading '$path' into '$pkg'\n";

   open my $fh, "<:utf8", $path
      or die "$path: $!";

   my $source =
      "package $pkg; use strict; use utf8;\n"
      . "#line 1 \"$path\"\n{\n"
      . (do { local $/; <$fh> })
      . "\n};\n1";

   eval $source
      or die "$path: $@";

   push @exts, $pkg;
   $ext_pkg{$base} = $pkg;

#   no strict 'refs';
#   @{"$pkg\::ISA"} = ext::;

   register $base, $pkg;
}

sub unload_extension {
   my ($pkg) = @_;

   warn "removing extension $pkg\n";

   if (my $cb = $pkg->can ("on_unload")) {
      $cb->($pkg);
   }

   # remove hooks
   for my $idx (0 .. $#EVENT) {
      delete $hook[$idx]{$pkg};
   }

   # remove commands
   for my $name (keys %command) {
      my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };

      if (@cb) {
         $command{$name} = \@cb;
         $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
      } else {
         delete $command{$name};
         delete $COMMAND{"$name\000"};
      }
   }

   # remove extcmds
   for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
      delete $extcmd{$name};
   }

   Symbol::delete_package $pkg;
}

sub load_extensions {
   my $LIBDIR = maps_directory "perl";

   for my $ext (<$LIBDIR/*.ext>) {
      next unless -r $ext;
      eval {
         load_extension $ext;
         1
      } or warn "$ext not loaded: $@";
   }
}

register_command "perl-reload", 0, sub {
   my ($who, $arg) = @_;

   if ($who->flag (FLAG_WIZ)) {
      $who->message ("reloading...");

      warn "reloading...\n";
      eval {
         $_->cancel for Event::all_watchers;

         unload_extension $_ for @exts;
         delete $INC{"cf.pm"};

         # don't, removes xs symbols, too
         #Symbol::delete_package __PACKAGE__;

         require cf;
      };
      warn $@ if $@;
      $who->message ($@) if $@;
      warn "reloaded\n";

      $who->message ("reloaded");
   } else {
      $who->message ("Intruder Alert!");
   }
};

#############################################################################
# extcmd framework, basically convert ext <id> <pkg> arg1 args
# into pkg::->on_extcmd_arg1 (...) while shortcutting a few

sub on_extcmd {
   my ($pl, $buf) = @_;

   my ($type) = $buf =~ s/^(\S+) // ? $1 : "";

   $extcmd{$type}[0]->($pl, $buf)
      if $extcmd{$type};
}

#############################################################################
# load/save/clean perl data associated with a map

*on_mapclean = sub {
   my ($map) = @_;

   my $path = $map->tmpname;
   defined $path or return;

   unlink "$path.cfperl";
};

*on_mapin =
*on_mapload = sub {
   my ($map) = @_;

   my $path = $map->tmpname;
   $path = $map->path unless defined $path;

   open my $fh, "<:raw", "$path.cfperl"
      or return; # no perl data

   my $data = Storable::thaw do { local $/; <$fh> };

   $data->{version} <= 1
      or return; # too new

   $map->_set_obs ($data->{obs});
};

*on_mapout = sub {
   my ($map) = @_;

   my $path = $map->tmpname;
   $path = $map->path unless defined $path;

   my $obs = $map->_get_obs;

   if (defined $obs) {
      open my $fh, ">:raw", "$path.cfperl"
         or die "$path.cfperl: $!";

      stat $path;

      print $fh Storable::nfreeze {
         size    => (stat _)[7],
         time    => (stat _)[9],
         version => 1,
         obs     => $obs,
      };

      chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
   } else {
      unlink "$path.cfperl";
   }
};

#############################################################################
# load/save perl data associated with player->ob objects

*on_player_load = sub {
   my ($ob, $path) = @_;

   if (open my $fh, "<:raw", "$path.cfperl") {

      #d##TODO#remove

      my $data = Storable::thaw do { local $/; <$fh> };

      $data->{version} <= 1
         or return; # too new

      %$ob = %{$data->{ob}};
      return;
   }

   for my $o ($ob, $ob->inv) {
      if (my $value = $o->get_ob_key_value ("_perl_data")) {
         $o->set_ob_key_value ("_perl_data");

         %$o = %{ Storable::thaw pack "H*", $value };
      }
   }
};

*on_player_save = sub {
   my ($ob, $path) = @_;

   $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
      for grep %$_, $ob, $ob->inv;

   unlink "$path.cfperl";#d##TODO#remove
};

#############################################################################
# core extensions - in perl

=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;
}

# rough implementation of a future "reply" method that works
# with dialog boxes.
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 {
      $msg = $npc->name . " says: $msg" if $npc;
      $self->message ($msg, $flags);
   }
}

#############################################################################
# map scripting support

our $safe = new Safe "ext";
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

for (
   ["cf::object"         => qw(contr)],
   ["cf::object::player" => qw(player)],
   ["cf::player"         => qw(peaceful)],
) {
   no strict 'refs';
   my ($pkg, @funs) = @$_;
   *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
      for @funs;
}

sub safe_eval($;@) {
   my ($code, %vars) = @_;

   my $qcode = $code;
   $qcode =~ s/"/‟/g; # not allowed in #line filenames
   $qcode =~ s/\n/\\n/g;

   local $_;
   local @ext::cf::_safe_eval_args = values %vars;

   $code =
      "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 ($code) : scalar $safe->reval ($code);
   sub_generation_inc;

   wantarray ? @res : $res[0]
}

sub register_script_function {
   my ($fun, $cb) = @_;

   no strict 'refs';
   *{"ext::$fun"} = $safe_hole->wrap ($cb);
}

#############################################################################
# initialisation

register "<global>", __PACKAGE__;

unshift @INC, maps_directory "perl";

load_extensions;

1

Revision:	1.25
Committed:	Thu Jul 20 07:22:40 2006 UTC (17 years, 11 months ago) by root
Branch:	MAIN
Changes since 1.24:	+29 -7 lines
Log Message:	- move cf::object::player::contr to cf::object::contr - implement wrapper classes for Safe compartment - export a few known-to-be-safe methods to Safe compartment
#	Content
1	package cf;
2
3	use Symbol;
4	use List::Util;
5	use Storable;
6	use Opcode;
7	use Safe;
8	use Safe::Hole;
9
10	use Event;
11	$Event::Eval = 1; # no idea why this is required, but it is
12
13	use strict;
14
15	our %COMMAND;
16	our @EVENT;
17	our %PROP_TYPE;
18	our %PROP_IDX;
19
20	BEGIN {
21	@EVENT = map lc, @EVENT;
22
23	*CORE::GLOBAL::warn = sub {
24	my $msg = join "", @_;
25	$msg .= "\n"
26	unless $msg =~ /\n$/;
27
28	print STDERR "cfperl: $msg";
29	LOG llevError, "cfperl: $msg";
30	};
31	}
32
33	my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
34
35	# generate property mutators
36	sub prop_gen {
37	my ($prefix, $class) = @_;
38
39	no strict 'refs';
40
41	for my $prop (keys %PROP_TYPE) {
42	$prop =~ /^\Q$prefix\E_(.*$)/ or next;
43	my $sub = lc $1;
44
45	my $type = $PROP_TYPE{$prop};
46	my $idx = $PROP_IDX {$prop};
47
48	{"$class\::get_$sub"} = {"$class\::$sub"} = sub {
49	$_[0]->get_property ($type, $idx)
50	};
51
52	*{"$class\::set_$sub"} = sub {
53	$_[0]->set_property ($type, $idx, $_[1]);
54	} unless $ignore_set{$prop};
55	}
56	}
57
58	# auto-generate most of the API
59
60	prop_gen OBJECT_PROP => "cf::object";
61	# CFAPI_OBJECT_ANIMATION?
62	prop_gen PLAYER_PROP => "cf::object::player";
63
64	prop_gen MAP_PROP => "cf::map";
65	prop_gen ARCH_PROP => "cf::arch";
66
67	# guessed hierarchies
68
69	@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
70	@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
71
72	# we bless all objects into derived classes to force a method lookup
73	# within the Safe compartment.
74	for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region)) {
75	no strict 'refs';
76	@{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
77	}
78
79	$Event::DIED = sub {
80	warn "error in event callback: @_";
81	};
82
83	my %ext_pkg;
84	my @exts;
85	my @hook;
86	my %command;
87	my %extcmd;
88
89	sub inject_event {
90	my $extension = shift;
91	my $event_code = shift;
92
93	my $cb = $hook[$event_code]{$extension}
94	or return;
95
96	&$cb
97	}
98
99	sub inject_global_event {
100	my $event = shift;
101
102	my $cb = $hook[$event]
103	or return;
104
105	List::Util::max map &$_, values %$cb
106	}
107
108	sub inject_command {
109	my ($name, $obj, $params) = @_;
110
111	for my $cmd (@{ $command{$name} }) {
112	$cmd->[1]->($obj, $params);
113	}
114
115	-1
116	}
117
118	sub register_command {
119	my ($name, $time, $cb) = @_;
120
121	my $caller = caller;
122	#warn "registering command '$name/$time' to '$caller'";
123
124	push @{ $command{$name} }, [$time, $cb, $caller];
125	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
126	}
127
128	sub register_extcmd {
129	my ($name, $cb) = @_;
130
131	my $caller = caller;
132	#warn "registering extcmd '$name' to '$caller'";
133
134	$extcmd{$name} = [$cb, $caller];
135	}
136
137	sub register {
138	my ($base, $pkg) = @_;
139
140	for my $idx (0 .. $#EVENT) {
141	if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
142	#warn "registering $EVENT[$idx] hook to '$pkg'\n";
143	$hook[$idx]{$base} = $ref;
144	}
145	}
146	}
147
148	sub load_extension {
149	my ($path) = @_;
150
151	$path =~ /([^\/\\]+)\.ext$/ or die "$path";
152	my $base = $1;
153	my $pkg = $1;
154	$pkg =~ s/[^[:word:]]/_/g;
155	$pkg = "cf::ext::$pkg";
156
157	warn "loading '$path' into '$pkg'\n";
158
159	open my $fh, "<:utf8", $path
160	or die "$path: $!";
161
162	my $source =
163	"package $pkg; use strict; use utf8;\n"
164	. "#line 1 \"$path\"\n{\n"
165	. (do { local $/; <$fh> })
166	. "\n};\n1";
167
168	eval $source
169	or die "$path: $@";
170
171	push @exts, $pkg;
172	$ext_pkg{$base} = $pkg;
173
174	# no strict 'refs';
175	# @{"$pkg\::ISA"} = ext::;
176
177	register $base, $pkg;
178	}
179
180	sub unload_extension {
181	my ($pkg) = @_;
182
183	warn "removing extension $pkg\n";
184
185	if (my $cb = $pkg->can ("on_unload")) {
186	$cb->($pkg);
187	}
188
189	# remove hooks
190	for my $idx (0 .. $#EVENT) {
191	delete $hook[$idx]{$pkg};
192	}
193
194	# remove commands
195	for my $name (keys %command) {
196	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
197
198	if (@cb) {
199	$command{$name} = \@cb;
200	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
201	} else {
202	delete $command{$name};
203	delete $COMMAND{"$name\000"};
204	}
205	}
206
207	# remove extcmds
208	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
209	delete $extcmd{$name};
210	}
211
212	Symbol::delete_package $pkg;
213	}
214
215	sub load_extensions {
216	my $LIBDIR = maps_directory "perl";
217
218	for my $ext (<$LIBDIR/*.ext>) {
219	next unless -r $ext;
220	eval {
221	load_extension $ext;
222	1
223	} or warn "$ext not loaded: $@";
224	}
225	}
226
227	register_command "perl-reload", 0, sub {
228	my ($who, $arg) = @_;
229
230	if ($who->flag (FLAG_WIZ)) {
231	$who->message ("reloading...");
232
233	warn "reloading...\n";
234	eval {
235	$_->cancel for Event::all_watchers;
236
237	unload_extension $_ for @exts;
238	delete $INC{"cf.pm"};
239
240	# don't, removes xs symbols, too
241	#Symbol::delete_package __PACKAGE__;
242
243	require cf;
244	};
245	warn $@ if $@;
246	$who->message ($@) if $@;
247	warn "reloaded\n";
248
249	$who->message ("reloaded");
250	} else {
251	$who->message ("Intruder Alert!");
252	}
253	};
254
255	#############################################################################
256	# extcmd framework, basically convert ext <id> <pkg> arg1 args
257	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
258
259	sub on_extcmd {
260	my ($pl, $buf) = @_;
261
262	my ($type) = $buf =~ s/^(\S+) // ? $1 : "";
263
264	$extcmd{$type}[0]->($pl, $buf)
265	if $extcmd{$type};
266	}
267
268	#############################################################################
269	# load/save/clean perl data associated with a map
270
271	*on_mapclean = sub {
272	my ($map) = @_;
273
274	my $path = $map->tmpname;
275	defined $path or return;
276
277	unlink "$path.cfperl";
278	};
279
280	*on_mapin =
281	*on_mapload = sub {
282	my ($map) = @_;
283
284	my $path = $map->tmpname;
285	$path = $map->path unless defined $path;
286
287	open my $fh, "<:raw", "$path.cfperl"
288	or return; # no perl data
289
290	my $data = Storable::thaw do { local $/; <$fh> };
291
292	$data->{version} <= 1
293	or return; # too new
294
295	$map->_set_obs ($data->{obs});
296	};
297
298	*on_mapout = sub {
299	my ($map) = @_;
300
301	my $path = $map->tmpname;
302	$path = $map->path unless defined $path;
303
304	my $obs = $map->_get_obs;
305
306	if (defined $obs) {
307	open my $fh, ">:raw", "$path.cfperl"
308	or die "$path.cfperl: $!";
309
310	stat $path;
311
312	print $fh Storable::nfreeze {
313	size => (stat _)[7],
314	time => (stat _)[9],
315	version => 1,
316	obs => $obs,
317	};
318
319	chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible g
320	} else {
321	unlink "$path.cfperl";
322	}
323	};
324
325	#############################################################################
326	# load/save perl data associated with player->ob objects
327
328	*on_player_load = sub {
329	my ($ob, $path) = @_;
330
331	if (open my $fh, "<:raw", "$path.cfperl") {
332
333	#d##TODO#remove
334
335	my $data = Storable::thaw do { local $/; <$fh> };
336
337	$data->{version} <= 1
338	or return; # too new
339
340	%$ob = %{$data->{ob}};
341	return;
342	}
343
344	for my $o ($ob, $ob->inv) {
345	if (my $value = $o->get_ob_key_value ("_perl_data")) {
346	$o->set_ob_key_value ("_perl_data");
347
348	%$o = %{ Storable::thaw pack "H*", $value };
349	}
350	}
351	};
352
353	*on_player_save = sub {
354	my ($ob, $path) = @_;
355
356	$_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
357	for grep %$_, $ob, $ob->inv;
358
359	unlink "$path.cfperl";#d##TODO#remove
360	};
361
362	#############################################################################
363	# core extensions - in perl
364
365	=item cf::player::exists $login
366
367	Returns true when the given account exists.
368
369	=cut
370
371	sub cf::player::exists($) {
372	cf::player::find $_[0]
373	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
374	}
375
376	# rough implementation of a future "reply" method that works
377	# with dialog boxes.
378	sub cf::object::player::reply($$$;$) {
379	my ($self, $npc, $msg, $flags) = @_;
380
381	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
382
383	if ($self->{record_replies}) {
384	push @{ $self->{record_replies} }, [$npc, $msg, $flags];
385	} else {
386	$msg = $npc->name . " says: $msg" if $npc;
387	$self->message ($msg, $flags);
388	}
389	}
390
391	#############################################################################
392	# map scripting support
393
394	our $safe = new Safe "ext";
395	our $safe_hole = new Safe::Hole;
396
397	$SIG{FPE} = 'IGNORE';
398
399	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
400
401	# here we export the classes and methods available to script code
402
403	for (
404	["cf::object" => qw(contr)],
405	["cf::object::player" => qw(player)],
406	["cf::player" => qw(peaceful)],
407	) {
408	no strict 'refs';
409	my ($pkg, @funs) = @$_;
410	*{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
411	for @funs;
412	}
413
414	sub safe_eval($;@) {
415	my ($code, %vars) = @_;
416
417	my $qcode = $code;
418	$qcode =~ s/"/‟/g; # not allowed in #line filenames
419	$qcode =~ s/\n/\\n/g;
420
421	local $_;
422	local @ext::cf::_safe_eval_args = values %vars;
423
424	$code =
425	"do {\n"
426	. "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
427	. "#line 0 \"{$qcode}\"\n"
428	. $code
429	. "\n}"
430	;
431
432	sub_generation_inc;
433	my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code);
434	sub_generation_inc;
435
436	wantarray ? @res : $res[0]
437	}
438
439	sub register_script_function {
440	my ($fun, $cb) = @_;
441
442	no strict 'refs';
443	*{"ext::$fun"} = $safe_hole->wrap ($cb);
444	}
445
446	#############################################################################
447	# initialisation
448
449	register "<global>", __PACKAGE__;
450
451	unshift @INC, maps_directory "perl";
452
453	load_extensions;
454
455	1
456