ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
Revision: 1.77
Committed: Sun Nov 5 11:13:01 2006 UTC (17 years, 6 months ago) by root
Branch: MAIN
Changes since 1.76: +12 -3 lines
Log Message:
- delayed status update in schmorplog.
- adjusted priorities for event watchers.
- limited io::aio request processing time.

File Contents

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