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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines