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.70 by root, Sun Oct 1 10:55:37 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
107############################################################################# 112=back
108# "new" plug-in system
109 113
114#############################################################################
115
116=head2 EVENTS AND OBJECT ATTACHMENTS
117
118=over 4
119
120=item $object->attach ($attachment, key => $value...)
121
110=item $object->attach ($attachment, ...) 122=item $object->detach ($attachment)
111 123
112Attach a pre-registered attachment to an object. 124Attach/detach a pre-registered attachment to an object.
113 125
126=item $player->attach ($attachment, key => $value...)
127
114=item $player->attach ($attachment, ...) 128=item $player->detach ($attachment)
115 129
116Attach a pre-registered attachment to a player. 130Attach/detach a pre-registered attachment to a player.
117 131
118=item $map->attach ($attachment, ...) # not yet persistent 132=item $map->attach ($attachment, key => $value...)
119 133
134=item $map->detach ($attachment)
135
120Attach a pre-registered attachment to a map. 136Attach/detach a pre-registered attachment to a map.
137
138=item $bool = $object->attached ($name)
139
140=item $bool = $player->attached ($name)
141
142=item $bool = $map->attached ($name)
143
144Checks wether the named attachment is currently attached to the object.
121 145
122=item cf::attach_global ... 146=item cf::attach_global ...
123 147
124Attach handlers for global events. 148Attach handlers for global events.
125 149
173=item cf::attach_to_maps ... 197=item cf::attach_to_maps ...
174 198
175Attach handlers to all maps. 199Attach handlers to all maps.
176 200
177=item cf:register_attachment $name, ... 201=item cf:register_attachment $name, ...
202
203Register an attachment by name through which objects can refer to this
204attachment.
205
206=item cf:register_player_attachment $name, ...
207
208Register an attachment by name through which players can refer to this
209attachment.
210
211=item cf:register_map_attachment $name, ...
212
213Register an attachment by name through which maps can refer to this
214attachment.
178 215
179=cut 216=cut
180 217
181# the following variables are defined in .xs and must not be re-created 218# the following variables are defined in .xs and must not be re-created
182our @CB_GLOBAL = (); # registry for all global events 219our @CB_GLOBAL = (); # registry for all global events
245 282
246 \%undo 283 \%undo
247} 284}
248 285
249sub _attach_attachment { 286sub _attach_attachment {
250 my ($obj, $name, @args) = @_; 287 my ($obj, $name, %arg) = @_;
288
289 return if exists $obj->{_attachment}{$name};
251 290
252 my $res; 291 my $res;
253 292
254 if (my $attach = $attachment{$name}) { 293 if (my $attach = $attachment{$name}) {
255 my $registry = $obj->registry; 294 my $registry = $obj->registry;
257 for (@$attach) { 296 for (@$attach) {
258 my ($klass, @attach) = @$_; 297 my ($klass, @attach) = @$_;
259 $res = _attach @$registry, $klass, @attach; 298 $res = _attach @$registry, $klass, @attach;
260 } 299 }
261 300
262 if (my $cb = delete $registry->[EVENT_OBJECT_INSTANTIATE]) { 301 $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 { 302 } else {
272 warn "object uses attachment '$name' that is not available, postponing.\n"; 303 warn "object uses attachment '$name' that is not available, postponing.\n";
273 } 304 }
274 305
275 push @{$obj->{_attachment}}, $name; 306 $obj->{_attachment}{$name} = undef;
276 307
277 $res->{attachment} = $name; 308 $res->{attachment} = $name;
278 $res 309 $res
279} 310}
280 311
281sub cf::object::attach { 312*cf::object::attach =
313*cf::player::attach =
314*cf::map::attach = sub {
282 my ($obj, $name, @args) = @_; 315 my ($obj, $name, %arg) = @_;
283 316
284 _attach_attachment $obj, $name, @args; 317 _attach_attachment $obj, $name, %arg;
285} 318};
286 319
320# all those should be optimised
321*cf::object::detach =
287sub cf::player::attach { 322*cf::player::detach =
323*cf::map::detach = sub {
288 my ($obj, $name, @args) = @_; 324 my ($obj, $name) = @_;
289 325
290 _attach_attachment KLASS_PLAYER, $obj, $name, @args; 326 delete $obj->{_attachment}{$name};
291} 327 reattach ($obj);
328};
292 329
293sub cf::map::attach { 330*cf::object::attached =
331*cf::player::attached =
332*cf::map::attached = sub {
294 my ($obj, $name, @args) = @_; 333 my ($obj, $name) = @_;
295 334
296 _attach_attachment KLASS_MAP, $obj, $name, @args; 335 exists $obj->{_attachment}{$name}
297} 336};
298 337
299sub attach_global { 338sub attach_global {
300 _attach @CB_GLOBAL, KLASS_GLOBAL, @_ 339 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
301} 340}
302 341
323 my $name = shift; 362 my $name = shift;
324 363
325 $attachment{$name} = [[KLASS_OBJECT, @_]]; 364 $attachment{$name} = [[KLASS_OBJECT, @_]];
326} 365}
327 366
367sub register_player_attachment {
368 my $name = shift;
369
370 $attachment{$name} = [[KLASS_PLAYER, @_]];
371}
372
373sub register_map_attachment {
374 my $name = shift;
375
376 $attachment{$name} = [[KLASS_MAP, @_]];
377}
378
328our $override; 379our $override;
329our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 380our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
330 381
331sub override { 382sub override {
332 $override = 1; 383 $override = 1;
344 for (@$callbacks) { 395 for (@$callbacks) {
345 eval { &{$_->[1]} }; 396 eval { &{$_->[1]} };
346 397
347 if ($@) { 398 if ($@) {
348 warn "$@"; 399 warn "$@";
349 warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; 400 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
350 override; 401 override;
351 } 402 }
352 403
353 return 1 if $override; 404 return 1 if $override;
354 } 405 }
355 406
356 0 407 0
357} 408}
409
410=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...
411
412=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
413
414=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
415
416=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
417
418Generate a global/object/player/map-specific event with the given arguments.
419
420This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
421removed in future versions), and there is no public API to access override
422results (if you must, access C<@cf::invoke_results> directly).
423
424=back
425
426#############################################################################
427
428=head2 METHODS VALID FOR ALL CORE OBJECTS
429
430=over 4
431
432=item $object->valid, $player->valid, $map->valid
433
434Just because you have a perl object does not mean that the corresponding
435C-level object still exists. If you try to access an object that has no
436valid C counterpart anymore you get an exception at runtime. This method
437can be used to test for existence of the C object part without causing an
438exception.
439
440=back
441
442=cut
443
444*cf::object::valid =
445*cf::player::valid =
446*cf::map::valid = \&cf::_valid;
358 447
359############################################################################# 448#############################################################################
360# object support 449# object support
361 450
362sub instantiate { 451sub instantiate {
364 453
365 $data = from_json $data; 454 $data = from_json $data;
366 455
367 for (@$data) { 456 for (@$data) {
368 my ($name, $args) = @$_; 457 my ($name, $args) = @$_;
369 attach $obj, $name, @{$args || [] }; 458
459 $obj->attach ($name, %{$args || {} });
370 } 460 }
371} 461}
372 462
373# basically do the same as instantiate, without calling instantiate 463# basically do the same as instantiate, without calling instantiate
374sub reattach { 464sub reattach {
375 my ($obj) = @_; 465 my ($obj) = @_;
376 my $registry = $obj->registry; 466 my $registry = $obj->registry;
377 467
378 @$registry = (); 468 @$registry = ();
379 469
470 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
471
380 for my $name (@{ $obj->{_attachment} }) { 472 for my $name (keys %{ $obj->{_attachment} || {} }) {
381 if (my $attach = $attachment{$name}) { 473 if (my $attach = $attachment{$name}) {
382 for (@$attach) { 474 for (@$attach) {
383 my ($klass, @attach) = @$_; 475 my ($klass, @attach) = @$_;
384 _attach @$registry, $klass, @attach; 476 _attach @$registry, $klass, @attach;
385 } 477 }
388 } 480 }
389 } 481 }
390} 482}
391 483
392sub object_freezer_save { 484sub object_freezer_save {
393 my ($filename, $objs) = @_; 485 my ($filename, $rdata, $objs) = @_;
394 486
395 $filename .= ".pst"; 487 if (length $$rdata) {
488 warn sprintf "saving %s (%d,%d)\n",
489 $filename, length $$rdata, scalar @$objs;
396 490
397 if (@$objs) {
398 open my $fh, ">:raw", "$filename~"; 491 if (open my $fh, ">:raw", "$filename~") {
399 chmod $fh, SAVE_MODE; 492 chmod SAVE_MODE, $fh;
493 syswrite $fh, $$rdata;
494 close $fh;
495
496 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
497 chmod SAVE_MODE, $fh;
400 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; 498 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
401 close $fh; 499 close $fh;
500 rename "$filename.pst~", "$filename.pst";
501 } else {
502 unlink "$filename.pst";
503 }
504
402 rename "$filename~", $filename; 505 rename "$filename~", $filename;
506 } else {
507 warn "FATAL: $filename~: $!\n";
508 }
403 } else { 509 } else {
404 unlink $filename; 510 unlink $filename;
511 unlink "$filename.pst";
405 } 512 }
406} 513}
407 514
408sub object_thawer_load { 515sub object_thawer_load {
409 my ($filename) = @_; 516 my ($filename) = @_;
410 517
518 local $/;
519
520 my $av;
521
522 #TODO: use sysread etc.
523 if (open my $data, "<:raw:perlio", $filename) {
524 $data = <$data>;
411 open my $fh, "<:raw:perlio", "$filename.pst" 525 if (open my $pst, "<:raw:perlio", "$filename.pst") {
412 or return; 526 $av = eval { (Storable::thaw <$pst>)->{objs} };
527 }
528 return ($data, $av);
529 }
413 530
414 eval { local $/; (Storable::thaw <$fh>)->{objs} } 531 ()
415} 532}
416 533
417attach_to_objects 534attach_to_objects
418 prio => -1000000, 535 prio => -1000000,
419 on_clone => sub { 536 on_clone => sub {
421 538
422 @{$dst->registry} = @{$src->registry}; 539 @{$dst->registry} = @{$src->registry};
423 540
424 %$dst = %$src; 541 %$dst = %$src;
425 542
426 $dst->{_attachment} = [@{ $src->{_attachment} }] 543 %{$dst->{_attachment}} = %{$src->{_attachment}}
427 if exists $src->{_attachment}; 544 if exists $src->{_attachment};
428 }, 545 },
429; 546;
430 547
431############################################################################# 548#############################################################################
565 load_extension $ext; 682 load_extension $ext;
566 1 683 1
567 } or warn "$ext not loaded: $@"; 684 } or warn "$ext not loaded: $@";
568 } 685 }
569} 686}
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 687
644############################################################################# 688#############################################################################
645# extcmd framework, basically convert ext <msg> 689# extcmd framework, basically convert ext <msg>
646# into pkg::->on_extcmd_arg1 (...) while shortcutting a few 690# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
647 691
672 my ($map) = @_; 716 my ($map) = @_;
673 717
674 my $path = $map->tmpname; 718 my $path = $map->tmpname;
675 defined $path or return; 719 defined $path or return;
676 720
677 unlink "$path.cfperl";
678 unlink "$path.pst"; 721 unlink "$path.pst";
679}; 722};
680 723
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::; 724attach_to_maps prio => -10000, package => cf::mapsupport::;
700 725
701############################################################################# 726#############################################################################
702# load/save perl data associated with player->ob objects 727# load/save perl data associated with player->ob objects
703 728
704sub all_objects(@) { 729sub all_objects(@) {
705 @_, map all_objects ($_->inv), @_ 730 @_, map all_objects ($_->inv), @_
706} 731}
707 732
733# TODO: compatibility cruft, remove when no longer needed
708attach_to_players 734attach_to_players
709 on_load => sub { 735 on_load => sub {
710 my ($pl, $path) = @_; 736 my ($pl, $path) = @_;
711 737
712 for my $o (all_objects $pl->ob) { 738 for my $o (all_objects $pl->ob) {
718 } 744 }
719 }, 745 },
720; 746;
721 747
722############################################################################# 748#############################################################################
723# core extensions - in perl 749
750=head2 CORE EXTENSIONS
751
752Functions and methods that extend core crossfire objects.
753
754=over 4
724 755
725=item cf::player::exists $login 756=item cf::player::exists $login
726 757
727Returns true when the given account exists. 758Returns true when the given account exists.
728 759
768 $msg{msgid} = $id; 799 $msg{msgid} = $id;
769 800
770 $self->send ("ext " . to_json \%msg); 801 $self->send ("ext " . to_json \%msg);
771} 802}
772 803
804=back
805
806=cut
807
773############################################################################# 808#############################################################################
774# map scripting support 809
810=head2 SAFE SCRIPTING
811
812Functions that provide a safe environment to compile and execute
813snippets of perl code without them endangering the safety of the server
814itself. Looping constructs, I/O operators and other built-in functionality
815is not available in the safe scripting environment, and the number of
816functions and methods that cna be called is greatly reduced.
817
818=cut
775 819
776our $safe = new Safe "safe"; 820our $safe = new Safe "safe";
777our $safe_hole = new Safe::Hole; 821our $safe_hole = new Safe::Hole;
778 822
779$SIG{FPE} = 'IGNORE'; 823$SIG{FPE} = 'IGNORE';
780 824
781$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 825$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
782 826
783# here we export the classes and methods available to script code 827# here we export the classes and methods available to script code
828
829=pod
830
831The following fucntions and emthods are available within a safe environment:
832
833 cf::object contr pay_amount pay_player
834 cf::object::player player
835 cf::player peaceful
836
837=cut
784 838
785for ( 839for (
786 ["cf::object" => qw(contr pay_amount pay_player)], 840 ["cf::object" => qw(contr pay_amount pay_player)],
787 ["cf::object::player" => qw(player)], 841 ["cf::object::player" => qw(player)],
788 ["cf::player" => qw(peaceful)], 842 ["cf::player" => qw(peaceful)],
791 my ($pkg, @funs) = @$_; 845 my ($pkg, @funs) = @$_;
792 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 846 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
793 for @funs; 847 for @funs;
794} 848}
795 849
850=over 4
851
852=item @retval = safe_eval $code, [var => value, ...]
853
854Compiled and executes the given perl code snippet. additional var/value
855pairs result in temporary local (my) scalar variables of the given name
856that are available in the code snippet. Example:
857
858 my $five = safe_eval '$first + $second', first => 1, second => 4;
859
860=cut
861
796sub safe_eval($;@) { 862sub safe_eval($;@) {
797 my ($code, %vars) = @_; 863 my ($code, %vars) = @_;
798 864
799 my $qcode = $code; 865 my $qcode = $code;
800 $qcode =~ s/"/‟/g; # not allowed in #line filenames 866 $qcode =~ s/"/‟/g; # not allowed in #line filenames
822 } 888 }
823 889
824 wantarray ? @res : $res[0] 890 wantarray ? @res : $res[0]
825} 891}
826 892
893=item cf::register_script_function $function => $cb
894
895Register a function that can be called from within map/npc scripts. The
896function should be reasonably secure and should be put into a package name
897like the extension.
898
899Example: register a function that gets called whenever a map script calls
900C<rent::overview>, as used by the C<rent> extension.
901
902 cf::register_script_function "rent::overview" => sub {
903 ...
904 };
905
906=cut
907
827sub register_script_function { 908sub register_script_function {
828 my ($fun, $cb) = @_; 909 my ($fun, $cb) = @_;
829 910
830 no strict 'refs'; 911 no strict 'refs';
831 *{"safe::$fun"} = $safe_hole->wrap ($cb); 912 *{"safe::$fun"} = $safe_hole->wrap ($cb);
832} 913}
833 914
915=back
916
917#############################################################################
918
919=head2 EXTENSION DATABASE SUPPORT
920
921Crossfire maintains a very simple database for extension use. It can
922currently store anything that can be serialised using Storable, which
923excludes objects.
924
925The parameter C<$family> should best start with the name of the extension
926using it, it should be unique.
927
928=over 4
929
930=item $hashref = cf::db_get $family
931
932Return a hashref for use by the extension C<$family>, which can be
933modified. After modifications, you have to call C<cf::db_dirty> or
934C<cf::db_sync>.
935
936=item $value = cf::db_get $family => $key
937
938Returns a single value from the database
939
940=item cf::db_put $family => $hashref
941
942Stores the given family hashref into the database. Updates are delayed, if
943you want the data to be synced to disk immediately, use C<cf::db_sync>.
944
945=item cf::db_put $family => $key => $value
946
947Stores the given C<$value> in the family hash. Updates are delayed, if you
948want the data to be synced to disk immediately, use C<cf::db_sync>.
949
950=item cf::db_dirty
951
952Marks the database as dirty, to be updated at a later time.
953
954=item cf::db_sync
955
956Immediately write the database to disk I<if it is dirty>.
957
958=cut
959
960{
961 my $db;
962 my $path = cf::localdir . "/database.pst";
963
964 sub db_load() {
965 warn "loading database $path\n";#d# remove later
966 $db = stat $path ? Storable::retrieve $path : { };
967 }
968
969 my $pid;
970
971 sub db_save() {
972 warn "saving database $path\n";#d# remove later
973 waitpid $pid, 0 if $pid;
974 if (0 == ($pid = fork)) {
975 $db->{_meta}{version} = 1;
976 Storable::nstore $db, "$path~";
977 rename "$path~", $path;
978 cf::_exit 0 if defined $pid;
979 }
980 }
981
982 my $dirty;
983
984 sub db_sync() {
985 db_save if $dirty;
986 undef $dirty;
987 }
988
989 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
990 db_sync;
991 });
992
993 sub db_dirty() {
994 $dirty = 1;
995 $idle->start;
996 }
997
998 sub db_get($;$) {
999 @_ >= 2
1000 ? $db->{$_[0]}{$_[1]}
1001 : ($db->{$_[0]} ||= { })
1002 }
1003
1004 sub db_put($$;$) {
1005 if (@_ >= 3) {
1006 $db->{$_[0]}{$_[1]} = $_[2];
1007 } else {
1008 $db->{$_[0]} = $_[1];
1009 }
1010 db_dirty;
1011 }
1012
1013 attach_global
1014 prio => 10000,
1015 on_cleanup => sub {
1016 db_sync;
1017 },
1018 ;
1019}
1020
834############################################################################# 1021#############################################################################
835# the server's main() 1022# the server's main()
836 1023
837sub main { 1024sub main {
1025 db_load;
1026 load_extensions;
838 Event::loop; 1027 Event::loop;
839} 1028}
840 1029
841############################################################################# 1030#############################################################################
842# initialisation 1031# initialisation
843 1032
1033sub _perl_reload(&) {
1034 my ($msg) = @_;
1035
1036 $msg->("reloading...");
1037
1038 eval {
1039 # cancel all watchers
1040 $_->cancel for Event::all_watchers;
1041
1042 # unload all extensions
1043 for (@exts) {
1044 $msg->("unloading <$_>");
1045 unload_extension $_;
1046 }
1047
1048 # unload all modules loaded from $LIBDIR
1049 while (my ($k, $v) = each %INC) {
1050 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1051
1052 $msg->("removing <$k>");
1053 delete $INC{$k};
1054
1055 $k =~ s/\.pm$//;
1056 $k =~ s/\//::/g;
1057
1058 if (my $cb = $k->can ("unload_module")) {
1059 $cb->();
1060 }
1061
1062 Symbol::delete_package $k;
1063 }
1064
1065 # sync database to disk
1066 cf::db_sync;
1067
1068 # get rid of safe::, as good as possible
1069 Symbol::delete_package "safe::$_"
1070 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
1071
1072 # remove register_script_function callbacks
1073 # TODO
1074
1075 # unload cf.pm "a bit"
1076 delete $INC{"cf.pm"};
1077
1078 # don't, removes xs symbols, too,
1079 # and global variables created in xs
1080 #Symbol::delete_package __PACKAGE__;
1081
1082 # reload cf.pm
1083 $msg->("reloading cf.pm");
1084 require cf;
1085
1086 # load database again
1087 cf::db_load;
1088
1089 # load extensions
1090 $msg->("load extensions");
1091 cf::load_extensions;
1092
1093 # reattach attachments to objects
1094 $msg->("reattach");
1095 _global_reattach;
1096 };
1097 $msg->($@) if $@;
1098
1099 $msg->("reloaded");
1100};
1101
1102sub perl_reload() {
1103 _perl_reload {
1104 warn $_[0];
1105 print "$_[0]\n";
1106 };
1107}
1108
1109register_command "perl-reload", 0, sub {
1110 my ($who, $arg) = @_;
1111
1112 if ($who->flag (FLAG_WIZ)) {
1113 _perl_reload {
1114 warn $_[0];
1115 $who->message ($_[0]);
1116 };
1117 }
1118};
1119
844register "<global>", __PACKAGE__; 1120register "<global>", __PACKAGE__;
845 1121
846unshift @INC, $LIBDIR; 1122unshift @INC, $LIBDIR;
847
848load_extensions;
849 1123
850$TICK_WATCHER = Event->timer ( 1124$TICK_WATCHER = Event->timer (
851 prio => 1, 1125 prio => 1,
852 at => $NEXT_TICK || 1, 1126 at => $NEXT_TICK || 1,
853 cb => sub { 1127 cb => sub {
862 $TICK_WATCHER->at ($NEXT_TICK); 1136 $TICK_WATCHER->at ($NEXT_TICK);
863 $TICK_WATCHER->start; 1137 $TICK_WATCHER->start;
864 }, 1138 },
865); 1139);
866 1140
867_reload_2;
868
8691 11411
870 1142

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines