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.47 by root, Sun Aug 27 13:02:04 2006 UTC vs.
Revision 1.75 by root, Mon Oct 2 00:22:01 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines