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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines