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.14 by root, Fri Mar 31 22:47:35 2006 UTC vs.
Revision 1.139 by root, Fri Jan 5 19:12:03 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines