ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
Revision: 1.124
Committed: Tue Jan 2 22:55:05 2007 UTC (17 years, 4 months ago) by root
Branch: MAIN
Changes since 1.123: +2 -1 lines
Log Message:
*** empty log message ***

File Contents

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