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.20 by root, Sun Jul 16 17:29:02 2006 UTC vs.
Revision 1.115 by root, Mon Jan 1 16:50:10 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Storable;
9use Opcode;
10use Safe;
11use Safe::Hole;
6 12
13use Coro 3.3;
7use Event; 14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18use Coro::AIO;
19
20use Digest::MD5;
21use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck ();
24use Time::HiRes;
25
8$Event::Eval = 1; # no idea why this is required, but it is 26use Event; $Event::Eval = 1; # no idea why this is required, but it is
9 27
10use strict; 28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1;
11 30
12our %COMMAND; 31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34
35our %COMMAND = ();
36our %COMMAND_TIME = ();
37our %EXTCMD = ();
38
13our @EVENT; 39our @EVENT;
14our %PROP_TYPE; 40our $LIBDIR = datadir . "/ext";
15our %PROP_IDX; 41
42our $TICK = MAX_TIME * 1e-6;
43our $TICK_WATCHER;
44our $NEXT_TICK;
45our $NOW;
46
47our %CFG;
48
49our $UPTIME; $UPTIME ||= time;
50our $RUNTIME;
51
52our %MAP; # all maps
53our $LINK_MAP; # the special {link} map
54our $FREEZE;
55our $RANDOM_MAPS = cf::localdir . "/random";
56our %EXT_CORO;
57
58binmode STDOUT;
59binmode STDERR;
60
61# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") {
63 open my $fh, "<", cf::localdir . "/runtime"
64 or die "unable to read runtime file: $!";
65 $RUNTIME = <$fh> + 0.;
66}
67
68mkdir cf::localdir;
69mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73
74# a special map that is always available
75our $LINK_MAP;
76
77our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];
78
79#############################################################################
80
81=head2 GLOBAL VARIABLES
82
83=over 4
84
85=item $cf::UPTIME
86
87The timestamp of the server start (so not actually an uptime).
88
89=item $cf::RUNTIME
90
91The time this server has run, starts at 0 and is increased by $cf::TICK on
92every server tick.
93
94=item $cf::LIBDIR
95
96The perl library directory, where extensions and cf-specific modules can
97be found. It will be added to C<@INC> automatically.
98
99=item $cf::NOW
100
101The time of the last (current) server tick.
102
103=item $cf::TICK
104
105The interval between server ticks, in seconds.
106
107=item %cf::CFG
108
109Configuration for the server, loaded from C</etc/crossfire/config>, or
110from wherever your confdir points to.
111
112=back
113
114=cut
16 115
17BEGIN { 116BEGIN {
18 @EVENT = map lc, @EVENT;
19
20 *CORE::GLOBAL::warn = sub { 117 *CORE::GLOBAL::warn = sub {
21 my $msg = join "", @_; 118 my $msg = join "", @_;
119 utf8::encode $msg;
120
22 $msg .= "\n" 121 $msg .= "\n"
23 unless $msg =~ /\n$/; 122 unless $msg =~ /\n$/;
24 123
25 print STDERR "cfperl: $msg";
26 LOG llevError, "cfperl: $msg"; 124 LOG llevError, "cfperl: $msg";
27 }; 125 };
28} 126}
29 127
30my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! 128@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
133@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
31 134
32# generate property mutators 135# we bless all objects into (empty) derived classes to force a method lookup
33sub prop_gen { 136# within the Safe compartment.
34 my ($prefix, $class) = @_; 137for my $pkg (qw(
35 138 cf::global cf::attachable
139 cf::object cf::object::player
140 cf::client cf::player
141 cf::arch cf::living
142 cf::map cf::party cf::region
143)) {
36 no strict 'refs'; 144 no strict 'refs';
37 145 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
38 for my $prop (keys %PROP_TYPE) {
39 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
40 my $sub = lc $1;
41
42 my $type = $PROP_TYPE{$prop};
43 my $idx = $PROP_IDX {$prop};
44
45 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
46 $_[0]->get_property ($type, $idx)
47 };
48
49 *{"$class\::set_$sub"} = sub {
50 $_[0]->set_property ($type, $idx, $_[1]);
51 } unless $ignore_set{$prop};
52 }
53} 146}
54
55# auto-generate most of the API
56
57prop_gen OBJECT_PROP => "cf::object";
58# CFAPI_OBJECT_ANIMATION?
59prop_gen PLAYER_PROP => "cf::object::player";
60
61prop_gen MAP_PROP => "cf::map";
62prop_gen ARCH_PROP => "cf::arch";
63
64# guessed hierarchies
65
66@cf::object::player::ISA = 'cf::object';
67@cf::object::map::ISA = 'cf::object';
68 147
69$Event::DIED = sub { 148$Event::DIED = sub {
70 warn "error in event callback: @_"; 149 warn "error in event callback: @_";
71}; 150};
72 151
73my %ext_pkg; 152my %ext_pkg;
74my @exts; 153my @exts;
75my @hook; 154my @hook;
76my %command;
77my %extcmd;
78 155
79sub inject_event { 156=head2 UTILITY FUNCTIONS
80 my $extension = shift; 157
158=over 4
159
160=cut
161
162use JSON::Syck (); # TODO# replace by JSON::PC once working
163
164=item $ref = cf::from_json $json
165
166Converts a JSON string into the corresponding perl data structure.
167
168=cut
169
170sub from_json($) {
171 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
172 JSON::Syck::Load $_[0]
173}
174
175=item $json = cf::to_json $ref
176
177Converts a perl data structure into its JSON representation.
178
179=cut
180
181sub to_json($) {
182 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183 JSON::Syck::Dump $_[0]
184}
185
186=item cf::sync_job { BLOCK }
187
188The design of crossfire+ requires that the main coro ($Coro::main) is
189always able to handle events or runnable, as crossfire+ is only partly
190reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
191
192If it must be done, put the blocking parts into C<sync_job>. This will run
193the given BLOCK in another coroutine while waiting for the result. The
194server will be frozen during this time, so the block should either finish
195fast or be very important.
196
197=cut
198
199sub sync_job(&) {
200 my ($job) = @_;
201
202 if ($Coro::current == $Coro::main) {
203 # this is the main coro, too bad, we have to block
204 # till the operation succeeds, freezing the server :/
205
206 # TODO: use suspend/resume instead
207 # (but this is cancel-safe)
208 local $FREEZE = 1;
209
210 my $busy = 1;
211 my @res;
212
213 (Coro::async {
214 @res = eval { $job->() };
215 warn $@ if $@;
216 undef $busy;
217 })->prio (Coro::PRIO_MAX);
218
219 while ($busy) {
220 Coro::cede_notself;
221 Event::one_event unless Coro::nready;
222 }
223
224 wantarray ? @res : $res[0]
225 } else {
226 # we are in another coroutine, how wonderful, everything just works
227
228 $job->()
229 }
230}
231
232=item $coro = cf::coro { BLOCK }
233
234Creates and returns a new coro. This coro is automcatially being canceled
235when the extension calling this is being unloaded.
236
237=cut
238
239sub coro(&) {
81 my $event_code = shift; 240 my $cb = shift;
82 241
83 my $cb = $hook[$event_code]{$extension} 242 my $coro; $coro = async {
243 eval {
244 $cb->();
245 };
246 warn $@ if $@;
247 };
248
249 $coro->on_destroy (sub {
250 delete $EXT_CORO{$coro+0};
251 });
252 $EXT_CORO{$coro+0} = $coro;
253
254 $coro
255}
256
257sub write_runtime {
258 my $runtime = cf::localdir . "/runtime";
259
260 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
84 or return; 261 or return;
85 262
86 &$cb 263 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
87} 264 (aio_write $fh, 0, (length $value), $value, 0) <= 0
265 and return;
88 266
89sub inject_global_event { 267 aio_fsync $fh
268 and return;
269
270 close $fh
271 or return;
272
273 aio_rename "$runtime~", $runtime
274 and return;
275
276 1
277}
278
279=back
280
281=cut
282
283#############################################################################
284
285package cf::path;
286
287sub new {
288 my ($class, $path, $base) = @_;
289
290 $path = $path->as_string if ref $path;
291
292 my $self = bless { }, $class;
293
294 # {... are special paths that are not touched
295 # ?xxx/... are special absolute paths
296 # ?random/... random maps
297 # /! non-realised random map exit
298 # /... normal maps
299 # ~/... per-player maps without a specific player (DO NOT USE)
300 # ~user/... per-player map of a specific user
301
302 if ($path =~ /^{/) {
303 # fine as it is
304 } elsif ($path =~ s{^\?random/}{}) {
305 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
306 $self->{random} = cf::from_json $data;
307 } else {
308 if ($path =~ s{^~([^/]+)?}{}) {
309 $self->{user_rel} = 1;
310
311 if (defined $1) {
312 $self->{user} = $1;
313 } elsif ($base =~ m{^~([^/]+)/}) {
314 $self->{user} = $1;
315 } else {
316 warn "cannot resolve user-relative path without user <$path,$base>\n";
317 }
318 } elsif ($path =~ /^\//) {
319 # already absolute
320 } else {
321 $base =~ s{[^/]+/?$}{};
322 return $class->new ("$base/$path");
323 }
324
325 for ($path) {
326 redo if s{/\.?/}{/};
327 redo if s{/[^/]+/\.\./}{/};
328 }
329 }
330
331 $self->{path} = $path;
332
333 $self
334}
335
336# the name / primary key / in-game path
337sub as_string {
338 my ($self) = @_;
339
340 $self->{user_rel} ? "~$self->{user}$self->{path}"
341 : $self->{random} ? "?random/$self->{path}"
342 : $self->{path}
343}
344
345# the displayed name, this is a one way mapping
346sub visible_name {
347 my ($self) = @_;
348
349# if (my $rmp = $self->{random}) {
350# # todo: be more intelligent about this
351# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
352# } else {
353 $self->as_string
354# }
355}
356
357# escape the /'s in the path
358sub _escaped_path {
359 # ∕ is U+2215
360 (my $path = $_[0]{path}) =~ s/\//∕/g;
361 $path
362}
363
364# the original (read-only) location
365sub load_path {
366 my ($self) = @_;
367
368 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
369}
370
371# the temporary/swap location
372sub save_path {
373 my ($self) = @_;
374
375 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
376 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
377 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
378}
379
380# the unique path, might be eq to save_path
381sub uniq_path {
382 my ($self) = @_;
383
384 $self->{user_rel} || $self->{random}
385 ? undef
386 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
387}
388
389# return random map parameters, or undef
390sub random_map_params {
391 my ($self) = @_;
392
393 $self->{random}
394}
395
396# this is somewhat ugly, but style maps do need special treatment
397sub is_style_map {
398 $_[0]{path} =~ m{^/styles/}
399}
400
401package cf;
402
403#############################################################################
404
405=head2 ATTACHABLE OBJECTS
406
407Many objects in crossfire are so-called attachable objects. That means you can
408attach callbacks/event handlers (a collection of which is called an "attachment")
409to it. All such attachable objects support the following methods.
410
411In the following description, CLASS can be any of C<global>, C<object>
412C<player>, C<client> or C<map> (i.e. the attachable objects in
413crossfire+).
414
415=over 4
416
417=item $attachable->attach ($attachment, key => $value...)
418
419=item $attachable->detach ($attachment)
420
421Attach/detach a pre-registered attachment to a specific object and give it
422the specified key/value pairs as arguments.
423
424Example, attach a minesweeper attachment to the given object, making it a
42510x10 minesweeper game:
426
427 $obj->attach (minesweeper => width => 10, height => 10);
428
429=item $bool = $attachable->attached ($name)
430
431Checks wether the named attachment is currently attached to the object.
432
433=item cf::CLASS->attach ...
434
435=item cf::CLASS->detach ...
436
437Define an anonymous attachment and attach it to all objects of the given
438CLASS. See the next function for an explanation of its arguments.
439
440You can attach to global events by using the C<cf::global> class.
441
442Example, log all player logins:
443
444 cf::player->attach (
445 on_login => sub {
446 my ($pl) = @_;
447 ...
448 },
449 );
450
451Example, attach to the jeweler skill:
452
453 cf::object->attach (
454 type => cf::SKILL,
455 subtype => cf::SK_JEWELER,
456 on_use_skill => sub {
457 my ($sk, $ob, $part, $dir, $msg) = @_;
458 ...
459 },
460 );
461
462=item cf::CLASS::attachment $name, ...
463
464Register an attachment by C<$name> through which attachable objects of the
465given CLASS can refer to this attachment.
466
467Some classes such as crossfire maps and objects can specify attachments
468that are attached at load/instantiate time, thus the need for a name.
469
470These calls expect any number of the following handler/hook descriptions:
471
472=over 4
473
474=item prio => $number
475
476Set the priority for all following handlers/hooks (unless overwritten
477by another C<prio> setting). Lower priority handlers get executed
478earlier. The default priority is C<0>, and many built-in handlers are
479registered at priority C<-1000>, so lower priorities should not be used
480unless you know what you are doing.
481
482=item type => $type
483
484(Only for C<< cf::object->attach >> calls), limits the attachment to the
485given type of objects only (the additional parameter C<subtype> can be
486used to further limit to the given subtype).
487
488=item on_I<event> => \&cb
489
490Call the given code reference whenever the named event happens (event is
491something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
492handlers are recognised generally depends on the type of object these
493handlers attach to).
494
495See F<include/eventinc.h> for the full list of events supported, and their
496class.
497
498=item package => package::
499
500Look for sub functions of the name C<< on_I<event> >> in the given
501package and register them. Only handlers for eevents supported by the
502object/class are recognised.
503
504=back
505
506Example, define an attachment called "sockpuppet" that calls the given
507event handler when a monster attacks:
508
509 cf::object::attachment sockpuppet =>
510 on_skill_attack => sub {
511 my ($self, $victim) = @_;
512 ...
513 }
514 }
515
516=item $attachable->valid
517
518Just because you have a perl object does not mean that the corresponding
519C-level object still exists. If you try to access an object that has no
520valid C counterpart anymore you get an exception at runtime. This method
521can be used to test for existence of the C object part without causing an
522exception.
523
524=cut
525
526# the following variables are defined in .xs and must not be re-created
527our @CB_GLOBAL = (); # registry for all global events
528our @CB_ATTACHABLE = (); # registry for all attachables
529our @CB_OBJECT = (); # all objects (should not be used except in emergency)
530our @CB_PLAYER = ();
531our @CB_CLIENT = ();
532our @CB_TYPE = (); # registry for type (cf-object class) based events
533our @CB_MAP = ();
534
535my %attachment;
536
537sub _attach_cb($$$$) {
538 my ($registry, $event, $prio, $cb) = @_;
539
540 use sort 'stable';
541
542 $cb = [$prio, $cb];
543
544 @{$registry->[$event]} = sort
545 { $a->[0] cmp $b->[0] }
546 @{$registry->[$event] || []}, $cb;
547}
548
549# hack
550my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
551
552# attach handles attaching event callbacks
553# the only thing the caller has to do is pass the correct
554# registry (== where the callback attaches to).
555sub _attach {
556 my ($registry, $klass, @arg) = @_;
557
558 my $object_type;
559 my $prio = 0;
560 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
561
562 #TODO: get rid of this hack
563 if ($attachable_klass{$klass}) {
564 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
565 }
566
567 while (@arg) {
568 my $type = shift @arg;
569
570 if ($type eq "prio") {
571 $prio = shift @arg;
572
573 } elsif ($type eq "type") {
574 $object_type = shift @arg;
575 $registry = $CB_TYPE[$object_type] ||= [];
576
577 } elsif ($type eq "subtype") {
578 defined $object_type or Carp::croak "subtype specified without type";
579 my $object_subtype = shift @arg;
580 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
581
582 } elsif ($type eq "package") {
583 my $pkg = shift @arg;
584
585 while (my ($name, $id) = each %cb_id) {
586 if (my $cb = $pkg->can ($name)) {
587 _attach_cb $registry, $id, $prio, $cb;
588 }
589 }
590
591 } elsif (exists $cb_id{$type}) {
592 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
593
594 } elsif (ref $type) {
595 warn "attaching objects not supported, ignoring.\n";
596
597 } else {
598 shift @arg;
599 warn "attach argument '$type' not supported, ignoring.\n";
600 }
601 }
602}
603
604sub _object_attach {
605 my ($obj, $name, %arg) = @_;
606
607 return if exists $obj->{_attachment}{$name};
608
609 if (my $attach = $attachment{$name}) {
610 my $registry = $obj->registry;
611
612 for (@$attach) {
613 my ($klass, @attach) = @$_;
614 _attach $registry, $klass, @attach;
615 }
616
617 $obj->{$name} = \%arg;
618 } else {
619 warn "object uses attachment '$name' that is not available, postponing.\n";
620 }
621
622 $obj->{_attachment}{$name} = undef;
623}
624
625sub cf::attachable::attach {
626 if (ref $_[0]) {
627 _object_attach @_;
628 } else {
629 _attach shift->_attach_registry, @_;
630 }
631};
632
633# all those should be optimised
634sub cf::attachable::detach {
635 my ($obj, $name) = @_;
636
637 if (ref $obj) {
638 delete $obj->{_attachment}{$name};
639 reattach ($obj);
640 } else {
641 Carp::croak "cannot, currently, detach class attachments";
642 }
643};
644
645sub cf::attachable::attached {
646 my ($obj, $name) = @_;
647
648 exists $obj->{_attachment}{$name}
649}
650
651for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
652 eval "#line " . __LINE__ . " 'cf.pm'
653 sub cf::\L$klass\E::_attach_registry {
654 (\\\@CB_$klass, KLASS_$klass)
655 }
656
657 sub cf::\L$klass\E::attachment {
658 my \$name = shift;
659
660 \$attachment{\$name} = [[KLASS_$klass, \@_]];
661 }
662 ";
663 die if $@;
664}
665
666our $override;
667our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
668
669sub override {
670 $override = 1;
671 @invoke_results = ();
672}
673
674sub do_invoke {
90 my $event = shift; 675 my $event = shift;
676 my $callbacks = shift;
91 677
92 my $cb = $hook[$event] 678 @invoke_results = ();
679
680 local $override;
681
682 for (@$callbacks) {
683 eval { &{$_->[1]} };
684
685 if ($@) {
686 warn "$@";
687 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
688 override;
689 }
690
691 return 1 if $override;
692 }
693
694 0
695}
696
697=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
698
699=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
700
701Generate an object-specific event with the given arguments.
702
703This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
704removed in future versions), and there is no public API to access override
705results (if you must, access C<@cf::invoke_results> directly).
706
707=back
708
709=cut
710
711#############################################################################
712# object support
713
714sub reattach {
715 # basically do the same as instantiate, without calling instantiate
716 my ($obj) = @_;
717
718 my $registry = $obj->registry;
719
720 @$registry = ();
721
722 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
723
724 for my $name (keys %{ $obj->{_attachment} || {} }) {
725 if (my $attach = $attachment{$name}) {
726 for (@$attach) {
727 my ($klass, @attach) = @$_;
728 _attach $registry, $klass, @attach;
729 }
730 } else {
731 warn "object uses attachment '$name' that is not available, postponing.\n";
732 }
733 }
734}
735
736cf::attachable->attach (
737 prio => -1000000,
738 on_instantiate => sub {
739 my ($obj, $data) = @_;
740
741 $data = from_json $data;
742
743 for (@$data) {
744 my ($name, $args) = @$_;
745
746 $obj->attach ($name, %{$args || {} });
747 }
748 },
749 on_reattach => \&reattach,
750 on_clone => sub {
751 my ($src, $dst) = @_;
752
753 @{$dst->registry} = @{$src->registry};
754
755 %$dst = %$src;
756
757 %{$dst->{_attachment}} = %{$src->{_attachment}}
758 if exists $src->{_attachment};
759 },
760);
761
762sub object_freezer_save {
763 my ($filename, $rdata, $objs) = @_;
764
765 sync_job {
766 if (length $$rdata) {
767 warn sprintf "saving %s (%d,%d)\n",
768 $filename, length $$rdata, scalar @$objs;
769
770 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
771 chmod SAVE_MODE, $fh;
772 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
773 aio_fsync $fh;
774 close $fh;
775
776 if (@$objs) {
777 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
778 chmod SAVE_MODE, $fh;
779 my $data = Storable::nfreeze { version => 1, objs => $objs };
780 aio_write $fh, 0, (length $data), $data, 0;
781 aio_fsync $fh;
782 close $fh;
783 aio_rename "$filename.pst~", "$filename.pst";
784 }
785 } else {
786 aio_unlink "$filename.pst";
787 }
788
789 aio_rename "$filename~", $filename;
790 } else {
791 warn "FATAL: $filename~: $!\n";
792 }
793 } else {
794 aio_unlink $filename;
795 aio_unlink "$filename.pst";
796 }
797 }
798}
799
800sub object_freezer_as_string {
801 my ($rdata, $objs) = @_;
802
803 use Data::Dumper;
804
805 $$rdata . Dumper $objs
806}
807
808sub object_thawer_load {
809 my ($filename) = @_;
810
811 my ($data, $av);
812
813 (aio_load $filename, $data) >= 0
93 or return; 814 or return;
94 815
95 List::Util::max map &$_, values %$cb 816 unless (aio_stat "$filename.pst") {
96} 817 (aio_load "$filename.pst", $av) >= 0
97 818 or return;
98sub inject_command { 819 $av = eval { (Storable::thaw $av)->{objs} };
99 my ($name, $obj, $params) = @_;
100
101 for my $cmd (@{ $command{$name} }) {
102 $cmd->[1]->($obj, $params);
103 } 820 }
104 821
105 -1 822 return ($data, $av);
106} 823}
824
825#############################################################################
826# command handling &c
827
828=item cf::register_command $name => \&callback($ob,$args);
829
830Register a callback for execution when the client sends the user command
831$name.
832
833=cut
107 834
108sub register_command { 835sub register_command {
109 my ($name, $time, $cb) = @_; 836 my ($name, $cb) = @_;
110 837
111 my $caller = caller; 838 my $caller = caller;
112 #warn "registering command '$name/$time' to '$caller'"; 839 #warn "registering command '$name/$time' to '$caller'";
113 840
114 push @{ $command{$name} }, [$time, $cb, $caller]; 841 push @{ $COMMAND{$name} }, [$caller, $cb];
115 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
116} 842}
843
844=item cf::register_extcmd $name => \&callback($pl,$packet);
845
846Register a callbackf ro execution when the client sends an extcmd packet.
847
848If the callback returns something, it is sent back as if reply was being
849called.
850
851=cut
117 852
118sub register_extcmd { 853sub register_extcmd {
119 my ($name, $cb) = @_; 854 my ($name, $cb) = @_;
120 855
121 my $caller = caller; 856 my $caller = caller;
122 #warn "registering extcmd '$name' to '$caller'"; 857 #warn "registering extcmd '$name' to '$caller'";
123 858
124 $extcmd{$name} = [$cb, $caller]; 859 $EXTCMD{$name} = [$cb, $caller];
125} 860}
861
862cf::player->attach (
863 on_command => sub {
864 my ($pl, $name, $params) = @_;
865
866 my $cb = $COMMAND{$name}
867 or return;
868
869 for my $cmd (@$cb) {
870 $cmd->[1]->($pl->ob, $params);
871 }
872
873 cf::override;
874 },
875 on_extcmd => sub {
876 my ($pl, $buf) = @_;
877
878 my $msg = eval { from_json $buf };
879
880 if (ref $msg) {
881 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
882 if (my %reply = $cb->[0]->($pl, $msg)) {
883 $pl->ext_reply ($msg->{msgid}, %reply);
884 }
885 }
886 } else {
887 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
888 }
889
890 cf::override;
891 },
892);
126 893
127sub register { 894sub register {
128 my ($base, $pkg) = @_; 895 my ($base, $pkg) = @_;
129 896
130 for my $idx (0 .. $#EVENT) { 897 #TODO
131 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
132 #warn "registering $EVENT[$idx] hook to '$pkg'\n";
133 $hook[$idx]{$base} = $ref;
134 }
135 }
136} 898}
137 899
138sub load_extension { 900sub load_extension {
139 my ($path) = @_; 901 my ($path) = @_;
140 902
141 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 903 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
142 my $base = $1; 904 my $base = $1;
143 my $pkg = $1; 905 my $pkg = $1;
144 $pkg =~ s/[^[:word:]]/_/g; 906 $pkg =~ s/[^[:word:]]/_/g;
145 $pkg = "cf::ext::$pkg"; 907 $pkg = "ext::$pkg";
146 908
147 warn "loading '$path' into '$pkg'\n"; 909 warn "loading '$path' into '$pkg'\n";
148 910
149 open my $fh, "<:utf8", $path 911 open my $fh, "<:utf8", $path
150 or die "$path: $!"; 912 or die "$path: $!";
154 . "#line 1 \"$path\"\n{\n" 916 . "#line 1 \"$path\"\n{\n"
155 . (do { local $/; <$fh> }) 917 . (do { local $/; <$fh> })
156 . "\n};\n1"; 918 . "\n};\n1";
157 919
158 eval $source 920 eval $source
159 or die "$path: $@"; 921 or die $@ ? "$path: $@\n"
922 : "extension disabled.\n";
160 923
161 push @exts, $pkg; 924 push @exts, $pkg;
162 $ext_pkg{$base} = $pkg; 925 $ext_pkg{$base} = $pkg;
163 926
164# no strict 'refs'; 927# no strict 'refs';
165# @{"$pkg\::ISA"} = cf::ext::; 928# @{"$pkg\::ISA"} = ext::;
166 929
167 register $base, $pkg; 930 register $base, $pkg;
168} 931}
169 932
170sub unload_extension { 933sub unload_extension {
171 my ($pkg) = @_; 934 my ($pkg) = @_;
172 935
173 warn "removing extension $pkg\n"; 936 warn "removing extension $pkg\n";
174 937
175 # remove hooks 938 # remove hooks
939 #TODO
176 for my $idx (0 .. $#EVENT) { 940# for my $idx (0 .. $#PLUGIN_EVENT) {
177 delete $hook[$idx]{$pkg}; 941# delete $hook[$idx]{$pkg};
178 } 942# }
179 943
180 # remove commands 944 # remove commands
181 for my $name (keys %command) { 945 for my $name (keys %COMMAND) {
182 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 946 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
183 947
184 if (@cb) { 948 if (@cb) {
185 $command{$name} = \@cb; 949 $COMMAND{$name} = \@cb;
186 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
187 } else { 950 } else {
188 delete $command{$name};
189 delete $COMMAND{"$name\000"}; 951 delete $COMMAND{$name};
190 } 952 }
191 } 953 }
192 954
193 # remove extcmds 955 # remove extcmds
194 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 956 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
195 delete $extcmd{$name}; 957 delete $EXTCMD{$name};
958 }
959
960 if (my $cb = $pkg->can ("unload")) {
961 eval {
962 $cb->($pkg);
963 1
964 } or warn "$pkg unloaded, but with errors: $@";
196 } 965 }
197 966
198 Symbol::delete_package $pkg; 967 Symbol::delete_package $pkg;
199} 968}
200 969
201sub load_extensions { 970sub load_extensions {
202 my $LIBDIR = maps_directory "perl";
203
204 for my $ext (<$LIBDIR/*.ext>) { 971 for my $ext (<$LIBDIR/*.ext>) {
205 next unless -r $ext; 972 next unless -r $ext;
206 eval { 973 eval {
207 load_extension $ext; 974 load_extension $ext;
208 1 975 1
209 } or warn "$ext not loaded: $@"; 976 } or warn "$ext not loaded: $@";
210 } 977 }
211} 978}
212 979
213register_command "perl-reload", 0, sub { 980#############################################################################
981# load/save/clean perl data associated with a map
982
983*cf::mapsupport::on_clean = sub {
984 my ($map) = @_;
985
986 my $path = $map->tmpname;
987 defined $path or return;
988
989 unlink "$path.pst";
990};
991
992cf::map->attach (prio => -10000, package => cf::mapsupport::);
993
994#############################################################################
995# load/save perl data associated with player->ob objects
996
997sub all_objects(@) {
998 @_, map all_objects ($_->inv), @_
999}
1000
1001# TODO: compatibility cruft, remove when no longer needed
1002cf::player->attach (
1003 on_load => sub {
1004 my ($pl, $path) = @_;
1005
1006 for my $o (all_objects $pl->ob) {
1007 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1008 $o->set_ob_key_value ("_perl_data");
1009
1010 %$o = %{ Storable::thaw pack "H*", $value };
1011 }
1012 }
1013 },
1014);
1015
1016#############################################################################
1017
1018=head2 CORE EXTENSIONS
1019
1020Functions and methods that extend core crossfire objects.
1021
1022=head3 cf::player
1023
1024=over 4
1025
1026=item cf::player::exists $login
1027
1028Returns true when the given account exists.
1029
1030=cut
1031
1032sub cf::player::exists($) {
1033 cf::player::find $_[0]
1034 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1035}
1036
1037=item $player->ext_reply ($msgid, $msgtype, %msg)
1038
1039Sends an ext reply to the player.
1040
1041=cut
1042
1043sub cf::player::ext_reply($$$%) {
1044 my ($self, $id, %msg) = @_;
1045
1046 $msg{msgid} = $id;
1047
1048 $self->send ("ext " . to_json \%msg);
1049}
1050
1051=back
1052
1053
1054=head3 cf::map
1055
1056=over 4
1057
1058=cut
1059
1060package cf::map;
1061
1062use Fcntl;
1063use Coro::AIO;
1064
1065our $MAX_RESET = 7200;
1066our $DEFAULT_RESET = 3600;
1067
1068sub generate_random_map {
214 my ($who, $arg) = @_; 1069 my ($path, $rmp) = @_;
215 1070
216 if ($who->flag (FLAG_WIZ)) { 1071 # mit "rum" bekleckern, nicht
217 $who->message ("reloading..."); 1072 cf::map::_create_random_map
1073 $path,
1074 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1075 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1076 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1077 $rmp->{exit_on_final_map},
1078 $rmp->{xsize}, $rmp->{ysize},
1079 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1080 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1081 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1082 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1083 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1084 (cf::region::find $rmp->{region})
1085}
218 1086
219 warn "reloading...\n"; 1087# and all this just because we cannot iterate over
1088# all maps in C++...
1089sub change_all_map_light {
1090 my ($change) = @_;
1091
1092 $_->change_map_light ($change) for values %cf::MAP;
1093}
1094
1095sub try_load_header($) {
1096 my ($path) = @_;
1097
1098 utf8::encode $path;
1099 aio_open $path, O_RDONLY, 0
1100 or return;
1101
1102 my $map = cf::map::new
1103 or return;
1104
1105 $map->load_header ($path)
1106 or return;
1107
1108 $map->{load_path} = $path;
1109
1110 $map
1111}
1112
1113sub find_map {
1114 my ($path, $origin) = @_;
1115
1116 #warn "find_map<$path,$origin>\n";#d#
1117
1118 $path = new cf::path $path, $origin && $origin->path;
1119 my $key = $path->as_string;
1120
1121 $cf::MAP{$key} || do {
1122 # do it the slow way
1123 my $map = try_load_header $path->save_path;
1124
1125 if ($map) {
1126 # safety
1127 $map->{instantiate_time} = $cf::RUNTIME
1128 if $map->{instantiate_time} > $cf::RUNTIME;
1129 } else {
1130 if (my $rmp = $path->random_map_params) {
1131 $map = generate_random_map $key, $rmp;
1132 } else {
1133 $map = try_load_header $path->load_path;
1134 }
1135
1136 $map or return;
1137
1138 $map->{load_original} = 1;
1139 $map->{instantiate_time} = $cf::RUNTIME;
1140 $map->instantiate;
1141
1142 # per-player maps become, after loading, normal maps
1143 $map->per_player (0) if $path->{user_rel};
1144 }
1145
1146 $map->path ($key);
1147 $map->{path} = $path;
1148 $map->last_access ($cf::RUNTIME);
1149
1150 if ($map->should_reset) {
1151 $map->reset;
1152 $map = find_map $path;
1153 }
1154
1155 $cf::MAP{$key} = $map
1156 }
1157}
1158
1159sub load {
1160 my ($self) = @_;
1161
1162 return if $self->in_memory != cf::MAP_SWAPPED;
1163
1164 $self->in_memory (cf::MAP_LOADING);
1165
1166 my $path = $self->{path};
1167
1168 $self->alloc;
1169 $self->load_objects ($self->{load_path}, 1)
1170 or return;
1171
1172 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1173 if delete $self->{load_original};
1174
1175 if (my $uniq = $path->uniq_path) {
1176 utf8::encode $uniq;
1177 if (aio_open $uniq, O_RDONLY, 0) {
1178 $self->clear_unique_items;
1179 $self->load_objects ($uniq, 0);
1180 }
1181 }
1182
1183 # now do the right thing for maps
1184 $self->link_multipart_objects;
1185
1186 if ($self->{path}->is_style_map) {
1187 $self->{deny_save} = 1;
1188 $self->{deny_reset} = 1;
1189 } else {
1190 $self->fix_auto_apply;
1191 $self->decay_objects;
1192 $self->update_buttons;
1193 $self->set_darkness_map;
1194 $self->difficulty ($self->estimate_difficulty)
1195 unless $self->difficulty;
1196 $self->activate;
1197 }
1198
1199 $self->in_memory (cf::MAP_IN_MEMORY);
1200}
1201
1202sub load_map_sync {
1203 my ($path, $origin) = @_;
1204
1205 #warn "load_map_sync<$path, $origin>\n";#d#
1206
1207 cf::sync_job {
1208 my $map = cf::map::find_map $path, $origin
1209 or return;
1210 $map->load;
1211 $map
1212 }
1213}
1214
1215sub save {
1216 my ($self) = @_;
1217
1218 my $save = $self->{path}->save_path; utf8::encode $save;
1219 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1220
1221 $self->{last_save} = $cf::RUNTIME;
1222
1223 return unless $self->dirty;
1224
1225 $self->{load_path} = $save;
1226
1227 return if $self->{deny_save};
1228
1229 if ($uniq) {
1230 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1231 $self->save_objects ($uniq, cf::IO_UNIQUES);
1232 } else {
1233 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1234 }
1235}
1236
1237sub swap_out {
1238 my ($self) = @_;
1239
1240 return if $self->players;
1241 return if $self->in_memory != cf::MAP_IN_MEMORY;
1242 return if $self->{deny_save};
1243
1244 $self->save;
1245 $self->clear;
1246 $self->in_memory (cf::MAP_SWAPPED);
1247}
1248
1249sub reset_at {
1250 my ($self) = @_;
1251
1252 # TODO: safety, remove and allow resettable per-player maps
1253 return 1e99 if $self->{path}{user_rel};
1254 return 1e99 if $self->{deny_reset};
1255
1256 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1257 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1258
1259 $time + $to
1260}
1261
1262sub should_reset {
1263 my ($self) = @_;
1264
1265 $self->reset_at <= $cf::RUNTIME
1266}
1267
1268sub unlink_save {
1269 my ($self) = @_;
1270
1271 utf8::encode (my $save = $self->{path}->save_path);
1272 aioreq_pri 3; IO::AIO::aio_unlink $save;
1273 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1274}
1275
1276sub rename {
1277 my ($self, $new_path) = @_;
1278
1279 $self->unlink_save;
1280
1281 delete $cf::MAP{$self->path};
1282 $self->{path} = new cf::path $new_path;
1283 $self->path ($self->{path}->as_string);
1284 $cf::MAP{$self->path} = $self;
1285
1286 $self->save;
1287}
1288
1289sub reset {
1290 my ($self) = @_;
1291
1292 return if $self->players;
1293 return if $self->{path}{user_rel};#d#
1294
1295 warn "resetting map ", $self->path;#d#
1296
1297 delete $cf::MAP{$self->path};
1298
1299 $_->clear_links_to ($self) for values %cf::MAP;
1300
1301 $self->unlink_save;
1302 $self->destroy;
1303}
1304
1305my $nuke_counter = "aaaa";
1306
1307sub nuke {
1308 my ($self) = @_;
1309
1310 $self->{deny_save} = 1;
1311 $self->reset_timeout (1);
1312 $self->rename ("{nuke}/" . ($nuke_counter++));
1313 $self->reset; # polite request, might not happen
1314}
1315
1316sub customise_for {
1317 my ($map, $ob) = @_;
1318
1319 if ($map->per_player) {
1320 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
1321 }
1322
1323 $map
1324}
1325
1326sub emergency_save {
1327 local $cf::FREEZE = 1;
1328
1329 warn "enter emergency map save\n";
1330
1331 cf::sync_job {
1332 warn "begin emergency map save\n";
1333 $_->save for values %cf::MAP;
1334 };
1335
1336 warn "end emergency map save\n";
1337}
1338
1339package cf;
1340
1341=back
1342
1343
1344=head3 cf::object::player
1345
1346=over 4
1347
1348=item $player_object->reply ($npc, $msg[, $flags])
1349
1350Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1351can be C<undef>. Does the right thing when the player is currently in a
1352dialogue with the given NPC character.
1353
1354=cut
1355
1356# rough implementation of a future "reply" method that works
1357# with dialog boxes.
1358#TODO: the first argument must go, split into a $npc->reply_to ( method
1359sub cf::object::player::reply($$$;$) {
1360 my ($self, $npc, $msg, $flags) = @_;
1361
1362 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1363
1364 if ($self->{record_replies}) {
1365 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
1366 } else {
1367 $msg = $npc->name . " says: $msg" if $npc;
1368 $self->message ($msg, $flags);
1369 }
1370}
1371
1372=item $player_object->may ("access")
1373
1374Returns wether the given player is authorized to access resource "access"
1375(e.g. "command_wizcast").
1376
1377=cut
1378
1379sub cf::object::player::may {
1380 my ($self, $access) = @_;
1381
1382 $self->flag (cf::FLAG_WIZ) ||
1383 (ref $cf::CFG{"may_$access"}
1384 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1385 : $cf::CFG{"may_$access"})
1386}
1387
1388=item $player_object->enter_link
1389
1390Freezes the player and moves him/her to a special map (C<{link}>).
1391
1392The player should be reaosnably safe there for short amounts of time. You
1393I<MUST> call C<leave_link> as soon as possible, though.
1394
1395=item $player_object->leave_link ($map, $x, $y)
1396
1397Moves the player out of the specila link map onto the given map. If the
1398map is not valid (or omitted), the player will be moved back to the
1399location he/she was before the call to C<enter_link>, or, if that fails,
1400to the emergency map position.
1401
1402Might block.
1403
1404=cut
1405
1406sub cf::object::player::enter_link {
1407 my ($self) = @_;
1408
1409 return if $self->map == $LINK_MAP;
1410
1411 $self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1412 if $self->map;
1413
1414 $self->enter_map ($LINK_MAP, 20, 20);
1415 $self->deactivate_recursive;
1416}
1417
1418sub cf::object::player::leave_link {
1419 my ($self, $map, $x, $y) = @_;
1420
1421 my $link_pos = delete $self->{_link_pos};
1422
1423 unless ($map) {
1424 # restore original map position
1425 ($map, $x, $y) = @{ $link_pos || [] };
1426 $map = cf::map::find_map $map;
1427
1428 unless ($map) {
1429 ($map, $x, $y) = @$EMERGENCY_POSITION;
1430 $map = cf::map::find_map $map
1431 or die "FATAL: cannot load emergency map\n";
1432 }
1433 }
1434
1435 ($x, $y) = (-1, -1)
1436 unless (defined $x) && (defined $y);
1437
1438 # use -1 or undef as default coordinates, not 0, 0
1439 ($x, $y) = ($map->enter_x, $map->enter_y)
1440 if $x <=0 && $y <= 0;
1441
1442 $map->load;
1443
1444 $self->activate_recursive;
1445 $self->enter_map ($map, $x, $y);
1446}
1447
1448=item $player_object->goto_map ($map, $x, $y)
1449
1450=cut
1451
1452sub cf::object::player::goto_map {
1453 my ($self, $path, $x, $y) = @_;
1454
1455 $self->enter_link;
1456
1457 (Coro::async {
1458 $path = new cf::path $path;
1459
1460 my $map = cf::map::find_map $path->as_string;
1461 $map = $map->customise_for ($self) if $map;
1462
1463 warn "entering ", $map->path, " at ($x, $y)\n"
1464 if $map;
1465
1466 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1467
1468 $self->leave_link ($map, $x, $y);
1469 })->prio (1);
1470}
1471
1472=item $player_object->enter_exit ($exit_object)
1473
1474=cut
1475
1476sub parse_random_map_params {
1477 my ($spec) = @_;
1478
1479 my $rmp = { # defaults
1480 xsize => 10,
1481 ysize => 10,
1482 };
1483
1484 for (split /\n/, $spec) {
1485 my ($k, $v) = split /\s+/, $_, 2;
1486
1487 $rmp->{lc $k} = $v if (length $k) && (length $v);
1488 }
1489
1490 $rmp
1491}
1492
1493sub prepare_random_map {
1494 my ($exit) = @_;
1495
1496 # all this does is basically replace the /! path by
1497 # a new random map path (?random/...) with a seed
1498 # that depends on the exit object
1499
1500 my $rmp = parse_random_map_params $exit->msg;
1501
1502 if ($exit->map) {
1503 $rmp->{region} = $exit->map->region_name;
1504 $rmp->{origin_map} = $exit->map->path;
1505 $rmp->{origin_x} = $exit->x;
1506 $rmp->{origin_y} = $exit->y;
1507 }
1508
1509 $rmp->{random_seed} ||= $exit->random_seed;
1510
1511 my $data = cf::to_json $rmp;
1512 my $md5 = Digest::MD5::md5_hex $data;
1513
1514 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1515 aio_write $fh, 0, (length $data), $data, 0;
1516
1517 $exit->slaying ("?random/$md5");
1518 $exit->msg (undef);
1519 }
1520}
1521
1522sub cf::object::player::enter_exit {
1523 my ($self, $exit) = @_;
1524
1525 return unless $self->type == cf::PLAYER;
1526
1527 $self->enter_link;
1528
1529 (Coro::async {
1530 unless (eval {
1531
1532 prepare_random_map $exit
1533 if $exit->slaying eq "/!";
1534
1535 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1536 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1537
1538 1;
1539 }) {
1540 $self->message ("Something went wrong deep within the crossfire server. "
1541 . "I'll try to bring you back to the map you were before. "
1542 . "Please report this to the dungeon master",
1543 cf::NDI_UNIQUE | cf::NDI_RED);
1544
1545 warn "ERROR in enter_exit: $@";
1546 $self->leave_link;
1547 }
1548 })->prio (1);
1549}
1550
1551=head3 cf::client
1552
1553=over 4
1554
1555=item $client->send_drawinfo ($text, $flags)
1556
1557Sends a drawinfo packet to the client. Circumvents output buffering so
1558should not be used under normal circumstances.
1559
1560=cut
1561
1562sub cf::client::send_drawinfo {
1563 my ($self, $text, $flags) = @_;
1564
1565 utf8::encode $text;
1566 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1567}
1568
1569
1570=item $success = $client->query ($flags, "text", \&cb)
1571
1572Queues a query to the client, calling the given callback with
1573the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1574C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1575
1576Queries can fail, so check the return code. Or don't, as queries will become
1577reliable at some point in the future.
1578
1579=cut
1580
1581sub cf::client::query {
1582 my ($self, $flags, $text, $cb) = @_;
1583
1584 return unless $self->state == ST_PLAYING
1585 || $self->state == ST_SETUP
1586 || $self->state == ST_CUSTOM;
1587
1588 $self->state (ST_CUSTOM);
1589
1590 utf8::encode $text;
1591 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1592
1593 $self->send_packet ($self->{query_queue}[0][0])
1594 if @{ $self->{query_queue} } == 1;
1595}
1596
1597cf::client->attach (
1598 on_reply => sub {
1599 my ($ns, $msg) = @_;
1600
1601 # this weird shuffling is so that direct followup queries
1602 # get handled first
1603 my $queue = delete $ns->{query_queue};
1604
1605 (shift @$queue)->[1]->($msg);
1606
1607 push @{ $ns->{query_queue} }, @$queue;
1608
1609 if (@{ $ns->{query_queue} } == @$queue) {
1610 if (@$queue) {
1611 $ns->send_packet ($ns->{query_queue}[0][0]);
1612 } else {
1613 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1614 }
1615 }
1616 },
1617);
1618
1619=item $client->coro (\&cb)
1620
1621Create a new coroutine, running the specified callback. The coroutine will
1622be automatically cancelled when the client gets destroyed (e.g. on logout,
1623or loss of connection).
1624
1625=cut
1626
1627sub cf::client::coro {
1628 my ($self, $cb) = @_;
1629
1630 my $coro; $coro = async {
220 eval { 1631 eval {
221 $_->cancel for Event::all_watchers; 1632 $cb->();
222
223 unload_extension $_ for @exts;
224 delete $INC{"cf.pm"};
225
226 # don't, removes xs symbols, too
227 #Symbol::delete_package $pkg;
228
229 require cf;
230 }; 1633 };
231 warn $@ if $@; 1634 warn $@ if $@;
232 $who->message ($@) if $@;
233 warn "reloaded\n";
234
235 $who->message ("reloaded");
236 } else {
237 $who->message ("Intruder Alert!");
238 } 1635 };
1636
1637 $coro->on_destroy (sub {
1638 delete $self->{_coro}{$coro+0};
1639 });
1640
1641 $self->{_coro}{$coro+0} = $coro;
1642
1643 $coro
1644}
1645
1646cf::client->attach (
1647 on_destroy => sub {
1648 my ($ns) = @_;
1649
1650 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1651 },
1652);
1653
1654=back
1655
1656
1657=head2 SAFE SCRIPTING
1658
1659Functions that provide a safe environment to compile and execute
1660snippets of perl code without them endangering the safety of the server
1661itself. Looping constructs, I/O operators and other built-in functionality
1662is not available in the safe scripting environment, and the number of
1663functions and methods that can be called is greatly reduced.
1664
1665=cut
1666
1667our $safe = new Safe "safe";
1668our $safe_hole = new Safe::Hole;
1669
1670$SIG{FPE} = 'IGNORE';
1671
1672$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
1673
1674# here we export the classes and methods available to script code
1675
1676=pod
1677
1678The following fucntions and emthods are available within a safe environment:
1679
1680 cf::object contr pay_amount pay_player map
1681 cf::object::player player
1682 cf::player peaceful
1683 cf::map trigger
1684
1685=cut
1686
1687for (
1688 ["cf::object" => qw(contr pay_amount pay_player map)],
1689 ["cf::object::player" => qw(player)],
1690 ["cf::player" => qw(peaceful)],
1691 ["cf::map" => qw(trigger)],
1692) {
1693 no strict 'refs';
1694 my ($pkg, @funs) = @$_;
1695 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
1696 for @funs;
1697}
1698
1699=over 4
1700
1701=item @retval = safe_eval $code, [var => value, ...]
1702
1703Compiled and executes the given perl code snippet. additional var/value
1704pairs result in temporary local (my) scalar variables of the given name
1705that are available in the code snippet. Example:
1706
1707 my $five = safe_eval '$first + $second', first => 1, second => 4;
1708
1709=cut
1710
1711sub safe_eval($;@) {
1712 my ($code, %vars) = @_;
1713
1714 my $qcode = $code;
1715 $qcode =~ s/"/‟/g; # not allowed in #line filenames
1716 $qcode =~ s/\n/\\n/g;
1717
1718 local $_;
1719 local @safe::cf::_safe_eval_args = values %vars;
1720
1721 my $eval =
1722 "do {\n"
1723 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
1724 . "#line 0 \"{$qcode}\"\n"
1725 . $code
1726 . "\n}"
1727 ;
1728
1729 sub_generation_inc;
1730 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
1731 sub_generation_inc;
1732
1733 if ($@) {
1734 warn "$@";
1735 warn "while executing safe code '$code'\n";
1736 warn "with arguments " . (join " ", %vars) . "\n";
1737 }
1738
1739 wantarray ? @res : $res[0]
1740}
1741
1742=item cf::register_script_function $function => $cb
1743
1744Register a function that can be called from within map/npc scripts. The
1745function should be reasonably secure and should be put into a package name
1746like the extension.
1747
1748Example: register a function that gets called whenever a map script calls
1749C<rent::overview>, as used by the C<rent> extension.
1750
1751 cf::register_script_function "rent::overview" => sub {
1752 ...
1753 };
1754
1755=cut
1756
1757sub register_script_function {
1758 my ($fun, $cb) = @_;
1759
1760 no strict 'refs';
1761 *{"safe::$fun"} = $safe_hole->wrap ($cb);
1762}
1763
1764=back
1765
1766=cut
1767
1768#############################################################################
1769
1770=head2 EXTENSION DATABASE SUPPORT
1771
1772Crossfire maintains a very simple database for extension use. It can
1773currently store anything that can be serialised using Storable, which
1774excludes objects.
1775
1776The parameter C<$family> should best start with the name of the extension
1777using it, it should be unique.
1778
1779=over 4
1780
1781=item $hashref = cf::db_get $family
1782
1783Return a hashref for use by the extension C<$family>, which can be
1784modified. After modifications, you have to call C<cf::db_dirty> or
1785C<cf::db_sync>.
1786
1787=item $value = cf::db_get $family => $key
1788
1789Returns a single value from the database
1790
1791=item cf::db_put $family => $hashref
1792
1793Stores the given family hashref into the database. Updates are delayed, if
1794you want the data to be synced to disk immediately, use C<cf::db_sync>.
1795
1796=item cf::db_put $family => $key => $value
1797
1798Stores the given C<$value> in the family hash. Updates are delayed, if you
1799want the data to be synced to disk immediately, use C<cf::db_sync>.
1800
1801=item cf::db_dirty
1802
1803Marks the database as dirty, to be updated at a later time.
1804
1805=item cf::db_sync
1806
1807Immediately write the database to disk I<if it is dirty>.
1808
1809=cut
1810
1811our $DB;
1812
1813{
1814 my $path = cf::localdir . "/database.pst";
1815
1816 sub db_load() {
1817 warn "loading database $path\n";#d# remove later
1818 $DB = stat $path ? Storable::retrieve $path : { };
1819 }
1820
1821 my $pid;
1822
1823 sub db_save() {
1824 warn "saving database $path\n";#d# remove later
1825 waitpid $pid, 0 if $pid;
1826 if (0 == ($pid = fork)) {
1827 $DB->{_meta}{version} = 1;
1828 Storable::nstore $DB, "$path~";
1829 rename "$path~", $path;
1830 cf::_exit 0 if defined $pid;
1831 }
1832 }
1833
1834 my $dirty;
1835
1836 sub db_sync() {
1837 db_save if $dirty;
1838 undef $dirty;
1839 }
1840
1841 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1842 db_sync;
1843 });
1844
1845 sub db_dirty() {
1846 $dirty = 1;
1847 $idle->start;
1848 }
1849
1850 sub db_get($;$) {
1851 @_ >= 2
1852 ? $DB->{$_[0]}{$_[1]}
1853 : ($DB->{$_[0]} ||= { })
1854 }
1855
1856 sub db_put($$;$) {
1857 if (@_ >= 3) {
1858 $DB->{$_[0]}{$_[1]} = $_[2];
1859 } else {
1860 $DB->{$_[0]} = $_[1];
1861 }
1862 db_dirty;
1863 }
1864
1865 cf::global->attach (
1866 prio => 10000,
1867 on_cleanup => sub {
1868 db_sync;
1869 },
1870 );
1871}
1872
1873#############################################################################
1874# the server's main()
1875
1876sub cfg_load {
1877 open my $fh, "<:utf8", cf::confdir . "/config"
1878 or return;
1879
1880 local $/;
1881 *CFG = YAML::Syck::Load <$fh>;
1882}
1883
1884sub main {
1885 # we must not ever block the main coroutine
1886 local $Coro::idle = sub {
1887 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1888 (Coro::unblock_sub {
1889 Event::one_event;
1890 })->();
1891 };
1892
1893 cfg_load;
1894 db_load;
1895 load_extensions;
1896 Event::loop;
1897}
1898
1899#############################################################################
1900# initialisation
1901
1902sub reload() {
1903 # can/must only be called in main
1904 if ($Coro::current != $Coro::main) {
1905 warn "can only reload from main coroutine\n";
1906 return;
1907 }
1908
1909 warn "reloading...";
1910
1911 local $FREEZE = 1;
1912 cf::emergency_save;
1913
1914 eval {
1915 # if anything goes wrong in here, we should simply crash as we already saved
1916
1917 # cancel all watchers
1918 for (Event::all_watchers) {
1919 $_->cancel if $_->data & WF_AUTOCANCEL;
1920 }
1921
1922 # cancel all extension coros
1923 $_->cancel for values %EXT_CORO;
1924 %EXT_CORO = ();
1925
1926 # unload all extensions
1927 for (@exts) {
1928 warn "unloading <$_>";
1929 unload_extension $_;
1930 }
1931
1932 # unload all modules loaded from $LIBDIR
1933 while (my ($k, $v) = each %INC) {
1934 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1935
1936 warn "removing <$k>";
1937 delete $INC{$k};
1938
1939 $k =~ s/\.pm$//;
1940 $k =~ s/\//::/g;
1941
1942 if (my $cb = $k->can ("unload_module")) {
1943 $cb->();
1944 }
1945
1946 Symbol::delete_package $k;
1947 }
1948
1949 # sync database to disk
1950 cf::db_sync;
1951 IO::AIO::flush;
1952
1953 # get rid of safe::, as good as possible
1954 Symbol::delete_package "safe::$_"
1955 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1956
1957 # remove register_script_function callbacks
1958 # TODO
1959
1960 # unload cf.pm "a bit"
1961 delete $INC{"cf.pm"};
1962
1963 # don't, removes xs symbols, too,
1964 # and global variables created in xs
1965 #Symbol::delete_package __PACKAGE__;
1966
1967 # reload cf.pm
1968 warn "reloading cf.pm";
1969 require cf;
1970 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1971
1972 # load config and database again
1973 cf::cfg_load;
1974 cf::db_load;
1975
1976 # load extensions
1977 warn "load extensions";
1978 cf::load_extensions;
1979
1980 # reattach attachments to objects
1981 warn "reattach";
1982 _global_reattach;
1983 };
1984
1985 if ($@) {
1986 warn $@;
1987 warn "error while reloading, exiting.";
1988 exit 1;
1989 }
1990
1991 warn "reloaded successfully";
239}; 1992};
240 1993
241############################################################################# 1994#############################################################################
242# extcmd framework, basically convert ext <id> <pkg> arg1 args
243# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
244 1995
245sub on_extcmd { 1996unless ($LINK_MAP) {
1997 $LINK_MAP = cf::map::new;
1998
1999 $LINK_MAP->width (41);
2000 $LINK_MAP->height (41);
2001 $LINK_MAP->alloc;
2002 $LINK_MAP->path ("{link}");
2003 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2004 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2005
2006 # dirty hack because... archetypes are not yet loaded
2007 Event->timer (
2008 after => 2,
2009 cb => sub {
2010 $_[0]->w->cancel;
2011
2012 # provide some exits "home"
2013 my $exit = cf::object::new "exit";
2014
2015 $exit->slaying ($EMERGENCY_POSITION->[0]);
2016 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2017 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2018
2019 $LINK_MAP->insert ($exit->clone, 19, 19);
2020 $LINK_MAP->insert ($exit->clone, 19, 20);
2021 $LINK_MAP->insert ($exit->clone, 19, 21);
2022 $LINK_MAP->insert ($exit->clone, 20, 19);
2023 $LINK_MAP->insert ($exit->clone, 20, 21);
2024 $LINK_MAP->insert ($exit->clone, 21, 19);
2025 $LINK_MAP->insert ($exit->clone, 21, 20);
2026 $LINK_MAP->insert ($exit->clone, 21, 21);
2027
2028 $exit->destroy;
2029 });
2030
2031 $LINK_MAP->{deny_save} = 1;
2032 $LINK_MAP->{deny_reset} = 1;
2033
2034 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2035}
2036
2037register "<global>", __PACKAGE__;
2038
2039register_command "reload" => sub {
246 my ($pl, $buf) = @_; 2040 my ($who, $arg) = @_;
247 2041
248 my ($type) = $buf =~ s/^(\S+) // ? $1 : ""; 2042 if ($who->flag (FLAG_WIZ)) {
249 2043 $who->message ("start of reload.");
250 $extcmd{$type}[0]->($pl, $buf) 2044 reload;
251 if $extcmd{$type}; 2045 $who->message ("end of reload.");
252} 2046 }
253
254#############################################################################
255# load/save/clean perl data associated with a map
256
257*on_mapclean = sub {
258 my ($map) = @_;
259
260 my $path = $map->tmpname;
261 defined $path or return;
262
263 unlink "$path.cfperl";
264}; 2047};
265 2048
266*on_mapin = 2049unshift @INC, $LIBDIR;
267*on_mapload = sub {
268 my ($map) = @_;
269 2050
270 my $path = $map->tmpname; 2051$TICK_WATCHER = Event->timer (
271 $path = $map->path unless defined $path; 2052 reentrant => 0,
272 2053 prio => 0,
273 open my $fh, "<:raw", "$path.cfperl" 2054 at => $NEXT_TICK || $TICK,
274 or return; # no perl data 2055 data => WF_AUTOCANCEL,
275 2056 cb => sub {
276 my $data = Storable::thaw do { local $/; <$fh> }; 2057 unless ($FREEZE) {
277 2058 cf::server_tick; # one server iteration
278 $data->{version} <= 1 2059 $RUNTIME += $TICK;
279 or return; # too new
280
281 $map->_set_obs ($data->{obs});
282};
283
284*on_mapout = sub {
285 my ($map) = @_;
286
287 my $path = $map->tmpname;
288 $path = $map->path unless defined $path;
289
290 my $obs = $map->_get_obs;
291
292 if (defined $obs) {
293 open my $fh, ">:raw", "$path.cfperl"
294 or die "$path.cfperl: $!";
295
296 stat $path;
297
298 print $fh Storable::nfreeze {
299 size => (stat _)[7],
300 time => (stat _)[9],
301 version => 1,
302 obs => $obs,
303 }; 2060 }
304 2061
305 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g* 2062 $NEXT_TICK += $TICK;
306 } else { 2063
307 unlink "$path.cfperl"; 2064 # if we are delayed by four ticks or more, skip them all
2065 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2066
2067 $TICK_WATCHER->at ($NEXT_TICK);
2068 $TICK_WATCHER->start;
308 } 2069 },
309}; 2070);
310 2071
311############################################################################# 2072IO::AIO::max_poll_time $TICK * 0.2;
312# load/save perl data associated with player->ob objects
313 2073
314*on_player_load = sub { 2074Event->io (
315 my ($ob, $path) = @_; 2075 fd => IO::AIO::poll_fileno,
2076 poll => 'r',
2077 prio => 5,
2078 data => WF_AUTOCANCEL,
2079 cb => \&IO::AIO::poll_cb,
2080);
316 2081
317 if (open my $fh, "<:raw", "$path.cfperl") { 2082Event->timer (
318 2083 data => WF_AUTOCANCEL,
319 #d##TODO#remove 2084 after => 0,
320 2085 interval => 10,
321 my $data = Storable::thaw do { local $/; <$fh> }; 2086 cb => sub {
322 2087 (Coro::unblock_sub {
323 $data->{version} <= 1 2088 write_runtime
324 or return; # too new 2089 or warn "ERROR: unable to write runtime file: $!";
325 2090 })->();
326 %$ob = %{$data->{ob}};
327 return;
328 } 2091 },
329 2092);
330 for my $o ($ob, $ob->inv) {
331 if (my $value = $o->get_ob_key_value ("_perl_data")) {
332 $o->set_ob_key_value ("_perl_data");
333
334 %$o = %{ Storable::thaw pack "H*", $value };
335 }
336 }
337};
338
339*on_player_save = sub {
340 my ($ob, $path) = @_;
341
342 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
343 for grep %$_, $ob, $ob->inv;
344
345 unlink "$path.cfperl";#d##TODO#remove
346};
347
348register "<global>", __PACKAGE__;
349
350unshift @INC, maps_directory "perl";
351
352load_extensions;
353 2093
3541 20941
355 2095

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines