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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines