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.169 by root, Sun Jan 14 01:09:46 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Storable;
6use Opcode; 9use Opcode;
7use Safe; 10use Safe;
8use Safe::Hole; 11use Safe::Hole;
9 12
13use Coro 3.3 ();
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;
265 507
266sub _attach_cb($$$$) { 508sub _attach_cb($$$$) {
267 my ($registry, $event, $prio, $cb) = @_; 509 my ($registry, $event, $prio, $cb) = @_;
272 514
273 @{$registry->[$event]} = sort 515 @{$registry->[$event]} = sort
274 { $a->[0] cmp $b->[0] } 516 { $a->[0] cmp $b->[0] }
275 @{$registry->[$event] || []}, $cb; 517 @{$registry->[$event] || []}, $cb;
276} 518}
519
520# hack
521my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
277 522
278# attach handles attaching event callbacks 523# attach handles attaching event callbacks
279# the only thing the caller has to do is pass the correct 524# the only thing the caller has to do is pass the correct
280# registry (== where the callback attaches to). 525# registry (== where the callback attaches to).
281sub _attach { 526sub _attach {
283 528
284 my $object_type; 529 my $object_type;
285 my $prio = 0; 530 my $prio = 0;
286 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 531 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
287 532
533 #TODO: get rid of this hack
534 if ($attachable_klass{$klass}) {
535 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
536 }
537
288 while (@arg) { 538 while (@arg) {
289 my $type = shift @arg; 539 my $type = shift @arg;
290 540
291 if ($type eq "prio") { 541 if ($type eq "prio") {
292 $prio = shift @arg; 542 $prio = shift @arg;
367 my ($obj, $name) = @_; 617 my ($obj, $name) = @_;
368 618
369 exists $obj->{_attachment}{$name} 619 exists $obj->{_attachment}{$name}
370} 620}
371 621
372for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 622for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
373 eval "#line " . __LINE__ . " 'cf.pm' 623 eval "#line " . __LINE__ . " 'cf.pm'
374 sub cf::\L$klass\E::_attach_registry { 624 sub cf::\L$klass\E::_attach_registry {
375 (\\\@CB_$klass, KLASS_$klass) 625 (\\\@CB_$klass, KLASS_$klass)
376 } 626 }
377 627
413 } 663 }
414 664
415 0 665 0
416} 666}
417 667
418=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 668=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
419 669
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, ...) 670=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
425 671
426=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428Generate a global/object/player/map-specific event with the given arguments. 672Generate an object-specific event with the given arguments.
429 673
430This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be 674This 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 675removed in future versions), and there is no public API to access override
432results (if you must, access C<@cf::invoke_results> directly). 676results (if you must, access C<@cf::invoke_results> directly).
433 677
434=back 678=back
435 679
436=cut 680=cut
437 681
438############################################################################# 682#############################################################################
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 683# object support
460 684
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 { 685sub reattach {
686 # basically do the same as instantiate, without calling instantiate
475 my ($obj) = @_; 687 my ($obj) = @_;
688
689 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
690
476 my $registry = $obj->registry; 691 my $registry = $obj->registry;
477 692
478 @$registry = (); 693 @$registry = ();
479 694
480 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 695 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
489 warn "object uses attachment '$name' that is not available, postponing.\n"; 704 warn "object uses attachment '$name' that is not available, postponing.\n";
490 } 705 }
491 } 706 }
492} 707}
493 708
494sub object_freezer_save { 709cf::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, 710 prio => -1000000,
711 on_instantiate => sub {
712 my ($obj, $data) = @_;
713
714 $data = from_json $data;
715
716 for (@$data) {
717 my ($name, $args) = @$_;
718
719 $obj->attach ($name, %{$args || {} });
720 }
721 },
722 on_reattach => \&reattach,
554 on_clone => sub { 723 on_clone => sub {
555 my ($src, $dst) = @_; 724 my ($src, $dst) = @_;
556 725
557 @{$dst->registry} = @{$src->registry}; 726 @{$dst->registry} = @{$src->registry};
558 727
561 %{$dst->{_attachment}} = %{$src->{_attachment}} 730 %{$dst->{_attachment}} = %{$src->{_attachment}}
562 if exists $src->{_attachment}; 731 if exists $src->{_attachment};
563 }, 732 },
564); 733);
565 734
735sub object_freezer_save {
736 my ($filename, $rdata, $objs) = @_;
737
738 sync_job {
739 if (length $$rdata) {
740 warn sprintf "saving %s (%d,%d)\n",
741 $filename, length $$rdata, scalar @$objs;
742
743 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
744 chmod SAVE_MODE, $fh;
745 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
746 aio_fsync $fh;
747 close $fh;
748
749 if (@$objs) {
750 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
751 chmod SAVE_MODE, $fh;
752 my $data = Storable::nfreeze { version => 1, objs => $objs };
753 aio_write $fh, 0, (length $data), $data, 0;
754 aio_fsync $fh;
755 close $fh;
756 aio_rename "$filename.pst~", "$filename.pst";
757 }
758 } else {
759 aio_unlink "$filename.pst";
760 }
761
762 aio_rename "$filename~", $filename;
763 } else {
764 warn "FATAL: $filename~: $!\n";
765 }
766 } else {
767 aio_unlink $filename;
768 aio_unlink "$filename.pst";
769 }
770 }
771}
772
773sub object_freezer_as_string {
774 my ($rdata, $objs) = @_;
775
776 use Data::Dumper;
777
778 $$rdata . Dumper $objs
779}
780
781sub object_thawer_load {
782 my ($filename) = @_;
783
784 my ($data, $av);
785
786 (aio_load $filename, $data) >= 0
787 or return;
788
789 unless (aio_stat "$filename.pst") {
790 (aio_load "$filename.pst", $av) >= 0
791 or return;
792 $av = eval { (Storable::thaw $av)->{objs} };
793 }
794
795 warn sprintf "loading %s (%d)\n",
796 $filename, length $data, scalar @{$av || []};#d#
797 return ($data, $av);
798}
799
566############################################################################# 800#############################################################################
567# command handling &c 801# command handling &c
568 802
569=item cf::register_command $name => \&callback($ob,$args); 803=item cf::register_command $name => \&callback($ob,$args);
570 804
592=cut 826=cut
593 827
594sub register_extcmd { 828sub register_extcmd {
595 my ($name, $cb) = @_; 829 my ($name, $cb) = @_;
596 830
597 my $caller = caller;
598 #warn "registering extcmd '$name' to '$caller'";
599
600 $EXTCMD{$name} = [$cb, $caller]; 831 $EXTCMD{$name} = $cb;
601} 832}
602 833
603cf::player->attach ( 834cf::player->attach (
604 on_command => sub { 835 on_command => sub {
605 my ($pl, $name, $params) = @_; 836 my ($pl, $name, $params) = @_;
618 849
619 my $msg = eval { from_json $buf }; 850 my $msg = eval { from_json $buf };
620 851
621 if (ref $msg) { 852 if (ref $msg) {
622 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 853 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
623 if (my %reply = $cb->[0]->($pl, $msg)) { 854 if (my %reply = $cb->($pl, $msg)) {
624 $pl->ext_reply ($msg->{msgid}, %reply); 855 $pl->ext_reply ($msg->{msgid}, %reply);
625 } 856 }
626 } 857 }
627 } else { 858 } else {
628 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 859 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
630 861
631 cf::override; 862 cf::override;
632 }, 863 },
633); 864);
634 865
635sub register {
636 my ($base, $pkg) = @_;
637
638 #TODO
639}
640
641sub load_extension { 866sub load_extension {
642 my ($path) = @_; 867 my ($path) = @_;
643 868
644 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 869 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
645 my $base = $1; 870 my $base = $1;
646 my $pkg = $1; 871 my $pkg = $1;
647 $pkg =~ s/[^[:word:]]/_/g; 872 $pkg =~ s/[^[:word:]]/_/g;
648 $pkg = "ext::$pkg"; 873 $pkg = "ext::$pkg";
649 874
650 warn "loading '$path' into '$pkg'\n"; 875 warn "... loading '$path' into '$pkg'\n";
651 876
652 open my $fh, "<:utf8", $path 877 open my $fh, "<:utf8", $path
653 or die "$path: $!"; 878 or die "$path: $!";
654 879
655 my $source = 880 my $source =
656 "package $pkg; use strict; use utf8;\n" 881 "package $pkg; use strict; use utf8;\n"
657 . "#line 1 \"$path\"\n{\n" 882 . "#line 1 \"$path\"\n{\n"
658 . (do { local $/; <$fh> }) 883 . (do { local $/; <$fh> })
659 . "\n};\n1"; 884 . "\n};\n1";
660 885
661 eval $source 886 unless (eval $source) {
662 or die $@ ? "$path: $@\n" 887 my $msg = $@ ? "$path: $@\n"
663 : "extension disabled.\n"; 888 : "extension disabled.\n";
664 889 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
665 push @exts, $pkg; 890 warn $@;
666 $ext_pkg{$base} = $pkg; 891 warn "mandatory extension failed to load, exiting.\n";
667 892 exit 1;
668# no strict 'refs'; 893 }
669# @{"$pkg\::ISA"} = ext::; 894 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# } 895 }
684 896
685 # remove commands 897 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} 898}
710 899
711sub load_extensions { 900sub load_extensions {
712 for my $ext (<$LIBDIR/*.ext>) { 901 for my $ext (<$LIBDIR/*.ext>) {
713 next unless -r $ext; 902 next unless -r $ext;
717 } or warn "$ext not loaded: $@"; 906 } or warn "$ext not loaded: $@";
718 } 907 }
719} 908}
720 909
721############################################################################# 910#############################################################################
722# load/save/clean perl data associated with a map
723 911
724*cf::mapsupport::on_clean = sub { 912=head2 CORE EXTENSIONS
913
914Functions and methods that extend core crossfire objects.
915
916=cut
917
918package cf::player;
919
920use Coro::AIO;
921
922=head3 cf::player
923
924=over 4
925
926=item cf::player::find $login
927
928Returns the given player object, loading it if necessary (might block).
929
930=cut
931
932sub playerdir($) {
933 cf::localdir
934 . "/"
935 . cf::playerdir
936 . "/"
937 . (ref $_[0] ? $_[0]->ob->name : $_[0])
938}
939
940sub path($) {
941 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
942
943 (playerdir $login) . "/$login.pl"
944}
945
946sub find_active($) {
947 $cf::PLAYER{$_[0]}
948 and $cf::PLAYER{$_[0]}->active
949 and $cf::PLAYER{$_[0]}
950}
951
952sub exists($) {
953 my ($login) = @_;
954
955 $cf::PLAYER{$login}
956 or cf::sync_job { !aio_stat $login }
957}
958
959sub find($) {
960 return $cf::PLAYER{$_[0]} || do {
961 my $login = $_[0];
962
963 my $guard = cf::lock_acquire "user_find:$login";
964
965 $cf::PLAYER{$_[0]} || do {
966 my $pl = load_pl path $login
967 or return;
968 $cf::PLAYER{$login} = $pl
969 }
970 }
971}
972
973sub save($) {
974 my ($pl) = @_;
975
976 return if $pl->{deny_save};
977
978 my $path = path $pl;
979 my $guard = cf::lock_acquire "user_save:$path";
980
981 return if $pl->{deny_save};
982
983 aio_mkdir playerdir $pl, 0770;
984 $pl->{last_save} = $cf::RUNTIME;
985
986 $pl->save_pl ($path);
987 Coro::cede;
988}
989
990sub new($) {
991 my ($login) = @_;
992
993 my $self = create;
994
995 $self->ob->name ($login);
996 $self->{deny_save} = 1;
997
998 $cf::PLAYER{$login} = $self;
999
1000 $self
1001}
1002
1003=item $pl->quit_character
1004
1005Nukes the player without looking back. If logged in, the connection will
1006be destroyed. May block for a long time.
1007
1008=cut
1009
1010sub quit_character {
1011 my ($pl) = @_;
1012
1013 $pl->{deny_save} = 1;
1014 $pl->password ("*"); # this should lock out the player until we nuked the dir
1015
1016 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1017 $pl->deactivate;
1018 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1019 $pl->ns->destroy if $pl->ns;
1020
1021 my $path = playerdir $pl;
1022 my $temp = "$path~$cf::RUNTIME~deleting~";
1023 aio_rename $path, $temp;
1024 delete $cf::PLAYER{$pl->ob->name};
1025 $pl->destroy;
1026 IO::AIO::aio_rmtree $temp;
1027}
1028
1029=item cf::player::list_logins
1030
1031Returns am arrayref of all valid playernames in the system, can take a
1032while and may block, so not sync_job-capable, ever.
1033
1034=cut
1035
1036sub list_logins {
1037 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1038 or return [];
1039
1040 my @logins;
1041
1042 for my $login (@$dirs) {
1043 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1044 aio_read $fh, 0, 512, my $buf, 0 or next;
1045 $buf !~ /^password -------------$/m or next; # official not-valid tag
1046
1047 utf8::decode $login;
1048 push @logins, $login;
1049 }
1050
1051 \@logins
1052}
1053
1054=item $player->maps
1055
1056Returns an arrayref of map paths that are private for this
1057player. May block.
1058
1059=cut
1060
1061sub maps($) {
1062 my ($pl) = @_;
1063
1064 my $files = aio_readdir playerdir $pl
1065 or return;
1066
1067 my @paths;
1068
1069 for (@$files) {
1070 utf8::decode $_;
1071 next if /\.(?:pl|pst)$/;
1072 next unless /^$PATH_SEP/o;
1073
1074 s/\.map$//;
1075 push @paths, "~" . $pl->ob->name . "/" . $_;
1076 }
1077
1078 \@paths
1079}
1080
1081=item $player->ext_reply ($msgid, $msgtype, %msg)
1082
1083Sends an ext reply to the player.
1084
1085=cut
1086
1087sub ext_reply($$$%) {
1088 my ($self, $id, %msg) = @_;
1089
1090 $msg{msgid} = $id;
1091
1092 $self->send ("ext " . cf::to_json \%msg);
1093}
1094
1095package cf;
1096
1097=back
1098
1099
1100=head3 cf::map
1101
1102=over 4
1103
1104=cut
1105
1106package cf::map;
1107
1108use Fcntl;
1109use Coro::AIO;
1110
1111use overload
1112 '""' => \&as_string;
1113
1114our $MAX_RESET = 3600;
1115our $DEFAULT_RESET = 3000;
1116
1117sub generate_random_map {
1118 my ($self, $rmp) = @_;
1119
1120 # mit "rum" bekleckern, nicht
1121 $self->_create_random_map (
1122 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1123 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1124 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1125 $rmp->{exit_on_final_map},
1126 $rmp->{xsize}, $rmp->{ysize},
1127 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1128 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1129 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1130 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1131 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1132 (cf::region::find $rmp->{region}), $rmp->{custom}
1133 )
1134}
1135
1136sub register {
1137 my (undef, $regex) = @_;
1138 my $pkg = caller;
1139
1140 no strict;
1141 push @{"$pkg\::ISA"}, __PACKAGE__;
1142
1143 $EXT_MAP{$pkg} = qr<$regex>;
1144}
1145
1146# also paths starting with '/'
1147$EXT_MAP{"cf::map"} = qr{^(?=/)};
1148
1149sub normalise {
1150 my ($path, $base) = @_;
1151
1152 # map plan:
1153 #
1154 # /! non-realised random map exit (special hack!)
1155 # {... are special paths that are not being touched
1156 # ?xxx/... are special absolute paths
1157 # ?random/... random maps
1158 # /... normal maps
1159 # ~user/... per-player map of a specific user
1160
1161 $path =~ s/$PATH_SEP/\//go;
1162
1163 # treat it as relative path if it starts with
1164 # something that looks reasonable
1165 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1166 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1167
1168 $base =~ s{[^/]+/?$}{};
1169 $path = "$base/$path";
1170 }
1171
1172 for ($path) {
1173 redo if s{//}{/};
1174 redo if s{/\.?/}{/};
1175 redo if s{/[^/]+/\.\./}{/};
1176 }
1177
1178 $path
1179}
1180
1181sub new_from_path {
1182 my (undef, $path, $base) = @_;
1183
1184 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1185
1186 $path = normalise $path, $base;
1187
1188 for my $pkg (keys %EXT_MAP) {
1189 if ($path =~ $EXT_MAP{$pkg}) {
1190 my $self = bless cf::map::new, $pkg;
1191 $self->{path} = $path; $self->path ($path);
1192 $self->init; # pass $1 etc.
1193 return $self;
1194 }
1195 }
1196
1197 Carp::carp "unable to resolve path '$path'.";
1198 ()
1199}
1200
1201sub init {
1202 my ($self) = @_;
1203
1204 $self
1205}
1206
1207sub as_string {
1208 my ($self) = @_;
1209
1210 "$self->{path}"
1211}
1212
1213# the displayed name, this is a one way mapping
1214sub visible_name {
1215 &as_string
1216}
1217
1218# the original (read-only) location
1219sub load_path {
1220 my ($self) = @_;
1221
1222 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
1223}
1224
1225# the temporary/swap location
1226sub save_path {
1227 my ($self) = @_;
1228
1229 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1230 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path
1231}
1232
1233# the unique path, undef == no special unique path
1234sub uniq_path {
1235 my ($self) = @_;
1236
1237 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1238 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1239}
1240
1241# and all this just because we cannot iterate over
1242# all maps in C++...
1243sub change_all_map_light {
1244 my ($change) = @_;
1245
1246 $_->change_map_light ($change)
1247 for grep $_->outdoor, values %cf::MAP;
1248}
1249
1250sub unlink_save {
1251 my ($self) = @_;
1252
1253 utf8::encode (my $save = $self->save_path);
1254 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save;
1255 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst";
1256}
1257
1258sub load_header_from($) {
1259 my ($self, $path) = @_;
1260
1261 utf8::encode $path;
1262 aio_open $path, O_RDONLY, 0
1263 or return;
1264
1265 $self->_load_header ($path)
1266 or return;
1267
1268 $self->{load_path} = $path;
1269
1270 1
1271}
1272
1273sub load_orig {
1274 my ($self) = @_;
1275
1276 $self->load_header_from ($self->load_path)
1277}
1278
1279sub load_temp {
1280 my ($self) = @_;
1281
1282 $self->load_header_from ($self->save_path)
1283}
1284
1285sub load_header {
1286 my ($self) = @_;
1287
1288 if ($self->load_temp) {
1289 $self->last_access ((delete $self->{last_access})
1290 || $cf::RUNTIME); #d#
1291 # safety
1292 $self->{instantiate_time} = $cf::RUNTIME
1293 if $self->{instantiate_time} > $cf::RUNTIME;
1294 } else {
1295 $self->load_orig
1296 or return;
1297
1298 $self->{load_original} = 1;
1299 $self->{instantiate_time} = $cf::RUNTIME;
1300 $self->last_access ($cf::RUNTIME);
1301 $self->instantiate;
1302 }
1303
1304 1
1305}
1306
1307sub find;
1308sub find {
1309 my ($path, $origin) = @_;
1310
1311 $path = normalise $path, $origin && $origin->path;
1312
1313 cf::lock_wait "map_find:$path";
1314
1315 $cf::MAP{$path} || do {
1316 my $guard = cf::lock_acquire "map_find:$path";
1317 my $map = new_from_path cf::map $path
1318 or return;
1319
1320 $map->{last_save} = $cf::RUNTIME;
1321
1322 $map->load_header
1323 or return;
1324
1325 if ($map->should_reset) {
1326 $map->reset;
1327 undef $guard;
1328 $map = find $path
1329 or return;
1330 }
1331
1332 $cf::MAP{$path} = $map
1333 }
1334}
1335
1336sub load {
1337 my ($self) = @_;
1338
1339 my $path = $self->{path};
1340 my $guard = cf::lock_acquire "map_load:$path";
1341
1342 return if $self->in_memory != cf::MAP_SWAPPED;
1343
1344 $self->in_memory (cf::MAP_LOADING);
1345
1346 $self->alloc;
1347 $self->_load_objects ($self->{load_path}, 1)
1348 or return;
1349
1350 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1351 if delete $self->{load_original};
1352
1353 if (my $uniq = $self->uniq_path) {
1354 utf8::encode $uniq;
1355 if (aio_open $uniq, O_RDONLY, 0) {
1356 $self->clear_unique_items;
1357 $self->_load_objects ($uniq, 0);
1358 }
1359 }
1360
1361 Coro::cede;
1362
1363 # now do the right thing for maps
1364 $self->link_multipart_objects;
1365
1366 unless ($self->{deny_activate}) {
1367 $self->decay_objects;
1368 $self->fix_auto_apply;
1369 $self->update_buttons;
1370 Coro::cede;
1371 $self->set_darkness_map;
1372 $self->difficulty ($self->estimate_difficulty)
1373 unless $self->difficulty;
1374 Coro::cede;
1375 $self->activate;
1376 }
1377
1378 $self->in_memory (cf::MAP_IN_MEMORY);
1379}
1380
1381sub customise_for {
1382 my ($self, $ob) = @_;
1383
1384 return find "~" . $ob->name . "/" . $self->{path}
1385 if $self->per_player;
1386
1387 $self
1388}
1389
1390# find and load all maps in the 3x3 area around a map
1391sub load_diag {
725 my ($map) = @_; 1392 my ($map) = @_;
726 1393
727 my $path = $map->tmpname; 1394 my @diag; # diagonal neighbours
728 defined $path or return;
729 1395
730 unlink "$path.pst"; 1396 for (0 .. 3) {
1397 my $neigh = $map->tile_path ($_)
1398 or next;
1399 $neigh = find $neigh, $map
1400 or next;
1401 $neigh->load;
1402
1403 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1404 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1405 }
1406
1407 for (@diag) {
1408 my $neigh = find @$_
1409 or next;
1410 $neigh->load;
1411 }
1412}
1413
1414sub find_sync {
1415 my ($path, $origin) = @_;
1416
1417 cf::sync_job { find $path, $origin }
1418}
1419
1420sub do_load_sync {
1421 my ($map) = @_;
1422
1423 cf::sync_job { $map->load };
1424}
1425
1426our %MAP_PREFETCH;
1427our $MAP_PREFETCHER = Coro::async {
1428 while () {
1429 for my $path (keys %MAP_PREFETCH) {
1430 my $map = find $path
1431 or next;
1432 $map->load;
1433
1434 delete $MAP_PREFETCH{$path};
1435 }
1436 Coro::schedule;
1437 }
731}; 1438};
732 1439
733cf::map->attach (prio => -10000, package => cf::mapsupport::); 1440sub find_async {
1441 my ($path, $origin) = @_;
734 1442
735############################################################################# 1443 $path = normalise $path, $origin && $origin->{path};
736# load/save perl data associated with player->ob objects
737 1444
738sub all_objects(@) { 1445 if (my $map = $cf::MAP{$path}) {
739 @_, map all_objects ($_->inv), @_ 1446 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 }, 1447 }
755);
756 1448
757############################################################################# 1449 $MAP_PREFETCH{$path} = 0;
1450 $MAP_PREFETCHER->ready;
758 1451
759=head2 CORE EXTENSIONS 1452 ()
1453}
760 1454
761Functions and methods that extend core crossfire objects. 1455sub save {
1456 my ($self) = @_;
762 1457
763=head3 cf::player 1458 my $lock = cf::lock_acquire "map_data:" . $self->path;
1459
1460 $self->{last_save} = $cf::RUNTIME;
1461
1462 return unless $self->dirty;
1463
1464 my $save = $self->save_path; utf8::encode $save;
1465 my $uniq = $self->uniq_path; utf8::encode $uniq;
1466
1467 $self->{load_path} = $save;
1468
1469 return if $self->{deny_save};
1470
1471 local $self->{last_access} = $self->last_access;#d#
1472
1473 cf::async {
1474 $_->contr->save for $self->players;
1475 };
1476
1477 if ($uniq) {
1478 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1479 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1480 } else {
1481 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1482 }
1483}
1484
1485sub swap_out {
1486 my ($self) = @_;
1487
1488 # save first because save cedes
1489 $self->save;
1490
1491 my $lock = cf::lock_acquire "map_data:" . $self->path;
1492
1493 return if $self->players;
1494 return if $self->in_memory != cf::MAP_IN_MEMORY;
1495 return if $self->{deny_save};
1496
1497 $self->clear;
1498 $self->in_memory (cf::MAP_SWAPPED);
1499}
1500
1501sub reset_at {
1502 my ($self) = @_;
1503
1504 # TODO: safety, remove and allow resettable per-player maps
1505 return 1e99 if $self->isa ("ext::map_per_player");#d#
1506 return 1e99 if $self->{deny_reset};
1507
1508 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1509 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1510
1511 $time + $to
1512}
1513
1514sub should_reset {
1515 my ($self) = @_;
1516
1517 $self->reset_at <= $cf::RUNTIME
1518}
1519
1520sub rename {
1521 my ($self, $new_path) = @_;
1522
1523 normalise $new_path;
1524
1525 $self->unlink_save;
1526
1527 delete $cf::MAP{$self->path};
1528 $self->{path} = $new_path; $self->path ($self->{path});
1529 $cf::MAP{$self->path} = $self;
1530
1531 $self->save;
1532}
1533
1534sub reset {
1535 my ($self) = @_;
1536
1537 my $lock = cf::lock_acquire "map_data:$self->{path}";
1538
1539 return if $self->players;
1540 return if $self->isa ("ext::map_per_player");#d#
1541
1542 warn "resetting map ", $self->path;#d#
1543
1544 delete $cf::MAP{$self->path};
1545
1546 $self->in_memory (cf::MAP_SWAPPED);
1547 $self->clear;
1548
1549 $_->clear_links_to ($self) for values %cf::MAP;
1550
1551 $self->unlink_save;
1552 $self->destroy;
1553}
1554
1555my $nuke_counter = "aaaa";
1556
1557sub nuke {
1558 my ($self) = @_;
1559
1560 $self->{deny_save} = 1;
1561 $self->reset_timeout (1);
1562 $self->rename ("{nuke}/" . ($nuke_counter++));
1563 $self->reset; # polite request, might not happen
1564}
1565
1566=item cf::map::unique_maps
1567
1568Returns an arrayref of paths of all shared maps that have
1569instantiated unique items. May block.
1570
1571=cut
1572
1573sub unique_maps() {
1574 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1575 or return;
1576
1577 my @paths;
1578
1579 for (@$files) {
1580 utf8::decode $_;
1581 next if /\.pst$/;
1582 next unless /^$PATH_SEP/o;
1583
1584 s/\.map$//;
1585 push @paths, $_;
1586 }
1587
1588 \@paths
1589}
1590
1591package cf;
1592
1593=back
1594
1595=head3 cf::object
1596
1597=cut
1598
1599package cf::object;
764 1600
765=over 4 1601=over 4
766 1602
767=item cf::player::exists $login 1603=item $ob->inv_recursive
768 1604
769Returns true when the given account exists. 1605Returns the inventory of the object _and_ their inventories, recursively.
770 1606
771=cut 1607=cut
772 1608
773sub cf::player::exists($) { 1609sub inv_recursive_;
774 cf::player::find $_[0] 1610sub inv_recursive_ {
775 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1611 map { $_, inv_recursive_ $_->inv } @_
776} 1612}
777 1613
778=item $player->ext_reply ($msgid, $msgtype, %msg) 1614sub inv_recursive {
779 1615 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} 1616}
1617
1618package cf;
791 1619
792=back 1620=back
793 1621
794=head3 cf::object::player 1622=head3 cf::object::player
795 1623
833 (ref $cf::CFG{"may_$access"} 1661 (ref $cf::CFG{"may_$access"}
834 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1662 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
835 : $cf::CFG{"may_$access"}) 1663 : $cf::CFG{"may_$access"})
836} 1664}
837 1665
1666=item $player_object->enter_link
1667
1668Freezes the player and moves him/her to a special map (C<{link}>).
1669
1670The player should be reasonably safe there for short amounts of time. You
1671I<MUST> call C<leave_link> as soon as possible, though.
1672
1673Will never block.
1674
1675=item $player_object->leave_link ($map, $x, $y)
1676
1677Moves the player out of the special C<{link}> map onto the specified
1678map. If the map is not valid (or omitted), the player will be moved back
1679to the location he/she was before the call to C<enter_link>, or, if that
1680fails, to the emergency map position.
1681
1682Might block.
1683
1684=cut
1685
1686sub link_map {
1687 unless ($LINK_MAP) {
1688 $LINK_MAP = cf::map::find "{link}"
1689 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 };
1690 $LINK_MAP->load;
1691 }
1692
1693 $LINK_MAP
1694}
1695
1696sub cf::object::player::enter_link {
1697 my ($self) = @_;
1698
1699 $self->deactivate_recursive;
1700
1701 return if UNIVERSAL::isa $self->map, "ext::map_link";
1702
1703 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1704 if $self->map;
1705
1706 $self->enter_map ($LINK_MAP || link_map, 20, 20);
1707}
1708
1709sub cf::object::player::leave_link {
1710 my ($self, $map, $x, $y) = @_;
1711
1712 my $link_pos = delete $self->{_link_pos};
1713
1714 unless ($map) {
1715 # restore original map position
1716 ($map, $x, $y) = @{ $link_pos || [] };
1717 $map = cf::map::find $map;
1718
1719 unless ($map) {
1720 ($map, $x, $y) = @$EMERGENCY_POSITION;
1721 $map = cf::map::find $map
1722 or die "FATAL: cannot load emergency map\n";
1723 }
1724 }
1725
1726 ($x, $y) = (-1, -1)
1727 unless (defined $x) && (defined $y);
1728
1729 # use -1 or undef as default coordinates, not 0, 0
1730 ($x, $y) = ($map->enter_x, $map->enter_y)
1731 if $x <=0 && $y <= 0;
1732
1733 $map->load;
1734 $map->load_diag;
1735
1736 return unless $self->contr->active;
1737 $self->activate_recursive;
1738 $self->enter_map ($map, $x, $y);
1739}
1740
1741cf::player->attach (
1742 on_logout => sub {
1743 my ($pl) = @_;
1744
1745 # abort map switching before logout
1746 if ($pl->ob->{_link_pos}) {
1747 cf::sync_job {
1748 $pl->ob->leave_link
1749 };
1750 }
1751 },
1752 on_login => sub {
1753 my ($pl) = @_;
1754
1755 # try to abort aborted map switching on player login :)
1756 # should happen only on crashes
1757 if ($pl->ob->{_link_pos}) {
1758 $pl->ob->enter_link;
1759 (async {
1760 # we need this sleep as the login has a concurrent enter_exit running
1761 # and this sleep increases chances of the player not ending up in scorn
1762 $pl->ob->reply (undef,
1763 "There was an internal problem at your last logout, "
1764 . "the server will try to bring you to your intended destination in a second.",
1765 cf::NDI_RED);
1766 Coro::Timer::sleep 1;
1767 $pl->ob->leave_link;
1768 })->prio (2);
1769 }
1770 },
1771);
1772
1773=item $player_object->goto ($path, $x, $y)
1774
1775=cut
1776
1777sub cf::object::player::goto {
1778 my ($self, $path, $x, $y) = @_;
1779
1780 $self->enter_link;
1781
1782 (async {
1783 my $map = cf::map::find $path;
1784 $map = $map->customise_for ($self) if $map;
1785
1786# warn "entering ", $map->path, " at ($x, $y)\n"
1787# if $map;
1788
1789 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1790
1791 $self->leave_link ($map, $x, $y);
1792 })->prio (1);
1793}
1794
1795=item $player_object->enter_exit ($exit_object)
1796
1797=cut
1798
1799sub parse_random_map_params {
1800 my ($spec) = @_;
1801
1802 my $rmp = { # defaults
1803 xsize => 10,
1804 ysize => 10,
1805 };
1806
1807 for (split /\n/, $spec) {
1808 my ($k, $v) = split /\s+/, $_, 2;
1809
1810 $rmp->{lc $k} = $v if (length $k) && (length $v);
1811 }
1812
1813 $rmp
1814}
1815
1816sub prepare_random_map {
1817 my ($exit) = @_;
1818
1819 # all this does is basically replace the /! path by
1820 # a new random map path (?random/...) with a seed
1821 # that depends on the exit object
1822
1823 my $rmp = parse_random_map_params $exit->msg;
1824
1825 if ($exit->map) {
1826 $rmp->{region} = $exit->map->region_name;
1827 $rmp->{origin_map} = $exit->map->path;
1828 $rmp->{origin_x} = $exit->x;
1829 $rmp->{origin_y} = $exit->y;
1830 }
1831
1832 $rmp->{random_seed} ||= $exit->random_seed;
1833
1834 my $data = cf::to_json $rmp;
1835 my $md5 = Digest::MD5::md5_hex $data;
1836
1837 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1838 aio_write $fh, 0, (length $data), $data, 0;
1839
1840 $exit->slaying ("?random/$md5");
1841 $exit->msg (undef);
1842 }
1843}
1844
1845sub cf::object::player::enter_exit {
1846 my ($self, $exit) = @_;
1847
1848 return unless $self->type == cf::PLAYER;
1849
1850 $self->enter_link;
1851
1852 (async {
1853 $self->deactivate_recursive; # just to be sure
1854 unless (eval {
1855 prepare_random_map $exit
1856 if $exit->slaying eq "/!";
1857
1858 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1859 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1860
1861 1;
1862 }) {
1863 $self->message ("Something went wrong deep within the crossfire server. "
1864 . "I'll try to bring you back to the map you were before. "
1865 . "Please report this to the dungeon master!",
1866 cf::NDI_UNIQUE | cf::NDI_RED);
1867
1868 warn "ERROR in enter_exit: $@";
1869 $self->leave_link;
1870 }
1871 })->prio (1);
1872}
1873
838=head3 cf::client 1874=head3 cf::client
839 1875
840=over 4 1876=over 4
841 1877
842=item $client->send_drawinfo ($text, $flags) 1878=item $client->send_drawinfo ($text, $flags)
885 on_reply => sub { 1921 on_reply => sub {
886 my ($ns, $msg) = @_; 1922 my ($ns, $msg) = @_;
887 1923
888 # this weird shuffling is so that direct followup queries 1924 # this weird shuffling is so that direct followup queries
889 # get handled first 1925 # get handled first
890 my $queue = delete $ns->{query_queue}; 1926 my $queue = delete $ns->{query_queue}
1927 or return; # be conservative, not sure how that can happen, but we saw a crash here
891 1928
892 (shift @$queue)->[1]->($msg); 1929 (shift @$queue)->[1]->($msg);
893 1930
894 push @{ $ns->{query_queue} }, @$queue; 1931 push @{ $ns->{query_queue} }, @$queue;
895 1932
896 if (@{ $ns->{query_queue} } == @$queue) { 1933 if (@{ $ns->{query_queue} } == @$queue) {
897 if (@$queue) { 1934 if (@$queue) {
898 $ns->send_packet ($ns->{query_queue}[0][0]); 1935 $ns->send_packet ($ns->{query_queue}[0][0]);
899 } else { 1936 } else {
900 $ns->state (ST_PLAYING); 1937 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
901 } 1938 }
902 } 1939 }
1940 },
1941);
1942
1943=item $client->async (\&cb)
1944
1945Create a new coroutine, running the specified callback. The coroutine will
1946be automatically cancelled when the client gets destroyed (e.g. on logout,
1947or loss of connection).
1948
1949=cut
1950
1951sub cf::client::async {
1952 my ($self, $cb) = @_;
1953
1954 my $coro = &Coro::async ($cb);
1955
1956 $coro->on_destroy (sub {
1957 delete $self->{_coro}{$coro+0};
1958 });
1959
1960 $self->{_coro}{$coro+0} = $coro;
1961
1962 $coro
1963}
1964
1965cf::client->attach (
1966 on_destroy => sub {
1967 my ($ns) = @_;
1968
1969 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
903 }, 1970 },
904); 1971);
905 1972
906=back 1973=back
907 1974
1064 2131
1065{ 2132{
1066 my $path = cf::localdir . "/database.pst"; 2133 my $path = cf::localdir . "/database.pst";
1067 2134
1068 sub db_load() { 2135 sub db_load() {
1069 warn "loading database $path\n";#d# remove later
1070 $DB = stat $path ? Storable::retrieve $path : { }; 2136 $DB = stat $path ? Storable::retrieve $path : { };
1071 } 2137 }
1072 2138
1073 my $pid; 2139 my $pid;
1074 2140
1075 sub db_save() { 2141 sub db_save() {
1076 warn "saving database $path\n";#d# remove later
1077 waitpid $pid, 0 if $pid; 2142 waitpid $pid, 0 if $pid;
1078 if (0 == ($pid = fork)) { 2143 if (0 == ($pid = fork)) {
1079 $DB->{_meta}{version} = 1; 2144 $DB->{_meta}{version} = 1;
1080 Storable::nstore $DB, "$path~"; 2145 Storable::nstore $DB, "$path~";
1081 rename "$path~", $path; 2146 rename "$path~", $path;
1129 open my $fh, "<:utf8", cf::confdir . "/config" 2194 open my $fh, "<:utf8", cf::confdir . "/config"
1130 or return; 2195 or return;
1131 2196
1132 local $/; 2197 local $/;
1133 *CFG = YAML::Syck::Load <$fh>; 2198 *CFG = YAML::Syck::Load <$fh>;
2199
2200 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2201
2202 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2203 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2204
2205 if (exists $CFG{mlockall}) {
2206 eval {
2207 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2208 and die "WARNING: m(un)lockall failed: $!\n";
2209 };
2210 warn $@ if $@;
2211 }
1134} 2212}
1135 2213
1136sub main { 2214sub main {
2215 # we must not ever block the main coroutine
2216 local $Coro::idle = sub {
2217 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2218 async { Event::one_event };
2219 };
2220
1137 cfg_load; 2221 cfg_load;
1138 db_load; 2222 db_load;
1139 load_extensions; 2223 load_extensions;
1140 Event::loop; 2224 Event::loop;
1141} 2225}
1142 2226
1143############################################################################# 2227#############################################################################
1144# initialisation 2228# initialisation and cleanup
1145 2229
2230# install some emergency cleanup handlers
2231BEGIN {
2232 for my $signal (qw(INT HUP TERM)) {
2233 Event->signal (
2234 data => WF_AUTOCANCEL,
2235 signal => $signal,
2236 cb => sub {
2237 cf::cleanup "SIG$signal";
2238 },
2239 );
2240 }
2241}
2242
2243sub emergency_save() {
2244 my $freeze_guard = cf::freeze_mainloop;
2245
2246 warn "enter emergency perl save\n";
2247
2248 cf::sync_job {
2249 # use a peculiar iteration method to avoid tripping on perl
2250 # refcount bugs in for. also avoids problems with players
2251 # and maps saved/destroyed asynchronously.
2252 warn "begin emergency player save\n";
2253 for my $login (keys %cf::PLAYER) {
2254 my $pl = $cf::PLAYER{$login} or next;
2255 $pl->valid or next;
2256 $pl->save;
2257 }
2258 warn "end emergency player save\n";
2259
2260 warn "begin emergency map save\n";
2261 for my $path (keys %cf::MAP) {
2262 my $map = $cf::MAP{$path} or next;
2263 $map->valid or next;
2264 $map->save;
2265 }
2266 warn "end emergency map save\n";
2267 };
2268
2269 warn "leave emergency perl save\n";
2270}
2271
1146sub _perl_reload(&) { 2272sub reload() {
1147 my ($msg) = @_; 2273 # can/must only be called in main
2274 if ($Coro::current != $Coro::main) {
2275 warn "can only reload from main coroutine\n";
2276 return;
2277 }
1148 2278
1149 $msg->("reloading..."); 2279 warn "reloading...";
2280
2281 warn "freezing server";
2282 my $guard = freeze_mainloop;
2283 cf::emergency_save;
2284
2285 warn "sync database to disk";
2286 cf::db_sync;
2287 IO::AIO::flush;
1150 2288
1151 eval { 2289 eval {
2290 # if anything goes wrong in here, we should simply crash as we already saved
2291
1152 # cancel all watchers 2292 warn "cancel all watchers";
1153 for (Event::all_watchers) { 2293 for (Event::all_watchers) {
1154 $_->cancel if $_->data & WF_AUTOCANCEL; 2294 $_->cancel if $_->data & WF_AUTOCANCEL;
1155 } 2295 }
1156 2296
2297 warn "cancel all extension coros";
2298 $_->cancel for values %EXT_CORO;
2299 %EXT_CORO = ();
2300
2301 warn "remove commands";
2302 %COMMAND = ();
2303
2304 warn "remove ext commands";
2305 %EXTCMD = ();
2306
1157 # unload all extensions 2307 warn "unload/nuke all extensions";
1158 for (@exts) { 2308 for my $pkg (@EXTS) {
1159 $msg->("unloading <$_>"); 2309 warn "... unloading $pkg";
1160 unload_extension $_; 2310
2311 if (my $cb = $pkg->can ("unload")) {
2312 eval {
2313 $cb->($pkg);
2314 1
2315 } or warn "$pkg unloaded, but with errors: $@";
1161 } 2316 }
1162 2317
2318 warn "... nuking $pkg";
2319 Symbol::delete_package $pkg;
2320 }
2321
1163 # unload all modules loaded from $LIBDIR 2322 warn "unload all perl modules loaded from $LIBDIR";
1164 while (my ($k, $v) = each %INC) { 2323 while (my ($k, $v) = each %INC) {
1165 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2324 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1166 2325
1167 $msg->("removing <$k>"); 2326 warn "removing <$k>";
1168 delete $INC{$k}; 2327 delete $INC{$k};
1169 2328
1170 $k =~ s/\.pm$//; 2329 $k =~ s/\.pm$//;
1171 $k =~ s/\//::/g; 2330 $k =~ s/\//::/g;
1172 2331
1175 } 2334 }
1176 2335
1177 Symbol::delete_package $k; 2336 Symbol::delete_package $k;
1178 } 2337 }
1179 2338
1180 # sync database to disk
1181 cf::db_sync;
1182
1183 # get rid of safe::, as good as possible 2339 warn "get rid of safe::, as good as possible";
1184 Symbol::delete_package "safe::$_" 2340 Symbol::delete_package "safe::$_"
1185 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2341 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1186 2342
1187 # remove register_script_function callbacks
1188 # TODO
1189
1190 # unload cf.pm "a bit" 2343 warn "unload cf.pm \"a bit\"";
1191 delete $INC{"cf.pm"}; 2344 delete $INC{"cf.pm"};
1192 2345
1193 # don't, removes xs symbols, too, 2346 # don't, removes xs symbols, too,
1194 # and global variables created in xs 2347 # and global variables created in xs
1195 #Symbol::delete_package __PACKAGE__; 2348 #Symbol::delete_package __PACKAGE__;
1196 2349
1197 # reload cf.pm
1198 $msg->("reloading cf.pm"); 2350 warn "reloading cf.pm";
1199 require cf; 2351 require cf;
2352 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1200 2353
1201 # load config and database again 2354 warn "load config and database again";
1202 cf::cfg_load; 2355 cf::cfg_load;
1203 cf::db_load; 2356 cf::db_load;
1204 2357
1205 # load extensions 2358 warn "load extensions";
1206 $msg->("load extensions");
1207 cf::load_extensions; 2359 cf::load_extensions;
1208 2360
1209 # reattach attachments to objects 2361 warn "reattach attachments to objects/players";
1210 $msg->("reattach");
1211 _global_reattach; 2362 _global_reattach;
2363 warn "reattach attachments to maps";
2364 reattach $_ for values %MAP;
1212 }; 2365 };
1213 $msg->($@) if $@;
1214 2366
1215 $msg->("reloaded"); 2367 if ($@) {
2368 warn $@;
2369 warn "error while reloading, exiting.";
2370 exit 1;
2371 }
2372
2373 warn "reloaded";
1216}; 2374};
1217 2375
1218sub perl_reload() {
1219 _perl_reload {
1220 warn $_[0];
1221 print "$_[0]\n";
1222 };
1223}
1224
1225register "<global>", __PACKAGE__;
1226
1227register_command "perl-reload" => sub { 2376register_command "reload" => sub {
1228 my ($who, $arg) = @_; 2377 my ($who, $arg) = @_;
1229 2378
1230 if ($who->flag (FLAG_WIZ)) { 2379 if ($who->flag (FLAG_WIZ)) {
1231 _perl_reload { 2380 $who->message ("start of reload.");
1232 warn $_[0]; 2381 reload;
1233 $who->message ($_[0]); 2382 $who->message ("end of reload.");
1234 };
1235 } 2383 }
1236}; 2384};
1237 2385
1238unshift @INC, $LIBDIR; 2386unshift @INC, $LIBDIR;
1239 2387
1240$TICK_WATCHER = Event->timer ( 2388$TICK_WATCHER = Event->timer (
2389 reentrant => 0,
1241 prio => 0, 2390 prio => 0,
1242 at => $NEXT_TICK || 1, 2391 at => $NEXT_TICK || $TICK,
1243 data => WF_AUTOCANCEL, 2392 data => WF_AUTOCANCEL,
1244 cb => sub { 2393 cb => sub {
2394 $NOW = Event::time;
2395
1245 cf::server_tick; # one server iteration 2396 cf::server_tick; # one server iteration
1246 2397 $RUNTIME += $TICK;
1247 my $NOW = Event::time;
1248 $NEXT_TICK += $TICK; 2398 $NEXT_TICK += $TICK;
1249 2399
2400 $WAIT_FOR_TICK->broadcast;
2401 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2402
1250 # if we are delayed by four ticks or more, skip them all 2403 # if we are delayed by four ticks or more, skip them all
1251 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2404 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1252 2405
1253 $TICK_WATCHER->at ($NEXT_TICK); 2406 $TICK_WATCHER->at ($NEXT_TICK);
1254 $TICK_WATCHER->start; 2407 $TICK_WATCHER->start;
1255 }, 2408 },
1256); 2409);
1257 2410
1258IO::AIO::max_poll_time $TICK * 0.2; 2411IO::AIO::max_poll_time $TICK * 0.2;
1259 2412
2413$AIO_POLL_WATCHER = Event->io (
1260Event->io (fd => IO::AIO::poll_fileno, 2414 fd => IO::AIO::poll_fileno,
1261 poll => 'r', 2415 poll => 'r',
1262 prio => 5, 2416 prio => 5,
1263 data => WF_AUTOCANCEL, 2417 data => WF_AUTOCANCEL,
1264 cb => \&IO::AIO::poll_cb); 2418 cb => \&IO::AIO::poll_cb,
2419);
2420
2421$WRITE_RUNTIME_WATCHER = Event->timer (
2422 data => WF_AUTOCANCEL,
2423 after => 0,
2424 interval => 10,
2425 cb => sub {
2426 (Coro::unblock_sub {
2427 write_runtime
2428 or warn "ERROR: unable to write runtime file: $!";
2429 })->();
2430 },
2431);
2432
2433END { cf::emergency_save }
1265 2434
12661 24351
1267 2436

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines