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

Diff Legend

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