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.54 by root, Tue Aug 29 14:49:28 2006 UTC vs.
Revision 1.69 by root, Mon Sep 18 01:10:35 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
16_reload_1; 16_init_vars;
17 17
18our %COMMAND = (); 18our %COMMAND = ();
19our @EVENT; 19our @EVENT;
20our %PROP_TYPE;
21our %PROP_IDX;
22our $LIBDIR = maps_directory "perl"; 20our $LIBDIR = maps_directory "perl";
23 21
24our $TICK = MAX_TIME * 1e-6; 22our $TICK = MAX_TIME * 1e-6;
25our $TICK_WATCHER; 23our $TICK_WATCHER;
26our $NEXT_TICK; 24our $NEXT_TICK;
… …
34 print STDERR "cfperl: $msg"; 32 print STDERR "cfperl: $msg";
35 LOG llevError, "cfperl: $msg"; 33 LOG llevError, "cfperl: $msg";
36 }; 34 };
37} 35}
38 36
39my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply!
40
41# generate property mutators
42sub 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
66prop_gen OBJECT_PROP => "cf::object";
67# CFAPI_OBJECT_ANIMATION?
68prop_gen PLAYER_PROP => "cf::object::player";
69
70prop_gen MAP_PROP => "cf::map";
71prop_gen ARCH_PROP => "cf::arch";
72
73@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 37@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74 38
75# we bless all objects into (empty) derived classes to force a method lookup 39# we bless all objects into (empty) derived classes to force a method lookup
76# within the Safe compartment. 40# within the Safe compartment.
77for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { 41for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
… …
105} 69}
106 70
107############################################################################# 71#############################################################################
108# "new" plug-in system 72# "new" plug-in system
109 73
74=head3 EVENTS AND OBJECT ATTACHMENTS
75
76=over 4
77
110=item $object->attach ($attachment, key => $value...) 78=item $object->attach ($attachment, key => $value...)
111 79
112=item $object->detach ($attachment) 80=item $object->detach ($attachment)
113 81
114Attach/detach a pre-registered attachment to an object. 82Attach/detach a pre-registered attachment to an object.
… …
122=item $map->attach ($attachment, key => $value...) 90=item $map->attach ($attachment, key => $value...)
123 91
124=item $map->detach ($attachment) 92=item $map->detach ($attachment)
125 93
126Attach/detach a pre-registered attachment to a map. 94Attach/detach a pre-registered attachment to a map.
95
96=item $bool = $object->attached ($name)
97
98=item $bool = $player->attached ($name)
99
100=item $bool = $map->attached ($name)
101
102Checks wether the named attachment is currently attached to the object.
127 103
128=item cf::attach_global ... 104=item cf::attach_global ...
129 105
130Attach handlers for global events. 106Attach handlers for global events.
131 107
… …
181Attach handlers to all maps. 157Attach handlers to all maps.
182 158
183=item cf:register_attachment $name, ... 159=item cf:register_attachment $name, ...
184 160
185Register an attachment by name through which objects can refer to this 161Register an attachment by name through which objects can refer to this
162attachment.
163
164=item cf:register_player_attachment $name, ...
165
166Register an attachment by name through which players can refer to this
186attachment. 167attachment.
187 168
188=item cf:register_map_attachment $name, ... 169=item cf:register_map_attachment $name, ...
189 170
190Register an attachment by name through which maps can refer to this 171Register an attachment by name through which maps can refer to this
… …
261} 242}
262 243
263sub _attach_attachment { 244sub _attach_attachment {
264 my ($obj, $name, %arg) = @_; 245 my ($obj, $name, %arg) = @_;
265 246
247 return if exists $obj->{_attachment}{$name};
248
266 my $res; 249 my $res;
267 250
268 if (my $attach = $attachment{$name}) { 251 if (my $attach = $attachment{$name}) {
269 my $registry = $obj->registry; 252 my $registry = $obj->registry;
270 253
… …
288*cf::player::attach = 271*cf::player::attach =
289*cf::map::attach = sub { 272*cf::map::attach = sub {
290 my ($obj, $name, %arg) = @_; 273 my ($obj, $name, %arg) = @_;
291 274
292 _attach_attachment $obj, $name, %arg; 275 _attach_attachment $obj, $name, %arg;
293} 276};
294 277
295# all those should be optimised 278# all those should be optimised
296*cf::object::detach = 279*cf::object::detach =
297*cf::player::detach = 280*cf::player::detach =
298*cf::map::detach = sub { 281*cf::map::detach = sub {
299 my ($obj, $name) = @_; 282 my ($obj, $name) = @_;
300 283
301 delete $obj->{_attachment}{$name}; 284 delete $obj->{_attachment}{$name};
302 reattach $obj; 285 reattach ($obj);
286};
287
288*cf::object::attached =
289*cf::player::attached =
290*cf::map::attached = sub {
291 my ($obj, $name) = @_;
292
293 exists $obj->{_attachment}{$name}
303}; 294};
304 295
305sub attach_global { 296sub attach_global {
306 _attach @CB_GLOBAL, KLASS_GLOBAL, @_ 297 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
307} 298}
… …
329 my $name = shift; 320 my $name = shift;
330 321
331 $attachment{$name} = [[KLASS_OBJECT, @_]]; 322 $attachment{$name} = [[KLASS_OBJECT, @_]];
332} 323}
333 324
325sub register_player_attachment {
326 my $name = shift;
327
328 $attachment{$name} = [[KLASS_PLAYER, @_]];
329}
330
334sub register_map_attachment { 331sub register_map_attachment {
335 my $name = shift; 332 my $name = shift;
336 333
337 $attachment{$name} = [[KLASS_MAP, @_]]; 334 $attachment{$name} = [[KLASS_MAP, @_]];
338} 335}
… …
356 for (@$callbacks) { 353 for (@$callbacks) {
357 eval { &{$_->[1]} }; 354 eval { &{$_->[1]} };
358 355
359 if ($@) { 356 if ($@) {
360 warn "$@"; 357 warn "$@";
361 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 358 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
362 override; 359 override;
363 } 360 }
364 361
365 return 1 if $override; 362 return 1 if $override;
366 } 363 }
367 364
368 0 365 0
369} 366}
367
368=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
369
370=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
371
372=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
373
374=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
375
376Generate a global/object/player/map-specific event with the given arguments.
377
378This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
379removed in future versions), and there is no public API to access override
380results (if you must, access C<@cf::invoke_results> directly).
381
382=back
383
384=head2 methods valid for all pointers
385
386=over 4
387
388=item $object->valid
389
390=item $player->valid
391
392=item $map->valid
393
394Just because you have a perl object does not mean that the corresponding
395C-level object still exists. If you try to access an object that has no
396valid C counterpart anymore you get an exception at runtime. This method
397can be used to test for existence of the C object part without causing an
398exception.
399
400=back
401
402=cut
403
404*cf::object::valid =
405*cf::player::valid =
406*cf::map::valid = \&cf::_valid;
370 407
371############################################################################# 408#############################################################################
372# object support 409# object support
373 410
374sub instantiate { 411sub instantiate {
… …
403 } 440 }
404 } 441 }
405} 442}
406 443
407sub object_freezer_save { 444sub object_freezer_save {
408 my ($filename, $objs) = @_; 445 my ($filename, $rdata, $objs) = @_;
409 446
410 if (@$objs) { 447 if (length $$rdata) {
448 warn sprintf "saving %s (%d,%d)\n",
449 $filename, length $$rdata, scalar @$objs;
450
411 open my $fh, ">:raw", "$filename.pst~"; 451 if (open my $fh, ">:raw", "$filename~") {
452 chmod SAVE_MODE, $fh;
453 syswrite $fh, $$rdata;
454 close $fh;
455
456 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
457 chmod SAVE_MODE, $fh;
412 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 458 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
413 close $fh; 459 close $fh;
414 chmod SAVE_MODE, "$filename.pst~";
415 rename "$filename.pst~", "$filename.pst"; 460 rename "$filename.pst~", "$filename.pst";
461 } else {
462 unlink "$filename.pst";
463 }
464
465 rename "$filename~", $filename;
466 } else {
467 warn "FATAL: $filename~: $!\n";
468 }
416 } else { 469 } else {
470 unlink $filename;
417 unlink "$filename.pst"; 471 unlink "$filename.pst";
418 } 472 }
419
420 chmod SAVE_MODE, "$filename~";
421 rename "$filename~", $filename;
422} 473}
423 474
424sub object_thawer_load { 475sub object_thawer_load {
425 my ($filename) = @_; 476 my ($filename) = @_;
426 477
478 local $/;
479
480 my $av;
481
482 #TODO: use sysread etc.
483 if (open my $data, "<:raw:perlio", $filename) {
484 $data = <$data>;
427 open my $fh, "<:raw:perlio", "$filename.pst" 485 if (open my $pst, "<:raw:perlio", "$filename.pst") {
428 or return; 486 $av = eval { (Storable::thaw <$pst>)->{objs} };
487 }
488 return ($data, $av);
489 }
429 490
430 eval { local $/; (Storable::thaw <$fh>)->{objs} } 491 ()
431} 492}
432 493
433attach_to_objects 494attach_to_objects
434 prio => -1000000, 495 prio => -1000000,
435 on_clone => sub { 496 on_clone => sub {
… …
581 load_extension $ext; 642 load_extension $ext;
582 1 643 1
583 } or warn "$ext not loaded: $@"; 644 } or warn "$ext not loaded: $@";
584 } 645 }
585} 646}
586
587sub _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
642sub perl_reload() {
643 _perl_reload {
644 warn $_[0];
645 print "$_[0]\n";
646 };
647}
648
649register_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 647
660############################################################################# 648#############################################################################
661# extcmd framework, basically convert ext <msg> 649# extcmd framework, basically convert ext <msg>
662# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 650# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
663 651
… …
691 defined $path or return; 679 defined $path or return;
692 680
693 unlink "$path.pst"; 681 unlink "$path.pst";
694}; 682};
695 683
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
716attach_to_maps prio => -10000, package => cf::mapsupport::; 684attach_to_maps prio => -10000, package => cf::mapsupport::;
717 685
718############################################################################# 686#############################################################################
719# load/save perl data associated with player->ob objects 687# load/save perl data associated with player->ob objects
720 688
721sub all_objects(@) { 689sub all_objects(@) {
722 @_, map all_objects ($_->inv), @_ 690 @_, map all_objects ($_->inv), @_
723} 691}
724 692
693# TODO: compatibility cruft, remove when no longer needed
725attach_to_players 694attach_to_players
726 on_load => sub { 695 on_load => sub {
727 my ($pl, $path) = @_; 696 my ($pl, $path) = @_;
728 697
729 for my $o (all_objects $pl->ob) { 698 for my $o (all_objects $pl->ob) {
… …
839 } 808 }
840 809
841 wantarray ? @res : $res[0] 810 wantarray ? @res : $res[0]
842} 811}
843 812
813=item cf::register_script_function $function => $cb
814
815Register a function that can be called from within map/npc scripts. The
816function should be reasonably secure and should be put into a package name
817like the extension.
818
819Example: register a function that gets called whenever a map script calls
820C<rent::overview>, as used by the C<rent> extension.
821
822 cf::register_script_function "rent::overview" => sub {
823 ...
824 };
825
826=cut
827
844sub register_script_function { 828sub register_script_function {
845 my ($fun, $cb) = @_; 829 my ($fun, $cb) = @_;
846 830
847 no strict 'refs'; 831 no strict 'refs';
848 *{"safe::$fun"} = $safe_hole->wrap ($cb); 832 *{"safe::$fun"} = $safe_hole->wrap ($cb);
849} 833}
850 834
851############################################################################# 835#############################################################################
836
837=head2 EXTENSION DATABASE SUPPORT
838
839Crossfire maintains a very simple database for extension use. It can
840currently store anything that can be serialised using Storable, which
841excludes objects.
842
843The parameter C<$family> should best start with the name of the extension
844using it, it should be unique.
845
846=over 4
847
848=item $hashref = cf::db_get $family
849
850Return a hashref for use by the extension C<$family>, which can be
851modified. After modifications, you have to call C<cf::db_dirty> or
852C<cf::db_sync>.
853
854=item $value = cf::db_get $family => $key
855
856Returns a single value from the database
857
858=item cf::db_put $family => $hashref
859
860Stores the given family hashref into the database. Updates are delayed, if
861you want the data to be synced to disk immediately, use C<cf::db_sync>.
862
863=item cf::db_put $family => $key => $value
864
865Stores the given C<$value> in the family hash. Updates are delayed, if you
866want the data to be synced to disk immediately, use C<cf::db_sync>.
867
868=item cf::db_dirty
869
870Marks the database as dirty, to be updated at a later time.
871
872=item cf::db_sync
873
874Immediately write the database to disk I<if it is dirty>.
875
876=cut
877
878{
879 my $db;
880 my $path = cf::localdir . "/database.pst";
881
882 sub db_load() {
883 warn "loading database $path\n";#d# remove later
884 $db = stat $path ? Storable::retrieve $path : { };
885 }
886
887 my $pid;
888
889 sub db_save() {
890 warn "saving database $path\n";#d# remove later
891 waitpid $pid, 0 if $pid;
892 if (0 == ($pid = fork)) {
893 $db->{_meta}{version} = 1;
894 Storable::nstore $db, "$path~";
895 rename "$path~", $path;
896 cf::_exit 0 if defined $pid;
897 }
898 }
899
900 my $dirty;
901
902 sub db_sync() {
903 db_save if $dirty;
904 undef $dirty;
905 }
906
907 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
908 db_sync;
909 });
910
911 sub db_dirty() {
912 $dirty = 1;
913 $idle->start;
914 }
915
916 sub db_get($;$) {
917 @_ >= 2
918 ? $db->{$_[0]}{$_[1]}
919 : ($db->{$_[0]} ||= { })
920 }
921
922 sub db_put($$;$) {
923 if (@_ >= 3) {
924 $db->{$_[0]}{$_[1]} = $_[2];
925 } else {
926 $db->{$_[0]} = $_[1];
927 }
928 db_dirty;
929 }
930
931 attach_global
932 prio => 10000,
933 on_cleanup => sub {
934 db_sync;
935 },
936 ;
937}
938
939#############################################################################
852# the server's main() 940# the server's main()
853 941
854sub main { 942sub main {
943 db_load;
944 load_extensions;
855 Event::loop; 945 Event::loop;
856} 946}
857 947
858############################################################################# 948#############################################################################
859# initialisation 949# initialisation
860 950
951sub _perl_reload(&) {
952 my ($msg) = @_;
953
954 $msg->("reloading...");
955
956 eval {
957 # cancel all watchers
958 $_->cancel for Event::all_watchers;
959
960 # unload all extensions
961 for (@exts) {
962 $msg->("unloading <$_>");
963 unload_extension $_;
964 }
965
966 # unload all modules loaded from $LIBDIR
967 while (my ($k, $v) = each %INC) {
968 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
969
970 $msg->("removing <$k>");
971 delete $INC{$k};
972
973 $k =~ s/\.pm$//;
974 $k =~ s/\//::/g;
975
976 if (my $cb = $k->can ("unload_module")) {
977 $cb->();
978 }
979
980 Symbol::delete_package $k;
981 }
982
983 # sync database to disk
984 cf::db_sync;
985
986 # get rid of safe::, as good as possible
987 Symbol::delete_package "safe::$_"
988 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
989
990 # remove register_script_function callbacks
991 # TODO
992
993 # unload cf.pm "a bit"
994 delete $INC{"cf.pm"};
995
996 # don't, removes xs symbols, too,
997 # and global variables created in xs
998 #Symbol::delete_package __PACKAGE__;
999
1000 # reload cf.pm
1001 $msg->("reloading cf.pm");
1002 require cf;
1003
1004 # load database again
1005 cf::db_load;
1006
1007 # load extensions
1008 $msg->("load extensions");
1009 cf::load_extensions;
1010
1011 # reattach attachments to objects
1012 $msg->("reattach");
1013 _global_reattach;
1014 };
1015 $msg->($@) if $@;
1016
1017 $msg->("reloaded");
1018};
1019
1020sub perl_reload() {
1021 _perl_reload {
1022 warn $_[0];
1023 print "$_[0]\n";
1024 };
1025}
1026
1027register_command "perl-reload", 0, sub {
1028 my ($who, $arg) = @_;
1029
1030 if ($who->flag (FLAG_WIZ)) {
1031 _perl_reload {
1032 warn $_[0];
1033 $who->message ($_[0]);
1034 };
1035 }
1036};
1037
861register "<global>", __PACKAGE__; 1038register "<global>", __PACKAGE__;
862 1039
863unshift @INC, $LIBDIR; 1040unshift @INC, $LIBDIR;
864
865load_extensions;
866 1041
867$TICK_WATCHER = Event->timer ( 1042$TICK_WATCHER = Event->timer (
868 prio => 1, 1043 prio => 1,
869 at => $NEXT_TICK || 1, 1044 at => $NEXT_TICK || 1,
870 cb => sub { 1045 cb => sub {
… …
879 $TICK_WATCHER->at ($NEXT_TICK); 1054 $TICK_WATCHER->at ($NEXT_TICK);
880 $TICK_WATCHER->start; 1055 $TICK_WATCHER->start;
881 }, 1056 },
882); 1057);
883 1058
884_reload_2;
885
8861 10591
887 1060

Diff Legend

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