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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines