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.95 by root, Fri Dec 22 02:04:20 2006 UTC vs.
Revision 1.180 by root, Fri Jan 19 00:38:02 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Storable;
6use Opcode; 9use Opcode;
7use Safe; 10use Safe;
8use Safe::Hole; 11use Safe::Hole;
9 12
13use Coro 3.4 ();
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18use Coro::AIO;
19
20use Data::Dumper;
21use Digest::MD5;
22use Fcntl;
10use IO::AIO (); 23use IO::AIO 2.32 ();
11use YAML::Syck (); 24use YAML::Syck ();
12use Time::HiRes; 25use Time::HiRes;
13use Event; 26
14$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
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15 30
16# 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?
17$YAML::Syck::ImplicitUnicode = 1; 32$YAML::Syck::ImplicitUnicode = 1;
18 33
19use strict; 34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 35
23our %COMMAND = (); 36our %COMMAND = ();
24our %COMMAND_TIME = (); 37our %COMMAND_TIME = ();
38
39our @EXTS = (); # list of extension package names
25our %EXTCMD = (); 40our %EXTCMD = ();
26 41our %EXT_CORO = (); # coroutines bound to extensions
27_init_vars; 42our %EXT_MAP = (); # pluggable maps
28 43
29our @EVENT; 44our @EVENT;
30our $LIBDIR = datadir . "/ext"; 45our $LIBDIR = datadir . "/ext";
31 46
32our $TICK = MAX_TIME * 1e-6; 47our $TICK = MAX_TIME * 1e-6;
33our $TICK_WATCHER; 48our $TICK_WATCHER;
49our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER;
34our $NEXT_TICK; 51our $NEXT_TICK;
52our $NOW;
35 53
36our %CFG; 54our %CFG;
37 55
38our $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;
39 87
40############################################################################# 88#############################################################################
41 89
42=head2 GLOBAL VARIABLES 90=head2 GLOBAL VARIABLES
43 91
44=over 4 92=over 4
45 93
46=item $cf::UPTIME 94=item $cf::UPTIME
47 95
48The 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.
49 102
50=item $cf::LIBDIR 103=item $cf::LIBDIR
51 104
52The perl library directory, where extensions and cf-specific modules can 105The perl library directory, where extensions and cf-specific modules can
53be found. It will be added to C<@INC> automatically. 106be found. It will be added to C<@INC> automatically.
54 107
108=item $cf::NOW
109
110The time of the last (current) server tick.
111
55=item $cf::TICK 112=item $cf::TICK
56 113
57The interval between server ticks, in seconds. 114The interval between server ticks, in seconds.
58 115
59=item %cf::CFG 116=item %cf::CFG
60 117
61Configuration for the server, loaded from C</etc/crossfire/config>, or 118Configuration for the server, loaded from C</etc/crossfire/config>, or
62from 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.
63 127
64=back 128=back
65 129
66=cut 130=cut
67 131
68BEGIN { 132BEGIN {
69 *CORE::GLOBAL::warn = sub { 133 *CORE::GLOBAL::warn = sub {
70 my $msg = join "", @_; 134 my $msg = join "", @_;
135 utf8::encode $msg;
136
71 $msg .= "\n" 137 $msg .= "\n"
72 unless $msg =~ /\n$/; 138 unless $msg =~ /\n$/;
73 139
74 print STDERR "cfperl: $msg";
75 LOG llevError, "cfperl: $msg"; 140 LOG llevError, $msg;
76 }; 141 };
77} 142}
78 143
79@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
84@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 149@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
85 150
86# 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
87# within the Safe compartment. 152# within the Safe compartment.
88for my $pkg (qw( 153for my $pkg (qw(
89 cf::global 154 cf::global cf::attachable
90 cf::object cf::object::player 155 cf::object cf::object::player
91 cf::client cf::player 156 cf::client cf::player
92 cf::arch cf::living 157 cf::arch cf::living
93 cf::map cf::party cf::region 158 cf::map cf::party cf::region
94)) { 159)) {
98 163
99$Event::DIED = sub { 164$Event::DIED = sub {
100 warn "error in event callback: @_"; 165 warn "error in event callback: @_";
101}; 166};
102 167
103my %ext_pkg;
104my @exts;
105my @hook;
106
107=head2 UTILITY FUNCTIONS 168=head2 UTILITY FUNCTIONS
108 169
109=over 4 170=over 4
110 171
172=item dumpval $ref
173
111=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}
112 194
113use JSON::Syck (); # TODO# replace by JSON::PC once working 195use JSON::Syck (); # TODO# replace by JSON::PC once working
114 196
115=item $ref = cf::from_json $json 197=item $ref = cf::from_json $json
116 198
130=cut 212=cut
131 213
132sub to_json($) { 214sub to_json($) {
133 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
134 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
135} 368}
136 369
137=back 370=back
138 371
139=cut 372=cut
249 my ($self, $victim) = @_; 482 my ($self, $victim) = @_;
250 ... 483 ...
251 } 484 }
252 } 485 }
253 486
487=item $attachable->valid
488
489Just because you have a perl object does not mean that the corresponding
490C-level object still exists. If you try to access an object that has no
491valid C counterpart anymore you get an exception at runtime. This method
492can be used to test for existence of the C object part without causing an
493exception.
494
254=cut 495=cut
255 496
256# 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
257our @CB_GLOBAL = (); # registry for all global events 498our @CB_GLOBAL = (); # registry for all global events
499our @CB_ATTACHABLE = (); # registry for all attachables
258our @CB_OBJECT = (); # all objects (should not be used except in emergency) 500our @CB_OBJECT = (); # all objects (should not be used except in emergency)
259our @CB_PLAYER = (); 501our @CB_PLAYER = ();
260our @CB_CLIENT = (); 502our @CB_CLIENT = ();
261our @CB_TYPE = (); # registry for type (cf-object class) based events 503our @CB_TYPE = (); # registry for type (cf-object class) based events
262our @CB_MAP = (); 504our @CB_MAP = ();
263 505
264my %attachment; 506my %attachment;
507
508sub cf::attachable::thawer_merge {
509 # simply override everything except _meta
510 local $_[0]{_meta};
511 %{$_[0]} = %{$_[1]};
512}
265 513
266sub _attach_cb($$$$) { 514sub _attach_cb($$$$) {
267 my ($registry, $event, $prio, $cb) = @_; 515 my ($registry, $event, $prio, $cb) = @_;
268 516
269 use sort 'stable'; 517 use sort 'stable';
272 520
273 @{$registry->[$event]} = sort 521 @{$registry->[$event]} = sort
274 { $a->[0] cmp $b->[0] } 522 { $a->[0] cmp $b->[0] }
275 @{$registry->[$event] || []}, $cb; 523 @{$registry->[$event] || []}, $cb;
276} 524}
525
526# hack
527my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
277 528
278# attach handles attaching event callbacks 529# attach handles attaching event callbacks
279# 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
280# registry (== where the callback attaches to). 531# registry (== where the callback attaches to).
281sub _attach { 532sub _attach {
283 534
284 my $object_type; 535 my $object_type;
285 my $prio = 0; 536 my $prio = 0;
286 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;
287 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
288 while (@arg) { 544 while (@arg) {
289 my $type = shift @arg; 545 my $type = shift @arg;
290 546
291 if ($type eq "prio") { 547 if ($type eq "prio") {
292 $prio = shift @arg; 548 $prio = shift @arg;
367 my ($obj, $name) = @_; 623 my ($obj, $name) = @_;
368 624
369 exists $obj->{_attachment}{$name} 625 exists $obj->{_attachment}{$name}
370} 626}
371 627
372for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 628for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
373 eval "#line " . __LINE__ . " 'cf.pm' 629 eval "#line " . __LINE__ . " 'cf.pm'
374 sub cf::\L$klass\E::_attach_registry { 630 sub cf::\L$klass\E::_attach_registry {
375 (\\\@CB_$klass, KLASS_$klass) 631 (\\\@CB_$klass, KLASS_$klass)
376 } 632 }
377 633
413 } 669 }
414 670
415 0 671 0
416} 672}
417 673
418=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 674=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
419 675
420=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
421
422=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
423
424=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...) 676=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
425 677
426=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428Generate a global/object/player/map-specific event with the given arguments. 678Generate an object-specific event with the given arguments.
429 679
430This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be 680This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
431removed in future versions), and there is no public API to access override 681removed in future versions), and there is no public API to access override
432results (if you must, access C<@cf::invoke_results> directly). 682results (if you must, access C<@cf::invoke_results> directly).
433 683
434=back 684=back
435 685
436=cut 686=cut
437 687
438############################################################################# 688#############################################################################
439
440=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
441
442Attachable objects includes objects, players, clients and maps.
443
444=over 4
445
446=item $object->valid
447
448Just because you have a perl object does not mean that the corresponding
449C-level object still exists. If you try to access an object that has no
450valid C counterpart anymore you get an exception at runtime. This method
451can be used to test for existence of the C object part without causing an
452exception.
453
454=back
455
456=cut
457
458#############################################################################
459# object support 689# object support
460 690
461sub instantiate {
462 my ($obj, $data) = @_;
463
464 $data = from_json $data;
465
466 for (@$data) {
467 my ($name, $args) = @$_;
468
469 $obj->attach ($name, %{$args || {} });
470 }
471}
472
473# basically do the same as instantiate, without calling instantiate
474sub reattach { 691sub reattach {
692 # basically do the same as instantiate, without calling instantiate
475 my ($obj) = @_; 693 my ($obj) = @_;
694
695 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
696
476 my $registry = $obj->registry; 697 my $registry = $obj->registry;
477 698
478 @$registry = (); 699 @$registry = ();
479 700
480 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 701 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
489 warn "object uses attachment '$name' that is not available, postponing.\n"; 710 warn "object uses attachment '$name' that is not available, postponing.\n";
490 } 711 }
491 } 712 }
492} 713}
493 714
494sub object_freezer_save { 715cf::attachable->attach (
495 my ($filename, $rdata, $objs) = @_;
496
497 if (length $$rdata) {
498 warn sprintf "saving %s (%d,%d)\n",
499 $filename, length $$rdata, scalar @$objs;
500
501 if (open my $fh, ">:raw", "$filename~") {
502 chmod SAVE_MODE, $fh;
503 syswrite $fh, $$rdata;
504 close $fh;
505
506 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
507 chmod SAVE_MODE, $fh;
508 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
509 close $fh;
510 rename "$filename.pst~", "$filename.pst";
511 } else {
512 unlink "$filename.pst";
513 }
514
515 rename "$filename~", $filename;
516 } else {
517 warn "FATAL: $filename~: $!\n";
518 }
519 } else {
520 unlink $filename;
521 unlink "$filename.pst";
522 }
523}
524
525sub object_freezer_as_string {
526 my ($rdata, $objs) = @_;
527
528 use Data::Dumper;
529
530 $$rdata . Dumper $objs
531}
532
533sub object_thawer_load {
534 my ($filename) = @_;
535
536 local $/;
537
538 my $av;
539
540 #TODO: use sysread etc.
541 if (open my $data, "<:raw:perlio", $filename) {
542 $data = <$data>;
543 if (open my $pst, "<:raw:perlio", "$filename.pst") {
544 $av = eval { (Storable::thaw <$pst>)->{objs} };
545 }
546 return ($data, $av);
547 }
548
549 ()
550}
551
552cf::object->attach (
553 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,
554 on_clone => sub { 729 on_clone => sub {
555 my ($src, $dst) = @_; 730 my ($src, $dst) = @_;
556 731
557 @{$dst->registry} = @{$src->registry}; 732 @{$dst->registry} = @{$src->registry};
558 733
561 %{$dst->{_attachment}} = %{$src->{_attachment}} 736 %{$dst->{_attachment}} = %{$src->{_attachment}}
562 if exists $src->{_attachment}; 737 if exists $src->{_attachment};
563 }, 738 },
564); 739);
565 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
566############################################################################# 806#############################################################################
567# command handling &c 807# command handling &c
568 808
569=item cf::register_command $name => \&callback($ob,$args); 809=item cf::register_command $name => \&callback($ob,$args);
570 810
592=cut 832=cut
593 833
594sub register_extcmd { 834sub register_extcmd {
595 my ($name, $cb) = @_; 835 my ($name, $cb) = @_;
596 836
597 my $caller = caller;
598 #warn "registering extcmd '$name' to '$caller'";
599
600 $EXTCMD{$name} = [$cb, $caller]; 837 $EXTCMD{$name} = $cb;
601} 838}
602 839
603cf::player->attach ( 840cf::player->attach (
604 on_command => sub { 841 on_command => sub {
605 my ($pl, $name, $params) = @_; 842 my ($pl, $name, $params) = @_;
618 855
619 my $msg = eval { from_json $buf }; 856 my $msg = eval { from_json $buf };
620 857
621 if (ref $msg) { 858 if (ref $msg) {
622 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 859 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
623 if (my %reply = $cb->[0]->($pl, $msg)) { 860 if (my %reply = $cb->($pl, $msg)) {
624 $pl->ext_reply ($msg->{msgid}, %reply); 861 $pl->ext_reply ($msg->{msgid}, %reply);
625 } 862 }
626 } 863 }
627 } else { 864 } else {
628 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 865 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
630 867
631 cf::override; 868 cf::override;
632 }, 869 },
633); 870);
634 871
635sub register {
636 my ($base, $pkg) = @_;
637
638 #TODO
639}
640
641sub load_extension { 872sub load_extension {
642 my ($path) = @_; 873 my ($path) = @_;
643 874
644 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 875 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
645 my $base = $1; 876 my $base = $1;
646 my $pkg = $1; 877 my $pkg = $1;
647 $pkg =~ s/[^[:word:]]/_/g; 878 $pkg =~ s/[^[:word:]]/_/g;
648 $pkg = "ext::$pkg"; 879 $pkg = "ext::$pkg";
649 880
650 warn "loading '$path' into '$pkg'\n"; 881 warn "... loading '$path' into '$pkg'\n";
651 882
652 open my $fh, "<:utf8", $path 883 open my $fh, "<:utf8", $path
653 or die "$path: $!"; 884 or die "$path: $!";
654 885
655 my $source = 886 my $source =
656 "package $pkg; use strict; use utf8;\n" 887 "package $pkg; use strict; use utf8;\n"
657 . "#line 1 \"$path\"\n{\n" 888 . "#line 1 \"$path\"\n{\n"
658 . (do { local $/; <$fh> }) 889 . (do { local $/; <$fh> })
659 . "\n};\n1"; 890 . "\n};\n1";
660 891
661 eval $source 892 unless (eval $source) {
662 or die $@ ? "$path: $@\n" 893 my $msg = $@ ? "$path: $@\n"
663 : "extension disabled.\n"; 894 : "extension disabled.\n";
664 895 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
665 push @exts, $pkg; 896 warn $@;
666 $ext_pkg{$base} = $pkg; 897 warn "mandatory extension failed to load, exiting.\n";
667 898 exit 1;
668# no strict 'refs'; 899 }
669# @{"$pkg\::ISA"} = ext::; 900 die $@;
670
671 register $base, $pkg;
672}
673
674sub unload_extension {
675 my ($pkg) = @_;
676
677 warn "removing extension $pkg\n";
678
679 # remove hooks
680 #TODO
681# for my $idx (0 .. $#PLUGIN_EVENT) {
682# delete $hook[$idx]{$pkg};
683# } 901 }
684 902
685 # remove commands 903 push @EXTS, $pkg;
686 for my $name (keys %COMMAND) {
687 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
688
689 if (@cb) {
690 $COMMAND{$name} = \@cb;
691 } else {
692 delete $COMMAND{$name};
693 }
694 }
695
696 # remove extcmds
697 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
698 delete $EXTCMD{$name};
699 }
700
701 if (my $cb = $pkg->can ("unload")) {
702 eval {
703 $cb->($pkg);
704 1
705 } or warn "$pkg unloaded, but with errors: $@";
706 }
707
708 Symbol::delete_package $pkg;
709} 904}
710 905
711sub load_extensions { 906sub load_extensions {
712 for my $ext (<$LIBDIR/*.ext>) { 907 for my $ext (<$LIBDIR/*.ext>) {
713 next unless -r $ext; 908 next unless -r $ext;
717 } or warn "$ext not loaded: $@"; 912 } or warn "$ext not loaded: $@";
718 } 913 }
719} 914}
720 915
721############################################################################# 916#############################################################################
722# load/save/clean perl data associated with a map
723 917
724*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 $cf::WAIT_FOR_TICK->wait;
1345 $map->reset;
1346 undef $guard;
1347 $map = find $path
1348 or return;
1349 }
1350
1351 $cf::MAP{$path} = $map
1352 }
1353}
1354
1355sub load {
1356 my ($self) = @_;
1357
1358 my $path = $self->{path};
1359 my $guard = cf::lock_acquire "map_load:$path";
1360
1361 return if $self->in_memory != cf::MAP_SWAPPED;
1362
1363 $self->in_memory (cf::MAP_LOADING);
1364
1365 $self->alloc;
1366 $self->_load_objects ($self->{load_path}, 1)
1367 or return;
1368
1369 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1370 if delete $self->{load_original};
1371
1372 if (my $uniq = $self->uniq_path) {
1373 utf8::encode $uniq;
1374 if (aio_open $uniq, O_RDONLY, 0) {
1375 $self->clear_unique_items;
1376 $self->_load_objects ($uniq, 0);
1377 }
1378 }
1379
1380 Coro::cede;
1381
1382 # now do the right thing for maps
1383 $self->link_multipart_objects;
1384
1385 unless ($self->{deny_activate}) {
1386 $self->decay_objects;
1387 $self->fix_auto_apply;
1388 $self->update_buttons;
1389 Coro::cede;
1390 $self->set_darkness_map;
1391 $self->difficulty ($self->estimate_difficulty)
1392 unless $self->difficulty;
1393 Coro::cede;
1394 $self->activate;
1395 }
1396
1397 $self->in_memory (cf::MAP_IN_MEMORY);
1398}
1399
1400sub customise_for {
1401 my ($self, $ob) = @_;
1402
1403 return find "~" . $ob->name . "/" . $self->{path}
1404 if $self->per_player;
1405
1406 $self
1407}
1408
1409# find and load all maps in the 3x3 area around a map
1410sub load_diag {
725 my ($map) = @_; 1411 my ($map) = @_;
726 1412
727 my $path = $map->tmpname; 1413 my @diag; # diagonal neighbours
728 defined $path or return;
729 1414
730 unlink "$path.pst"; 1415 for (0 .. 3) {
1416 my $neigh = $map->tile_path ($_)
1417 or next;
1418 $neigh = find $neigh, $map
1419 or next;
1420 $neigh->load;
1421
1422 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1423 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1424 }
1425
1426 for (@diag) {
1427 my $neigh = find @$_
1428 or next;
1429 $neigh->load;
1430 }
1431}
1432
1433sub find_sync {
1434 my ($path, $origin) = @_;
1435
1436 cf::sync_job { find $path, $origin }
1437}
1438
1439sub do_load_sync {
1440 my ($map) = @_;
1441
1442 cf::sync_job { $map->load };
1443}
1444
1445our %MAP_PREFETCH;
1446our $MAP_PREFETCHER = Coro::async {
1447 while () {
1448 for my $path (keys %MAP_PREFETCH) {
1449 my $map = find $path
1450 or next;
1451 $map->load;
1452
1453 delete $MAP_PREFETCH{$path};
1454 }
1455 Coro::schedule;
1456 }
731}; 1457};
732 1458
733cf::map->attach (prio => -10000, package => cf::mapsupport::); 1459sub find_async {
1460 my ($path, $origin) = @_;
734 1461
735############################################################################# 1462 $path = normalise $path, $origin && $origin->{path};
736# load/save perl data associated with player->ob objects
737 1463
738sub all_objects(@) { 1464 if (my $map = $cf::MAP{$path}) {
739 @_, map all_objects ($_->inv), @_ 1465 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
740}
741
742# TODO: compatibility cruft, remove when no longer needed
743cf::player->attach (
744 on_load => sub {
745 my ($pl, $path) = @_;
746
747 for my $o (all_objects $pl->ob) {
748 if (my $value = $o->get_ob_key_value ("_perl_data")) {
749 $o->set_ob_key_value ("_perl_data");
750
751 %$o = %{ Storable::thaw pack "H*", $value };
752 }
753 }
754 }, 1466 }
755);
756 1467
757############################################################################# 1468 $MAP_PREFETCH{$path} = 0;
1469 $MAP_PREFETCHER->ready;
758 1470
759=head2 CORE EXTENSIONS 1471 ()
1472}
760 1473
761Functions and methods that extend core crossfire objects. 1474sub save {
1475 my ($self) = @_;
762 1476
763=head3 cf::player 1477 my $lock = cf::lock_acquire "map_data:" . $self->path;
1478
1479 $self->{last_save} = $cf::RUNTIME;
1480
1481 return unless $self->dirty;
1482
1483 my $save = $self->save_path; utf8::encode $save;
1484 my $uniq = $self->uniq_path; utf8::encode $uniq;
1485
1486 $self->{load_path} = $save;
1487
1488 return if $self->{deny_save};
1489
1490 local $self->{last_access} = $self->last_access;#d#
1491
1492 cf::async {
1493 $_->contr->save for $self->players;
1494 };
1495
1496 if ($uniq) {
1497 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1498 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1499 } else {
1500 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1501 }
1502}
1503
1504sub swap_out {
1505 my ($self) = @_;
1506
1507 # save first because save cedes
1508 $self->save;
1509
1510 my $lock = cf::lock_acquire "map_data:" . $self->path;
1511
1512 return if $self->players;
1513 return if $self->in_memory != cf::MAP_IN_MEMORY;
1514 return if $self->{deny_save};
1515
1516 $self->clear;
1517 $self->in_memory (cf::MAP_SWAPPED);
1518}
1519
1520sub reset_at {
1521 my ($self) = @_;
1522
1523 # TODO: safety, remove and allow resettable per-player maps
1524 return 1e99 if $self->isa ("ext::map_per_player");#d#
1525 return 1e99 if $self->{deny_reset};
1526
1527 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1528 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1529
1530 $time + $to
1531}
1532
1533sub should_reset {
1534 my ($self) = @_;
1535
1536 $self->reset_at <= $cf::RUNTIME
1537}
1538
1539sub reset {
1540 my ($self) = @_;
1541
1542 my $lock = cf::lock_acquire "map_data:$self->{path}";
1543
1544 return if $self->players;
1545 return if $self->isa ("ext::map_per_player");#d#
1546
1547 warn "resetting map ", $self->path;#d#
1548
1549 delete $cf::MAP{$self->path};
1550
1551 $self->in_memory (cf::MAP_SWAPPED);
1552 $self->clear;
1553
1554 $_->clear_links_to ($self) for values %cf::MAP;
1555
1556 $self->unlink_save;
1557 $self->destroy;
1558}
1559
1560my $nuke_counter = "aaaa";
1561
1562sub nuke {
1563 my ($self) = @_;
1564
1565 delete $cf::MAP{$self->path};
1566
1567 $self->unlink_save;
1568
1569 bless $self, "cf::map";
1570 delete $self->{deny_reset};
1571 $self->{deny_save} = 1;
1572 $self->reset_timeout (1);
1573 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1574
1575 $cf::MAP{$self->path} = $self;
1576
1577 $self->reset; # polite request, might not happen
1578}
1579
1580=item cf::map::unique_maps
1581
1582Returns an arrayref of paths of all shared maps that have
1583instantiated unique items. May block.
1584
1585=cut
1586
1587sub unique_maps() {
1588 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1589 or return;
1590
1591 my @paths;
1592
1593 for (@$files) {
1594 utf8::decode $_;
1595 next if /\.pst$/;
1596 next unless /^$PATH_SEP/o;
1597
1598 s/\.map$//;
1599 push @paths, $_;
1600 }
1601
1602 \@paths
1603}
1604
1605package cf;
1606
1607=back
1608
1609=head3 cf::object
1610
1611=cut
1612
1613package cf::object;
764 1614
765=over 4 1615=over 4
766 1616
767=item cf::player::exists $login 1617=item $ob->inv_recursive
768 1618
769Returns true when the given account exists. 1619Returns the inventory of the object _and_ their inventories, recursively.
770 1620
771=cut 1621=cut
772 1622
773sub cf::player::exists($) { 1623sub inv_recursive_;
774 cf::player::find $_[0] 1624sub inv_recursive_ {
775 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1625 map { $_, inv_recursive_ $_->inv } @_
776} 1626}
777 1627
778=item $player->ext_reply ($msgid, $msgtype, %msg) 1628sub inv_recursive {
779 1629 inv_recursive_ inv $_[0]
780Sends an ext reply to the player.
781
782=cut
783
784sub cf::player::ext_reply($$$%) {
785 my ($self, $id, %msg) = @_;
786
787 $msg{msgid} = $id;
788
789 $self->send ("ext " . to_json \%msg);
790} 1630}
1631
1632package cf;
791 1633
792=back 1634=back
793 1635
794=head3 cf::object::player 1636=head3 cf::object::player
795 1637
833 (ref $cf::CFG{"may_$access"} 1675 (ref $cf::CFG{"may_$access"}
834 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1676 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
835 : $cf::CFG{"may_$access"}) 1677 : $cf::CFG{"may_$access"})
836} 1678}
837 1679
1680=item $player_object->enter_link
1681
1682Freezes the player and moves him/her to a special map (C<{link}>).
1683
1684The player should be reasonably safe there for short amounts of time. You
1685I<MUST> call C<leave_link> as soon as possible, though.
1686
1687Will never block.
1688
1689=item $player_object->leave_link ($map, $x, $y)
1690
1691Moves the player out of the special C<{link}> map onto the specified
1692map. If the map is not valid (or omitted), the player will be moved back
1693to the location he/she was before the call to C<enter_link>, or, if that
1694fails, to the emergency map position.
1695
1696Might block.
1697
1698=cut
1699
1700sub link_map {
1701 unless ($LINK_MAP) {
1702 $LINK_MAP = cf::map::find "{link}"
1703 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1704 $LINK_MAP->load;
1705 }
1706
1707 $LINK_MAP
1708}
1709
1710sub cf::object::player::enter_link {
1711 my ($self) = @_;
1712
1713 $self->deactivate_recursive;
1714
1715 return if UNIVERSAL::isa $self->map, "ext::map_link";
1716
1717 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1718 if $self->map;
1719
1720 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1721}
1722
1723sub cf::object::player::leave_link {
1724 my ($self, $map, $x, $y) = @_;
1725
1726 my $link_pos = delete $self->{_link_pos};
1727
1728 unless ($map) {
1729 # restore original map position
1730 ($map, $x, $y) = @{ $link_pos || [] };
1731 $map = cf::map::find $map;
1732
1733 unless ($map) {
1734 ($map, $x, $y) = @$EMERGENCY_POSITION;
1735 $map = cf::map::find $map
1736 or die "FATAL: cannot load emergency map\n";
1737 }
1738 }
1739
1740 ($x, $y) = (-1, -1)
1741 unless (defined $x) && (defined $y);
1742
1743 # use -1 or undef as default coordinates, not 0, 0
1744 ($x, $y) = ($map->enter_x, $map->enter_y)
1745 if $x <=0 && $y <= 0;
1746
1747 $map->load;
1748 $map->load_diag;
1749
1750 return unless $self->contr->active;
1751 $self->activate_recursive;
1752 $self->enter_map ($map, $x, $y);
1753}
1754
1755cf::player->attach (
1756 on_logout => sub {
1757 my ($pl) = @_;
1758
1759 # abort map switching before logout
1760 if ($pl->ob->{_link_pos}) {
1761 cf::sync_job {
1762 $pl->ob->leave_link
1763 };
1764 }
1765 },
1766 on_login => sub {
1767 my ($pl) = @_;
1768
1769 # try to abort aborted map switching on player login :)
1770 # should happen only on crashes
1771 if ($pl->ob->{_link_pos}) {
1772 $pl->ob->enter_link;
1773 (async {
1774 # we need this sleep as the login has a concurrent enter_exit running
1775 # and this sleep increases chances of the player not ending up in scorn
1776 $pl->ob->reply (undef,
1777 "There was an internal problem at your last logout, "
1778 . "the server will try to bring you to your intended destination in a second.",
1779 cf::NDI_RED);
1780 Coro::Timer::sleep 1;
1781 $pl->ob->leave_link;
1782 })->prio (2);
1783 }
1784 },
1785);
1786
1787=item $player_object->goto ($path, $x, $y)
1788
1789=cut
1790
1791sub cf::object::player::goto {
1792 my ($self, $path, $x, $y) = @_;
1793
1794 $self->enter_link;
1795
1796 (async {
1797 my $map = cf::map::find $path;
1798 $map = $map->customise_for ($self) if $map;
1799
1800# warn "entering ", $map->path, " at ($x, $y)\n"
1801# if $map;
1802
1803 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1804
1805 $self->leave_link ($map, $x, $y);
1806 })->prio (1);
1807}
1808
1809=item $player_object->enter_exit ($exit_object)
1810
1811=cut
1812
1813sub parse_random_map_params {
1814 my ($spec) = @_;
1815
1816 my $rmp = { # defaults
1817 xsize => -1,
1818 ysize => -1,
1819 };
1820
1821 for (split /\n/, $spec) {
1822 my ($k, $v) = split /\s+/, $_, 2;
1823
1824 $rmp->{lc $k} = $v if (length $k) && (length $v);
1825 }
1826
1827 $rmp
1828}
1829
1830sub prepare_random_map {
1831 my ($exit) = @_;
1832
1833 my $guard = cf::lock_acquire "exit_prepare:$exit";
1834
1835 # all this does is basically replace the /! path by
1836 # a new random map path (?random/...) with a seed
1837 # that depends on the exit object
1838
1839 my $rmp = parse_random_map_params $exit->msg;
1840
1841 if ($exit->map) {
1842 $rmp->{region} = $exit->map->region_name;
1843 $rmp->{origin_map} = $exit->map->path;
1844 $rmp->{origin_x} = $exit->x;
1845 $rmp->{origin_y} = $exit->y;
1846 }
1847
1848 $rmp->{random_seed} ||= $exit->random_seed;
1849
1850 my $data = cf::to_json $rmp;
1851 my $md5 = Digest::MD5::md5_hex $data;
1852 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1853
1854 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1855 aio_write $fh, 0, (length $data), $data, 0;
1856 undef $fh;
1857 aio_rename "$meta~", $meta;
1858
1859 $exit->slaying ("?random/$md5");
1860 $exit->msg (undef);
1861 }
1862}
1863
1864sub cf::object::player::enter_exit {
1865 my ($self, $exit) = @_;
1866
1867 return unless $self->type == cf::PLAYER;
1868
1869 $self->enter_link;
1870
1871 (async {
1872 $self->deactivate_recursive; # just to be sure
1873 unless (eval {
1874 prepare_random_map $exit
1875 if $exit->slaying eq "/!";
1876
1877 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1878 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1879
1880 1;
1881 }) {
1882 $self->message ("Something went wrong deep within the crossfire server. "
1883 . "I'll try to bring you back to the map you were before. "
1884 . "Please report this to the dungeon master!",
1885 cf::NDI_UNIQUE | cf::NDI_RED);
1886
1887 warn "ERROR in enter_exit: $@";
1888 $self->leave_link;
1889 }
1890 })->prio (1);
1891}
1892
838=head3 cf::client 1893=head3 cf::client
839 1894
840=over 4 1895=over 4
841 1896
842=item $client->send_drawinfo ($text, $flags) 1897=item $client->send_drawinfo ($text, $flags)
885 on_reply => sub { 1940 on_reply => sub {
886 my ($ns, $msg) = @_; 1941 my ($ns, $msg) = @_;
887 1942
888 # this weird shuffling is so that direct followup queries 1943 # this weird shuffling is so that direct followup queries
889 # get handled first 1944 # get handled first
890 my $queue = delete $ns->{query_queue}; 1945 my $queue = delete $ns->{query_queue}
1946 or return; # be conservative, not sure how that can happen, but we saw a crash here
891 1947
892 (shift @$queue)->[1]->($msg); 1948 (shift @$queue)->[1]->($msg);
893 1949
894 push @{ $ns->{query_queue} }, @$queue; 1950 push @{ $ns->{query_queue} }, @$queue;
895 1951
896 if (@{ $ns->{query_queue} } == @$queue) { 1952 if (@{ $ns->{query_queue} } == @$queue) {
897 if (@$queue) { 1953 if (@$queue) {
898 $ns->send_packet ($ns->{query_queue}[0][0]); 1954 $ns->send_packet ($ns->{query_queue}[0][0]);
899 } else { 1955 } else {
900 $ns->state (ST_PLAYING); 1956 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
901 } 1957 }
902 } 1958 }
1959 },
1960);
1961
1962=item $client->async (\&cb)
1963
1964Create a new coroutine, running the specified callback. The coroutine will
1965be automatically cancelled when the client gets destroyed (e.g. on logout,
1966or loss of connection).
1967
1968=cut
1969
1970sub cf::client::async {
1971 my ($self, $cb) = @_;
1972
1973 my $coro = &Coro::async ($cb);
1974
1975 $coro->on_destroy (sub {
1976 delete $self->{_coro}{$coro+0};
1977 });
1978
1979 $self->{_coro}{$coro+0} = $coro;
1980
1981 $coro
1982}
1983
1984cf::client->attach (
1985 on_destroy => sub {
1986 my ($ns) = @_;
1987
1988 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
903 }, 1989 },
904); 1990);
905 1991
906=back 1992=back
907 1993
1064 2150
1065{ 2151{
1066 my $path = cf::localdir . "/database.pst"; 2152 my $path = cf::localdir . "/database.pst";
1067 2153
1068 sub db_load() { 2154 sub db_load() {
1069 warn "loading database $path\n";#d# remove later
1070 $DB = stat $path ? Storable::retrieve $path : { }; 2155 $DB = stat $path ? Storable::retrieve $path : { };
1071 } 2156 }
1072 2157
1073 my $pid; 2158 my $pid;
1074 2159
1075 sub db_save() { 2160 sub db_save() {
1076 warn "saving database $path\n";#d# remove later
1077 waitpid $pid, 0 if $pid; 2161 waitpid $pid, 0 if $pid;
1078 if (0 == ($pid = fork)) { 2162 if (0 == ($pid = fork)) {
1079 $DB->{_meta}{version} = 1; 2163 $DB->{_meta}{version} = 1;
1080 Storable::nstore $DB, "$path~"; 2164 Storable::nstore $DB, "$path~";
1081 rename "$path~", $path; 2165 rename "$path~", $path;
1129 open my $fh, "<:utf8", cf::confdir . "/config" 2213 open my $fh, "<:utf8", cf::confdir . "/config"
1130 or return; 2214 or return;
1131 2215
1132 local $/; 2216 local $/;
1133 *CFG = YAML::Syck::Load <$fh>; 2217 *CFG = YAML::Syck::Load <$fh>;
2218
2219 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2220
2221 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2222 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2223
2224 if (exists $CFG{mlockall}) {
2225 eval {
2226 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2227 and die "WARNING: m(un)lockall failed: $!\n";
2228 };
2229 warn $@ if $@;
2230 }
1134} 2231}
1135 2232
1136sub main { 2233sub main {
2234 # we must not ever block the main coroutine
2235 local $Coro::idle = sub {
2236 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2237 (async {
2238 Event::one_event;
2239 })->prio (Coro::PRIO_MAX);
2240 };
2241
1137 cfg_load; 2242 cfg_load;
1138 db_load; 2243 db_load;
1139 load_extensions; 2244 load_extensions;
1140 Event::loop; 2245 Event::loop;
1141} 2246}
1142 2247
1143############################################################################# 2248#############################################################################
1144# initialisation 2249# initialisation and cleanup
1145 2250
2251# install some emergency cleanup handlers
2252BEGIN {
2253 for my $signal (qw(INT HUP TERM)) {
2254 Event->signal (
2255 data => WF_AUTOCANCEL,
2256 signal => $signal,
2257 cb => sub {
2258 cf::cleanup "SIG$signal";
2259 },
2260 );
2261 }
2262}
2263
2264sub emergency_save() {
2265 my $freeze_guard = cf::freeze_mainloop;
2266
2267 warn "enter emergency perl save\n";
2268
2269 cf::sync_job {
2270 # use a peculiar iteration method to avoid tripping on perl
2271 # refcount bugs in for. also avoids problems with players
2272 # and maps saved/destroyed asynchronously.
2273 warn "begin emergency player save\n";
2274 for my $login (keys %cf::PLAYER) {
2275 my $pl = $cf::PLAYER{$login} or next;
2276 $pl->valid or next;
2277 $pl->save;
2278 }
2279 warn "end emergency player save\n";
2280
2281 warn "begin emergency map save\n";
2282 for my $path (keys %cf::MAP) {
2283 my $map = $cf::MAP{$path} or next;
2284 $map->valid or next;
2285 $map->save;
2286 }
2287 warn "end emergency map save\n";
2288 };
2289
2290 warn "leave emergency perl save\n";
2291}
2292
1146sub _perl_reload(&) { 2293sub reload() {
1147 my ($msg) = @_; 2294 # can/must only be called in main
2295 if ($Coro::current != $Coro::main) {
2296 warn "can only reload from main coroutine\n";
2297 return;
2298 }
1148 2299
1149 $msg->("reloading..."); 2300 warn "reloading...";
2301
2302 warn "freezing server";
2303 my $guard = freeze_mainloop;
2304 cf::emergency_save;
2305
2306 warn "sync database to disk";
2307 cf::db_sync;
2308 IO::AIO::flush;
1150 2309
1151 eval { 2310 eval {
2311 # if anything goes wrong in here, we should simply crash as we already saved
2312
1152 # cancel all watchers 2313 warn "cancel all watchers";
1153 for (Event::all_watchers) { 2314 for (Event::all_watchers) {
1154 $_->cancel if $_->data & WF_AUTOCANCEL; 2315 $_->cancel if $_->data & WF_AUTOCANCEL;
1155 } 2316 }
1156 2317
2318 warn "cancel all extension coros";
2319 $_->cancel for values %EXT_CORO;
2320 %EXT_CORO = ();
2321
2322 warn "remove commands";
2323 %COMMAND = ();
2324
2325 warn "remove ext commands";
2326 %EXTCMD = ();
2327
1157 # unload all extensions 2328 warn "unload/nuke all extensions";
1158 for (@exts) { 2329 for my $pkg (@EXTS) {
1159 $msg->("unloading <$_>"); 2330 warn "... unloading $pkg";
1160 unload_extension $_; 2331
2332 if (my $cb = $pkg->can ("unload")) {
2333 eval {
2334 $cb->($pkg);
2335 1
2336 } or warn "$pkg unloaded, but with errors: $@";
1161 } 2337 }
1162 2338
2339 warn "... nuking $pkg";
2340 Symbol::delete_package $pkg;
2341 }
2342
1163 # unload all modules loaded from $LIBDIR 2343 warn "unload all perl modules loaded from $LIBDIR";
1164 while (my ($k, $v) = each %INC) { 2344 while (my ($k, $v) = each %INC) {
1165 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2345 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1166 2346
1167 $msg->("removing <$k>"); 2347 warn "removing <$k>";
1168 delete $INC{$k}; 2348 delete $INC{$k};
1169 2349
1170 $k =~ s/\.pm$//; 2350 $k =~ s/\.pm$//;
1171 $k =~ s/\//::/g; 2351 $k =~ s/\//::/g;
1172 2352
1175 } 2355 }
1176 2356
1177 Symbol::delete_package $k; 2357 Symbol::delete_package $k;
1178 } 2358 }
1179 2359
1180 # sync database to disk
1181 cf::db_sync;
1182
1183 # get rid of safe::, as good as possible 2360 warn "get rid of safe::, as good as possible";
1184 Symbol::delete_package "safe::$_" 2361 Symbol::delete_package "safe::$_"
1185 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2362 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1186 2363
1187 # remove register_script_function callbacks
1188 # TODO
1189
1190 # unload cf.pm "a bit" 2364 warn "unload cf.pm \"a bit\"";
1191 delete $INC{"cf.pm"}; 2365 delete $INC{"cf.pm"};
1192 2366
1193 # don't, removes xs symbols, too, 2367 # don't, removes xs symbols, too,
1194 # and global variables created in xs 2368 # and global variables created in xs
1195 #Symbol::delete_package __PACKAGE__; 2369 #Symbol::delete_package __PACKAGE__;
1196 2370
1197 # reload cf.pm
1198 $msg->("reloading cf.pm"); 2371 warn "reloading cf.pm";
1199 require cf; 2372 require cf;
2373 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1200 2374
1201 # load config and database again 2375 warn "load config and database again";
1202 cf::cfg_load; 2376 cf::cfg_load;
1203 cf::db_load; 2377 cf::db_load;
1204 2378
1205 # load extensions 2379 warn "load extensions";
1206 $msg->("load extensions");
1207 cf::load_extensions; 2380 cf::load_extensions;
1208 2381
1209 # reattach attachments to objects 2382 warn "reattach attachments to objects/players";
1210 $msg->("reattach");
1211 _global_reattach; 2383 _global_reattach;
2384 warn "reattach attachments to maps";
2385 reattach $_ for values %MAP;
1212 }; 2386 };
1213 $msg->($@) if $@;
1214 2387
1215 $msg->("reloaded"); 2388 if ($@) {
2389 warn $@;
2390 warn "error while reloading, exiting.";
2391 exit 1;
2392 }
2393
2394 warn "reloaded";
1216}; 2395};
1217 2396
1218sub perl_reload() { 2397our $RELOAD_WATCHER; # used only during reload
1219 _perl_reload {
1220 warn $_[0];
1221 print "$_[0]\n";
1222 };
1223}
1224 2398
1225register "<global>", __PACKAGE__;
1226
1227register_command "perl-reload" => sub { 2399register_command "reload" => sub {
1228 my ($who, $arg) = @_; 2400 my ($who, $arg) = @_;
1229 2401
1230 if ($who->flag (FLAG_WIZ)) { 2402 if ($who->flag (FLAG_WIZ)) {
1231 _perl_reload { 2403 $who->message ("reloading server.");
1232 warn $_[0]; 2404
1233 $who->message ($_[0]); 2405 # doing reload synchronously and two reloads happen back-to-back,
2406 # coro crashes during coro_state_free->destroy here.
2407
2408 $RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2409 reload;
2410 undef $RELOAD_WATCHER;
1234 }; 2411 });
1235 } 2412 }
1236}; 2413};
1237 2414
1238unshift @INC, $LIBDIR; 2415unshift @INC, $LIBDIR;
1239 2416
1240$TICK_WATCHER = Event->timer ( 2417$TICK_WATCHER = Event->timer (
2418 reentrant => 0,
1241 prio => 0, 2419 prio => 0,
1242 at => $NEXT_TICK || 1, 2420 at => $NEXT_TICK || $TICK,
1243 data => WF_AUTOCANCEL, 2421 data => WF_AUTOCANCEL,
1244 cb => sub { 2422 cb => sub {
2423 $NOW = Event::time;
2424
1245 cf::server_tick; # one server iteration 2425 cf::server_tick; # one server iteration
1246 2426 $RUNTIME += $TICK;
1247 my $NOW = Event::time;
1248 $NEXT_TICK += $TICK; 2427 $NEXT_TICK += $TICK;
1249 2428
2429 $WAIT_FOR_TICK->broadcast;
2430 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2431
1250 # if we are delayed by four ticks or more, skip them all 2432 # if we are delayed by four ticks or more, skip them all
1251 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2433 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1252 2434
1253 $TICK_WATCHER->at ($NEXT_TICK); 2435 $TICK_WATCHER->at ($NEXT_TICK);
1254 $TICK_WATCHER->start; 2436 $TICK_WATCHER->start;
1255 }, 2437 },
1256); 2438);
1257 2439
1258IO::AIO::max_poll_time $TICK * 0.2; 2440IO::AIO::max_poll_time $TICK * 0.2;
1259 2441
2442$AIO_POLL_WATCHER = Event->io (
1260Event->io (fd => IO::AIO::poll_fileno, 2443 fd => IO::AIO::poll_fileno,
1261 poll => 'r', 2444 poll => 'r',
1262 prio => 5, 2445 prio => 5,
1263 data => WF_AUTOCANCEL, 2446 data => WF_AUTOCANCEL,
1264 cb => \&IO::AIO::poll_cb); 2447 cb => \&IO::AIO::poll_cb,
2448);
2449
2450$WRITE_RUNTIME_WATCHER = Event->timer (
2451 data => WF_AUTOCANCEL,
2452 after => 0,
2453 interval => 10,
2454 cb => sub {
2455 (Coro::unblock_sub {
2456 write_runtime
2457 or warn "ERROR: unable to write runtime file: $!";
2458 })->();
2459 },
2460);
2461
2462END { cf::emergency_save }
1265 2463
12661 24641
1267 2465

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines