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.94 by root, Thu Dec 21 23:02:54 2006 UTC vs.
Revision 1.156 by root, Tue Jan 9 22:07:08 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Storable;
6use Opcode; 9use Opcode;
7use Safe; 10use Safe;
8use Safe::Hole; 11use Safe::Hole;
9 12
13use Coro 3.3 ();
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18use Coro::AIO;
19
20use Data::Dumper;
21use Digest::MD5;
22use Fcntl;
10use IO::AIO (); 23use IO::AIO 2.32 ();
11use YAML::Syck (); 24use YAML::Syck ();
12use Time::HiRes; 25use Time::HiRes;
13use Event; 26
14$Event::Eval = 1; # no idea why this is required, but it is 27use Event; $Event::Eval = 1; # no idea why this is required, but it is
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15 30
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1; 32$YAML::Syck::ImplicitUnicode = 1;
18 33
19use strict; 34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 35
23our %COMMAND = (); 36our %COMMAND = ();
24our %COMMAND_TIME = (); 37our %COMMAND_TIME = ();
25our %EXTCMD = (); 38our %EXTCMD = ();
26 39
27_init_vars;
28
29our @EVENT; 40our @EVENT;
30our $LIBDIR = datadir . "/ext"; 41our $LIBDIR = datadir . "/ext";
31 42
32our $TICK = MAX_TIME * 1e-6; 43our $TICK = MAX_TIME * 1e-6;
33our $TICK_WATCHER; 44our $TICK_WATCHER;
34our $NEXT_TICK; 45our $NEXT_TICK;
46our $NOW;
35 47
36our %CFG; 48our %CFG;
37 49
38our $UPTIME; $UPTIME ||= time; 50our $UPTIME; $UPTIME ||= time;
51our $RUNTIME;
52
53our %PLAYER; # all users
54our %MAP; # all maps
55our $LINK_MAP; # the special {link} map
56our $RANDOM_MAPS = cf::localdir . "/random";
57our %EXT_CORO; # coroutines bound to extensions
58
59our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
60our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
61
62binmode STDOUT;
63binmode STDERR;
64
65# read virtual server time, if available
66unless ($RUNTIME || !-e cf::localdir . "/runtime") {
67 open my $fh, "<", cf::localdir . "/runtime"
68 or die "unable to read runtime file: $!";
69 $RUNTIME = <$fh> + 0.;
70}
71
72mkdir cf::localdir;
73mkdir cf::localdir . "/" . cf::playerdir;
74mkdir cf::localdir . "/" . cf::tmpdir;
75mkdir cf::localdir . "/" . cf::uniquedir;
76mkdir $RANDOM_MAPS;
77
78# a special map that is always available
79our $LINK_MAP;
80our $EMERGENCY_POSITION;
39 81
40############################################################################# 82#############################################################################
41 83
42=head2 GLOBAL VARIABLES 84=head2 GLOBAL VARIABLES
43 85
44=over 4 86=over 4
45 87
46=item $cf::UPTIME 88=item $cf::UPTIME
47 89
48The timestamp of the server start (so not actually an uptime). 90The timestamp of the server start (so not actually an uptime).
91
92=item $cf::RUNTIME
93
94The time this server has run, starts at 0 and is increased by $cf::TICK on
95every server tick.
49 96
50=item $cf::LIBDIR 97=item $cf::LIBDIR
51 98
52The perl library directory, where extensions and cf-specific modules can 99The perl library directory, where extensions and cf-specific modules can
53be found. It will be added to C<@INC> automatically. 100be found. It will be added to C<@INC> automatically.
54 101
102=item $cf::NOW
103
104The time of the last (current) server tick.
105
55=item $cf::TICK 106=item $cf::TICK
56 107
57The interval between server ticks, in seconds. 108The interval between server ticks, in seconds.
58 109
59=item %cf::CFG 110=item %cf::CFG
60 111
61Configuration for the server, loaded from C</etc/crossfire/config>, or 112Configuration for the server, loaded from C</etc/crossfire/config>, or
62from wherever your confdir points to. 113from wherever your confdir points to.
114
115=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
116
117These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
118or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
119processing has been done. Call C<< ->wait >> on them to maximise the
120window of cpu time available, or simply to synchronise to the server tick.
63 121
64=back 122=back
65 123
66=cut 124=cut
67 125
68BEGIN { 126BEGIN {
69 *CORE::GLOBAL::warn = sub { 127 *CORE::GLOBAL::warn = sub {
70 my $msg = join "", @_; 128 my $msg = join "", @_;
129 utf8::encode $msg;
130
71 $msg .= "\n" 131 $msg .= "\n"
72 unless $msg =~ /\n$/; 132 unless $msg =~ /\n$/;
73 133
74 print STDERR "cfperl: $msg";
75 LOG llevError, "cfperl: $msg"; 134 LOG llevError, $msg;
76 }; 135 };
77} 136}
78 137
79@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 138@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 139@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
84@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 143@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
85 144
86# we bless all objects into (empty) derived classes to force a method lookup 145# we bless all objects into (empty) derived classes to force a method lookup
87# within the Safe compartment. 146# within the Safe compartment.
88for my $pkg (qw( 147for my $pkg (qw(
89 cf::global 148 cf::global cf::attachable
90 cf::object cf::object::player 149 cf::object cf::object::player
91 cf::client cf::player 150 cf::client cf::player
92 cf::arch cf::living 151 cf::arch cf::living
93 cf::map cf::party cf::region 152 cf::map cf::party cf::region
94)) { 153)) {
106 165
107=head2 UTILITY FUNCTIONS 166=head2 UTILITY FUNCTIONS
108 167
109=over 4 168=over 4
110 169
170=item dumpval $ref
171
111=cut 172=cut
173
174sub dumpval {
175 eval {
176 local $SIG{__DIE__};
177 my $d;
178 if (1) {
179 $d = new Data::Dumper([$_[0]], ["*var"]);
180 $d->Terse(1);
181 $d->Indent(2);
182 $d->Quotekeys(0);
183 $d->Useqq(1);
184 #$d->Bless(...);
185 $d->Seen($_[1]) if @_ > 1;
186 $d = $d->Dump();
187 }
188 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
189 $d
190 } || "[unable to dump $_[0]: '$@']";
191}
112 192
113use JSON::Syck (); # TODO# replace by JSON::PC once working 193use JSON::Syck (); # TODO# replace by JSON::PC once working
114 194
115=item $ref = cf::from_json $json 195=item $ref = cf::from_json $json
116 196
132sub to_json($) { 212sub to_json($) {
133 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 213 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
134 JSON::Syck::Dump $_[0] 214 JSON::Syck::Dump $_[0]
135} 215}
136 216
217=item cf::lock_wait $string
218
219Wait until the given lock is available. See cf::lock_acquire.
220
221=item my $lock = cf::lock_acquire $string
222
223Wait until the given lock is available and then acquires it and returns
224a Coro::guard object. If the guard object gets destroyed (goes out of scope,
225for example when the coroutine gets canceled), the lock is automatically
226returned.
227
228Lock names should begin with a unique identifier (for example, cf::map::find
229uses map_find and cf::map::load uses map_load).
230
231=cut
232
233our %LOCK;
234
235sub lock_wait($) {
236 my ($key) = @_;
237
238 # wait for lock, if any
239 while ($LOCK{$key}) {
240 push @{ $LOCK{$key} }, $Coro::current;
241 Coro::schedule;
242 }
243}
244
245sub lock_acquire($) {
246 my ($key) = @_;
247
248 # wait, to be sure we are not locked
249 lock_wait $key;
250
251 $LOCK{$key} = [];
252
253 Coro::guard {
254 # wake up all waiters, to be on the safe side
255 $_->ready for @{ delete $LOCK{$key} };
256 }
257}
258
259sub freeze_mainloop {
260 return unless $TICK_WATCHER->is_active;
261
262 my $guard = Coro::guard { $TICK_WATCHER->start };
263 $TICK_WATCHER->stop;
264 $guard
265}
266
267=item cf::async { BLOCK }
268
269Currently the same as Coro::async_pool, meaning you cannot use
270C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
271thing you are allowed to do is call C<prio> on it.
272
273=cut
274
275BEGIN { *async = \&Coro::async_pool }
276
277=item cf::sync_job { BLOCK }
278
279The design of crossfire+ requires that the main coro ($Coro::main) is
280always able to handle events or runnable, as crossfire+ is only partly
281reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
282
283If it must be done, put the blocking parts into C<sync_job>. This will run
284the given BLOCK in another coroutine while waiting for the result. The
285server will be frozen during this time, so the block should either finish
286fast or be very important.
287
288=cut
289
290sub sync_job(&) {
291 my ($job) = @_;
292
293 if ($Coro::current == $Coro::main) {
294 # this is the main coro, too bad, we have to block
295 # till the operation succeeds, freezing the server :/
296
297 # TODO: use suspend/resume instead
298 # (but this is cancel-safe)
299 my $freeze_guard = freeze_mainloop;
300
301 my $busy = 1;
302 my @res;
303
304 (async {
305 @res = eval { $job->() };
306 warn $@ if $@;
307 undef $busy;
308 })->prio (Coro::PRIO_MAX);
309
310 while ($busy) {
311 Coro::cede or Event::one_event;
312 }
313
314 wantarray ? @res : $res[0]
315 } else {
316 # we are in another coroutine, how wonderful, everything just works
317
318 $job->()
319 }
320}
321
322=item $coro = cf::async_ext { BLOCK }
323
324Like async, but this coro is automcatially being canceled when the
325extension calling this is being unloaded.
326
327=cut
328
329sub async_ext(&) {
330 my $cb = shift;
331
332 my $coro = &Coro::async ($cb);
333
334 $coro->on_destroy (sub {
335 delete $EXT_CORO{$coro+0};
336 });
337 $EXT_CORO{$coro+0} = $coro;
338
339 $coro
340}
341
342sub write_runtime {
343 my $runtime = cf::localdir . "/runtime";
344
345 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
346 or return;
347
348 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
349 (aio_write $fh, 0, (length $value), $value, 0) <= 0
350 and return;
351
352 aio_fsync $fh
353 and return;
354
355 close $fh
356 or return;
357
358 aio_rename "$runtime~", $runtime
359 and return;
360
361 1
362}
363
137=back 364=back
138 365
139=cut 366=cut
367
368#############################################################################
369
370package cf::path;
371
372# used to convert map paths into valid unix filenames by repalcing / by ∕
373our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
374
375sub new {
376 my ($class, $path, $base) = @_;
377
378 $path = $path->as_string if ref $path;
379
380 my $self = bless { }, $class;
381
382 # {... are special paths that are not touched
383 # ?xxx/... are special absolute paths
384 # ?random/... random maps
385 # /! non-realised random map exit
386 # /... normal maps
387 # ~/... per-player maps without a specific player (DO NOT USE)
388 # ~user/... per-player map of a specific user
389
390 if ($path =~ /^{/) {
391 # fine as it is
392 } elsif ($path =~ s{^\?random/}{}) {
393 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
394 $self->{random} = cf::from_json $data;
395 } else {
396 if ($path =~ s{^~([^/]+)?}{}) {
397 $self->{user_rel} = 1;
398
399 if (defined $1) {
400 $self->{user} = $1;
401 } elsif ($base =~ m{^~([^/]+)/}) {
402 $self->{user} = $1;
403 } else {
404 warn "cannot resolve user-relative path without user <$path,$base>\n";
405 }
406 } elsif ($path =~ /^\//) {
407 # already absolute
408 } else {
409 $base =~ s{[^/]+/?$}{};
410 return $class->new ("$base/$path");
411 }
412
413 for ($path) {
414 redo if s{/\.?/}{/};
415 redo if s{/[^/]+/\.\./}{/};
416 }
417 }
418
419 $self->{path} = $path;
420
421 $self
422}
423
424# the name / primary key / in-game path
425sub as_string {
426 my ($self) = @_;
427
428 $self->{user_rel} ? "~$self->{user}$self->{path}"
429 : $self->{random} ? "?random/$self->{path}"
430 : $self->{path}
431}
432
433# the displayed name, this is a one way mapping
434sub visible_name {
435 my ($self) = @_;
436
437# if (my $rmp = $self->{random}) {
438# # todo: be more intelligent about this
439# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
440# } else {
441 $self->as_string
442# }
443}
444
445# escape the /'s in the path
446sub _escaped_path {
447 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
448 $path
449}
450
451# the original (read-only) location
452sub load_path {
453 my ($self) = @_;
454
455 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
456}
457
458# the temporary/swap location
459sub save_path {
460 my ($self) = @_;
461
462 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
463 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
464 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
465}
466
467# the unique path, might be eq to save_path
468sub uniq_path {
469 my ($self) = @_;
470
471 $self->{user_rel} || $self->{random}
472 ? undef
473 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
474}
475
476# return random map parameters, or undef
477sub random_map_params {
478 my ($self) = @_;
479
480 $self->{random}
481}
482
483# this is somewhat ugly, but style maps do need special treatment
484sub is_style_map {
485 $_[0]{path} =~ m{^/styles/}
486}
487
488package cf;
140 489
141############################################################################# 490#############################################################################
142 491
143=head2 ATTACHABLE OBJECTS 492=head2 ATTACHABLE OBJECTS
144 493
249 my ($self, $victim) = @_; 598 my ($self, $victim) = @_;
250 ... 599 ...
251 } 600 }
252 } 601 }
253 602
603=item $attachable->valid
604
605Just because you have a perl object does not mean that the corresponding
606C-level object still exists. If you try to access an object that has no
607valid C counterpart anymore you get an exception at runtime. This method
608can be used to test for existence of the C object part without causing an
609exception.
610
254=cut 611=cut
255 612
256# the following variables are defined in .xs and must not be re-created 613# the following variables are defined in .xs and must not be re-created
257our @CB_GLOBAL = (); # registry for all global events 614our @CB_GLOBAL = (); # registry for all global events
615our @CB_ATTACHABLE = (); # registry for all attachables
258our @CB_OBJECT = (); # all objects (should not be used except in emergency) 616our @CB_OBJECT = (); # all objects (should not be used except in emergency)
259our @CB_PLAYER = (); 617our @CB_PLAYER = ();
260our @CB_CLIENT = (); 618our @CB_CLIENT = ();
261our @CB_TYPE = (); # registry for type (cf-object class) based events 619our @CB_TYPE = (); # registry for type (cf-object class) based events
262our @CB_MAP = (); 620our @CB_MAP = ();
263 621
264my %attachment; 622my %attachment;
265 623
266sub _attach_cb($$$$) { 624sub _attach_cb($$$$) {
267 my ($registry, $event, $prio, $cb) = @_; 625 my ($registry, $event, $prio, $cb) = @_;
272 630
273 @{$registry->[$event]} = sort 631 @{$registry->[$event]} = sort
274 { $a->[0] cmp $b->[0] } 632 { $a->[0] cmp $b->[0] }
275 @{$registry->[$event] || []}, $cb; 633 @{$registry->[$event] || []}, $cb;
276} 634}
635
636# hack
637my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
277 638
278# attach handles attaching event callbacks 639# attach handles attaching event callbacks
279# the only thing the caller has to do is pass the correct 640# the only thing the caller has to do is pass the correct
280# registry (== where the callback attaches to). 641# registry (== where the callback attaches to).
281sub _attach { 642sub _attach {
283 644
284 my $object_type; 645 my $object_type;
285 my $prio = 0; 646 my $prio = 0;
286 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 647 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
287 648
649 #TODO: get rid of this hack
650 if ($attachable_klass{$klass}) {
651 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
652 }
653
288 while (@arg) { 654 while (@arg) {
289 my $type = shift @arg; 655 my $type = shift @arg;
290 656
291 if ($type eq "prio") { 657 if ($type eq "prio") {
292 $prio = shift @arg; 658 $prio = shift @arg;
367 my ($obj, $name) = @_; 733 my ($obj, $name) = @_;
368 734
369 exists $obj->{_attachment}{$name} 735 exists $obj->{_attachment}{$name}
370} 736}
371 737
372for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 738for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
373 eval "#line " . __LINE__ . " 'cf.pm' 739 eval "#line " . __LINE__ . " 'cf.pm'
374 sub cf::\L$klass\E::_attach_registry { 740 sub cf::\L$klass\E::_attach_registry {
375 (\\\@CB_$klass, KLASS_$klass) 741 (\\\@CB_$klass, KLASS_$klass)
376 } 742 }
377 743
413 } 779 }
414 780
415 0 781 0
416} 782}
417 783
418=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 784=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
419 785
420=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
421
422=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
423
424=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...) 786=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
425 787
426=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428Generate a global/object/player/map-specific event with the given arguments. 788Generate an object-specific event with the given arguments.
429 789
430This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be 790This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
431removed in future versions), and there is no public API to access override 791removed in future versions), and there is no public API to access override
432results (if you must, access C<@cf::invoke_results> directly). 792results (if you must, access C<@cf::invoke_results> directly).
433 793
434=back 794=back
435 795
436=cut 796=cut
437 797
438############################################################################# 798#############################################################################
439
440=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
441
442Attachable objects includes objects, players, clients and maps.
443
444=over 4
445
446=item $object->valid
447
448Just because you have a perl object does not mean that the corresponding
449C-level object still exists. If you try to access an object that has no
450valid C counterpart anymore you get an exception at runtime. This method
451can be used to test for existence of the C object part without causing an
452exception.
453
454=back
455
456=cut
457
458#############################################################################
459# object support 799# object support
460 800
461sub instantiate {
462 my ($obj, $data) = @_;
463
464 $data = from_json $data;
465
466 for (@$data) {
467 my ($name, $args) = @$_;
468
469 $obj->attach ($name, %{$args || {} });
470 }
471}
472
473# basically do the same as instantiate, without calling instantiate
474sub reattach { 801sub reattach {
802 # basically do the same as instantiate, without calling instantiate
475 my ($obj) = @_; 803 my ($obj) = @_;
804
476 my $registry = $obj->registry; 805 my $registry = $obj->registry;
477 806
478 @$registry = (); 807 @$registry = ();
479 808
480 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 809 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
489 warn "object uses attachment '$name' that is not available, postponing.\n"; 818 warn "object uses attachment '$name' that is not available, postponing.\n";
490 } 819 }
491 } 820 }
492} 821}
493 822
494sub object_freezer_save { 823cf::attachable->attach (
495 my ($filename, $rdata, $objs) = @_;
496
497 if (length $$rdata) {
498 warn sprintf "saving %s (%d,%d)\n",
499 $filename, length $$rdata, scalar @$objs;
500
501 if (open my $fh, ">:raw", "$filename~") {
502 chmod SAVE_MODE, $fh;
503 syswrite $fh, $$rdata;
504 close $fh;
505
506 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
507 chmod SAVE_MODE, $fh;
508 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
509 close $fh;
510 rename "$filename.pst~", "$filename.pst";
511 } else {
512 unlink "$filename.pst";
513 }
514
515 rename "$filename~", $filename;
516 } else {
517 warn "FATAL: $filename~: $!\n";
518 }
519 } else {
520 unlink $filename;
521 unlink "$filename.pst";
522 }
523}
524
525sub object_freezer_as_string {
526 my ($rdata, $objs) = @_;
527
528 use Data::Dumper;
529
530 $$rdata . Dumper $objs
531}
532
533sub object_thawer_load {
534 my ($filename) = @_;
535
536 local $/;
537
538 my $av;
539
540 #TODO: use sysread etc.
541 if (open my $data, "<:raw:perlio", $filename) {
542 $data = <$data>;
543 if (open my $pst, "<:raw:perlio", "$filename.pst") {
544 $av = eval { (Storable::thaw <$pst>)->{objs} };
545 }
546 return ($data, $av);
547 }
548
549 ()
550}
551
552cf::object->attach (
553 prio => -1000000, 824 prio => -1000000,
825 on_instantiate => sub {
826 my ($obj, $data) = @_;
827
828 $data = from_json $data;
829
830 for (@$data) {
831 my ($name, $args) = @$_;
832
833 $obj->attach ($name, %{$args || {} });
834 }
835 },
836 on_reattach => \&reattach,
554 on_clone => sub { 837 on_clone => sub {
555 my ($src, $dst) = @_; 838 my ($src, $dst) = @_;
556 839
557 @{$dst->registry} = @{$src->registry}; 840 @{$dst->registry} = @{$src->registry};
558 841
560 843
561 %{$dst->{_attachment}} = %{$src->{_attachment}} 844 %{$dst->{_attachment}} = %{$src->{_attachment}}
562 if exists $src->{_attachment}; 845 if exists $src->{_attachment};
563 }, 846 },
564); 847);
848
849sub object_freezer_save {
850 my ($filename, $rdata, $objs) = @_;
851
852 sync_job {
853 if (length $$rdata) {
854 warn sprintf "saving %s (%d,%d)\n",
855 $filename, length $$rdata, scalar @$objs;
856
857 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
858 chmod SAVE_MODE, $fh;
859 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
860 aio_fsync $fh;
861 close $fh;
862
863 if (@$objs) {
864 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
865 chmod SAVE_MODE, $fh;
866 my $data = Storable::nfreeze { version => 1, objs => $objs };
867 aio_write $fh, 0, (length $data), $data, 0;
868 aio_fsync $fh;
869 close $fh;
870 aio_rename "$filename.pst~", "$filename.pst";
871 }
872 } else {
873 aio_unlink "$filename.pst";
874 }
875
876 aio_rename "$filename~", $filename;
877 } else {
878 warn "FATAL: $filename~: $!\n";
879 }
880 } else {
881 aio_unlink $filename;
882 aio_unlink "$filename.pst";
883 }
884 }
885}
886
887sub object_freezer_as_string {
888 my ($rdata, $objs) = @_;
889
890 use Data::Dumper;
891
892 $$rdata . Dumper $objs
893}
894
895sub object_thawer_load {
896 my ($filename) = @_;
897
898 my ($data, $av);
899
900 (aio_load $filename, $data) >= 0
901 or return;
902
903 unless (aio_stat "$filename.pst") {
904 (aio_load "$filename.pst", $av) >= 0
905 or return;
906 $av = eval { (Storable::thaw $av)->{objs} };
907 }
908
909 warn sprintf "loading %s (%d)\n",
910 $filename, length $data, scalar @{$av || []};#d#
911 return ($data, $av);
912}
565 913
566############################################################################# 914#############################################################################
567# command handling &c 915# command handling &c
568 916
569=item cf::register_command $name => \&callback($ob,$args); 917=item cf::register_command $name => \&callback($ob,$args);
731}; 1079};
732 1080
733cf::map->attach (prio => -10000, package => cf::mapsupport::); 1081cf::map->attach (prio => -10000, package => cf::mapsupport::);
734 1082
735############################################################################# 1083#############################################################################
736# load/save perl data associated with player->ob objects
737 1084
738sub all_objects(@) { 1085=head2 CORE EXTENSIONS
739 @_, map all_objects ($_->inv), @_
740}
741 1086
742# TODO: compatibility cruft, remove when no longer needed 1087Functions and methods that extend core crossfire objects.
743cf::player->attach ( 1088
744 on_load => sub { 1089=cut
1090
1091package cf::player;
1092
1093use Coro::AIO;
1094
1095=head3 cf::player
1096
1097=over 4
1098
1099=item cf::player::find $login
1100
1101Returns the given player object, loading it if necessary (might block).
1102
1103=cut
1104
1105sub playerdir($) {
1106 cf::localdir
1107 . "/"
1108 . cf::playerdir
1109 . "/"
1110 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1111}
1112
1113sub path($) {
1114 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1115
1116 (playerdir $login) . "/$login.pl"
1117}
1118
1119sub find_active($) {
1120 $cf::PLAYER{$_[0]}
1121 and $cf::PLAYER{$_[0]}->active
1122 and $cf::PLAYER{$_[0]}
1123}
1124
1125sub exists($) {
1126 my ($login) = @_;
1127
1128 $cf::PLAYER{$login}
1129 or cf::sync_job { !aio_stat $login }
1130}
1131
1132sub find($) {
1133 return $cf::PLAYER{$_[0]} || do {
1134 my $login = $_[0];
1135
1136 my $guard = cf::lock_acquire "user_find:$login";
1137
1138 $cf::PLAYER{$_[0]} || do {
1139 my $pl = load_pl path $login
1140 or return;
1141 $cf::PLAYER{$login} = $pl
1142 }
1143 }
1144}
1145
1146sub save($) {
1147 my ($pl) = @_;
1148
1149 return if $pl->{deny_save};
1150
1151 my $path = path $pl;
1152 my $guard = cf::lock_acquire "user_save:$path";
1153
1154 return if $pl->{deny_save};
1155
1156 aio_mkdir playerdir $pl, 0770;
1157 $pl->{last_save} = $cf::RUNTIME;
1158
1159 $pl->save_pl ($path);
1160 Coro::cede;
1161}
1162
1163sub new($) {
1164 my ($login) = @_;
1165
1166 my $self = create;
1167
1168 $self->ob->name ($login);
1169 $self->{deny_save} = 1;
1170
1171 $cf::PLAYER{$login} = $self;
1172
1173 $self
1174}
1175
1176=item $pl->quit_character
1177
1178Nukes the player without looking back. If logged in, the connection will
1179be destroyed. May block for a long time.
1180
1181=cut
1182
1183sub quit_character {
1184 my ($pl) = @_;
1185
1186 $pl->{deny_save} = 1;
1187 $pl->password ("*"); # this should lock out the player until we nuked the dir
1188
1189 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1190 $pl->deactivate;
1191 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1192 $pl->ns->destroy if $pl->ns;
1193
1194 my $path = playerdir $pl;
1195 my $temp = "$path~$cf::RUNTIME~deleting~";
1196 aio_rename $path, $temp;
1197 delete $cf::PLAYER{$pl->ob->name};
1198 $pl->destroy;
1199 IO::AIO::aio_rmtree $temp;
1200}
1201
1202=item cf::player::list_logins
1203
1204Returns am arrayref of all valid playernames in the system, can take a
1205while and may block, so not sync_job-capable, ever.
1206
1207=cut
1208
1209sub list_logins {
1210 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1211 or return [];
1212
1213 my @logins;
1214
1215 for my $login (@$dirs) {
1216 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1217 aio_read $fh, 0, 512, my $buf, 0 or next;
1218 $buf !~ /^password -------------$/m or next; # official not-valid tag
1219
1220 utf8::decode $login;
1221 push @logins, $login;
1222 }
1223
1224 \@logins
1225}
1226
1227=item $player->maps
1228
1229Returns an arrayref of cf::path's of all maps that are private for this
1230player. May block.
1231
1232=cut
1233
1234sub maps($) {
1235 my ($pl) = @_;
1236
1237 my $files = aio_readdir playerdir $pl
1238 or return;
1239
1240 my @paths;
1241
1242 for (@$files) {
1243 utf8::decode $_;
1244 next if /\.(?:pl|pst)$/;
1245 next unless /^$PATH_SEP/;
1246
1247 s/$PATH_SEP/\//g;
1248 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
1249 }
1250
1251 \@paths
1252}
1253
1254=item $player->ext_reply ($msgid, $msgtype, %msg)
1255
1256Sends an ext reply to the player.
1257
1258=cut
1259
1260sub ext_reply($$$%) {
1261 my ($self, $id, %msg) = @_;
1262
1263 $msg{msgid} = $id;
1264
1265 $self->send ("ext " . cf::to_json \%msg);
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})
1304}
1305
1306# and all this just because we cannot iterate over
1307# all maps in C++...
1308sub change_all_map_light {
1309 my ($change) = @_;
1310
1311 $_->change_map_light ($change)
1312 for grep $_->outdoor, values %cf::MAP;
1313}
1314
1315sub try_load_header($) {
745 my ($pl, $path) = @_; 1316 my ($path) = @_;
746 1317
747 for my $o (all_objects $pl->ob) { 1318 utf8::encode $path;
748 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1319 aio_open $path, O_RDONLY, 0
749 $o->set_ob_key_value ("_perl_data"); 1320 or return;
750 1321
751 %$o = %{ Storable::thaw pack "H*", $value }; 1322 my $map = cf::map::new
1323 or return;
1324
1325 # for better error messages only, will be overwritten
1326 $map->path ($path);
1327
1328 $map->load_header ($path)
1329 or return;
1330
1331 $map->{load_path} = $path;
1332
1333 $map
1334}
1335
1336sub find;
1337sub find {
1338 my ($path, $origin) = @_;
1339
1340 #warn "find<$path,$origin>\n";#d#
1341
1342 $path = new cf::path $path, $origin && $origin->path;
1343 my $key = $path->as_string;
1344
1345 cf::lock_wait "map_find:$key";
1346
1347 $cf::MAP{$key} || do {
1348 my $guard = cf::lock_acquire "map_find:$key";
1349
1350 # do it the slow way
1351 my $map = try_load_header $path->save_path;
1352
1353 Coro::cede;
1354
1355 if ($map) {
1356 $map->last_access ((delete $map->{last_access})
1357 || $cf::RUNTIME); #d#
1358 # safety
1359 $map->{instantiate_time} = $cf::RUNTIME
1360 if $map->{instantiate_time} > $cf::RUNTIME;
1361 } else {
1362 if (my $rmp = $path->random_map_params) {
1363 $map = generate_random_map $key, $rmp;
1364 } else {
1365 $map = try_load_header $path->load_path;
752 } 1366 }
1367
1368 $map or return;
1369
1370 $map->{load_original} = 1;
1371 $map->{instantiate_time} = $cf::RUNTIME;
1372 $map->last_access ($cf::RUNTIME);
1373 $map->instantiate;
1374
1375 # per-player maps become, after loading, normal maps
1376 $map->per_player (0) if $path->{user_rel};
753 } 1377 }
1378
1379 $map->path ($key);
1380 $map->{path} = $path;
1381 $map->{last_save} = $cf::RUNTIME;
1382
1383 Coro::cede;
1384
1385 if ($map->should_reset) {
1386 $map->reset;
1387 undef $guard;
1388 $map = find $path
1389 or return;
1390 }
1391
1392 $cf::MAP{$key} = $map
754 }, 1393 }
755); 1394}
756 1395
757############################################################################# 1396sub load {
1397 my ($self) = @_;
758 1398
759=head2 CORE EXTENSIONS 1399 my $path = $self->{path};
1400 my $guard = cf::lock_acquire "map_load:" . $path->as_string;
760 1401
761Functions and methods that extend core crossfire objects. 1402 return if $self->in_memory != cf::MAP_SWAPPED;
1403
1404 $self->in_memory (cf::MAP_LOADING);
1405
1406 $self->alloc;
1407 $self->load_objects ($self->{load_path}, 1)
1408 or return;
1409
1410 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1411 if delete $self->{load_original};
1412
1413 if (my $uniq = $path->uniq_path) {
1414 utf8::encode $uniq;
1415 if (aio_open $uniq, O_RDONLY, 0) {
1416 $self->clear_unique_items;
1417 $self->load_objects ($uniq, 0);
1418 }
1419 }
1420
1421 Coro::cede;
1422
1423 # now do the right thing for maps
1424 $self->link_multipart_objects;
1425
1426 if ($self->{path}->is_style_map) {
1427 $self->{deny_save} = 1;
1428 $self->{deny_reset} = 1;
1429 } else {
1430 $self->fix_auto_apply;
1431 $self->decay_objects;
1432 $self->update_buttons;
1433 $self->set_darkness_map;
1434 $self->difficulty ($self->estimate_difficulty)
1435 unless $self->difficulty;
1436 $self->activate;
1437 }
1438
1439 Coro::cede;
1440
1441 $self->in_memory (cf::MAP_IN_MEMORY);
1442}
1443
1444sub find_sync {
1445 my ($path, $origin) = @_;
1446
1447 cf::sync_job { cf::map::find $path, $origin }
1448}
1449
1450sub do_load_sync {
1451 my ($map) = @_;
1452
1453 cf::sync_job { $map->load };
1454}
1455
1456sub save {
1457 my ($self) = @_;
1458
1459 my $lock = cf::lock_acquire "map_data:" . $self->path;
1460
1461 $self->{last_save} = $cf::RUNTIME;
1462
1463 return unless $self->dirty;
1464
1465 my $save = $self->{path}->save_path; utf8::encode $save;
1466 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1467
1468 $self->{load_path} = $save;
1469
1470 return if $self->{deny_save};
1471
1472 local $self->{last_access} = $self->last_access;#d#
1473
1474 cf::async {
1475 $_->contr->save for $self->players;
1476 };
1477
1478 if ($uniq) {
1479 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1480 $self->save_objects ($uniq, cf::IO_UNIQUES);
1481 } else {
1482 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1483 }
1484}
1485
1486sub swap_out {
1487 my ($self) = @_;
1488
1489 # save first because save cedes
1490 $self->save;
1491
1492 my $lock = cf::lock_acquire "map_data:" . $self->path;
1493
1494 return if $self->players;
1495 return if $self->in_memory != cf::MAP_IN_MEMORY;
1496 return if $self->{deny_save};
1497
1498 $self->clear;
1499 $self->in_memory (cf::MAP_SWAPPED);
1500}
1501
1502sub reset_at {
1503 my ($self) = @_;
1504
1505 # TODO: safety, remove and allow resettable per-player maps
1506 return 1e99 if $self->{path}{user_rel};
1507 return 1e99 if $self->{deny_reset};
1508
1509 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1510 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1511
1512 $time + $to
1513}
1514
1515sub should_reset {
1516 my ($self) = @_;
1517
1518 $self->reset_at <= $cf::RUNTIME
1519}
1520
1521sub unlink_save {
1522 my ($self) = @_;
1523
1524 utf8::encode (my $save = $self->{path}->save_path);
1525 aioreq_pri 3; IO::AIO::aio_unlink $save;
1526 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1527}
1528
1529sub rename {
1530 my ($self, $new_path) = @_;
1531
1532 $self->unlink_save;
1533
1534 delete $cf::MAP{$self->path};
1535 $self->{path} = new cf::path $new_path;
1536 $self->path ($self->{path}->as_string);
1537 $cf::MAP{$self->path} = $self;
1538
1539 $self->save;
1540}
1541
1542sub reset {
1543 my ($self) = @_;
1544
1545 my $lock = cf::lock_acquire "map_data:" . $self->path;
1546
1547 return if $self->players;
1548 return if $self->{path}{user_rel};#d#
1549
1550 warn "resetting map ", $self->path;#d#
1551
1552 delete $cf::MAP{$self->path};
1553
1554 $_->clear_links_to ($self) for values %cf::MAP;
1555
1556 $self->unlink_save;
1557 $self->destroy;
1558}
1559
1560my $nuke_counter = "aaaa";
1561
1562sub nuke {
1563 my ($self) = @_;
1564
1565 $self->{deny_save} = 1;
1566 $self->reset_timeout (1);
1567 $self->rename ("{nuke}/" . ($nuke_counter++));
1568 $self->reset; # polite request, might not happen
1569}
1570
1571sub customise_for {
1572 my ($map, $ob) = @_;
1573
1574 if ($map->per_player) {
1575 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
1576 }
1577
1578 $map
1579}
1580
1581package cf;
1582
1583=back
1584
1585=head3 cf::object
1586
1587=cut
1588
1589package cf::object;
762 1590
763=over 4 1591=over 4
764 1592
765=item cf::player::exists $login 1593=item $ob->inv_recursive
766 1594
767Returns true when the given account exists. 1595Returns the inventory of the object _and_ their inventories, recursively.
768 1596
769=cut 1597=cut
770 1598
771sub cf::player::exists($) { 1599sub inv_recursive_;
772 cf::player::find $_[0] 1600sub inv_recursive_ {
773 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1601 map { $_, inv_recursive_ $_->inv } @_
774} 1602}
1603
1604sub inv_recursive {
1605 inv_recursive_ inv $_[0]
1606}
1607
1608package cf;
1609
1610=back
1611
1612=head3 cf::object::player
1613
1614=over 4
775 1615
776=item $player_object->reply ($npc, $msg[, $flags]) 1616=item $player_object->reply ($npc, $msg[, $flags])
777 1617
778Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1618Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
779can be C<undef>. Does the right thing when the player is currently in a 1619can be C<undef>. Does the right thing when the player is currently in a
781 1621
782=cut 1622=cut
783 1623
784# rough implementation of a future "reply" method that works 1624# rough implementation of a future "reply" method that works
785# with dialog boxes. 1625# with dialog boxes.
1626#TODO: the first argument must go, split into a $npc->reply_to ( method
786sub cf::object::player::reply($$$;$) { 1627sub cf::object::player::reply($$$;$) {
787 my ($self, $npc, $msg, $flags) = @_; 1628 my ($self, $npc, $msg, $flags) = @_;
788 1629
789 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1630 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
790 1631
794 $msg = $npc->name . " says: $msg" if $npc; 1635 $msg = $npc->name . " says: $msg" if $npc;
795 $self->message ($msg, $flags); 1636 $self->message ($msg, $flags);
796 } 1637 }
797} 1638}
798 1639
799=item $player->ext_reply ($msgid, $msgtype, %msg)
800
801Sends an ext reply to the player.
802
803=cut
804
805sub cf::player::ext_reply($$$%) {
806 my ($self, $id, %msg) = @_;
807
808 $msg{msgid} = $id;
809
810 $self->send ("ext " . to_json \%msg);
811}
812
813=item $player_object->may ("access") 1640=item $player_object->may ("access")
814 1641
815Returns wether the given player is authorized to access resource "access" 1642Returns wether the given player is authorized to access resource "access"
816(e.g. "command_wizcast"). 1643(e.g. "command_wizcast").
817 1644
824 (ref $cf::CFG{"may_$access"} 1651 (ref $cf::CFG{"may_$access"}
825 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1652 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826 : $cf::CFG{"may_$access"}) 1653 : $cf::CFG{"may_$access"})
827} 1654}
828 1655
829=cut 1656=item $player_object->enter_link
830 1657
831############################################################################# 1658Freezes the player and moves him/her to a special map (C<{link}>).
1659
1660The player should be reaosnably safe there for short amounts of time. You
1661I<MUST> call C<leave_link> as soon as possible, though.
1662
1663=item $player_object->leave_link ($map, $x, $y)
1664
1665Moves the player out of the specila link map onto the given map. If the
1666map is not valid (or omitted), the player will be moved back to the
1667location he/she was before the call to C<enter_link>, or, if that fails,
1668to the emergency map position.
1669
1670Might block.
1671
1672=cut
1673
1674sub cf::object::player::enter_link {
1675 my ($self) = @_;
1676
1677 $self->deactivate_recursive;
1678
1679 return if $self->map == $LINK_MAP;
1680
1681 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1682 if $self->map;
1683
1684 $self->enter_map ($LINK_MAP, 20, 20);
1685}
1686
1687sub cf::object::player::leave_link {
1688 my ($self, $map, $x, $y) = @_;
1689
1690 my $link_pos = delete $self->{_link_pos};
1691
1692 unless ($map) {
1693 # restore original map position
1694 ($map, $x, $y) = @{ $link_pos || [] };
1695 $map = cf::map::find $map;
1696
1697 unless ($map) {
1698 ($map, $x, $y) = @$EMERGENCY_POSITION;
1699 $map = cf::map::find $map
1700 or die "FATAL: cannot load emergency map\n";
1701 }
1702 }
1703
1704 ($x, $y) = (-1, -1)
1705 unless (defined $x) && (defined $y);
1706
1707 # use -1 or undef as default coordinates, not 0, 0
1708 ($x, $y) = ($map->enter_x, $map->enter_y)
1709 if $x <=0 && $y <= 0;
1710
1711 $map->load;
1712
1713 return unless $self->contr->active;
1714 $self->activate_recursive;
1715 $self->enter_map ($map, $x, $y);
1716}
1717
1718cf::player->attach (
1719 on_logout => sub {
1720 my ($pl) = @_;
1721
1722 # abort map switching before logout
1723 if ($pl->ob->{_link_pos}) {
1724 cf::sync_job {
1725 $pl->ob->leave_link
1726 };
1727 }
1728 },
1729 on_login => sub {
1730 my ($pl) = @_;
1731
1732 # try to abort aborted map switching on player login :)
1733 # should happen only on crashes
1734 if ($pl->ob->{_link_pos}) {
1735 $pl->ob->enter_link;
1736 (async {
1737 # we need this sleep as the login has a concurrent enter_exit running
1738 # and this sleep increases chances of the player not ending up in scorn
1739 $pl->ob->reply (undef,
1740 "There was an internal problem at your last logout, "
1741 . "the server will try to bring you to your intended destination in a second.",
1742 cf::NDI_RED);
1743 Coro::Timer::sleep 1;
1744 $pl->ob->leave_link;
1745 })->prio (2);
1746 }
1747 },
1748);
1749
1750=item $player_object->goto ($path, $x, $y)
1751
1752=cut
1753
1754sub cf::object::player::goto {
1755 my ($self, $path, $x, $y) = @_;
1756
1757 $path = new cf::path $path;
1758 $path ne "/" or Carp::cluck ("oy");#d#
1759
1760 $self->enter_link;
1761
1762 (async {
1763 my $map = cf::map::find $path->as_string;
1764 $map = $map->customise_for ($self) if $map;
1765
1766# warn "entering ", $map->path, " at ($x, $y)\n"
1767# if $map;
1768
1769 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1770
1771 $self->leave_link ($map, $x, $y);
1772 })->prio (1);
1773}
1774
1775=item $player_object->enter_exit ($exit_object)
1776
1777=cut
1778
1779sub parse_random_map_params {
1780 my ($spec) = @_;
1781
1782 my $rmp = { # defaults
1783 xsize => 10,
1784 ysize => 10,
1785 };
1786
1787 for (split /\n/, $spec) {
1788 my ($k, $v) = split /\s+/, $_, 2;
1789
1790 $rmp->{lc $k} = $v if (length $k) && (length $v);
1791 }
1792
1793 $rmp
1794}
1795
1796sub prepare_random_map {
1797 my ($exit) = @_;
1798
1799 # all this does is basically replace the /! path by
1800 # a new random map path (?random/...) with a seed
1801 # that depends on the exit object
1802
1803 my $rmp = parse_random_map_params $exit->msg;
1804
1805 if ($exit->map) {
1806 $rmp->{region} = $exit->map->region_name;
1807 $rmp->{origin_map} = $exit->map->path;
1808 $rmp->{origin_x} = $exit->x;
1809 $rmp->{origin_y} = $exit->y;
1810 }
1811
1812 $rmp->{random_seed} ||= $exit->random_seed;
1813
1814 my $data = cf::to_json $rmp;
1815 my $md5 = Digest::MD5::md5_hex $data;
1816
1817 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1818 aio_write $fh, 0, (length $data), $data, 0;
1819
1820 $exit->slaying ("?random/$md5");
1821 $exit->msg (undef);
1822 }
1823}
1824
1825sub cf::object::player::enter_exit {
1826 my ($self, $exit) = @_;
1827
1828 return unless $self->type == cf::PLAYER;
1829
1830 $self->enter_link;
1831
1832 (async {
1833 $self->deactivate_recursive; # just to be sure
1834 unless (eval {
1835 prepare_random_map $exit
1836 if $exit->slaying eq "/!";
1837
1838 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1839 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1840
1841 1;
1842 }) {
1843 $self->message ("Something went wrong deep within the crossfire server. "
1844 . "I'll try to bring you back to the map you were before. "
1845 . "Please report this to the dungeon master",
1846 cf::NDI_UNIQUE | cf::NDI_RED);
1847
1848 warn "ERROR in enter_exit: $@";
1849 $self->leave_link;
1850 }
1851 })->prio (1);
1852}
1853
1854=head3 cf::client
1855
1856=over 4
1857
1858=item $client->send_drawinfo ($text, $flags)
1859
1860Sends a drawinfo packet to the client. Circumvents output buffering so
1861should not be used under normal circumstances.
1862
1863=cut
1864
1865sub cf::client::send_drawinfo {
1866 my ($self, $text, $flags) = @_;
1867
1868 utf8::encode $text;
1869 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1870}
1871
1872
1873=item $success = $client->query ($flags, "text", \&cb)
1874
1875Queues a query to the client, calling the given callback with
1876the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1877C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1878
1879Queries can fail, so check the return code. Or don't, as queries will become
1880reliable at some point in the future.
1881
1882=cut
1883
1884sub cf::client::query {
1885 my ($self, $flags, $text, $cb) = @_;
1886
1887 return unless $self->state == ST_PLAYING
1888 || $self->state == ST_SETUP
1889 || $self->state == ST_CUSTOM;
1890
1891 $self->state (ST_CUSTOM);
1892
1893 utf8::encode $text;
1894 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1895
1896 $self->send_packet ($self->{query_queue}[0][0])
1897 if @{ $self->{query_queue} } == 1;
1898}
1899
1900cf::client->attach (
1901 on_reply => sub {
1902 my ($ns, $msg) = @_;
1903
1904 # this weird shuffling is so that direct followup queries
1905 # get handled first
1906 my $queue = delete $ns->{query_queue}
1907 or return; # be conservative, not sure how that can happen, but we saw a crash here
1908
1909 (shift @$queue)->[1]->($msg);
1910
1911 push @{ $ns->{query_queue} }, @$queue;
1912
1913 if (@{ $ns->{query_queue} } == @$queue) {
1914 if (@$queue) {
1915 $ns->send_packet ($ns->{query_queue}[0][0]);
1916 } else {
1917 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1918 }
1919 }
1920 },
1921);
1922
1923=item $client->async (\&cb)
1924
1925Create a new coroutine, running the specified callback. The coroutine will
1926be automatically cancelled when the client gets destroyed (e.g. on logout,
1927or loss of connection).
1928
1929=cut
1930
1931sub cf::client::async {
1932 my ($self, $cb) = @_;
1933
1934 my $coro = &Coro::async ($cb);
1935
1936 $coro->on_destroy (sub {
1937 delete $self->{_coro}{$coro+0};
1938 });
1939
1940 $self->{_coro}{$coro+0} = $coro;
1941
1942 $coro
1943}
1944
1945cf::client->attach (
1946 on_destroy => sub {
1947 my ($ns) = @_;
1948
1949 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1950 },
1951);
1952
1953=back
1954
832 1955
833=head2 SAFE SCRIPTING 1956=head2 SAFE SCRIPTING
834 1957
835Functions that provide a safe environment to compile and execute 1958Functions that provide a safe environment to compile and execute
836snippets of perl code without them endangering the safety of the server 1959snippets of perl code without them endangering the safety of the server
988 2111
989{ 2112{
990 my $path = cf::localdir . "/database.pst"; 2113 my $path = cf::localdir . "/database.pst";
991 2114
992 sub db_load() { 2115 sub db_load() {
993 warn "loading database $path\n";#d# remove later
994 $DB = stat $path ? Storable::retrieve $path : { }; 2116 $DB = stat $path ? Storable::retrieve $path : { };
995 } 2117 }
996 2118
997 my $pid; 2119 my $pid;
998 2120
999 sub db_save() { 2121 sub db_save() {
1000 warn "saving database $path\n";#d# remove later
1001 waitpid $pid, 0 if $pid; 2122 waitpid $pid, 0 if $pid;
1002 if (0 == ($pid = fork)) { 2123 if (0 == ($pid = fork)) {
1003 $DB->{_meta}{version} = 1; 2124 $DB->{_meta}{version} = 1;
1004 Storable::nstore $DB, "$path~"; 2125 Storable::nstore $DB, "$path~";
1005 rename "$path~", $path; 2126 rename "$path~", $path;
1053 open my $fh, "<:utf8", cf::confdir . "/config" 2174 open my $fh, "<:utf8", cf::confdir . "/config"
1054 or return; 2175 or return;
1055 2176
1056 local $/; 2177 local $/;
1057 *CFG = YAML::Syck::Load <$fh>; 2178 *CFG = YAML::Syck::Load <$fh>;
2179
2180 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2181
2182 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2183 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2184
2185 if (exists $CFG{mlockall}) {
2186 eval {
2187 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2188 and die "WARNING: m(un)lockall failed: $!\n";
2189 };
2190 warn $@ if $@;
2191 }
1058} 2192}
1059 2193
1060sub main { 2194sub main {
2195 # we must not ever block the main coroutine
2196 local $Coro::idle = sub {
2197 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2198 async { Event::one_event };
2199 };
2200
1061 cfg_load; 2201 cfg_load;
1062 db_load; 2202 db_load;
1063 load_extensions; 2203 load_extensions;
1064 Event::loop; 2204 Event::loop;
1065} 2205}
1066 2206
1067############################################################################# 2207#############################################################################
1068# initialisation 2208# initialisation and cleanup
1069 2209
2210# install some emergency cleanup handlers
2211BEGIN {
2212 for my $signal (qw(INT HUP TERM)) {
2213 Event->signal (
2214 data => WF_AUTOCANCEL,
2215 signal => $signal,
2216 cb => sub {
2217 cf::cleanup "SIG$signal";
2218 },
2219 );
2220 }
2221}
2222
2223sub emergency_save() {
2224 my $freeze_guard = cf::freeze_mainloop;
2225
2226 warn "enter emergency perl save\n";
2227
2228 cf::sync_job {
2229 # use a peculiar iteration method to avoid tripping on perl
2230 # refcount bugs in for. also avoids problems with players
2231 # and maps saved/Destroyed asynchronously.
2232 warn "begin emergency player save\n";
2233 for my $login (keys %cf::PLAYER) {
2234 my $pl = $cf::PLAYER{$login} or next;
2235 $pl->valid or next;
2236 $pl->save;
2237 }
2238 warn "end emergency player save\n";
2239
2240 warn "begin emergency map save\n";
2241 for my $path (keys %cf::MAP) {
2242 my $map = $cf::MAP{$path} or next;
2243 $map->valid or next;
2244 $map->save;
2245 }
2246 warn "end emergency map save\n";
2247 };
2248
2249 warn "leave emergency perl save\n";
2250}
2251
1070sub _perl_reload(&) { 2252sub reload() {
1071 my ($msg) = @_; 2253 # can/must only be called in main
2254 if ($Coro::current != $Coro::main) {
2255 warn "can only reload from main coroutine\n";
2256 return;
2257 }
1072 2258
1073 $msg->("reloading..."); 2259 warn "reloading...";
2260
2261 my $guard = freeze_mainloop;
2262 cf::emergency_save;
1074 2263
1075 eval { 2264 eval {
2265 # if anything goes wrong in here, we should simply crash as we already saved
2266
1076 # cancel all watchers 2267 # cancel all watchers
1077 for (Event::all_watchers) { 2268 for (Event::all_watchers) {
1078 $_->cancel if $_->data & WF_AUTOCANCEL; 2269 $_->cancel if $_->data & WF_AUTOCANCEL;
1079 } 2270 }
1080 2271
2272 # cancel all extension coros
2273 $_->cancel for values %EXT_CORO;
2274 %EXT_CORO = ();
2275
1081 # unload all extensions 2276 # unload all extensions
1082 for (@exts) { 2277 for (@exts) {
1083 $msg->("unloading <$_>"); 2278 warn "unloading <$_>";
1084 unload_extension $_; 2279 unload_extension $_;
1085 } 2280 }
1086 2281
1087 # unload all modules loaded from $LIBDIR 2282 # unload all modules loaded from $LIBDIR
1088 while (my ($k, $v) = each %INC) { 2283 while (my ($k, $v) = each %INC) {
1089 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2284 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1090 2285
1091 $msg->("removing <$k>"); 2286 warn "removing <$k>";
1092 delete $INC{$k}; 2287 delete $INC{$k};
1093 2288
1094 $k =~ s/\.pm$//; 2289 $k =~ s/\.pm$//;
1095 $k =~ s/\//::/g; 2290 $k =~ s/\//::/g;
1096 2291
1101 Symbol::delete_package $k; 2296 Symbol::delete_package $k;
1102 } 2297 }
1103 2298
1104 # sync database to disk 2299 # sync database to disk
1105 cf::db_sync; 2300 cf::db_sync;
2301 IO::AIO::flush;
1106 2302
1107 # get rid of safe::, as good as possible 2303 # get rid of safe::, as good as possible
1108 Symbol::delete_package "safe::$_" 2304 Symbol::delete_package "safe::$_"
1109 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2305 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1110 2306
1111 # remove register_script_function callbacks 2307 # remove register_script_function callbacks
1112 # TODO 2308 # TODO
1113 2309
1114 # unload cf.pm "a bit" 2310 # unload cf.pm "a bit"
1117 # don't, removes xs symbols, too, 2313 # don't, removes xs symbols, too,
1118 # and global variables created in xs 2314 # and global variables created in xs
1119 #Symbol::delete_package __PACKAGE__; 2315 #Symbol::delete_package __PACKAGE__;
1120 2316
1121 # reload cf.pm 2317 # reload cf.pm
1122 $msg->("reloading cf.pm"); 2318 warn "reloading cf.pm";
1123 require cf; 2319 require cf;
2320 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1124 2321
1125 # load config and database again 2322 # load config and database again
1126 cf::cfg_load; 2323 cf::cfg_load;
1127 cf::db_load; 2324 cf::db_load;
1128 2325
1129 # load extensions 2326 # load extensions
1130 $msg->("load extensions"); 2327 warn "load extensions";
1131 cf::load_extensions; 2328 cf::load_extensions;
1132 2329
1133 # reattach attachments to objects 2330 # reattach attachments to objects
1134 $msg->("reattach"); 2331 warn "reattach";
1135 _global_reattach; 2332 _global_reattach;
2333 reattach $_ for values %MAP;
1136 }; 2334 };
1137 $msg->($@) if $@;
1138 2335
1139 $msg->("reloaded"); 2336 if ($@) {
2337 warn $@;
2338 warn "error while reloading, exiting.";
2339 exit 1;
2340 }
2341
2342 warn "reloaded successfully";
1140}; 2343};
1141 2344
1142sub perl_reload() { 2345#############################################################################
1143 _perl_reload { 2346
1144 warn $_[0]; 2347unless ($LINK_MAP) {
1145 print "$_[0]\n"; 2348 $LINK_MAP = cf::map::new;
1146 }; 2349
2350 $LINK_MAP->width (41);
2351 $LINK_MAP->height (41);
2352 $LINK_MAP->alloc;
2353 $LINK_MAP->path ("{link}");
2354 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2355 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2356
2357 # dirty hack because... archetypes are not yet loaded
2358 Event->timer (
2359 after => 10,
2360 cb => sub {
2361 $_[0]->w->cancel;
2362
2363 # provide some exits "home"
2364 my $exit = cf::object::new "exit";
2365
2366 $exit->slaying ($EMERGENCY_POSITION->[0]);
2367 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2368 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2369
2370 $LINK_MAP->insert ($exit->clone, 19, 19);
2371 $LINK_MAP->insert ($exit->clone, 19, 20);
2372 $LINK_MAP->insert ($exit->clone, 19, 21);
2373 $LINK_MAP->insert ($exit->clone, 20, 19);
2374 $LINK_MAP->insert ($exit->clone, 20, 21);
2375 $LINK_MAP->insert ($exit->clone, 21, 19);
2376 $LINK_MAP->insert ($exit->clone, 21, 20);
2377 $LINK_MAP->insert ($exit->clone, 21, 21);
2378
2379 $exit->destroy;
2380 });
2381
2382 $LINK_MAP->{deny_save} = 1;
2383 $LINK_MAP->{deny_reset} = 1;
2384
2385 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1147} 2386}
1148 2387
1149register "<global>", __PACKAGE__; 2388register "<global>", __PACKAGE__;
1150 2389
1151register_command "perl-reload" => sub { 2390register_command "reload" => sub {
1152 my ($who, $arg) = @_; 2391 my ($who, $arg) = @_;
1153 2392
1154 if ($who->flag (FLAG_WIZ)) { 2393 if ($who->flag (FLAG_WIZ)) {
1155 _perl_reload { 2394 $who->message ("start of reload.");
1156 warn $_[0]; 2395 reload;
1157 $who->message ($_[0]); 2396 $who->message ("end of reload.");
1158 };
1159 } 2397 }
1160}; 2398};
1161 2399
1162unshift @INC, $LIBDIR; 2400unshift @INC, $LIBDIR;
1163 2401
1164$TICK_WATCHER = Event->timer ( 2402$TICK_WATCHER = Event->timer (
2403 reentrant => 0,
1165 prio => 0, 2404 prio => 0,
1166 at => $NEXT_TICK || 1, 2405 at => $NEXT_TICK || $TICK,
1167 data => WF_AUTOCANCEL, 2406 data => WF_AUTOCANCEL,
1168 cb => sub { 2407 cb => sub {
1169 cf::server_tick; # one server iteration 2408 cf::server_tick; # one server iteration
1170 2409 $RUNTIME += $TICK;
1171 my $NOW = Event::time;
1172 $NEXT_TICK += $TICK; 2410 $NEXT_TICK += $TICK;
1173 2411
2412 $WAIT_FOR_TICK->broadcast;
2413 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2414
1174 # if we are delayed by four ticks or more, skip them all 2415 # if we are delayed by four ticks or more, skip them all
1175 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2416 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1176 2417
1177 $TICK_WATCHER->at ($NEXT_TICK); 2418 $TICK_WATCHER->at ($NEXT_TICK);
1178 $TICK_WATCHER->start; 2419 $TICK_WATCHER->start;
1179 }, 2420 },
1180); 2421);
1181 2422
1182IO::AIO::max_poll_time $TICK * 0.2; 2423IO::AIO::max_poll_time $TICK * 0.2;
1183 2424
2425Event->io (
1184Event->io (fd => IO::AIO::poll_fileno, 2426 fd => IO::AIO::poll_fileno,
1185 poll => 'r', 2427 poll => 'r',
1186 prio => 5, 2428 prio => 5,
1187 data => WF_AUTOCANCEL, 2429 data => WF_AUTOCANCEL,
1188 cb => \&IO::AIO::poll_cb); 2430 cb => \&IO::AIO::poll_cb,
2431);
2432
2433Event->timer (
2434 data => WF_AUTOCANCEL,
2435 after => 0,
2436 interval => 10,
2437 cb => sub {
2438 (Coro::unblock_sub {
2439 write_runtime
2440 or warn "ERROR: unable to write runtime file: $!";
2441 })->();
2442 },
2443);
2444
2445END { cf::emergency_save }
1189 2446
11901 24471
1191 2448

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines