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.163 by root, Thu Jan 11 01:01:56 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
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
65binmode STDOUT;
66binmode STDERR;
67
68# read virtual server time, if available
69unless ($RUNTIME || !-e cf::localdir . "/runtime") {
70 open my $fh, "<", cf::localdir . "/runtime"
71 or die "unable to read runtime file: $!";
72 $RUNTIME = <$fh> + 0.;
73}
74
75mkdir cf::localdir;
76mkdir cf::localdir . "/" . cf::playerdir;
77mkdir cf::localdir . "/" . cf::tmpdir;
78mkdir cf::localdir . "/" . cf::uniquedir;
79mkdir $RANDOM_MAPS;
80
81# a special map that is always available
82our $LINK_MAP;
83our $EMERGENCY_POSITION;
48 84
49############################################################################# 85#############################################################################
50 86
51=head2 GLOBAL VARIABLES 87=head2 GLOBAL VARIABLES
52 88
53=over 4 89=over 4
54 90
55=item $cf::UPTIME 91=item $cf::UPTIME
56 92
57The timestamp of the server start (so not actually an uptime). 93The timestamp of the server start (so not actually an uptime).
94
95=item $cf::RUNTIME
96
97The time this server has run, starts at 0 and is increased by $cf::TICK on
98every server tick.
58 99
59=item $cf::LIBDIR 100=item $cf::LIBDIR
60 101
61The perl library directory, where extensions and cf-specific modules can 102The perl library directory, where extensions and cf-specific modules can
62be found. It will be added to C<@INC> automatically. 103be found. It will be added to C<@INC> automatically.
63 104
105=item $cf::NOW
106
107The time of the last (current) server tick.
108
64=item $cf::TICK 109=item $cf::TICK
65 110
66The interval between server ticks, in seconds. 111The interval between server ticks, in seconds.
67 112
68=item %cf::CFG 113=item %cf::CFG
69 114
70Configuration for the server, loaded from C</etc/crossfire/config>, or 115Configuration for the server, loaded from C</etc/crossfire/config>, or
71from wherever your confdir points to. 116from wherever your confdir points to.
117
118=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
119
120These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
121or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
122processing has been done. Call C<< ->wait >> on them to maximise the
123window of cpu time available, or simply to synchronise to the server tick.
72 124
73=back 125=back
74 126
75=cut 127=cut
76 128
77BEGIN { 129BEGIN {
78 *CORE::GLOBAL::warn = sub { 130 *CORE::GLOBAL::warn = sub {
79 my $msg = join "", @_; 131 my $msg = join "", @_;
132 utf8::encode $msg;
133
80 $msg .= "\n" 134 $msg .= "\n"
81 unless $msg =~ /\n$/; 135 unless $msg =~ /\n$/;
82 136
83 print STDERR "cfperl: $msg";
84 LOG llevError, "cfperl: $msg"; 137 LOG llevError, $msg;
85 }; 138 };
86} 139}
87 140
88@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 141@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
89@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 142@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
93@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 146@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
94 147
95# we bless all objects into (empty) derived classes to force a method lookup 148# we bless all objects into (empty) derived classes to force a method lookup
96# within the Safe compartment. 149# within the Safe compartment.
97for my $pkg (qw( 150for my $pkg (qw(
98 cf::global 151 cf::global cf::attachable
99 cf::object cf::object::player 152 cf::object cf::object::player
100 cf::client cf::player 153 cf::client cf::player
101 cf::arch cf::living 154 cf::arch cf::living
102 cf::map cf::party cf::region 155 cf::map cf::party cf::region
103)) { 156)) {
107 160
108$Event::DIED = sub { 161$Event::DIED = sub {
109 warn "error in event callback: @_"; 162 warn "error in event callback: @_";
110}; 163};
111 164
112my %ext_pkg;
113my @exts;
114my @hook;
115
116=head2 UTILITY FUNCTIONS 165=head2 UTILITY FUNCTIONS
117 166
118=over 4 167=over 4
119 168
169=item dumpval $ref
170
120=cut 171=cut
172
173sub dumpval {
174 eval {
175 local $SIG{__DIE__};
176 my $d;
177 if (1) {
178 $d = new Data::Dumper([$_[0]], ["*var"]);
179 $d->Terse(1);
180 $d->Indent(2);
181 $d->Quotekeys(0);
182 $d->Useqq(1);
183 #$d->Bless(...);
184 $d->Seen($_[1]) if @_ > 1;
185 $d = $d->Dump();
186 }
187 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
188 $d
189 } || "[unable to dump $_[0]: '$@']";
190}
121 191
122use JSON::Syck (); # TODO# replace by JSON::PC once working 192use JSON::Syck (); # TODO# replace by JSON::PC once working
123 193
124=item $ref = cf::from_json $json 194=item $ref = cf::from_json $json
125 195
141sub to_json($) { 211sub to_json($) {
142 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 212 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
143 JSON::Syck::Dump $_[0] 213 JSON::Syck::Dump $_[0]
144} 214}
145 215
216=item cf::lock_wait $string
217
218Wait until the given lock is available. See cf::lock_acquire.
219
220=item my $lock = cf::lock_acquire $string
221
222Wait until the given lock is available and then acquires it and returns
223a Coro::guard object. If the guard object gets destroyed (goes out of scope,
224for example when the coroutine gets canceled), the lock is automatically
225returned.
226
227Lock names should begin with a unique identifier (for example, cf::map::find
228uses map_find and cf::map::load uses map_load).
229
230=cut
231
232our %LOCK;
233
234sub lock_wait($) {
235 my ($key) = @_;
236
237 # wait for lock, if any
238 while ($LOCK{$key}) {
239 push @{ $LOCK{$key} }, $Coro::current;
240 Coro::schedule;
241 }
242}
243
244sub lock_acquire($) {
245 my ($key) = @_;
246
247 # wait, to be sure we are not locked
248 lock_wait $key;
249
250 $LOCK{$key} = [];
251
252 Coro::guard {
253 # wake up all waiters, to be on the safe side
254 $_->ready for @{ delete $LOCK{$key} };
255 }
256}
257
258sub freeze_mainloop {
259 return unless $TICK_WATCHER->is_active;
260
261 my $guard = Coro::guard { $TICK_WATCHER->start };
262 $TICK_WATCHER->stop;
263 $guard
264}
265
266=item cf::async { BLOCK }
267
268Currently the same as Coro::async_pool, meaning you cannot use
269C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
270thing you are allowed to do is call C<prio> on it.
271
272=cut
273
274BEGIN { *async = \&Coro::async_pool }
275
276=item cf::sync_job { BLOCK }
277
278The design of crossfire+ requires that the main coro ($Coro::main) is
279always able to handle events or runnable, as crossfire+ is only partly
280reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
281
282If it must be done, put the blocking parts into C<sync_job>. This will run
283the given BLOCK in another coroutine while waiting for the result. The
284server will be frozen during this time, so the block should either finish
285fast or be very important.
286
287=cut
288
289sub sync_job(&) {
290 my ($job) = @_;
291
292 if ($Coro::current == $Coro::main) {
293 # this is the main coro, too bad, we have to block
294 # till the operation succeeds, freezing the server :/
295
296 # TODO: use suspend/resume instead
297 # (but this is cancel-safe)
298 my $freeze_guard = freeze_mainloop;
299
300 my $busy = 1;
301 my @res;
302
303 (async {
304 @res = eval { $job->() };
305 warn $@ if $@;
306 undef $busy;
307 })->prio (Coro::PRIO_MAX);
308
309 while ($busy) {
310 Coro::cede or Event::one_event;
311 }
312
313 wantarray ? @res : $res[0]
314 } else {
315 # we are in another coroutine, how wonderful, everything just works
316
317 $job->()
318 }
319}
320
321=item $coro = cf::async_ext { BLOCK }
322
323Like async, but this coro is automatically being canceled when the
324extension calling this is being unloaded.
325
326=cut
327
328sub async_ext(&) {
329 my $cb = shift;
330
331 my $coro = &Coro::async ($cb);
332
333 $coro->on_destroy (sub {
334 delete $EXT_CORO{$coro+0};
335 });
336 $EXT_CORO{$coro+0} = $coro;
337
338 $coro
339}
340
341sub write_runtime {
342 my $runtime = cf::localdir . "/runtime";
343
344 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
345 or return;
346
347 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
348 (aio_write $fh, 0, (length $value), $value, 0) <= 0
349 and return;
350
351 aio_fsync $fh
352 and return;
353
354 close $fh
355 or return;
356
357 aio_rename "$runtime~", $runtime
358 and return;
359
360 1
361}
362
146=back 363=back
147 364
148=cut 365=cut
366
367#############################################################################
368
369package cf::path;
370
371use overload
372 '""' => \&as_string;
373
374# used to convert map paths into valid unix filenames by repalcing / by ∕
375our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
376
377sub register {
378 my ($pkg, $prefix) = @_;
379
380 $EXT_MAP{$prefix} = $pkg;
381}
382
383sub new {
384 my ($class, $path, $base) = @_;
385
386 return $path if ref $path;
387
388 my $self = {};
389
390 # {... are special paths that are not being touched
391 # ?xxx/... are special absolute paths
392 # ?random/... random maps
393 # /! non-realised random map exit
394 # /... normal maps
395 # ~/... per-player maps without a specific player (DO NOT USE)
396 # ~user/... per-player map of a specific user
397
398 $path =~ s/$PATH_SEP/\//go;
399
400 if ($path =~ /^{/) {
401 # fine as it is
402 } else {
403 if ($path =~ s{^~([^/]+)?}{}) {
404 # ~user
405 $self->{user_rel} = 1;
406
407 if (defined $1) {
408 $self->{user} = $1;
409 } elsif ($base =~ m{^~([^/]+)/}) {
410 $self->{user} = $1;
411 } else {
412 warn "cannot resolve user-relative path without user <$path,$base>\n";
413 }
414 } elsif ($path =~ s{^\?([^/]+)/}{}) {
415 # ?...
416 $self->{ext} = $1;
417 if (my $ext = $EXT_MAP{$1}) {
418 bless $self, $ext;
419 }
420 } elsif ($path =~ /^\//) {
421 # /...
422 # already absolute
423 } else {
424 # relative
425 $base =~ s{[^/]+/?$}{};
426 return $class->new ("$base/$path");
427 }
428
429 for ($path) {
430 redo if s{/\.?/}{/};
431 redo if s{/[^/]+/\.\./}{/};
432 }
433 }
434
435 $self->{path} = $path;
436
437 if ("HASH" eq ref $self) {
438 bless $self, $class;
439 } else {
440 $self->init;
441 }
442
443 for my $ext (values %EXT_MAP) {
444 if (my $subst = $ext->substitute ($self)) {
445 return $subst;
446 }
447 }
448
449 $self
450}
451
452sub init {
453 # nop
454}
455
456sub substitute {
457 ()
458}
459
460# the name / primary key / in-game path
461sub as_string {
462 my ($self) = @_;
463
464 $self->{user_rel} ? "~$self->{user}$self->{path}"
465 : $self->{ext} ? "?$self->{ext}/$self->{path}"
466 : $self->{path}
467}
468
469# the displayed name, this is a one way mapping
470sub visible_name {
471 &as_string
472}
473
474# escape the /'s in the path
475sub _escaped_path {
476 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
477
478 $path
479}
480
481# the original (read-only) location
482sub load_path {
483 my ($self) = @_;
484
485 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
486}
487
488# the temporary/swap location
489sub save_path {
490 my ($self) = @_;
491
492 $self->{user_rel}
493 ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
494 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
495}
496
497# the unique path, undef == no special unique path
498sub uniq_path {
499 my ($self) = @_;
500
501 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
502}
503
504# this is somewhat ugly, but style maps do need special treatment
505sub is_style_map {
506 $_[0]{path} =~ m{^/styles/}
507}
508
509sub load_orig {
510 my ($self) = @_;
511
512 &cf::map::load_map_header ($self->load_path)
513}
514
515sub load_temp {
516 my ($self) = @_;
517
518 &cf::map::load_map_header ($self->save_path)
519}
520
521package cf;
149 522
150############################################################################# 523#############################################################################
151 524
152=head2 ATTACHABLE OBJECTS 525=head2 ATTACHABLE OBJECTS
153 526
269exception. 642exception.
270 643
271=cut 644=cut
272 645
273# the following variables are defined in .xs and must not be re-created 646# the following variables are defined in .xs and must not be re-created
274our @CB_GLOBAL = (); # registry for all global events 647our @CB_GLOBAL = (); # registry for all global events
648our @CB_ATTACHABLE = (); # registry for all attachables
275our @CB_OBJECT = (); # all objects (should not be used except in emergency) 649our @CB_OBJECT = (); # all objects (should not be used except in emergency)
276our @CB_PLAYER = (); 650our @CB_PLAYER = ();
277our @CB_CLIENT = (); 651our @CB_CLIENT = ();
278our @CB_TYPE = (); # registry for type (cf-object class) based events 652our @CB_TYPE = (); # registry for type (cf-object class) based events
279our @CB_MAP = (); 653our @CB_MAP = ();
280 654
281my %attachment; 655my %attachment;
282 656
283sub _attach_cb($$$$) { 657sub _attach_cb($$$$) {
284 my ($registry, $event, $prio, $cb) = @_; 658 my ($registry, $event, $prio, $cb) = @_;
289 663
290 @{$registry->[$event]} = sort 664 @{$registry->[$event]} = sort
291 { $a->[0] cmp $b->[0] } 665 { $a->[0] cmp $b->[0] }
292 @{$registry->[$event] || []}, $cb; 666 @{$registry->[$event] || []}, $cb;
293} 667}
668
669# hack
670my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
294 671
295# attach handles attaching event callbacks 672# attach handles attaching event callbacks
296# the only thing the caller has to do is pass the correct 673# the only thing the caller has to do is pass the correct
297# registry (== where the callback attaches to). 674# registry (== where the callback attaches to).
298sub _attach { 675sub _attach {
300 677
301 my $object_type; 678 my $object_type;
302 my $prio = 0; 679 my $prio = 0;
303 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 680 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
304 681
682 #TODO: get rid of this hack
683 if ($attachable_klass{$klass}) {
684 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
685 }
686
305 while (@arg) { 687 while (@arg) {
306 my $type = shift @arg; 688 my $type = shift @arg;
307 689
308 if ($type eq "prio") { 690 if ($type eq "prio") {
309 $prio = shift @arg; 691 $prio = shift @arg;
384 my ($obj, $name) = @_; 766 my ($obj, $name) = @_;
385 767
386 exists $obj->{_attachment}{$name} 768 exists $obj->{_attachment}{$name}
387} 769}
388 770
389for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 771for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
390 eval "#line " . __LINE__ . " 'cf.pm' 772 eval "#line " . __LINE__ . " 'cf.pm'
391 sub cf::\L$klass\E::_attach_registry { 773 sub cf::\L$klass\E::_attach_registry {
392 (\\\@CB_$klass, KLASS_$klass) 774 (\\\@CB_$klass, KLASS_$klass)
393 } 775 }
394 776
447=cut 829=cut
448 830
449############################################################################# 831#############################################################################
450# object support 832# object support
451 833
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 { 834sub reattach {
835 # basically do the same as instantiate, without calling instantiate
466 my ($obj) = @_; 836 my ($obj) = @_;
837
467 my $registry = $obj->registry; 838 my $registry = $obj->registry;
468 839
469 @$registry = (); 840 @$registry = ();
470 841
471 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 842 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
480 warn "object uses attachment '$name' that is not available, postponing.\n"; 851 warn "object uses attachment '$name' that is not available, postponing.\n";
481 } 852 }
482 } 853 }
483} 854}
484 855
485sub object_freezer_save { 856cf::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, 857 prio => -1000000,
858 on_instantiate => sub {
859 my ($obj, $data) = @_;
860
861 $data = from_json $data;
862
863 for (@$data) {
864 my ($name, $args) = @$_;
865
866 $obj->attach ($name, %{$args || {} });
867 }
868 },
869 on_reattach => \&reattach,
545 on_clone => sub { 870 on_clone => sub {
546 my ($src, $dst) = @_; 871 my ($src, $dst) = @_;
547 872
548 @{$dst->registry} = @{$src->registry}; 873 @{$dst->registry} = @{$src->registry};
549 874
552 %{$dst->{_attachment}} = %{$src->{_attachment}} 877 %{$dst->{_attachment}} = %{$src->{_attachment}}
553 if exists $src->{_attachment}; 878 if exists $src->{_attachment};
554 }, 879 },
555); 880);
556 881
882sub object_freezer_save {
883 my ($filename, $rdata, $objs) = @_;
884
885 sync_job {
886 if (length $$rdata) {
887 warn sprintf "saving %s (%d,%d)\n",
888 $filename, length $$rdata, scalar @$objs;
889
890 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
891 chmod SAVE_MODE, $fh;
892 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
893 aio_fsync $fh;
894 close $fh;
895
896 if (@$objs) {
897 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
898 chmod SAVE_MODE, $fh;
899 my $data = Storable::nfreeze { version => 1, objs => $objs };
900 aio_write $fh, 0, (length $data), $data, 0;
901 aio_fsync $fh;
902 close $fh;
903 aio_rename "$filename.pst~", "$filename.pst";
904 }
905 } else {
906 aio_unlink "$filename.pst";
907 }
908
909 aio_rename "$filename~", $filename;
910 } else {
911 warn "FATAL: $filename~: $!\n";
912 }
913 } else {
914 aio_unlink $filename;
915 aio_unlink "$filename.pst";
916 }
917 }
918}
919
920sub object_freezer_as_string {
921 my ($rdata, $objs) = @_;
922
923 use Data::Dumper;
924
925 $$rdata . Dumper $objs
926}
927
928sub object_thawer_load {
929 my ($filename) = @_;
930
931 my ($data, $av);
932
933 (aio_load $filename, $data) >= 0
934 or return;
935
936 unless (aio_stat "$filename.pst") {
937 (aio_load "$filename.pst", $av) >= 0
938 or return;
939 $av = eval { (Storable::thaw $av)->{objs} };
940 }
941
942 warn sprintf "loading %s (%d)\n",
943 $filename, length $data, scalar @{$av || []};#d#
944 return ($data, $av);
945}
946
557############################################################################# 947#############################################################################
558# command handling &c 948# command handling &c
559 949
560=item cf::register_command $name => \&callback($ob,$args); 950=item cf::register_command $name => \&callback($ob,$args);
561 951
583=cut 973=cut
584 974
585sub register_extcmd { 975sub register_extcmd {
586 my ($name, $cb) = @_; 976 my ($name, $cb) = @_;
587 977
588 my $caller = caller;
589 #warn "registering extcmd '$name' to '$caller'";
590
591 $EXTCMD{$name} = [$cb, $caller]; 978 $EXTCMD{$name} = $cb;
592} 979}
593 980
594cf::player->attach ( 981cf::player->attach (
595 on_command => sub { 982 on_command => sub {
596 my ($pl, $name, $params) = @_; 983 my ($pl, $name, $params) = @_;
609 996
610 my $msg = eval { from_json $buf }; 997 my $msg = eval { from_json $buf };
611 998
612 if (ref $msg) { 999 if (ref $msg) {
613 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1000 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
614 if (my %reply = $cb->[0]->($pl, $msg)) { 1001 if (my %reply = $cb->($pl, $msg)) {
615 $pl->ext_reply ($msg->{msgid}, %reply); 1002 $pl->ext_reply ($msg->{msgid}, %reply);
616 } 1003 }
617 } 1004 }
618 } else { 1005 } else {
619 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1006 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
621 1008
622 cf::override; 1009 cf::override;
623 }, 1010 },
624); 1011);
625 1012
626sub register {
627 my ($base, $pkg) = @_;
628
629 #TODO
630}
631
632sub load_extension { 1013sub load_extension {
633 my ($path) = @_; 1014 my ($path) = @_;
634 1015
635 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1016 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
636 my $base = $1; 1017 my $base = $1;
637 my $pkg = $1; 1018 my $pkg = $1;
638 $pkg =~ s/[^[:word:]]/_/g; 1019 $pkg =~ s/[^[:word:]]/_/g;
639 $pkg = "ext::$pkg"; 1020 $pkg = "ext::$pkg";
640 1021
641 warn "loading '$path' into '$pkg'\n"; 1022 warn "... loading '$path' into '$pkg'\n";
642 1023
643 open my $fh, "<:utf8", $path 1024 open my $fh, "<:utf8", $path
644 or die "$path: $!"; 1025 or die "$path: $!";
645 1026
646 my $source = 1027 my $source =
651 1032
652 eval $source 1033 eval $source
653 or die $@ ? "$path: $@\n" 1034 or die $@ ? "$path: $@\n"
654 : "extension disabled.\n"; 1035 : "extension disabled.\n";
655 1036
656 push @exts, $pkg; 1037 push @EXTS, $pkg;
657 $ext_pkg{$base} = $pkg;
658
659# no strict 'refs';
660# @{"$pkg\::ISA"} = ext::;
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# }
675
676 # remove commands
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} 1038}
701 1039
702sub load_extensions { 1040sub load_extensions {
703 for my $ext (<$LIBDIR/*.ext>) { 1041 for my $ext (<$LIBDIR/*.ext>) {
704 next unless -r $ext; 1042 next unless -r $ext;
722}; 1060};
723 1061
724cf::map->attach (prio => -10000, package => cf::mapsupport::); 1062cf::map->attach (prio => -10000, package => cf::mapsupport::);
725 1063
726############################################################################# 1064#############################################################################
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 1065
750=head2 CORE EXTENSIONS 1066=head2 CORE EXTENSIONS
751 1067
752Functions and methods that extend core crossfire objects. 1068Functions and methods that extend core crossfire objects.
753 1069
1070=cut
1071
1072package cf::player;
1073
1074use Coro::AIO;
1075
754=head3 cf::player 1076=head3 cf::player
755 1077
756=over 4 1078=over 4
757 1079
758=item cf::player::exists $login 1080=item cf::player::find $login
759 1081
760Returns true when the given account exists. 1082Returns the given player object, loading it if necessary (might block).
761 1083
762=cut 1084=cut
763 1085
764sub cf::player::exists($) { 1086sub playerdir($) {
765 cf::player::find $_[0] 1087 cf::localdir
766 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1088 . "/"
1089 . cf::playerdir
1090 . "/"
1091 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1092}
1093
1094sub path($) {
1095 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1096
1097 (playerdir $login) . "/$login.pl"
1098}
1099
1100sub find_active($) {
1101 $cf::PLAYER{$_[0]}
1102 and $cf::PLAYER{$_[0]}->active
1103 and $cf::PLAYER{$_[0]}
1104}
1105
1106sub exists($) {
1107 my ($login) = @_;
1108
1109 $cf::PLAYER{$login}
1110 or cf::sync_job { !aio_stat $login }
1111}
1112
1113sub find($) {
1114 return $cf::PLAYER{$_[0]} || do {
1115 my $login = $_[0];
1116
1117 my $guard = cf::lock_acquire "user_find:$login";
1118
1119 $cf::PLAYER{$_[0]} || do {
1120 my $pl = load_pl path $login
1121 or return;
1122 $cf::PLAYER{$login} = $pl
1123 }
1124 }
1125}
1126
1127sub save($) {
1128 my ($pl) = @_;
1129
1130 return if $pl->{deny_save};
1131
1132 my $path = path $pl;
1133 my $guard = cf::lock_acquire "user_save:$path";
1134
1135 return if $pl->{deny_save};
1136
1137 aio_mkdir playerdir $pl, 0770;
1138 $pl->{last_save} = $cf::RUNTIME;
1139
1140 $pl->save_pl ($path);
1141 Coro::cede;
1142}
1143
1144sub new($) {
1145 my ($login) = @_;
1146
1147 my $self = create;
1148
1149 $self->ob->name ($login);
1150 $self->{deny_save} = 1;
1151
1152 $cf::PLAYER{$login} = $self;
1153
1154 $self
1155}
1156
1157=item $pl->quit_character
1158
1159Nukes the player without looking back. If logged in, the connection will
1160be destroyed. May block for a long time.
1161
1162=cut
1163
1164sub quit_character {
1165 my ($pl) = @_;
1166
1167 $pl->{deny_save} = 1;
1168 $pl->password ("*"); # this should lock out the player until we nuked the dir
1169
1170 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1171 $pl->deactivate;
1172 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1173 $pl->ns->destroy if $pl->ns;
1174
1175 my $path = playerdir $pl;
1176 my $temp = "$path~$cf::RUNTIME~deleting~";
1177 aio_rename $path, $temp;
1178 delete $cf::PLAYER{$pl->ob->name};
1179 $pl->destroy;
1180 IO::AIO::aio_rmtree $temp;
1181}
1182
1183=item cf::player::list_logins
1184
1185Returns am arrayref of all valid playernames in the system, can take a
1186while and may block, so not sync_job-capable, ever.
1187
1188=cut
1189
1190sub list_logins {
1191 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1192 or return [];
1193
1194 my @logins;
1195
1196 for my $login (@$dirs) {
1197 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1198 aio_read $fh, 0, 512, my $buf, 0 or next;
1199 $buf !~ /^password -------------$/m or next; # official not-valid tag
1200
1201 utf8::decode $login;
1202 push @logins, $login;
1203 }
1204
1205 \@logins
1206}
1207
1208=item $player->maps
1209
1210Returns an arrayref of cf::path's of all maps that are private for this
1211player. May block.
1212
1213=cut
1214
1215sub maps($) {
1216 my ($pl) = @_;
1217
1218 my $files = aio_readdir playerdir $pl
1219 or return;
1220
1221 my @paths;
1222
1223 for (@$files) {
1224 utf8::decode $_;
1225 next if /\.(?:pl|pst)$/;
1226 next unless /^$PATH_SEP/o;
1227
1228 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
1229 }
1230
1231 \@paths
767} 1232}
768 1233
769=item $player->ext_reply ($msgid, $msgtype, %msg) 1234=item $player->ext_reply ($msgid, $msgtype, %msg)
770 1235
771Sends an ext reply to the player. 1236Sends an ext reply to the player.
772 1237
773=cut 1238=cut
774 1239
775sub cf::player::ext_reply($$$%) { 1240sub ext_reply($$$%) {
776 my ($self, $id, %msg) = @_; 1241 my ($self, $id, %msg) = @_;
777 1242
778 $msg{msgid} = $id; 1243 $msg{msgid} = $id;
779 1244
780 $self->send ("ext " . to_json \%msg); 1245 $self->send ("ext " . cf::to_json \%msg);
781} 1246}
1247
1248package cf;
1249
1250=back
1251
1252
1253=head3 cf::map
1254
1255=over 4
1256
1257=cut
1258
1259package cf::map;
1260
1261use Fcntl;
1262use Coro::AIO;
1263
1264our $MAX_RESET = 3600;
1265our $DEFAULT_RESET = 3000;
1266
1267sub generate_random_map {
1268 my ($path, $rmp) = @_;
1269
1270 # mit "rum" bekleckern, nicht
1271 cf::map::_create_random_map (
1272 $path,
1273 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1274 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1275 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1276 $rmp->{exit_on_final_map},
1277 $rmp->{xsize}, $rmp->{ysize},
1278 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1279 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1280 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1281 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1282 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1283 (cf::region::find $rmp->{region}), $rmp->{custom}
1284 )
1285}
1286
1287# and all this just because we cannot iterate over
1288# all maps in C++...
1289sub change_all_map_light {
1290 my ($change) = @_;
1291
1292 $_->change_map_light ($change)
1293 for grep $_->outdoor, values %cf::MAP;
1294}
1295
1296sub load_map_header($) {
1297 my ($path) = @_;
1298
1299 utf8::encode $path;
1300 aio_open $path, O_RDONLY, 0
1301 or return;
1302
1303 my $map = cf::map::new
1304 or return;
1305
1306 # for better error messages only, will be overwritten later
1307 $map->path ($path);
1308
1309 $map->load_header ($path)
1310 or return;
1311
1312 $map->{load_path} = $path;
1313
1314 $map
1315}
1316
1317sub find;
1318sub find {
1319 my ($path, $origin) = @_;
1320
1321 #warn "find<$path,$origin>\n";#d#
1322
1323 $path = new cf::path $path, $origin && $origin->path;
1324 my $key = $path->as_string;
1325
1326 cf::lock_wait "map_find:$key";
1327
1328 $cf::MAP{$key} || do {
1329 my $guard = cf::lock_acquire "map_find:$key";
1330
1331 # do it the slow way
1332 my $map = $path->load_temp;
1333
1334 Coro::cede;
1335
1336 if ($map) {
1337 $map->last_access ((delete $map->{last_access})
1338 || $cf::RUNTIME); #d#
1339 # safety
1340 $map->{instantiate_time} = $cf::RUNTIME
1341 if $map->{instantiate_time} > $cf::RUNTIME;
1342 } else {
1343 $map = $path->load_orig
1344 or return;
1345
1346 $map->{load_original} = 1;
1347 $map->{instantiate_time} = $cf::RUNTIME;
1348 $map->last_access ($cf::RUNTIME);
1349 $map->instantiate;
1350
1351 # per-player maps become, after loading, normal maps
1352 $map->per_player (0) if $path->{user_rel};
1353 }
1354
1355 $map->path ($key);
1356 $map->{path} = $path;
1357 $map->{last_save} = $cf::RUNTIME;
1358
1359 Coro::cede;
1360
1361 if ($map->should_reset) {
1362 $map->reset;
1363 undef $guard;
1364 $map = find $path
1365 or return;
1366 }
1367
1368 $cf::MAP{$key} = $map
1369 }
1370}
1371
1372sub load {
1373 my ($self) = @_;
1374
1375 my $path = $self->{path};
1376 my $guard = cf::lock_acquire "map_load:" . $path->as_string;
1377
1378 return if $self->in_memory != cf::MAP_SWAPPED;
1379
1380 $self->in_memory (cf::MAP_LOADING);
1381
1382 $self->alloc;
1383 $self->load_objects ($self->{load_path}, 1)
1384 or return;
1385
1386 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1387 if delete $self->{load_original};
1388
1389 if (my $uniq = $path->uniq_path) {
1390 utf8::encode $uniq;
1391 if (aio_open $uniq, O_RDONLY, 0) {
1392 $self->clear_unique_items;
1393 $self->load_objects ($uniq, 0);
1394 }
1395 }
1396
1397 Coro::cede;
1398
1399 # now do the right thing for maps
1400 $self->link_multipart_objects;
1401
1402 if ($self->{path}->is_style_map) {
1403 $self->{deny_save} = 1;
1404 $self->{deny_reset} = 1;
1405 } else {
1406 $self->fix_auto_apply;
1407 $self->decay_objects;
1408 $self->update_buttons;
1409 $self->set_darkness_map;
1410 $self->difficulty ($self->estimate_difficulty)
1411 unless $self->difficulty;
1412 $self->activate;
1413 }
1414
1415 Coro::cede;
1416
1417 $self->in_memory (cf::MAP_IN_MEMORY);
1418}
1419
1420# find and load all maps in the 3x3 area around a map
1421sub load_diag {
1422 my ($map) = @_;
1423
1424 my @diag; # diagonal neighbours
1425
1426 for (0 .. 3) {
1427 my $neigh = $map->tile_path ($_)
1428 or next;
1429 $neigh = find $neigh, $map
1430 or next;
1431 $neigh->load;
1432
1433 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1434 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1435 }
1436
1437 for (@diag) {
1438 my $neigh = find @$_
1439 or next;
1440 $neigh->load;
1441 }
1442}
1443
1444sub find_sync {
1445 my ($path, $origin) = @_;
1446
1447 cf::sync_job { find $path, $origin }
1448}
1449
1450sub do_load_sync {
1451 my ($map) = @_;
1452
1453 cf::sync_job { $map->load };
1454}
1455
1456our %MAP_PREFETCH;
1457our $MAP_PREFETCHER = Coro::async {
1458 while () {
1459 while (%MAP_PREFETCH) {
1460 my $key = each %MAP_PREFETCH
1461 or next;
1462 my $path = delete $MAP_PREFETCH{$key};
1463
1464 my $map = find $path
1465 or next;
1466 $map->load;
1467 }
1468 Coro::schedule;
1469 }
1470};
1471
1472sub find_async {
1473 my ($path, $origin) = @_;
1474
1475 $path = new cf::path $path, $origin && $origin->path;
1476 my $key = $path->as_string;
1477
1478 if (my $map = $cf::MAP{$key}) {
1479 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1480 }
1481
1482 $MAP_PREFETCH{$key} = $path;
1483 $MAP_PREFETCHER->ready;
1484
1485 ()
1486}
1487
1488sub save {
1489 my ($self) = @_;
1490
1491 my $lock = cf::lock_acquire "map_data:" . $self->path;
1492
1493 $self->{last_save} = $cf::RUNTIME;
1494
1495 return unless $self->dirty;
1496
1497 my $save = $self->{path}->save_path; utf8::encode $save;
1498 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1499
1500 $self->{load_path} = $save;
1501
1502 return if $self->{deny_save};
1503
1504 local $self->{last_access} = $self->last_access;#d#
1505
1506 cf::async {
1507 $_->contr->save for $self->players;
1508 };
1509
1510 if ($uniq) {
1511 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1512 $self->save_objects ($uniq, cf::IO_UNIQUES);
1513 } else {
1514 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1515 }
1516}
1517
1518sub swap_out {
1519 my ($self) = @_;
1520
1521 # save first because save cedes
1522 $self->save;
1523
1524 my $lock = cf::lock_acquire "map_data:" . $self->path;
1525
1526 return if $self->players;
1527 return if $self->in_memory != cf::MAP_IN_MEMORY;
1528 return if $self->{deny_save};
1529
1530 $self->clear;
1531 $self->in_memory (cf::MAP_SWAPPED);
1532}
1533
1534sub reset_at {
1535 my ($self) = @_;
1536
1537 # TODO: safety, remove and allow resettable per-player maps
1538 return 1e99 if $self->{path}{user_rel};
1539 return 1e99 if $self->{deny_reset};
1540
1541 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1542 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1543
1544 $time + $to
1545}
1546
1547sub should_reset {
1548 my ($self) = @_;
1549
1550 $self->reset_at <= $cf::RUNTIME
1551}
1552
1553sub unlink_save {
1554 my ($self) = @_;
1555
1556 utf8::encode (my $save = $self->{path}->save_path);
1557 aioreq_pri 3; IO::AIO::aio_unlink $save;
1558 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1559}
1560
1561sub rename {
1562 my ($self, $new_path) = @_;
1563
1564 $self->unlink_save;
1565
1566 delete $cf::MAP{$self->path};
1567 $self->{path} = new cf::path $new_path;
1568 $self->path ($self->{path}->as_string);
1569 $cf::MAP{$self->path} = $self;
1570
1571 $self->save;
1572}
1573
1574sub reset {
1575 my ($self) = @_;
1576
1577 my $lock = cf::lock_acquire "map_data:" . $self->path;
1578
1579 return if $self->players;
1580 return if $self->{path}{user_rel};#d#
1581
1582 warn "resetting map ", $self->path;#d#
1583
1584 delete $cf::MAP{$self->path};
1585
1586 $_->clear_links_to ($self) for values %cf::MAP;
1587
1588 $self->unlink_save;
1589 $self->destroy;
1590}
1591
1592my $nuke_counter = "aaaa";
1593
1594sub nuke {
1595 my ($self) = @_;
1596
1597 $self->{deny_save} = 1;
1598 $self->reset_timeout (1);
1599 $self->rename ("{nuke}/" . ($nuke_counter++));
1600 $self->reset; # polite request, might not happen
1601}
1602
1603sub customise_for {
1604 my ($map, $ob) = @_;
1605
1606 if ($map->per_player) {
1607 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
1608 }
1609
1610 $map
1611}
1612
1613=item cf::map::unique_maps
1614
1615Returns an arrayref of cf::path's of all shared maps that have
1616instantiated unique items. May block.
1617
1618=cut
1619
1620sub unique_maps() {
1621 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1622 or return;
1623
1624 my @paths;
1625
1626 for (@$files) {
1627 utf8::decode $_;
1628 next if /\.pst$/;
1629 next unless /^$PATH_SEP/o;
1630
1631 push @paths, new cf::path $_;
1632 }
1633
1634 \@paths
1635}
1636
1637package cf;
1638
1639=back
1640
1641=head3 cf::object
1642
1643=cut
1644
1645package cf::object;
1646
1647=over 4
1648
1649=item $ob->inv_recursive
1650
1651Returns the inventory of the object _and_ their inventories, recursively.
1652
1653=cut
1654
1655sub inv_recursive_;
1656sub inv_recursive_ {
1657 map { $_, inv_recursive_ $_->inv } @_
1658}
1659
1660sub inv_recursive {
1661 inv_recursive_ inv $_[0]
1662}
1663
1664package cf;
782 1665
783=back 1666=back
784 1667
785=head3 cf::object::player 1668=head3 cf::object::player
786 1669
824 (ref $cf::CFG{"may_$access"} 1707 (ref $cf::CFG{"may_$access"}
825 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1708 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826 : $cf::CFG{"may_$access"}) 1709 : $cf::CFG{"may_$access"})
827} 1710}
828 1711
1712=item $player_object->enter_link
1713
1714Freezes the player and moves him/her to a special map (C<{link}>).
1715
1716The player should be reaosnably safe there for short amounts of time. You
1717I<MUST> call C<leave_link> as soon as possible, though.
1718
1719=item $player_object->leave_link ($map, $x, $y)
1720
1721Moves the player out of the specila link map onto the given map. If the
1722map is not valid (or omitted), the player will be moved back to the
1723location he/she was before the call to C<enter_link>, or, if that fails,
1724to the emergency map position.
1725
1726Might block.
1727
1728=cut
1729
1730sub cf::object::player::enter_link {
1731 my ($self) = @_;
1732
1733 $self->deactivate_recursive;
1734
1735 return if $self->map == $LINK_MAP;
1736
1737 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1738 if $self->map;
1739
1740 $self->enter_map ($LINK_MAP, 20, 20);
1741}
1742
1743sub cf::object::player::leave_link {
1744 my ($self, $map, $x, $y) = @_;
1745
1746 my $link_pos = delete $self->{_link_pos};
1747
1748 unless ($map) {
1749 # restore original map position
1750 ($map, $x, $y) = @{ $link_pos || [] };
1751 $map = cf::map::find $map;
1752
1753 unless ($map) {
1754 ($map, $x, $y) = @$EMERGENCY_POSITION;
1755 $map = cf::map::find $map
1756 or die "FATAL: cannot load emergency map\n";
1757 }
1758 }
1759
1760 ($x, $y) = (-1, -1)
1761 unless (defined $x) && (defined $y);
1762
1763 # use -1 or undef as default coordinates, not 0, 0
1764 ($x, $y) = ($map->enter_x, $map->enter_y)
1765 if $x <=0 && $y <= 0;
1766
1767 $map->load;
1768 $map->load_diag;
1769
1770 return unless $self->contr->active;
1771 $self->activate_recursive;
1772 $self->enter_map ($map, $x, $y);
1773}
1774
1775cf::player->attach (
1776 on_logout => sub {
1777 my ($pl) = @_;
1778
1779 # abort map switching before logout
1780 if ($pl->ob->{_link_pos}) {
1781 cf::sync_job {
1782 $pl->ob->leave_link
1783 };
1784 }
1785 },
1786 on_login => sub {
1787 my ($pl) = @_;
1788
1789 # try to abort aborted map switching on player login :)
1790 # should happen only on crashes
1791 if ($pl->ob->{_link_pos}) {
1792 $pl->ob->enter_link;
1793 (async {
1794 # we need this sleep as the login has a concurrent enter_exit running
1795 # and this sleep increases chances of the player not ending up in scorn
1796 $pl->ob->reply (undef,
1797 "There was an internal problem at your last logout, "
1798 . "the server will try to bring you to your intended destination in a second.",
1799 cf::NDI_RED);
1800 Coro::Timer::sleep 1;
1801 $pl->ob->leave_link;
1802 })->prio (2);
1803 }
1804 },
1805);
1806
1807=item $player_object->goto ($path, $x, $y)
1808
1809=cut
1810
1811sub cf::object::player::goto {
1812 my ($self, $path, $x, $y) = @_;
1813
1814 $path = new cf::path $path;
1815
1816 $self->enter_link;
1817
1818 (async {
1819 my $map = cf::map::find $path->as_string;
1820 $map = $map->customise_for ($self) if $map;
1821
1822# warn "entering ", $map->path, " at ($x, $y)\n"
1823# if $map;
1824
1825 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1826
1827 $self->leave_link ($map, $x, $y);
1828 })->prio (1);
1829}
1830
1831=item $player_object->enter_exit ($exit_object)
1832
1833=cut
1834
1835sub parse_random_map_params {
1836 my ($spec) = @_;
1837
1838 my $rmp = { # defaults
1839 xsize => 10,
1840 ysize => 10,
1841 };
1842
1843 for (split /\n/, $spec) {
1844 my ($k, $v) = split /\s+/, $_, 2;
1845
1846 $rmp->{lc $k} = $v if (length $k) && (length $v);
1847 }
1848
1849 $rmp
1850}
1851
1852sub prepare_random_map {
1853 my ($exit) = @_;
1854
1855 # all this does is basically replace the /! path by
1856 # a new random map path (?random/...) with a seed
1857 # that depends on the exit object
1858
1859 my $rmp = parse_random_map_params $exit->msg;
1860
1861 if ($exit->map) {
1862 $rmp->{region} = $exit->map->region_name;
1863 $rmp->{origin_map} = $exit->map->path;
1864 $rmp->{origin_x} = $exit->x;
1865 $rmp->{origin_y} = $exit->y;
1866 }
1867
1868 $rmp->{random_seed} ||= $exit->random_seed;
1869
1870 my $data = cf::to_json $rmp;
1871 my $md5 = Digest::MD5::md5_hex $data;
1872
1873 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1874 aio_write $fh, 0, (length $data), $data, 0;
1875
1876 $exit->slaying ("?random/$md5");
1877 $exit->msg (undef);
1878 }
1879}
1880
1881sub cf::object::player::enter_exit {
1882 my ($self, $exit) = @_;
1883
1884 return unless $self->type == cf::PLAYER;
1885
1886 $self->enter_link;
1887
1888 (async {
1889 $self->deactivate_recursive; # just to be sure
1890 unless (eval {
1891 prepare_random_map $exit
1892 if $exit->slaying eq "/!";
1893
1894 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1895 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1896
1897 1;
1898 }) {
1899 $self->message ("Something went wrong deep within the crossfire server. "
1900 . "I'll try to bring you back to the map you were before. "
1901 . "Please report this to the dungeon master!",
1902 cf::NDI_UNIQUE | cf::NDI_RED);
1903
1904 warn "ERROR in enter_exit: $@";
1905 $self->leave_link;
1906 }
1907 })->prio (1);
1908}
1909
829=head3 cf::client 1910=head3 cf::client
830 1911
831=over 4 1912=over 4
832 1913
833=item $client->send_drawinfo ($text, $flags) 1914=item $client->send_drawinfo ($text, $flags)
876 on_reply => sub { 1957 on_reply => sub {
877 my ($ns, $msg) = @_; 1958 my ($ns, $msg) = @_;
878 1959
879 # this weird shuffling is so that direct followup queries 1960 # this weird shuffling is so that direct followup queries
880 # get handled first 1961 # get handled first
881 my $queue = delete $ns->{query_queue}; 1962 my $queue = delete $ns->{query_queue}
1963 or return; # be conservative, not sure how that can happen, but we saw a crash here
882 1964
883 (shift @$queue)->[1]->($msg); 1965 (shift @$queue)->[1]->($msg);
884 1966
885 push @{ $ns->{query_queue} }, @$queue; 1967 push @{ $ns->{query_queue} }, @$queue;
886 1968
887 if (@{ $ns->{query_queue} } == @$queue) { 1969 if (@{ $ns->{query_queue} } == @$queue) {
888 if (@$queue) { 1970 if (@$queue) {
889 $ns->send_packet ($ns->{query_queue}[0][0]); 1971 $ns->send_packet ($ns->{query_queue}[0][0]);
890 } else { 1972 } else {
891 $ns->state (ST_PLAYING); 1973 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
892 } 1974 }
893 } 1975 }
894 }, 1976 },
895); 1977);
896 1978
897=item $client->coro (\&cb) 1979=item $client->async (\&cb)
898 1980
899Create a new coroutine, running the specified callback. The coroutine will 1981Create a new coroutine, running the specified callback. The coroutine will
900be automatically cancelled when the client gets destroyed (e.g. on logout, 1982be automatically cancelled when the client gets destroyed (e.g. on logout,
901or loss of connection). 1983or loss of connection).
902 1984
903=cut 1985=cut
904 1986
905sub cf::client::coro { 1987sub cf::client::async {
906 my ($self, $cb) = @_; 1988 my ($self, $cb) = @_;
907 1989
908 my $coro; $coro = async { 1990 my $coro = &Coro::async ($cb);
909 eval { 1991
910 $cb->(); 1992 $coro->on_destroy (sub {
911 };
912 warn $@ if $@;
913 delete $self->{_coro}{$coro+0}; 1993 delete $self->{_coro}{$coro+0};
914 }; 1994 });
915 1995
916 $self->{_coro}{$coro+0} = $coro; 1996 $self->{_coro}{$coro+0} = $coro;
1997
1998 $coro
917} 1999}
918 2000
919cf::client->attach ( 2001cf::client->attach (
920 on_destroy => sub { 2002 on_destroy => sub {
921 my ($ns) = @_; 2003 my ($ns) = @_;
1085 2167
1086{ 2168{
1087 my $path = cf::localdir . "/database.pst"; 2169 my $path = cf::localdir . "/database.pst";
1088 2170
1089 sub db_load() { 2171 sub db_load() {
1090 warn "loading database $path\n";#d# remove later
1091 $DB = stat $path ? Storable::retrieve $path : { }; 2172 $DB = stat $path ? Storable::retrieve $path : { };
1092 } 2173 }
1093 2174
1094 my $pid; 2175 my $pid;
1095 2176
1096 sub db_save() { 2177 sub db_save() {
1097 warn "saving database $path\n";#d# remove later
1098 waitpid $pid, 0 if $pid; 2178 waitpid $pid, 0 if $pid;
1099 if (0 == ($pid = fork)) { 2179 if (0 == ($pid = fork)) {
1100 $DB->{_meta}{version} = 1; 2180 $DB->{_meta}{version} = 1;
1101 Storable::nstore $DB, "$path~"; 2181 Storable::nstore $DB, "$path~";
1102 rename "$path~", $path; 2182 rename "$path~", $path;
1150 open my $fh, "<:utf8", cf::confdir . "/config" 2230 open my $fh, "<:utf8", cf::confdir . "/config"
1151 or return; 2231 or return;
1152 2232
1153 local $/; 2233 local $/;
1154 *CFG = YAML::Syck::Load <$fh>; 2234 *CFG = YAML::Syck::Load <$fh>;
2235
2236 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2237
2238 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2239 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2240
2241 if (exists $CFG{mlockall}) {
2242 eval {
2243 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2244 and die "WARNING: m(un)lockall failed: $!\n";
2245 };
2246 warn $@ if $@;
2247 }
1155} 2248}
1156 2249
1157sub main { 2250sub main {
2251 # we must not ever block the main coroutine
2252 local $Coro::idle = sub {
2253 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2254 async { Event::one_event };
2255 };
2256
1158 cfg_load; 2257 cfg_load;
1159 db_load; 2258 db_load;
1160 load_extensions; 2259 load_extensions;
1161 Event::loop; 2260 Event::loop;
1162} 2261}
1163 2262
1164############################################################################# 2263#############################################################################
1165# initialisation 2264# initialisation and cleanup
1166 2265
2266# install some emergency cleanup handlers
2267BEGIN {
2268 for my $signal (qw(INT HUP TERM)) {
2269 Event->signal (
2270 data => WF_AUTOCANCEL,
2271 signal => $signal,
2272 cb => sub {
2273 cf::cleanup "SIG$signal";
2274 },
2275 );
2276 }
2277}
2278
2279sub emergency_save() {
2280 my $freeze_guard = cf::freeze_mainloop;
2281
2282 warn "enter emergency perl save\n";
2283
2284 cf::sync_job {
2285 # use a peculiar iteration method to avoid tripping on perl
2286 # refcount bugs in for. also avoids problems with players
2287 # and maps saved/Destroyed asynchronously.
2288 warn "begin emergency player save\n";
2289 for my $login (keys %cf::PLAYER) {
2290 my $pl = $cf::PLAYER{$login} or next;
2291 $pl->valid or next;
2292 $pl->save;
2293 }
2294 warn "end emergency player save\n";
2295
2296 warn "begin emergency map save\n";
2297 for my $path (keys %cf::MAP) {
2298 my $map = $cf::MAP{$path} or next;
2299 $map->valid or next;
2300 $map->save;
2301 }
2302 warn "end emergency map save\n";
2303 };
2304
2305 warn "leave emergency perl save\n";
2306}
2307
1167sub _perl_reload(&) { 2308sub reload() {
1168 my ($msg) = @_; 2309 # can/must only be called in main
2310 if ($Coro::current != $Coro::main) {
2311 warn "can only reload from main coroutine\n";
2312 return;
2313 }
1169 2314
1170 $msg->("reloading..."); 2315 warn "reloading...";
2316
2317 warn "freezing server";
2318 my $guard = freeze_mainloop;
2319 cf::emergency_save;
2320
2321 warn "sync database to disk";
2322 cf::db_sync;
2323 IO::AIO::flush;
1171 2324
1172 eval { 2325 eval {
2326 # if anything goes wrong in here, we should simply crash as we already saved
2327
1173 # cancel all watchers 2328 warn "cancel all watchers";
1174 for (Event::all_watchers) { 2329 for (Event::all_watchers) {
1175 $_->cancel if $_->data & WF_AUTOCANCEL; 2330 $_->cancel if $_->data & WF_AUTOCANCEL;
1176 } 2331 }
1177 2332
2333 warn "cancel all extension coros";
2334 $_->cancel for values %EXT_CORO;
2335 %EXT_CORO = ();
2336
2337 warn "remove commands";
2338 %COMMAND = ();
2339
2340 warn "remove ext commands";
2341 %EXTCMD = ();
2342
1178 # unload all extensions 2343 warn "unload/nuke all extensions";
1179 for (@exts) { 2344 for my $pkg (@EXTS) {
1180 $msg->("unloading <$_>"); 2345 warn "... unloading $pkg";
1181 unload_extension $_; 2346
2347 if (my $cb = $pkg->can ("unload")) {
2348 eval {
2349 $cb->($pkg);
2350 1
2351 } or warn "$pkg unloaded, but with errors: $@";
1182 } 2352 }
1183 2353
2354 warn "... nuking $pkg";
2355 Symbol::delete_package $pkg;
2356 }
2357
1184 # unload all modules loaded from $LIBDIR 2358 warn "unload all perl modules loaded from $LIBDIR";
1185 while (my ($k, $v) = each %INC) { 2359 while (my ($k, $v) = each %INC) {
1186 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2360 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1187 2361
1188 $msg->("removing <$k>"); 2362 warn "removing <$k>";
1189 delete $INC{$k}; 2363 delete $INC{$k};
1190 2364
1191 $k =~ s/\.pm$//; 2365 $k =~ s/\.pm$//;
1192 $k =~ s/\//::/g; 2366 $k =~ s/\//::/g;
1193 2367
1196 } 2370 }
1197 2371
1198 Symbol::delete_package $k; 2372 Symbol::delete_package $k;
1199 } 2373 }
1200 2374
1201 # sync database to disk
1202 cf::db_sync;
1203
1204 # get rid of safe::, as good as possible 2375 warn "get rid of safe::, as good as possible";
1205 Symbol::delete_package "safe::$_" 2376 Symbol::delete_package "safe::$_"
1206 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2377 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1207 2378
1208 # remove register_script_function callbacks
1209 # TODO
1210
1211 # unload cf.pm "a bit" 2379 warn "unload cf.pm \"a bit\"";
1212 delete $INC{"cf.pm"}; 2380 delete $INC{"cf.pm"};
1213 2381
1214 # don't, removes xs symbols, too, 2382 # don't, removes xs symbols, too,
1215 # and global variables created in xs 2383 # and global variables created in xs
1216 #Symbol::delete_package __PACKAGE__; 2384 #Symbol::delete_package __PACKAGE__;
1217 2385
1218 # reload cf.pm
1219 $msg->("reloading cf.pm"); 2386 warn "reloading cf.pm";
1220 require cf; 2387 require cf;
2388 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1221 2389
1222 # load config and database again 2390 warn "load config and database again";
1223 cf::cfg_load; 2391 cf::cfg_load;
1224 cf::db_load; 2392 cf::db_load;
1225 2393
1226 # load extensions 2394 warn "load extensions";
1227 $msg->("load extensions");
1228 cf::load_extensions; 2395 cf::load_extensions;
1229 2396
1230 # reattach attachments to objects 2397 warn "reattach attachments to objects/players";
1231 $msg->("reattach");
1232 _global_reattach; 2398 _global_reattach;
2399 warn "reattach attachments to maps";
2400 reattach $_ for values %MAP;
1233 }; 2401 };
1234 $msg->($@) if $@;
1235 2402
1236 $msg->("reloaded"); 2403 if ($@) {
2404 warn $@;
2405 warn "error while reloading, exiting.";
2406 exit 1;
2407 }
2408
2409 warn "reloaded";
1237}; 2410};
1238 2411
1239sub perl_reload() { 2412#############################################################################
1240 _perl_reload {
1241 warn $_[0];
1242 print "$_[0]\n";
1243 };
1244}
1245 2413
1246register "<global>", __PACKAGE__; 2414unless ($LINK_MAP) {
2415 $LINK_MAP = cf::map::new;
1247 2416
2417 $LINK_MAP->width (41);
2418 $LINK_MAP->height (41);
2419 $LINK_MAP->alloc;
2420 $LINK_MAP->path ("{link}");
2421 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2422 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2423
2424 # dirty hack because... archetypes are not yet loaded
2425 Event->timer (
2426 after => 10,
2427 cb => sub {
2428 $_[0]->w->cancel;
2429
2430 # provide some exits "home"
2431 my $exit = cf::object::new "exit";
2432
2433 $exit->slaying ($EMERGENCY_POSITION->[0]);
2434 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2435 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2436
2437 $LINK_MAP->insert ($exit->clone, 19, 19);
2438 $LINK_MAP->insert ($exit->clone, 19, 20);
2439 $LINK_MAP->insert ($exit->clone, 19, 21);
2440 $LINK_MAP->insert ($exit->clone, 20, 19);
2441 $LINK_MAP->insert ($exit->clone, 20, 21);
2442 $LINK_MAP->insert ($exit->clone, 21, 19);
2443 $LINK_MAP->insert ($exit->clone, 21, 20);
2444 $LINK_MAP->insert ($exit->clone, 21, 21);
2445
2446 $exit->destroy;
2447 });
2448
2449 $LINK_MAP->{deny_save} = 1;
2450 $LINK_MAP->{deny_reset} = 1;
2451
2452 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2453}
2454
1248register_command "perl-reload" => sub { 2455register_command "reload" => sub {
1249 my ($who, $arg) = @_; 2456 my ($who, $arg) = @_;
1250 2457
1251 if ($who->flag (FLAG_WIZ)) { 2458 if ($who->flag (FLAG_WIZ)) {
1252 _perl_reload { 2459 $who->message ("start of reload.");
1253 warn $_[0]; 2460 reload;
1254 $who->message ($_[0]); 2461 $who->message ("end of reload.");
1255 };
1256 } 2462 }
1257}; 2463};
1258 2464
1259unshift @INC, $LIBDIR; 2465unshift @INC, $LIBDIR;
1260 2466
1261$TICK_WATCHER = Event->timer ( 2467$TICK_WATCHER = Event->timer (
2468 reentrant => 0,
1262 prio => 0, 2469 prio => 0,
1263 at => $NEXT_TICK || 1, 2470 at => $NEXT_TICK || $TICK,
1264 data => WF_AUTOCANCEL, 2471 data => WF_AUTOCANCEL,
1265 cb => sub { 2472 cb => sub {
2473 $NOW = Event::time;
2474
1266 cf::server_tick; # one server iteration 2475 cf::server_tick; # one server iteration
1267 2476 $RUNTIME += $TICK;
1268 my $NOW = Event::time;
1269 $NEXT_TICK += $TICK; 2477 $NEXT_TICK += $TICK;
1270 2478
2479 $WAIT_FOR_TICK->broadcast;
2480 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2481
1271 # if we are delayed by four ticks or more, skip them all 2482 # if we are delayed by four ticks or more, skip them all
1272 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2483 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1273 2484
1274 $TICK_WATCHER->at ($NEXT_TICK); 2485 $TICK_WATCHER->at ($NEXT_TICK);
1275 $TICK_WATCHER->start; 2486 $TICK_WATCHER->start;
1276 }, 2487 },
1277); 2488);
1278 2489
1279IO::AIO::max_poll_time $TICK * 0.2; 2490IO::AIO::max_poll_time $TICK * 0.2;
1280 2491
2492Event->io (
1281Event->io (fd => IO::AIO::poll_fileno, 2493 fd => IO::AIO::poll_fileno,
1282 poll => 'r', 2494 poll => 'r',
1283 prio => 5, 2495 prio => 5,
1284 data => WF_AUTOCANCEL, 2496 data => WF_AUTOCANCEL,
1285 cb => \&IO::AIO::poll_cb); 2497 cb => \&IO::AIO::poll_cb,
2498);
2499
2500Event->timer (
2501 data => WF_AUTOCANCEL,
2502 after => 0,
2503 interval => 10,
2504 cb => sub {
2505 (Coro::unblock_sub {
2506 write_runtime
2507 or warn "ERROR: unable to write runtime file: $!";
2508 })->();
2509 },
2510);
2511
2512END { cf::emergency_save }
1286 2513
12871 25141
1288 2515

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines