ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
Revision: 1.27
Committed: Fri Jul 21 00:51:39 2006 UTC (17 years, 10 months ago) by root
Branch: MAIN
Changes since 1.26: +37 -3 lines
Log Message:
added pay_amount/pay_player to safe env, imprpved reload to also unload/reload .pm files

File Contents

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