ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
Revision: 1.54
Committed: Tue Aug 29 14:49:28 2006 UTC (17 years, 8 months ago) by root
Branch: MAIN
Changes since 1.53: +11 -24 lines
Log Message:
implement detach

File Contents

# Content
1 package cf;
2
3 use Symbol;
4 use List::Util;
5 use Storable;
6 use Opcode;
7 use Safe;
8 use Safe::Hole;
9
10 use Time::HiRes;
11 use Event;
12 $Event::Eval = 1; # no idea why this is required, but it is
13
14 use strict;
15
16 _reload_1;
17
18 our %COMMAND = ();
19 our @EVENT;
20 our %PROP_TYPE;
21 our %PROP_IDX;
22 our $LIBDIR = maps_directory "perl";
23
24 our $TICK = MAX_TIME * 1e-6;
25 our $TICK_WATCHER;
26 our $NEXT_TICK;
27
28 BEGIN {
29 *CORE::GLOBAL::warn = sub {
30 my $msg = join "", @_;
31 $msg .= "\n"
32 unless $msg =~ /\n$/;
33
34 print STDERR "cfperl: $msg";
35 LOG llevError, "cfperl: $msg";
36 };
37 }
38
39 my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
40
41 # generate property mutators
42 sub prop_gen {
43 my ($prefix, $class) = @_;
44
45 no strict 'refs';
46
47 for my $prop (keys %PROP_TYPE) {
48 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
49 my $sub = lc $1;
50
51 my $type = $PROP_TYPE{$prop};
52 my $idx = $PROP_IDX {$prop};
53
54 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
55 $_[0]->get_property ($type, $idx)
56 };
57
58 *{"$class\::set_$sub"} = sub {
59 $_[0]->set_property ($type, $idx, $_[1]);
60 } unless $ignore_set{$prop};
61 }
62 }
63
64 # auto-generate most of the API
65
66 prop_gen OBJECT_PROP => "cf::object";
67 # CFAPI_OBJECT_ANIMATION?
68 prop_gen PLAYER_PROP => "cf::object::player";
69
70 prop_gen MAP_PROP => "cf::map";
71 prop_gen ARCH_PROP => "cf::arch";
72
73 @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74
75 # we bless all objects into (empty) derived classes to force a method lookup
76 # within the Safe compartment.
77 for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
78 no strict 'refs';
79 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80 }
81
82 $Event::DIED = sub {
83 warn "error in event callback: @_";
84 };
85
86 my %ext_pkg;
87 my @exts;
88 my @hook;
89 my %command;
90 my %extcmd;
91
92 #############################################################################
93 # utility functions
94
95 use JSON::Syck (); # TODO# replace by JSON::PC once working
96
97 sub from_json($) {
98 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99 JSON::Syck::Load $_[0]
100 }
101
102 sub to_json($) {
103 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104 JSON::Syck::Dump $_[0]
105 }
106
107 #############################################################################
108 # "new" plug-in system
109
110 =item $object->attach ($attachment, key => $value...)
111
112 =item $object->detach ($attachment)
113
114 Attach/detach a pre-registered attachment to an object.
115
116 =item $player->attach ($attachment, key => $value...)
117
118 =item $player->detach ($attachment)
119
120 Attach/detach a pre-registered attachment to a player.
121
122 =item $map->attach ($attachment, key => $value...)
123
124 =item $map->detach ($attachment)
125
126 Attach/detach a pre-registered attachment to a map.
127
128 =item cf::attach_global ...
129
130 Attach handlers for global events.
131
132 This and all following C<attach_*>-functions expect any number of the
133 following handler/hook descriptions:
134
135 =over 4
136
137 =item prio => $number
138
139 Set the priority for all following handlers/hooks (unless overwritten
140 by another C<prio> setting). Lower priority handlers get executed
141 earlier. The default priority is C<0>, and many built-in handlers are
142 registered at priority C<-1000>, so lower priorities should not be used
143 unless you know what you are doing.
144
145 =item on_I<event> => \&cb
146
147 Call the given code reference whenever the named event happens (event is
148 something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
149 handlers are recognised generally depends on the type of object these
150 handlers attach to).
151
152 See F<include/eventinc.h> for the full list of events supported, and their
153 class.
154
155 =item package => package::
156
157 Look for sub functions of the name C<< on_I<event> >> in the given
158 package and register them. Only handlers for eevents supported by the
159 object/class are recognised.
160
161 =back
162
163 =item cf::attach_to_type $object_type, $subtype, ...
164
165 Attach handlers for a specific object type (e.g. TRANSPORT) and
166 subtype. If C<$subtype> is zero or undef, matches all objects of the given
167 type.
168
169 =item cf::attach_to_objects ...
170
171 Attach handlers to all objects. Do not use this except for debugging or
172 very rare events, as handlers are (obviously) called for I<all> objects in
173 the game.
174
175 =item cf::attach_to_players ...
176
177 Attach handlers to all players.
178
179 =item cf::attach_to_maps ...
180
181 Attach handlers to all maps.
182
183 =item cf:register_attachment $name, ...
184
185 Register an attachment by name through which objects can refer to this
186 attachment.
187
188 =item cf:register_map_attachment $name, ...
189
190 Register an attachment by name through which maps can refer to this
191 attachment.
192
193 =cut
194
195 # the following variables are defined in .xs and must not be re-created
196 our @CB_GLOBAL = (); # registry for all global events
197 our @CB_OBJECT = (); # all objects (should not be used except in emergency)
198 our @CB_PLAYER = ();
199 our @CB_TYPE = (); # registry for type (cf-object class) based events
200 our @CB_MAP = ();
201
202 my %attachment;
203
204 sub _attach_cb($\%$$$) {
205 my ($registry, $undo, $event, $prio, $cb) = @_;
206
207 use sort 'stable';
208
209 $cb = [$prio, $cb];
210
211 @{$registry->[$event]} = sort
212 { $a->[0] cmp $b->[0] }
213 @{$registry->[$event] || []}, $cb;
214
215 push @{$undo->{cb}}, [$event, $cb];
216 }
217
218 # attach handles attaching event callbacks
219 # the only thing the caller has to do is pass the correct
220 # registry (== where the callback attaches to).
221 sub _attach(\@$@) {
222 my ($registry, $klass, @arg) = @_;
223
224 my $prio = 0;
225
226 my %undo = (
227 registry => $registry,
228 cb => [],
229 );
230
231 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
232
233 while (@arg) {
234 my $type = shift @arg;
235
236 if ($type eq "prio") {
237 $prio = shift @arg;
238
239 } elsif ($type eq "package") {
240 my $pkg = shift @arg;
241
242 while (my ($name, $id) = each %cb_id) {
243 if (my $cb = $pkg->can ($name)) {
244 _attach_cb $registry, %undo, $id, $prio, $cb;
245 }
246 }
247
248 } elsif (exists $cb_id{$type}) {
249 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
250
251 } elsif (ref $type) {
252 warn "attaching objects not supported, ignoring.\n";
253
254 } else {
255 shift @arg;
256 warn "attach argument '$type' not supported, ignoring.\n";
257 }
258 }
259
260 \%undo
261 }
262
263 sub _attach_attachment {
264 my ($obj, $name, %arg) = @_;
265
266 my $res;
267
268 if (my $attach = $attachment{$name}) {
269 my $registry = $obj->registry;
270
271 for (@$attach) {
272 my ($klass, @attach) = @$_;
273 $res = _attach @$registry, $klass, @attach;
274 }
275
276 $obj->{$name} = \%arg;
277 } else {
278 warn "object uses attachment '$name' that is not available, postponing.\n";
279 }
280
281 $obj->{_attachment}{$name} = undef;
282
283 $res->{attachment} = $name;
284 $res
285 }
286
287 *cf::object::attach =
288 *cf::player::attach =
289 *cf::map::attach = sub {
290 my ($obj, $name, %arg) = @_;
291
292 _attach_attachment $obj, $name, %arg;
293 }
294
295 # all those should be optimised
296 *cf::object::detach =
297 *cf::player::detach =
298 *cf::map::detach = sub {
299 my ($obj, $name) = @_;
300
301 delete $obj->{_attachment}{$name};
302 reattach $obj;
303 };
304
305 sub attach_global {
306 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
307 }
308
309 sub attach_to_type {
310 my $type = shift;
311 my $subtype = shift;
312
313 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
314 }
315
316 sub attach_to_objects {
317 _attach @CB_OBJECT, KLASS_OBJECT, @_
318 }
319
320 sub attach_to_players {
321 _attach @CB_PLAYER, KLASS_PLAYER, @_
322 }
323
324 sub attach_to_maps {
325 _attach @CB_MAP, KLASS_MAP, @_
326 }
327
328 sub register_attachment {
329 my $name = shift;
330
331 $attachment{$name} = [[KLASS_OBJECT, @_]];
332 }
333
334 sub register_map_attachment {
335 my $name = shift;
336
337 $attachment{$name} = [[KLASS_MAP, @_]];
338 }
339
340 our $override;
341 our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
342
343 sub override {
344 $override = 1;
345 @invoke_results = ();
346 }
347
348 sub do_invoke {
349 my $event = shift;
350 my $callbacks = shift;
351
352 @invoke_results = ();
353
354 local $override;
355
356 for (@$callbacks) {
357 eval { &{$_->[1]} };
358
359 if ($@) {
360 warn "$@";
361 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";
362 override;
363 }
364
365 return 1 if $override;
366 }
367
368 0
369 }
370
371 #############################################################################
372 # object support
373
374 sub instantiate {
375 my ($obj, $data) = @_;
376
377 $data = from_json $data;
378
379 for (@$data) {
380 my ($name, $args) = @$_;
381
382 $obj->attach ($name, %{$args || {} });
383 }
384 }
385
386 # basically do the same as instantiate, without calling instantiate
387 sub reattach {
388 my ($obj) = @_;
389 my $registry = $obj->registry;
390
391 @$registry = ();
392
393 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
394
395 for my $name (keys %{ $obj->{_attachment} || {} }) {
396 if (my $attach = $attachment{$name}) {
397 for (@$attach) {
398 my ($klass, @attach) = @$_;
399 _attach @$registry, $klass, @attach;
400 }
401 } else {
402 warn "object uses attachment '$name' that is not available, postponing.\n";
403 }
404 }
405 }
406
407 sub object_freezer_save {
408 my ($filename, $objs) = @_;
409
410 if (@$objs) {
411 open my $fh, ">:raw", "$filename.pst~";
412 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
413 close $fh;
414 chmod SAVE_MODE, "$filename.pst~";
415 rename "$filename.pst~", "$filename.pst";
416 } else {
417 unlink "$filename.pst";
418 }
419
420 chmod SAVE_MODE, "$filename~";
421 rename "$filename~", $filename;
422 }
423
424 sub object_thawer_load {
425 my ($filename) = @_;
426
427 open my $fh, "<:raw:perlio", "$filename.pst"
428 or return;
429
430 eval { local $/; (Storable::thaw <$fh>)->{objs} }
431 }
432
433 attach_to_objects
434 prio => -1000000,
435 on_clone => sub {
436 my ($src, $dst) = @_;
437
438 @{$dst->registry} = @{$src->registry};
439
440 %$dst = %$src;
441
442 %{$dst->{_attachment}} = %{$src->{_attachment}}
443 if exists $src->{_attachment};
444 },
445 ;
446
447 #############################################################################
448 # old plug-in events
449
450 sub inject_event {
451 my $extension = shift;
452 my $event_code = shift;
453
454 my $cb = $hook[$event_code]{$extension}
455 or return;
456
457 &$cb
458 }
459
460 sub inject_global_event {
461 my $event = shift;
462
463 my $cb = $hook[$event]
464 or return;
465
466 List::Util::max map &$_, values %$cb
467 }
468
469 sub inject_command {
470 my ($name, $obj, $params) = @_;
471
472 for my $cmd (@{ $command{$name} }) {
473 $cmd->[1]->($obj, $params);
474 }
475
476 -1
477 }
478
479 sub register_command {
480 my ($name, $time, $cb) = @_;
481
482 my $caller = caller;
483 #warn "registering command '$name/$time' to '$caller'";
484
485 push @{ $command{$name} }, [$time, $cb, $caller];
486 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
487 }
488
489 sub register_extcmd {
490 my ($name, $cb) = @_;
491
492 my $caller = caller;
493 #warn "registering extcmd '$name' to '$caller'";
494
495 $extcmd{$name} = [$cb, $caller];
496 }
497
498 sub register {
499 my ($base, $pkg) = @_;
500
501 #TODO
502 }
503
504 sub load_extension {
505 my ($path) = @_;
506
507 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
508 my $base = $1;
509 my $pkg = $1;
510 $pkg =~ s/[^[:word:]]/_/g;
511 $pkg = "ext::$pkg";
512
513 warn "loading '$path' into '$pkg'\n";
514
515 open my $fh, "<:utf8", $path
516 or die "$path: $!";
517
518 my $source =
519 "package $pkg; use strict; use utf8;\n"
520 . "#line 1 \"$path\"\n{\n"
521 . (do { local $/; <$fh> })
522 . "\n};\n1";
523
524 eval $source
525 or die "$path: $@";
526
527 push @exts, $pkg;
528 $ext_pkg{$base} = $pkg;
529
530 # no strict 'refs';
531 # @{"$pkg\::ISA"} = ext::;
532
533 register $base, $pkg;
534 }
535
536 sub unload_extension {
537 my ($pkg) = @_;
538
539 warn "removing extension $pkg\n";
540
541 # remove hooks
542 #TODO
543 # for my $idx (0 .. $#PLUGIN_EVENT) {
544 # delete $hook[$idx]{$pkg};
545 # }
546
547 # remove commands
548 for my $name (keys %command) {
549 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
550
551 if (@cb) {
552 $command{$name} = \@cb;
553 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
554 } else {
555 delete $command{$name};
556 delete $COMMAND{"$name\000"};
557 }
558 }
559
560 # remove extcmds
561 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
562 delete $extcmd{$name};
563 }
564
565 if (my $cb = $pkg->can ("unload")) {
566 eval {
567 $cb->($pkg);
568 1
569 } or warn "$pkg unloaded, but with errors: $@";
570 }
571
572 Symbol::delete_package $pkg;
573 }
574
575 sub load_extensions {
576 my $LIBDIR = maps_directory "perl";
577
578 for my $ext (<$LIBDIR/*.ext>) {
579 next unless -r $ext;
580 eval {
581 load_extension $ext;
582 1
583 } or warn "$ext not loaded: $@";
584 }
585 }
586
587 sub _perl_reload(&) {
588 my ($msg) = @_;
589
590 $msg->("reloading...");
591
592 eval {
593 # 1. cancel all watchers
594 $_->cancel for Event::all_watchers;
595
596 # 2. unload all extensions
597 for (@exts) {
598 $msg->("unloading <$_>");
599 unload_extension $_;
600 }
601
602 # 3. unload all modules loaded from $LIBDIR
603 while (my ($k, $v) = each %INC) {
604 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
605
606 $msg->("removing <$k>");
607 delete $INC{$k};
608
609 $k =~ s/\.pm$//;
610 $k =~ s/\//::/g;
611
612 if (my $cb = $k->can ("unload_module")) {
613 $cb->();
614 }
615
616 Symbol::delete_package $k;
617 }
618
619 # 4. get rid of safe::, as good as possible
620 Symbol::delete_package "safe::$_"
621 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
622
623 # 5. remove register_script_function callbacks
624 # TODO
625
626 # 6. unload cf.pm "a bit"
627 delete $INC{"cf.pm"};
628
629 # don't, removes xs symbols, too,
630 # and global variables created in xs
631 #Symbol::delete_package __PACKAGE__;
632
633 # 7. reload cf.pm
634 $msg->("reloading cf.pm");
635 require cf;
636 };
637 $msg->($@) if $@;
638
639 $msg->("reloaded");
640 };
641
642 sub perl_reload() {
643 _perl_reload {
644 warn $_[0];
645 print "$_[0]\n";
646 };
647 }
648
649 register_command "perl-reload", 0, sub {
650 my ($who, $arg) = @_;
651
652 if ($who->flag (FLAG_WIZ)) {
653 _perl_reload {
654 warn $_[0];
655 $who->message ($_[0]);
656 };
657 }
658 };
659
660 #############################################################################
661 # extcmd framework, basically convert ext <msg>
662 # into pkg::->on_extcmd_arg1 (...) while shortcutting a few
663
664 attach_to_players
665 on_extcmd => sub {
666 my ($pl, $buf) = @_;
667
668 my $msg = eval { from_json $buf };
669
670 if (ref $msg) {
671 if (my $cb = $extcmd{$msg->{msgtype}}) {
672 if (my %reply = $cb->[0]->($pl, $msg)) {
673 $pl->ext_reply ($msg->{msgid}, %reply);
674 }
675 }
676 } else {
677 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
678 }
679
680 cf::override;
681 },
682 ;
683
684 #############################################################################
685 # load/save/clean perl data associated with a map
686
687 *cf::mapsupport::on_clean = sub {
688 my ($map) = @_;
689
690 my $path = $map->tmpname;
691 defined $path or return;
692
693 unlink "$path.pst";
694 };
695
696 # old style persistent data, TODO: remove #d#
697 *cf::mapsupport::on_swapin =
698 *cf::mapsupport::on_load = sub {
699 my ($map) = @_;
700
701 my $path = $map->tmpname;
702 $path = $map->path unless defined $path;
703
704 open my $fh, "<:raw", "$path.cfperl"
705 or return; # no perl data
706
707 my $data = Storable::thaw do { local $/; <$fh> };
708
709 $data->{version} <= 1
710 or return; # too new
711
712 $map->_set_obs ($data->{obs});
713 $map->invoke (EVENT_MAP_UPGRADE);
714 };
715
716 attach_to_maps prio => -10000, package => cf::mapsupport::;
717
718 #############################################################################
719 # load/save perl data associated with player->ob objects
720
721 sub all_objects(@) {
722 @_, map all_objects ($_->inv), @_
723 }
724
725 attach_to_players
726 on_load => sub {
727 my ($pl, $path) = @_;
728
729 for my $o (all_objects $pl->ob) {
730 if (my $value = $o->get_ob_key_value ("_perl_data")) {
731 $o->set_ob_key_value ("_perl_data");
732
733 %$o = %{ Storable::thaw pack "H*", $value };
734 }
735 }
736 },
737 ;
738
739 #############################################################################
740 # core extensions - in perl
741
742 =item cf::player::exists $login
743
744 Returns true when the given account exists.
745
746 =cut
747
748 sub cf::player::exists($) {
749 cf::player::find $_[0]
750 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
751 }
752
753 =item $player->reply ($npc, $msg[, $flags])
754
755 Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
756 can be C<undef>. Does the right thing when the player is currently in a
757 dialogue with the given NPC character.
758
759 =cut
760
761 # rough implementation of a future "reply" method that works
762 # with dialog boxes.
763 sub cf::object::player::reply($$$;$) {
764 my ($self, $npc, $msg, $flags) = @_;
765
766 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
767
768 if ($self->{record_replies}) {
769 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
770 } else {
771 $msg = $npc->name . " says: $msg" if $npc;
772 $self->message ($msg, $flags);
773 }
774 }
775
776 =item $player->ext_reply ($msgid, $msgtype, %msg)
777
778 Sends an ext reply to the player.
779
780 =cut
781
782 sub cf::player::ext_reply($$$%) {
783 my ($self, $id, %msg) = @_;
784
785 $msg{msgid} = $id;
786
787 $self->send ("ext " . to_json \%msg);
788 }
789
790 #############################################################################
791 # map scripting support
792
793 our $safe = new Safe "safe";
794 our $safe_hole = new Safe::Hole;
795
796 $SIG{FPE} = 'IGNORE';
797
798 $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
799
800 # here we export the classes and methods available to script code
801
802 for (
803 ["cf::object" => qw(contr pay_amount pay_player)],
804 ["cf::object::player" => qw(player)],
805 ["cf::player" => qw(peaceful)],
806 ) {
807 no strict 'refs';
808 my ($pkg, @funs) = @$_;
809 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
810 for @funs;
811 }
812
813 sub safe_eval($;@) {
814 my ($code, %vars) = @_;
815
816 my $qcode = $code;
817 $qcode =~ s/"/‟/g; # not allowed in #line filenames
818 $qcode =~ s/\n/\\n/g;
819
820 local $_;
821 local @safe::cf::_safe_eval_args = values %vars;
822
823 my $eval =
824 "do {\n"
825 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
826 . "#line 0 \"{$qcode}\"\n"
827 . $code
828 . "\n}"
829 ;
830
831 sub_generation_inc;
832 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
833 sub_generation_inc;
834
835 if ($@) {
836 warn "$@";
837 warn "while executing safe code '$code'\n";
838 warn "with arguments " . (join " ", %vars) . "\n";
839 }
840
841 wantarray ? @res : $res[0]
842 }
843
844 sub register_script_function {
845 my ($fun, $cb) = @_;
846
847 no strict 'refs';
848 *{"safe::$fun"} = $safe_hole->wrap ($cb);
849 }
850
851 #############################################################################
852 # the server's main()
853
854 sub main {
855 Event::loop;
856 }
857
858 #############################################################################
859 # initialisation
860
861 register "<global>", __PACKAGE__;
862
863 unshift @INC, $LIBDIR;
864
865 load_extensions;
866
867 $TICK_WATCHER = Event->timer (
868 prio => 1,
869 at => $NEXT_TICK || 1,
870 cb => sub {
871 cf::server_tick; # one server iteration
872
873 my $NOW = Event::time;
874 $NEXT_TICK += $TICK;
875
876 # if we are delayed by four ticks, skip them all
877 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
878
879 $TICK_WATCHER->at ($NEXT_TICK);
880 $TICK_WATCHER->start;
881 },
882 );
883
884 _reload_2;
885
886 1
887