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.48 by root, Sun Aug 27 15:24:22 2006 UTC vs.
Revision 1.71 by root, Sun Oct 1 10:59:30 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;
25
26our %CFG;
27
28#############################################################################
29
30=head2 GLOBAL VARIABLES
31
32=over 4
33
34=item $cf::LIBDIR
35
36The perl library directory, where extensions and cf-specific modules can
37be found. It will be added to C<@INC> automatically.
38
39=item $cf::TICK
40
41The interval between server ticks, in seconds.
42
43=item %cf::CFG
44
45Configuration for the server, loaded from C</etc/crossfire/config>, or
46from wherever your confdir points to.
47
48=back
49
50=cut
27 51
28BEGIN { 52BEGIN {
29 *CORE::GLOBAL::warn = sub { 53 *CORE::GLOBAL::warn = sub {
30 my $msg = join "", @_; 54 my $msg = join "", @_;
31 $msg .= "\n" 55 $msg .= "\n"
34 print STDERR "cfperl: $msg"; 58 print STDERR "cfperl: $msg";
35 LOG llevError, "cfperl: $msg"; 59 LOG llevError, "cfperl: $msg";
36 }; 60 };
37} 61}
38 62
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'; 63@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74 64
75# we bless all objects into (empty) derived classes to force a method lookup 65# we bless all objects into (empty) derived classes to force a method lookup
76# within the Safe compartment. 66# within the Safe compartment.
77for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch)) { 67for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
78 no strict 'refs'; 68 no strict 'refs';
79 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 69 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80} 70}
81 71
82$Event::DIED = sub { 72$Event::DIED = sub {
87my @exts; 77my @exts;
88my @hook; 78my @hook;
89my %command; 79my %command;
90my %extcmd; 80my %extcmd;
91 81
92############################################################################# 82=head2 UTILITY FUNCTIONS
93# utility functions 83
84=over 4
85
86=cut
94 87
95use JSON::Syck (); # TODO# replace by JSON::PC once working 88use JSON::Syck (); # TODO# replace by JSON::PC once working
89
90=item $ref = cf::from_json $json
91
92Converts a JSON string into the corresponding perl data structure.
93
94=cut
96 95
97sub from_json($) { 96sub from_json($) {
98 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs 97 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99 JSON::Syck::Load $_[0] 98 JSON::Syck::Load $_[0]
100} 99}
101 100
101=item $json = cf::to_json $ref
102
103Converts a perl data structure into its JSON representation.
104
105=cut
106
102sub to_json($) { 107sub to_json($) {
103 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 108 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104 JSON::Syck::Dump $_[0] 109 JSON::Syck::Dump $_[0]
105} 110}
106 111
112=back
113
114=cut
115
107############################################################################# 116#############################################################################
108# "new" plug-in system 117
118=head2 EVENTS AND OBJECT ATTACHMENTS
119
120=over 4
109 121
110=item $object->attach ($attachment, key => $value...) 122=item $object->attach ($attachment, key => $value...)
111 123
124=item $object->detach ($attachment)
125
112Attach a pre-registered attachment to an object. 126Attach/detach a pre-registered attachment to an object.
113 127
114=item $player->attach ($attachment, key => $value...) 128=item $player->attach ($attachment, key => $value...)
115 129
130=item $player->detach ($attachment)
131
116Attach a pre-registered attachment to a player. 132Attach/detach a pre-registered attachment to a player.
117 133
118=item $map->attach ($attachment, key => $value...) # not yet persistent 134=item $map->attach ($attachment, key => $value...)
119 135
136=item $map->detach ($attachment)
137
120Attach a pre-registered attachment to a map. 138Attach/detach a pre-registered attachment to a map.
139
140=item $bool = $object->attached ($name)
141
142=item $bool = $player->attached ($name)
143
144=item $bool = $map->attached ($name)
145
146Checks wether the named attachment is currently attached to the object.
121 147
122=item cf::attach_global ... 148=item cf::attach_global ...
123 149
124Attach handlers for global events. 150Attach handlers for global events.
125 151
173=item cf::attach_to_maps ... 199=item cf::attach_to_maps ...
174 200
175Attach handlers to all maps. 201Attach handlers to all maps.
176 202
177=item cf:register_attachment $name, ... 203=item cf:register_attachment $name, ...
204
205Register an attachment by name through which objects can refer to this
206attachment.
207
208=item cf:register_player_attachment $name, ...
209
210Register an attachment by name through which players can refer to this
211attachment.
212
213=item cf:register_map_attachment $name, ...
214
215Register an attachment by name through which maps can refer to this
216attachment.
178 217
179=cut 218=cut
180 219
181# the following variables are defined in .xs and must not be re-created 220# the following variables are defined in .xs and must not be re-created
182our @CB_GLOBAL = (); # registry for all global events 221our @CB_GLOBAL = (); # registry for all global events
247} 286}
248 287
249sub _attach_attachment { 288sub _attach_attachment {
250 my ($obj, $name, %arg) = @_; 289 my ($obj, $name, %arg) = @_;
251 290
291 return if exists $obj->{_attachment}{$name};
292
252 my $res; 293 my $res;
253 294
254 if (my $attach = $attachment{$name}) { 295 if (my $attach = $attachment{$name}) {
255 my $registry = $obj->registry; 296 my $registry = $obj->registry;
256 297
262 $obj->{$name} = \%arg; 303 $obj->{$name} = \%arg;
263 } else { 304 } else {
264 warn "object uses attachment '$name' that is not available, postponing.\n"; 305 warn "object uses attachment '$name' that is not available, postponing.\n";
265 } 306 }
266 307
267 push @{$obj->{_attachment}}, $name; 308 $obj->{_attachment}{$name} = undef;
268 309
269 $res->{attachment} = $name; 310 $res->{attachment} = $name;
270 $res 311 $res
271} 312}
272 313
273sub cf::object::attach { 314*cf::object::attach =
315*cf::player::attach =
316*cf::map::attach = sub {
274 my ($obj, $name, %arg) = @_; 317 my ($obj, $name, %arg) = @_;
275 318
276 _attach_attachment $obj, $name, %arg; 319 _attach_attachment $obj, $name, %arg;
277} 320};
278 321
322# all those should be optimised
323*cf::object::detach =
279sub cf::player::attach { 324*cf::player::detach =
325*cf::map::detach = sub {
280 my ($obj, $name, %arg) = @_; 326 my ($obj, $name) = @_;
281 327
282 _attach_attachment KLASS_PLAYER, $obj, $name, %arg; 328 delete $obj->{_attachment}{$name};
283} 329 reattach ($obj);
330};
284 331
285sub cf::map::attach { 332*cf::object::attached =
333*cf::player::attached =
334*cf::map::attached = sub {
286 my ($obj, $name, %arg) = @_; 335 my ($obj, $name) = @_;
287 336
288 _attach_attachment KLASS_MAP, $obj, $name, %arg; 337 exists $obj->{_attachment}{$name}
289} 338};
290 339
291sub attach_global { 340sub attach_global {
292 _attach @CB_GLOBAL, KLASS_GLOBAL, @_ 341 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
293} 342}
294 343
315 my $name = shift; 364 my $name = shift;
316 365
317 $attachment{$name} = [[KLASS_OBJECT, @_]]; 366 $attachment{$name} = [[KLASS_OBJECT, @_]];
318} 367}
319 368
369sub register_player_attachment {
370 my $name = shift;
371
372 $attachment{$name} = [[KLASS_PLAYER, @_]];
373}
374
375sub register_map_attachment {
376 my $name = shift;
377
378 $attachment{$name} = [[KLASS_MAP, @_]];
379}
380
320our $override; 381our $override;
321our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 382our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
322 383
323sub override { 384sub override {
324 $override = 1; 385 $override = 1;
336 for (@$callbacks) { 397 for (@$callbacks) {
337 eval { &{$_->[1]} }; 398 eval { &{$_->[1]} };
338 399
339 if ($@) { 400 if ($@) {
340 warn "$@"; 401 warn "$@";
341 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 402 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342 override; 403 override;
343 } 404 }
344 405
345 return 1 if $override; 406 return 1 if $override;
346 } 407 }
347 408
348 0 409 0
349} 410}
411
412=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
413
414=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
415
416=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
417
418=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
419
420Generate a global/object/player/map-specific event with the given arguments.
421
422This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
423removed in future versions), and there is no public API to access override
424results (if you must, access C<@cf::invoke_results> directly).
425
426=back
427
428=cut
429
430#############################################################################
431
432=head2 METHODS VALID FOR ALL CORE OBJECTS
433
434=over 4
435
436=item $object->valid, $player->valid, $map->valid
437
438Just because you have a perl object does not mean that the corresponding
439C-level object still exists. If you try to access an object that has no
440valid C counterpart anymore you get an exception at runtime. This method
441can be used to test for existence of the C object part without causing an
442exception.
443
444=back
445
446=cut
447
448*cf::object::valid =
449*cf::player::valid =
450*cf::map::valid = \&cf::_valid;
350 451
351############################################################################# 452#############################################################################
352# object support 453# object support
353 454
354sub instantiate { 455sub instantiate {
356 457
357 $data = from_json $data; 458 $data = from_json $data;
358 459
359 for (@$data) { 460 for (@$data) {
360 my ($name, $args) = @$_; 461 my ($name, $args) = @$_;
462
361 attach $obj, $name, %{$args || {} }; 463 $obj->attach ($name, %{$args || {} });
362 } 464 }
363} 465}
364 466
365# basically do the same as instantiate, without calling instantiate 467# basically do the same as instantiate, without calling instantiate
366sub reattach { 468sub reattach {
367 my ($obj) = @_; 469 my ($obj) = @_;
368 my $registry = $obj->registry; 470 my $registry = $obj->registry;
369 471
370 @$registry = (); 472 @$registry = ();
371 473
474 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
475
372 for my $name (@{ $obj->{_attachment} }) { 476 for my $name (keys %{ $obj->{_attachment} || {} }) {
373 if (my $attach = $attachment{$name}) { 477 if (my $attach = $attachment{$name}) {
374 for (@$attach) { 478 for (@$attach) {
375 my ($klass, @attach) = @$_; 479 my ($klass, @attach) = @$_;
376 _attach @$registry, $klass, @attach; 480 _attach @$registry, $klass, @attach;
377 } 481 }
380 } 484 }
381 } 485 }
382} 486}
383 487
384sub object_freezer_save { 488sub object_freezer_save {
385 my ($filename, $objs) = @_; 489 my ($filename, $rdata, $objs) = @_;
386 490
387 $filename .= ".pst"; 491 if (length $$rdata) {
492 warn sprintf "saving %s (%d,%d)\n",
493 $filename, length $$rdata, scalar @$objs;
388 494
389 if (@$objs) {
390 open my $fh, ">:raw", "$filename~"; 495 if (open my $fh, ">:raw", "$filename~") {
391 chmod $fh, SAVE_MODE; 496 chmod SAVE_MODE, $fh;
497 syswrite $fh, $$rdata;
498 close $fh;
499
500 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
501 chmod SAVE_MODE, $fh;
392 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 502 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
393 close $fh; 503 close $fh;
504 rename "$filename.pst~", "$filename.pst";
505 } else {
506 unlink "$filename.pst";
507 }
508
394 rename "$filename~", $filename; 509 rename "$filename~", $filename;
510 } else {
511 warn "FATAL: $filename~: $!\n";
512 }
395 } else { 513 } else {
396 unlink $filename; 514 unlink $filename;
515 unlink "$filename.pst";
397 } 516 }
398} 517}
399 518
400sub object_thawer_load { 519sub object_thawer_load {
401 my ($filename) = @_; 520 my ($filename) = @_;
402 521
522 local $/;
523
524 my $av;
525
526 #TODO: use sysread etc.
527 if (open my $data, "<:raw:perlio", $filename) {
528 $data = <$data>;
403 open my $fh, "<:raw:perlio", "$filename.pst" 529 if (open my $pst, "<:raw:perlio", "$filename.pst") {
404 or return; 530 $av = eval { (Storable::thaw <$pst>)->{objs} };
531 }
532 return ($data, $av);
533 }
405 534
406 eval { local $/; (Storable::thaw <$fh>)->{objs} } 535 ()
407} 536}
408 537
409attach_to_objects 538attach_to_objects
410 prio => -1000000, 539 prio => -1000000,
411 on_clone => sub { 540 on_clone => sub {
413 542
414 @{$dst->registry} = @{$src->registry}; 543 @{$dst->registry} = @{$src->registry};
415 544
416 %$dst = %$src; 545 %$dst = %$src;
417 546
418 $dst->{_attachment} = [@{ $src->{_attachment} }] 547 %{$dst->{_attachment}} = %{$src->{_attachment}}
419 if exists $src->{_attachment}; 548 if exists $src->{_attachment};
420 }, 549 },
421; 550;
422 551
423############################################################################# 552#############################################################################
557 load_extension $ext; 686 load_extension $ext;
558 1 687 1
559 } or warn "$ext not loaded: $@"; 688 } or warn "$ext not loaded: $@";
560 } 689 }
561} 690}
562
563sub _perl_reload(&) {
564 my ($msg) = @_;
565
566 $msg->("reloading...");
567
568 eval {
569 # 1. cancel all watchers
570 $_->cancel for Event::all_watchers;
571
572 # 2. unload all extensions
573 for (@exts) {
574 $msg->("unloading <$_>");
575 unload_extension $_;
576 }
577
578 # 3. unload all modules loaded from $LIBDIR
579 while (my ($k, $v) = each %INC) {
580 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
581
582 $msg->("removing <$k>");
583 delete $INC{$k};
584
585 $k =~ s/\.pm$//;
586 $k =~ s/\//::/g;
587
588 if (my $cb = $k->can ("unload_module")) {
589 $cb->();
590 }
591
592 Symbol::delete_package $k;
593 }
594
595 # 4. get rid of safe::, as good as possible
596 Symbol::delete_package "safe::$_"
597 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
598
599 # 5. remove register_script_function callbacks
600 # TODO
601
602 # 6. unload cf.pm "a bit"
603 delete $INC{"cf.pm"};
604
605 # don't, removes xs symbols, too,
606 # and global variables created in xs
607 #Symbol::delete_package __PACKAGE__;
608
609 # 7. reload cf.pm
610 $msg->("reloading cf.pm");
611 require cf;
612 };
613 $msg->($@) if $@;
614
615 $msg->("reloaded");
616};
617
618sub perl_reload() {
619 _perl_reload {
620 warn $_[0];
621 print "$_[0]\n";
622 };
623}
624
625register_command "perl-reload", 0, sub {
626 my ($who, $arg) = @_;
627
628 if ($who->flag (FLAG_WIZ)) {
629 _perl_reload {
630 warn $_[0];
631 $who->message ($_[0]);
632 };
633 }
634};
635 691
636############################################################################# 692#############################################################################
637# extcmd framework, basically convert ext <msg> 693# extcmd framework, basically convert ext <msg>
638# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 694# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
639 695
664 my ($map) = @_; 720 my ($map) = @_;
665 721
666 my $path = $map->tmpname; 722 my $path = $map->tmpname;
667 defined $path or return; 723 defined $path or return;
668 724
669 unlink "$path.cfperl";
670 unlink "$path.pst"; 725 unlink "$path.pst";
671}; 726};
672 727
673*cf::mapsupport::on_swapin =
674*cf::mapsupport::on_load = sub {
675 my ($map) = @_;
676
677 my $path = $map->tmpname;
678 $path = $map->path unless defined $path;
679
680 open my $fh, "<:raw", "$path.cfperl"
681 or return; # no perl data
682
683 my $data = Storable::thaw do { local $/; <$fh> };
684
685 $data->{version} <= 1
686 or return; # too new
687
688 $map->_set_obs ($data->{obs});
689};
690
691attach_to_maps prio => -10000, package => cf::mapsupport::; 728attach_to_maps prio => -10000, package => cf::mapsupport::;
692 729
693############################################################################# 730#############################################################################
694# load/save perl data associated with player->ob objects 731# load/save perl data associated with player->ob objects
695 732
696sub all_objects(@) { 733sub all_objects(@) {
697 @_, map all_objects ($_->inv), @_ 734 @_, map all_objects ($_->inv), @_
698} 735}
699 736
737# TODO: compatibility cruft, remove when no longer needed
700attach_to_players 738attach_to_players
701 on_load => sub { 739 on_load => sub {
702 my ($pl, $path) = @_; 740 my ($pl, $path) = @_;
703 741
704 for my $o (all_objects $pl->ob) { 742 for my $o (all_objects $pl->ob) {
710 } 748 }
711 }, 749 },
712; 750;
713 751
714############################################################################# 752#############################################################################
715# core extensions - in perl 753
754=head2 CORE EXTENSIONS
755
756Functions and methods that extend core crossfire objects.
757
758=over 4
716 759
717=item cf::player::exists $login 760=item cf::player::exists $login
718 761
719Returns true when the given account exists. 762Returns true when the given account exists.
720 763
760 $msg{msgid} = $id; 803 $msg{msgid} = $id;
761 804
762 $self->send ("ext " . to_json \%msg); 805 $self->send ("ext " . to_json \%msg);
763} 806}
764 807
808=back
809
810=cut
811
765############################################################################# 812#############################################################################
766# map scripting support 813
814=head2 SAFE SCRIPTING
815
816Functions that provide a safe environment to compile and execute
817snippets of perl code without them endangering the safety of the server
818itself. Looping constructs, I/O operators and other built-in functionality
819is not available in the safe scripting environment, and the number of
820functions and methods that cna be called is greatly reduced.
821
822=cut
767 823
768our $safe = new Safe "safe"; 824our $safe = new Safe "safe";
769our $safe_hole = new Safe::Hole; 825our $safe_hole = new Safe::Hole;
770 826
771$SIG{FPE} = 'IGNORE'; 827$SIG{FPE} = 'IGNORE';
772 828
773$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 829$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
774 830
775# here we export the classes and methods available to script code 831# here we export the classes and methods available to script code
832
833=pod
834
835The following fucntions and emthods are available within a safe environment:
836
837 cf::object contr pay_amount pay_player
838 cf::object::player player
839 cf::player peaceful
840
841=cut
776 842
777for ( 843for (
778 ["cf::object" => qw(contr pay_amount pay_player)], 844 ["cf::object" => qw(contr pay_amount pay_player)],
779 ["cf::object::player" => qw(player)], 845 ["cf::object::player" => qw(player)],
780 ["cf::player" => qw(peaceful)], 846 ["cf::player" => qw(peaceful)],
783 my ($pkg, @funs) = @$_; 849 my ($pkg, @funs) = @$_;
784 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 850 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
785 for @funs; 851 for @funs;
786} 852}
787 853
854=over 4
855
856=item @retval = safe_eval $code, [var => value, ...]
857
858Compiled and executes the given perl code snippet. additional var/value
859pairs result in temporary local (my) scalar variables of the given name
860that are available in the code snippet. Example:
861
862 my $five = safe_eval '$first + $second', first => 1, second => 4;
863
864=cut
865
788sub safe_eval($;@) { 866sub safe_eval($;@) {
789 my ($code, %vars) = @_; 867 my ($code, %vars) = @_;
790 868
791 my $qcode = $code; 869 my $qcode = $code;
792 $qcode =~ s/"/‟/g; # not allowed in #line filenames 870 $qcode =~ s/"/‟/g; # not allowed in #line filenames
814 } 892 }
815 893
816 wantarray ? @res : $res[0] 894 wantarray ? @res : $res[0]
817} 895}
818 896
897=item cf::register_script_function $function => $cb
898
899Register a function that can be called from within map/npc scripts. The
900function should be reasonably secure and should be put into a package name
901like the extension.
902
903Example: register a function that gets called whenever a map script calls
904C<rent::overview>, as used by the C<rent> extension.
905
906 cf::register_script_function "rent::overview" => sub {
907 ...
908 };
909
910=cut
911
819sub register_script_function { 912sub register_script_function {
820 my ($fun, $cb) = @_; 913 my ($fun, $cb) = @_;
821 914
822 no strict 'refs'; 915 no strict 'refs';
823 *{"safe::$fun"} = $safe_hole->wrap ($cb); 916 *{"safe::$fun"} = $safe_hole->wrap ($cb);
824} 917}
825 918
919=back
920
921=cut
922
923#############################################################################
924
925=head2 EXTENSION DATABASE SUPPORT
926
927Crossfire maintains a very simple database for extension use. It can
928currently store anything that can be serialised using Storable, which
929excludes objects.
930
931The parameter C<$family> should best start with the name of the extension
932using it, it should be unique.
933
934=over 4
935
936=item $hashref = cf::db_get $family
937
938Return a hashref for use by the extension C<$family>, which can be
939modified. After modifications, you have to call C<cf::db_dirty> or
940C<cf::db_sync>.
941
942=item $value = cf::db_get $family => $key
943
944Returns a single value from the database
945
946=item cf::db_put $family => $hashref
947
948Stores the given family hashref into the database. Updates are delayed, if
949you want the data to be synced to disk immediately, use C<cf::db_sync>.
950
951=item cf::db_put $family => $key => $value
952
953Stores the given C<$value> in the family hash. Updates are delayed, if you
954want the data to be synced to disk immediately, use C<cf::db_sync>.
955
956=item cf::db_dirty
957
958Marks the database as dirty, to be updated at a later time.
959
960=item cf::db_sync
961
962Immediately write the database to disk I<if it is dirty>.
963
964=cut
965
966{
967 my $db;
968 my $path = cf::localdir . "/database.pst";
969
970 sub db_load() {
971 warn "loading database $path\n";#d# remove later
972 $db = stat $path ? Storable::retrieve $path : { };
973 }
974
975 my $pid;
976
977 sub db_save() {
978 warn "saving database $path\n";#d# remove later
979 waitpid $pid, 0 if $pid;
980 if (0 == ($pid = fork)) {
981 $db->{_meta}{version} = 1;
982 Storable::nstore $db, "$path~";
983 rename "$path~", $path;
984 cf::_exit 0 if defined $pid;
985 }
986 }
987
988 my $dirty;
989
990 sub db_sync() {
991 db_save if $dirty;
992 undef $dirty;
993 }
994
995 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
996 db_sync;
997 });
998
999 sub db_dirty() {
1000 $dirty = 1;
1001 $idle->start;
1002 }
1003
1004 sub db_get($;$) {
1005 @_ >= 2
1006 ? $db->{$_[0]}{$_[1]}
1007 : ($db->{$_[0]} ||= { })
1008 }
1009
1010 sub db_put($$;$) {
1011 if (@_ >= 3) {
1012 $db->{$_[0]}{$_[1]} = $_[2];
1013 } else {
1014 $db->{$_[0]} = $_[1];
1015 }
1016 db_dirty;
1017 }
1018
1019 attach_global
1020 prio => 10000,
1021 on_cleanup => sub {
1022 db_sync;
1023 },
1024 ;
1025}
1026
826############################################################################# 1027#############################################################################
827# the server's main() 1028# the server's main()
828 1029
829sub main { 1030sub main {
1031 db_load;
1032 load_extensions;
830 Event::loop; 1033 Event::loop;
831} 1034}
832 1035
833############################################################################# 1036#############################################################################
834# initialisation 1037# initialisation
835 1038
1039sub _perl_reload(&) {
1040 my ($msg) = @_;
1041
1042 $msg->("reloading...");
1043
1044 eval {
1045 # cancel all watchers
1046 $_->cancel for Event::all_watchers;
1047
1048 # unload all extensions
1049 for (@exts) {
1050 $msg->("unloading <$_>");
1051 unload_extension $_;
1052 }
1053
1054 # unload all modules loaded from $LIBDIR
1055 while (my ($k, $v) = each %INC) {
1056 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1057
1058 $msg->("removing <$k>");
1059 delete $INC{$k};
1060
1061 $k =~ s/\.pm$//;
1062 $k =~ s/\//::/g;
1063
1064 if (my $cb = $k->can ("unload_module")) {
1065 $cb->();
1066 }
1067
1068 Symbol::delete_package $k;
1069 }
1070
1071 # sync database to disk
1072 cf::db_sync;
1073
1074 # get rid of safe::, as good as possible
1075 Symbol::delete_package "safe::$_"
1076 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1077
1078 # remove register_script_function callbacks
1079 # TODO
1080
1081 # unload cf.pm "a bit"
1082 delete $INC{"cf.pm"};
1083
1084 # don't, removes xs symbols, too,
1085 # and global variables created in xs
1086 #Symbol::delete_package __PACKAGE__;
1087
1088 # reload cf.pm
1089 $msg->("reloading cf.pm");
1090 require cf;
1091
1092 # load database again
1093 cf::db_load;
1094
1095 # load extensions
1096 $msg->("load extensions");
1097 cf::load_extensions;
1098
1099 # reattach attachments to objects
1100 $msg->("reattach");
1101 _global_reattach;
1102 };
1103 $msg->($@) if $@;
1104
1105 $msg->("reloaded");
1106};
1107
1108sub perl_reload() {
1109 _perl_reload {
1110 warn $_[0];
1111 print "$_[0]\n";
1112 };
1113}
1114
1115register_command "perl-reload", 0, sub {
1116 my ($who, $arg) = @_;
1117
1118 if ($who->flag (FLAG_WIZ)) {
1119 _perl_reload {
1120 warn $_[0];
1121 $who->message ($_[0]);
1122 };
1123 }
1124};
1125
836register "<global>", __PACKAGE__; 1126register "<global>", __PACKAGE__;
837 1127
838unshift @INC, $LIBDIR; 1128unshift @INC, $LIBDIR;
839
840load_extensions;
841 1129
842$TICK_WATCHER = Event->timer ( 1130$TICK_WATCHER = Event->timer (
843 prio => 1, 1131 prio => 1,
844 at => $NEXT_TICK || 1, 1132 at => $NEXT_TICK || 1,
845 cb => sub { 1133 cb => sub {
854 $TICK_WATCHER->at ($NEXT_TICK); 1142 $TICK_WATCHER->at ($NEXT_TICK);
855 $TICK_WATCHER->start; 1143 $TICK_WATCHER->start;
856 }, 1144 },
857); 1145);
858 1146
859_reload_2;
860
8611 11471
862 1148

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines