ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.1 by root, Fri Feb 3 19:49:32 2006 UTC vs.
Revision 1.32 by root, Tue Aug 15 18:07:25 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines