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.25 by root, Thu Jul 20 07:22:40 2006 UTC vs.
Revision 1.118 by root, Mon Jan 1 21:19:52 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;
6use Opcode; 9use Opcode;
7use Safe; 10use Safe;
8use Safe::Hole; 11use Safe::Hole;
9 12
13use Coro 3.3;
10use 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
11$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
12 27
13use strict; 28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1;
14 30
15our %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
16our @EVENT; 39our @EVENT;
17our %PROP_TYPE; 40our $LIBDIR = datadir . "/ext";
18our %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
19 115
20BEGIN { 116BEGIN {
21 @EVENT = map lc, @EVENT;
22
23 *CORE::GLOBAL::warn = sub { 117 *CORE::GLOBAL::warn = sub {
24 my $msg = join "", @_; 118 my $msg = join "", @_;
119 utf8::encode $msg;
120
25 $msg .= "\n" 121 $msg .= "\n"
26 unless $msg =~ /\n$/; 122 unless $msg =~ /\n$/;
27 123
28 print STDERR "cfperl: $msg";
29 LOG llevError, "cfperl: $msg"; 124 LOG llevError, "cfperl: $msg";
30 }; 125 };
31} 126}
32 127
33my %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';
34 134
35# generate property mutators 135# we bless all objects into (empty) derived classes to force a method lookup
36sub prop_gen { 136# within the Safe compartment.
37 my ($prefix, $class) = @_; 137for my $pkg (qw(
38 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)) {
39 no strict 'refs'; 144 no strict 'refs';
40
41 for my $prop (keys %PROP_TYPE) {
42 $prop =~ /^\Q$prefix\E_(.*$)/ or next;
43 my $sub = lc $1;
44
45 my $type = $PROP_TYPE{$prop};
46 my $idx = $PROP_IDX {$prop};
47
48 *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub {
49 $_[0]->get_property ($type, $idx)
50 };
51
52 *{"$class\::set_$sub"} = sub {
53 $_[0]->set_property ($type, $idx, $_[1]);
54 } unless $ignore_set{$prop};
55 }
56}
57
58# auto-generate most of the API
59
60prop_gen OBJECT_PROP => "cf::object";
61# CFAPI_OBJECT_ANIMATION?
62prop_gen PLAYER_PROP => "cf::object::player";
63
64prop_gen MAP_PROP => "cf::map";
65prop_gen ARCH_PROP => "cf::arch";
66
67# guessed hierarchies
68
69@ext::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
70@ext::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object';
71
72# we bless all objects into derived classes to force a method lookup
73# within the Safe compartment.
74for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region)) {
75 no strict 'refs';
76 @{"ext::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 145 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
77} 146}
78 147
79$Event::DIED = sub { 148$Event::DIED = sub {
80 warn "error in event callback: @_"; 149 warn "error in event callback: @_";
81}; 150};
82 151
83my %ext_pkg; 152my %ext_pkg;
84my @exts; 153my @exts;
85my @hook; 154my @hook;
86my %command;
87my %extcmd;
88 155
89sub inject_event { 156=head2 UTILITY FUNCTIONS
90 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(&) {
91 my $event_code = shift; 240 my $cb = shift;
92 241
93 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
94 or return; 261 or return;
95 262
96 &$cb 263 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
97} 264 (aio_write $fh, 0, (length $value), $value, 0) <= 0
265 and return;
98 266
99sub 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 {
100 my $event = shift; 675 my $event = shift;
676 my $callbacks = shift;
101 677
102 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
103 or return; 814 or return;
104 815
105 List::Util::max map &$_, values %$cb 816 unless (aio_stat "$filename.pst") {
106} 817 (aio_load "$filename.pst", $av) >= 0
107 818 or return;
108sub inject_command { 819 $av = eval { (Storable::thaw $av)->{objs} };
109 my ($name, $obj, $params) = @_;
110
111 for my $cmd (@{ $command{$name} }) {
112 $cmd->[1]->($obj, $params);
113 } 820 }
114 821
115 -1 822 warn sprintf "loading %s (%d)\n",
823 $filename, length $data, scalar @{$av || []};#d#
824 return ($data, $av);
116} 825}
826
827#############################################################################
828# command handling &c
829
830=item cf::register_command $name => \&callback($ob,$args);
831
832Register a callback for execution when the client sends the user command
833$name.
834
835=cut
117 836
118sub register_command { 837sub register_command {
119 my ($name, $time, $cb) = @_; 838 my ($name, $cb) = @_;
120 839
121 my $caller = caller; 840 my $caller = caller;
122 #warn "registering command '$name/$time' to '$caller'"; 841 #warn "registering command '$name/$time' to '$caller'";
123 842
124 push @{ $command{$name} }, [$time, $cb, $caller]; 843 push @{ $COMMAND{$name} }, [$caller, $cb];
125 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
126} 844}
845
846=item cf::register_extcmd $name => \&callback($pl,$packet);
847
848Register a callbackf ro execution when the client sends an extcmd packet.
849
850If the callback returns something, it is sent back as if reply was being
851called.
852
853=cut
127 854
128sub register_extcmd { 855sub register_extcmd {
129 my ($name, $cb) = @_; 856 my ($name, $cb) = @_;
130 857
131 my $caller = caller; 858 my $caller = caller;
132 #warn "registering extcmd '$name' to '$caller'"; 859 #warn "registering extcmd '$name' to '$caller'";
133 860
134 $extcmd{$name} = [$cb, $caller]; 861 $EXTCMD{$name} = [$cb, $caller];
135} 862}
863
864cf::player->attach (
865 on_command => sub {
866 my ($pl, $name, $params) = @_;
867
868 my $cb = $COMMAND{$name}
869 or return;
870
871 for my $cmd (@$cb) {
872 $cmd->[1]->($pl->ob, $params);
873 }
874
875 cf::override;
876 },
877 on_extcmd => sub {
878 my ($pl, $buf) = @_;
879
880 my $msg = eval { from_json $buf };
881
882 if (ref $msg) {
883 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
884 if (my %reply = $cb->[0]->($pl, $msg)) {
885 $pl->ext_reply ($msg->{msgid}, %reply);
886 }
887 }
888 } else {
889 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
890 }
891
892 cf::override;
893 },
894);
136 895
137sub register { 896sub register {
138 my ($base, $pkg) = @_; 897 my ($base, $pkg) = @_;
139 898
140 for my $idx (0 .. $#EVENT) { 899 #TODO
141 if (my $ref = $pkg->can ("on_$EVENT[$idx]")) {
142 #warn "registering $EVENT[$idx] hook to '$pkg'\n";
143 $hook[$idx]{$base} = $ref;
144 }
145 }
146} 900}
147 901
148sub load_extension { 902sub load_extension {
149 my ($path) = @_; 903 my ($path) = @_;
150 904
151 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 905 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
152 my $base = $1; 906 my $base = $1;
153 my $pkg = $1; 907 my $pkg = $1;
154 $pkg =~ s/[^[:word:]]/_/g; 908 $pkg =~ s/[^[:word:]]/_/g;
155 $pkg = "cf::ext::$pkg"; 909 $pkg = "ext::$pkg";
156 910
157 warn "loading '$path' into '$pkg'\n"; 911 warn "loading '$path' into '$pkg'\n";
158 912
159 open my $fh, "<:utf8", $path 913 open my $fh, "<:utf8", $path
160 or die "$path: $!"; 914 or die "$path: $!";
164 . "#line 1 \"$path\"\n{\n" 918 . "#line 1 \"$path\"\n{\n"
165 . (do { local $/; <$fh> }) 919 . (do { local $/; <$fh> })
166 . "\n};\n1"; 920 . "\n};\n1";
167 921
168 eval $source 922 eval $source
169 or die "$path: $@"; 923 or die $@ ? "$path: $@\n"
924 : "extension disabled.\n";
170 925
171 push @exts, $pkg; 926 push @exts, $pkg;
172 $ext_pkg{$base} = $pkg; 927 $ext_pkg{$base} = $pkg;
173 928
174# no strict 'refs'; 929# no strict 'refs';
180sub unload_extension { 935sub unload_extension {
181 my ($pkg) = @_; 936 my ($pkg) = @_;
182 937
183 warn "removing extension $pkg\n"; 938 warn "removing extension $pkg\n";
184 939
185 if (my $cb = $pkg->can ("on_unload")) {
186 $cb->($pkg);
187 }
188
189 # remove hooks 940 # remove hooks
941 #TODO
190 for my $idx (0 .. $#EVENT) { 942# for my $idx (0 .. $#PLUGIN_EVENT) {
191 delete $hook[$idx]{$pkg}; 943# delete $hook[$idx]{$pkg};
192 } 944# }
193 945
194 # remove commands 946 # remove commands
195 for my $name (keys %command) { 947 for my $name (keys %COMMAND) {
196 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 948 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
197 949
198 if (@cb) { 950 if (@cb) {
199 $command{$name} = \@cb; 951 $COMMAND{$name} = \@cb;
200 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
201 } else { 952 } else {
202 delete $command{$name};
203 delete $COMMAND{"$name\000"}; 953 delete $COMMAND{$name};
204 } 954 }
205 } 955 }
206 956
207 # remove extcmds 957 # remove extcmds
208 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 958 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
209 delete $extcmd{$name}; 959 delete $EXTCMD{$name};
960 }
961
962 if (my $cb = $pkg->can ("unload")) {
963 eval {
964 $cb->($pkg);
965 1
966 } or warn "$pkg unloaded, but with errors: $@";
210 } 967 }
211 968
212 Symbol::delete_package $pkg; 969 Symbol::delete_package $pkg;
213} 970}
214 971
215sub load_extensions { 972sub load_extensions {
216 my $LIBDIR = maps_directory "perl";
217
218 for my $ext (<$LIBDIR/*.ext>) { 973 for my $ext (<$LIBDIR/*.ext>) {
219 next unless -r $ext; 974 next unless -r $ext;
220 eval { 975 eval {
221 load_extension $ext; 976 load_extension $ext;
222 1 977 1
223 } or warn "$ext not loaded: $@"; 978 } or warn "$ext not loaded: $@";
224 } 979 }
225} 980}
226 981
227register_command "perl-reload", 0, sub {
228 my ($who, $arg) = @_;
229
230 if ($who->flag (FLAG_WIZ)) {
231 $who->message ("reloading...");
232
233 warn "reloading...\n";
234 eval {
235 $_->cancel for Event::all_watchers;
236
237 unload_extension $_ for @exts;
238 delete $INC{"cf.pm"};
239
240 # don't, removes xs symbols, too
241 #Symbol::delete_package __PACKAGE__;
242
243 require cf;
244 };
245 warn $@ if $@;
246 $who->message ($@) if $@;
247 warn "reloaded\n";
248
249 $who->message ("reloaded");
250 } else {
251 $who->message ("Intruder Alert!");
252 }
253};
254
255#############################################################################
256# extcmd framework, basically convert ext <id> <pkg> arg1 args
257# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
258
259sub on_extcmd {
260 my ($pl, $buf) = @_;
261
262 my ($type) = $buf =~ s/^(\S+) // ? $1 : "";
263
264 $extcmd{$type}[0]->($pl, $buf)
265 if $extcmd{$type};
266}
267
268############################################################################# 982#############################################################################
269# load/save/clean perl data associated with a map 983# load/save/clean perl data associated with a map
270 984
271*on_mapclean = sub { 985*cf::mapsupport::on_clean = sub {
272 my ($map) = @_; 986 my ($map) = @_;
273 987
274 my $path = $map->tmpname; 988 my $path = $map->tmpname;
275 defined $path or return; 989 defined $path or return;
276 990
277 unlink "$path.cfperl"; 991 unlink "$path.pst";
278}; 992};
279 993
280*on_mapin = 994cf::map->attach (prio => -10000, package => cf::mapsupport::);
281*on_mapload = sub {
282 my ($map) = @_;
283
284 my $path = $map->tmpname;
285 $path = $map->path unless defined $path;
286
287 open my $fh, "<:raw", "$path.cfperl"
288 or return; # no perl data
289
290 my $data = Storable::thaw do { local $/; <$fh> };
291
292 $data->{version} <= 1
293 or return; # too new
294
295 $map->_set_obs ($data->{obs});
296};
297
298*on_mapout = sub {
299 my ($map) = @_;
300
301 my $path = $map->tmpname;
302 $path = $map->path unless defined $path;
303
304 my $obs = $map->_get_obs;
305
306 if (defined $obs) {
307 open my $fh, ">:raw", "$path.cfperl"
308 or die "$path.cfperl: $!";
309
310 stat $path;
311
312 print $fh Storable::nfreeze {
313 size => (stat _)[7],
314 time => (stat _)[9],
315 version => 1,
316 obs => $obs,
317 };
318
319 chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g*
320 } else {
321 unlink "$path.cfperl";
322 }
323};
324 995
325############################################################################# 996#############################################################################
326# load/save perl data associated with player->ob objects 997# load/save perl data associated with player->ob objects
327 998
328*on_player_load = sub { 999sub all_objects(@) {
1000 @_, map all_objects ($_->inv), @_
1001}
1002
1003# TODO: compatibility cruft, remove when no longer needed
1004cf::player->attach (
1005 on_load => sub {
329 my ($ob, $path) = @_; 1006 my ($pl, $path) = @_;
330 1007
331 if (open my $fh, "<:raw", "$path.cfperl") { 1008 for my $o (all_objects $pl->ob) {
332
333 #d##TODO#remove
334
335 my $data = Storable::thaw do { local $/; <$fh> };
336
337 $data->{version} <= 1
338 or return; # too new
339
340 %$ob = %{$data->{ob}};
341 return;
342 }
343
344 for my $o ($ob, $ob->inv) {
345 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1009 if (my $value = $o->get_ob_key_value ("_perl_data")) {
346 $o->set_ob_key_value ("_perl_data"); 1010 $o->set_ob_key_value ("_perl_data");
347 1011
348 %$o = %{ Storable::thaw pack "H*", $value }; 1012 %$o = %{ Storable::thaw pack "H*", $value };
349 } 1013 }
1014 }
350 } 1015 },
351}; 1016);
352
353*on_player_save = sub {
354 my ($ob, $path) = @_;
355
356 $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_)
357 for grep %$_, $ob, $ob->inv;
358
359 unlink "$path.cfperl";#d##TODO#remove
360};
361 1017
362############################################################################# 1018#############################################################################
363# core extensions - in perl 1019
1020=head2 CORE EXTENSIONS
1021
1022Functions and methods that extend core crossfire objects.
1023
1024=head3 cf::player
1025
1026=over 4
364 1027
365=item cf::player::exists $login 1028=item cf::player::exists $login
366 1029
367Returns true when the given account exists. 1030Returns true when the given account exists.
368 1031
371sub cf::player::exists($) { 1034sub cf::player::exists($) {
372 cf::player::find $_[0] 1035 cf::player::find $_[0]
373 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1036 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
374} 1037}
375 1038
1039=item $player->ext_reply ($msgid, $msgtype, %msg)
1040
1041Sends an ext reply to the player.
1042
1043=cut
1044
1045sub cf::player::ext_reply($$$%) {
1046 my ($self, $id, %msg) = @_;
1047
1048 $msg{msgid} = $id;
1049
1050 $self->send ("ext " . to_json \%msg);
1051}
1052
1053=back
1054
1055
1056=head3 cf::map
1057
1058=over 4
1059
1060=cut
1061
1062package cf::map;
1063
1064use Fcntl;
1065use Coro::AIO;
1066
1067our $MAX_RESET = 7200;
1068our $DEFAULT_RESET = 3600;
1069
1070sub generate_random_map {
1071 my ($path, $rmp) = @_;
1072
1073 # mit "rum" bekleckern, nicht
1074 cf::map::_create_random_map
1075 $path,
1076 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1077 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1078 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1079 $rmp->{exit_on_final_map},
1080 $rmp->{xsize}, $rmp->{ysize},
1081 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1082 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1083 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1084 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1085 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1086 (cf::region::find $rmp->{region})
1087}
1088
1089# and all this just because we cannot iterate over
1090# all maps in C++...
1091sub change_all_map_light {
1092 my ($change) = @_;
1093
1094 $_->change_map_light ($change) for values %cf::MAP;
1095}
1096
1097sub try_load_header($) {
1098 my ($path) = @_;
1099
1100 utf8::encode $path;
1101 aio_open $path, O_RDONLY, 0
1102 or return;
1103
1104 my $map = cf::map::new
1105 or return;
1106
1107 $map->load_header ($path)
1108 or return;
1109
1110 $map->{load_path} = $path;
1111
1112 $map
1113}
1114
1115sub find_map {
1116 my ($path, $origin) = @_;
1117
1118 #warn "find_map<$path,$origin>\n";#d#
1119
1120 $path = new cf::path $path, $origin && $origin->path;
1121 my $key = $path->as_string;
1122
1123 $cf::MAP{$key} || do {
1124 # do it the slow way
1125 my $map = try_load_header $path->save_path;
1126
1127 if ($map) {
1128 # safety
1129 $map->{instantiate_time} = $cf::RUNTIME
1130 if $map->{instantiate_time} > $cf::RUNTIME;
1131 } else {
1132 if (my $rmp = $path->random_map_params) {
1133 $map = generate_random_map $key, $rmp;
1134 } else {
1135 $map = try_load_header $path->load_path;
1136 }
1137
1138 $map or return;
1139
1140 $map->{load_original} = 1;
1141 $map->{instantiate_time} = $cf::RUNTIME;
1142 $map->instantiate;
1143
1144 # per-player maps become, after loading, normal maps
1145 $map->per_player (0) if $path->{user_rel};
1146 }
1147 #Coro::Timer::sleep 1;#d#
1148
1149 $map->path ($key);
1150 $map->{path} = $path;
1151 $map->{last_save} = $cf::RUNTIME;
1152 $map->last_access ($cf::RUNTIME);
1153
1154 if ($map->should_reset) {
1155 $map->reset;
1156 $map = find_map $path;
1157 }
1158
1159 $cf::MAP{$key} = $map
1160 }
1161}
1162
1163sub load {
1164 my ($self) = @_;
1165
1166 return if $self->in_memory != cf::MAP_SWAPPED;
1167
1168 $self->in_memory (cf::MAP_LOADING);
1169
1170 my $path = $self->{path};
1171
1172 $self->alloc;
1173 $self->load_objects ($self->{load_path}, 1)
1174 or return;
1175
1176 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1177 if delete $self->{load_original};
1178
1179 if (my $uniq = $path->uniq_path) {
1180 utf8::encode $uniq;
1181 if (aio_open $uniq, O_RDONLY, 0) {
1182 $self->clear_unique_items;
1183 $self->load_objects ($uniq, 0);
1184 }
1185 }
1186
1187 # now do the right thing for maps
1188 $self->link_multipart_objects;
1189
1190 if ($self->{path}->is_style_map) {
1191 $self->{deny_save} = 1;
1192 $self->{deny_reset} = 1;
1193 } else {
1194 $self->fix_auto_apply;
1195 $self->decay_objects;
1196 $self->update_buttons;
1197 $self->set_darkness_map;
1198 $self->difficulty ($self->estimate_difficulty)
1199 unless $self->difficulty;
1200 $self->activate;
1201 }
1202
1203 $self->in_memory (cf::MAP_IN_MEMORY);
1204}
1205
1206sub load_map_sync {
1207 my ($path, $origin) = @_;
1208
1209 #warn "load_map_sync<$path, $origin>\n";#d#
1210
1211 cf::sync_job {
1212 my $map = cf::map::find_map $path, $origin
1213 or return;
1214 $map->load;
1215 $map
1216 }
1217}
1218
1219sub save {
1220 my ($self) = @_;
1221
1222 $self->{last_save} = $cf::RUNTIME;
1223
1224 return unless $self->dirty;
1225
1226 my $save = $self->{path}->save_path; utf8::encode $save;
1227 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1228
1229 $self->{load_path} = $save;
1230
1231 return if $self->{deny_save};
1232
1233 if ($uniq) {
1234 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1235 $self->save_objects ($uniq, cf::IO_UNIQUES);
1236 } else {
1237 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1238 }
1239}
1240
1241sub swap_out {
1242 my ($self) = @_;
1243
1244 return if $self->players;
1245 return if $self->in_memory != cf::MAP_IN_MEMORY;
1246 return if $self->{deny_save};
1247
1248 $self->save;
1249 $self->clear;
1250 $self->in_memory (cf::MAP_SWAPPED);
1251}
1252
1253sub reset_at {
1254 my ($self) = @_;
1255
1256 # TODO: safety, remove and allow resettable per-player maps
1257 return 1e99 if $self->{path}{user_rel};
1258 return 1e99 if $self->{deny_reset};
1259
1260 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1261 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1262
1263 $time + $to
1264}
1265
1266sub should_reset {
1267 my ($self) = @_;
1268
1269 $self->reset_at <= $cf::RUNTIME
1270}
1271
1272sub unlink_save {
1273 my ($self) = @_;
1274
1275 utf8::encode (my $save = $self->{path}->save_path);
1276 aioreq_pri 3; IO::AIO::aio_unlink $save;
1277 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1278}
1279
1280sub rename {
1281 my ($self, $new_path) = @_;
1282
1283 $self->unlink_save;
1284
1285 delete $cf::MAP{$self->path};
1286 $self->{path} = new cf::path $new_path;
1287 $self->path ($self->{path}->as_string);
1288 $cf::MAP{$self->path} = $self;
1289
1290 $self->save;
1291}
1292
1293sub reset {
1294 my ($self) = @_;
1295
1296 return if $self->players;
1297 return if $self->{path}{user_rel};#d#
1298
1299 warn "resetting map ", $self->path;#d#
1300
1301 delete $cf::MAP{$self->path};
1302
1303 $_->clear_links_to ($self) for values %cf::MAP;
1304
1305 $self->unlink_save;
1306 $self->destroy;
1307}
1308
1309my $nuke_counter = "aaaa";
1310
1311sub nuke {
1312 my ($self) = @_;
1313
1314 $self->{deny_save} = 1;
1315 $self->reset_timeout (1);
1316 $self->rename ("{nuke}/" . ($nuke_counter++));
1317 $self->reset; # polite request, might not happen
1318}
1319
1320sub customise_for {
1321 my ($map, $ob) = @_;
1322
1323 if ($map->per_player) {
1324 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
1325 }
1326
1327 $map
1328}
1329
1330sub emergency_save {
1331 local $cf::FREEZE = 1;
1332
1333 warn "enter emergency map save\n";
1334
1335 cf::sync_job {
1336 warn "begin emergency map save\n";
1337 $_->save for values %cf::MAP;
1338 };
1339
1340 warn "end emergency map save\n";
1341}
1342
1343package cf;
1344
1345=back
1346
1347
1348=head3 cf::object::player
1349
1350=over 4
1351
1352=item $player_object->reply ($npc, $msg[, $flags])
1353
1354Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1355can be C<undef>. Does the right thing when the player is currently in a
1356dialogue with the given NPC character.
1357
1358=cut
1359
376# rough implementation of a future "reply" method that works 1360# rough implementation of a future "reply" method that works
377# with dialog boxes. 1361# with dialog boxes.
1362#TODO: the first argument must go, split into a $npc->reply_to ( method
378sub cf::object::player::reply($$$;$) { 1363sub cf::object::player::reply($$$;$) {
379 my ($self, $npc, $msg, $flags) = @_; 1364 my ($self, $npc, $msg, $flags) = @_;
380 1365
381 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1366 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
382 1367
386 $msg = $npc->name . " says: $msg" if $npc; 1371 $msg = $npc->name . " says: $msg" if $npc;
387 $self->message ($msg, $flags); 1372 $self->message ($msg, $flags);
388 } 1373 }
389} 1374}
390 1375
391############################################################################# 1376=item $player_object->may ("access")
392# map scripting support
393 1377
1378Returns wether the given player is authorized to access resource "access"
1379(e.g. "command_wizcast").
1380
1381=cut
1382
1383sub cf::object::player::may {
1384 my ($self, $access) = @_;
1385
1386 $self->flag (cf::FLAG_WIZ) ||
1387 (ref $cf::CFG{"may_$access"}
1388 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1389 : $cf::CFG{"may_$access"})
1390}
1391
1392=item $player_object->enter_link
1393
1394Freezes the player and moves him/her to a special map (C<{link}>).
1395
1396The player should be reaosnably safe there for short amounts of time. You
1397I<MUST> call C<leave_link> as soon as possible, though.
1398
1399=item $player_object->leave_link ($map, $x, $y)
1400
1401Moves the player out of the specila link map onto the given map. If the
1402map is not valid (or omitted), the player will be moved back to the
1403location he/she was before the call to C<enter_link>, or, if that fails,
1404to the emergency map position.
1405
1406Might block.
1407
1408=cut
1409
1410sub cf::object::player::enter_link {
1411 my ($self) = @_;
1412
1413 return if $self->map == $LINK_MAP;
1414
1415 $self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1416 if $self->map;
1417
1418 $self->enter_map ($LINK_MAP, 20, 20);
1419 $self->deactivate_recursive;
1420}
1421
1422sub cf::object::player::leave_link {
1423 my ($self, $map, $x, $y) = @_;
1424
1425 my $link_pos = delete $self->{_link_pos};
1426
1427 unless ($map) {
1428 # restore original map position
1429 ($map, $x, $y) = @{ $link_pos || [] };
1430 $map = cf::map::find_map $map;
1431
1432 unless ($map) {
1433 ($map, $x, $y) = @$EMERGENCY_POSITION;
1434 $map = cf::map::find_map $map
1435 or die "FATAL: cannot load emergency map\n";
1436 }
1437 }
1438
1439 ($x, $y) = (-1, -1)
1440 unless (defined $x) && (defined $y);
1441
1442 # use -1 or undef as default coordinates, not 0, 0
1443 ($x, $y) = ($map->enter_x, $map->enter_y)
1444 if $x <=0 && $y <= 0;
1445
1446 $map->load;
1447
1448 $self->activate_recursive;
1449 $self->enter_map ($map, $x, $y);
1450}
1451
1452=item $player_object->goto_map ($path, $x, $y)
1453
1454=cut
1455
1456sub cf::object::player::goto_map {
1457 my ($self, $path, $x, $y) = @_;
1458
1459 $self->enter_link;
1460
1461 (Coro::async {
1462 $path = new cf::path $path;
1463
1464 my $map = cf::map::find_map $path->as_string;
1465 $map = $map->customise_for ($self) if $map;
1466
1467 warn "entering ", $map->path, " at ($x, $y)\n"
1468 if $map;
1469
1470 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1471
1472 $self->leave_link ($map, $x, $y);
1473 })->prio (1);
1474}
1475
1476=item $player_object->enter_exit ($exit_object)
1477
1478=cut
1479
1480sub parse_random_map_params {
1481 my ($spec) = @_;
1482
1483 my $rmp = { # defaults
1484 xsize => 10,
1485 ysize => 10,
1486 };
1487
1488 for (split /\n/, $spec) {
1489 my ($k, $v) = split /\s+/, $_, 2;
1490
1491 $rmp->{lc $k} = $v if (length $k) && (length $v);
1492 }
1493
1494 $rmp
1495}
1496
1497sub prepare_random_map {
1498 my ($exit) = @_;
1499
1500 # all this does is basically replace the /! path by
1501 # a new random map path (?random/...) with a seed
1502 # that depends on the exit object
1503
1504 my $rmp = parse_random_map_params $exit->msg;
1505
1506 if ($exit->map) {
1507 $rmp->{region} = $exit->map->region_name;
1508 $rmp->{origin_map} = $exit->map->path;
1509 $rmp->{origin_x} = $exit->x;
1510 $rmp->{origin_y} = $exit->y;
1511 }
1512
1513 $rmp->{random_seed} ||= $exit->random_seed;
1514
1515 my $data = cf::to_json $rmp;
1516 my $md5 = Digest::MD5::md5_hex $data;
1517
1518 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1519 aio_write $fh, 0, (length $data), $data, 0;
1520
1521 $exit->slaying ("?random/$md5");
1522 $exit->msg (undef);
1523 }
1524}
1525
1526sub cf::object::player::enter_exit {
1527 my ($self, $exit) = @_;
1528
1529 return unless $self->type == cf::PLAYER;
1530
1531 $self->enter_link;
1532
1533 (Coro::async {
1534 unless (eval {
1535
1536 prepare_random_map $exit
1537 if $exit->slaying eq "/!";
1538
1539 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1540 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1541
1542 1;
1543 }) {
1544 $self->message ("Something went wrong deep within the crossfire server. "
1545 . "I'll try to bring you back to the map you were before. "
1546 . "Please report this to the dungeon master",
1547 cf::NDI_UNIQUE | cf::NDI_RED);
1548
1549 warn "ERROR in enter_exit: $@";
1550 $self->leave_link;
1551 }
1552 })->prio (1);
1553}
1554
1555=head3 cf::client
1556
1557=over 4
1558
1559=item $client->send_drawinfo ($text, $flags)
1560
1561Sends a drawinfo packet to the client. Circumvents output buffering so
1562should not be used under normal circumstances.
1563
1564=cut
1565
1566sub cf::client::send_drawinfo {
1567 my ($self, $text, $flags) = @_;
1568
1569 utf8::encode $text;
1570 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1571}
1572
1573
1574=item $success = $client->query ($flags, "text", \&cb)
1575
1576Queues a query to the client, calling the given callback with
1577the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1578C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1579
1580Queries can fail, so check the return code. Or don't, as queries will become
1581reliable at some point in the future.
1582
1583=cut
1584
1585sub cf::client::query {
1586 my ($self, $flags, $text, $cb) = @_;
1587
1588 return unless $self->state == ST_PLAYING
1589 || $self->state == ST_SETUP
1590 || $self->state == ST_CUSTOM;
1591
1592 $self->state (ST_CUSTOM);
1593
1594 utf8::encode $text;
1595 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1596
1597 $self->send_packet ($self->{query_queue}[0][0])
1598 if @{ $self->{query_queue} } == 1;
1599}
1600
1601cf::client->attach (
1602 on_reply => sub {
1603 my ($ns, $msg) = @_;
1604
1605 # this weird shuffling is so that direct followup queries
1606 # get handled first
1607 my $queue = delete $ns->{query_queue};
1608
1609 (shift @$queue)->[1]->($msg);
1610
1611 push @{ $ns->{query_queue} }, @$queue;
1612
1613 if (@{ $ns->{query_queue} } == @$queue) {
1614 if (@$queue) {
1615 $ns->send_packet ($ns->{query_queue}[0][0]);
1616 } else {
1617 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1618 }
1619 }
1620 },
1621);
1622
1623=item $client->coro (\&cb)
1624
1625Create a new coroutine, running the specified callback. The coroutine will
1626be automatically cancelled when the client gets destroyed (e.g. on logout,
1627or loss of connection).
1628
1629=cut
1630
1631sub cf::client::coro {
1632 my ($self, $cb) = @_;
1633
1634 my $coro; $coro = async {
1635 eval {
1636 $cb->();
1637 };
1638 warn $@ if $@;
1639 };
1640
1641 $coro->on_destroy (sub {
1642 delete $self->{_coro}{$coro+0};
1643 });
1644
1645 $self->{_coro}{$coro+0} = $coro;
1646
1647 $coro
1648}
1649
1650cf::client->attach (
1651 on_destroy => sub {
1652 my ($ns) = @_;
1653
1654 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1655 },
1656);
1657
1658=back
1659
1660
1661=head2 SAFE SCRIPTING
1662
1663Functions that provide a safe environment to compile and execute
1664snippets of perl code without them endangering the safety of the server
1665itself. Looping constructs, I/O operators and other built-in functionality
1666is not available in the safe scripting environment, and the number of
1667functions and methods that can be called is greatly reduced.
1668
1669=cut
1670
394our $safe = new Safe "ext"; 1671our $safe = new Safe "safe";
395our $safe_hole = new Safe::Hole; 1672our $safe_hole = new Safe::Hole;
396 1673
397$SIG{FPE} = 'IGNORE'; 1674$SIG{FPE} = 'IGNORE';
398 1675
399$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 1676$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
400 1677
401# here we export the classes and methods available to script code 1678# here we export the classes and methods available to script code
402 1679
1680=pod
1681
1682The following fucntions and emthods are available within a safe environment:
1683
1684 cf::object contr pay_amount pay_player map
1685 cf::object::player player
1686 cf::player peaceful
1687 cf::map trigger
1688
1689=cut
1690
403for ( 1691for (
404 ["cf::object" => qw(contr)], 1692 ["cf::object" => qw(contr pay_amount pay_player map)],
405 ["cf::object::player" => qw(player)], 1693 ["cf::object::player" => qw(player)],
406 ["cf::player" => qw(peaceful)], 1694 ["cf::player" => qw(peaceful)],
1695 ["cf::map" => qw(trigger)],
407) { 1696) {
408 no strict 'refs'; 1697 no strict 'refs';
409 my ($pkg, @funs) = @$_; 1698 my ($pkg, @funs) = @$_;
410 *{"ext::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 1699 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
411 for @funs; 1700 for @funs;
412} 1701}
1702
1703=over 4
1704
1705=item @retval = safe_eval $code, [var => value, ...]
1706
1707Compiled and executes the given perl code snippet. additional var/value
1708pairs result in temporary local (my) scalar variables of the given name
1709that are available in the code snippet. Example:
1710
1711 my $five = safe_eval '$first + $second', first => 1, second => 4;
1712
1713=cut
413 1714
414sub safe_eval($;@) { 1715sub safe_eval($;@) {
415 my ($code, %vars) = @_; 1716 my ($code, %vars) = @_;
416 1717
417 my $qcode = $code; 1718 my $qcode = $code;
418 $qcode =~ s/"/‟/g; # not allowed in #line filenames 1719 $qcode =~ s/"/‟/g; # not allowed in #line filenames
419 $qcode =~ s/\n/\\n/g; 1720 $qcode =~ s/\n/\\n/g;
420 1721
421 local $_; 1722 local $_;
422 local @ext::cf::_safe_eval_args = values %vars; 1723 local @safe::cf::_safe_eval_args = values %vars;
423 1724
424 $code = 1725 my $eval =
425 "do {\n" 1726 "do {\n"
426 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 1727 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
427 . "#line 0 \"{$qcode}\"\n" 1728 . "#line 0 \"{$qcode}\"\n"
428 . $code 1729 . $code
429 . "\n}" 1730 . "\n}"
430 ; 1731 ;
431 1732
432 sub_generation_inc; 1733 sub_generation_inc;
433 my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); 1734 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
434 sub_generation_inc; 1735 sub_generation_inc;
435 1736
1737 if ($@) {
1738 warn "$@";
1739 warn "while executing safe code '$code'\n";
1740 warn "with arguments " . (join " ", %vars) . "\n";
1741 }
1742
436 wantarray ? @res : $res[0] 1743 wantarray ? @res : $res[0]
437} 1744}
1745
1746=item cf::register_script_function $function => $cb
1747
1748Register a function that can be called from within map/npc scripts. The
1749function should be reasonably secure and should be put into a package name
1750like the extension.
1751
1752Example: register a function that gets called whenever a map script calls
1753C<rent::overview>, as used by the C<rent> extension.
1754
1755 cf::register_script_function "rent::overview" => sub {
1756 ...
1757 };
1758
1759=cut
438 1760
439sub register_script_function { 1761sub register_script_function {
440 my ($fun, $cb) = @_; 1762 my ($fun, $cb) = @_;
441 1763
442 no strict 'refs'; 1764 no strict 'refs';
443 *{"ext::$fun"} = $safe_hole->wrap ($cb); 1765 *{"safe::$fun"} = $safe_hole->wrap ($cb);
1766}
1767
1768=back
1769
1770=cut
1771
1772#############################################################################
1773
1774=head2 EXTENSION DATABASE SUPPORT
1775
1776Crossfire maintains a very simple database for extension use. It can
1777currently store anything that can be serialised using Storable, which
1778excludes objects.
1779
1780The parameter C<$family> should best start with the name of the extension
1781using it, it should be unique.
1782
1783=over 4
1784
1785=item $hashref = cf::db_get $family
1786
1787Return a hashref for use by the extension C<$family>, which can be
1788modified. After modifications, you have to call C<cf::db_dirty> or
1789C<cf::db_sync>.
1790
1791=item $value = cf::db_get $family => $key
1792
1793Returns a single value from the database
1794
1795=item cf::db_put $family => $hashref
1796
1797Stores the given family hashref into the database. Updates are delayed, if
1798you want the data to be synced to disk immediately, use C<cf::db_sync>.
1799
1800=item cf::db_put $family => $key => $value
1801
1802Stores the given C<$value> in the family hash. Updates are delayed, if you
1803want the data to be synced to disk immediately, use C<cf::db_sync>.
1804
1805=item cf::db_dirty
1806
1807Marks the database as dirty, to be updated at a later time.
1808
1809=item cf::db_sync
1810
1811Immediately write the database to disk I<if it is dirty>.
1812
1813=cut
1814
1815our $DB;
1816
1817{
1818 my $path = cf::localdir . "/database.pst";
1819
1820 sub db_load() {
1821 warn "loading database $path\n";#d# remove later
1822 $DB = stat $path ? Storable::retrieve $path : { };
1823 }
1824
1825 my $pid;
1826
1827 sub db_save() {
1828 warn "saving database $path\n";#d# remove later
1829 waitpid $pid, 0 if $pid;
1830 if (0 == ($pid = fork)) {
1831 $DB->{_meta}{version} = 1;
1832 Storable::nstore $DB, "$path~";
1833 rename "$path~", $path;
1834 cf::_exit 0 if defined $pid;
1835 }
1836 }
1837
1838 my $dirty;
1839
1840 sub db_sync() {
1841 db_save if $dirty;
1842 undef $dirty;
1843 }
1844
1845 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1846 db_sync;
1847 });
1848
1849 sub db_dirty() {
1850 $dirty = 1;
1851 $idle->start;
1852 }
1853
1854 sub db_get($;$) {
1855 @_ >= 2
1856 ? $DB->{$_[0]}{$_[1]}
1857 : ($DB->{$_[0]} ||= { })
1858 }
1859
1860 sub db_put($$;$) {
1861 if (@_ >= 3) {
1862 $DB->{$_[0]}{$_[1]} = $_[2];
1863 } else {
1864 $DB->{$_[0]} = $_[1];
1865 }
1866 db_dirty;
1867 }
1868
1869 cf::global->attach (
1870 prio => 10000,
1871 on_cleanup => sub {
1872 db_sync;
1873 },
1874 );
1875}
1876
1877#############################################################################
1878# the server's main()
1879
1880sub cfg_load {
1881 open my $fh, "<:utf8", cf::confdir . "/config"
1882 or return;
1883
1884 local $/;
1885 *CFG = YAML::Syck::Load <$fh>;
1886}
1887
1888sub main {
1889 # we must not ever block the main coroutine
1890 local $Coro::idle = sub {
1891 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1892 (Coro::unblock_sub {
1893 Event::one_event;
1894 })->();
1895 };
1896
1897 cfg_load;
1898 db_load;
1899 load_extensions;
1900 Event::loop;
444} 1901}
445 1902
446############################################################################# 1903#############################################################################
447# initialisation 1904# initialisation
448 1905
1906sub reload() {
1907 # can/must only be called in main
1908 if ($Coro::current != $Coro::main) {
1909 warn "can only reload from main coroutine\n";
1910 return;
1911 }
1912
1913 warn "reloading...";
1914
1915 local $FREEZE = 1;
1916 cf::emergency_save;
1917
1918 eval {
1919 # if anything goes wrong in here, we should simply crash as we already saved
1920
1921 # cancel all watchers
1922 for (Event::all_watchers) {
1923 $_->cancel if $_->data & WF_AUTOCANCEL;
1924 }
1925
1926 # cancel all extension coros
1927 $_->cancel for values %EXT_CORO;
1928 %EXT_CORO = ();
1929
1930 # unload all extensions
1931 for (@exts) {
1932 warn "unloading <$_>";
1933 unload_extension $_;
1934 }
1935
1936 # unload all modules loaded from $LIBDIR
1937 while (my ($k, $v) = each %INC) {
1938 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1939
1940 warn "removing <$k>";
1941 delete $INC{$k};
1942
1943 $k =~ s/\.pm$//;
1944 $k =~ s/\//::/g;
1945
1946 if (my $cb = $k->can ("unload_module")) {
1947 $cb->();
1948 }
1949
1950 Symbol::delete_package $k;
1951 }
1952
1953 # sync database to disk
1954 cf::db_sync;
1955 IO::AIO::flush;
1956
1957 # get rid of safe::, as good as possible
1958 Symbol::delete_package "safe::$_"
1959 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1960
1961 # remove register_script_function callbacks
1962 # TODO
1963
1964 # unload cf.pm "a bit"
1965 delete $INC{"cf.pm"};
1966
1967 # don't, removes xs symbols, too,
1968 # and global variables created in xs
1969 #Symbol::delete_package __PACKAGE__;
1970
1971 # reload cf.pm
1972 warn "reloading cf.pm";
1973 require cf;
1974 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1975
1976 # load config and database again
1977 cf::cfg_load;
1978 cf::db_load;
1979
1980 # load extensions
1981 warn "load extensions";
1982 cf::load_extensions;
1983
1984 # reattach attachments to objects
1985 warn "reattach";
1986 _global_reattach;
1987 };
1988
1989 if ($@) {
1990 warn $@;
1991 warn "error while reloading, exiting.";
1992 exit 1;
1993 }
1994
1995 warn "reloaded successfully";
1996};
1997
1998#############################################################################
1999
2000unless ($LINK_MAP) {
2001 $LINK_MAP = cf::map::new;
2002
2003 $LINK_MAP->width (41);
2004 $LINK_MAP->height (41);
2005 $LINK_MAP->alloc;
2006 $LINK_MAP->path ("{link}");
2007 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2008 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2009
2010 # dirty hack because... archetypes are not yet loaded
2011 Event->timer (
2012 after => 2,
2013 cb => sub {
2014 $_[0]->w->cancel;
2015
2016 # provide some exits "home"
2017 my $exit = cf::object::new "exit";
2018
2019 $exit->slaying ($EMERGENCY_POSITION->[0]);
2020 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2021 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2022
2023 $LINK_MAP->insert ($exit->clone, 19, 19);
2024 $LINK_MAP->insert ($exit->clone, 19, 20);
2025 $LINK_MAP->insert ($exit->clone, 19, 21);
2026 $LINK_MAP->insert ($exit->clone, 20, 19);
2027 $LINK_MAP->insert ($exit->clone, 20, 21);
2028 $LINK_MAP->insert ($exit->clone, 21, 19);
2029 $LINK_MAP->insert ($exit->clone, 21, 20);
2030 $LINK_MAP->insert ($exit->clone, 21, 21);
2031
2032 $exit->destroy;
2033 });
2034
2035 $LINK_MAP->{deny_save} = 1;
2036 $LINK_MAP->{deny_reset} = 1;
2037
2038 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2039}
2040
449register "<global>", __PACKAGE__; 2041register "<global>", __PACKAGE__;
450 2042
451unshift @INC, maps_directory "perl"; 2043register_command "reload" => sub {
2044 my ($who, $arg) = @_;
452 2045
453load_extensions; 2046 if ($who->flag (FLAG_WIZ)) {
2047 $who->message ("start of reload.");
2048 reload;
2049 $who->message ("end of reload.");
2050 }
2051};
2052
2053unshift @INC, $LIBDIR;
2054
2055$TICK_WATCHER = Event->timer (
2056 reentrant => 0,
2057 prio => 0,
2058 at => $NEXT_TICK || $TICK,
2059 data => WF_AUTOCANCEL,
2060 cb => sub {
2061 unless ($FREEZE) {
2062 cf::server_tick; # one server iteration
2063 $RUNTIME += $TICK;
2064 }
2065
2066 $NEXT_TICK += $TICK;
2067
2068 # if we are delayed by four ticks or more, skip them all
2069 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2070
2071 $TICK_WATCHER->at ($NEXT_TICK);
2072 $TICK_WATCHER->start;
2073 },
2074);
2075
2076IO::AIO::max_poll_time $TICK * 0.2;
2077
2078Event->io (
2079 fd => IO::AIO::poll_fileno,
2080 poll => 'r',
2081 prio => 5,
2082 data => WF_AUTOCANCEL,
2083 cb => \&IO::AIO::poll_cb,
2084);
2085
2086Event->timer (
2087 data => WF_AUTOCANCEL,
2088 after => 0,
2089 interval => 10,
2090 cb => sub {
2091 (Coro::unblock_sub {
2092 write_runtime
2093 or warn "ERROR: unable to write runtime file: $!";
2094 })->();
2095 },
2096);
454 2097
4551 20981
456 2099

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines