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.261 by root, Fri Apr 27 20:09:48 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
8use Socket;
5use Storable; 9use Storable;
10use Event;
6use Opcode; 11use Opcode;
7use Safe; 12use Safe;
8use Safe::Hole; 13use Safe::Hole;
9 14
10use IO::AIO (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
18use Coro::Event;
19use Coro::Timer;
20use Coro::Signal;
21use Coro::Semaphore;
22use Coro::AIO;
23use Coro::Storable;
24
25use BDB ();
26use Data::Dumper;
27use Digest::MD5;
28use Fcntl;
11use YAML::Syck (); 29use YAML::Syck ();
30use IO::AIO 2.32 ();
12use Time::HiRes; 31use Time::HiRes;
13use Event; 32use Compress::LZF;
33
34# configure various modules to our taste
35#
36$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39
14$Event::Eval = 1; # no idea why this is required, but it is 40$Event::Eval = 1; # no idea why this is required, but it is
15 41
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1; 43$YAML::Syck::ImplicitUnicode = 1;
18 44
19use strict; 45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20 46
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 48
23our %COMMAND = (); 49our %COMMAND = ();
24our %COMMAND_TIME = (); 50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
25our %EXTCMD = (); 53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
26 56
27_init_vars; 57our $RELOAD; # number of reloads so far
28
29our @EVENT; 58our @EVENT;
30our $LIBDIR = datadir . "/ext";
31 59
32our $TICK = MAX_TIME * 1e-6; 60our $CONFDIR = confdir;
61our $DATADIR = datadir;
62our $LIBDIR = "$DATADIR/ext";
63our $PODDIR = "$DATADIR/pod";
64our $MAPDIR = "$DATADIR/" . mapdir;
65our $LOCALDIR = localdir;
66our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db";
71
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
33our $TICK_WATCHER; 73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
34our $NEXT_TICK; 76our $NEXT_TICK;
77our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off
79
80our $BDB_POLL_WATCHER;
81our $DB_ENV;
35 82
36our %CFG; 83our %CFG;
37 84
38our $UPTIME; $UPTIME ||= time; 85our $UPTIME; $UPTIME ||= time;
86our $RUNTIME;
87
88our %PLAYER; # all users
89our %MAP; # all maps
90our $LINK_MAP; # the special {link} map, which is always available
91
92# used to convert map paths into valid unix filenames by replacing / by ∕
93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94
95binmode STDOUT;
96binmode STDERR;
97
98# read virtual server time, if available
99unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
100 open my $fh, "<", "$LOCALDIR/runtime"
101 or die "unable to read runtime file: $!";
102 $RUNTIME = <$fh> + 0.;
103}
104
105mkdir $_
106 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
107
108our $EMERGENCY_POSITION;
109
110sub cf::map::normalise;
39 111
40############################################################################# 112#############################################################################
41 113
42=head2 GLOBAL VARIABLES 114=head2 GLOBAL VARIABLES
43 115
45 117
46=item $cf::UPTIME 118=item $cf::UPTIME
47 119
48The timestamp of the server start (so not actually an uptime). 120The timestamp of the server start (so not actually an uptime).
49 121
50=item $cf::LIBDIR 122=item $cf::RUNTIME
51 123
52The perl library directory, where extensions and cf-specific modules can 124The time this server has run, starts at 0 and is increased by $cf::TICK on
53be found. It will be added to C<@INC> automatically. 125every server tick.
126
127=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
128$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
129$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
130
131Various directories - "/etc", read-only install directory, perl-library
132directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
133unique-items directory, player file directory, random maps directory and
134database environment.
135
136=item $cf::NOW
137
138The time of the last (current) server tick.
54 139
55=item $cf::TICK 140=item $cf::TICK
56 141
57The interval between server ticks, in seconds. 142The interval between server ticks, in seconds.
58 143
59=item %cf::CFG 144=item %cf::CFG
60 145
61Configuration for the server, loaded from C</etc/crossfire/config>, or 146Configuration for the server, loaded from C</etc/crossfire/config>, or
62from wherever your confdir points to. 147from wherever your confdir points to.
148
149=item cf::wait_for_tick, cf::wait_for_tick_begin
150
151These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
152returns directly I<after> the tick processing (and consequently, can only wake one process
153per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
63 154
64=back 155=back
65 156
66=cut 157=cut
67 158
68BEGIN { 159BEGIN {
69 *CORE::GLOBAL::warn = sub { 160 *CORE::GLOBAL::warn = sub {
70 my $msg = join "", @_; 161 my $msg = join "", @_;
162
71 $msg .= "\n" 163 $msg .= "\n"
72 unless $msg =~ /\n$/; 164 unless $msg =~ /\n$/;
73 165
74 print STDERR "cfperl: $msg"; 166 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
167
168 utf8::encode $msg;
75 LOG llevError, "cfperl: $msg"; 169 LOG llevError, $msg;
76 }; 170 };
77} 171}
78 172
79@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 173@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
80@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 174@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
84@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 178@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
85 179
86# we bless all objects into (empty) derived classes to force a method lookup 180# we bless all objects into (empty) derived classes to force a method lookup
87# within the Safe compartment. 181# within the Safe compartment.
88for my $pkg (qw( 182for my $pkg (qw(
89 cf::global 183 cf::global cf::attachable
90 cf::object cf::object::player 184 cf::object cf::object::player
91 cf::client cf::player 185 cf::client cf::player
92 cf::arch cf::living 186 cf::arch cf::living
93 cf::map cf::party cf::region 187 cf::map cf::party cf::region
94)) { 188)) {
98 192
99$Event::DIED = sub { 193$Event::DIED = sub {
100 warn "error in event callback: @_"; 194 warn "error in event callback: @_";
101}; 195};
102 196
103my %ext_pkg;
104my @exts;
105my @hook;
106
107=head2 UTILITY FUNCTIONS 197=head2 UTILITY FUNCTIONS
108 198
109=over 4 199=over 4
110 200
111=cut 201=item dumpval $ref
112 202
203=cut
204
205sub dumpval {
206 eval {
207 local $SIG{__DIE__};
208 my $d;
209 if (1) {
210 $d = new Data::Dumper([$_[0]], ["*var"]);
211 $d->Terse(1);
212 $d->Indent(2);
213 $d->Quotekeys(0);
214 $d->Useqq(1);
215 #$d->Bless(...);
216 $d->Seen($_[1]) if @_ > 1;
217 $d = $d->Dump();
218 }
219 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
220 $d
221 } || "[unable to dump $_[0]: '$@']";
222}
223
113use JSON::Syck (); # TODO# replace by JSON::PC once working 224use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
114 225
115=item $ref = cf::from_json $json 226=item $ref = cf::from_json $json
116 227
117Converts a JSON string into the corresponding perl data structure. 228Converts a JSON string into the corresponding perl data structure.
118 229
119=cut
120
121sub from_json($) {
122 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
123 JSON::Syck::Load $_[0]
124}
125
126=item $json = cf::to_json $ref 230=item $json = cf::to_json $ref
127 231
128Converts a perl data structure into its JSON representation. 232Converts a perl data structure into its JSON representation.
129 233
130=cut 234=item cf::lock_wait $string
131 235
132sub to_json($) { 236Wait until the given lock is available. See cf::lock_acquire.
133 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 237
134 JSON::Syck::Dump $_[0] 238=item my $lock = cf::lock_acquire $string
239
240Wait until the given lock is available and then acquires it and returns
241a Coro::guard object. If the guard object gets destroyed (goes out of scope,
242for example when the coroutine gets canceled), the lock is automatically
243returned.
244
245Lock names should begin with a unique identifier (for example, cf::map::find
246uses map_find and cf::map::load uses map_load).
247
248=item $locked = cf::lock_active $string
249
250Return true if the lock is currently active, i.e. somebody has locked it.
251
252=cut
253
254our %LOCK;
255
256sub lock_wait($) {
257 my ($key) = @_;
258
259 # wait for lock, if any
260 while ($LOCK{$key}) {
261 push @{ $LOCK{$key} }, $Coro::current;
262 Coro::schedule;
263 }
264}
265
266sub lock_acquire($) {
267 my ($key) = @_;
268
269 # wait, to be sure we are not locked
270 lock_wait $key;
271
272 $LOCK{$key} = [];
273
274 Coro::guard {
275 # wake up all waiters, to be on the safe side
276 $_->ready for @{ delete $LOCK{$key} };
277 }
278}
279
280sub lock_active($) {
281 my ($key) = @_;
282
283 ! ! $LOCK{$key}
284}
285
286sub freeze_mainloop {
287 return unless $TICK_WATCHER->is_active;
288
289 my $guard = Coro::guard {
290 $TICK_WATCHER->start;
291 };
292 $TICK_WATCHER->stop;
293 $guard
294}
295
296=item cf::async { BLOCK }
297
298Currently the same as Coro::async_pool, meaning you cannot use
299C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
300thing you are allowed to do is call C<prio> on it.
301
302=cut
303
304BEGIN { *async = \&Coro::async_pool }
305
306=item cf::sync_job { BLOCK }
307
308The design of crossfire+ requires that the main coro ($Coro::main) is
309always able to handle events or runnable, as crossfire+ is only partly
310reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
311
312If it must be done, put the blocking parts into C<sync_job>. This will run
313the given BLOCK in another coroutine while waiting for the result. The
314server will be frozen during this time, so the block should either finish
315fast or be very important.
316
317=cut
318
319sub sync_job(&) {
320 my ($job) = @_;
321
322 if ($Coro::current == $Coro::main) {
323 # this is the main coro, too bad, we have to block
324 # till the operation succeeds, freezing the server :/
325
326 # TODO: use suspend/resume instead
327 # (but this is cancel-safe)
328 my $freeze_guard = freeze_mainloop;
329
330 my $busy = 1;
331 my @res;
332
333 (async {
334 @res = eval { $job->() };
335 warn $@ if $@;
336 undef $busy;
337 })->prio (Coro::PRIO_MAX);
338
339 while ($busy) {
340 Coro::cede or Event::one_event;
341 }
342
343 wantarray ? @res : $res[0]
344 } else {
345 # we are in another coroutine, how wonderful, everything just works
346
347 $job->()
348 }
349}
350
351=item $coro = cf::async_ext { BLOCK }
352
353Like async, but this coro is automatically being canceled when the
354extension calling this is being unloaded.
355
356=cut
357
358sub async_ext(&) {
359 my $cb = shift;
360
361 my $coro = &Coro::async ($cb);
362
363 $coro->on_destroy (sub {
364 delete $EXT_CORO{$coro+0};
365 });
366 $EXT_CORO{$coro+0} = $coro;
367
368 $coro
369}
370
371sub write_runtime {
372 my $guard = cf::lock_acquire "write_runtime";
373
374 my $runtime = "$LOCALDIR/runtime";
375
376 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
377 or return;
378
379 my $value = $cf::RUNTIME + 90 + 10;
380 # 10 is the runtime save interval, for a monotonic clock
381 # 60 allows for the watchdog to kill the server.
382
383 (aio_write $fh, 0, (length $value), $value, 0) <= 0
384 and return;
385
386 # always fsync - this file is important
387 aio_fsync $fh
388 and return;
389
390 close $fh
391 or return;
392
393 aio_rename "$runtime~", $runtime
394 and return;
395
396 1
397}
398
399=item cf::datalog type => key => value, ...
400
401Log a datalog packet of the given type with the given key-value pairs.
402
403=cut
404
405sub datalog($@) {
406 my ($type, %kv) = @_;
407 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
135} 408}
136 409
137=back 410=back
138 411
139=cut 412=cut
249 my ($self, $victim) = @_; 522 my ($self, $victim) = @_;
250 ... 523 ...
251 } 524 }
252 } 525 }
253 526
527=item $attachable->valid
528
529Just because you have a perl object does not mean that the corresponding
530C-level object still exists. If you try to access an object that has no
531valid C counterpart anymore you get an exception at runtime. This method
532can be used to test for existence of the C object part without causing an
533exception.
534
254=cut 535=cut
255 536
256# the following variables are defined in .xs and must not be re-created 537# the following variables are defined in .xs and must not be re-created
257our @CB_GLOBAL = (); # registry for all global events 538our @CB_GLOBAL = (); # registry for all global events
539our @CB_ATTACHABLE = (); # registry for all attachables
258our @CB_OBJECT = (); # all objects (should not be used except in emergency) 540our @CB_OBJECT = (); # all objects (should not be used except in emergency)
259our @CB_PLAYER = (); 541our @CB_PLAYER = ();
260our @CB_CLIENT = (); 542our @CB_CLIENT = ();
261our @CB_TYPE = (); # registry for type (cf-object class) based events 543our @CB_TYPE = (); # registry for type (cf-object class) based events
262our @CB_MAP = (); 544our @CB_MAP = ();
263 545
264my %attachment; 546my %attachment;
547
548sub cf::attachable::thawer_merge {
549 # simply override everything except _meta
550 local $_[0]{_meta};
551 %{$_[0]} = %{$_[1]};
552}
265 553
266sub _attach_cb($$$$) { 554sub _attach_cb($$$$) {
267 my ($registry, $event, $prio, $cb) = @_; 555 my ($registry, $event, $prio, $cb) = @_;
268 556
269 use sort 'stable'; 557 use sort 'stable';
272 560
273 @{$registry->[$event]} = sort 561 @{$registry->[$event]} = sort
274 { $a->[0] cmp $b->[0] } 562 { $a->[0] cmp $b->[0] }
275 @{$registry->[$event] || []}, $cb; 563 @{$registry->[$event] || []}, $cb;
276} 564}
565
566# hack
567my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
277 568
278# attach handles attaching event callbacks 569# attach handles attaching event callbacks
279# the only thing the caller has to do is pass the correct 570# the only thing the caller has to do is pass the correct
280# registry (== where the callback attaches to). 571# registry (== where the callback attaches to).
281sub _attach { 572sub _attach {
283 574
284 my $object_type; 575 my $object_type;
285 my $prio = 0; 576 my $prio = 0;
286 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; 577 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
287 578
579 #TODO: get rid of this hack
580 if ($attachable_klass{$klass}) {
581 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
582 }
583
288 while (@arg) { 584 while (@arg) {
289 my $type = shift @arg; 585 my $type = shift @arg;
290 586
291 if ($type eq "prio") { 587 if ($type eq "prio") {
292 $prio = shift @arg; 588 $prio = shift @arg;
367 my ($obj, $name) = @_; 663 my ($obj, $name) = @_;
368 664
369 exists $obj->{_attachment}{$name} 665 exists $obj->{_attachment}{$name}
370} 666}
371 667
372for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { 668for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
373 eval "#line " . __LINE__ . " 'cf.pm' 669 eval "#line " . __LINE__ . " 'cf.pm'
374 sub cf::\L$klass\E::_attach_registry { 670 sub cf::\L$klass\E::_attach_registry {
375 (\\\@CB_$klass, KLASS_$klass) 671 (\\\@CB_$klass, KLASS_$klass)
376 } 672 }
377 673
413 } 709 }
414 710
415 0 711 0
416} 712}
417 713
418=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 714=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
419 715
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, ...) 716=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
425 717
426=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
427
428Generate a global/object/player/map-specific event with the given arguments. 718Generate an object-specific event with the given arguments.
429 719
430This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be 720This 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 721removed in future versions), and there is no public API to access override
432results (if you must, access C<@cf::invoke_results> directly). 722results (if you must, access C<@cf::invoke_results> directly).
433 723
434=back 724=back
435 725
436=cut 726=cut
437 727
438############################################################################# 728#############################################################################
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 729# object support
460 730
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 { 731sub reattach {
732 # basically do the same as instantiate, without calling instantiate
475 my ($obj) = @_; 733 my ($obj) = @_;
734
735 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
736
476 my $registry = $obj->registry; 737 my $registry = $obj->registry;
477 738
478 @$registry = (); 739 @$registry = ();
479 740
480 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 741 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
489 warn "object uses attachment '$name' that is not available, postponing.\n"; 750 warn "object uses attachment '$name' that is not available, postponing.\n";
490 } 751 }
491 } 752 }
492} 753}
493 754
494sub object_freezer_save { 755cf::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, 756 prio => -1000000,
757 on_instantiate => sub {
758 my ($obj, $data) = @_;
759
760 $data = from_json $data;
761
762 for (@$data) {
763 my ($name, $args) = @$_;
764
765 $obj->attach ($name, %{$args || {} });
766 }
767 },
768 on_reattach => \&reattach,
554 on_clone => sub { 769 on_clone => sub {
555 my ($src, $dst) = @_; 770 my ($src, $dst) = @_;
556 771
557 @{$dst->registry} = @{$src->registry}; 772 @{$dst->registry} = @{$src->registry};
558 773
561 %{$dst->{_attachment}} = %{$src->{_attachment}} 776 %{$dst->{_attachment}} = %{$src->{_attachment}}
562 if exists $src->{_attachment}; 777 if exists $src->{_attachment};
563 }, 778 },
564); 779);
565 780
781sub object_freezer_save {
782 my ($filename, $rdata, $objs) = @_;
783
784 sync_job {
785 if (length $$rdata) {
786 warn sprintf "saving %s (%d,%d)\n",
787 $filename, length $$rdata, scalar @$objs;
788
789 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
790 chmod SAVE_MODE, $fh;
791 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
792 aio_fsync $fh if $cf::USE_FSYNC;
793 close $fh;
794
795 if (@$objs) {
796 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
797 chmod SAVE_MODE, $fh;
798 my $data = Storable::nfreeze { version => 1, objs => $objs };
799 aio_write $fh, 0, (length $data), $data, 0;
800 aio_fsync $fh if $cf::USE_FSYNC;
801 close $fh;
802 aio_rename "$filename.pst~", "$filename.pst";
803 }
804 } else {
805 aio_unlink "$filename.pst";
806 }
807
808 aio_rename "$filename~", $filename;
809 } else {
810 warn "FATAL: $filename~: $!\n";
811 }
812 } else {
813 aio_unlink $filename;
814 aio_unlink "$filename.pst";
815 }
816 }
817}
818
819sub object_freezer_as_string {
820 my ($rdata, $objs) = @_;
821
822 use Data::Dumper;
823
824 $$rdata . Dumper $objs
825}
826
827sub object_thawer_load {
828 my ($filename) = @_;
829
830 my ($data, $av);
831
832 (aio_load $filename, $data) >= 0
833 or return;
834
835 unless (aio_stat "$filename.pst") {
836 (aio_load "$filename.pst", $av) >= 0
837 or return;
838 $av = eval { (Storable::thaw $av)->{objs} };
839 }
840
841 warn sprintf "loading %s (%d)\n",
842 $filename, length $data, scalar @{$av || []};#d#
843 return ($data, $av);
844}
845
566############################################################################# 846#############################################################################
567# command handling &c 847# command handling &c
568 848
569=item cf::register_command $name => \&callback($ob,$args); 849=item cf::register_command $name => \&callback($ob,$args);
570 850
592=cut 872=cut
593 873
594sub register_extcmd { 874sub register_extcmd {
595 my ($name, $cb) = @_; 875 my ($name, $cb) = @_;
596 876
597 my $caller = caller;
598 #warn "registering extcmd '$name' to '$caller'";
599
600 $EXTCMD{$name} = [$cb, $caller]; 877 $EXTCMD{$name} = $cb;
601} 878}
602 879
603cf::player->attach ( 880cf::player->attach (
604 on_command => sub { 881 on_command => sub {
605 my ($pl, $name, $params) = @_; 882 my ($pl, $name, $params) = @_;
618 895
619 my $msg = eval { from_json $buf }; 896 my $msg = eval { from_json $buf };
620 897
621 if (ref $msg) { 898 if (ref $msg) {
622 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 899 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
623 if (my %reply = $cb->[0]->($pl, $msg)) { 900 if (my %reply = $cb->($pl, $msg)) {
624 $pl->ext_reply ($msg->{msgid}, %reply); 901 $pl->ext_reply ($msg->{msgid}, %reply);
625 } 902 }
626 } 903 }
627 } else { 904 } else {
628 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 905 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
630 907
631 cf::override; 908 cf::override;
632 }, 909 },
633); 910);
634 911
635sub register {
636 my ($base, $pkg) = @_;
637
638 #TODO
639}
640
641sub load_extension { 912sub load_extension {
642 my ($path) = @_; 913 my ($path) = @_;
643 914
644 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 915 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
645 my $base = $1; 916 my $base = $1;
646 my $pkg = $1; 917 my $pkg = $1;
647 $pkg =~ s/[^[:word:]]/_/g; 918 $pkg =~ s/[^[:word:]]/_/g;
648 $pkg = "ext::$pkg"; 919 $pkg = "ext::$pkg";
649 920
650 warn "loading '$path' into '$pkg'\n"; 921 warn "... loading '$path' into '$pkg'\n";
651 922
652 open my $fh, "<:utf8", $path 923 open my $fh, "<:utf8", $path
653 or die "$path: $!"; 924 or die "$path: $!";
654 925
655 my $source = 926 my $source =
656 "package $pkg; use strict; use utf8;\n" 927 "package $pkg; use strict; use utf8;\n"
657 . "#line 1 \"$path\"\n{\n" 928 . "#line 1 \"$path\"\n{\n"
658 . (do { local $/; <$fh> }) 929 . (do { local $/; <$fh> })
659 . "\n};\n1"; 930 . "\n};\n1";
660 931
661 eval $source 932 unless (eval $source) {
662 or die $@ ? "$path: $@\n" 933 my $msg = $@ ? "$path: $@\n"
663 : "extension disabled.\n"; 934 : "extension disabled.\n";
664 935 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
665 push @exts, $pkg; 936 warn $@;
666 $ext_pkg{$base} = $pkg; 937 warn "mandatory extension failed to load, exiting.\n";
667 938 exit 1;
668# no strict 'refs'; 939 }
669# @{"$pkg\::ISA"} = ext::; 940 die $@;
670
671 register $base, $pkg;
672}
673
674sub unload_extension {
675 my ($pkg) = @_;
676
677 warn "removing extension $pkg\n";
678
679 # remove hooks
680 #TODO
681# for my $idx (0 .. $#PLUGIN_EVENT) {
682# delete $hook[$idx]{$pkg};
683# } 941 }
684 942
685 # remove commands 943 push @EXTS, $pkg;
686 for my $name (keys %COMMAND) {
687 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
688
689 if (@cb) {
690 $COMMAND{$name} = \@cb;
691 } else {
692 delete $COMMAND{$name};
693 }
694 }
695
696 # remove extcmds
697 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
698 delete $EXTCMD{$name};
699 }
700
701 if (my $cb = $pkg->can ("unload")) {
702 eval {
703 $cb->($pkg);
704 1
705 } or warn "$pkg unloaded, but with errors: $@";
706 }
707
708 Symbol::delete_package $pkg;
709} 944}
710 945
711sub load_extensions { 946sub load_extensions {
712 for my $ext (<$LIBDIR/*.ext>) { 947 for my $ext (<$LIBDIR/*.ext>) {
713 next unless -r $ext; 948 next unless -r $ext;
717 } or warn "$ext not loaded: $@"; 952 } or warn "$ext not loaded: $@";
718 } 953 }
719} 954}
720 955
721############################################################################# 956#############################################################################
722# load/save/clean perl data associated with a map
723 957
724*cf::mapsupport::on_clean = sub { 958=head2 CORE EXTENSIONS
959
960Functions and methods that extend core crossfire objects.
961
962=cut
963
964package cf::player;
965
966use Coro::AIO;
967
968=head3 cf::player
969
970=over 4
971
972=item cf::player::find $login
973
974Returns the given player object, loading it if necessary (might block).
975
976=cut
977
978sub playerdir($) {
979 "$PLAYERDIR/"
980 . (ref $_[0] ? $_[0]->ob->name : $_[0])
981}
982
983sub path($) {
984 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
985
986 (playerdir $login) . "/playerdata"
987}
988
989sub find_active($) {
990 $cf::PLAYER{$_[0]}
991 and $cf::PLAYER{$_[0]}->active
992 and $cf::PLAYER{$_[0]}
993}
994
995sub exists($) {
996 my ($login) = @_;
997
998 $cf::PLAYER{$login}
999 or cf::sync_job { !aio_stat path $login }
1000}
1001
1002sub find($) {
1003 return $cf::PLAYER{$_[0]} || do {
1004 my $login = $_[0];
1005
1006 my $guard = cf::lock_acquire "user_find:$login";
1007
1008 $cf::PLAYER{$_[0]} || do {
1009 # rename old playerfiles to new ones
1010 #TODO: remove when no longer required
1011 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1012 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1013 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1014 aio_unlink +(playerdir $login) . "/$login.pl";
1015
1016 my $pl = load_pl path $login
1017 or return;
1018 $cf::PLAYER{$login} = $pl
1019 }
1020 }
1021}
1022
1023sub save($) {
1024 my ($pl) = @_;
1025
1026 return if $pl->{deny_save};
1027
1028 my $path = path $pl;
1029 my $guard = cf::lock_acquire "user_save:$path";
1030
1031 return if $pl->{deny_save};
1032
1033 aio_mkdir playerdir $pl, 0770;
1034 $pl->{last_save} = $cf::RUNTIME;
1035
1036 $pl->save_pl ($path);
1037 Coro::cede;
1038}
1039
1040sub new($) {
1041 my ($login) = @_;
1042
1043 my $self = create;
1044
1045 $self->ob->name ($login);
1046 $self->{deny_save} = 1;
1047
1048 $cf::PLAYER{$login} = $self;
1049
1050 $self
1051}
1052
1053=item $pl->quit_character
1054
1055Nukes the player without looking back. If logged in, the connection will
1056be destroyed. May block for a long time.
1057
1058=cut
1059
1060sub quit_character {
1061 my ($pl) = @_;
1062
1063 my $name = $pl->ob->name;
1064
1065 $pl->{deny_save} = 1;
1066 $pl->password ("*"); # this should lock out the player until we nuked the dir
1067
1068 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1069 $pl->deactivate;
1070 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1071 $pl->ns->destroy if $pl->ns;
1072
1073 my $path = playerdir $pl;
1074 my $temp = "$path~$cf::RUNTIME~deleting~";
1075 aio_rename $path, $temp;
1076 delete $cf::PLAYER{$pl->ob->name};
1077 $pl->destroy;
1078
1079 my $prefix = qr<^~\Q$name\E/>;
1080
1081 # nuke player maps
1082 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1083
1084 IO::AIO::aio_rmtree $temp;
1085}
1086
1087=item $pl->kick
1088
1089Kicks a player out of the game. This destroys the connection.
1090
1091=cut
1092
1093sub kick {
1094 my ($pl, $kicker) = @_;
1095
1096 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1097 $pl->killer ("kicked");
1098 $pl->ns->destroy;
1099}
1100
1101=item cf::player::list_logins
1102
1103Returns am arrayref of all valid playernames in the system, can take a
1104while and may block, so not sync_job-capable, ever.
1105
1106=cut
1107
1108sub list_logins {
1109 my $dirs = aio_readdir $PLAYERDIR
1110 or return [];
1111
1112 my @logins;
1113
1114 for my $login (@$dirs) {
1115 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1116 aio_read $fh, 0, 512, my $buf, 0 or next;
1117 $buf !~ /^password -------------$/m or next; # official not-valid tag
1118
1119 utf8::decode $login;
1120 push @logins, $login;
1121 }
1122
1123 \@logins
1124}
1125
1126=item $player->maps
1127
1128Returns an arrayref of map paths that are private for this
1129player. May block.
1130
1131=cut
1132
1133sub maps($) {
1134 my ($pl) = @_;
1135
1136 $pl = ref $pl ? $pl->ob->name : $pl;
1137
1138 my $files = aio_readdir playerdir $pl
1139 or return;
1140
1141 my @paths;
1142
1143 for (@$files) {
1144 utf8::decode $_;
1145 next if /\.(?:pl|pst)$/;
1146 next unless /^$PATH_SEP/o;
1147
1148 push @paths, cf::map::normalise "~$pl/$_";
1149 }
1150
1151 \@paths
1152}
1153
1154=item $player->ext_reply ($msgid, %msg)
1155
1156Sends an ext reply to the player.
1157
1158=cut
1159
1160sub ext_reply($$%) {
1161 my ($self, $id, %msg) = @_;
1162
1163 $msg{msgid} = $id;
1164
1165 $self->send ("ext " . cf::to_json \%msg);
1166}
1167
1168=item $player->ext_event ($type, %msg)
1169
1170Sends an ext event to the client.
1171
1172=cut
1173
1174sub ext_event($$%) {
1175 my ($self, $type, %msg) = @_;
1176
1177 $self->ns->ext_event ($type, %msg);
1178}
1179
1180=head3 cf::region
1181
1182=over 4
1183
1184=cut
1185
1186package cf::region;
1187
1188=item cf::region::find_by_path $path
1189
1190Tries to decuce the probable region for a map knowing only its path.
1191
1192=cut
1193
1194sub find_by_path($) {
1195 my ($path) = @_;
1196
1197 my ($match, $specificity);
1198
1199 for my $region (list) {
1200 if ($region->match && $path =~ $region->match) {
1201 ($match, $specificity) = ($region, $region->specificity)
1202 if $region->specificity > $specificity;
1203 }
1204 }
1205
1206 $match
1207}
1208
1209=back
1210
1211=head3 cf::map
1212
1213=over 4
1214
1215=cut
1216
1217package cf::map;
1218
1219use Fcntl;
1220use Coro::AIO;
1221
1222use overload
1223 '""' => \&as_string,
1224 fallback => 1;
1225
1226our $MAX_RESET = 3600;
1227our $DEFAULT_RESET = 3000;
1228
1229sub generate_random_map {
1230 my ($self, $rmp) = @_;
1231 # mit "rum" bekleckern, nicht
1232 $self->_create_random_map (
1233 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1234 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1235 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1236 $rmp->{exit_on_final_map},
1237 $rmp->{xsize}, $rmp->{ysize},
1238 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1239 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1240 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1241 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1242 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1243 (cf::region::find $rmp->{region}), $rmp->{custom}
1244 )
1245}
1246
1247=item cf::map->register ($regex, $prio)
1248
1249Register a handler for the map path matching the given regex at the
1250givne priority (higher is better, built-in handlers have priority 0, the
1251default).
1252
1253=cut
1254
1255sub register {
1256 my (undef, $regex, $prio) = @_;
1257 my $pkg = caller;
1258
1259 no strict;
1260 push @{"$pkg\::ISA"}, __PACKAGE__;
1261
1262 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1263}
1264
1265# also paths starting with '/'
1266$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1267
1268sub thawer_merge {
1269 my ($self, $merge) = @_;
1270
1271 # we have to keep some variables in memory intact
1272 local $self->{path};
1273 local $self->{load_path};
1274 local $self->{deny_save};
1275 local $self->{deny_reset};
1276
1277 $self->SUPER::thawer_merge ($merge);
1278}
1279
1280sub normalise {
1281 my ($path, $base) = @_;
1282
1283 $path = "$path"; # make sure its a string
1284
1285 $path =~ s/\.map$//;
1286
1287 # map plan:
1288 #
1289 # /! non-realised random map exit (special hack!)
1290 # {... are special paths that are not being touched
1291 # ?xxx/... are special absolute paths
1292 # ?random/... random maps
1293 # /... normal maps
1294 # ~user/... per-player map of a specific user
1295
1296 $path =~ s/$PATH_SEP/\//go;
1297
1298 # treat it as relative path if it starts with
1299 # something that looks reasonable
1300 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1301 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1302
1303 $base =~ s{[^/]+/?$}{};
1304 $path = "$base/$path";
1305 }
1306
1307 for ($path) {
1308 redo if s{//}{/};
1309 redo if s{/\.?/}{/};
1310 redo if s{/[^/]+/\.\./}{/};
1311 }
1312
1313 $path
1314}
1315
1316sub new_from_path {
1317 my (undef, $path, $base) = @_;
1318
1319 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1320
1321 $path = normalise $path, $base;
1322
1323 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1324 if ($path =~ $EXT_MAP{$pkg}[1]) {
1325 my $self = bless cf::map::new, $pkg;
1326 $self->{path} = $path; $self->path ($path);
1327 $self->init; # pass $1 etc.
1328 return $self;
1329 }
1330 }
1331
1332 Carp::carp "unable to resolve path '$path' (base '$base').";
1333 ()
1334}
1335
1336sub init {
1337 my ($self) = @_;
1338
1339 $self
1340}
1341
1342sub as_string {
1343 my ($self) = @_;
1344
1345 "$self->{path}"
1346}
1347
1348# the displayed name, this is a one way mapping
1349sub visible_name {
1350 &as_string
1351}
1352
1353# the original (read-only) location
1354sub load_path {
1355 my ($self) = @_;
1356
1357 "$MAPDIR/$self->{path}.map"
1358}
1359
1360# the temporary/swap location
1361sub save_path {
1362 my ($self) = @_;
1363
1364 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1365 "$TMPDIR/$path.map"
1366}
1367
1368# the unique path, undef == no special unique path
1369sub uniq_path {
1370 my ($self) = @_;
1371
1372 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1373 "$UNIQUEDIR/$path"
1374}
1375
1376# and all this just because we cannot iterate over
1377# all maps in C++...
1378sub change_all_map_light {
1379 my ($change) = @_;
1380
1381 $_->change_map_light ($change)
1382 for grep $_->outdoor, values %cf::MAP;
1383}
1384
1385sub unlink_save {
1386 my ($self) = @_;
1387
1388 utf8::encode (my $save = $self->save_path);
1389 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1390 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1391}
1392
1393sub load_header_from($) {
1394 my ($self, $path) = @_;
1395
1396 utf8::encode $path;
1397 #aio_open $path, O_RDONLY, 0
1398 # or return;
1399
1400 $self->_load_header ($path)
1401 or return;
1402
1403 $self->{load_path} = $path;
1404
1405 1
1406}
1407
1408sub load_header_orig {
1409 my ($self) = @_;
1410
1411 $self->load_header_from ($self->load_path)
1412}
1413
1414sub load_header_temp {
1415 my ($self) = @_;
1416
1417 $self->load_header_from ($self->save_path)
1418}
1419
1420sub prepare_temp {
1421 my ($self) = @_;
1422
1423 $self->last_access ((delete $self->{last_access})
1424 || $cf::RUNTIME); #d#
1425 # safety
1426 $self->{instantiate_time} = $cf::RUNTIME
1427 if $self->{instantiate_time} > $cf::RUNTIME;
1428}
1429
1430sub prepare_orig {
1431 my ($self) = @_;
1432
1433 $self->{load_original} = 1;
1434 $self->{instantiate_time} = $cf::RUNTIME;
1435 $self->last_access ($cf::RUNTIME);
1436 $self->instantiate;
1437}
1438
1439sub load_header {
1440 my ($self) = @_;
1441
1442 if ($self->load_header_temp) {
1443 $self->prepare_temp;
1444 } else {
1445 $self->load_header_orig
1446 or return;
1447 $self->prepare_orig;
1448 }
1449
1450 $self->default_region (cf::region::find_by_path $self->{path})
1451 unless $self->default_region;
1452
1453 1
1454}
1455
1456sub find;
1457sub find {
1458 my ($path, $origin) = @_;
1459
1460 $path = normalise $path, $origin && $origin->path;
1461
1462 cf::lock_wait "map_find:$path";
1463
1464 $cf::MAP{$path} || do {
1465 my $guard = cf::lock_acquire "map_find:$path";
1466 my $map = new_from_path cf::map $path
1467 or return;
1468
1469 $map->{last_save} = $cf::RUNTIME;
1470
1471 $map->load_header
1472 or return;
1473
1474 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1475 # doing this can freeze the server in a sync job, obviously
1476 #$cf::WAIT_FOR_TICK->wait;
1477 $map->reset;
1478 undef $guard;
1479 return find $path;
1480 }
1481
1482 $cf::MAP{$path} = $map
1483 }
1484}
1485
1486sub pre_load { }
1487sub post_load { }
1488
1489sub load {
1490 my ($self) = @_;
1491
1492 local $self->{deny_reset} = 1; # loading can take a long time
1493
1494 my $path = $self->{path};
1495
1496 {
1497 my $guard = cf::lock_acquire "map_load:$path";
1498
1499 return if $self->in_memory != cf::MAP_SWAPPED;
1500
1501 $self->in_memory (cf::MAP_LOADING);
1502
1503 $self->alloc;
1504
1505 $self->pre_load;
1506 Coro::cede;
1507
1508 $self->_load_objects ($self->{load_path}, 1)
1509 or return;
1510
1511 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1512 if delete $self->{load_original};
1513
1514 if (my $uniq = $self->uniq_path) {
1515 utf8::encode $uniq;
1516 if (aio_open $uniq, O_RDONLY, 0) {
1517 $self->clear_unique_items;
1518 $self->_load_objects ($uniq, 0);
1519 }
1520 }
1521
1522 Coro::cede;
1523 # now do the right thing for maps
1524 $self->link_multipart_objects;
1525 $self->difficulty ($self->estimate_difficulty)
1526 unless $self->difficulty;
1527 Coro::cede;
1528
1529 unless ($self->{deny_activate}) {
1530 $self->decay_objects;
1531 $self->fix_auto_apply;
1532 $self->update_buttons;
1533 Coro::cede;
1534 $self->set_darkness_map;
1535 Coro::cede;
1536 $self->activate;
1537 }
1538
1539 $self->in_memory (cf::MAP_IN_MEMORY);
1540 }
1541
1542 $self->post_load;
1543}
1544
1545sub customise_for {
1546 my ($self, $ob) = @_;
1547
1548 return find "~" . $ob->name . "/" . $self->{path}
1549 if $self->per_player;
1550
1551 $self
1552}
1553
1554# find and load all maps in the 3x3 area around a map
1555sub load_diag {
725 my ($map) = @_; 1556 my ($map) = @_;
726 1557
727 my $path = $map->tmpname; 1558 my @diag; # diagonal neighbours
728 defined $path or return;
729 1559
730 unlink "$path.pst"; 1560 for (0 .. 3) {
731}; 1561 my $neigh = $map->tile_path ($_)
1562 or next;
1563 $neigh = find $neigh, $map
1564 or next;
1565 $neigh->load;
732 1566
733cf::map->attach (prio => -10000, package => cf::mapsupport::); 1567 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1568 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1569 }
734 1570
735############################################################################# 1571 for (@diag) {
736# load/save perl data associated with player->ob objects 1572 my $neigh = find @$_
737 1573 or next;
738sub all_objects(@) { 1574 $neigh->load;
739 @_, map all_objects ($_->inv), @_ 1575 }
740} 1576}
741 1577
742# TODO: compatibility cruft, remove when no longer needed 1578sub find_sync {
743cf::player->attach ( 1579 my ($path, $origin) = @_;
744 on_load => sub {
745 my ($pl, $path) = @_;
746 1580
747 for my $o (all_objects $pl->ob) { 1581 cf::sync_job { find $path, $origin }
748 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1582}
749 $o->set_ob_key_value ("_perl_data");
750 1583
751 %$o = %{ Storable::thaw pack "H*", $value }; 1584sub do_load_sync {
1585 my ($map) = @_;
1586
1587 cf::sync_job { $map->load };
1588}
1589
1590our %MAP_PREFETCH;
1591our $MAP_PREFETCHER = undef;
1592
1593sub find_async {
1594 my ($path, $origin) = @_;
1595
1596 $path = normalise $path, $origin && $origin->{path};
1597
1598 if (my $map = $cf::MAP{$path}) {
1599 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1600 }
1601
1602 undef $MAP_PREFETCH{$path};
1603 $MAP_PREFETCHER ||= cf::async {
1604 while (%MAP_PREFETCH) {
1605 for my $path (keys %MAP_PREFETCH) {
1606 my $map = find $path
1607 or next;
1608 $map->load;
1609
1610 delete $MAP_PREFETCH{$path};
752 } 1611 }
753 } 1612 }
1613 undef $MAP_PREFETCHER;
1614 };
1615 $MAP_PREFETCHER->prio (6);
1616
1617 ()
1618}
1619
1620sub save {
1621 my ($self) = @_;
1622
1623 my $lock = cf::lock_acquire "map_data:" . $self->path;
1624
1625 $self->{last_save} = $cf::RUNTIME;
1626
1627 return unless $self->dirty;
1628
1629 my $save = $self->save_path; utf8::encode $save;
1630 my $uniq = $self->uniq_path; utf8::encode $uniq;
1631
1632 $self->{load_path} = $save;
1633
1634 return if $self->{deny_save};
1635
1636 local $self->{last_access} = $self->last_access;#d#
1637
1638 cf::async {
1639 $_->contr->save for $self->players;
1640 };
1641
1642 if ($uniq) {
1643 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1644 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1645 } else {
1646 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
754 }, 1647 }
755); 1648}
756 1649
757############################################################################# 1650sub swap_out {
1651 my ($self) = @_;
758 1652
759=head2 CORE EXTENSIONS 1653 # save first because save cedes
1654 $self->save;
760 1655
761Functions and methods that extend core crossfire objects. 1656 my $lock = cf::lock_acquire "map_data:" . $self->path;
1657
1658 return if $self->players;
1659 return if $self->in_memory != cf::MAP_IN_MEMORY;
1660 return if $self->{deny_save};
1661
1662 $self->clear;
1663 $self->in_memory (cf::MAP_SWAPPED);
1664}
1665
1666sub reset_at {
1667 my ($self) = @_;
1668
1669 # TODO: safety, remove and allow resettable per-player maps
1670 return 1e99 if $self->isa ("ext::map_per_player");#d#
1671 return 1e99 if $self->{deny_reset};
1672
1673 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1674 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1675
1676 $time + $to
1677}
1678
1679sub should_reset {
1680 my ($self) = @_;
1681
1682 $self->reset_at <= $cf::RUNTIME
1683}
1684
1685sub reset {
1686 my ($self) = @_;
1687
1688 my $lock = cf::lock_acquire "map_data:$self->{path}";
1689
1690 return if $self->players;
1691 return if $self->isa ("ext::map_per_player");#d#
1692
1693 warn "resetting map ", $self->path;#d#
1694
1695 $self->in_memory (cf::MAP_SWAPPED);
1696
1697 # need to save uniques path
1698 unless ($self->{deny_save}) {
1699 my $uniq = $self->uniq_path; utf8::encode $uniq;
1700
1701 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1702 if $uniq;
1703 }
1704
1705 delete $cf::MAP{$self->path};
1706
1707 $self->clear;
1708
1709 $_->clear_links_to ($self) for values %cf::MAP;
1710
1711 $self->unlink_save;
1712 $self->destroy;
1713}
1714
1715my $nuke_counter = "aaaa";
1716
1717sub nuke {
1718 my ($self) = @_;
1719
1720 delete $cf::MAP{$self->path};
1721
1722 $self->unlink_save;
1723
1724 bless $self, "cf::map";
1725 delete $self->{deny_reset};
1726 $self->{deny_save} = 1;
1727 $self->reset_timeout (1);
1728 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1729
1730 $cf::MAP{$self->path} = $self;
1731
1732 $self->reset; # polite request, might not happen
1733}
1734
1735=item cf::map::unique_maps
1736
1737Returns an arrayref of paths of all shared maps that have
1738instantiated unique items. May block.
1739
1740=cut
1741
1742sub unique_maps() {
1743 my $files = aio_readdir $UNIQUEDIR
1744 or return;
1745
1746 my @paths;
1747
1748 for (@$files) {
1749 utf8::decode $_;
1750 next if /\.pst$/;
1751 next unless /^$PATH_SEP/o;
1752
1753 push @paths, cf::map::normalise $_;
1754 }
1755
1756 \@paths
1757}
1758
1759package cf;
1760
1761=back
1762
1763=head3 cf::object
1764
1765=cut
1766
1767package cf::object;
762 1768
763=over 4 1769=over 4
764 1770
765=item cf::player::exists $login 1771=item $ob->inv_recursive
766 1772
767Returns true when the given account exists. 1773Returns the inventory of the object _and_ their inventories, recursively.
768 1774
769=cut 1775=cut
770 1776
771sub cf::player::exists($) { 1777sub inv_recursive_;
772 cf::player::find $_[0] 1778sub inv_recursive_ {
773 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1779 map { $_, inv_recursive_ $_->inv } @_
774} 1780}
1781
1782sub inv_recursive {
1783 inv_recursive_ inv $_[0]
1784}
1785
1786package cf;
1787
1788=back
1789
1790=head3 cf::object::player
1791
1792=over 4
775 1793
776=item $player_object->reply ($npc, $msg[, $flags]) 1794=item $player_object->reply ($npc, $msg[, $flags])
777 1795
778Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1796Sends 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 1797can be C<undef>. Does the right thing when the player is currently in a
781 1799
782=cut 1800=cut
783 1801
784# rough implementation of a future "reply" method that works 1802# rough implementation of a future "reply" method that works
785# with dialog boxes. 1803# with dialog boxes.
1804#TODO: the first argument must go, split into a $npc->reply_to ( method
786sub cf::object::player::reply($$$;$) { 1805sub cf::object::player::reply($$$;$) {
787 my ($self, $npc, $msg, $flags) = @_; 1806 my ($self, $npc, $msg, $flags) = @_;
788 1807
789 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1808 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
790 1809
794 $msg = $npc->name . " says: $msg" if $npc; 1813 $msg = $npc->name . " says: $msg" if $npc;
795 $self->message ($msg, $flags); 1814 $self->message ($msg, $flags);
796 } 1815 }
797} 1816}
798 1817
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") 1818=item $player_object->may ("access")
814 1819
815Returns wether the given player is authorized to access resource "access" 1820Returns wether the given player is authorized to access resource "access"
816(e.g. "command_wizcast"). 1821(e.g. "command_wizcast").
817 1822
824 (ref $cf::CFG{"may_$access"} 1829 (ref $cf::CFG{"may_$access"}
825 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1830 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
826 : $cf::CFG{"may_$access"}) 1831 : $cf::CFG{"may_$access"})
827} 1832}
828 1833
829=cut 1834=item $player_object->enter_link
830 1835
831############################################################################# 1836Freezes the player and moves him/her to a special map (C<{link}>).
1837
1838The player should be reasonably safe there for short amounts of time. You
1839I<MUST> call C<leave_link> as soon as possible, though.
1840
1841Will never block.
1842
1843=item $player_object->leave_link ($map, $x, $y)
1844
1845Moves the player out of the special C<{link}> map onto the specified
1846map. If the map is not valid (or omitted), the player will be moved back
1847to the location he/she was before the call to C<enter_link>, or, if that
1848fails, to the emergency map position.
1849
1850Might block.
1851
1852=cut
1853
1854sub link_map {
1855 unless ($LINK_MAP) {
1856 $LINK_MAP = cf::map::find "{link}"
1857 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1858 $LINK_MAP->load;
1859 }
1860
1861 $LINK_MAP
1862}
1863
1864sub cf::object::player::enter_link {
1865 my ($self) = @_;
1866
1867 $self->deactivate_recursive;
1868
1869 return if UNIVERSAL::isa $self->map, "ext::map_link";
1870
1871 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1872 if $self->map;
1873
1874 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1875}
1876
1877sub cf::object::player::leave_link {
1878 my ($self, $map, $x, $y) = @_;
1879
1880 my $link_pos = delete $self->{_link_pos};
1881
1882 unless ($map) {
1883 # restore original map position
1884 ($map, $x, $y) = @{ $link_pos || [] };
1885 $map = cf::map::find $map;
1886
1887 unless ($map) {
1888 ($map, $x, $y) = @$EMERGENCY_POSITION;
1889 $map = cf::map::find $map
1890 or die "FATAL: cannot load emergency map\n";
1891 }
1892 }
1893
1894 ($x, $y) = (-1, -1)
1895 unless (defined $x) && (defined $y);
1896
1897 # use -1 or undef as default coordinates, not 0, 0
1898 ($x, $y) = ($map->enter_x, $map->enter_y)
1899 if $x <=0 && $y <= 0;
1900
1901 $map->load;
1902 $map->load_diag;
1903
1904 return unless $self->contr->active;
1905 $self->activate_recursive;
1906
1907 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1908 $self->enter_map ($map, $x, $y);
1909}
1910
1911cf::player->attach (
1912 on_logout => sub {
1913 my ($pl) = @_;
1914
1915 # abort map switching before logout
1916 if ($pl->ob->{_link_pos}) {
1917 cf::sync_job {
1918 $pl->ob->leave_link
1919 };
1920 }
1921 },
1922 on_login => sub {
1923 my ($pl) = @_;
1924
1925 # try to abort aborted map switching on player login :)
1926 # should happen only on crashes
1927 if ($pl->ob->{_link_pos}) {
1928 $pl->ob->enter_link;
1929 (async {
1930 $pl->ob->reply (undef,
1931 "There was an internal problem at your last logout, "
1932 . "the server will try to bring you to your intended destination in a second.",
1933 cf::NDI_RED);
1934 # we need this sleep as the login has a concurrent enter_exit running
1935 # and this sleep increases chances of the player not ending up in scorn
1936 Coro::Timer::sleep 1;
1937 $pl->ob->leave_link;
1938 })->prio (2);
1939 }
1940 },
1941);
1942
1943=item $player_object->goto ($path, $x, $y)
1944
1945=cut
1946
1947sub cf::object::player::goto {
1948 my ($self, $path, $x, $y) = @_;
1949
1950 $self->enter_link;
1951
1952 (async {
1953 my $map = eval {
1954 my $map = cf::map::find $path;
1955 $map = $map->customise_for ($self) if $map;
1956 $map
1957 } or
1958 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1959
1960 $self->leave_link ($map, $x, $y);
1961 })->prio (1);
1962}
1963
1964=item $player_object->enter_exit ($exit_object)
1965
1966=cut
1967
1968sub parse_random_map_params {
1969 my ($spec) = @_;
1970
1971 my $rmp = { # defaults
1972 xsize => (cf::rndm 15, 40),
1973 ysize => (cf::rndm 15, 40),
1974 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1975 #layout => string,
1976 };
1977
1978 for (split /\n/, $spec) {
1979 my ($k, $v) = split /\s+/, $_, 2;
1980
1981 $rmp->{lc $k} = $v if (length $k) && (length $v);
1982 }
1983
1984 $rmp
1985}
1986
1987sub prepare_random_map {
1988 my ($exit) = @_;
1989
1990 my $guard = cf::lock_acquire "exit_prepare:$exit";
1991
1992 # all this does is basically replace the /! path by
1993 # a new random map path (?random/...) with a seed
1994 # that depends on the exit object
1995
1996 my $rmp = parse_random_map_params $exit->msg;
1997
1998 if ($exit->map) {
1999 $rmp->{region} = $exit->region->name;
2000 $rmp->{origin_map} = $exit->map->path;
2001 $rmp->{origin_x} = $exit->x;
2002 $rmp->{origin_y} = $exit->y;
2003 }
2004
2005 $rmp->{random_seed} ||= $exit->random_seed;
2006
2007 my $data = cf::to_json $rmp;
2008 my $md5 = Digest::MD5::md5_hex $data;
2009 my $meta = "$RANDOMDIR/$md5.meta";
2010
2011 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2012 aio_write $fh, 0, (length $data), $data, 0;
2013 undef $fh;
2014 aio_rename "$meta~", $meta;
2015
2016 $exit->slaying ("?random/$md5");
2017 $exit->msg (undef);
2018 }
2019}
2020
2021sub cf::object::player::enter_exit {
2022 my ($self, $exit) = @_;
2023
2024 return unless $self->type == cf::PLAYER;
2025
2026 if ($exit->slaying eq "/!") {
2027 #TODO: this should de-fi-ni-te-ly not be a sync-job
2028 # the problem is that $exit might not survive long enough
2029 # so it needs to be done right now, right here
2030 cf::sync_job { prepare_random_map $exit };
2031 }
2032
2033 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2034 my $hp = $exit->stats->hp;
2035 my $sp = $exit->stats->sp;
2036
2037 $self->enter_link;
2038
2039 (async {
2040 $self->deactivate_recursive; # just to be sure
2041 unless (eval {
2042 $self->goto ($slaying, $hp, $sp);
2043
2044 1;
2045 }) {
2046 $self->message ("Something went wrong deep within the crossfire server. "
2047 . "I'll try to bring you back to the map you were before. "
2048 . "Please report this to the dungeon master!",
2049 cf::NDI_UNIQUE | cf::NDI_RED);
2050
2051 warn "ERROR in enter_exit: $@";
2052 $self->leave_link;
2053 }
2054 })->prio (1);
2055}
2056
2057=head3 cf::client
2058
2059=over 4
2060
2061=item $client->send_drawinfo ($text, $flags)
2062
2063Sends a drawinfo packet to the client. Circumvents output buffering so
2064should not be used under normal circumstances.
2065
2066=cut
2067
2068sub cf::client::send_drawinfo {
2069 my ($self, $text, $flags) = @_;
2070
2071 utf8::encode $text;
2072 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2073}
2074
2075=item $client->ext_event ($type, %msg)
2076
2077Sends an exti event to the client.
2078
2079=cut
2080
2081sub cf::client::ext_event($$%) {
2082 my ($self, $type, %msg) = @_;
2083
2084 $msg{msgtype} = "event_$type";
2085 $self->send_packet ("ext " . cf::to_json \%msg);
2086}
2087
2088=item $success = $client->query ($flags, "text", \&cb)
2089
2090Queues a query to the client, calling the given callback with
2091the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2092C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2093
2094Queries can fail, so check the return code. Or don't, as queries will become
2095reliable at some point in the future.
2096
2097=cut
2098
2099sub cf::client::query {
2100 my ($self, $flags, $text, $cb) = @_;
2101
2102 return unless $self->state == ST_PLAYING
2103 || $self->state == ST_SETUP
2104 || $self->state == ST_CUSTOM;
2105
2106 $self->state (ST_CUSTOM);
2107
2108 utf8::encode $text;
2109 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2110
2111 $self->send_packet ($self->{query_queue}[0][0])
2112 if @{ $self->{query_queue} } == 1;
2113}
2114
2115cf::client->attach (
2116 on_reply => sub {
2117 my ($ns, $msg) = @_;
2118
2119 # this weird shuffling is so that direct followup queries
2120 # get handled first
2121 my $queue = delete $ns->{query_queue}
2122 or return; # be conservative, not sure how that can happen, but we saw a crash here
2123
2124 (shift @$queue)->[1]->($msg);
2125 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2126
2127 push @{ $ns->{query_queue} }, @$queue;
2128
2129 if (@{ $ns->{query_queue} } == @$queue) {
2130 if (@$queue) {
2131 $ns->send_packet ($ns->{query_queue}[0][0]);
2132 } else {
2133 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2134 }
2135 }
2136 },
2137);
2138
2139=item $client->async (\&cb)
2140
2141Create a new coroutine, running the specified callback. The coroutine will
2142be automatically cancelled when the client gets destroyed (e.g. on logout,
2143or loss of connection).
2144
2145=cut
2146
2147sub cf::client::async {
2148 my ($self, $cb) = @_;
2149
2150 my $coro = &Coro::async ($cb);
2151
2152 $coro->on_destroy (sub {
2153 delete $self->{_coro}{$coro+0};
2154 });
2155
2156 $self->{_coro}{$coro+0} = $coro;
2157
2158 $coro
2159}
2160
2161cf::client->attach (
2162 on_destroy => sub {
2163 my ($ns) = @_;
2164
2165 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2166 },
2167);
2168
2169=back
2170
832 2171
833=head2 SAFE SCRIPTING 2172=head2 SAFE SCRIPTING
834 2173
835Functions that provide a safe environment to compile and execute 2174Functions that provide a safe environment to compile and execute
836snippets of perl code without them endangering the safety of the server 2175snippets of perl code without them endangering the safety of the server
849 2188
850# here we export the classes and methods available to script code 2189# here we export the classes and methods available to script code
851 2190
852=pod 2191=pod
853 2192
854The following fucntions and emthods are available within a safe environment: 2193The following functions and methods are available within a safe environment:
855 2194
856 cf::object contr pay_amount pay_player map 2195 cf::object contr pay_amount pay_player map
857 cf::object::player player 2196 cf::object::player player
858 cf::player peaceful 2197 cf::player peaceful
859 cf::map trigger 2198 cf::map trigger
944############################################################################# 2283#############################################################################
945 2284
946=head2 EXTENSION DATABASE SUPPORT 2285=head2 EXTENSION DATABASE SUPPORT
947 2286
948Crossfire maintains a very simple database for extension use. It can 2287Crossfire maintains a very simple database for extension use. It can
949currently store anything that can be serialised using Storable, which 2288currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
950excludes objects. 2289convert to/from binary).
951 2290
952The parameter C<$family> should best start with the name of the extension 2291The parameter C<$family> should best start with the name of the extension
953using it, it should be unique. 2292using it, it should be unique.
954 2293
955=over 4 2294=over 4
956 2295
957=item $hashref = cf::db_get $family
958
959Return a hashref for use by the extension C<$family>, which can be
960modified. After modifications, you have to call C<cf::db_dirty> or
961C<cf::db_sync>.
962
963=item $value = cf::db_get $family => $key 2296=item $value = cf::db_get $family => $key
964 2297
965Returns a single value from the database 2298Returns a single value from the database.
966
967=item cf::db_put $family => $hashref
968
969Stores the given family hashref into the database. Updates are delayed, if
970you want the data to be synced to disk immediately, use C<cf::db_sync>.
971 2299
972=item cf::db_put $family => $key => $value 2300=item cf::db_put $family => $key => $value
973 2301
974Stores the given C<$value> in the family hash. Updates are delayed, if you 2302Stores the given C<$value> in the family.
975want the data to be synced to disk immediately, use C<cf::db_sync>.
976
977=item cf::db_dirty
978
979Marks the database as dirty, to be updated at a later time.
980
981=item cf::db_sync
982
983Immediately write the database to disk I<if it is dirty>.
984 2303
985=cut 2304=cut
986 2305
987our $DB; 2306our $DB;
988 2307
989{ 2308sub db_init {
990 my $path = cf::localdir . "/database.pst"; 2309 unless ($DB) {
2310 $DB = BDB::db_create $DB_ENV;
991 2311
992 sub db_load() { 2312 cf::sync_job {
993 warn "loading database $path\n";#d# remove later 2313 eval {
994 $DB = stat $path ? Storable::retrieve $path : { }; 2314 $DB->set_flags (BDB::CHKSUM);
995 }
996 2315
997 my $pid; 2316 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
998 2317 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
999 sub db_save() { 2318 cf::cleanup "db_open(db): $!" if $!;
1000 warn "saving database $path\n";#d# remove later 2319 };
1001 waitpid $pid, 0 if $pid; 2320 cf::cleanup "db_open(db): $@" if $@;
1002 if (0 == ($pid = fork)) {
1003 $DB->{_meta}{version} = 1;
1004 Storable::nstore $DB, "$path~";
1005 rename "$path~", $path;
1006 cf::_exit 0 if defined $pid;
1007 } 2321 };
1008 }
1009
1010 my $dirty;
1011
1012 sub db_sync() {
1013 db_save if $dirty;
1014 undef $dirty;
1015 }
1016
1017 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1018 db_sync;
1019 }); 2322 }
2323}
1020 2324
1021 sub db_dirty() {
1022 $dirty = 1;
1023 $idle->start;
1024 }
1025
1026 sub db_get($;$) { 2325sub db_get($$) {
1027 @_ >= 2 2326 my $key = "$_[0]/$_[1]";
1028 ? $DB->{$_[0]}{$_[1]}
1029 : ($DB->{$_[0]} ||= { })
1030 }
1031 2327
2328 cf::sync_job {
2329 BDB::db_get $DB, undef, $key, my $data;
2330
2331 $! ? ()
2332 : $data
2333 }
2334}
2335
1032 sub db_put($$;$) { 2336sub db_put($$$) {
1033 if (@_ >= 3) { 2337 BDB::dbreq_pri 4;
1034 $DB->{$_[0]}{$_[1]} = $_[2]; 2338 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1035 } else { 2339}
1036 $DB->{$_[0]} = $_[1];
1037 }
1038 db_dirty;
1039 }
1040 2340
1041 cf::global->attach ( 2341=item cf::cache $id => [$paths...], $processversion => $process
1042 prio => 10000, 2342
1043 on_cleanup => sub { 2343Generic caching function that returns the value of the resource $id,
1044 db_sync; 2344caching and regenerating as required.
2345
2346This function can block.
2347
2348=cut
2349
2350sub cache {
2351 my ($id, $src, $processversion, $process) = @_;
2352
2353 my $meta =
2354 join "\x00",
2355 $processversion,
2356 map {
2357 aio_stat $_
2358 and Carp::croak "$_: $!";
2359
2360 ($_, (stat _)[7,9])
2361 } @$src;
2362
2363 my $dbmeta = db_get cache => "$id/meta";
2364 if ($dbmeta ne $meta) {
2365 # changed, we may need to process
2366
2367 my @data;
2368 my $md5;
2369
2370 for (0 .. $#$src) {
2371 0 <= aio_load $src->[$_], $data[$_]
2372 or Carp::croak "$src->[$_]: $!";
1045 }, 2373 }
1046 ); 2374
2375 # if processing is expensive, check
2376 # checksum first
2377 if (1) {
2378 $md5 =
2379 join "\x00",
2380 $processversion,
2381 map {
2382 Coro::cede;
2383 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2384 } 0.. $#$src;
2385
2386
2387 my $dbmd5 = db_get cache => "$id/md5";
2388 if ($dbmd5 eq $md5) {
2389 db_put cache => "$id/meta", $meta;
2390
2391 return db_get cache => "$id/data";
2392 }
2393 }
2394
2395 my $t1 = Time::HiRes::time;
2396 my $data = $process->(\@data);
2397 my $t2 = Time::HiRes::time;
2398
2399 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2400
2401 db_put cache => "$id/data", $data;
2402 db_put cache => "$id/md5" , $md5;
2403 db_put cache => "$id/meta", $meta;
2404
2405 return $data;
2406 }
2407
2408 db_get cache => "$id/data"
1047} 2409}
2410
2411=item fork_call { }, $args
2412
2413Executes the given code block with the given arguments in a seperate
2414process, returning the results. Everything must be serialisable with
2415Coro::Storable. May, of course, block. Note that the executed sub may
2416never block itself or use any form of Event handling.
2417
2418=cut
2419
2420sub fork_call(&@) {
2421 my ($cb, @args) = @_;
2422
2423# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2424# or die "socketpair: $!";
2425 pipe my $fh1, my $fh2
2426 or die "pipe: $!";
2427
2428 if (my $pid = fork) {
2429 close $fh2;
2430
2431 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2432 $res = Coro::Storable::thaw $res;
2433
2434 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2435
2436 die $$res unless "ARRAY" eq ref $res;
2437
2438 return wantarray ? @$res : $res->[-1];
2439 } else {
2440 local $SIG{__WARN__};
2441 eval {
2442 local $SIG{__DIE__};
2443 close $fh1;
2444
2445 my @res = eval { $cb->(@args) };
2446 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2447 };
2448
2449 warn $@ if $@;
2450 _exit 0;
2451 }
2452}
2453
2454
1048 2455
1049############################################################################# 2456#############################################################################
1050# the server's main() 2457# the server's init and main functions
2458
2459sub load_facedata($) {
2460 my ($path) = @_;
2461
2462 warn "loading facedata from $path\n";
2463
2464 my $facedata;
2465 0 < aio_load $path, $facedata
2466 or die "$path: $!";
2467
2468 $facedata = Coro::Storable::thaw $facedata;
2469
2470 $facedata->{version} == 2
2471 or cf::cleanup "$path: version mismatch, cannot proceed.";
2472
2473 {
2474 my $faces = $facedata->{faceinfo};
2475
2476 while (my ($face, $info) = each %$faces) {
2477 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2478 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2479 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2480 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2481 Coro::cede;
2482 }
2483
2484 while (my ($face, $info) = each %$faces) {
2485 next unless $info->{smooth};
2486 my $idx = cf::face::find $face
2487 or next;
2488 if (my $smooth = cf::face::find $info->{smooth}) {
2489 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2490 } else {
2491 warn "smooth face '$info->{smooth}' not found for face '$face'";
2492 }
2493 Coro::cede;
2494 }
2495 }
2496
2497 {
2498 my $anims = $facedata->{animinfo};
2499
2500 while (my ($anim, $info) = each %$anims) {
2501 cf::anim::set $anim, $info->{frames}, $info->{facings};
2502 Coro::cede;
2503 }
2504
2505 cf::anim::invalidate_all; # d'oh
2506 }
2507
2508 1
2509}
2510
2511sub reload_regions {
2512 load_resource_file "$MAPDIR/regions"
2513 or die "unable to load regions file\n";
2514}
2515
2516sub reload_facedata {
2517 load_facedata "$DATADIR/facedata"
2518 or die "unable to load facedata\n";
2519}
2520
2521sub reload_archetypes {
2522 load_resource_file "$DATADIR/archetypes"
2523 or die "unable to load archetypes\n";
2524}
2525
2526sub reload_treasures {
2527 load_resource_file "$DATADIR/treasures"
2528 or die "unable to load treasurelists\n";
2529}
2530
2531sub reload_resources {
2532 warn "reloading resource files...\n";
2533
2534 reload_regions;
2535 reload_facedata;
2536 reload_archetypes;
2537 reload_treasures;
2538
2539 warn "finished reloading resource files\n";
2540}
2541
2542sub init {
2543 reload_resources;
2544}
1051 2545
1052sub cfg_load { 2546sub cfg_load {
1053 open my $fh, "<:utf8", cf::confdir . "/config" 2547 open my $fh, "<:utf8", "$CONFDIR/config"
1054 or return; 2548 or return;
1055 2549
1056 local $/; 2550 local $/;
1057 *CFG = YAML::Syck::Load <$fh>; 2551 *CFG = YAML::Syck::Load <$fh>;
2552
2553 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2554
2555 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2556 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2557
2558 if (exists $CFG{mlockall}) {
2559 eval {
2560 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2561 and die "WARNING: m(un)lockall failed: $!\n";
2562 };
2563 warn $@ if $@;
2564 }
1058} 2565}
1059 2566
1060sub main { 2567sub main {
2568 # we must not ever block the main coroutine
2569 local $Coro::idle = sub {
2570 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2571 (async {
2572 Event::one_event;
2573 })->prio (Coro::PRIO_MAX);
2574 };
2575
1061 cfg_load; 2576 cfg_load;
1062 db_load; 2577 db_init;
1063 load_extensions; 2578 load_extensions;
2579
2580 $TICK_WATCHER->start;
1064 Event::loop; 2581 Event::loop;
1065} 2582}
1066 2583
1067############################################################################# 2584#############################################################################
1068# initialisation 2585# initialisation and cleanup
1069 2586
1070sub _perl_reload(&) { 2587# install some emergency cleanup handlers
2588BEGIN {
2589 for my $signal (qw(INT HUP TERM)) {
2590 Event->signal (
2591 reentrant => 0,
2592 data => WF_AUTOCANCEL,
2593 signal => $signal,
2594 prio => 0,
2595 cb => sub {
2596 cf::cleanup "SIG$signal";
2597 },
2598 );
2599 }
2600}
2601
2602sub emergency_save() {
2603 my $freeze_guard = cf::freeze_mainloop;
2604
2605 warn "enter emergency perl save\n";
2606
2607 cf::sync_job {
2608 # use a peculiar iteration method to avoid tripping on perl
2609 # refcount bugs in for. also avoids problems with players
2610 # and maps saved/destroyed asynchronously.
2611 warn "begin emergency player save\n";
2612 for my $login (keys %cf::PLAYER) {
2613 my $pl = $cf::PLAYER{$login} or next;
2614 $pl->valid or next;
2615 $pl->save;
2616 }
2617 warn "end emergency player save\n";
2618
2619 warn "begin emergency map save\n";
2620 for my $path (keys %cf::MAP) {
2621 my $map = $cf::MAP{$path} or next;
2622 $map->valid or next;
2623 $map->save;
2624 }
2625 warn "end emergency map save\n";
2626
2627 warn "begin emergency database checkpoint\n";
2628 BDB::db_env_txn_checkpoint $DB_ENV;
2629 warn "end emergency database checkpoint\n";
2630 };
2631
2632 warn "leave emergency perl save\n";
2633}
2634
2635sub post_cleanup {
1071 my ($msg) = @_; 2636 my ($make_core) = @_;
1072 2637
1073 $msg->("reloading..."); 2638 warn Carp::longmess "post_cleanup backtrace"
2639 if $make_core;
2640}
1074 2641
1075 eval { 2642sub do_reload_perl() {
1076 # cancel all watchers 2643 # can/must only be called in main
2644 if ($Coro::current != $Coro::main) {
2645 warn "can only reload from main coroutine";
2646 return;
2647 }
2648
2649 warn "reloading...";
2650
2651 warn "entering sync_job";
2652
2653 cf::sync_job {
2654 cf::write_runtime; # external watchdog should not bark
2655 cf::emergency_save;
2656 cf::write_runtime; # external watchdog should not bark
2657
2658 warn "syncing database to disk";
2659 BDB::db_env_txn_checkpoint $DB_ENV;
2660
2661 # if anything goes wrong in here, we should simply crash as we already saved
2662
2663 warn "cancelling all WF_AUTOCANCEL watchers";
1077 for (Event::all_watchers) { 2664 for (Event::all_watchers) {
1078 $_->cancel if $_->data & WF_AUTOCANCEL; 2665 $_->cancel if $_->data & WF_AUTOCANCEL;
1079 } 2666 }
1080 2667
1081 # unload all extensions 2668 warn "flushing outstanding aio requests";
1082 for (@exts) { 2669 for (;;) {
1083 $msg->("unloading <$_>"); 2670 BDB::flush;
1084 unload_extension $_; 2671 IO::AIO::flush;
2672 Coro::cede;
2673 last unless IO::AIO::nreqs || BDB::nreqs;
2674 warn "iterate...";
2675 }
2676
2677 ++$RELOAD;
2678
2679 warn "cancelling all extension coros";
2680 $_->cancel for values %EXT_CORO;
2681 %EXT_CORO = ();
2682
2683 warn "removing commands";
2684 %COMMAND = ();
2685
2686 warn "removing ext commands";
2687 %EXTCMD = ();
2688
2689 warn "unloading/nuking all extensions";
2690 for my $pkg (@EXTS) {
2691 warn "... unloading $pkg";
2692
2693 if (my $cb = $pkg->can ("unload")) {
2694 eval {
2695 $cb->($pkg);
2696 1
2697 } or warn "$pkg unloaded, but with errors: $@";
1085 } 2698 }
1086 2699
2700 warn "... nuking $pkg";
2701 Symbol::delete_package $pkg;
2702 }
2703
1087 # unload all modules loaded from $LIBDIR 2704 warn "unloading all perl modules loaded from $LIBDIR";
1088 while (my ($k, $v) = each %INC) { 2705 while (my ($k, $v) = each %INC) {
1089 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2706 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1090 2707
1091 $msg->("removing <$k>"); 2708 warn "... unloading $k";
1092 delete $INC{$k}; 2709 delete $INC{$k};
1093 2710
1094 $k =~ s/\.pm$//; 2711 $k =~ s/\.pm$//;
1095 $k =~ s/\//::/g; 2712 $k =~ s/\//::/g;
1096 2713
1099 } 2716 }
1100 2717
1101 Symbol::delete_package $k; 2718 Symbol::delete_package $k;
1102 } 2719 }
1103 2720
1104 # sync database to disk
1105 cf::db_sync;
1106
1107 # get rid of safe::, as good as possible 2721 warn "getting rid of safe::, as good as possible";
1108 Symbol::delete_package "safe::$_" 2722 Symbol::delete_package "safe::$_"
1109 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2723 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1110 2724
1111 # remove register_script_function callbacks
1112 # TODO
1113
1114 # unload cf.pm "a bit" 2725 warn "unloading cf.pm \"a bit\"";
1115 delete $INC{"cf.pm"}; 2726 delete $INC{"cf.pm"};
2727 delete $INC{"cf/pod.pm"};
1116 2728
1117 # don't, removes xs symbols, too, 2729 # don't, removes xs symbols, too,
1118 # and global variables created in xs 2730 # and global variables created in xs
1119 #Symbol::delete_package __PACKAGE__; 2731 #Symbol::delete_package __PACKAGE__;
1120 2732
1121 # reload cf.pm 2733 warn "unload completed, starting to reload now";
2734
1122 $msg->("reloading cf.pm"); 2735 warn "reloading cf.pm";
1123 require cf; 2736 require cf;
2737 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1124 2738
1125 # load config and database again 2739 warn "loading config and database again";
1126 cf::cfg_load; 2740 cf::cfg_load;
1127 cf::db_load;
1128 2741
1129 # load extensions 2742 warn "loading extensions";
1130 $msg->("load extensions");
1131 cf::load_extensions; 2743 cf::load_extensions;
1132 2744
1133 # reattach attachments to objects 2745 warn "reattaching attachments to objects/players";
1134 $msg->("reattach"); 2746 _global_reattach; # objects, sockets
1135 _global_reattach; 2747 warn "reattaching attachments to maps";
2748 reattach $_ for values %MAP;
2749 warn "reattaching attachments to players";
2750 reattach $_ for values %PLAYER;
2751
2752 warn "leaving sync_job";
2753
2754 1
2755 } or do {
2756 warn $@;
2757 warn "error while reloading, exiting.";
2758 exit 1;
1136 }; 2759 };
1137 $msg->($@) if $@;
1138 2760
1139 $msg->("reloaded"); 2761 warn "reloaded";
1140}; 2762};
1141 2763
1142sub perl_reload() { 2764our $RELOAD_WATCHER; # used only during reload
1143 _perl_reload { 2765
1144 warn $_[0]; 2766sub reload_perl() {
1145 print "$_[0]\n"; 2767 # doing reload synchronously and two reloads happen back-to-back,
2768 # coro crashes during coro_state_free->destroy here.
2769
2770 $RELOAD_WATCHER ||= Event->timer (
2771 reentrant => 0,
2772 after => 0,
2773 data => WF_AUTOCANCEL,
2774 cb => sub {
2775 do_reload_perl;
2776 undef $RELOAD_WATCHER;
2777 },
1146 }; 2778 );
1147} 2779}
1148 2780
1149register "<global>", __PACKAGE__;
1150
1151register_command "perl-reload" => sub { 2781register_command "reload" => sub {
1152 my ($who, $arg) = @_; 2782 my ($who, $arg) = @_;
1153 2783
1154 if ($who->flag (FLAG_WIZ)) { 2784 if ($who->flag (FLAG_WIZ)) {
1155 _perl_reload { 2785 $who->message ("reloading server.");
1156 warn $_[0]; 2786 async { reload_perl };
1157 $who->message ($_[0]);
1158 };
1159 } 2787 }
1160}; 2788};
1161 2789
1162unshift @INC, $LIBDIR; 2790unshift @INC, $LIBDIR;
1163 2791
2792my $bug_warning = 0;
2793
2794our @WAIT_FOR_TICK;
2795our @WAIT_FOR_TICK_BEGIN;
2796
2797sub wait_for_tick {
2798 return unless $TICK_WATCHER->is_active;
2799 return if $Coro::current == $Coro::main;
2800
2801 my $signal = new Coro::Signal;
2802 push @WAIT_FOR_TICK, $signal;
2803 $signal->wait;
2804}
2805
2806sub wait_for_tick_begin {
2807 return unless $TICK_WATCHER->is_active;
2808 return if $Coro::current == $Coro::main;
2809
2810 my $signal = new Coro::Signal;
2811 push @WAIT_FOR_TICK_BEGIN, $signal;
2812 $signal->wait;
2813}
2814
1164$TICK_WATCHER = Event->timer ( 2815$TICK_WATCHER = Event->timer (
2816 reentrant => 0,
2817 parked => 1,
1165 prio => 0, 2818 prio => 0,
1166 at => $NEXT_TICK || 1, 2819 at => $NEXT_TICK || $TICK,
1167 data => WF_AUTOCANCEL, 2820 data => WF_AUTOCANCEL,
1168 cb => sub { 2821 cb => sub {
2822 if ($Coro::current != $Coro::main) {
2823 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2824 unless ++$bug_warning > 10;
2825 return;
2826 }
2827
2828 $NOW = Event::time;
2829
1169 cf::server_tick; # one server iteration 2830 cf::server_tick; # one server iteration
1170 2831
1171 my $NOW = Event::time; 2832 $RUNTIME += $TICK;
1172 $NEXT_TICK += $TICK; 2833 $NEXT_TICK += $TICK;
1173 2834
2835 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2836 $NEXT_RUNTIME_WRITE = $NOW + 10;
2837 Coro::async_pool {
2838 write_runtime
2839 or warn "ERROR: unable to write runtime file: $!";
2840 };
2841 }
2842
2843# my $AFTER = Event::time;
2844# warn $AFTER - $NOW;#d#
2845
1174 # if we are delayed by four ticks or more, skip them all 2846 # if we are delayed by four ticks or more, skip them all
1175 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2847 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1176 2848
1177 $TICK_WATCHER->at ($NEXT_TICK); 2849 $TICK_WATCHER->at ($NEXT_TICK);
1178 $TICK_WATCHER->start; 2850 $TICK_WATCHER->start;
2851
2852 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2853 $sig->send;
2854 }
2855 while (my $sig = shift @WAIT_FOR_TICK) {
2856 $sig->send;
2857 }
2858
2859 _post_tick;
1179 }, 2860 },
1180); 2861);
1181 2862
2863{
2864 BDB::max_poll_time $TICK * 0.1;
2865 $BDB_POLL_WATCHER = Event->io (
2866 reentrant => 0,
2867 fd => BDB::poll_fileno,
2868 poll => 'r',
2869 prio => 0,
2870 data => WF_AUTOCANCEL,
2871 cb => \&BDB::poll_cb,
2872 );
2873 BDB::min_parallel 8;
2874
2875 BDB::set_sync_prepare {
2876 my $status;
2877 my $current = $Coro::current;
2878 (
2879 sub {
2880 $status = $!;
2881 $current->ready; undef $current;
2882 },
2883 sub {
2884 Coro::schedule while defined $current;
2885 $! = $status;
2886 },
2887 )
2888 };
2889
2890 unless ($DB_ENV) {
2891 $DB_ENV = BDB::db_env_create;
2892
2893 cf::sync_job {
2894 eval {
2895 BDB::db_env_open
2896 $DB_ENV,
2897 $BDBDIR,
2898 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2899 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2900 0666;
2901
2902 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2903
2904 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2905 $DB_ENV->set_lk_detect;
2906 };
2907
2908 cf::cleanup "db_env_open(db): $@" if $@;
2909 };
2910 }
2911}
2912
2913{
2914 IO::AIO::min_parallel 8;
2915
2916 undef $Coro::AIO::WATCHER;
1182IO::AIO::max_poll_time $TICK * 0.2; 2917 IO::AIO::max_poll_time $TICK * 0.1;
1183 2918 $AIO_POLL_WATCHER = Event->io (
1184Event->io (fd => IO::AIO::poll_fileno, 2919 reentrant => 0,
1185 poll => 'r',
1186 prio => 5,
1187 data => WF_AUTOCANCEL, 2920 data => WF_AUTOCANCEL,
2921 fd => IO::AIO::poll_fileno,
2922 poll => 'r',
2923 prio => 6,
1188 cb => \&IO::AIO::poll_cb); 2924 cb => \&IO::AIO::poll_cb,
2925 );
2926}
2927
2928sub _log_backtrace {
2929 my ($msg, @addr) = @_;
2930
2931 async {
2932 my @bt = fork_call {
2933 @addr = map { sprintf "%x", $_ } @addr;
2934 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
2935 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
2936 or die "addr2line: $!";
2937
2938 my @funcs;
2939 my @res = <$fh>;
2940 chomp for @res;
2941 while (@res) {
2942 my ($func, $line) = splice @res, 0, 2, ();
2943 push @funcs, "[$func] $line";
2944 }
2945
2946 @funcs
2947 };
2948
2949 $msg =~ s/\n//;
2950
2951 LOG llevInfo, "[ABT] $msg\n";
2952 LOG llevInfo, "[ABT] $_\n" for @bt;
2953 };
2954}
2955
2956# load additional modules
2957use cf::pod;
2958
2959END { cf::emergency_save }
1189 2960
11901 29611
1191 2962

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines