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.97 by root, Fri Dec 22 06:03:20 2006 UTC vs.
Revision 1.185 by root, Fri Jan 19 23:32:52 2007 UTC

8use Storable; 8use Storable;
9use Opcode; 9use Opcode;
10use Safe; 10use Safe;
11use Safe::Hole; 11use Safe::Hole;
12 12
13use Coro; 13use Coro 3.4 ();
14use Coro::Event; 14use Coro::Event;
15use Coro::Timer; 15use Coro::Timer;
16use Coro::Signal; 16use Coro::Signal;
17use Coro::Semaphore; 17use Coro::Semaphore;
18
19use IO::AIO; 18use Coro::AIO;
19
20use Data::Dumper;
21use Digest::MD5;
22use Fcntl;
23use IO::AIO 2.32 ();
20use YAML::Syck (); 24use YAML::Syck ();
21use Time::HiRes; 25use Time::HiRes;
22 26
23use Event; $Event::Eval = 1; # no idea why this is required, but it is 27use Event; $Event::Eval = 1; # no idea why this is required, but it is
24 28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30
25# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
26$YAML::Syck::ImplicitUnicode = 1; 32$YAML::Syck::ImplicitUnicode = 1;
27 33
28$Coro::main->prio (Coro::PRIO_MIN); 34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
29
30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31 35
32our %COMMAND = (); 36our %COMMAND = ();
33our %COMMAND_TIME = (); 37our %COMMAND_TIME = ();
38
39our @EXTS = (); # list of extension package names
34our %EXTCMD = (); 40our %EXTCMD = ();
35 41our %EXT_CORO = (); # coroutines bound to extensions
36_init_vars; 42our %EXT_MAP = (); # pluggable maps
37 43
38our @EVENT; 44our @EVENT;
39our $LIBDIR = datadir . "/ext"; 45our $LIBDIR = datadir . "/ext";
40 46
41our $TICK = MAX_TIME * 1e-6; 47our $TICK = MAX_TIME * 1e-6;
42our $TICK_WATCHER; 48our $TICK_WATCHER;
49our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER;
43our $NEXT_TICK; 51our $NEXT_TICK;
52our $NOW;
44 53
45our %CFG; 54our %CFG;
46 55
47our $UPTIME; $UPTIME ||= time; 56our $UPTIME; $UPTIME ||= time;
57our $RUNTIME;
58
59our %PLAYER; # all users
60our %MAP; # all maps
61our $LINK_MAP; # the special {link} map, which is always available
62our $RANDOM_MAPS = cf::localdir . "/random";
63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66
67# used to convert map paths into valid unix filenames by replacing / by ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69
70binmode STDOUT;
71binmode STDERR;
72
73# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") {
75 open my $fh, "<", cf::localdir . "/runtime"
76 or die "unable to read runtime file: $!";
77 $RUNTIME = <$fh> + 0.;
78}
79
80mkdir cf::localdir;
81mkdir cf::localdir . "/" . cf::playerdir;
82mkdir cf::localdir . "/" . cf::tmpdir;
83mkdir cf::localdir . "/" . cf::uniquedir;
84mkdir $RANDOM_MAPS;
85
86our $EMERGENCY_POSITION;
48 87
49############################################################################# 88#############################################################################
50 89
51=head2 GLOBAL VARIABLES 90=head2 GLOBAL VARIABLES
52 91
53=over 4 92=over 4
54 93
55=item $cf::UPTIME 94=item $cf::UPTIME
56 95
57The timestamp of the server start (so not actually an uptime). 96The timestamp of the server start (so not actually an uptime).
97
98=item $cf::RUNTIME
99
100The time this server has run, starts at 0 and is increased by $cf::TICK on
101every server tick.
58 102
59=item $cf::LIBDIR 103=item $cf::LIBDIR
60 104
61The perl library directory, where extensions and cf-specific modules can 105The perl library directory, where extensions and cf-specific modules can
62be found. It will be added to C<@INC> automatically. 106be found. It will be added to C<@INC> automatically.
63 107
108=item $cf::NOW
109
110The time of the last (current) server tick.
111
64=item $cf::TICK 112=item $cf::TICK
65 113
66The interval between server ticks, in seconds. 114The interval between server ticks, in seconds.
67 115
68=item %cf::CFG 116=item %cf::CFG
69 117
70Configuration for the server, loaded from C</etc/crossfire/config>, or 118Configuration for the server, loaded from C</etc/crossfire/config>, or
71from wherever your confdir points to. 119from wherever your confdir points to.
120
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
122
123These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
124or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
125processing has been done. Call C<< ->wait >> on them to maximise the
126window of cpu time available, or simply to synchronise to the server tick.
72 127
73=back 128=back
74 129
75=cut 130=cut
76 131
77BEGIN { 132BEGIN {
78 *CORE::GLOBAL::warn = sub { 133 *CORE::GLOBAL::warn = sub {
79 my $msg = join "", @_; 134 my $msg = join "", @_;
135 utf8::encode $msg;
136
80 $msg .= "\n" 137 $msg .= "\n"
81 unless $msg =~ /\n$/; 138 unless $msg =~ /\n$/;
82 139
83 print STDERR "cfperl: $msg";
84 LOG llevError, "cfperl: $msg"; 140 LOG llevError, $msg;
85 }; 141 };
86} 142}
87 143
88@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
89@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
93@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 149@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
94 150
95# we bless all objects into (empty) derived classes to force a method lookup 151# we bless all objects into (empty) derived classes to force a method lookup
96# within the Safe compartment. 152# within the Safe compartment.
97for my $pkg (qw( 153for my $pkg (qw(
98 cf::global 154 cf::global cf::attachable
99 cf::object cf::object::player 155 cf::object cf::object::player
100 cf::client cf::player 156 cf::client cf::player
101 cf::arch cf::living 157 cf::arch cf::living
102 cf::map cf::party cf::region 158 cf::map cf::party cf::region
103)) { 159)) {
107 163
108$Event::DIED = sub { 164$Event::DIED = sub {
109 warn "error in event callback: @_"; 165 warn "error in event callback: @_";
110}; 166};
111 167
112my %ext_pkg;
113my @exts;
114my @hook;
115
116=head2 UTILITY FUNCTIONS 168=head2 UTILITY FUNCTIONS
117 169
118=over 4 170=over 4
119 171
172=item dumpval $ref
173
120=cut 174=cut
175
176sub dumpval {
177 eval {
178 local $SIG{__DIE__};
179 my $d;
180 if (1) {
181 $d = new Data::Dumper([$_[0]], ["*var"]);
182 $d->Terse(1);
183 $d->Indent(2);
184 $d->Quotekeys(0);
185 $d->Useqq(1);
186 #$d->Bless(...);
187 $d->Seen($_[1]) if @_ > 1;
188 $d = $d->Dump();
189 }
190 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191 $d
192 } || "[unable to dump $_[0]: '$@']";
193}
121 194
122use JSON::Syck (); # TODO# replace by JSON::PC once working 195use JSON::Syck (); # TODO# replace by JSON::PC once working
123 196
124=item $ref = cf::from_json $json 197=item $ref = cf::from_json $json
125 198
139=cut 212=cut
140 213
141sub to_json($) { 214sub to_json($) {
142 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
143 JSON::Syck::Dump $_[0] 216 JSON::Syck::Dump $_[0]
217}
218
219=item cf::lock_wait $string
220
221Wait until the given lock is available. See cf::lock_acquire.
222
223=item my $lock = cf::lock_acquire $string
224
225Wait until the given lock is available and then acquires it and returns
226a Coro::guard object. If the guard object gets destroyed (goes out of scope,
227for example when the coroutine gets canceled), the lock is automatically
228returned.
229
230Lock names should begin with a unique identifier (for example, cf::map::find
231uses map_find and cf::map::load uses map_load).
232
233=cut
234
235our %LOCK;
236
237sub lock_wait($) {
238 my ($key) = @_;
239
240 # wait for lock, if any
241 while ($LOCK{$key}) {
242 push @{ $LOCK{$key} }, $Coro::current;
243 Coro::schedule;
244 }
245}
246
247sub lock_acquire($) {
248 my ($key) = @_;
249
250 # wait, to be sure we are not locked
251 lock_wait $key;
252
253 $LOCK{$key} = [];
254
255 Coro::guard {
256 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} };
258 }
259}
260
261sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active;
263
264 my $guard = Coro::guard {
265 $TICK_WATCHER->start;
266 $WRITE_RUNTIME_WATCHER->start;
267 };
268 $WRITE_RUNTIME_WATCHER->stop;
269 $TICK_WATCHER->stop;
270 $guard
271}
272
273=item cf::async { BLOCK }
274
275Currently the same as Coro::async_pool, meaning you cannot use
276C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
277thing you are allowed to do is call C<prio> on it.
278
279=cut
280
281BEGIN { *async = \&Coro::async_pool }
282
283=item cf::sync_job { BLOCK }
284
285The design of crossfire+ requires that the main coro ($Coro::main) is
286always able to handle events or runnable, as crossfire+ is only partly
287reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
288
289If it must be done, put the blocking parts into C<sync_job>. This will run
290the given BLOCK in another coroutine while waiting for the result. The
291server will be frozen during this time, so the block should either finish
292fast or be very important.
293
294=cut
295
296sub sync_job(&) {
297 my ($job) = @_;
298
299 if ($Coro::current == $Coro::main) {
300 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/
302
303 # TODO: use suspend/resume instead
304 # (but this is cancel-safe)
305 my $freeze_guard = freeze_mainloop;
306
307 my $busy = 1;
308 my @res;
309
310 (async {
311 @res = eval { $job->() };
312 warn $@ if $@;
313 undef $busy;
314 })->prio (Coro::PRIO_MAX);
315
316 while ($busy) {
317 Coro::cede or Event::one_event;
318 }
319
320 wantarray ? @res : $res[0]
321 } else {
322 # we are in another coroutine, how wonderful, everything just works
323
324 $job->()
325 }
326}
327
328=item $coro = cf::async_ext { BLOCK }
329
330Like async, but this coro is automatically being canceled when the
331extension calling this is being unloaded.
332
333=cut
334
335sub async_ext(&) {
336 my $cb = shift;
337
338 my $coro = &Coro::async ($cb);
339
340 $coro->on_destroy (sub {
341 delete $EXT_CORO{$coro+0};
342 });
343 $EXT_CORO{$coro+0} = $coro;
344
345 $coro
346}
347
348sub write_runtime {
349 my $runtime = cf::localdir . "/runtime";
350
351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
352 or return;
353
354 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
355 (aio_write $fh, 0, (length $value), $value, 0) <= 0
356 and return;
357
358 aio_fsync $fh
359 and return;
360
361 close $fh
362 or return;
363
364 aio_rename "$runtime~", $runtime
365 and return;
366
367 1
144} 368}
145 369
146=back 370=back
147 371
148=cut 372=cut
269exception. 493exception.
270 494
271=cut 495=cut
272 496
273# the following variables are defined in .xs and must not be re-created 497# the following variables are defined in .xs and must not be re-created
274our @CB_GLOBAL = (); # registry for all global events 498our @CB_GLOBAL = (); # registry for all global events
499our @CB_ATTACHABLE = (); # registry for all attachables
275our @CB_OBJECT = (); # all objects (should not be used except in emergency) 500our @CB_OBJECT = (); # all objects (should not be used except in emergency)
276our @CB_PLAYER = (); 501our @CB_PLAYER = ();
277our @CB_CLIENT = (); 502our @CB_CLIENT = ();
278our @CB_TYPE = (); # registry for type (cf-object class) based events 503our @CB_TYPE = (); # registry for type (cf-object class) based events
279our @CB_MAP = (); 504our @CB_MAP = ();
280 505
281my %attachment; 506my %attachment;
507
508sub cf::attachable::thawer_merge {
509 # simply override everything except _meta
510 local $_[0]{_meta};
511 %{$_[0]} = %{$_[1]};
512}
282 513
283sub _attach_cb($$$$) { 514sub _attach_cb($$$$) {
284 my ($registry, $event, $prio, $cb) = @_; 515 my ($registry, $event, $prio, $cb) = @_;
285 516
286 use sort 'stable'; 517 use sort 'stable';
289 520
290 @{$registry->[$event]} = sort 521 @{$registry->[$event]} = sort
291 { $a->[0] cmp $b->[0] } 522 { $a->[0] cmp $b->[0] }
292 @{$registry->[$event] || []}, $cb; 523 @{$registry->[$event] || []}, $cb;
293} 524}
525
526# hack
527my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
294 528
295# attach handles attaching event callbacks 529# attach handles attaching event callbacks
296# the only thing the caller has to do is pass the correct 530# the only thing the caller has to do is pass the correct
297# registry (== where the callback attaches to). 531# registry (== where the callback attaches to).
298sub _attach { 532sub _attach {
300 534
301 my $object_type; 535 my $object_type;
302 my $prio = 0; 536 my $prio = 0;
303 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 537 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
304 538
539 #TODO: get rid of this hack
540 if ($attachable_klass{$klass}) {
541 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
542 }
543
305 while (@arg) { 544 while (@arg) {
306 my $type = shift @arg; 545 my $type = shift @arg;
307 546
308 if ($type eq "prio") { 547 if ($type eq "prio") {
309 $prio = shift @arg; 548 $prio = shift @arg;
384 my ($obj, $name) = @_; 623 my ($obj, $name) = @_;
385 624
386 exists $obj->{_attachment}{$name} 625 exists $obj->{_attachment}{$name}
387} 626}
388 627
389for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 628for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
390 eval "#line " . __LINE__ . " 'cf.pm' 629 eval "#line " . __LINE__ . " 'cf.pm'
391 sub cf::\L$klass\E::_attach_registry { 630 sub cf::\L$klass\E::_attach_registry {
392 (\\\@CB_$klass, KLASS_$klass) 631 (\\\@CB_$klass, KLASS_$klass)
393 } 632 }
394 633
447=cut 686=cut
448 687
449############################################################################# 688#############################################################################
450# object support 689# object support
451 690
452sub instantiate {
453 my ($obj, $data) = @_;
454
455 $data = from_json $data;
456
457 for (@$data) {
458 my ($name, $args) = @$_;
459
460 $obj->attach ($name, %{$args || {} });
461 }
462}
463
464# basically do the same as instantiate, without calling instantiate
465sub reattach { 691sub reattach {
692 # basically do the same as instantiate, without calling instantiate
466 my ($obj) = @_; 693 my ($obj) = @_;
694
695 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
696
467 my $registry = $obj->registry; 697 my $registry = $obj->registry;
468 698
469 @$registry = (); 699 @$registry = ();
470 700
471 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 701 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
480 warn "object uses attachment '$name' that is not available, postponing.\n"; 710 warn "object uses attachment '$name' that is not available, postponing.\n";
481 } 711 }
482 } 712 }
483} 713}
484 714
485sub object_freezer_save { 715cf::attachable->attach (
486 my ($filename, $rdata, $objs) = @_;
487
488 if (length $$rdata) {
489 warn sprintf "saving %s (%d,%d)\n",
490 $filename, length $$rdata, scalar @$objs;
491
492 if (open my $fh, ">:raw", "$filename~") {
493 chmod SAVE_MODE, $fh;
494 syswrite $fh, $$rdata;
495 close $fh;
496
497 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
498 chmod SAVE_MODE, $fh;
499 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
500 close $fh;
501 rename "$filename.pst~", "$filename.pst";
502 } else {
503 unlink "$filename.pst";
504 }
505
506 rename "$filename~", $filename;
507 } else {
508 warn "FATAL: $filename~: $!\n";
509 }
510 } else {
511 unlink $filename;
512 unlink "$filename.pst";
513 }
514}
515
516sub object_freezer_as_string {
517 my ($rdata, $objs) = @_;
518
519 use Data::Dumper;
520
521 $$rdata . Dumper $objs
522}
523
524sub object_thawer_load {
525 my ($filename) = @_;
526
527 local $/;
528
529 my $av;
530
531 #TODO: use sysread etc.
532 if (open my $data, "<:raw:perlio", $filename) {
533 $data = <$data>;
534 if (open my $pst, "<:raw:perlio", "$filename.pst") {
535 $av = eval { (Storable::thaw <$pst>)->{objs} };
536 }
537 return ($data, $av);
538 }
539
540 ()
541}
542
543cf::object->attach (
544 prio => -1000000, 716 prio => -1000000,
717 on_instantiate => sub {
718 my ($obj, $data) = @_;
719
720 $data = from_json $data;
721
722 for (@$data) {
723 my ($name, $args) = @$_;
724
725 $obj->attach ($name, %{$args || {} });
726 }
727 },
728 on_reattach => \&reattach,
545 on_clone => sub { 729 on_clone => sub {
546 my ($src, $dst) = @_; 730 my ($src, $dst) = @_;
547 731
548 @{$dst->registry} = @{$src->registry}; 732 @{$dst->registry} = @{$src->registry};
549 733
552 %{$dst->{_attachment}} = %{$src->{_attachment}} 736 %{$dst->{_attachment}} = %{$src->{_attachment}}
553 if exists $src->{_attachment}; 737 if exists $src->{_attachment};
554 }, 738 },
555); 739);
556 740
741sub object_freezer_save {
742 my ($filename, $rdata, $objs) = @_;
743
744 sync_job {
745 if (length $$rdata) {
746 warn sprintf "saving %s (%d,%d)\n",
747 $filename, length $$rdata, scalar @$objs;
748
749 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750 chmod SAVE_MODE, $fh;
751 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
752 aio_fsync $fh;
753 close $fh;
754
755 if (@$objs) {
756 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
757 chmod SAVE_MODE, $fh;
758 my $data = Storable::nfreeze { version => 1, objs => $objs };
759 aio_write $fh, 0, (length $data), $data, 0;
760 aio_fsync $fh;
761 close $fh;
762 aio_rename "$filename.pst~", "$filename.pst";
763 }
764 } else {
765 aio_unlink "$filename.pst";
766 }
767
768 aio_rename "$filename~", $filename;
769 } else {
770 warn "FATAL: $filename~: $!\n";
771 }
772 } else {
773 aio_unlink $filename;
774 aio_unlink "$filename.pst";
775 }
776 }
777}
778
779sub object_freezer_as_string {
780 my ($rdata, $objs) = @_;
781
782 use Data::Dumper;
783
784 $$rdata . Dumper $objs
785}
786
787sub object_thawer_load {
788 my ($filename) = @_;
789
790 my ($data, $av);
791
792 (aio_load $filename, $data) >= 0
793 or return;
794
795 unless (aio_stat "$filename.pst") {
796 (aio_load "$filename.pst", $av) >= 0
797 or return;
798 $av = eval { (Storable::thaw $av)->{objs} };
799 }
800
801 warn sprintf "loading %s (%d)\n",
802 $filename, length $data, scalar @{$av || []};#d#
803 return ($data, $av);
804}
805
557############################################################################# 806#############################################################################
558# command handling &c 807# command handling &c
559 808
560=item cf::register_command $name => \&callback($ob,$args); 809=item cf::register_command $name => \&callback($ob,$args);
561 810
583=cut 832=cut
584 833
585sub register_extcmd { 834sub register_extcmd {
586 my ($name, $cb) = @_; 835 my ($name, $cb) = @_;
587 836
588 my $caller = caller;
589 #warn "registering extcmd '$name' to '$caller'";
590
591 $EXTCMD{$name} = [$cb, $caller]; 837 $EXTCMD{$name} = $cb;
592} 838}
593 839
594cf::player->attach ( 840cf::player->attach (
595 on_command => sub { 841 on_command => sub {
596 my ($pl, $name, $params) = @_; 842 my ($pl, $name, $params) = @_;
609 855
610 my $msg = eval { from_json $buf }; 856 my $msg = eval { from_json $buf };
611 857
612 if (ref $msg) { 858 if (ref $msg) {
613 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 859 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
614 if (my %reply = $cb->[0]->($pl, $msg)) { 860 if (my %reply = $cb->($pl, $msg)) {
615 $pl->ext_reply ($msg->{msgid}, %reply); 861 $pl->ext_reply ($msg->{msgid}, %reply);
616 } 862 }
617 } 863 }
618 } else { 864 } else {
619 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 865 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
621 867
622 cf::override; 868 cf::override;
623 }, 869 },
624); 870);
625 871
626sub register {
627 my ($base, $pkg) = @_;
628
629 #TODO
630}
631
632sub load_extension { 872sub load_extension {
633 my ($path) = @_; 873 my ($path) = @_;
634 874
635 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 875 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
636 my $base = $1; 876 my $base = $1;
637 my $pkg = $1; 877 my $pkg = $1;
638 $pkg =~ s/[^[:word:]]/_/g; 878 $pkg =~ s/[^[:word:]]/_/g;
639 $pkg = "ext::$pkg"; 879 $pkg = "ext::$pkg";
640 880
641 warn "loading '$path' into '$pkg'\n"; 881 warn "... loading '$path' into '$pkg'\n";
642 882
643 open my $fh, "<:utf8", $path 883 open my $fh, "<:utf8", $path
644 or die "$path: $!"; 884 or die "$path: $!";
645 885
646 my $source = 886 my $source =
647 "package $pkg; use strict; use utf8;\n" 887 "package $pkg; use strict; use utf8;\n"
648 . "#line 1 \"$path\"\n{\n" 888 . "#line 1 \"$path\"\n{\n"
649 . (do { local $/; <$fh> }) 889 . (do { local $/; <$fh> })
650 . "\n};\n1"; 890 . "\n};\n1";
651 891
652 eval $source 892 unless (eval $source) {
653 or die $@ ? "$path: $@\n" 893 my $msg = $@ ? "$path: $@\n"
654 : "extension disabled.\n"; 894 : "extension disabled.\n";
655 895 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
656 push @exts, $pkg; 896 warn $@;
657 $ext_pkg{$base} = $pkg; 897 warn "mandatory extension failed to load, exiting.\n";
658 898 exit 1;
659# no strict 'refs'; 899 }
660# @{"$pkg\::ISA"} = ext::; 900 die $@;
661
662 register $base, $pkg;
663}
664
665sub unload_extension {
666 my ($pkg) = @_;
667
668 warn "removing extension $pkg\n";
669
670 # remove hooks
671 #TODO
672# for my $idx (0 .. $#PLUGIN_EVENT) {
673# delete $hook[$idx]{$pkg};
674# } 901 }
675 902
676 # remove commands 903 push @EXTS, $pkg;
677 for my $name (keys %COMMAND) {
678 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
679
680 if (@cb) {
681 $COMMAND{$name} = \@cb;
682 } else {
683 delete $COMMAND{$name};
684 }
685 }
686
687 # remove extcmds
688 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
689 delete $EXTCMD{$name};
690 }
691
692 if (my $cb = $pkg->can ("unload")) {
693 eval {
694 $cb->($pkg);
695 1
696 } or warn "$pkg unloaded, but with errors: $@";
697 }
698
699 Symbol::delete_package $pkg;
700} 904}
701 905
702sub load_extensions { 906sub load_extensions {
703 for my $ext (<$LIBDIR/*.ext>) { 907 for my $ext (<$LIBDIR/*.ext>) {
704 next unless -r $ext; 908 next unless -r $ext;
708 } or warn "$ext not loaded: $@"; 912 } or warn "$ext not loaded: $@";
709 } 913 }
710} 914}
711 915
712############################################################################# 916#############################################################################
713# load/save/clean perl data associated with a map
714 917
715*cf::mapsupport::on_clean = sub { 918=head2 CORE EXTENSIONS
919
920Functions and methods that extend core crossfire objects.
921
922=cut
923
924package cf::player;
925
926use Coro::AIO;
927
928=head3 cf::player
929
930=over 4
931
932=item cf::player::find $login
933
934Returns the given player object, loading it if necessary (might block).
935
936=cut
937
938sub playerdir($) {
939 cf::localdir
940 . "/"
941 . cf::playerdir
942 . "/"
943 . (ref $_[0] ? $_[0]->ob->name : $_[0])
944}
945
946sub path($) {
947 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948
949 (playerdir $login) . "/$login.pl"
950}
951
952sub find_active($) {
953 $cf::PLAYER{$_[0]}
954 and $cf::PLAYER{$_[0]}->active
955 and $cf::PLAYER{$_[0]}
956}
957
958sub exists($) {
959 my ($login) = @_;
960
961 $cf::PLAYER{$login}
962 or cf::sync_job { !aio_stat path $login }
963}
964
965sub find($) {
966 return $cf::PLAYER{$_[0]} || do {
967 my $login = $_[0];
968
969 my $guard = cf::lock_acquire "user_find:$login";
970
971 $cf::PLAYER{$_[0]} || do {
972 my $pl = load_pl path $login
973 or return;
974 $cf::PLAYER{$login} = $pl
975 }
976 }
977}
978
979sub save($) {
980 my ($pl) = @_;
981
982 return if $pl->{deny_save};
983
984 my $path = path $pl;
985 my $guard = cf::lock_acquire "user_save:$path";
986
987 return if $pl->{deny_save};
988
989 aio_mkdir playerdir $pl, 0770;
990 $pl->{last_save} = $cf::RUNTIME;
991
992 $pl->save_pl ($path);
993 Coro::cede;
994}
995
996sub new($) {
997 my ($login) = @_;
998
999 my $self = create;
1000
1001 $self->ob->name ($login);
1002 $self->{deny_save} = 1;
1003
1004 $cf::PLAYER{$login} = $self;
1005
1006 $self
1007}
1008
1009=item $pl->quit_character
1010
1011Nukes the player without looking back. If logged in, the connection will
1012be destroyed. May block for a long time.
1013
1014=cut
1015
1016sub quit_character {
1017 my ($pl) = @_;
1018
1019 $pl->{deny_save} = 1;
1020 $pl->password ("*"); # this should lock out the player until we nuked the dir
1021
1022 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1023 $pl->deactivate;
1024 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1025 $pl->ns->destroy if $pl->ns;
1026
1027 my $path = playerdir $pl;
1028 my $temp = "$path~$cf::RUNTIME~deleting~";
1029 aio_rename $path, $temp;
1030 delete $cf::PLAYER{$pl->ob->name};
1031 $pl->destroy;
1032 IO::AIO::aio_rmtree $temp;
1033}
1034
1035=item cf::player::list_logins
1036
1037Returns am arrayref of all valid playernames in the system, can take a
1038while and may block, so not sync_job-capable, ever.
1039
1040=cut
1041
1042sub list_logins {
1043 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1044 or return [];
1045
1046 my @logins;
1047
1048 for my $login (@$dirs) {
1049 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1050 aio_read $fh, 0, 512, my $buf, 0 or next;
1051 $buf !~ /^password -------------$/m or next; # official not-valid tag
1052
1053 utf8::decode $login;
1054 push @logins, $login;
1055 }
1056
1057 \@logins
1058}
1059
1060=item $player->maps
1061
1062Returns an arrayref of map paths that are private for this
1063player. May block.
1064
1065=cut
1066
1067sub maps($) {
1068 my ($pl) = @_;
1069
1070 my $files = aio_readdir playerdir $pl
1071 or return;
1072
1073 my @paths;
1074
1075 for (@$files) {
1076 utf8::decode $_;
1077 next if /\.(?:pl|pst)$/;
1078 next unless /^$PATH_SEP/o;
1079
1080 s/\.map$//;
1081 push @paths, "~" . $pl->ob->name . "/" . $_;
1082 }
1083
1084 \@paths
1085}
1086
1087=item $player->ext_reply ($msgid, $msgtype, %msg)
1088
1089Sends an ext reply to the player.
1090
1091=cut
1092
1093sub ext_reply($$$%) {
1094 my ($self, $id, %msg) = @_;
1095
1096 $msg{msgid} = $id;
1097
1098 $self->send ("ext " . cf::to_json \%msg);
1099}
1100
1101package cf;
1102
1103=back
1104
1105
1106=head3 cf::map
1107
1108=over 4
1109
1110=cut
1111
1112package cf::map;
1113
1114use Fcntl;
1115use Coro::AIO;
1116
1117use overload
1118 '""' => \&as_string,
1119 fallback => 1;
1120
1121our $MAX_RESET = 3600;
1122our $DEFAULT_RESET = 3000;
1123
1124sub generate_random_map {
1125 my ($self, $rmp) = @_;
1126 # mit "rum" bekleckern, nicht
1127 $self->_create_random_map (
1128 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1130 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1131 $rmp->{exit_on_final_map},
1132 $rmp->{xsize}, $rmp->{ysize},
1133 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1134 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1135 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1136 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1137 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138 (cf::region::find $rmp->{region}), $rmp->{custom}
1139 )
1140}
1141
1142sub register {
1143 my (undef, $regex) = @_;
1144 my $pkg = caller;
1145
1146 no strict;
1147 push @{"$pkg\::ISA"}, __PACKAGE__;
1148
1149 $EXT_MAP{$pkg} = qr<$regex>;
1150}
1151
1152# also paths starting with '/'
1153$EXT_MAP{"cf::map"} = qr{^(?=/)};
1154
1155sub thawer_merge {
1156 my ($self, $merge) = @_;
1157
1158 # we have to keep some variables in memory intact
1159 local $self->{path};
1160 local $self->{load_path};
1161 local $self->{deny_save};
1162 local $self->{deny_reset};
1163
1164 $self->SUPER::thawer_merge ($merge);
1165}
1166
1167sub normalise {
1168 my ($path, $base) = @_;
1169
1170 # map plan:
1171 #
1172 # /! non-realised random map exit (special hack!)
1173 # {... are special paths that are not being touched
1174 # ?xxx/... are special absolute paths
1175 # ?random/... random maps
1176 # /... normal maps
1177 # ~user/... per-player map of a specific user
1178
1179 $path =~ s/$PATH_SEP/\//go;
1180
1181 # treat it as relative path if it starts with
1182 # something that looks reasonable
1183 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1184 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1185
1186 $base =~ s{[^/]+/?$}{};
1187 $path = "$base/$path";
1188 }
1189
1190 for ($path) {
1191 redo if s{//}{/};
1192 redo if s{/\.?/}{/};
1193 redo if s{/[^/]+/\.\./}{/};
1194 }
1195
1196 $path
1197}
1198
1199sub new_from_path {
1200 my (undef, $path, $base) = @_;
1201
1202 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203
1204 $path = normalise $path, $base;
1205
1206 for my $pkg (keys %EXT_MAP) {
1207 if ($path =~ $EXT_MAP{$pkg}) {
1208 my $self = bless cf::map::new, $pkg;
1209 $self->{path} = $path; $self->path ($path);
1210 $self->init; # pass $1 etc.
1211 return $self;
1212 }
1213 }
1214
1215 Carp::carp "unable to resolve path '$path'.";
1216 ()
1217}
1218
1219sub init {
1220 my ($self) = @_;
1221
1222 $self
1223}
1224
1225sub as_string {
1226 my ($self) = @_;
1227
1228 "$self->{path}"
1229}
1230
1231# the displayed name, this is a one way mapping
1232sub visible_name {
1233 &as_string
1234}
1235
1236# the original (read-only) location
1237sub load_path {
1238 my ($self) = @_;
1239
1240 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
1241}
1242
1243# the temporary/swap location
1244sub save_path {
1245 my ($self) = @_;
1246
1247 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1248 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
1249}
1250
1251# the unique path, undef == no special unique path
1252sub uniq_path {
1253 my ($self) = @_;
1254
1255 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1256 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1257}
1258
1259# and all this just because we cannot iterate over
1260# all maps in C++...
1261sub change_all_map_light {
1262 my ($change) = @_;
1263
1264 $_->change_map_light ($change)
1265 for grep $_->outdoor, values %cf::MAP;
1266}
1267
1268sub unlink_save {
1269 my ($self) = @_;
1270
1271 utf8::encode (my $save = $self->save_path);
1272 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1273 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1274}
1275
1276sub load_header_from($) {
1277 my ($self, $path) = @_;
1278
1279 utf8::encode $path;
1280 aio_open $path, O_RDONLY, 0
1281 or return;
1282
1283 $self->_load_header ($path)
1284 or return;
1285
1286 $self->{load_path} = $path;
1287
1288 1
1289}
1290
1291sub load_orig {
1292 my ($self) = @_;
1293
1294 $self->load_header_from ($self->load_path)
1295}
1296
1297sub load_temp {
1298 my ($self) = @_;
1299
1300 $self->load_header_from ($self->save_path)
1301}
1302
1303sub load_header {
1304 my ($self) = @_;
1305
1306 if ($self->load_temp) {
1307 $self->last_access ((delete $self->{last_access})
1308 || $cf::RUNTIME); #d#
1309 # safety
1310 $self->{instantiate_time} = $cf::RUNTIME
1311 if $self->{instantiate_time} > $cf::RUNTIME;
1312 } else {
1313 $self->load_orig
1314 or return;
1315
1316 $self->{load_original} = 1;
1317 $self->{instantiate_time} = $cf::RUNTIME;
1318 $self->last_access ($cf::RUNTIME);
1319 $self->instantiate;
1320 }
1321
1322 1
1323}
1324
1325sub find;
1326sub find {
1327 my ($path, $origin) = @_;
1328
1329 $path = normalise $path, $origin && $origin->path;
1330
1331 cf::lock_wait "map_find:$path";
1332
1333 $cf::MAP{$path} || do {
1334 my $guard = cf::lock_acquire "map_find:$path";
1335 my $map = new_from_path cf::map $path
1336 or return;
1337
1338 $map->{last_save} = $cf::RUNTIME;
1339
1340 $map->load_header
1341 or return;
1342
1343 if ($map->should_reset) {
1344 # doing this can freeze the server in a sync job, obviously
1345 #$cf::WAIT_FOR_TICK->wait;
1346 $map->reset;
1347 undef $guard;
1348 $map = find $path
1349 or return;
1350 }
1351
1352 $cf::MAP{$path} = $map
1353 }
1354}
1355
1356sub load {
1357 my ($self) = @_;
1358
1359 my $path = $self->{path};
1360 my $guard = cf::lock_acquire "map_load:$path";
1361
1362 return if $self->in_memory != cf::MAP_SWAPPED;
1363
1364 $self->in_memory (cf::MAP_LOADING);
1365
1366 $self->alloc;
1367 $self->_load_objects ($self->{load_path}, 1)
1368 or return;
1369
1370 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1371 if delete $self->{load_original};
1372
1373 if (my $uniq = $self->uniq_path) {
1374 utf8::encode $uniq;
1375 if (aio_open $uniq, O_RDONLY, 0) {
1376 $self->clear_unique_items;
1377 $self->_load_objects ($uniq, 0);
1378 }
1379 }
1380
1381 Coro::cede;
1382
1383 # now do the right thing for maps
1384 $self->link_multipart_objects;
1385
1386 unless ($self->{deny_activate}) {
1387 $self->decay_objects;
1388 $self->fix_auto_apply;
1389 $self->update_buttons;
1390 Coro::cede;
1391 $self->set_darkness_map;
1392 $self->difficulty ($self->estimate_difficulty)
1393 unless $self->difficulty;
1394 Coro::cede;
1395 $self->activate;
1396 }
1397
1398 $self->in_memory (cf::MAP_IN_MEMORY);
1399}
1400
1401sub customise_for {
1402 my ($self, $ob) = @_;
1403
1404 return find "~" . $ob->name . "/" . $self->{path}
1405 if $self->per_player;
1406
1407 $self
1408}
1409
1410# find and load all maps in the 3x3 area around a map
1411sub load_diag {
716 my ($map) = @_; 1412 my ($map) = @_;
717 1413
718 my $path = $map->tmpname; 1414 my @diag; # diagonal neighbours
719 defined $path or return;
720 1415
721 unlink "$path.pst"; 1416 for (0 .. 3) {
722}; 1417 my $neigh = $map->tile_path ($_)
1418 or next;
1419 $neigh = find $neigh, $map
1420 or next;
1421 $neigh->load;
723 1422
724cf::map->attach (prio => -10000, package => cf::mapsupport::); 1423 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1424 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1425 }
725 1426
726############################################################################# 1427 for (@diag) {
727# load/save perl data associated with player->ob objects 1428 my $neigh = find @$_
728 1429 or next;
729sub all_objects(@) { 1430 $neigh->load;
730 @_, map all_objects ($_->inv), @_ 1431 }
731} 1432}
732 1433
733# TODO: compatibility cruft, remove when no longer needed 1434sub find_sync {
734cf::player->attach ( 1435 my ($path, $origin) = @_;
735 on_load => sub {
736 my ($pl, $path) = @_;
737 1436
738 for my $o (all_objects $pl->ob) { 1437 cf::sync_job { find $path, $origin }
739 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1438}
740 $o->set_ob_key_value ("_perl_data");
741 1439
742 %$o = %{ Storable::thaw pack "H*", $value }; 1440sub do_load_sync {
1441 my ($map) = @_;
1442
1443 cf::sync_job { $map->load };
1444}
1445
1446our %MAP_PREFETCH;
1447our $MAP_PREFETCHER = undef;
1448
1449sub find_async {
1450 my ($path, $origin) = @_;
1451
1452 $path = normalise $path, $origin && $origin->{path};
1453
1454 if (my $map = $cf::MAP{$path}) {
1455 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1456 }
1457
1458 undef $MAP_PREFETCH{$path};
1459 $MAP_PREFETCHER ||= cf::async {
1460 while (%MAP_PREFETCH) {
1461 for my $path (keys %MAP_PREFETCH) {
1462 my $map = find $path
1463 or next;
1464 $map->load;
1465
1466 delete $MAP_PREFETCH{$path};
743 } 1467 }
744 } 1468 }
1469 undef $MAP_PREFETCHER;
1470 };
1471
1472 ()
1473}
1474
1475sub save {
1476 my ($self) = @_;
1477
1478 my $lock = cf::lock_acquire "map_data:" . $self->path;
1479
1480 $self->{last_save} = $cf::RUNTIME;
1481
1482 return unless $self->dirty;
1483
1484 my $save = $self->save_path; utf8::encode $save;
1485 my $uniq = $self->uniq_path; utf8::encode $uniq;
1486
1487 $self->{load_path} = $save;
1488
1489 return if $self->{deny_save};
1490
1491 local $self->{last_access} = $self->last_access;#d#
1492
1493 cf::async {
1494 $_->contr->save for $self->players;
1495 };
1496
1497 if ($uniq) {
1498 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1499 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1500 } else {
1501 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
745 }, 1502 }
746); 1503}
747 1504
748############################################################################# 1505sub swap_out {
1506 my ($self) = @_;
749 1507
750=head2 CORE EXTENSIONS 1508 # save first because save cedes
1509 $self->save;
751 1510
752Functions and methods that extend core crossfire objects. 1511 my $lock = cf::lock_acquire "map_data:" . $self->path;
753 1512
754=head3 cf::player 1513 return if $self->players;
1514 return if $self->in_memory != cf::MAP_IN_MEMORY;
1515 return if $self->{deny_save};
1516
1517 $self->clear;
1518 $self->in_memory (cf::MAP_SWAPPED);
1519}
1520
1521sub reset_at {
1522 my ($self) = @_;
1523
1524 # TODO: safety, remove and allow resettable per-player maps
1525 return 1e99 if $self->isa ("ext::map_per_player");#d#
1526 return 1e99 if $self->{deny_reset};
1527
1528 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1529 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1530
1531 $time + $to
1532}
1533
1534sub should_reset {
1535 my ($self) = @_;
1536
1537 $self->reset_at <= $cf::RUNTIME
1538}
1539
1540sub reset {
1541 my ($self) = @_;
1542
1543 my $lock = cf::lock_acquire "map_data:$self->{path}";
1544
1545 return if $self->players;
1546 return if $self->isa ("ext::map_per_player");#d#
1547
1548 warn "resetting map ", $self->path;#d#
1549
1550 delete $cf::MAP{$self->path};
1551
1552 $self->in_memory (cf::MAP_SWAPPED);
1553 $self->clear;
1554
1555 $_->clear_links_to ($self) for values %cf::MAP;
1556
1557 $self->unlink_save;
1558 $self->destroy;
1559}
1560
1561my $nuke_counter = "aaaa";
1562
1563sub nuke {
1564 my ($self) = @_;
1565
1566 delete $cf::MAP{$self->path};
1567
1568 $self->unlink_save;
1569
1570 bless $self, "cf::map";
1571 delete $self->{deny_reset};
1572 $self->{deny_save} = 1;
1573 $self->reset_timeout (1);
1574 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1575
1576 $cf::MAP{$self->path} = $self;
1577
1578 $self->reset; # polite request, might not happen
1579}
1580
1581=item cf::map::unique_maps
1582
1583Returns an arrayref of paths of all shared maps that have
1584instantiated unique items. May block.
1585
1586=cut
1587
1588sub unique_maps() {
1589 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1590 or return;
1591
1592 my @paths;
1593
1594 for (@$files) {
1595 utf8::decode $_;
1596 next if /\.pst$/;
1597 next unless /^$PATH_SEP/o;
1598
1599 s/\.map$//;
1600 push @paths, $_;
1601 }
1602
1603 \@paths
1604}
1605
1606package cf;
1607
1608=back
1609
1610=head3 cf::object
1611
1612=cut
1613
1614package cf::object;
755 1615
756=over 4 1616=over 4
757 1617
758=item cf::player::exists $login 1618=item $ob->inv_recursive
759 1619
760Returns true when the given account exists. 1620Returns the inventory of the object _and_ their inventories, recursively.
761 1621
762=cut 1622=cut
763 1623
764sub cf::player::exists($) { 1624sub inv_recursive_;
765 cf::player::find $_[0] 1625sub inv_recursive_ {
766 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1626 map { $_, inv_recursive_ $_->inv } @_
767} 1627}
768 1628
769=item $player->ext_reply ($msgid, $msgtype, %msg) 1629sub inv_recursive {
770 1630 inv_recursive_ inv $_[0]
771Sends an ext reply to the player.
772
773=cut
774
775sub cf::player::ext_reply($$$%) {
776 my ($self, $id, %msg) = @_;
777
778 $msg{msgid} = $id;
779
780 $self->send ("ext " . to_json \%msg);
781} 1631}
1632
1633package cf;
782 1634
783=back 1635=back
784 1636
785=head3 cf::object::player 1637=head3 cf::object::player
786 1638
824 (ref $cf::CFG{"may_$access"} 1676 (ref $cf::CFG{"may_$access"}
825 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1677 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826 : $cf::CFG{"may_$access"}) 1678 : $cf::CFG{"may_$access"})
827} 1679}
828 1680
1681=item $player_object->enter_link
1682
1683Freezes the player and moves him/her to a special map (C<{link}>).
1684
1685The player should be reasonably safe there for short amounts of time. You
1686I<MUST> call C<leave_link> as soon as possible, though.
1687
1688Will never block.
1689
1690=item $player_object->leave_link ($map, $x, $y)
1691
1692Moves the player out of the special C<{link}> map onto the specified
1693map. If the map is not valid (or omitted), the player will be moved back
1694to the location he/she was before the call to C<enter_link>, or, if that
1695fails, to the emergency map position.
1696
1697Might block.
1698
1699=cut
1700
1701sub link_map {
1702 unless ($LINK_MAP) {
1703 $LINK_MAP = cf::map::find "{link}"
1704 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1705 $LINK_MAP->load;
1706 }
1707
1708 $LINK_MAP
1709}
1710
1711sub cf::object::player::enter_link {
1712 my ($self) = @_;
1713
1714 $self->deactivate_recursive;
1715
1716 return if UNIVERSAL::isa $self->map, "ext::map_link";
1717
1718 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1719 if $self->map;
1720
1721 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1722}
1723
1724sub cf::object::player::leave_link {
1725 my ($self, $map, $x, $y) = @_;
1726
1727 my $link_pos = delete $self->{_link_pos};
1728
1729 unless ($map) {
1730 # restore original map position
1731 ($map, $x, $y) = @{ $link_pos || [] };
1732 $map = cf::map::find $map;
1733
1734 unless ($map) {
1735 ($map, $x, $y) = @$EMERGENCY_POSITION;
1736 $map = cf::map::find $map
1737 or die "FATAL: cannot load emergency map\n";
1738 }
1739 }
1740
1741 ($x, $y) = (-1, -1)
1742 unless (defined $x) && (defined $y);
1743
1744 # use -1 or undef as default coordinates, not 0, 0
1745 ($x, $y) = ($map->enter_x, $map->enter_y)
1746 if $x <=0 && $y <= 0;
1747
1748 $map->load;
1749 $map->load_diag;
1750
1751 return unless $self->contr->active;
1752 $self->activate_recursive;
1753 $self->enter_map ($map, $x, $y);
1754}
1755
1756cf::player->attach (
1757 on_logout => sub {
1758 my ($pl) = @_;
1759
1760 # abort map switching before logout
1761 if ($pl->ob->{_link_pos}) {
1762 cf::sync_job {
1763 $pl->ob->leave_link
1764 };
1765 }
1766 },
1767 on_login => sub {
1768 my ($pl) = @_;
1769
1770 # try to abort aborted map switching on player login :)
1771 # should happen only on crashes
1772 if ($pl->ob->{_link_pos}) {
1773 $pl->ob->enter_link;
1774 (async {
1775 # we need this sleep as the login has a concurrent enter_exit running
1776 # and this sleep increases chances of the player not ending up in scorn
1777 $pl->ob->reply (undef,
1778 "There was an internal problem at your last logout, "
1779 . "the server will try to bring you to your intended destination in a second.",
1780 cf::NDI_RED);
1781 Coro::Timer::sleep 1;
1782 $pl->ob->leave_link;
1783 })->prio (2);
1784 }
1785 },
1786);
1787
1788=item $player_object->goto ($path, $x, $y)
1789
1790=cut
1791
1792sub cf::object::player::goto {
1793 my ($self, $path, $x, $y) = @_;
1794
1795 $self->enter_link;
1796
1797 (async {
1798 my $map = cf::map::find $path;
1799 $map = $map->customise_for ($self) if $map;
1800
1801# warn "entering ", $map->path, " at ($x, $y)\n"
1802# if $map;
1803
1804 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1805
1806 $self->leave_link ($map, $x, $y);
1807 })->prio (1);
1808}
1809
1810=item $player_object->enter_exit ($exit_object)
1811
1812=cut
1813
1814sub parse_random_map_params {
1815 my ($spec) = @_;
1816
1817 my $rmp = { # defaults
1818 xsize => (cf::rndm 15, 40),
1819 ysize => (cf::rndm 15, 40),
1820 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1821 #layout => string,
1822 };
1823
1824 for (split /\n/, $spec) {
1825 my ($k, $v) = split /\s+/, $_, 2;
1826
1827 $rmp->{lc $k} = $v if (length $k) && (length $v);
1828 }
1829
1830 $rmp
1831}
1832
1833sub prepare_random_map {
1834 my ($exit) = @_;
1835
1836 my $guard = cf::lock_acquire "exit_prepare:$exit";
1837
1838 # all this does is basically replace the /! path by
1839 # a new random map path (?random/...) with a seed
1840 # that depends on the exit object
1841
1842 my $rmp = parse_random_map_params $exit->msg;
1843
1844 if ($exit->map) {
1845 $rmp->{region} = $exit->map->region_name;
1846 $rmp->{origin_map} = $exit->map->path;
1847 $rmp->{origin_x} = $exit->x;
1848 $rmp->{origin_y} = $exit->y;
1849 }
1850
1851 $rmp->{random_seed} ||= $exit->random_seed;
1852
1853 my $data = cf::to_json $rmp;
1854 my $md5 = Digest::MD5::md5_hex $data;
1855 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1856
1857 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1858 aio_write $fh, 0, (length $data), $data, 0;
1859 undef $fh;
1860 aio_rename "$meta~", $meta;
1861
1862 $exit->slaying ("?random/$md5");
1863 $exit->msg (undef);
1864 }
1865}
1866
1867sub cf::object::player::enter_exit {
1868 my ($self, $exit) = @_;
1869
1870 return unless $self->type == cf::PLAYER;
1871
1872 $self->enter_link;
1873
1874 (async {
1875 $self->deactivate_recursive; # just to be sure
1876 unless (eval {
1877 prepare_random_map $exit
1878 if $exit->slaying eq "/!";
1879
1880 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1881 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1882
1883 1;
1884 }) {
1885 $self->message ("Something went wrong deep within the crossfire server. "
1886 . "I'll try to bring you back to the map you were before. "
1887 . "Please report this to the dungeon master!",
1888 cf::NDI_UNIQUE | cf::NDI_RED);
1889
1890 warn "ERROR in enter_exit: $@";
1891 $self->leave_link;
1892 }
1893 })->prio (1);
1894}
1895
829=head3 cf::client 1896=head3 cf::client
830 1897
831=over 4 1898=over 4
832 1899
833=item $client->send_drawinfo ($text, $flags) 1900=item $client->send_drawinfo ($text, $flags)
876 on_reply => sub { 1943 on_reply => sub {
877 my ($ns, $msg) = @_; 1944 my ($ns, $msg) = @_;
878 1945
879 # this weird shuffling is so that direct followup queries 1946 # this weird shuffling is so that direct followup queries
880 # get handled first 1947 # get handled first
881 my $queue = delete $ns->{query_queue}; 1948 my $queue = delete $ns->{query_queue}
1949 or return; # be conservative, not sure how that can happen, but we saw a crash here
882 1950
883 (shift @$queue)->[1]->($msg); 1951 (shift @$queue)->[1]->($msg);
884 1952
885 push @{ $ns->{query_queue} }, @$queue; 1953 push @{ $ns->{query_queue} }, @$queue;
886 1954
887 if (@{ $ns->{query_queue} } == @$queue) { 1955 if (@{ $ns->{query_queue} } == @$queue) {
888 if (@$queue) { 1956 if (@$queue) {
889 $ns->send_packet ($ns->{query_queue}[0][0]); 1957 $ns->send_packet ($ns->{query_queue}[0][0]);
890 } else { 1958 } else {
891 $ns->state (ST_PLAYING); 1959 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
892 } 1960 }
893 } 1961 }
894 }, 1962 },
895); 1963);
896 1964
897=item $client->coro (\&cb) 1965=item $client->async (\&cb)
898 1966
899Create a new coroutine, running the specified callback. The coroutine will 1967Create a new coroutine, running the specified callback. The coroutine will
900be automatically cancelled when the client gets destroyed (e.g. on logout, 1968be automatically cancelled when the client gets destroyed (e.g. on logout,
901or loss of connection). 1969or loss of connection).
902 1970
903=cut 1971=cut
904 1972
905sub cf::client::coro { 1973sub cf::client::async {
906 my ($self, $cb) = @_; 1974 my ($self, $cb) = @_;
907 1975
908 my $coro; $coro = async { 1976 my $coro = &Coro::async ($cb);
909 eval { 1977
910 $cb->(); 1978 $coro->on_destroy (sub {
911 };
912 warn $@ if $@;
913 delete $self->{_coro}{$coro+0}; 1979 delete $self->{_coro}{$coro+0};
914 }; 1980 });
915 1981
916 $self->{_coro}{$coro+0} = $coro; 1982 $self->{_coro}{$coro+0} = $coro;
1983
1984 $coro
917} 1985}
918 1986
919cf::client->attach ( 1987cf::client->attach (
920 on_destroy => sub { 1988 on_destroy => sub {
921 my ($ns) = @_; 1989 my ($ns) = @_;
1085 2153
1086{ 2154{
1087 my $path = cf::localdir . "/database.pst"; 2155 my $path = cf::localdir . "/database.pst";
1088 2156
1089 sub db_load() { 2157 sub db_load() {
1090 warn "loading database $path\n";#d# remove later
1091 $DB = stat $path ? Storable::retrieve $path : { }; 2158 $DB = stat $path ? Storable::retrieve $path : { };
1092 } 2159 }
1093 2160
1094 my $pid; 2161 my $pid;
1095 2162
1096 sub db_save() { 2163 sub db_save() {
1097 warn "saving database $path\n";#d# remove later
1098 waitpid $pid, 0 if $pid; 2164 waitpid $pid, 0 if $pid;
1099 if (0 == ($pid = fork)) { 2165 if (0 == ($pid = fork)) {
1100 $DB->{_meta}{version} = 1; 2166 $DB->{_meta}{version} = 1;
1101 Storable::nstore $DB, "$path~"; 2167 Storable::nstore $DB, "$path~";
1102 rename "$path~", $path; 2168 rename "$path~", $path;
1109 sub db_sync() { 2175 sub db_sync() {
1110 db_save if $dirty; 2176 db_save if $dirty;
1111 undef $dirty; 2177 undef $dirty;
1112 } 2178 }
1113 2179
1114 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { 2180 my $idle = Event->idle (min => 10, max => 20, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1115 db_sync; 2181 db_sync;
1116 }); 2182 });
1117 2183
1118 sub db_dirty() { 2184 sub db_dirty() {
1119 $dirty = 1; 2185 $dirty = 1;
1150 open my $fh, "<:utf8", cf::confdir . "/config" 2216 open my $fh, "<:utf8", cf::confdir . "/config"
1151 or return; 2217 or return;
1152 2218
1153 local $/; 2219 local $/;
1154 *CFG = YAML::Syck::Load <$fh>; 2220 *CFG = YAML::Syck::Load <$fh>;
2221
2222 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2223
2224 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2225 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2226
2227 if (exists $CFG{mlockall}) {
2228 eval {
2229 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2230 and die "WARNING: m(un)lockall failed: $!\n";
2231 };
2232 warn $@ if $@;
2233 }
1155} 2234}
1156 2235
1157sub main { 2236sub main {
2237 # we must not ever block the main coroutine
2238 local $Coro::idle = sub {
2239 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2240 (async {
2241 Event::one_event;
2242 })->prio (Coro::PRIO_MAX);
2243 };
2244
1158 cfg_load; 2245 cfg_load;
1159 db_load; 2246 db_load;
1160 load_extensions; 2247 load_extensions;
2248
2249 $TICK_WATCHER->start;
1161 Event::loop; 2250 Event::loop;
1162} 2251}
1163 2252
1164############################################################################# 2253#############################################################################
1165# initialisation 2254# initialisation and cleanup
1166 2255
2256# install some emergency cleanup handlers
2257BEGIN {
2258 for my $signal (qw(INT HUP TERM)) {
2259 Event->signal (
2260 data => WF_AUTOCANCEL,
2261 signal => $signal,
2262 cb => sub {
2263 cf::cleanup "SIG$signal";
2264 },
2265 );
2266 }
2267}
2268
2269sub emergency_save() {
2270 my $freeze_guard = cf::freeze_mainloop;
2271
2272 warn "enter emergency perl save\n";
2273
2274 cf::sync_job {
2275 # use a peculiar iteration method to avoid tripping on perl
2276 # refcount bugs in for. also avoids problems with players
2277 # and maps saved/destroyed asynchronously.
2278 warn "begin emergency player save\n";
2279 for my $login (keys %cf::PLAYER) {
2280 my $pl = $cf::PLAYER{$login} or next;
2281 $pl->valid or next;
2282 $pl->save;
2283 }
2284 warn "end emergency player save\n";
2285
2286 warn "begin emergency map save\n";
2287 for my $path (keys %cf::MAP) {
2288 my $map = $cf::MAP{$path} or next;
2289 $map->valid or next;
2290 $map->save;
2291 }
2292 warn "end emergency map save\n";
2293 };
2294
2295 warn "leave emergency perl save\n";
2296}
2297
1167sub _perl_reload(&) { 2298sub reload() {
1168 my ($msg) = @_; 2299 # can/must only be called in main
2300 if ($Coro::current != $Coro::main) {
2301 warn "can only reload from main coroutine";
2302 return;
2303 }
1169 2304
1170 $msg->("reloading..."); 2305 warn "reloading...";
2306
2307 warn "cancelling server ticker";
2308 $TICK_WATCHER->cancel;
2309
2310 cf::emergency_save;
1171 2311
1172 eval { 2312 eval {
1173 # cancel all watchers 2313 # if anything goes wrong in here, we should simply crash as we already saved
2314
2315 warn "syncing database to disk";
2316 cf::db_sync;
2317
2318 warn "cancelling all WF_AUTOCANCEL watchers";
1174 for (Event::all_watchers) { 2319 for (Event::all_watchers) {
1175 $_->cancel if $_->data & WF_AUTOCANCEL; 2320 $_->cancel if $_->data & WF_AUTOCANCEL;
1176 } 2321 }
1177 2322
1178 # unload all extensions 2323 warn "flushing outstanding aio requests";
1179 for (@exts) { 2324 for (;;) {
1180 $msg->("unloading <$_>"); 2325 IO::AIO::flush;
1181 unload_extension $_; 2326 Coro::cede;
2327 last unless IO::AIO::nreqs;
2328 warn "iterate...";
2329 }
2330
2331 warn "cancelling all extension coros";
2332 $_->cancel for values %EXT_CORO;
2333 %EXT_CORO = ();
2334
2335 warn "removing commands";
2336 %COMMAND = ();
2337
2338 warn "removing ext commands";
2339 %EXTCMD = ();
2340
2341 warn "unloading/nuking all extensions";
2342 for my $pkg (@EXTS) {
2343 warn "... unloading $pkg";
2344
2345 if (my $cb = $pkg->can ("unload")) {
2346 eval {
2347 $cb->($pkg);
2348 1
2349 } or warn "$pkg unloaded, but with errors: $@";
1182 } 2350 }
1183 2351
2352 warn "... nuking $pkg";
2353 Symbol::delete_package $pkg;
2354 }
2355
1184 # unload all modules loaded from $LIBDIR 2356 warn "unloading all perl modules loaded from $LIBDIR";
1185 while (my ($k, $v) = each %INC) { 2357 while (my ($k, $v) = each %INC) {
1186 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2358 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1187 2359
1188 $msg->("removing <$k>"); 2360 warn "... unloading $k";
1189 delete $INC{$k}; 2361 delete $INC{$k};
1190 2362
1191 $k =~ s/\.pm$//; 2363 $k =~ s/\.pm$//;
1192 $k =~ s/\//::/g; 2364 $k =~ s/\//::/g;
1193 2365
1196 } 2368 }
1197 2369
1198 Symbol::delete_package $k; 2370 Symbol::delete_package $k;
1199 } 2371 }
1200 2372
1201 # sync database to disk
1202 cf::db_sync;
1203
1204 # get rid of safe::, as good as possible 2373 warn "getting rid of safe::, as good as possible";
1205 Symbol::delete_package "safe::$_" 2374 Symbol::delete_package "safe::$_"
1206 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2375 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1207 2376
1208 # remove register_script_function callbacks
1209 # TODO
1210
1211 # unload cf.pm "a bit" 2377 warn "unloading cf.pm \"a bit\"";
1212 delete $INC{"cf.pm"}; 2378 delete $INC{"cf.pm"};
1213 2379
1214 # don't, removes xs symbols, too, 2380 # don't, removes xs symbols, too,
1215 # and global variables created in xs 2381 # and global variables created in xs
1216 #Symbol::delete_package __PACKAGE__; 2382 #Symbol::delete_package __PACKAGE__;
1217 2383
1218 # reload cf.pm 2384 warn "unload completed, starting to reload now";
2385
1219 $msg->("reloading cf.pm"); 2386 warn "reloading cf.pm";
1220 require cf; 2387 require cf;
2388 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1221 2389
1222 # load config and database again 2390 warn "loading config and database again";
1223 cf::cfg_load; 2391 cf::cfg_load;
1224 cf::db_load; 2392 cf::db_load;
1225 2393
1226 # load extensions 2394 warn "loading extensions";
1227 $msg->("load extensions");
1228 cf::load_extensions; 2395 cf::load_extensions;
1229 2396
1230 # reattach attachments to objects 2397 warn "reattaching attachments to objects/players";
1231 $msg->("reattach");
1232 _global_reattach; 2398 _global_reattach;
2399 warn "reattaching attachments to maps";
2400 reattach $_ for values %MAP;
2401
2402 warn "restarting server ticker";
2403
2404 $TICK_WATCHER->start;
1233 }; 2405 };
1234 $msg->($@) if $@;
1235 2406
1236 $msg->("reloaded"); 2407 if ($@) {
2408 warn $@;
2409 warn "error while reloading, exiting.";
2410 exit 1;
2411 }
2412
2413 warn "reloaded";
1237}; 2414};
1238 2415
1239sub perl_reload() { 2416our $RELOAD_WATCHER; # used only during reload
1240 _perl_reload {
1241 warn $_[0];
1242 print "$_[0]\n";
1243 };
1244}
1245 2417
1246register "<global>", __PACKAGE__;
1247
1248register_command "perl-reload" => sub { 2418register_command "reload" => sub {
1249 my ($who, $arg) = @_; 2419 my ($who, $arg) = @_;
1250 2420
1251 if ($who->flag (FLAG_WIZ)) { 2421 if ($who->flag (FLAG_WIZ)) {
1252 _perl_reload { 2422 $who->message ("reloading server.");
1253 warn $_[0]; 2423
1254 $who->message ($_[0]); 2424 # doing reload synchronously and two reloads happen back-to-back,
2425 # coro crashes during coro_state_free->destroy here.
2426
2427 $RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2428 reload;
2429 undef $RELOAD_WATCHER;
1255 }; 2430 });
1256 } 2431 }
1257}; 2432};
1258 2433
1259unshift @INC, $LIBDIR; 2434unshift @INC, $LIBDIR;
1260 2435
2436my $bug_warning = 0;
2437
1261$TICK_WATCHER = Event->timer ( 2438$TICK_WATCHER = Event->timer (
2439 reentrant => 0,
2440 parked => 1,
1262 prio => 0, 2441 prio => 0,
1263 at => $NEXT_TICK || 1, 2442 at => $NEXT_TICK || $TICK,
1264 data => WF_AUTOCANCEL, 2443 data => WF_AUTOCANCEL,
1265 cb => sub { 2444 cb => sub {
2445 if ($Coro::current != $Coro::main) {
2446 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2447 unless ++$bug_warning > 10;
2448 return;
2449 }
2450
2451 $NOW = Event::time;
2452
1266 cf::server_tick; # one server iteration 2453 cf::server_tick; # one server iteration
1267 2454 $RUNTIME += $TICK;
1268 my $NOW = Event::time;
1269 $NEXT_TICK += $TICK; 2455 $NEXT_TICK += $TICK;
1270 2456
2457 $WAIT_FOR_TICK->broadcast;
2458 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2459
1271 # if we are delayed by four ticks or more, skip them all 2460 # if we are delayed by four ticks or more, skip them all
1272 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2461 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1273 2462
1274 $TICK_WATCHER->at ($NEXT_TICK); 2463 $TICK_WATCHER->at ($NEXT_TICK);
1275 $TICK_WATCHER->start; 2464 $TICK_WATCHER->start;
1276 }, 2465 },
1277); 2466);
1278 2467
1279IO::AIO::max_poll_time $TICK * 0.2; 2468IO::AIO::max_poll_time $TICK * 0.2;
1280 2469
2470$AIO_POLL_WATCHER = Event->io (
1281Event->io (fd => IO::AIO::poll_fileno, 2471 fd => IO::AIO::poll_fileno,
1282 poll => 'r', 2472 poll => 'r',
1283 prio => 5, 2473 prio => 5,
1284 data => WF_AUTOCANCEL, 2474 data => WF_AUTOCANCEL,
1285 cb => \&IO::AIO::poll_cb); 2475 cb => \&IO::AIO::poll_cb,
2476);
2477
2478$WRITE_RUNTIME_WATCHER = Event->timer (
2479 data => WF_AUTOCANCEL,
2480 after => 1,
2481 interval => 10,
2482 cb => Coro::unblock_sub {
2483 write_runtime
2484 or warn "ERROR: unable to write runtime file: $!";
2485 },
2486);
2487
2488END { cf::emergency_save }
1286 2489
12871 24901
1288 2491

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines