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.38 by root, Thu Aug 24 17:29:30 2006 UTC vs.
Revision 1.45 by root, Sat Aug 26 23:36:32 2006 UTC

11use Event; 11use Event;
12$Event::Eval = 1; # no idea why this is required, but it is 12$Event::Eval = 1; # no idea why this is required, but it is
13 13
14use strict; 14use strict;
15 15
16our %COMMAND; 16our %COMMAND = ();
17our @EVENT; 17our @EVENT;
18our @PLUGIN_EVENT;
19our %PROP_TYPE; 18our %PROP_TYPE;
20our %PROP_IDX; 19our %PROP_IDX;
21our $LIBDIR = maps_directory "perl"; 20our $LIBDIR = maps_directory "perl";
22 21
23our $TICK = MAX_TIME * 1e-6; 22our $TICK = MAX_TIME * 1e-6;
24our $TICK_WATCHER; 23our $TICK_WATCHER;
25our $NEXT_TICK; 24our $NEXT_TICK;
26 25
27BEGIN { 26BEGIN {
28 @PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
29
30 *CORE::GLOBAL::warn = sub { 27 *CORE::GLOBAL::warn = sub {
31 my $msg = join "", @_; 28 my $msg = join "", @_;
32 $msg .= "\n" 29 $msg .= "\n"
33 unless $msg =~ /\n$/; 30 unless $msg =~ /\n$/;
34 31
69prop_gen PLAYER_PROP => "cf::object::player"; 66prop_gen PLAYER_PROP => "cf::object::player";
70 67
71prop_gen MAP_PROP => "cf::map"; 68prop_gen MAP_PROP => "cf::map";
72prop_gen ARCH_PROP => "cf::arch"; 69prop_gen ARCH_PROP => "cf::arch";
73 70
74# guessed hierarchies
75
76@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 71@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
77@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
78 72
79# we bless all objects into derived classes to force a method lookup 73# we bless all objects into (empty) derived classes to force a method lookup
80# within the Safe compartment. 74# within the Safe compartment.
81for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) { 75for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch)) {
82 no strict 'refs'; 76 no strict 'refs';
83 @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 77 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84} 78}
85 79
86$Event::DIED = sub { 80$Event::DIED = sub {
87 warn "error in event callback: @_"; 81 warn "error in event callback: @_";
88}; 82};
91my @exts; 85my @exts;
92my @hook; 86my @hook;
93my %command; 87my %command;
94my %extcmd; 88my %extcmd;
95 89
90#############################################################################
91# utility functions
92
93use JSON::Syck (); # TODO# replace by JSON::PC once working
94
95sub from_json($) {
96 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
97 JSON::Syck::Load $_[0]
98}
99
100sub to_json($) {
101 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
102 JSON::Syck::Dump $_[0]
103}
104
105#############################################################################
106# "new" plug-in system
107
108=item cf::object::attach ... # NYI
109
110=item cf::attach_global ...
111
112=item cf::attach_to_type $object_type, ...
113
114=item cf::attach_to_objects ...
115
116=item cf::attach_to_players ...
117
118=item cf::attach_to_maps ...
119
120=item cf:register_attachment $name, ...
121
122 prio => $number, # lower is earlier
123 on_xxx => \&cb,
124 package => package::,
125
126=cut
127
128# the following variables are defined in .xs and must not be re-created
129our @CB_GLOBAL = (); # registry for all global events
130our @CB_OBJECT = (); # all objects (should not be used except in emergency)
131our @CB_PLAYER = ();
132our @CB_TYPE = (); # registry for type (cf-object class) based events
133our @CB_MAP = ();
134
135my %attachment;
136
137sub _attach_cb($\%$$$) {
138 my ($registry, $undo, $event, $prio, $cb) = @_;
139
140 use sort 'stable';
141
142 $cb = [$prio, $cb];
143
144 @{$registry->[$event]} = sort
145 { $a->[0] cmp $b->[0] }
146 @{$registry->[$event] || []}, $cb;
147
148 push @{$undo->{cb}}, [$event, $cb];
149}
150
151# attach handles attaching event callbacks
152# the only thing the caller has to do is pass the correct
153# registry (== where the callback attaches to).
154sub _attach(\@$@) {
155 my ($registry, $klass, @arg) = @_;
156
157 my $prio = 0;
158
159 my %undo = (
160 registry => $registry,
161 cb => [],
162 );
163
164 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
165
166 while (@arg) {
167 my $type = shift @arg;
168
169 if ($type eq "prio") {
170 $prio = shift @arg;
171
172 } elsif ($type eq "package") {
173 my $pkg = shift @arg;
174
175 while (my ($name, $id) = each %cb_id) {
176 if (my $cb = $pkg->can ($name)) {
177 _attach_cb $registry, %undo, $id, $prio, $cb;
178 }
179 }
180
181 } elsif (exists $cb_id{$type}) {
182 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
183
184 } elsif (ref $type) {
185 warn "attaching objects not supported, ignoring.\n";
186
187 } else {
188 shift @arg;
189 warn "attach argument '$type' not supported, ignoring.\n";
190 }
191 }
192
193 \%undo
194}
195
196sub cf::object::attach {
197 die;
198}
199
200sub attach_global {
201 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
202}
203
204sub attach_to_type {
205 my $type = shift;
206
207 _attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_
208}
209
210sub attach_to_objects {
211 _attach @CB_OBJECT, KLASS_OBJECT, @_
212}
213
214sub attach_to_players {
215 _attach @CB_PLAYER, KLASS_PLAYER, @_
216}
217
218sub attach_to_maps {
219 _attach @CB_MAP, KLASS_MAP, @_
220}
221
222sub register_attachment {
223 my $name = shift;
224
225 $attachment{$name} = [@_];
226}
227
228our $override;
229our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
230
231sub override {
232 $override = 1;
233 @invoke_results = ();
234}
235
236sub do_invoke {
237 my $event = shift;
238 my $callbacks = shift;
239
240 @invoke_results = ();
241
242 local $override;
243
244 for (@$callbacks) {
245 eval { &{$_->[1]} };
246
247 if ($@) {
248 warn "$@";
249 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";
250 override;
251 }
252
253 return 1 if $override;
254 }
255
256 0
257}
258
259#############################################################################
260# object support
261
262sub instantiate {
263 my ($obj, $data) = @_;
264 my $registry = $obj->registry;
265
266 $data = from_json $data;
267
268 for (@$data) {
269 my ($pri, $name, @args) = @$_;
270
271 if (my $attach = $attachment{$name}) {
272 _attach @$registry, KLASS_OBJECT, @$attach;
273
274 if (my $cb = delete $registry->[EVENT_OBJECT_INSTANTIATE]) {
275 for (@$cb) {
276 eval { $_->[1]->($obj, @args); };
277 if ($@) {
278 warn "$@";
279 warn "... while processing '$name' instantiate with args <@args>\n";
280 }
281 }
282 }
283 } else {
284 warn "object uses attachment $name that is not available, postponing.\n";
285 }
286
287 push @{$obj->{_attachment}}, $name;
288 }
289}
290
291# basically do the same as instantiate, without calling instantiate
292sub reattach {
293 my ($obj) = @_;
294 my $registry = $obj->registry;
295
296 warn "reattach<@_, $_>\n";
297}
298
299attach_to_objects
300 prio => -1000000,
301 on_clone => sub {
302 my ($src, $dst) = @_;
303
304 @{$dst->registry} = @{$src->registry};
305 warn "registry clone ", join ":", @{$src->registry};#d#
306
307 %$dst = %$src;
308
309 $dst->{_attachment} = [@{ $src->{_attachment} }]
310 if exists $src->{_attachment};
311
312 warn "clone<@_>\n";#d#
313 },
314;
315
316#############################################################################
317# old plug-in events
318
96sub inject_event { 319sub inject_event {
97 my $extension = shift; 320 my $extension = shift;
98 my $event_code = shift; 321 my $event_code = shift;
99 322
100 my $cb = $hook[$event_code]{$extension} 323 my $cb = $hook[$event_code]{$extension}
142} 365}
143 366
144sub register { 367sub register {
145 my ($base, $pkg) = @_; 368 my ($base, $pkg) = @_;
146 369
147 for my $idx (0 .. $#PLUGIN_EVENT) { 370 #TODO
148 if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
149 #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
150 $hook[$idx]{$base} = $ref;
151 }
152 }
153} 371}
154 372
155sub load_extension { 373sub load_extension {
156 my ($path) = @_; 374 my ($path) = @_;
157 375
158 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 376 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
159 my $base = $1; 377 my $base = $1;
160 my $pkg = $1; 378 my $pkg = $1;
161 $pkg =~ s/[^[:word:]]/_/g; 379 $pkg =~ s/[^[:word:]]/_/g;
162 $pkg = "cf::ext::$pkg"; 380 $pkg = "ext::$pkg";
163 381
164 warn "loading '$path' into '$pkg'\n"; 382 warn "loading '$path' into '$pkg'\n";
165 383
166 open my $fh, "<:utf8", $path 384 open my $fh, "<:utf8", $path
167 or die "$path: $!"; 385 or die "$path: $!";
188 my ($pkg) = @_; 406 my ($pkg) = @_;
189 407
190 warn "removing extension $pkg\n"; 408 warn "removing extension $pkg\n";
191 409
192 # remove hooks 410 # remove hooks
411 #TODO
193 for my $idx (0 .. $#PLUGIN_EVENT) { 412# for my $idx (0 .. $#PLUGIN_EVENT) {
194 delete $hook[$idx]{$pkg}; 413# delete $hook[$idx]{$pkg};
195 } 414# }
196 415
197 # remove commands 416 # remove commands
198 for my $name (keys %command) { 417 for my $name (keys %command) {
199 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 418 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
200 419
210 # remove extcmds 429 # remove extcmds
211 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 430 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
212 delete $extcmd{$name}; 431 delete $extcmd{$name};
213 } 432 }
214 433
215 if (my $cb = $pkg->can ("on_unload")) { 434 if (my $cb = $pkg->can ("unload")) {
216 eval { 435 eval {
217 $cb->($pkg); 436 $cb->($pkg);
218 1 437 1
219 } or warn "$pkg unloaded, but with errors: $@"; 438 } or warn "$pkg unloaded, but with errors: $@";
220 } 439 }
264 } 483 }
265 484
266 Symbol::delete_package $k; 485 Symbol::delete_package $k;
267 } 486 }
268 487
269 # 4. get rid of ext::, as good as possible 488 # 4. get rid of safe::, as good as possible
270 Symbol::delete_package "ext::$_" 489 Symbol::delete_package "safe::$_"
271 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region); 490 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
272 491
273 # 5. remove register_script_function callbacks 492 # 5. remove register_script_function callbacks
274 # TODO 493 # TODO
275 494
276 # 6. unload cf.pm "a bit" 495 # 6. unload cf.pm "a bit"
277 delete $INC{"cf.pm"}; 496 delete $INC{"cf.pm"};
278 497
279 # don't, removes xs symbols, too 498 # don't, removes xs symbols, too,
499 # and global variables created in xs
280 #Symbol::delete_package __PACKAGE__; 500 #Symbol::delete_package __PACKAGE__;
281 501
282 # 7. reload cf.pm 502 # 7. reload cf.pm
283 $msg->("reloading cf.pm"); 503 $msg->("reloading cf.pm");
284 require cf; 504 require cf;
305 }; 525 };
306 } 526 }
307}; 527};
308 528
309############################################################################# 529#############################################################################
310# utility functions
311
312use JSON::Syck (); # TODO# replace by JSON::PC once working
313
314sub from_json($) {
315 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
316 JSON::Syck::Load $_[0]
317}
318
319sub to_json($) {
320 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
321 JSON::Syck::Dump $_[0]
322}
323
324#############################################################################
325# extcmd framework, basically convert ext <msg> 530# extcmd framework, basically convert ext <msg>
326# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 531# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
327 532
328sub on_extcmd { 533attach_to_players
534 on_extcmd => sub {
329 my ($pl, $buf) = @_; 535 my ($pl, $buf) = @_;
330 536
331 my $msg = eval { from_json $buf }; 537 my $msg = eval { from_json $buf };
332 538
333 if (ref $msg) { 539 if (ref $msg) {
334 if (my $cb = $extcmd{$msg->{msgtype}}) { 540 if (my $cb = $extcmd{$msg->{msgtype}}) {
335 if (my %reply = $cb->[0]->($pl, $msg)) { 541 if (my %reply = $cb->[0]->($pl, $msg)) {
336 $pl->ext_reply ($msg->{msgid}, %reply); 542 $pl->ext_reply ($msg->{msgid}, %reply);
543 }
337 } 544 }
545 } else {
546 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
338 } 547 }
339 } else { 548
340 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 549 cf::override;
341 } 550 },
342 551;
343 1
344}
345 552
346############################################################################# 553#############################################################################
347# load/save/clean perl data associated with a map 554# load/save/clean perl data associated with a map
348 555
349*on_mapclean = sub { 556*cf::mapsupport::on_clean = sub {
350 my ($map) = @_; 557 my ($map) = @_;
351 558
352 my $path = $map->tmpname; 559 my $path = $map->tmpname;
353 defined $path or return; 560 defined $path or return;
354 561
355 unlink "$path.cfperl"; 562 unlink "$path.cfperl";
356}; 563};
357 564
358*on_mapin = 565*cf::mapsupport::on_swapin =
359*on_mapload = sub { 566*cf::mapsupport::on_load = sub {
360 my ($map) = @_; 567 my ($map) = @_;
361 568
362 my $path = $map->tmpname; 569 my $path = $map->tmpname;
363 $path = $map->path unless defined $path; 570 $path = $map->path unless defined $path;
364 571
371 or return; # too new 578 or return; # too new
372 579
373 $map->_set_obs ($data->{obs}); 580 $map->_set_obs ($data->{obs});
374}; 581};
375 582
376*on_mapout = sub { 583*cf::mapsupport::on_swapout = sub {
377 my ($map) = @_; 584 my ($map) = @_;
378 585
379 my $path = $map->tmpname; 586 my $path = $map->tmpname;
380 $path = $map->path unless defined $path; 587 $path = $map->path unless defined $path;
381 588
398 } else { 605 } else {
399 unlink "$path.cfperl"; 606 unlink "$path.cfperl";
400 } 607 }
401}; 608};
402 609
610attach_to_maps prio => -10000, package => cf::mapsupport::;
611
403############################################################################# 612#############################################################################
404# load/save perl data associated with player->ob objects 613# load/save perl data associated with player->ob objects
405 614
406sub all_objects(@) { 615sub all_objects(@) {
407 @_, map all_objects ($_->inv), @_ 616 @_, map all_objects ($_->inv), @_
408} 617}
409 618
410*on_player_load = sub { 619attach_to_players
620 on_load => sub {
411 my ($ob, $path) = @_; 621 my ($pl, $path) = @_;
412 622
413 for my $o (all_objects $ob) { 623 for my $o (all_objects $pl->ob) {
414 if (my $value = $o->get_ob_key_value ("_perl_data")) { 624 if (my $value = $o->get_ob_key_value ("_perl_data")) {
415 $o->set_ob_key_value ("_perl_data"); 625 $o->set_ob_key_value ("_perl_data");
416 626
417 %$o = %{ Storable::thaw pack "H*", $value }; 627 %$o = %{ Storable::thaw pack "H*", $value };
628 }
418 } 629 }
419 } 630 },
420}; 631 on_save => sub {
421
422*on_player_save = sub {
423 my ($ob, $path) = @_; 632 my ($pl, $path) = @_;
424 633
425 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) 634 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
426 for grep %$_, all_objects $ob; 635 for grep %$_, all_objects $pl->ob;
427}; 636 },
637;
428 638
429############################################################################# 639#############################################################################
430# core extensions - in perl 640# core extensions - in perl
431 641
432=item cf::player::exists $login 642=item cf::player::exists $login
478} 688}
479 689
480############################################################################# 690#############################################################################
481# map scripting support 691# map scripting support
482 692
483our $safe = new Safe "ext"; 693our $safe = new Safe "safe";
484our $safe_hole = new Safe::Hole; 694our $safe_hole = new Safe::Hole;
485 695
486$SIG{FPE} = 'IGNORE'; 696$SIG{FPE} = 'IGNORE';
487 697
488$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 698$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
494 ["cf::object::player" => qw(player)], 704 ["cf::object::player" => qw(player)],
495 ["cf::player" => qw(peaceful)], 705 ["cf::player" => qw(peaceful)],
496) { 706) {
497 no strict 'refs'; 707 no strict 'refs';
498 my ($pkg, @funs) = @$_; 708 my ($pkg, @funs) = @$_;
499 *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 709 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
500 for @funs; 710 for @funs;
501} 711}
502 712
503sub safe_eval($;@) { 713sub safe_eval($;@) {
504 my ($code, %vars) = @_; 714 my ($code, %vars) = @_;
506 my $qcode = $code; 716 my $qcode = $code;
507 $qcode =~ s/"/‟/g; # not allowed in #line filenames 717 $qcode =~ s/"/‟/g; # not allowed in #line filenames
508 $qcode =~ s/\n/\\n/g; 718 $qcode =~ s/\n/\\n/g;
509 719
510 local $_; 720 local $_;
511 local @ext::cf::_safe_eval_args = values %vars; 721 local @safe::cf::_safe_eval_args = values %vars;
512 722
513 $code = 723 my $eval =
514 "do {\n" 724 "do {\n"
515 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 725 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
516 . "#line 0 \"{$qcode}\"\n" 726 . "#line 0 \"{$qcode}\"\n"
517 . $code 727 . $code
518 . "\n}" 728 . "\n}"
519 ; 729 ;
520 730
521 sub_generation_inc; 731 sub_generation_inc;
522 my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); 732 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
523 sub_generation_inc; 733 sub_generation_inc;
734
735 if ($@) {
736 warn "$@";
737 warn "while executing safe code '$code'\n";
738 warn "with arguments " . (join " ", %vars) . "\n";
739 }
524 740
525 wantarray ? @res : $res[0] 741 wantarray ? @res : $res[0]
526} 742}
527 743
528sub register_script_function { 744sub register_script_function {
529 my ($fun, $cb) = @_; 745 my ($fun, $cb) = @_;
530 746
531 no strict 'refs'; 747 no strict 'refs';
532 *{"ext::$fun"} = $safe_hole->wrap ($cb); 748 *{"safe::$fun"} = $safe_hole->wrap ($cb);
533} 749}
534 750
535############################################################################# 751#############################################################################
536# the server's main() 752# the server's main()
537 753
538sub run { 754sub main {
539 Event::loop; 755 Event::loop;
540} 756}
541 757
542############################################################################# 758#############################################################################
543# initialisation 759# initialisation

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines