ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
Revision: 1.86
Committed: Thu Dec 14 05:09:32 2006 UTC (17 years, 5 months ago) by root
Branch: MAIN
Changes since 1.85: +6 -1 lines
Log Message:
- remove some old socket mode cruft
- preliminarily added attachable client_socket interface to perl
  (untested but also unreachable from perl code atm)

File Contents

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