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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines