ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.97 by root, Fri Dec 22 06:03:20 2006 UTC vs.
Revision 1.166 by root, Sat Jan 13 23:06:13 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines