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.49 by root, Sun Aug 27 17:59:26 2006 UTC vs.
Revision 1.80 by root, Tue Nov 7 16:30:55 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)) { 76for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {
78 no strict 'refs'; 77 no strict 'refs';
79 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 78 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
80} 79}
81 80
82$Event::DIED = sub { 81$Event::DIED = sub {
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
173=item cf::attach_to_maps ... 208=item cf::attach_to_maps ...
174 209
175Attach handlers to all maps. 210Attach handlers to all maps.
176 211
177=item cf:register_attachment $name, ... 212=item cf:register_attachment $name, ...
213
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
220attachment.
221
222=item cf:register_map_attachment $name, ...
223
224Register an attachment by name through which maps can refer to this
225attachment.
178 226
179=cut 227=cut
180 228
181# the following variables are defined in .xs and must not be re-created 229# the following variables are defined in .xs and must not be re-created
182our @CB_GLOBAL = (); # registry for all global events 230our @CB_GLOBAL = (); # registry for all global events
247} 295}
248 296
249sub _attach_attachment { 297sub _attach_attachment {
250 my ($obj, $name, %arg) = @_; 298 my ($obj, $name, %arg) = @_;
251 299
300 return if exists $obj->{_attachment}{$name};
301
252 my $res; 302 my $res;
253 303
254 if (my $attach = $attachment{$name}) { 304 if (my $attach = $attachment{$name}) {
255 my $registry = $obj->registry; 305 my $registry = $obj->registry;
256 306
262 $obj->{$name} = \%arg; 312 $obj->{$name} = \%arg;
263 } else { 313 } else {
264 warn "object uses attachment '$name' that is not available, postponing.\n"; 314 warn "object uses attachment '$name' that is not available, postponing.\n";
265 } 315 }
266 316
267 push @{$obj->{_attachment}}, $name; 317 $obj->{_attachment}{$name} = undef;
268 318
269 $res->{attachment} = $name; 319 $res->{attachment} = $name;
270 $res 320 $res
271} 321}
272 322
273sub cf::object::attach { 323*cf::object::attach =
324*cf::player::attach =
325*cf::map::attach = sub {
274 my ($obj, $name, %arg) = @_; 326 my ($obj, $name, %arg) = @_;
275 327
276 _attach_attachment $obj, $name, %arg; 328 _attach_attachment $obj, $name, %arg;
277} 329};
278 330
331# all those should be optimised
332*cf::object::detach =
279sub cf::player::attach { 333*cf::player::detach =
334*cf::map::detach = sub {
280 my ($obj, $name, %arg) = @_; 335 my ($obj, $name) = @_;
281 336
282 _attach_attachment KLASS_PLAYER, $obj, $name, %arg; 337 delete $obj->{_attachment}{$name};
283} 338 reattach ($obj);
339};
284 340
285sub cf::map::attach { 341*cf::object::attached =
342*cf::player::attached =
343*cf::map::attached = sub {
286 my ($obj, $name, %arg) = @_; 344 my ($obj, $name) = @_;
287 345
288 _attach_attachment KLASS_MAP, $obj, $name, %arg; 346 exists $obj->{_attachment}{$name}
289} 347};
290 348
291sub attach_global { 349sub attach_global {
292 _attach @CB_GLOBAL, KLASS_GLOBAL, @_ 350 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
293} 351}
294 352
315 my $name = shift; 373 my $name = shift;
316 374
317 $attachment{$name} = [[KLASS_OBJECT, @_]]; 375 $attachment{$name} = [[KLASS_OBJECT, @_]];
318} 376}
319 377
378sub register_player_attachment {
379 my $name = shift;
380
381 $attachment{$name} = [[KLASS_PLAYER, @_]];
382}
383
384sub register_map_attachment {
385 my $name = shift;
386
387 $attachment{$name} = [[KLASS_MAP, @_]];
388}
389
320our $override; 390our $override;
321our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 391our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
322 392
323sub override { 393sub override {
324 $override = 1; 394 $override = 1;
336 for (@$callbacks) { 406 for (@$callbacks) {
337 eval { &{$_->[1]} }; 407 eval { &{$_->[1]} };
338 408
339 if ($@) { 409 if ($@) {
340 warn "$@"; 410 warn "$@";
341 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 411 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
342 override; 412 override;
343 } 413 }
344 414
345 return 1 if $override; 415 return 1 if $override;
346 } 416 }
347 417
348 0 418 0
349} 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;
350 460
351############################################################################# 461#############################################################################
352# object support 462# object support
353 463
354sub instantiate { 464sub instantiate {
368 my ($obj) = @_; 478 my ($obj) = @_;
369 my $registry = $obj->registry; 479 my $registry = $obj->registry;
370 480
371 @$registry = (); 481 @$registry = ();
372 482
373 delete $obj->{_attachment} unless @{ $obj->{_attachment} || [] }; 483 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
374 484
375 for my $name (@{ $obj->{_attachment} || [] }) { 485 for my $name (keys %{ $obj->{_attachment} || {} }) {
376 if (my $attach = $attachment{$name}) { 486 if (my $attach = $attachment{$name}) {
377 for (@$attach) { 487 for (@$attach) {
378 my ($klass, @attach) = @$_; 488 my ($klass, @attach) = @$_;
379 _attach @$registry, $klass, @attach; 489 _attach @$registry, $klass, @attach;
380 } 490 }
383 } 493 }
384 } 494 }
385} 495}
386 496
387sub object_freezer_save { 497sub object_freezer_save {
388 my ($filename, $objs) = @_; 498 my ($filename, $rdata, $objs) = @_;
389 499
390 $filename .= ".pst"; 500 if (length $$rdata) {
501 warn sprintf "saving %s (%d,%d)\n",
502 $filename, length $$rdata, scalar @$objs;
391 503
392 if (@$objs) {
393 open my $fh, ">:raw", "$filename~"; 504 if (open my $fh, ">:raw", "$filename~") {
394 chmod $fh, SAVE_MODE; 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;
395 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 511 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
396 close $fh; 512 close $fh;
513 rename "$filename.pst~", "$filename.pst";
514 } else {
515 unlink "$filename.pst";
516 }
517
397 rename "$filename~", $filename; 518 rename "$filename~", $filename;
519 } else {
520 warn "FATAL: $filename~: $!\n";
521 }
398 } else { 522 } else {
399 unlink $filename; 523 unlink $filename;
524 unlink "$filename.pst";
400 } 525 }
526}
527
528sub object_freezer_as_string {
529 my ($rdata, $objs) = @_;
530
531 use Data::Dumper;
532
533 "$$rdata\n" . Dumper $objs
401} 534}
402 535
403sub object_thawer_load { 536sub object_thawer_load {
404 my ($filename) = @_; 537 my ($filename) = @_;
405 538
539 local $/;
540
541 my $av;
542
543 #TODO: use sysread etc.
544 if (open my $data, "<:raw:perlio", $filename) {
545 $data = <$data>;
406 open my $fh, "<:raw:perlio", "$filename.pst" 546 if (open my $pst, "<:raw:perlio", "$filename.pst") {
407 or return; 547 $av = eval { (Storable::thaw <$pst>)->{objs} };
548 }
549 return ($data, $av);
550 }
408 551
409 eval { local $/; (Storable::thaw <$fh>)->{objs} } 552 ()
410} 553}
411 554
412attach_to_objects 555attach_to_objects
413 prio => -1000000, 556 prio => -1000000,
414 on_clone => sub { 557 on_clone => sub {
416 559
417 @{$dst->registry} = @{$src->registry}; 560 @{$dst->registry} = @{$src->registry};
418 561
419 %$dst = %$src; 562 %$dst = %$src;
420 563
421 $dst->{_attachment} = [@{ $src->{_attachment} }] 564 %{$dst->{_attachment}} = %{$src->{_attachment}}
422 if exists $src->{_attachment}; 565 if exists $src->{_attachment};
423 }, 566 },
424; 567;
425 568
426############################################################################# 569#############################################################################
560 load_extension $ext; 703 load_extension $ext;
561 1 704 1
562 } or warn "$ext not loaded: $@"; 705 } or warn "$ext not loaded: $@";
563 } 706 }
564} 707}
565
566sub _perl_reload(&) {
567 my ($msg) = @_;
568
569 $msg->("reloading...");
570
571 eval {
572 # 1. cancel all watchers
573 $_->cancel for Event::all_watchers;
574
575 # 2. unload all extensions
576 for (@exts) {
577 $msg->("unloading <$_>");
578 unload_extension $_;
579 }
580
581 # 3. unload all modules loaded from $LIBDIR
582 while (my ($k, $v) = each %INC) {
583 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
584
585 $msg->("removing <$k>");
586 delete $INC{$k};
587
588 $k =~ s/\.pm$//;
589 $k =~ s/\//::/g;
590
591 if (my $cb = $k->can ("unload_module")) {
592 $cb->();
593 }
594
595 Symbol::delete_package $k;
596 }
597
598 # 4. get rid of safe::, as good as possible
599 Symbol::delete_package "safe::$_"
600 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
601
602 # 5. remove register_script_function callbacks
603 # TODO
604
605 # 6. unload cf.pm "a bit"
606 delete $INC{"cf.pm"};
607
608 # don't, removes xs symbols, too,
609 # and global variables created in xs
610 #Symbol::delete_package __PACKAGE__;
611
612 # 7. reload cf.pm
613 $msg->("reloading cf.pm");
614 require cf;
615 };
616 $msg->($@) if $@;
617
618 $msg->("reloaded");
619};
620
621sub perl_reload() {
622 _perl_reload {
623 warn $_[0];
624 print "$_[0]\n";
625 };
626}
627
628register_command "perl-reload", 0, sub {
629 my ($who, $arg) = @_;
630
631 if ($who->flag (FLAG_WIZ)) {
632 _perl_reload {
633 warn $_[0];
634 $who->message ($_[0]);
635 };
636 }
637};
638 708
639############################################################################# 709#############################################################################
640# extcmd framework, basically convert ext <msg> 710# extcmd framework, basically convert ext <msg>
641# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 711# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
642 712
667 my ($map) = @_; 737 my ($map) = @_;
668 738
669 my $path = $map->tmpname; 739 my $path = $map->tmpname;
670 defined $path or return; 740 defined $path or return;
671 741
672 unlink "$path.cfperl";
673 unlink "$path.pst"; 742 unlink "$path.pst";
674}; 743};
675 744
676*cf::mapsupport::on_swapin =
677*cf::mapsupport::on_load = sub {
678 my ($map) = @_;
679
680 my $path = $map->tmpname;
681 $path = $map->path unless defined $path;
682
683 open my $fh, "<:raw", "$path.cfperl"
684 or return; # no perl data
685
686 my $data = Storable::thaw do { local $/; <$fh> };
687
688 $data->{version} <= 1
689 or return; # too new
690
691 $map->_set_obs ($data->{obs});
692};
693
694attach_to_maps prio => -10000, package => cf::mapsupport::; 745attach_to_maps prio => -10000, package => cf::mapsupport::;
695 746
696############################################################################# 747#############################################################################
697# load/save perl data associated with player->ob objects 748# load/save perl data associated with player->ob objects
698 749
699sub all_objects(@) { 750sub all_objects(@) {
700 @_, map all_objects ($_->inv), @_ 751 @_, map all_objects ($_->inv), @_
701} 752}
702 753
754# TODO: compatibility cruft, remove when no longer needed
703attach_to_players 755attach_to_players
704 on_load => sub { 756 on_load => sub {
705 my ($pl, $path) = @_; 757 my ($pl, $path) = @_;
706 758
707 for my $o (all_objects $pl->ob) { 759 for my $o (all_objects $pl->ob) {
713 } 765 }
714 }, 766 },
715; 767;
716 768
717############################################################################# 769#############################################################################
718# core extensions - in perl 770
771=head2 CORE EXTENSIONS
772
773Functions and methods that extend core crossfire objects.
774
775=over 4
719 776
720=item cf::player::exists $login 777=item cf::player::exists $login
721 778
722Returns true when the given account exists. 779Returns true when the given account exists.
723 780
726sub cf::player::exists($) { 783sub cf::player::exists($) {
727 cf::player::find $_[0] 784 cf::player::find $_[0]
728 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 785 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
729} 786}
730 787
731=item $player->reply ($npc, $msg[, $flags]) 788=item $player_object->reply ($npc, $msg[, $flags])
732 789
733Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 790Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
734can be C<undef>. Does the right thing when the player is currently in a 791can be C<undef>. Does the right thing when the player is currently in a
735dialogue with the given NPC character. 792dialogue with the given NPC character.
736 793
763 $msg{msgid} = $id; 820 $msg{msgid} = $id;
764 821
765 $self->send ("ext " . to_json \%msg); 822 $self->send ("ext " . to_json \%msg);
766} 823}
767 824
825=item $player_object->may ("access")
826
827Returns wether the given player is authorized to access resource "access"
828(e.g. "command_wizcast").
829
830=cut
831
832sub cf::object::player::may {
833 my ($self, $access) = @_;
834
835 $self->flag (cf::FLAG_WIZ) ||
836 (ref $cf::CFG{"may_$access"}
837 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
838 : $cf::CFG{"may_$access"})
839}
840
841=cut
842
768############################################################################# 843#############################################################################
769# map scripting support 844
845=head2 SAFE SCRIPTING
846
847Functions that provide a safe environment to compile and execute
848snippets of perl code without them endangering the safety of the server
849itself. Looping constructs, I/O operators and other built-in functionality
850is not available in the safe scripting environment, and the number of
851functions and methods that can be called is greatly reduced.
852
853=cut
770 854
771our $safe = new Safe "safe"; 855our $safe = new Safe "safe";
772our $safe_hole = new Safe::Hole; 856our $safe_hole = new Safe::Hole;
773 857
774$SIG{FPE} = 'IGNORE'; 858$SIG{FPE} = 'IGNORE';
775 859
776$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 860$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
777 861
778# here we export the classes and methods available to script code 862# here we export the classes and methods available to script code
863
864=pod
865
866The following fucntions and emthods are available within a safe environment:
867
868 cf::object contr pay_amount pay_player
869 cf::object::player player
870 cf::player peaceful
871
872=cut
779 873
780for ( 874for (
781 ["cf::object" => qw(contr pay_amount pay_player)], 875 ["cf::object" => qw(contr pay_amount pay_player)],
782 ["cf::object::player" => qw(player)], 876 ["cf::object::player" => qw(player)],
783 ["cf::player" => qw(peaceful)], 877 ["cf::player" => qw(peaceful)],
786 my ($pkg, @funs) = @$_; 880 my ($pkg, @funs) = @$_;
787 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 881 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
788 for @funs; 882 for @funs;
789} 883}
790 884
885=over 4
886
887=item @retval = safe_eval $code, [var => value, ...]
888
889Compiled and executes the given perl code snippet. additional var/value
890pairs result in temporary local (my) scalar variables of the given name
891that are available in the code snippet. Example:
892
893 my $five = safe_eval '$first + $second', first => 1, second => 4;
894
895=cut
896
791sub safe_eval($;@) { 897sub safe_eval($;@) {
792 my ($code, %vars) = @_; 898 my ($code, %vars) = @_;
793 899
794 my $qcode = $code; 900 my $qcode = $code;
795 $qcode =~ s/"/‟/g; # not allowed in #line filenames 901 $qcode =~ s/"/‟/g; # not allowed in #line filenames
817 } 923 }
818 924
819 wantarray ? @res : $res[0] 925 wantarray ? @res : $res[0]
820} 926}
821 927
928=item cf::register_script_function $function => $cb
929
930Register a function that can be called from within map/npc scripts. The
931function should be reasonably secure and should be put into a package name
932like the extension.
933
934Example: register a function that gets called whenever a map script calls
935C<rent::overview>, as used by the C<rent> extension.
936
937 cf::register_script_function "rent::overview" => sub {
938 ...
939 };
940
941=cut
942
822sub register_script_function { 943sub register_script_function {
823 my ($fun, $cb) = @_; 944 my ($fun, $cb) = @_;
824 945
825 no strict 'refs'; 946 no strict 'refs';
826 *{"safe::$fun"} = $safe_hole->wrap ($cb); 947 *{"safe::$fun"} = $safe_hole->wrap ($cb);
827} 948}
828 949
950=back
951
952=cut
953
954#############################################################################
955
956=head2 EXTENSION DATABASE SUPPORT
957
958Crossfire maintains a very simple database for extension use. It can
959currently store anything that can be serialised using Storable, which
960excludes objects.
961
962The parameter C<$family> should best start with the name of the extension
963using it, it should be unique.
964
965=over 4
966
967=item $hashref = cf::db_get $family
968
969Return a hashref for use by the extension C<$family>, which can be
970modified. After modifications, you have to call C<cf::db_dirty> or
971C<cf::db_sync>.
972
973=item $value = cf::db_get $family => $key
974
975Returns a single value from the database
976
977=item cf::db_put $family => $hashref
978
979Stores the given family hashref into the database. Updates are delayed, if
980you want the data to be synced to disk immediately, use C<cf::db_sync>.
981
982=item cf::db_put $family => $key => $value
983
984Stores the given C<$value> in the family hash. Updates are delayed, if you
985want the data to be synced to disk immediately, use C<cf::db_sync>.
986
987=item cf::db_dirty
988
989Marks the database as dirty, to be updated at a later time.
990
991=item cf::db_sync
992
993Immediately write the database to disk I<if it is dirty>.
994
995=cut
996
997our $DB;
998
999{
1000 my $path = cf::localdir . "/database.pst";
1001
1002 sub db_load() {
1003 warn "loading database $path\n";#d# remove later
1004 $DB = stat $path ? Storable::retrieve $path : { };
1005 }
1006
1007 my $pid;
1008
1009 sub db_save() {
1010 warn "saving database $path\n";#d# remove later
1011 waitpid $pid, 0 if $pid;
1012 if (0 == ($pid = fork)) {
1013 $DB->{_meta}{version} = 1;
1014 Storable::nstore $DB, "$path~";
1015 rename "$path~", $path;
1016 cf::_exit 0 if defined $pid;
1017 }
1018 }
1019
1020 my $dirty;
1021
1022 sub db_sync() {
1023 db_save if $dirty;
1024 undef $dirty;
1025 }
1026
1027 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
1028 db_sync;
1029 });
1030
1031 sub db_dirty() {
1032 $dirty = 1;
1033 $idle->start;
1034 }
1035
1036 sub db_get($;$) {
1037 @_ >= 2
1038 ? $DB->{$_[0]}{$_[1]}
1039 : ($DB->{$_[0]} ||= { })
1040 }
1041
1042 sub db_put($$;$) {
1043 if (@_ >= 3) {
1044 $DB->{$_[0]}{$_[1]} = $_[2];
1045 } else {
1046 $DB->{$_[0]} = $_[1];
1047 }
1048 db_dirty;
1049 }
1050
1051 attach_global
1052 prio => 10000,
1053 on_cleanup => sub {
1054 db_sync;
1055 },
1056 ;
1057}
1058
829############################################################################# 1059#############################################################################
830# the server's main() 1060# the server's main()
831 1061
1062sub cfg_load {
1063 open my $fh, "<:utf8", cf::confdir . "/config"
1064 or return;
1065
1066 local $/;
1067 *CFG = YAML::Syck::Load <$fh>;
1068}
1069
832sub main { 1070sub main {
1071 cfg_load;
1072 db_load;
1073 load_extensions;
833 Event::loop; 1074 Event::loop;
834} 1075}
835 1076
836############################################################################# 1077#############################################################################
837# initialisation 1078# initialisation
838 1079
1080sub _perl_reload(&) {
1081 my ($msg) = @_;
1082
1083 $msg->("reloading...");
1084
1085 eval {
1086 # cancel all watchers
1087 $_->cancel for Event::all_watchers;
1088
1089 # unload all extensions
1090 for (@exts) {
1091 $msg->("unloading <$_>");
1092 unload_extension $_;
1093 }
1094
1095 # unload all modules loaded from $LIBDIR
1096 while (my ($k, $v) = each %INC) {
1097 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1098
1099 $msg->("removing <$k>");
1100 delete $INC{$k};
1101
1102 $k =~ s/\.pm$//;
1103 $k =~ s/\//::/g;
1104
1105 if (my $cb = $k->can ("unload_module")) {
1106 $cb->();
1107 }
1108
1109 Symbol::delete_package $k;
1110 }
1111
1112 # sync database to disk
1113 cf::db_sync;
1114
1115 # get rid of safe::, as good as possible
1116 Symbol::delete_package "safe::$_"
1117 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1118
1119 # remove register_script_function callbacks
1120 # TODO
1121
1122 # unload cf.pm "a bit"
1123 delete $INC{"cf.pm"};
1124
1125 # don't, removes xs symbols, too,
1126 # and global variables created in xs
1127 #Symbol::delete_package __PACKAGE__;
1128
1129 # reload cf.pm
1130 $msg->("reloading cf.pm");
1131 require cf;
1132
1133 # load config and database again
1134 cf::cfg_load;
1135 cf::db_load;
1136
1137 # load extensions
1138 $msg->("load extensions");
1139 cf::load_extensions;
1140
1141 # reattach attachments to objects
1142 $msg->("reattach");
1143 _global_reattach;
1144 };
1145 $msg->($@) if $@;
1146
1147 $msg->("reloaded");
1148};
1149
1150sub perl_reload() {
1151 _perl_reload {
1152 warn $_[0];
1153 print "$_[0]\n";
1154 };
1155}
1156
1157register_command "perl-reload", 0, sub {
1158 my ($who, $arg) = @_;
1159
1160 if ($who->flag (FLAG_WIZ)) {
1161 _perl_reload {
1162 warn $_[0];
1163 $who->message ($_[0]);
1164 };
1165 }
1166};
1167
839register "<global>", __PACKAGE__; 1168register "<global>", __PACKAGE__;
840 1169
841unshift @INC, $LIBDIR; 1170unshift @INC, $LIBDIR;
842 1171
843load_extensions;
844
845$TICK_WATCHER = Event->timer ( 1172$TICK_WATCHER = Event->timer (
846 prio => 1, 1173 prio => 1,
1174 async => 1,
847 at => $NEXT_TICK || 1, 1175 at => $NEXT_TICK || 1,
848 cb => sub { 1176 cb => sub {
849 cf::server_tick; # one server iteration 1177 cf::server_tick; # one server iteration
850 1178
851 my $NOW = Event::time; 1179 my $NOW = Event::time;
852 $NEXT_TICK += $TICK; 1180 $NEXT_TICK += $TICK;
853 1181
854 # if we are delayed by four ticks, skip them all 1182 # if we are delayed by four ticks or more, skip them all
855 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 1183 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
856 1184
857 $TICK_WATCHER->at ($NEXT_TICK); 1185 $TICK_WATCHER->at ($NEXT_TICK);
858 $TICK_WATCHER->start; 1186 $TICK_WATCHER->start;
859 }, 1187 },
860); 1188);
861 1189
862_reload_2; 1190IO::AIO::max_poll_time $TICK * 0.2;
1191
1192Event->io (fd => IO::AIO::poll_fileno,
1193 poll => 'r',
1194 prio => 5,
1195 cb => \&IO::AIO::poll_cb);
863 1196
8641 11971
865 1198

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines