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.52 by root, Mon Aug 28 16:52:51 2006 UTC vs.
Revision 1.65 by root, Tue Sep 12 22:18:55 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
80=item $object->detach ($attachment)
81
112Attach a pre-registered attachment to an object. 82Attach/detach a pre-registered attachment to an object.
113 83
114=item $player->attach ($attachment, key => $value...) 84=item $player->attach ($attachment, key => $value...)
115 85
86=item $player->detach ($attachment)
87
116Attach a pre-registered attachment to a player. 88Attach/detach a pre-registered attachment to a player.
117 89
118=item $map->attach ($attachment, key => $value...) # not yet persistent 90=item $map->attach ($attachment, key => $value...)
119 91
92=item $map->detach ($attachment)
93
120Attach 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.
121 103
122=item cf::attach_global ... 104=item cf::attach_global ...
123 105
124Attach handlers for global events. 106Attach handlers for global events.
125 107
… …
175Attach handlers to all maps. 157Attach handlers to all maps.
176 158
177=item cf:register_attachment $name, ... 159=item cf:register_attachment $name, ...
178 160
179Register 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
180attachment. 167attachment.
181 168
182=item cf:register_map_attachment $name, ... 169=item cf:register_map_attachment $name, ...
183 170
184Register an attachment by name through which maps can refer to this 171Register an attachment by name through which maps can refer to this
… …
255} 242}
256 243
257sub _attach_attachment { 244sub _attach_attachment {
258 my ($obj, $name, %arg) = @_; 245 my ($obj, $name, %arg) = @_;
259 246
247 return if exists $obj->{_attachment}{$name};
248
260 my $res; 249 my $res;
261 250
262 if (my $attach = $attachment{$name}) { 251 if (my $attach = $attachment{$name}) {
263 my $registry = $obj->registry; 252 my $registry = $obj->registry;
264 253
… …
276 265
277 $res->{attachment} = $name; 266 $res->{attachment} = $name;
278 $res 267 $res
279} 268}
280 269
281sub cf::object::attach { 270*cf::object::attach =
271*cf::player::attach =
272*cf::map::attach = sub {
282 my ($obj, $name, %arg) = @_; 273 my ($obj, $name, %arg) = @_;
283 274
284 _attach_attachment $obj, $name, %arg; 275 _attach_attachment $obj, $name, %arg;
285} 276};
286 277
278# all those should be optimised
279*cf::object::detach =
287sub cf::player::attach { 280*cf::player::detach =
281*cf::map::detach = sub {
288 my ($obj, $name, %arg) = @_; 282 my ($obj, $name) = @_;
289 283
290 _attach_attachment $obj, $name, %arg; 284 delete $obj->{_attachment}{$name};
291} 285 reattach ($obj);
286};
292 287
293sub cf::map::attach { 288*cf::object::attached =
289*cf::player::attached =
290*cf::map::attached = sub {
294 my ($obj, $name, %arg) = @_; 291 my ($obj, $name) = @_;
295 292
296 _attach_attachment $obj, $name, %arg; 293 exists $obj->{_attachment}{$name}
297} 294};
298 295
299sub attach_global { 296sub attach_global {
300 _attach @CB_GLOBAL, KLASS_GLOBAL, @_ 297 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
301} 298}
302 299
… …
323 my $name = shift; 320 my $name = shift;
324 321
325 $attachment{$name} = [[KLASS_OBJECT, @_]]; 322 $attachment{$name} = [[KLASS_OBJECT, @_]];
326} 323}
327 324
325sub register_player_attachment {
326 my $name = shift;
327
328 $attachment{$name} = [[KLASS_PLAYER, @_]];
329}
330
328sub register_map_attachment { 331sub register_map_attachment {
329 my $name = shift; 332 my $name = shift;
330 333
331 $attachment{$name} = [[KLASS_MAP, @_]]; 334 $attachment{$name} = [[KLASS_MAP, @_]];
332} 335}
… …
350 for (@$callbacks) { 353 for (@$callbacks) {
351 eval { &{$_->[1]} }; 354 eval { &{$_->[1]} };
352 355
353 if ($@) { 356 if ($@) {
354 warn "$@"; 357 warn "$@";
355 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 358 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
356 override; 359 override;
357 } 360 }
358 361
359 return 1 if $override; 362 return 1 if $override;
360 } 363 }
361 364
362 0 365 0
363} 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;
364 407
365############################################################################# 408#############################################################################
366# object support 409# object support
367 410
368sub instantiate { 411sub instantiate {
… …
397 } 440 }
398 } 441 }
399} 442}
400 443
401sub object_freezer_save { 444sub object_freezer_save {
402 my ($filename, $objs) = @_; 445 my ($filename, $rdata, $objs) = @_;
403 446
404 if (@$objs) { 447 if (length $$rdata) {
448 warn sprintf "saving %s (%d,%d)\n",
449 $filename, length $$rdata, scalar @$objs;
450
405 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;
406 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 458 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
407 close $fh; 459 close $fh;
408 chmod SAVE_MODE, "$filename.pst~";
409 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 }
410 } else { 469 } else {
470 unlink $filename;
411 unlink "$filename.pst"; 471 unlink "$filename.pst";
412 } 472 }
413
414 chmod SAVE_MODE, "$filename~";
415 rename "$filename~", $filename;
416} 473}
417 474
418sub object_thawer_load { 475sub object_thawer_load {
419 my ($filename) = @_; 476 my ($filename) = @_;
420 477
478 local $/;
479
480 my $av;
481
482 #TODO: use sysread etc.
483 if (open my $data, "<:raw:perlio", $filename) {
484 $data = <$data>;
421 open my $fh, "<:raw:perlio", "$filename.pst" 485 if (open my $pst, "<:raw:perlio", "$filename.pst") {
422 or return; 486 $av = eval { (Storable::thaw <$pst>)->{objs} };
487 }
488 return ($data, $av);
489 }
423 490
424 eval { local $/; (Storable::thaw <$fh>)->{objs} } 491 ()
425} 492}
426 493
427attach_to_objects 494attach_to_objects
428 prio => -1000000, 495 prio => -1000000,
429 on_clone => sub { 496 on_clone => sub {
… …
575 load_extension $ext; 642 load_extension $ext;
576 1 643 1
577 } or warn "$ext not loaded: $@"; 644 } or warn "$ext not loaded: $@";
578 } 645 }
579} 646}
580
581sub _perl_reload(&) {
582 my ($msg) = @_;
583
584 $msg->("reloading...");
585
586 eval {
587 # 1. cancel all watchers
588 $_->cancel for Event::all_watchers;
589
590 # 2. unload all extensions
591 for (@exts) {
592 $msg->("unloading <$_>");
593 unload_extension $_;
594 }
595
596 # 3. unload all modules loaded from $LIBDIR
597 while (my ($k, $v) = each %INC) {
598 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
599
600 $msg->("removing <$k>");
601 delete $INC{$k};
602
603 $k =~ s/\.pm$//;
604 $k =~ s/\//::/g;
605
606 if (my $cb = $k->can ("unload_module")) {
607 $cb->();
608 }
609
610 Symbol::delete_package $k;
611 }
612
613 # 4. get rid of safe::, as good as possible
614 Symbol::delete_package "safe::$_"
615 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
616
617 # 5. remove register_script_function callbacks
618 # TODO
619
620 # 6. unload cf.pm "a bit"
621 delete $INC{"cf.pm"};
622
623 # don't, removes xs symbols, too,
624 # and global variables created in xs
625 #Symbol::delete_package __PACKAGE__;
626
627 # 7. reload cf.pm
628 $msg->("reloading cf.pm");
629 require cf;
630 };
631 $msg->($@) if $@;
632
633 $msg->("reloaded");
634};
635
636sub perl_reload() {
637 _perl_reload {
638 warn $_[0];
639 print "$_[0]\n";
640 };
641}
642
643register_command "perl-reload", 0, sub {
644 my ($who, $arg) = @_;
645
646 if ($who->flag (FLAG_WIZ)) {
647 _perl_reload {
648 warn $_[0];
649 $who->message ($_[0]);
650 };
651 }
652};
653 647
654############################################################################# 648#############################################################################
655# extcmd framework, basically convert ext <msg> 649# extcmd framework, basically convert ext <msg>
656# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 650# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
657 651
… …
685 defined $path or return; 679 defined $path or return;
686 680
687 unlink "$path.pst"; 681 unlink "$path.pst";
688}; 682};
689 683
690# old style persistent data, TODO: remove #d#
691*cf::mapsupport::on_swapin =
692*cf::mapsupport::on_load = sub {
693 my ($map) = @_;
694
695 my $path = $map->tmpname;
696 $path = $map->path unless defined $path;
697
698 open my $fh, "<:raw", "$path.cfperl"
699 or return; # no perl data
700
701 my $data = Storable::thaw do { local $/; <$fh> };
702
703 $data->{version} <= 1
704 or return; # too new
705
706 $map->_set_obs ($data->{obs});
707 $map->invoke (EVENT_MAP_UPGRADE);
708};
709
710attach_to_maps prio => -10000, package => cf::mapsupport::; 684attach_to_maps prio => -10000, package => cf::mapsupport::;
711 685
712############################################################################# 686#############################################################################
713# load/save perl data associated with player->ob objects 687# load/save perl data associated with player->ob objects
714 688
715sub all_objects(@) { 689sub all_objects(@) {
716 @_, map all_objects ($_->inv), @_ 690 @_, map all_objects ($_->inv), @_
717} 691}
718 692
693# TODO: compatibility cruft, remove when no longer needed
719attach_to_players 694attach_to_players
720 on_load => sub { 695 on_load => sub {
721 my ($pl, $path) = @_; 696 my ($pl, $path) = @_;
722 697
723 for my $o (all_objects $pl->ob) { 698 for my $o (all_objects $pl->ob) {
… …
841 no strict 'refs'; 816 no strict 'refs';
842 *{"safe::$fun"} = $safe_hole->wrap ($cb); 817 *{"safe::$fun"} = $safe_hole->wrap ($cb);
843} 818}
844 819
845############################################################################# 820#############################################################################
821
822=head2 EXTENSION DATABASE SUPPORT
823
824Crossfire maintains a very simple database for extension use. It can
825currently store anything that can be serialised using Storable, which
826excludes objects.
827
828The parameter C<$family> should best start with the name of the extension
829using it, it should be unique.
830
831=over 4
832
833=item $hashref = cf::db_get $family
834
835Return a hashref for use by the extension C<$family>, which can be
836modified. After modifications, you have to call C<cf::db_dirty> or
837C<cf::db_sync>.
838
839=item $value = cf::db_get $family => $key
840
841Returns a single value from the database
842
843=item cf::db_put $family => $hashref
844
845Stores the given family hashref into the database. Updates are delayed, if
846you want the data to be synced to disk immediately, use C<cf::db_sync>.
847
848=item cf::db_put $family => $key => $value
849
850Stores the given C<$value> in the family hash. Updates are delayed, if you
851want the data to be synced to disk immediately, use C<cf::db_sync>.
852
853=item cf::db_dirty
854
855Marks the database as dirty, to be updated at a later time.
856
857=item cf::db_sync
858
859Immediately write the database to disk I<if it is dirty>.
860
861=cut
862
863{
864 my $db;
865 my $path = cf::datadir . "/database.pst";
866
867 sub db_load() {
868 warn "loading database $path\n";#d# remove later
869 $db = stat $path ? Storable::retrieve $path : { };
870 }
871
872 my $pid;
873
874 sub db_save() {
875 warn "saving database $path\n";#d# remove later
876 waitpid $pid, 0 if $pid;
877 unless ($pid = fork) {
878 $db->{_meta}{version} = 1;
879 Storable::nstore $db, "$path~";
880 rename "$path~", $path;
881 cf::_exit 0 if defined $pid;
882 }
883 }
884
885 my $dirty;
886
887 sub db_sync() {
888 db_save if $dirty;
889 undef $dirty;
890 }
891
892 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
893 db_sync;
894 });
895
896 sub db_dirty() {
897 $dirty = 1;
898 $idle->start;
899 }
900
901 sub db_get($;$) {
902 @_ >= 2
903 ? $db->{$_[0]}{$_[1]}
904 : ($db->{$_[0]} ||= { })
905 }
906
907 sub db_put($$;$) {
908 if (@_ >= 3) {
909 $db->{$_[0]}{$_[1]} = $_[2];
910 } else {
911 $db->{$_[0]} = $_[1];
912 }
913 db_dirty;
914 }
915}
916
917#############################################################################
846# the server's main() 918# the server's main()
847 919
848sub main { 920sub main {
921 db_load;
922 load_extensions;
849 Event::loop; 923 Event::loop;
850} 924}
851 925
852############################################################################# 926#############################################################################
853# initialisation 927# initialisation
854 928
929sub _perl_reload(&) {
930 my ($msg) = @_;
931
932 $msg->("reloading...");
933
934 eval {
935 # cancel all watchers
936 $_->cancel for Event::all_watchers;
937
938 # unload all extensions
939 for (@exts) {
940 $msg->("unloading <$_>");
941 unload_extension $_;
942 }
943
944 # unload all modules loaded from $LIBDIR
945 while (my ($k, $v) = each %INC) {
946 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
947
948 $msg->("removing <$k>");
949 delete $INC{$k};
950
951 $k =~ s/\.pm$//;
952 $k =~ s/\//::/g;
953
954 if (my $cb = $k->can ("unload_module")) {
955 $cb->();
956 }
957
958 Symbol::delete_package $k;
959 }
960
961 # sync database to disk
962 cf::db_sync;
963
964 # get rid of safe::, as good as possible
965 Symbol::delete_package "safe::$_"
966 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
967
968 # remove register_script_function callbacks
969 # TODO
970
971 # unload cf.pm "a bit"
972 delete $INC{"cf.pm"};
973
974 # don't, removes xs symbols, too,
975 # and global variables created in xs
976 #Symbol::delete_package __PACKAGE__;
977
978 # reload cf.pm
979 $msg->("reloading cf.pm");
980 require cf;
981
982 # load database again
983 cf::db_load;
984
985 # load extensions
986 $msg->("load extensions");
987 cf::load_extensions;
988
989 # reattach attachments to objects
990 $msg->("reattach");
991 _global_reattach;
992 };
993 $msg->($@) if $@;
994
995 $msg->("reloaded");
996};
997
998sub perl_reload() {
999 _perl_reload {
1000 warn $_[0];
1001 print "$_[0]\n";
1002 };
1003}
1004
1005register_command "perl-reload", 0, sub {
1006 my ($who, $arg) = @_;
1007
1008 if ($who->flag (FLAG_WIZ)) {
1009 _perl_reload {
1010 warn $_[0];
1011 $who->message ($_[0]);
1012 };
1013 }
1014};
1015
855register "<global>", __PACKAGE__; 1016register "<global>", __PACKAGE__;
856 1017
857unshift @INC, $LIBDIR; 1018unshift @INC, $LIBDIR;
858
859load_extensions;
860 1019
861$TICK_WATCHER = Event->timer ( 1020$TICK_WATCHER = Event->timer (
862 prio => 1, 1021 prio => 1,
863 at => $NEXT_TICK || 1, 1022 at => $NEXT_TICK || 1,
864 cb => sub { 1023 cb => sub {
… …
873 $TICK_WATCHER->at ($NEXT_TICK); 1032 $TICK_WATCHER->at ($NEXT_TICK);
874 $TICK_WATCHER->start; 1033 $TICK_WATCHER->start;
875 }, 1034 },
876); 1035);
877 1036
878_reload_2;
879
8801 10371
881 1038

Diff Legend

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