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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines