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.82 by root, Sun Dec 3 20:59:52 2006 UTC

5use Storable; 5use Storable;
6use Opcode; 6use Opcode;
7use Safe; 7use Safe;
8use Safe::Hole; 8use Safe::Hole;
9 9
10use IO::AIO ();
11use YAML::Syck ();
10use Time::HiRes; 12use Time::HiRes;
11use Event; 13use Event;
12$Event::Eval = 1; # no idea why this is required, but it is 14$Event::Eval = 1; # no idea why this is required, but it is
13 15
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1;
18
14use strict; 19use strict;
15 20
16_reload_1; 21_init_vars;
17 22
18our %COMMAND = (); 23our %COMMAND = ();
19our @EVENT; 24our @EVENT;
20our %PROP_TYPE;
21our %PROP_IDX;
22our $LIBDIR = maps_directory "perl"; 25our $LIBDIR = maps_directory "perl";
23 26
24our $TICK = MAX_TIME * 1e-6; 27our $TICK = MAX_TIME * 1e-6;
25our $TICK_WATCHER; 28our $TICK_WATCHER;
26our $NEXT_TICK; 29our $NEXT_TICK;
30
31our %CFG;
32
33our $uptime;
34
35$uptime ||= time;
36
37#############################################################################
38
39=head2 GLOBAL VARIABLES
40
41=over 4
42
43=item $cf::LIBDIR
44
45The perl library directory, where extensions and cf-specific modules can
46be found. It will be added to C<@INC> automatically.
47
48=item $cf::TICK
49
50The interval between server ticks, in seconds.
51
52=item %cf::CFG
53
54Configuration for the server, loaded from C</etc/crossfire/config>, or
55from wherever your confdir points to.
56
57=back
58
59=cut
27 60
28BEGIN { 61BEGIN {
29 *CORE::GLOBAL::warn = sub { 62 *CORE::GLOBAL::warn = sub {
30 my $msg = join "", @_; 63 my $msg = join "", @_;
31 $msg .= "\n" 64 $msg .= "\n"
34 print STDERR "cfperl: $msg"; 67 print STDERR "cfperl: $msg";
35 LOG llevError, "cfperl: $msg"; 68 LOG llevError, "cfperl: $msg";
36 }; 69 };
37} 70}
38 71
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'; 72@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
74 73
75# we bless all objects into (empty) derived classes to force a method lookup 74# we bless all objects into (empty) derived classes to force a method lookup
76# within the Safe compartment. 75# 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)) { 76for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
87my @exts; 86my @exts;
88my @hook; 87my @hook;
89my %command; 88my %command;
90my %extcmd; 89my %extcmd;
91 90
92############################################################################# 91=head2 UTILITY FUNCTIONS
93# utility functions 92
93=over 4
94
95=cut
94 96
95use JSON::Syck (); # TODO# replace by JSON::PC once working 97use JSON::Syck (); # TODO# replace by JSON::PC once working
98
99=item $ref = cf::from_json $json
100
101Converts a JSON string into the corresponding perl data structure.
102
103=cut
96 104
97sub from_json($) { 105sub from_json($) {
98 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs 106 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
99 JSON::Syck::Load $_[0] 107 JSON::Syck::Load $_[0]
100} 108}
101 109
110=item $json = cf::to_json $ref
111
112Converts a perl data structure into its JSON representation.
113
114=cut
115
102sub to_json($) { 116sub to_json($) {
103 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 117 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
104 JSON::Syck::Dump $_[0] 118 JSON::Syck::Dump $_[0]
105} 119}
106 120
121=back
122
123=cut
124
107############################################################################# 125#############################################################################
108# "new" plug-in system 126
127=head2 EVENTS AND OBJECT ATTACHMENTS
128
129=over 4
109 130
110=item $object->attach ($attachment, key => $value...) 131=item $object->attach ($attachment, key => $value...)
111 132
133=item $object->detach ($attachment)
134
112Attach a pre-registered attachment to an object. 135Attach/detach a pre-registered attachment to an object.
113 136
114=item $player->attach ($attachment, key => $value...) 137=item $player->attach ($attachment, key => $value...)
115 138
139=item $player->detach ($attachment)
140
116Attach a pre-registered attachment to a player. 141Attach/detach a pre-registered attachment to a player.
117 142
118=item $map->attach ($attachment, key => $value...) # not yet persistent 143=item $map->attach ($attachment, key => $value...)
119 144
145=item $map->detach ($attachment)
146
120Attach a pre-registered attachment to a map. 147Attach/detach a pre-registered attachment to a map.
148
149=item $bool = $object->attached ($name)
150
151=item $bool = $player->attached ($name)
152
153=item $bool = $map->attached ($name)
154
155Checks wether the named attachment is currently attached to the object.
121 156
122=item cf::attach_global ... 157=item cf::attach_global ...
123 158
124Attach handlers for global events. 159Attach handlers for global events.
125 160
175Attach handlers to all maps. 210Attach handlers to all maps.
176 211
177=item cf:register_attachment $name, ... 212=item cf:register_attachment $name, ...
178 213
179Register an attachment by name through which objects can refer to this 214Register an attachment by name through which objects can refer to this
215attachment.
216
217=item cf:register_player_attachment $name, ...
218
219Register an attachment by name through which players can refer to this
180attachment. 220attachment.
181 221
182=item cf:register_map_attachment $name, ... 222=item cf:register_map_attachment $name, ...
183 223
184Register an attachment by name through which maps can refer to this 224Register an attachment by name through which maps can refer to this
255} 295}
256 296
257sub _attach_attachment { 297sub _attach_attachment {
258 my ($obj, $name, %arg) = @_; 298 my ($obj, $name, %arg) = @_;
259 299
300 return if exists $obj->{_attachment}{$name};
301
260 my $res; 302 my $res;
261 303
262 if (my $attach = $attachment{$name}) { 304 if (my $attach = $attachment{$name}) {
263 my $registry = $obj->registry; 305 my $registry = $obj->registry;
264 306
276 318
277 $res->{attachment} = $name; 319 $res->{attachment} = $name;
278 $res 320 $res
279} 321}
280 322
281sub cf::object::attach { 323*cf::object::attach =
324*cf::player::attach =
325*cf::map::attach = sub {
282 my ($obj, $name, %arg) = @_; 326 my ($obj, $name, %arg) = @_;
283 327
284 _attach_attachment $obj, $name, %arg; 328 _attach_attachment $obj, $name, %arg;
285} 329};
286 330
331# all those should be optimised
332*cf::object::detach =
287sub cf::player::attach { 333*cf::player::detach =
334*cf::map::detach = sub {
288 my ($obj, $name, %arg) = @_; 335 my ($obj, $name) = @_;
289 336
290 _attach_attachment $obj, $name, %arg; 337 delete $obj->{_attachment}{$name};
291} 338 reattach ($obj);
339};
292 340
293sub cf::map::attach { 341*cf::object::attached =
342*cf::player::attached =
343*cf::map::attached = sub {
294 my ($obj, $name, %arg) = @_; 344 my ($obj, $name) = @_;
295 345
296 _attach_attachment $obj, $name, %arg; 346 exists $obj->{_attachment}{$name}
297} 347};
298 348
299sub attach_global { 349sub attach_global {
300 _attach @CB_GLOBAL, KLASS_GLOBAL, @_ 350 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
301} 351}
302 352
323 my $name = shift; 373 my $name = shift;
324 374
325 $attachment{$name} = [[KLASS_OBJECT, @_]]; 375 $attachment{$name} = [[KLASS_OBJECT, @_]];
326} 376}
327 377
378sub register_player_attachment {
379 my $name = shift;
380
381 $attachment{$name} = [[KLASS_PLAYER, @_]];
382}
383
328sub register_map_attachment { 384sub register_map_attachment {
329 my $name = shift; 385 my $name = shift;
330 386
331 $attachment{$name} = [[KLASS_MAP, @_]]; 387 $attachment{$name} = [[KLASS_MAP, @_]];
332} 388}
350 for (@$callbacks) { 406 for (@$callbacks) {
351 eval { &{$_->[1]} }; 407 eval { &{$_->[1]} };
352 408
353 if ($@) { 409 if ($@) {
354 warn "$@"; 410 warn "$@";
355 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 411 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
356 override; 412 override;
357 } 413 }
358 414
359 return 1 if $override; 415 return 1 if $override;
360 } 416 }
361 417
362 0 418 0
363} 419}
420
421=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
422
423=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
424
425=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
426
427=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
428
429Generate a global/object/player/map-specific event with the given arguments.
430
431This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
432removed in future versions), and there is no public API to access override
433results (if you must, access C<@cf::invoke_results> directly).
434
435=back
436
437=cut
438
439#############################################################################
440
441=head2 METHODS VALID FOR ALL CORE OBJECTS
442
443=over 4
444
445=item $object->valid, $player->valid, $map->valid
446
447Just because you have a perl object does not mean that the corresponding
448C-level object still exists. If you try to access an object that has no
449valid C counterpart anymore you get an exception at runtime. This method
450can be used to test for existence of the C object part without causing an
451exception.
452
453=back
454
455=cut
456
457*cf::object::valid =
458*cf::player::valid =
459*cf::map::valid = \&cf::_valid;
364 460
365############################################################################# 461#############################################################################
366# object support 462# object support
367 463
368sub instantiate { 464sub instantiate {
397 } 493 }
398 } 494 }
399} 495}
400 496
401sub object_freezer_save { 497sub object_freezer_save {
402 my ($filename, $objs) = @_; 498 my ($filename, $rdata, $objs) = @_;
403 499
404 if (@$objs) { 500 if (length $$rdata) {
501 warn sprintf "saving %s (%d,%d)\n",
502 $filename, length $$rdata, scalar @$objs;
503
405 open my $fh, ">:raw", "$filename.pst~"; 504 if (open my $fh, ">:raw", "$filename~") {
505 chmod SAVE_MODE, $fh;
506 syswrite $fh, $$rdata;
507 close $fh;
508
509 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
510 chmod SAVE_MODE, $fh;
406 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 511 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
407 close $fh; 512 close $fh;
408 chmod SAVE_MODE, "$filename.pst~";
409 rename "$filename.pst~", "$filename.pst"; 513 rename "$filename.pst~", "$filename.pst";
514 } else {
515 unlink "$filename.pst";
516 }
517
518 rename "$filename~", $filename;
519 } else {
520 warn "FATAL: $filename~: $!\n";
521 }
410 } else { 522 } else {
523 unlink $filename;
411 unlink "$filename.pst"; 524 unlink "$filename.pst";
412 } 525 }
526}
413 527
414 chmod SAVE_MODE, "$filename~"; 528sub object_freezer_as_string {
415 rename "$filename~", $filename; 529 my ($rdata, $objs) = @_;
530
531 use Data::Dumper;
532
533 $$rdata . Dumper $objs
416} 534}
417 535
418sub object_thawer_load { 536sub object_thawer_load {
419 my ($filename) = @_; 537 my ($filename) = @_;
420 538
539 local $/;
540
541 my $av;
542
543 #TODO: use sysread etc.
544 if (open my $data, "<:raw:perlio", $filename) {
545 $data = <$data>;
421 open my $fh, "<:raw:perlio", "$filename.pst" 546 if (open my $pst, "<:raw:perlio", "$filename.pst") {
422 or return; 547 $av = eval { (Storable::thaw <$pst>)->{objs} };
548 }
549 return ($data, $av);
550 }
423 551
424 eval { local $/; (Storable::thaw <$fh>)->{objs} } 552 ()
425} 553}
426 554
427attach_to_objects 555attach_to_objects
428 prio => -1000000, 556 prio => -1000000,
429 on_clone => sub { 557 on_clone => sub {
514 . "#line 1 \"$path\"\n{\n" 642 . "#line 1 \"$path\"\n{\n"
515 . (do { local $/; <$fh> }) 643 . (do { local $/; <$fh> })
516 . "\n};\n1"; 644 . "\n};\n1";
517 645
518 eval $source 646 eval $source
519 or die "$path: $@"; 647 or die $@ ? "$path: $@\n"
648 : "extension disabled.\n";
520 649
521 push @exts, $pkg; 650 push @exts, $pkg;
522 $ext_pkg{$base} = $pkg; 651 $ext_pkg{$base} = $pkg;
523 652
524# no strict 'refs'; 653# no strict 'refs';
575 load_extension $ext; 704 load_extension $ext;
576 1 705 1
577 } or warn "$ext not loaded: $@"; 706 } or warn "$ext not loaded: $@";
578 } 707 }
579} 708}
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 709
654############################################################################# 710#############################################################################
655# extcmd framework, basically convert ext <msg> 711# extcmd framework, basically convert ext <msg>
656# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 712# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
657 713
685 defined $path or return; 741 defined $path or return;
686 742
687 unlink "$path.pst"; 743 unlink "$path.pst";
688}; 744};
689 745
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::; 746attach_to_maps prio => -10000, package => cf::mapsupport::;
711 747
712############################################################################# 748#############################################################################
713# load/save perl data associated with player->ob objects 749# load/save perl data associated with player->ob objects
714 750
715sub all_objects(@) { 751sub all_objects(@) {
716 @_, map all_objects ($_->inv), @_ 752 @_, map all_objects ($_->inv), @_
717} 753}
718 754
755# TODO: compatibility cruft, remove when no longer needed
719attach_to_players 756attach_to_players
720 on_load => sub { 757 on_load => sub {
721 my ($pl, $path) = @_; 758 my ($pl, $path) = @_;
722 759
723 for my $o (all_objects $pl->ob) { 760 for my $o (all_objects $pl->ob) {
729 } 766 }
730 }, 767 },
731; 768;
732 769
733############################################################################# 770#############################################################################
734# core extensions - in perl 771
772=head2 CORE EXTENSIONS
773
774Functions and methods that extend core crossfire objects.
775
776=over 4
735 777
736=item cf::player::exists $login 778=item cf::player::exists $login
737 779
738Returns true when the given account exists. 780Returns true when the given account exists.
739 781
742sub cf::player::exists($) { 784sub cf::player::exists($) {
743 cf::player::find $_[0] 785 cf::player::find $_[0]
744 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 786 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
745} 787}
746 788
747=item $player->reply ($npc, $msg[, $flags]) 789=item $player_object->reply ($npc, $msg[, $flags])
748 790
749Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 791Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
750can be C<undef>. Does the right thing when the player is currently in a 792can be C<undef>. Does the right thing when the player is currently in a
751dialogue with the given NPC character. 793dialogue with the given NPC character.
752 794
779 $msg{msgid} = $id; 821 $msg{msgid} = $id;
780 822
781 $self->send ("ext " . to_json \%msg); 823 $self->send ("ext " . to_json \%msg);
782} 824}
783 825
826=item $player_object->may ("access")
827
828Returns wether the given player is authorized to access resource "access"
829(e.g. "command_wizcast").
830
831=cut
832
833sub cf::object::player::may {
834 my ($self, $access) = @_;
835
836 $self->flag (cf::FLAG_WIZ) ||
837 (ref $cf::CFG{"may_$access"}
838 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839 : $cf::CFG{"may_$access"})
840}
841
842=cut
843
784############################################################################# 844#############################################################################
785# map scripting support 845
846=head2 SAFE SCRIPTING
847
848Functions that provide a safe environment to compile and execute
849snippets of perl code without them endangering the safety of the server
850itself. Looping constructs, I/O operators and other built-in functionality
851is not available in the safe scripting environment, and the number of
852functions and methods that can be called is greatly reduced.
853
854=cut
786 855
787our $safe = new Safe "safe"; 856our $safe = new Safe "safe";
788our $safe_hole = new Safe::Hole; 857our $safe_hole = new Safe::Hole;
789 858
790$SIG{FPE} = 'IGNORE'; 859$SIG{FPE} = 'IGNORE';
791 860
792$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 861$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
793 862
794# here we export the classes and methods available to script code 863# here we export the classes and methods available to script code
864
865=pod
866
867The following fucntions and emthods are available within a safe environment:
868
869 cf::object contr pay_amount pay_player
870 cf::object::player player
871 cf::player peaceful
872
873=cut
795 874
796for ( 875for (
797 ["cf::object" => qw(contr pay_amount pay_player)], 876 ["cf::object" => qw(contr pay_amount pay_player)],
798 ["cf::object::player" => qw(player)], 877 ["cf::object::player" => qw(player)],
799 ["cf::player" => qw(peaceful)], 878 ["cf::player" => qw(peaceful)],
802 my ($pkg, @funs) = @$_; 881 my ($pkg, @funs) = @$_;
803 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 882 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
804 for @funs; 883 for @funs;
805} 884}
806 885
886=over 4
887
888=item @retval = safe_eval $code, [var => value, ...]
889
890Compiled and executes the given perl code snippet. additional var/value
891pairs result in temporary local (my) scalar variables of the given name
892that are available in the code snippet. Example:
893
894 my $five = safe_eval '$first + $second', first => 1, second => 4;
895
896=cut
897
807sub safe_eval($;@) { 898sub safe_eval($;@) {
808 my ($code, %vars) = @_; 899 my ($code, %vars) = @_;
809 900
810 my $qcode = $code; 901 my $qcode = $code;
811 $qcode =~ s/"/‟/g; # not allowed in #line filenames 902 $qcode =~ s/"/‟/g; # not allowed in #line filenames
833 } 924 }
834 925
835 wantarray ? @res : $res[0] 926 wantarray ? @res : $res[0]
836} 927}
837 928
929=item cf::register_script_function $function => $cb
930
931Register a function that can be called from within map/npc scripts. The
932function should be reasonably secure and should be put into a package name
933like the extension.
934
935Example: register a function that gets called whenever a map script calls
936C<rent::overview>, as used by the C<rent> extension.
937
938 cf::register_script_function "rent::overview" => sub {
939 ...
940 };
941
942=cut
943
838sub register_script_function { 944sub register_script_function {
839 my ($fun, $cb) = @_; 945 my ($fun, $cb) = @_;
840 946
841 no strict 'refs'; 947 no strict 'refs';
842 *{"safe::$fun"} = $safe_hole->wrap ($cb); 948 *{"safe::$fun"} = $safe_hole->wrap ($cb);
843} 949}
844 950
951=back
952
953=cut
954
955#############################################################################
956
957=head2 EXTENSION DATABASE SUPPORT
958
959Crossfire maintains a very simple database for extension use. It can
960currently store anything that can be serialised using Storable, which
961excludes objects.
962
963The parameter C<$family> should best start with the name of the extension
964using it, it should be unique.
965
966=over 4
967
968=item $hashref = cf::db_get $family
969
970Return a hashref for use by the extension C<$family>, which can be
971modified. After modifications, you have to call C<cf::db_dirty> or
972C<cf::db_sync>.
973
974=item $value = cf::db_get $family => $key
975
976Returns a single value from the database
977
978=item cf::db_put $family => $hashref
979
980Stores the given family hashref into the database. Updates are delayed, if
981you want the data to be synced to disk immediately, use C<cf::db_sync>.
982
983=item cf::db_put $family => $key => $value
984
985Stores the given C<$value> in the family hash. Updates are delayed, if you
986want the data to be synced to disk immediately, use C<cf::db_sync>.
987
988=item cf::db_dirty
989
990Marks the database as dirty, to be updated at a later time.
991
992=item cf::db_sync
993
994Immediately write the database to disk I<if it is dirty>.
995
996=cut
997
998our $DB;
999
1000{
1001 my $path = cf::localdir . "/database.pst";
1002
1003 sub db_load() {
1004 warn "loading database $path\n";#d# remove later
1005 $DB = stat $path ? Storable::retrieve $path : { };
1006 }
1007
1008 my $pid;
1009
1010 sub db_save() {
1011 warn "saving database $path\n";#d# remove later
1012 waitpid $pid, 0 if $pid;
1013 if (0 == ($pid = fork)) {
1014 $DB->{_meta}{version} = 1;
1015 Storable::nstore $DB, "$path~";
1016 rename "$path~", $path;
1017 cf::_exit 0 if defined $pid;
1018 }
1019 }
1020
1021 my $dirty;
1022
1023 sub db_sync() {
1024 db_save if $dirty;
1025 undef $dirty;
1026 }
1027
1028 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
1029 db_sync;
1030 });
1031
1032 sub db_dirty() {
1033 $dirty = 1;
1034 $idle->start;
1035 }
1036
1037 sub db_get($;$) {
1038 @_ >= 2
1039 ? $DB->{$_[0]}{$_[1]}
1040 : ($DB->{$_[0]} ||= { })
1041 }
1042
1043 sub db_put($$;$) {
1044 if (@_ >= 3) {
1045 $DB->{$_[0]}{$_[1]} = $_[2];
1046 } else {
1047 $DB->{$_[0]} = $_[1];
1048 }
1049 db_dirty;
1050 }
1051
1052 attach_global
1053 prio => 10000,
1054 on_cleanup => sub {
1055 db_sync;
1056 },
1057 ;
1058}
1059
845############################################################################# 1060#############################################################################
846# the server's main() 1061# the server's main()
847 1062
1063sub cfg_load {
1064 open my $fh, "<:utf8", cf::confdir . "/config"
1065 or return;
1066
1067 local $/;
1068 *CFG = YAML::Syck::Load <$fh>;
1069}
1070
848sub main { 1071sub main {
1072 cfg_load;
1073 db_load;
1074 load_extensions;
849 Event::loop; 1075 Event::loop;
850} 1076}
851 1077
852############################################################################# 1078#############################################################################
853# initialisation 1079# initialisation
854 1080
1081sub _perl_reload(&) {
1082 my ($msg) = @_;
1083
1084 $msg->("reloading...");
1085
1086 eval {
1087 # cancel all watchers
1088 $_->cancel for Event::all_watchers;
1089
1090 # unload all extensions
1091 for (@exts) {
1092 $msg->("unloading <$_>");
1093 unload_extension $_;
1094 }
1095
1096 # unload all modules loaded from $LIBDIR
1097 while (my ($k, $v) = each %INC) {
1098 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1099
1100 $msg->("removing <$k>");
1101 delete $INC{$k};
1102
1103 $k =~ s/\.pm$//;
1104 $k =~ s/\//::/g;
1105
1106 if (my $cb = $k->can ("unload_module")) {
1107 $cb->();
1108 }
1109
1110 Symbol::delete_package $k;
1111 }
1112
1113 # sync database to disk
1114 cf::db_sync;
1115
1116 # get rid of safe::, as good as possible
1117 Symbol::delete_package "safe::$_"
1118 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1119
1120 # remove register_script_function callbacks
1121 # TODO
1122
1123 # unload cf.pm "a bit"
1124 delete $INC{"cf.pm"};
1125
1126 # don't, removes xs symbols, too,
1127 # and global variables created in xs
1128 #Symbol::delete_package __PACKAGE__;
1129
1130 # reload cf.pm
1131 $msg->("reloading cf.pm");
1132 require cf;
1133
1134 # load config and database again
1135 cf::cfg_load;
1136 cf::db_load;
1137
1138 # load extensions
1139 $msg->("load extensions");
1140 cf::load_extensions;
1141
1142 # reattach attachments to objects
1143 $msg->("reattach");
1144 _global_reattach;
1145 };
1146 $msg->($@) if $@;
1147
1148 $msg->("reloaded");
1149};
1150
1151sub perl_reload() {
1152 _perl_reload {
1153 warn $_[0];
1154 print "$_[0]\n";
1155 };
1156}
1157
1158register_command "perl-reload", 0, sub {
1159 my ($who, $arg) = @_;
1160
1161 if ($who->flag (FLAG_WIZ)) {
1162 _perl_reload {
1163 warn $_[0];
1164 $who->message ($_[0]);
1165 };
1166 }
1167};
1168
855register "<global>", __PACKAGE__; 1169register "<global>", __PACKAGE__;
856 1170
857unshift @INC, $LIBDIR; 1171unshift @INC, $LIBDIR;
858 1172
859load_extensions;
860
861$TICK_WATCHER = Event->timer ( 1173$TICK_WATCHER = Event->timer (
862 prio => 1, 1174 prio => 1,
1175 async => 1,
863 at => $NEXT_TICK || 1, 1176 at => $NEXT_TICK || 1,
864 cb => sub { 1177 cb => sub {
865 cf::server_tick; # one server iteration 1178 cf::server_tick; # one server iteration
866 1179
867 my $NOW = Event::time; 1180 my $NOW = Event::time;
868 $NEXT_TICK += $TICK; 1181 $NEXT_TICK += $TICK;
869 1182
870 # if we are delayed by four ticks, skip them all 1183 # if we are delayed by four ticks or more, skip them all
871 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1184 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
872 1185
873 $TICK_WATCHER->at ($NEXT_TICK); 1186 $TICK_WATCHER->at ($NEXT_TICK);
874 $TICK_WATCHER->start; 1187 $TICK_WATCHER->start;
875 }, 1188 },
876); 1189);
877 1190
878_reload_2; 1191IO::AIO::max_poll_time $TICK * 0.2;
1192
1193Event->io (fd => IO::AIO::poll_fileno,
1194 poll => 'r',
1195 prio => 5,
1196 cb => \&IO::AIO::poll_cb);
879 1197
8801 11981
881 1199

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines