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.23 by root, Wed Jul 19 22:19:19 2006 UTC vs.
Revision 1.44 by root, Sat Aug 26 08:44:06 2006 UTC

… …
5use Storable; 5use Storable;
6use Opcode; 6use Opcode;
7use Safe; 7use Safe;
8use Safe::Hole; 8use Safe::Hole;
9 9
10use Time::HiRes;
10use Event; 11use Event;
11$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
12 13
13use strict; 14use strict;
14 15
15our %COMMAND; 16our %COMMAND = ();
16our @EVENT; 17our @EVENT;
18our @PLUGIN_EVENT;
17our %PROP_TYPE; 19our %PROP_TYPE;
18our %PROP_IDX; 20our %PROP_IDX;
21our $LIBDIR = maps_directory "perl";
22
23our $TICK = MAX_TIME * 1e-6;
24our $TICK_WATCHER;
25our $NEXT_TICK;
19 26
20BEGIN { 27BEGIN {
21 @EVENT = map lc, @EVENT; 28 @PLUGIN_EVENT = map lc, @PLUGIN_EVENT;
22 29
23 *CORE::GLOBAL::warn = sub { 30 *CORE::GLOBAL::warn = sub {
24 my $msg = join "", @_; 31 my $msg = join "", @_;
25 $msg .= "\n" 32 $msg .= "\n"
26 unless $msg =~ /\n$/; 33 unless $msg =~ /\n$/;
… …
64prop_gen MAP_PROP => "cf::map"; 71prop_gen MAP_PROP => "cf::map";
65prop_gen ARCH_PROP => "cf::arch"; 72prop_gen ARCH_PROP => "cf::arch";
66 73
67# guessed hierarchies 74# guessed hierarchies
68 75
69@cf::object::player::ISA = 'cf::object'; 76@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
70@cf::object::map::ISA = 'cf::object'; 77@safe::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
78
79# we bless all objects into (empty) derived classes to force a method lookup
80# 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)) {
82 no strict 'refs';
83 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
84}
71 85
72$Event::DIED = sub { 86$Event::DIED = sub {
73 warn "error in event callback: @_"; 87 warn "error in event callback: @_";
74}; 88};
75 89
… …
77my @exts; 91my @exts;
78my @hook; 92my @hook;
79my %command; 93my %command;
80my %extcmd; 94my %extcmd;
81 95
96#############################################################################
97# object support
98
99sub reattach {
100 warn "reattach<@_>\n";
101}
102
103sub instantiate {
104 warn "instantiate<@_>\n";
105}
106
107sub clone {
108 warn "clone<@_>\n";
109}
110
111#############################################################################
112# "new" plug-in system
113
114=item cf::object::attach ... # NYI
115
116=item cf::attach_global ...
117
118=item cf::attach_to_type ...
119
120=item cf::attach_to_objects ...
121
122=item cf::attach_to_players ...
123
124=item cf::attach_to_maps ...
125
126 prio => $number, # lower is earlier
127 on_xxx => \&cb,
128 package => package::,
129
130=cut
131
132# the following variables are defined in .xs and must not be re-created
133our @CB_GLOBAL = (); # registry for all global events
134our @CB_OBJECT = ();
135our @CB_PLAYER = ();
136our @CB_TYPE = (); # registry for type (cf-object class) based events
137our @CB_MAP = ();
138
139sub _attach_cb($\%$$$) {
140 my ($registry, $undo, $event, $prio, $cb) = @_;
141
142 use sort 'stable';
143
144 $cb = [$prio, $cb];
145
146 @{$registry->[$event]} = sort
147 { $a->[0] cmp $b->[0] }
148 @{$registry->[$event] || []}, $cb;
149
150 push @{$undo->{cb}}, [$event, $cb];
151}
152
153# attach handles attaching event callbacks
154# the only thing the caller has to do is pass the correct
155# registry (== where the callback attaches to).
156sub _attach(\@$\@) {
157 my ($registry, $klass, $arg) = @_;
158
159 my $prio = 0;
160
161 my %undo = (
162 registry => $registry,
163 cb => [],
164 );
165
166 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
167
168 while (@$arg) {
169 my $type = shift @$arg;
170
171 if ($type eq "prio") {
172 $prio = shift @$arg;
173
174 } elsif ($type eq "package") {
175 my $pkg = shift @$arg;
176
177 while (my ($name, $id) = each %cb_id) {
178 if (my $cb = $pkg->can ($name)) {
179 _attach_cb $registry, %undo, $id, $prio, $cb;
180 }
181 }
182
183 } elsif (exists $cb_id{$type}) {
184 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg;
185
186 } elsif (ref $type) {
187 warn "attaching objects not supported, ignoring.\n";
188
189 } else {
190 shift @$arg;
191 warn "attach argument '$type' not supported, ignoring.\n";
192 }
193 }
194
195 \%undo
196}
197
198sub cf::object::attach {
199 die;
200}
201
202sub attach_global {
203 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
204}
205
206sub attach_to_type {
207 my $type = shift;
208 _attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_
209}
210
211sub attach_to_objects {
212 _attach @CB_OBJECT, KLASS_OBJECT, @_
213}
214
215sub attach_to_players {
216 _attach @CB_PLAYER, KLASS_PLAYER, @_
217}
218
219sub attach_to_maps {
220 _attach @CB_MAP, KLASS_MAP, @_
221}
222
223our $override;
224
225sub override() {
226 $override = 1
227}
228
229sub invoke {
230 my $event = shift;
231 my $callbacks = shift;
232
233 local $override;
234
235 for (@$callbacks) {
236 eval { &{$_->[1]} };
237
238 if ($@) {
239 warn "$@";
240 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";
241 override;
242 }
243
244 return 1 if $override;
245 }
246
247 0
248}
249
250#############################################################################
251# old plug-in events
252
82sub inject_event { 253sub inject_event {
83 my $extension = shift; 254 my $extension = shift;
84 my $event_code = shift; 255 my $event_code = shift;
85 256
86 my $cb = $hook[$event_code]{$extension} 257 my $cb = $hook[$event_code]{$extension}
… …
128} 299}
129 300
130sub register { 301sub register {
131 my ($base, $pkg) = @_; 302 my ($base, $pkg) = @_;
132 303
133 for my $idx (0 .. $#EVENT) { 304 for my $idx (0 .. $#PLUGIN_EVENT) {
134 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) { 305 if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) {
135 #warn "registering $EVENT[$idx] hook to '$pkg'\n"; 306 #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n";
136 $hook[$idx]{$base} = $ref; 307 $hook[$idx]{$base} = $ref;
137 } 308 }
138 } 309 }
139} 310}
140 311
… …
143 314
144 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 315 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
145 my $base = $1; 316 my $base = $1;
146 my $pkg = $1; 317 my $pkg = $1;
147 $pkg =~ s/[^[:word:]]/_/g; 318 $pkg =~ s/[^[:word:]]/_/g;
148 $pkg = "cf::ext::$pkg"; 319 $pkg = "ext::$pkg";
149 320
150 warn "loading '$path' into '$pkg'\n"; 321 warn "loading '$path' into '$pkg'\n";
151 322
152 open my $fh, "<:utf8", $path 323 open my $fh, "<:utf8", $path
153 or die "$path: $!"; 324 or die "$path: $!";
… …
173sub unload_extension { 344sub unload_extension {
174 my ($pkg) = @_; 345 my ($pkg) = @_;
175 346
176 warn "removing extension $pkg\n"; 347 warn "removing extension $pkg\n";
177 348
178 if (my $cb = $pkg->can ("on_unload")) {
179 $cb->($pkg);
180 }
181
182 # remove hooks 349 # remove hooks
183 for my $idx (0 .. $#EVENT) { 350 for my $idx (0 .. $#PLUGIN_EVENT) {
184 delete $hook[$idx]{$pkg}; 351 delete $hook[$idx]{$pkg};
185 } 352 }
186 353
187 # remove commands 354 # remove commands
188 for my $name (keys %command) { 355 for my $name (keys %command) {
… …
200 # remove extcmds 367 # remove extcmds
201 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 368 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
202 delete $extcmd{$name}; 369 delete $extcmd{$name};
203 } 370 }
204 371
372 if (my $cb = $pkg->can ("unload")) {
373 eval {
374 $cb->($pkg);
375 1
376 } or warn "$pkg unloaded, but with errors: $@";
377 }
378
205 Symbol::delete_package $pkg; 379 Symbol::delete_package $pkg;
206} 380}
207 381
208sub load_extensions { 382sub load_extensions {
209 my $LIBDIR = maps_directory "perl"; 383 my $LIBDIR = maps_directory "perl";
… …
215 1 389 1
216 } or warn "$ext not loaded: $@"; 390 } or warn "$ext not loaded: $@";
217 } 391 }
218} 392}
219 393
394sub _perl_reload(&) {
395 my ($msg) = @_;
396
397 $msg->("reloading...");
398
399 eval {
400 # 1. cancel all watchers
401 $_->cancel for Event::all_watchers;
402
403 # 2. unload all extensions
404 for (@exts) {
405 $msg->("unloading <$_>");
406 unload_extension $_;
407 }
408
409 # 3. unload all modules loaded from $LIBDIR
410 while (my ($k, $v) = each %INC) {
411 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
412
413 $msg->("removing <$k>");
414 delete $INC{$k};
415
416 $k =~ s/\.pm$//;
417 $k =~ s/\//::/g;
418
419 if (my $cb = $k->can ("unload_module")) {
420 $cb->();
421 }
422
423 Symbol::delete_package $k;
424 }
425
426 # 4. get rid of safe::, as good as possible
427 Symbol::delete_package "safe::$_"
428 for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region);
429
430 # 5. remove register_script_function callbacks
431 # TODO
432
433 # 6. unload cf.pm "a bit"
434 delete $INC{"cf.pm"};
435
436 # don't, removes xs symbols, too,
437 # and global variables created in xs
438 #Symbol::delete_package __PACKAGE__;
439
440 # 7. reload cf.pm
441 $msg->("reloading cf.pm");
442 require cf;
443 };
444 $msg->($@) if $@;
445
446 $msg->("reloaded");
447};
448
449sub perl_reload() {
450 _perl_reload {
451 warn $_[0];
452 print "$_[0]\n";
453 };
454}
455
220register_command "perl-reload", 0, sub { 456register_command "perl-reload", 0, sub {
221 my ($who, $arg) = @_; 457 my ($who, $arg) = @_;
222 458
223 if ($who->flag (FLAG_WIZ)) { 459 if ($who->flag (FLAG_WIZ)) {
224 $who->message ("reloading..."); 460 _perl_reload {
225 461 warn $_[0];
226 warn "reloading...\n"; 462 $who->message ($_[0]);
227 eval {
228 $_->cancel for Event::all_watchers;
229
230 unload_extension $_ for @exts;
231 delete $INC{"cf.pm"};
232
233 # don't, removes xs symbols, too
234 #Symbol::delete_package __PACKAGE__;
235
236 require cf;
237 }; 463 };
238 warn $@ if $@;
239 $who->message ($@) if $@;
240 warn "reloaded\n";
241
242 $who->message ("reloaded");
243 } else {
244 $who->message ("Intruder Alert!");
245 } 464 }
246}; 465};
247 466
248############################################################################# 467#############################################################################
468# utility functions
469
470use JSON::Syck (); # TODO# replace by JSON::PC once working
471
472sub from_json($) {
473 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
474 JSON::Syck::Load $_[0]
475}
476
477sub to_json($) {
478 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
479 JSON::Syck::Dump $_[0]
480}
481
482#############################################################################
249# extcmd framework, basically convert ext <id> <pkg> arg1 args 483# extcmd framework, basically convert ext <msg>
250# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 484# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
251 485
252sub on_extcmd { 486attach_to_players
487 on_extcmd => sub {
253 my ($pl, $buf) = @_; 488 my ($pl, $buf) = @_;
254 489
255 my ($type) = $buf =~ s/^(\S+) // ? $1 : ""; 490 my $msg = eval { from_json $buf };
256 491
257 $extcmd{$type}[0]->($pl, $buf) 492 if (ref $msg) {
258 if $extcmd{$type}; 493 if (my $cb = $extcmd{$msg->{msgtype}}) {
259} 494 if (my %reply = $cb->[0]->($pl, $msg)) {
495 $pl->ext_reply ($msg->{msgid}, %reply);
496 }
497 }
498 } else {
499 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
500 }
501
502 cf::override;
503 },
504;
260 505
261############################################################################# 506#############################################################################
262# load/save/clean perl data associated with a map 507# load/save/clean perl data associated with a map
263 508
264*on_mapclean = sub { 509*cf::mapsupport::on_clean = sub {
265 my ($map) = @_; 510 my ($map) = @_;
266 511
267 my $path = $map->tmpname; 512 my $path = $map->tmpname;
268 defined $path or return; 513 defined $path or return;
269 514
270 unlink "$path.cfperl"; 515 unlink "$path.cfperl";
271}; 516};
272 517
273*on_mapin = 518*cf::mapsupport::on_swapin =
274*on_mapload = sub { 519*cf::mapsupport::on_load = sub {
275 my ($map) = @_; 520 my ($map) = @_;
276 521
277 my $path = $map->tmpname; 522 my $path = $map->tmpname;
278 $path = $map->path unless defined $path; 523 $path = $map->path unless defined $path;
279 524
… …
286 or return; # too new 531 or return; # too new
287 532
288 $map->_set_obs ($data->{obs}); 533 $map->_set_obs ($data->{obs});
289}; 534};
290 535
291*on_mapout = sub { 536*cf::mapsupport::on_swapout = sub {
292 my ($map) = @_; 537 my ($map) = @_;
293 538
294 my $path = $map->tmpname; 539 my $path = $map->tmpname;
295 $path = $map->path unless defined $path; 540 $path = $map->path unless defined $path;
296 541
… …
313 } else { 558 } else {
314 unlink "$path.cfperl"; 559 unlink "$path.cfperl";
315 } 560 }
316}; 561};
317 562
563attach_to_maps prio => -10000, package => cf::mapsupport::;
564
318############################################################################# 565#############################################################################
319# load/save perl data associated with player->ob objects 566# load/save perl data associated with player->ob objects
320 567
321*on_player_load = sub { 568sub all_objects(@) {
569 @_, map all_objects ($_->inv), @_
570}
571
572attach_to_players
573 on_load => sub {
322 my ($ob, $path) = @_; 574 my ($pl, $path) = @_;
323 575
324 if (open my $fh, "<:raw", "$path.cfperl") { 576 for my $o (all_objects $pl->ob) {
325
326 #d##TODO#remove
327
328 my $data = Storable::thaw do { local $/; <$fh> };
329
330 $data->{version} <= 1
331 or return; # too new
332
333 %$ob = %{$data->{ob}};
334 return;
335 }
336
337 for my $o ($ob, $ob->inv) {
338 if (my $value = $o->get_ob_key_value ("_perl_data")) { 577 if (my $value = $o->get_ob_key_value ("_perl_data")) {
339 $o->set_ob_key_value ("_perl_data"); 578 $o->set_ob_key_value ("_perl_data");
340 579
341 %$o = %{ Storable::thaw pack "H*", $value }; 580 %$o = %{ Storable::thaw pack "H*", $value };
581 }
342 } 582 }
343 } 583 },
344}; 584 on_save => sub {
345
346*on_player_save = sub {
347 my ($ob, $path) = @_; 585 my ($pl, $path) = @_;
348 586
349 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) 587 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
350 for grep %$_, $ob, $ob->inv; 588 for grep %$_, all_objects $pl->ob;
351 589 },
352 unlink "$path.cfperl";#d##TODO#remove 590;
353};
354 591
355############################################################################# 592#############################################################################
356# core extensions - in perl 593# core extensions - in perl
357 594
358=item cf::player::exists $login 595=item cf::player::exists $login
… …
363 600
364sub cf::player::exists($) { 601sub cf::player::exists($) {
365 cf::player::find $_[0] 602 cf::player::find $_[0]
366 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 603 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
367} 604}
605
606=item $player->reply ($npc, $msg[, $flags])
607
608Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
609can be C<undef>. Does the right thing when the player is currently in a
610dialogue with the given NPC character.
611
612=cut
368 613
369# rough implementation of a future "reply" method that works 614# rough implementation of a future "reply" method that works
370# with dialog boxes. 615# with dialog boxes.
371sub cf::object::player::reply($$$;$) { 616sub cf::object::player::reply($$$;$) {
372 my ($self, $npc, $msg, $flags) = @_; 617 my ($self, $npc, $msg, $flags) = @_;
373 618
374 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 619 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
375 620
621 if ($self->{record_replies}) {
622 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
623 } else {
376 $msg = $npc->name . " says: $msg" if $npc; 624 $msg = $npc->name . " says: $msg" if $npc;
377
378 $self->message ($msg, $flags); 625 $self->message ($msg, $flags);
626 }
627}
628
629=item $player->ext_reply ($msgid, $msgtype, %msg)
630
631Sends an ext reply to the player.
632
633=cut
634
635sub cf::player::ext_reply($$$%) {
636 my ($self, $id, %msg) = @_;
637
638 $msg{msgid} = $id;
639
640 $self->send ("ext " . to_json \%msg);
379} 641}
380 642
381############################################################################# 643#############################################################################
382# map scripting support 644# map scripting support
383 645
384our $safe = new Safe "ext"; 646our $safe = new Safe "safe";
385our $safe_hole = new Safe::Hole; 647our $safe_hole = new Safe::Hole;
386 648
387$SIG{FPE} = 'IGNORE'; 649$SIG{FPE} = 'IGNORE';
388 650
389$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 651$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
390 652
391# here we would export the classes and methods available to script code 653# here we export the classes and methods available to script code
392#@ext::cf::object::player::ISA = @cf::object::player::ISA; 654
393#@ext::cf::object::map::ISA = @cf::object::map::ISA; 655for (
656 ["cf::object" => qw(contr pay_amount pay_player)],
657 ["cf::object::player" => qw(player)],
658 ["cf::player" => qw(peaceful)],
659) {
660 no strict 'refs';
661 my ($pkg, @funs) = @$_;
662 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
663 for @funs;
664}
394 665
395sub safe_eval($;@) { 666sub safe_eval($;@) {
396 my ($code, %vars) = @_; 667 my ($code, %vars) = @_;
397 668
398 my $qcode = $code; 669 my $qcode = $code;
399 $qcode =~ s/"/‟/g; # not allowed in #line filenames 670 $qcode =~ s/"/‟/g; # not allowed in #line filenames
400 $qcode =~ s/\n/\\n/g; 671 $qcode =~ s/\n/\\n/g;
401 672
402 local $_; 673 local $_;
403 local @ext::cf::_safe_eval_args = values %vars; 674 local @safe::cf::_safe_eval_args = values %vars;
404 675
405 $safe->reval ( 676 my $eval =
406 "do {\n" 677 "do {\n"
407 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 678 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
408 . "#line 0 \"{$qcode}\"\n" 679 . "#line 0 \"{$qcode}\"\n"
409 . $code 680 . $code
410 . "\n}" 681 . "\n}"
411 ) 682 ;
683
684 sub_generation_inc;
685 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
686 sub_generation_inc;
687
688 if ($@) {
689 warn "$@";
690 warn "while executing safe code '$code'\n";
691 warn "with arguments " . (join " ", %vars) . "\n";
692 }
693
694 wantarray ? @res : $res[0]
412} 695}
413 696
414sub register_script_function { 697sub register_script_function {
415 my ($fun, $cb) = @_; 698 my ($fun, $cb) = @_;
416 699
417 no strict 'refs'; 700 no strict 'refs';
418 *{"ext::$fun"} = $safe_hole->wrap ($cb); 701 *{"safe::$fun"} = $safe_hole->wrap ($cb);
702}
703
704#############################################################################
705# the server's main()
706
707sub main {
708 Event::loop;
419} 709}
420 710
421############################################################################# 711#############################################################################
422# initialisation 712# initialisation
423 713
424register "<global>", __PACKAGE__; 714register "<global>", __PACKAGE__;
425 715
426unshift @INC, maps_directory "perl"; 716unshift @INC, $LIBDIR;
427 717
428load_extensions; 718load_extensions;
429 719
720$TICK_WATCHER = Event->timer (
721 prio => 1,
722 at => $NEXT_TICK || 1,
723 cb => sub {
724 cf::server_tick; # one server iteration
725
726 my $NOW = Event::time;
727 $NEXT_TICK += $TICK;
728
729 # if we are delayed by four ticks, skip them all
730 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
731
732 $TICK_WATCHER->at ($NEXT_TICK);
733 $TICK_WATCHER->start;
734 },
735);
736
4301 7371
431 738

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines