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.124 by root, Tue Jan 2 22:55:05 2007 UTC vs.
Revision 1.220 by root, Sat Feb 17 23:54:35 2007 UTC

8use Storable; 8use Storable;
9use Opcode; 9use Opcode;
10use Safe; 10use Safe;
11use Safe::Hole; 11use Safe::Hole;
12 12
13use Coro 3.3; 13use Coro 3.5 ();
14use Coro::Event; 14use Coro::Event;
15use Coro::Timer; 15use Coro::Timer;
16use Coro::Signal; 16use Coro::Signal;
17use Coro::Semaphore; 17use Coro::Semaphore;
18use Coro::AIO; 18use Coro::AIO;
19 19
20use BDB ();
21use Data::Dumper;
20use Digest::MD5; 22use Digest::MD5;
21use Fcntl; 23use Fcntl;
22use IO::AIO 2.31 (); 24use IO::AIO 2.32 ();
23use YAML::Syck (); 25use YAML::Syck ();
24use Time::HiRes; 26use Time::HiRes;
27use Compress::LZF;
28
29Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
25 30
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 31use Event; $Event::Eval = 1; # no idea why this is required, but it is
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
27 34
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 35# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1; 36$YAML::Syck::ImplicitUnicode = 1;
30 37
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 38$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 39
35our %COMMAND = (); 40our %COMMAND = ();
36our %COMMAND_TIME = (); 41our %COMMAND_TIME = ();
42
43our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 44our %EXTCMD = ();
45our %EXT_CORO = (); # coroutines bound to extensions
46our %EXT_MAP = (); # pluggable maps
38 47
39our @EVENT; 48our @EVENT;
40our $LIBDIR = datadir . "/ext"; 49our $LIBDIR = datadir . "/ext";
41 50
42our $TICK = MAX_TIME * 1e-6; 51our $TICK = MAX_TIME * 1e-6;
43our $TICK_WATCHER; 52our $TICK_WATCHER;
53our $AIO_POLL_WATCHER;
54our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 55our $NEXT_TICK;
45our $NOW; 56our $NOW;
57our $USE_FSYNC = 1; # use fsync to write maps - default off
58
59our $BDB_POLL_WATCHER;
60our $DB_ENV;
46 61
47our %CFG; 62our %CFG;
48 63
49our $UPTIME; $UPTIME ||= time; 64our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 65our $RUNTIME;
51 66
67our %PLAYER; # all users
52our %MAP; # all maps 68our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 69our $LINK_MAP; # the special {link} map, which is always available
54our $FREEZE;
55our $RANDOM_MAPS = cf::localdir . "/random"; 70our $RANDOM_MAPS = cf::localdir . "/random";
56our %EXT_CORO; 71our $BDB_ENV_DIR = cf::localdir . "/db";
72
73our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75
76# used to convert map paths into valid unix filenames by replacing / by ∕
77our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
57 78
58binmode STDOUT; 79binmode STDOUT;
59binmode STDERR; 80binmode STDERR;
60 81
61# read virtual server time, if available 82# read virtual server time, if available
68mkdir cf::localdir; 89mkdir cf::localdir;
69mkdir cf::localdir . "/" . cf::playerdir; 90mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir; 91mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir; 92mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS; 93mkdir $RANDOM_MAPS;
94mkdir $BDB_ENV_DIR;
73 95
74# a special map that is always available 96our $EMERGENCY_POSITION;
75our $LINK_MAP;
76 97
77our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 98sub cf::map::normalise;
78 99
79############################################################################# 100#############################################################################
80 101
81=head2 GLOBAL VARIABLES 102=head2 GLOBAL VARIABLES
82 103
106 127
107=item %cf::CFG 128=item %cf::CFG
108 129
109Configuration for the server, loaded from C</etc/crossfire/config>, or 130Configuration for the server, loaded from C</etc/crossfire/config>, or
110from wherever your confdir points to. 131from wherever your confdir points to.
132
133=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
134
135These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
136or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
137processing has been done. Call C<< ->wait >> on them to maximise the
138window of cpu time available, or simply to synchronise to the server tick.
111 139
112=back 140=back
113 141
114=cut 142=cut
115 143
119 utf8::encode $msg; 147 utf8::encode $msg;
120 148
121 $msg .= "\n" 149 $msg .= "\n"
122 unless $msg =~ /\n$/; 150 unless $msg =~ /\n$/;
123 151
124 LOG llevError, "cfperl: $msg"; 152 LOG llevError, $msg;
125 }; 153 };
126} 154}
127 155
128@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 156@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 157@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
147 175
148$Event::DIED = sub { 176$Event::DIED = sub {
149 warn "error in event callback: @_"; 177 warn "error in event callback: @_";
150}; 178};
151 179
152my %ext_pkg;
153my @exts;
154my @hook;
155
156=head2 UTILITY FUNCTIONS 180=head2 UTILITY FUNCTIONS
157 181
158=over 4 182=over 4
159 183
184=item dumpval $ref
185
160=cut 186=cut
187
188sub dumpval {
189 eval {
190 local $SIG{__DIE__};
191 my $d;
192 if (1) {
193 $d = new Data::Dumper([$_[0]], ["*var"]);
194 $d->Terse(1);
195 $d->Indent(2);
196 $d->Quotekeys(0);
197 $d->Useqq(1);
198 #$d->Bless(...);
199 $d->Seen($_[1]) if @_ > 1;
200 $d = $d->Dump();
201 }
202 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203 $d
204 } || "[unable to dump $_[0]: '$@']";
205}
161 206
162use JSON::Syck (); # TODO# replace by JSON::PC once working 207use JSON::Syck (); # TODO# replace by JSON::PC once working
163 208
164=item $ref = cf::from_json $json 209=item $ref = cf::from_json $json
165 210
181sub to_json($) { 226sub to_json($) {
182 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 227 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183 JSON::Syck::Dump $_[0] 228 JSON::Syck::Dump $_[0]
184} 229}
185 230
186=item my $guard = cf::guard { BLOCK }
187
188Run the given callback when the guard object gets destroyed (useful for
189coroutine cancellations).
190
191You can call C<< ->cancel >> on the guard object to stop the block from
192being executed.
193
194=cut
195
196sub guard(&) {
197 bless \(my $cb = $_[0]), cf::guard::;
198}
199
200sub cf::guard::cancel {
201 ${$_[0]} = sub { };
202}
203
204sub cf::guard::DESTROY {
205 ${$_[0]}->();
206}
207
208=item cf::lock_wait $string 231=item cf::lock_wait $string
209 232
210Wait until the given lock is available. See cf::lock_acquire. 233Wait until the given lock is available. See cf::lock_acquire.
211 234
212=item my $lock = cf::lock_acquire $string 235=item my $lock = cf::lock_acquire $string
213 236
214Wait until the given lock is available and then acquires it and returns 237Wait until the given lock is available and then acquires it and returns
215a guard object. If the guard object gets destroyed (goes out of scope, 238a Coro::guard object. If the guard object gets destroyed (goes out of scope,
216for example when the coroutine gets canceled), the lock is automatically 239for example when the coroutine gets canceled), the lock is automatically
217returned. 240returned.
218 241
219Lock names should begin with a unique identifier (for example, find_map 242Lock names should begin with a unique identifier (for example, cf::map::find
220uses map_find and load_map uses map_load). 243uses map_find and cf::map::load uses map_load).
221 244
222=cut 245=cut
223 246
224our %LOCK; 247our %LOCK;
225 248
239 # wait, to be sure we are not locked 262 # wait, to be sure we are not locked
240 lock_wait $key; 263 lock_wait $key;
241 264
242 $LOCK{$key} = []; 265 $LOCK{$key} = [];
243 266
244 cf::guard { 267 Coro::guard {
245 # wake up all waiters, to be on the safe side 268 # wake up all waiters, to be on the safe side
246 $_->ready for @{ delete $LOCK{$key} }; 269 $_->ready for @{ delete $LOCK{$key} };
247 } 270 }
248} 271}
272
273sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active;
275
276 my $guard = Coro::guard {
277 $TICK_WATCHER->start;
278 };
279 $TICK_WATCHER->stop;
280 $guard
281}
282
283=item cf::async { BLOCK }
284
285Currently the same as Coro::async_pool, meaning you cannot use
286C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
287thing you are allowed to do is call C<prio> on it.
288
289=cut
290
291BEGIN { *async = \&Coro::async_pool }
249 292
250=item cf::sync_job { BLOCK } 293=item cf::sync_job { BLOCK }
251 294
252The design of crossfire+ requires that the main coro ($Coro::main) is 295The design of crossfire+ requires that the main coro ($Coro::main) is
253always able to handle events or runnable, as crossfire+ is only partly 296always able to handle events or runnable, as crossfire+ is only partly
267 # this is the main coro, too bad, we have to block 310 # this is the main coro, too bad, we have to block
268 # till the operation succeeds, freezing the server :/ 311 # till the operation succeeds, freezing the server :/
269 312
270 # TODO: use suspend/resume instead 313 # TODO: use suspend/resume instead
271 # (but this is cancel-safe) 314 # (but this is cancel-safe)
272 local $FREEZE = 1; 315 my $freeze_guard = freeze_mainloop;
273 316
274 my $busy = 1; 317 my $busy = 1;
275 my @res; 318 my @res;
276 319
277 (Coro::async { 320 (async {
278 @res = eval { $job->() }; 321 @res = eval { $job->() };
279 warn $@ if $@; 322 warn $@ if $@;
280 undef $busy; 323 undef $busy;
281 })->prio (Coro::PRIO_MAX); 324 })->prio (Coro::PRIO_MAX);
282 325
283 while ($busy) { 326 while ($busy) {
284 Coro::cede_notself; 327 Coro::cede or Event::one_event;
285 Event::one_event unless Coro::nready;
286 } 328 }
287 329
288 wantarray ? @res : $res[0] 330 wantarray ? @res : $res[0]
289 } else { 331 } else {
290 # we are in another coroutine, how wonderful, everything just works 332 # we are in another coroutine, how wonderful, everything just works
291 333
292 $job->() 334 $job->()
293 } 335 }
294} 336}
295 337
296=item $coro = cf::coro { BLOCK } 338=item $coro = cf::async_ext { BLOCK }
297 339
298Creates and returns a new coro. This coro is automcatially being canceled 340Like async, but this coro is automatically being canceled when the
299when the extension calling this is being unloaded. 341extension calling this is being unloaded.
300 342
301=cut 343=cut
302 344
303sub coro(&) { 345sub async_ext(&) {
304 my $cb = shift; 346 my $cb = shift;
305 347
306 my $coro; $coro = async { 348 my $coro = &Coro::async ($cb);
307 eval {
308 $cb->();
309 };
310 warn $@ if $@;
311 };
312 349
313 $coro->on_destroy (sub { 350 $coro->on_destroy (sub {
314 delete $EXT_CORO{$coro+0}; 351 delete $EXT_CORO{$coro+0};
315 }); 352 });
316 $EXT_CORO{$coro+0} = $coro; 353 $EXT_CORO{$coro+0} = $coro;
317 354
318 $coro 355 $coro
319} 356}
320 357
321sub write_runtime { 358sub write_runtime {
359 my $guard = cf::lock_acquire "write_runtime";
360
322 my $runtime = cf::localdir . "/runtime"; 361 my $runtime = cf::localdir . "/runtime";
323 362
324 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
325 or return; 364 or return;
326 365
366 my $value = $cf::RUNTIME + 90 + 10;
327 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 367 # 10 is the runtime save interval, for a monotonic clock
368 # 60 allows for the watchdog to kill the server.
369
328 (aio_write $fh, 0, (length $value), $value, 0) <= 0 370 (aio_write $fh, 0, (length $value), $value, 0) <= 0
329 and return; 371 and return;
330 372
373 # always fsync - this file is important
331 aio_fsync $fh 374 aio_fsync $fh
332 and return; 375 and return;
333 376
334 close $fh 377 close $fh
335 or return; 378 or return;
341} 384}
342 385
343=back 386=back
344 387
345=cut 388=cut
346
347#############################################################################
348
349package cf::path;
350
351sub new {
352 my ($class, $path, $base) = @_;
353
354 $path = $path->as_string if ref $path;
355
356 my $self = bless { }, $class;
357
358 # {... are special paths that are not touched
359 # ?xxx/... are special absolute paths
360 # ?random/... random maps
361 # /! non-realised random map exit
362 # /... normal maps
363 # ~/... per-player maps without a specific player (DO NOT USE)
364 # ~user/... per-player map of a specific user
365
366 if ($path =~ /^{/) {
367 # fine as it is
368 } elsif ($path =~ s{^\?random/}{}) {
369 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
370 $self->{random} = cf::from_json $data;
371 } else {
372 if ($path =~ s{^~([^/]+)?}{}) {
373 $self->{user_rel} = 1;
374
375 if (defined $1) {
376 $self->{user} = $1;
377 } elsif ($base =~ m{^~([^/]+)/}) {
378 $self->{user} = $1;
379 } else {
380 warn "cannot resolve user-relative path without user <$path,$base>\n";
381 }
382 } elsif ($path =~ /^\//) {
383 # already absolute
384 } else {
385 $base =~ s{[^/]+/?$}{};
386 return $class->new ("$base/$path");
387 }
388
389 for ($path) {
390 redo if s{/\.?/}{/};
391 redo if s{/[^/]+/\.\./}{/};
392 }
393 }
394
395 $self->{path} = $path;
396
397 $self
398}
399
400# the name / primary key / in-game path
401sub as_string {
402 my ($self) = @_;
403
404 $self->{user_rel} ? "~$self->{user}$self->{path}"
405 : $self->{random} ? "?random/$self->{path}"
406 : $self->{path}
407}
408
409# the displayed name, this is a one way mapping
410sub visible_name {
411 my ($self) = @_;
412
413# if (my $rmp = $self->{random}) {
414# # todo: be more intelligent about this
415# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
416# } else {
417 $self->as_string
418# }
419}
420
421# escape the /'s in the path
422sub _escaped_path {
423 # ∕ is U+2215
424 (my $path = $_[0]{path}) =~ s/\//∕/g;
425 $path
426}
427
428# the original (read-only) location
429sub load_path {
430 my ($self) = @_;
431
432 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
433}
434
435# the temporary/swap location
436sub save_path {
437 my ($self) = @_;
438
439 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
440 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
441 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
442}
443
444# the unique path, might be eq to save_path
445sub uniq_path {
446 my ($self) = @_;
447
448 $self->{user_rel} || $self->{random}
449 ? undef
450 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
451}
452
453# return random map parameters, or undef
454sub random_map_params {
455 my ($self) = @_;
456
457 $self->{random}
458}
459
460# this is somewhat ugly, but style maps do need special treatment
461sub is_style_map {
462 $_[0]{path} =~ m{^/styles/}
463}
464
465package cf;
466 389
467############################################################################# 390#############################################################################
468 391
469=head2 ATTACHABLE OBJECTS 392=head2 ATTACHABLE OBJECTS
470 393
596our @CB_TYPE = (); # registry for type (cf-object class) based events 519our @CB_TYPE = (); # registry for type (cf-object class) based events
597our @CB_MAP = (); 520our @CB_MAP = ();
598 521
599my %attachment; 522my %attachment;
600 523
524sub cf::attachable::thawer_merge {
525 # simply override everything except _meta
526 local $_[0]{_meta};
527 %{$_[0]} = %{$_[1]};
528}
529
601sub _attach_cb($$$$) { 530sub _attach_cb($$$$) {
602 my ($registry, $event, $prio, $cb) = @_; 531 my ($registry, $event, $prio, $cb) = @_;
603 532
604 use sort 'stable'; 533 use sort 'stable';
605 534
776# object support 705# object support
777 706
778sub reattach { 707sub reattach {
779 # basically do the same as instantiate, without calling instantiate 708 # basically do the same as instantiate, without calling instantiate
780 my ($obj) = @_; 709 my ($obj) = @_;
710
711 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
781 712
782 my $registry = $obj->registry; 713 my $registry = $obj->registry;
783 714
784 @$registry = (); 715 @$registry = ();
785 716
832 $filename, length $$rdata, scalar @$objs; 763 $filename, length $$rdata, scalar @$objs;
833 764
834 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 765 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
835 chmod SAVE_MODE, $fh; 766 chmod SAVE_MODE, $fh;
836 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 767 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
837 aio_fsync $fh; 768 aio_fsync $fh if $cf::USE_FSYNC;
838 close $fh; 769 close $fh;
839 770
840 if (@$objs) { 771 if (@$objs) {
841 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 772 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
842 chmod SAVE_MODE, $fh; 773 chmod SAVE_MODE, $fh;
843 my $data = Storable::nfreeze { version => 1, objs => $objs }; 774 my $data = Storable::nfreeze { version => 1, objs => $objs };
844 aio_write $fh, 0, (length $data), $data, 0; 775 aio_write $fh, 0, (length $data), $data, 0;
845 aio_fsync $fh; 776 aio_fsync $fh if $cf::USE_FSYNC;
846 close $fh; 777 close $fh;
847 aio_rename "$filename.pst~", "$filename.pst"; 778 aio_rename "$filename.pst~", "$filename.pst";
848 } 779 }
849 } else { 780 } else {
850 aio_unlink "$filename.pst"; 781 aio_unlink "$filename.pst";
917=cut 848=cut
918 849
919sub register_extcmd { 850sub register_extcmd {
920 my ($name, $cb) = @_; 851 my ($name, $cb) = @_;
921 852
922 my $caller = caller;
923 #warn "registering extcmd '$name' to '$caller'";
924
925 $EXTCMD{$name} = [$cb, $caller]; 853 $EXTCMD{$name} = $cb;
926} 854}
927 855
928cf::player->attach ( 856cf::player->attach (
929 on_command => sub { 857 on_command => sub {
930 my ($pl, $name, $params) = @_; 858 my ($pl, $name, $params) = @_;
943 871
944 my $msg = eval { from_json $buf }; 872 my $msg = eval { from_json $buf };
945 873
946 if (ref $msg) { 874 if (ref $msg) {
947 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 875 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
948 if (my %reply = $cb->[0]->($pl, $msg)) { 876 if (my %reply = $cb->($pl, $msg)) {
949 $pl->ext_reply ($msg->{msgid}, %reply); 877 $pl->ext_reply ($msg->{msgid}, %reply);
950 } 878 }
951 } 879 }
952 } else { 880 } else {
953 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 881 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
955 883
956 cf::override; 884 cf::override;
957 }, 885 },
958); 886);
959 887
960sub register {
961 my ($base, $pkg) = @_;
962
963 #TODO
964}
965
966sub load_extension { 888sub load_extension {
967 my ($path) = @_; 889 my ($path) = @_;
968 890
969 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 891 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
970 my $base = $1; 892 my $base = $1;
971 my $pkg = $1; 893 my $pkg = $1;
972 $pkg =~ s/[^[:word:]]/_/g; 894 $pkg =~ s/[^[:word:]]/_/g;
973 $pkg = "ext::$pkg"; 895 $pkg = "ext::$pkg";
974 896
975 warn "loading '$path' into '$pkg'\n"; 897 warn "... loading '$path' into '$pkg'\n";
976 898
977 open my $fh, "<:utf8", $path 899 open my $fh, "<:utf8", $path
978 or die "$path: $!"; 900 or die "$path: $!";
979 901
980 my $source = 902 my $source =
981 "package $pkg; use strict; use utf8;\n" 903 "package $pkg; use strict; use utf8;\n"
982 . "#line 1 \"$path\"\n{\n" 904 . "#line 1 \"$path\"\n{\n"
983 . (do { local $/; <$fh> }) 905 . (do { local $/; <$fh> })
984 . "\n};\n1"; 906 . "\n};\n1";
985 907
986 eval $source 908 unless (eval $source) {
987 or die $@ ? "$path: $@\n" 909 my $msg = $@ ? "$path: $@\n"
988 : "extension disabled.\n"; 910 : "extension disabled.\n";
989 911 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
990 push @exts, $pkg; 912 warn $@;
991 $ext_pkg{$base} = $pkg; 913 warn "mandatory extension failed to load, exiting.\n";
992 914 exit 1;
993# no strict 'refs'; 915 }
994# @{"$pkg\::ISA"} = ext::; 916 die $@;
995
996 register $base, $pkg;
997}
998
999sub unload_extension {
1000 my ($pkg) = @_;
1001
1002 warn "removing extension $pkg\n";
1003
1004 # remove hooks
1005 #TODO
1006# for my $idx (0 .. $#PLUGIN_EVENT) {
1007# delete $hook[$idx]{$pkg};
1008# } 917 }
1009 918
1010 # remove commands 919 push @EXTS, $pkg;
1011 for my $name (keys %COMMAND) {
1012 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1013
1014 if (@cb) {
1015 $COMMAND{$name} = \@cb;
1016 } else {
1017 delete $COMMAND{$name};
1018 }
1019 }
1020
1021 # remove extcmds
1022 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1023 delete $EXTCMD{$name};
1024 }
1025
1026 if (my $cb = $pkg->can ("unload")) {
1027 eval {
1028 $cb->($pkg);
1029 1
1030 } or warn "$pkg unloaded, but with errors: $@";
1031 }
1032
1033 Symbol::delete_package $pkg;
1034} 920}
1035 921
1036sub load_extensions { 922sub load_extensions {
1037 for my $ext (<$LIBDIR/*.ext>) { 923 for my $ext (<$LIBDIR/*.ext>) {
1038 next unless -r $ext; 924 next unless -r $ext;
1042 } or warn "$ext not loaded: $@"; 928 } or warn "$ext not loaded: $@";
1043 } 929 }
1044} 930}
1045 931
1046############################################################################# 932#############################################################################
1047# load/save/clean perl data associated with a map
1048
1049*cf::mapsupport::on_clean = sub {
1050 my ($map) = @_;
1051
1052 my $path = $map->tmpname;
1053 defined $path or return;
1054
1055 unlink "$path.pst";
1056};
1057
1058cf::map->attach (prio => -10000, package => cf::mapsupport::);
1059
1060#############################################################################
1061# load/save perl data associated with player->ob objects
1062
1063sub all_objects(@) {
1064 @_, map all_objects ($_->inv), @_
1065}
1066
1067# TODO: compatibility cruft, remove when no longer needed
1068cf::player->attach (
1069 on_load => sub {
1070 my ($pl, $path) = @_;
1071
1072 for my $o (all_objects $pl->ob) {
1073 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1074 $o->set_ob_key_value ("_perl_data");
1075
1076 %$o = %{ Storable::thaw pack "H*", $value };
1077 }
1078 }
1079 },
1080);
1081
1082#############################################################################
1083 933
1084=head2 CORE EXTENSIONS 934=head2 CORE EXTENSIONS
1085 935
1086Functions and methods that extend core crossfire objects. 936Functions and methods that extend core crossfire objects.
1087 937
938=cut
939
940package cf::player;
941
942use Coro::AIO;
943
1088=head3 cf::player 944=head3 cf::player
1089 945
1090=over 4 946=over 4
1091 947
1092=item cf::player::exists $login 948=item cf::player::find $login
1093 949
1094Returns true when the given account exists. 950Returns the given player object, loading it if necessary (might block).
1095 951
1096=cut 952=cut
1097 953
1098sub cf::player::exists($) { 954sub playerdir($) {
1099 cf::player::find $_[0] 955 cf::localdir
1100 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 956 . "/"
957 . cf::playerdir
958 . "/"
959 . (ref $_[0] ? $_[0]->ob->name : $_[0])
960}
961
962sub path($) {
963 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964
965 (playerdir $login) . "/$login.pl"
966}
967
968sub find_active($) {
969 $cf::PLAYER{$_[0]}
970 and $cf::PLAYER{$_[0]}->active
971 and $cf::PLAYER{$_[0]}
972}
973
974sub exists($) {
975 my ($login) = @_;
976
977 $cf::PLAYER{$login}
978 or cf::sync_job { !aio_stat path $login }
979}
980
981sub find($) {
982 return $cf::PLAYER{$_[0]} || do {
983 my $login = $_[0];
984
985 my $guard = cf::lock_acquire "user_find:$login";
986
987 $cf::PLAYER{$_[0]} || do {
988 my $pl = load_pl path $login
989 or return;
990 $cf::PLAYER{$login} = $pl
991 }
992 }
993}
994
995sub save($) {
996 my ($pl) = @_;
997
998 return if $pl->{deny_save};
999
1000 my $path = path $pl;
1001 my $guard = cf::lock_acquire "user_save:$path";
1002
1003 return if $pl->{deny_save};
1004
1005 aio_mkdir playerdir $pl, 0770;
1006 $pl->{last_save} = $cf::RUNTIME;
1007
1008 $pl->save_pl ($path);
1009 Coro::cede;
1010}
1011
1012sub new($) {
1013 my ($login) = @_;
1014
1015 my $self = create;
1016
1017 $self->ob->name ($login);
1018 $self->{deny_save} = 1;
1019
1020 $cf::PLAYER{$login} = $self;
1021
1022 $self
1023}
1024
1025=item $pl->quit_character
1026
1027Nukes the player without looking back. If logged in, the connection will
1028be destroyed. May block for a long time.
1029
1030=cut
1031
1032sub quit_character {
1033 my ($pl) = @_;
1034
1035 my $name = $pl->ob->name;
1036
1037 $pl->{deny_save} = 1;
1038 $pl->password ("*"); # this should lock out the player until we nuked the dir
1039
1040 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1041 $pl->deactivate;
1042 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1043 $pl->ns->destroy if $pl->ns;
1044
1045 my $path = playerdir $pl;
1046 my $temp = "$path~$cf::RUNTIME~deleting~";
1047 aio_rename $path, $temp;
1048 delete $cf::PLAYER{$pl->ob->name};
1049 $pl->destroy;
1050
1051 my $prefix = qr<^~\Q$name\E/>;
1052
1053 # nuke player maps
1054 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1055
1056 IO::AIO::aio_rmtree $temp;
1057}
1058
1059=item cf::player::list_logins
1060
1061Returns am arrayref of all valid playernames in the system, can take a
1062while and may block, so not sync_job-capable, ever.
1063
1064=cut
1065
1066sub list_logins {
1067 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1068 or return [];
1069
1070 my @logins;
1071
1072 for my $login (@$dirs) {
1073 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1074 aio_read $fh, 0, 512, my $buf, 0 or next;
1075 $buf !~ /^password -------------$/m or next; # official not-valid tag
1076
1077 utf8::decode $login;
1078 push @logins, $login;
1079 }
1080
1081 \@logins
1082}
1083
1084=item $player->maps
1085
1086Returns an arrayref of map paths that are private for this
1087player. May block.
1088
1089=cut
1090
1091sub maps($) {
1092 my ($pl) = @_;
1093
1094 $pl = ref $pl ? $pl->ob->name : $pl;
1095
1096 my $files = aio_readdir playerdir $pl
1097 or return;
1098
1099 my @paths;
1100
1101 for (@$files) {
1102 utf8::decode $_;
1103 next if /\.(?:pl|pst)$/;
1104 next unless /^$PATH_SEP/o;
1105
1106 push @paths, cf::map::normalise "~$pl/$_";
1107 }
1108
1109 \@paths
1101} 1110}
1102 1111
1103=item $player->ext_reply ($msgid, $msgtype, %msg) 1112=item $player->ext_reply ($msgid, $msgtype, %msg)
1104 1113
1105Sends an ext reply to the player. 1114Sends an ext reply to the player.
1106 1115
1107=cut 1116=cut
1108 1117
1109sub cf::player::ext_reply($$$%) { 1118sub ext_reply($$$%) {
1110 my ($self, $id, %msg) = @_; 1119 my ($self, $id, %msg) = @_;
1111 1120
1112 $msg{msgid} = $id; 1121 $msg{msgid} = $id;
1113 1122
1114 $self->send ("ext " . to_json \%msg); 1123 $self->send ("ext " . cf::to_json \%msg);
1115} 1124}
1125
1126package cf;
1116 1127
1117=back 1128=back
1118 1129
1119 1130
1120=head3 cf::map 1131=head3 cf::map
1126package cf::map; 1137package cf::map;
1127 1138
1128use Fcntl; 1139use Fcntl;
1129use Coro::AIO; 1140use Coro::AIO;
1130 1141
1142use overload
1143 '""' => \&as_string,
1144 fallback => 1;
1145
1131our $MAX_RESET = 7200; 1146our $MAX_RESET = 3600;
1132our $DEFAULT_RESET = 3600; 1147our $DEFAULT_RESET = 3000;
1133 1148
1134sub generate_random_map { 1149sub generate_random_map {
1135 my ($path, $rmp) = @_; 1150 my ($self, $rmp) = @_;
1136
1137 # mit "rum" bekleckern, nicht 1151 # mit "rum" bekleckern, nicht
1138 cf::map::_create_random_map 1152 $self->_create_random_map (
1139 $path,
1140 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1153 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1141 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1154 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1142 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1155 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1143 $rmp->{exit_on_final_map}, 1156 $rmp->{exit_on_final_map},
1144 $rmp->{xsize}, $rmp->{ysize}, 1157 $rmp->{xsize}, $rmp->{ysize},
1145 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1158 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1146 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1159 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1147 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1160 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1148 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1161 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1149 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1162 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1150 (cf::region::find $rmp->{region}) 1163 (cf::region::find $rmp->{region}), $rmp->{custom}
1164 )
1165}
1166
1167=item cf::map->register ($regex, $prio)
1168
1169Register a handler for the map path matching the given regex at the
1170givne priority (higher is better, built-in handlers have priority 0, the
1171default).
1172
1173=cut
1174
1175sub register {
1176 my (undef, $regex, $prio) = @_;
1177 my $pkg = caller;
1178
1179 no strict;
1180 push @{"$pkg\::ISA"}, __PACKAGE__;
1181
1182 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1183}
1184
1185# also paths starting with '/'
1186$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1187
1188sub thawer_merge {
1189 my ($self, $merge) = @_;
1190
1191 # we have to keep some variables in memory intact
1192 local $self->{path};
1193 local $self->{load_path};
1194 local $self->{deny_save};
1195 local $self->{deny_reset};
1196
1197 $self->SUPER::thawer_merge ($merge);
1198}
1199
1200sub normalise {
1201 my ($path, $base) = @_;
1202
1203 $path = "$path"; # make sure its a string
1204
1205 $path =~ s/\.map$//;
1206
1207 # map plan:
1208 #
1209 # /! non-realised random map exit (special hack!)
1210 # {... are special paths that are not being touched
1211 # ?xxx/... are special absolute paths
1212 # ?random/... random maps
1213 # /... normal maps
1214 # ~user/... per-player map of a specific user
1215
1216 $path =~ s/$PATH_SEP/\//go;
1217
1218 # treat it as relative path if it starts with
1219 # something that looks reasonable
1220 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1221 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1222
1223 $base =~ s{[^/]+/?$}{};
1224 $path = "$base/$path";
1225 }
1226
1227 for ($path) {
1228 redo if s{//}{/};
1229 redo if s{/\.?/}{/};
1230 redo if s{/[^/]+/\.\./}{/};
1231 }
1232
1233 $path
1234}
1235
1236sub new_from_path {
1237 my (undef, $path, $base) = @_;
1238
1239 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1240
1241 $path = normalise $path, $base;
1242
1243 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1244 if ($path =~ $EXT_MAP{$pkg}[1]) {
1245 my $self = bless cf::map::new, $pkg;
1246 $self->{path} = $path; $self->path ($path);
1247 $self->init; # pass $1 etc.
1248 return $self;
1249 }
1250 }
1251
1252 Carp::carp "unable to resolve path '$path' (base '$base').";
1253 ()
1254}
1255
1256sub init {
1257 my ($self) = @_;
1258
1259 $self
1260}
1261
1262sub as_string {
1263 my ($self) = @_;
1264
1265 "$self->{path}"
1266}
1267
1268# the displayed name, this is a one way mapping
1269sub visible_name {
1270 &as_string
1271}
1272
1273# the original (read-only) location
1274sub load_path {
1275 my ($self) = @_;
1276
1277 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
1278}
1279
1280# the temporary/swap location
1281sub save_path {
1282 my ($self) = @_;
1283
1284 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1285 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
1286}
1287
1288# the unique path, undef == no special unique path
1289sub uniq_path {
1290 my ($self) = @_;
1291
1292 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1293 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1151} 1294}
1152 1295
1153# and all this just because we cannot iterate over 1296# and all this just because we cannot iterate over
1154# all maps in C++... 1297# all maps in C++...
1155sub change_all_map_light { 1298sub change_all_map_light {
1157 1300
1158 $_->change_map_light ($change) 1301 $_->change_map_light ($change)
1159 for grep $_->outdoor, values %cf::MAP; 1302 for grep $_->outdoor, values %cf::MAP;
1160} 1303}
1161 1304
1305sub unlink_save {
1306 my ($self) = @_;
1307
1308 utf8::encode (my $save = $self->save_path);
1309 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1310 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1311}
1312
1162sub try_load_header($) { 1313sub load_header_from($) {
1163 my ($path) = @_; 1314 my ($self, $path) = @_;
1164 1315
1165 utf8::encode $path; 1316 utf8::encode $path;
1166 aio_open $path, O_RDONLY, 0 1317 #aio_open $path, O_RDONLY, 0
1318 # or return;
1319
1320 $self->_load_header ($path)
1167 or return; 1321 or return;
1168 1322
1169 my $map = cf::map::new 1323 $self->{load_path} = $path;
1324
1325 1
1326}
1327
1328sub load_header_orig {
1329 my ($self) = @_;
1330
1331 $self->load_header_from ($self->load_path)
1332}
1333
1334sub load_header_temp {
1335 my ($self) = @_;
1336
1337 $self->load_header_from ($self->save_path)
1338}
1339
1340sub prepare_temp {
1341 my ($self) = @_;
1342
1343 $self->last_access ((delete $self->{last_access})
1344 || $cf::RUNTIME); #d#
1345 # safety
1346 $self->{instantiate_time} = $cf::RUNTIME
1347 if $self->{instantiate_time} > $cf::RUNTIME;
1348}
1349
1350sub prepare_orig {
1351 my ($self) = @_;
1352
1353 $self->{load_original} = 1;
1354 $self->{instantiate_time} = $cf::RUNTIME;
1355 $self->last_access ($cf::RUNTIME);
1356 $self->instantiate;
1357}
1358
1359sub load_header {
1360 my ($self) = @_;
1361
1362 if ($self->load_header_temp) {
1363 $self->prepare_temp;
1364 } else {
1365 $self->load_header_orig
1170 or return; 1366 or return;
1367 $self->prepare_orig;
1368 }
1171 1369
1172 $map->load_header ($path) 1370 1
1173 or return;
1174
1175 $map->{load_path} = $path;
1176
1177 $map
1178} 1371}
1179 1372
1373sub find;
1180sub find_map { 1374sub find {
1181 my ($path, $origin) = @_; 1375 my ($path, $origin) = @_;
1182 1376
1183 #warn "find_map<$path,$origin>\n";#d#
1184
1185 $path = new cf::path $path, $origin && $origin->path; 1377 $path = normalise $path, $origin && $origin->path;
1186 my $key = $path->as_string;
1187 1378
1188 cf::lock_wait "map_find:$key"; 1379 cf::lock_wait "map_find:$path";
1189 1380
1190 $cf::MAP{$key} || do { 1381 $cf::MAP{$path} || do {
1191 my $guard = cf::lock_acquire "map_find:$key"; 1382 my $guard = cf::lock_acquire "map_find:$path";
1192 1383 my $map = new_from_path cf::map $path
1193 # do it the slow way
1194 my $map = try_load_header $path->save_path;
1195
1196 if ($map) {
1197 # safety
1198 $map->{instantiate_time} = $cf::RUNTIME
1199 if $map->{instantiate_time} > $cf::RUNTIME;
1200 } else {
1201 if (my $rmp = $path->random_map_params) {
1202 $map = generate_random_map $key, $rmp;
1203 } else {
1204 $map = try_load_header $path->load_path;
1205 }
1206
1207 $map or return; 1384 or return;
1208 1385
1209 $map->{load_original} = 1;
1210 $map->{instantiate_time} = $cf::RUNTIME;
1211 $map->instantiate;
1212
1213 # per-player maps become, after loading, normal maps
1214 $map->per_player (0) if $path->{user_rel};
1215 }
1216
1217 $map->path ($key);
1218 $map->{path} = $path;
1219 $map->{last_save} = $cf::RUNTIME; 1386 $map->{last_save} = $cf::RUNTIME;
1220 $map->last_access ($cf::RUNTIME);
1221 1387
1222 if ($map->should_reset) { 1388 $map->load_header
1389 or return;
1390
1391 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1392 # doing this can freeze the server in a sync job, obviously
1393 #$cf::WAIT_FOR_TICK->wait;
1223 $map->reset; 1394 $map->reset;
1224 undef $guard; 1395 undef $guard;
1225 $map = cf::map::find_map ($path) 1396 return find $path;
1226 or return;
1227 } 1397 }
1228 1398
1229 $cf::MAP{$key} = $map 1399 $cf::MAP{$path} = $map
1230 } 1400 }
1231} 1401}
1402
1403sub pre_load { }
1404sub post_load { }
1232 1405
1233sub load { 1406sub load {
1234 my ($self) = @_; 1407 my ($self) = @_;
1235 1408
1409 local $self->{deny_reset} = 1; # loading can take a long time
1410
1236 my $path = $self->{path}; 1411 my $path = $self->{path};
1237 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1412 my $guard = cf::lock_acquire "map_load:$path";
1238 1413
1239 return if $self->in_memory != cf::MAP_SWAPPED; 1414 return if $self->in_memory != cf::MAP_SWAPPED;
1240 1415
1241 $self->in_memory (cf::MAP_LOADING); 1416 $self->in_memory (cf::MAP_LOADING);
1242 1417
1243 $self->alloc; 1418 $self->alloc;
1419
1420 $self->pre_load;
1421
1244 $self->load_objects ($self->{load_path}, 1) 1422 $self->_load_objects ($self->{load_path}, 1)
1245 or return; 1423 or return;
1246 1424
1247 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1425 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1248 if delete $self->{load_original}; 1426 if delete $self->{load_original};
1249 1427
1250 if (my $uniq = $path->uniq_path) { 1428 if (my $uniq = $self->uniq_path) {
1251 utf8::encode $uniq; 1429 utf8::encode $uniq;
1252 if (aio_open $uniq, O_RDONLY, 0) { 1430 if (aio_open $uniq, O_RDONLY, 0) {
1253 $self->clear_unique_items; 1431 $self->clear_unique_items;
1254 $self->load_objects ($uniq, 0); 1432 $self->_load_objects ($uniq, 0);
1255 } 1433 }
1256 } 1434 }
1435
1436 Coro::cede;
1257 1437
1258 # now do the right thing for maps 1438 # now do the right thing for maps
1259 $self->link_multipart_objects; 1439 $self->link_multipart_objects;
1260 1440
1261 if ($self->{path}->is_style_map) { 1441 unless ($self->{deny_activate}) {
1262 $self->{deny_save} = 1; 1442 $self->decay_objects;
1263 $self->{deny_reset} = 1;
1264 } else {
1265 $self->fix_auto_apply; 1443 $self->fix_auto_apply;
1266 $self->decay_objects;
1267 $self->update_buttons; 1444 $self->update_buttons;
1445 Coro::cede;
1268 $self->set_darkness_map; 1446 $self->set_darkness_map;
1269 $self->difficulty ($self->estimate_difficulty) 1447 $self->difficulty ($self->estimate_difficulty)
1270 unless $self->difficulty; 1448 unless $self->difficulty;
1449 Coro::cede;
1271 $self->activate; 1450 $self->activate;
1272 } 1451 }
1273 1452
1453 $self->post_load;
1454
1274 $self->in_memory (cf::MAP_IN_MEMORY); 1455 $self->in_memory (cf::MAP_IN_MEMORY);
1275} 1456}
1276 1457
1277sub load_map_sync { 1458sub customise_for {
1459 my ($self, $ob) = @_;
1460
1461 return find "~" . $ob->name . "/" . $self->{path}
1462 if $self->per_player;
1463
1464 $self
1465}
1466
1467# find and load all maps in the 3x3 area around a map
1468sub load_diag {
1469 my ($map) = @_;
1470
1471 my @diag; # diagonal neighbours
1472
1473 for (0 .. 3) {
1474 my $neigh = $map->tile_path ($_)
1475 or next;
1476 $neigh = find $neigh, $map
1477 or next;
1478 $neigh->load;
1479
1480 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1481 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1482 }
1483
1484 for (@diag) {
1485 my $neigh = find @$_
1486 or next;
1487 $neigh->load;
1488 }
1489}
1490
1491sub find_sync {
1278 my ($path, $origin) = @_; 1492 my ($path, $origin) = @_;
1279 1493
1280 #warn "load_map_sync<$path, $origin>\n";#d# 1494 cf::sync_job { find $path, $origin }
1495}
1281 1496
1282 cf::sync_job { 1497sub do_load_sync {
1283 my $map = cf::map::find_map $path, $origin 1498 my ($map) = @_;
1284 or return; 1499
1500 cf::sync_job { $map->load };
1501}
1502
1503our %MAP_PREFETCH;
1504our $MAP_PREFETCHER = undef;
1505
1506sub find_async {
1507 my ($path, $origin) = @_;
1508
1509 $path = normalise $path, $origin && $origin->{path};
1510
1511 if (my $map = $cf::MAP{$path}) {
1512 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1513 }
1514
1515 undef $MAP_PREFETCH{$path};
1516 $MAP_PREFETCHER ||= cf::async {
1517 while (%MAP_PREFETCH) {
1518 for my $path (keys %MAP_PREFETCH) {
1519 my $map = find $path
1520 or next;
1285 $map->load; 1521 $map->load;
1286 $map 1522
1523 delete $MAP_PREFETCH{$path};
1524 }
1525 }
1526 undef $MAP_PREFETCHER;
1287 } 1527 };
1528 $MAP_PREFETCHER->prio (6);
1529
1530 ()
1288} 1531}
1289 1532
1290sub save { 1533sub save {
1291 my ($self) = @_; 1534 my ($self) = @_;
1292 1535
1536 my $lock = cf::lock_acquire "map_data:" . $self->path;
1537
1293 $self->{last_save} = $cf::RUNTIME; 1538 $self->{last_save} = $cf::RUNTIME;
1294 1539
1295 return unless $self->dirty; 1540 return unless $self->dirty;
1296 1541
1297 my $save = $self->{path}->save_path; utf8::encode $save; 1542 my $save = $self->save_path; utf8::encode $save;
1298 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1543 my $uniq = $self->uniq_path; utf8::encode $uniq;
1299 1544
1300 $self->{load_path} = $save; 1545 $self->{load_path} = $save;
1301 1546
1302 return if $self->{deny_save}; 1547 return if $self->{deny_save};
1303 1548
1549 local $self->{last_access} = $self->last_access;#d#
1550
1551 cf::async {
1552 $_->contr->save for $self->players;
1553 };
1554
1304 if ($uniq) { 1555 if ($uniq) {
1305 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1556 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1306 $self->save_objects ($uniq, cf::IO_UNIQUES); 1557 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1307 } else { 1558 } else {
1308 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 1559 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1309 } 1560 }
1310} 1561}
1311 1562
1312sub swap_out { 1563sub swap_out {
1313 my ($self) = @_; 1564 my ($self) = @_;
1565
1566 # save first because save cedes
1567 $self->save;
1568
1569 my $lock = cf::lock_acquire "map_data:" . $self->path;
1314 1570
1315 return if $self->players; 1571 return if $self->players;
1316 return if $self->in_memory != cf::MAP_IN_MEMORY; 1572 return if $self->in_memory != cf::MAP_IN_MEMORY;
1317 return if $self->{deny_save}; 1573 return if $self->{deny_save};
1318 1574
1319 $self->save;
1320 $self->clear; 1575 $self->clear;
1321 $self->in_memory (cf::MAP_SWAPPED); 1576 $self->in_memory (cf::MAP_SWAPPED);
1322} 1577}
1323 1578
1324sub reset_at { 1579sub reset_at {
1325 my ($self) = @_; 1580 my ($self) = @_;
1326 1581
1327 # TODO: safety, remove and allow resettable per-player maps 1582 # TODO: safety, remove and allow resettable per-player maps
1328 return 1e99 if $self->{path}{user_rel}; 1583 return 1e99 if $self->isa ("ext::map_per_player");#d#
1329 return 1e99 if $self->{deny_reset}; 1584 return 1e99 if $self->{deny_reset};
1330 1585
1331 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1586 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1332 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1587 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1333 1588
1338 my ($self) = @_; 1593 my ($self) = @_;
1339 1594
1340 $self->reset_at <= $cf::RUNTIME 1595 $self->reset_at <= $cf::RUNTIME
1341} 1596}
1342 1597
1343sub unlink_save {
1344 my ($self) = @_;
1345
1346 utf8::encode (my $save = $self->{path}->save_path);
1347 aioreq_pri 3; IO::AIO::aio_unlink $save;
1348 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1349}
1350
1351sub rename {
1352 my ($self, $new_path) = @_;
1353
1354 $self->unlink_save;
1355
1356 delete $cf::MAP{$self->path};
1357 $self->{path} = new cf::path $new_path;
1358 $self->path ($self->{path}->as_string);
1359 $cf::MAP{$self->path} = $self;
1360
1361 $self->save;
1362}
1363
1364sub reset { 1598sub reset {
1365 my ($self) = @_; 1599 my ($self) = @_;
1366 1600
1601 my $lock = cf::lock_acquire "map_data:$self->{path}";
1602
1367 return if $self->players; 1603 return if $self->players;
1368 return if $self->{path}{user_rel};#d# 1604 return if $self->isa ("ext::map_per_player");#d#
1369 1605
1370 warn "resetting map ", $self->path;#d# 1606 warn "resetting map ", $self->path;#d#
1371 1607
1608 $self->in_memory (cf::MAP_SWAPPED);
1609
1610 # need to save uniques path
1611 unless ($self->{deny_save}) {
1612 my $uniq = $self->uniq_path; utf8::encode $uniq;
1613
1614 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1615 if $uniq;
1616 }
1617
1372 delete $cf::MAP{$self->path}; 1618 delete $cf::MAP{$self->path};
1619
1620 $self->clear;
1373 1621
1374 $_->clear_links_to ($self) for values %cf::MAP; 1622 $_->clear_links_to ($self) for values %cf::MAP;
1375 1623
1376 $self->unlink_save; 1624 $self->unlink_save;
1377 $self->destroy; 1625 $self->destroy;
1380my $nuke_counter = "aaaa"; 1628my $nuke_counter = "aaaa";
1381 1629
1382sub nuke { 1630sub nuke {
1383 my ($self) = @_; 1631 my ($self) = @_;
1384 1632
1633 delete $cf::MAP{$self->path};
1634
1635 $self->unlink_save;
1636
1637 bless $self, "cf::map";
1638 delete $self->{deny_reset};
1385 $self->{deny_save} = 1; 1639 $self->{deny_save} = 1;
1386 $self->reset_timeout (1); 1640 $self->reset_timeout (1);
1387 $self->rename ("{nuke}/" . ($nuke_counter++)); 1641 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1642
1643 $cf::MAP{$self->path} = $self;
1644
1388 $self->reset; # polite request, might not happen 1645 $self->reset; # polite request, might not happen
1389} 1646}
1390 1647
1391sub customise_for { 1648=item cf::map::unique_maps
1392 my ($map, $ob) = @_;
1393 1649
1394 if ($map->per_player) { 1650Returns an arrayref of paths of all shared maps that have
1395 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 1651instantiated unique items. May block.
1396 }
1397 1652
1398 $map 1653=cut
1399}
1400 1654
1401sub emergency_save { 1655sub unique_maps() {
1402 local $cf::FREEZE = 1; 1656 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1657 or return;
1403 1658
1404 warn "enter emergency map save\n"; 1659 my @paths;
1405 1660
1406 cf::sync_job { 1661 for (@$files) {
1407 warn "begin emergency map save\n"; 1662 utf8::decode $_;
1408 $_->save for values %cf::MAP; 1663 next if /\.pst$/;
1664 next unless /^$PATH_SEP/o;
1665
1666 push @paths, cf::map::normalise $_;
1409 }; 1667 }
1410 1668
1411 warn "end emergency map save\n"; 1669 \@paths
1412} 1670}
1413 1671
1414package cf; 1672package cf;
1415 1673
1416=back 1674=back
1417 1675
1676=head3 cf::object
1677
1678=cut
1679
1680package cf::object;
1681
1682=over 4
1683
1684=item $ob->inv_recursive
1685
1686Returns the inventory of the object _and_ their inventories, recursively.
1687
1688=cut
1689
1690sub inv_recursive_;
1691sub inv_recursive_ {
1692 map { $_, inv_recursive_ $_->inv } @_
1693}
1694
1695sub inv_recursive {
1696 inv_recursive_ inv $_[0]
1697}
1698
1699package cf;
1700
1701=back
1418 1702
1419=head3 cf::object::player 1703=head3 cf::object::player
1420 1704
1421=over 4 1705=over 4
1422 1706
1462 1746
1463=item $player_object->enter_link 1747=item $player_object->enter_link
1464 1748
1465Freezes the player and moves him/her to a special map (C<{link}>). 1749Freezes the player and moves him/her to a special map (C<{link}>).
1466 1750
1467The player should be reaosnably safe there for short amounts of time. You 1751The player should be reasonably safe there for short amounts of time. You
1468I<MUST> call C<leave_link> as soon as possible, though. 1752I<MUST> call C<leave_link> as soon as possible, though.
1469 1753
1754Will never block.
1755
1470=item $player_object->leave_link ($map, $x, $y) 1756=item $player_object->leave_link ($map, $x, $y)
1471 1757
1472Moves the player out of the specila link map onto the given map. If the 1758Moves the player out of the special C<{link}> map onto the specified
1473map is not valid (or omitted), the player will be moved back to the 1759map. If the map is not valid (or omitted), the player will be moved back
1474location he/she was before the call to C<enter_link>, or, if that fails, 1760to the location he/she was before the call to C<enter_link>, or, if that
1475to the emergency map position. 1761fails, to the emergency map position.
1476 1762
1477Might block. 1763Might block.
1478 1764
1479=cut 1765=cut
1766
1767sub link_map {
1768 unless ($LINK_MAP) {
1769 $LINK_MAP = cf::map::find "{link}"
1770 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1771 $LINK_MAP->load;
1772 }
1773
1774 $LINK_MAP
1775}
1480 1776
1481sub cf::object::player::enter_link { 1777sub cf::object::player::enter_link {
1482 my ($self) = @_; 1778 my ($self) = @_;
1483 1779
1484 $self->deactivate_recursive; 1780 $self->deactivate_recursive;
1485 1781
1486 return if $self->map == $LINK_MAP; 1782 return if UNIVERSAL::isa $self->map, "ext::map_link";
1487 1783
1488 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 1784 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1489 if $self->map; 1785 if $self->map;
1490 1786
1491 $self->enter_map ($LINK_MAP, 20, 20); 1787 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1492} 1788}
1493 1789
1494sub cf::object::player::leave_link { 1790sub cf::object::player::leave_link {
1495 my ($self, $map, $x, $y) = @_; 1791 my ($self, $map, $x, $y) = @_;
1496 1792
1497 my $link_pos = delete $self->{_link_pos}; 1793 my $link_pos = delete $self->{_link_pos};
1498 1794
1499 unless ($map) { 1795 unless ($map) {
1500 # restore original map position 1796 # restore original map position
1501 ($map, $x, $y) = @{ $link_pos || [] }; 1797 ($map, $x, $y) = @{ $link_pos || [] };
1502 $map = cf::map::find_map $map; 1798 $map = cf::map::find $map;
1503 1799
1504 unless ($map) { 1800 unless ($map) {
1505 ($map, $x, $y) = @$EMERGENCY_POSITION; 1801 ($map, $x, $y) = @$EMERGENCY_POSITION;
1506 $map = cf::map::find_map $map 1802 $map = cf::map::find $map
1507 or die "FATAL: cannot load emergency map\n"; 1803 or die "FATAL: cannot load emergency map\n";
1508 } 1804 }
1509 } 1805 }
1510 1806
1511 ($x, $y) = (-1, -1) 1807 ($x, $y) = (-1, -1)
1514 # use -1 or undef as default coordinates, not 0, 0 1810 # use -1 or undef as default coordinates, not 0, 0
1515 ($x, $y) = ($map->enter_x, $map->enter_y) 1811 ($x, $y) = ($map->enter_x, $map->enter_y)
1516 if $x <=0 && $y <= 0; 1812 if $x <=0 && $y <= 0;
1517 1813
1518 $map->load; 1814 $map->load;
1815 $map->load_diag;
1519 1816
1817 return unless $self->contr->active;
1520 $self->activate_recursive; 1818 $self->activate_recursive;
1819
1820 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1521 $self->enter_map ($map, $x, $y); 1821 $self->enter_map ($map, $x, $y);
1522} 1822}
1523 1823
1524cf::player->attach ( 1824cf::player->attach (
1525 on_logout => sub { 1825 on_logout => sub {
1537 1837
1538 # try to abort aborted map switching on player login :) 1838 # try to abort aborted map switching on player login :)
1539 # should happen only on crashes 1839 # should happen only on crashes
1540 if ($pl->ob->{_link_pos}) { 1840 if ($pl->ob->{_link_pos}) {
1541 $pl->ob->enter_link; 1841 $pl->ob->enter_link;
1542 Coro::async { 1842 (async {
1843 $pl->ob->reply (undef,
1844 "There was an internal problem at your last logout, "
1845 . "the server will try to bring you to your intended destination in a second.",
1846 cf::NDI_RED);
1543 # we need this sleep as the login has a concurrent enter_exit running 1847 # we need this sleep as the login has a concurrent enter_exit running
1544 # and this sleep increases chances of the player not ending up in scorn 1848 # and this sleep increases chances of the player not ending up in scorn
1545 Coro::Timer::sleep 1; 1849 Coro::Timer::sleep 1;
1546 $pl->ob->leave_link; 1850 $pl->ob->leave_link;
1547 }; 1851 })->prio (2);
1548 } 1852 }
1549 }, 1853 },
1550); 1854);
1551 1855
1552=item $player_object->goto_map ($path, $x, $y) 1856=item $player_object->goto ($path, $x, $y)
1553 1857
1554=cut 1858=cut
1555 1859
1556sub cf::object::player::goto_map { 1860sub cf::object::player::goto {
1557 my ($self, $path, $x, $y) = @_; 1861 my ($self, $path, $x, $y) = @_;
1558 1862
1559 $self->enter_link; 1863 $self->enter_link;
1560 1864
1561 (Coro::async { 1865 (async {
1562 $path = new cf::path $path; 1866 my $map = eval {
1563
1564 my $map = cf::map::find_map $path->as_string; 1867 my $map = cf::map::find $path;
1565 $map = $map->customise_for ($self) if $map; 1868 $map = $map->customise_for ($self) if $map;
1566 1869 $map
1567# warn "entering ", $map->path, " at ($x, $y)\n" 1870 } or
1568# if $map;
1569
1570 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 1871 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1571 1872
1572 $self->leave_link ($map, $x, $y); 1873 $self->leave_link ($map, $x, $y);
1573 })->prio (1); 1874 })->prio (1);
1574} 1875}
1575 1876
1579 1880
1580sub parse_random_map_params { 1881sub parse_random_map_params {
1581 my ($spec) = @_; 1882 my ($spec) = @_;
1582 1883
1583 my $rmp = { # defaults 1884 my $rmp = { # defaults
1584 xsize => 10, 1885 xsize => (cf::rndm 15, 40),
1585 ysize => 10, 1886 ysize => (cf::rndm 15, 40),
1887 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1888 #layout => string,
1586 }; 1889 };
1587 1890
1588 for (split /\n/, $spec) { 1891 for (split /\n/, $spec) {
1589 my ($k, $v) = split /\s+/, $_, 2; 1892 my ($k, $v) = split /\s+/, $_, 2;
1590 1893
1594 $rmp 1897 $rmp
1595} 1898}
1596 1899
1597sub prepare_random_map { 1900sub prepare_random_map {
1598 my ($exit) = @_; 1901 my ($exit) = @_;
1902
1903 my $guard = cf::lock_acquire "exit_prepare:$exit";
1599 1904
1600 # all this does is basically replace the /! path by 1905 # all this does is basically replace the /! path by
1601 # a new random map path (?random/...) with a seed 1906 # a new random map path (?random/...) with a seed
1602 # that depends on the exit object 1907 # that depends on the exit object
1603 1908
1604 my $rmp = parse_random_map_params $exit->msg; 1909 my $rmp = parse_random_map_params $exit->msg;
1605 1910
1606 if ($exit->map) { 1911 if ($exit->map) {
1607 $rmp->{region} = $exit->map->region_name; 1912 $rmp->{region} = $exit->region->name;
1608 $rmp->{origin_map} = $exit->map->path; 1913 $rmp->{origin_map} = $exit->map->path;
1609 $rmp->{origin_x} = $exit->x; 1914 $rmp->{origin_x} = $exit->x;
1610 $rmp->{origin_y} = $exit->y; 1915 $rmp->{origin_y} = $exit->y;
1611 } 1916 }
1612 1917
1613 $rmp->{random_seed} ||= $exit->random_seed; 1918 $rmp->{random_seed} ||= $exit->random_seed;
1614 1919
1615 my $data = cf::to_json $rmp; 1920 my $data = cf::to_json $rmp;
1616 my $md5 = Digest::MD5::md5_hex $data; 1921 my $md5 = Digest::MD5::md5_hex $data;
1922 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1617 1923
1618 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 1924 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1619 aio_write $fh, 0, (length $data), $data, 0; 1925 aio_write $fh, 0, (length $data), $data, 0;
1926 undef $fh;
1927 aio_rename "$meta~", $meta;
1620 1928
1621 $exit->slaying ("?random/$md5"); 1929 $exit->slaying ("?random/$md5");
1622 $exit->msg (undef); 1930 $exit->msg (undef);
1623 } 1931 }
1624} 1932}
1626sub cf::object::player::enter_exit { 1934sub cf::object::player::enter_exit {
1627 my ($self, $exit) = @_; 1935 my ($self, $exit) = @_;
1628 1936
1629 return unless $self->type == cf::PLAYER; 1937 return unless $self->type == cf::PLAYER;
1630 1938
1939 if ($exit->slaying eq "/!") {
1940 #TODO: this should de-fi-ni-te-ly not be a sync-job
1941 cf::sync_job { prepare_random_map $exit };
1942 }
1943
1944 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1945 my $hp = $exit->stats->hp;
1946 my $sp = $exit->stats->sp;
1947
1631 $self->enter_link; 1948 $self->enter_link;
1632 1949
1633 (Coro::async { 1950 (async {
1951 $self->deactivate_recursive; # just to be sure
1634 unless (eval { 1952 unless (eval {
1635 1953 $self->goto ($slaying, $hp, $sp);
1636 prepare_random_map $exit
1637 if $exit->slaying eq "/!";
1638
1639 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1640 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1641 1954
1642 1; 1955 1;
1643 }) { 1956 }) {
1644 $self->message ("Something went wrong deep within the crossfire server. " 1957 $self->message ("Something went wrong deep within the crossfire server. "
1645 . "I'll try to bring you back to the map you were before. " 1958 . "I'll try to bring you back to the map you were before. "
1646 . "Please report this to the dungeon master", 1959 . "Please report this to the dungeon master!",
1647 cf::NDI_UNIQUE | cf::NDI_RED); 1960 cf::NDI_UNIQUE | cf::NDI_RED);
1648 1961
1649 warn "ERROR in enter_exit: $@"; 1962 warn "ERROR in enter_exit: $@";
1650 $self->leave_link; 1963 $self->leave_link;
1651 } 1964 }
1702 on_reply => sub { 2015 on_reply => sub {
1703 my ($ns, $msg) = @_; 2016 my ($ns, $msg) = @_;
1704 2017
1705 # this weird shuffling is so that direct followup queries 2018 # this weird shuffling is so that direct followup queries
1706 # get handled first 2019 # get handled first
1707 my $queue = delete $ns->{query_queue}; 2020 my $queue = delete $ns->{query_queue}
2021 or return; # be conservative, not sure how that can happen, but we saw a crash here
1708 2022
1709 (shift @$queue)->[1]->($msg); 2023 (shift @$queue)->[1]->($msg);
2024 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1710 2025
1711 push @{ $ns->{query_queue} }, @$queue; 2026 push @{ $ns->{query_queue} }, @$queue;
1712 2027
1713 if (@{ $ns->{query_queue} } == @$queue) { 2028 if (@{ $ns->{query_queue} } == @$queue) {
1714 if (@$queue) { 2029 if (@$queue) {
1718 } 2033 }
1719 } 2034 }
1720 }, 2035 },
1721); 2036);
1722 2037
1723=item $client->coro (\&cb) 2038=item $client->async (\&cb)
1724 2039
1725Create a new coroutine, running the specified callback. The coroutine will 2040Create a new coroutine, running the specified callback. The coroutine will
1726be automatically cancelled when the client gets destroyed (e.g. on logout, 2041be automatically cancelled when the client gets destroyed (e.g. on logout,
1727or loss of connection). 2042or loss of connection).
1728 2043
1729=cut 2044=cut
1730 2045
1731sub cf::client::coro { 2046sub cf::client::async {
1732 my ($self, $cb) = @_; 2047 my ($self, $cb) = @_;
1733 2048
1734 my $coro; $coro = async { 2049 my $coro = &Coro::async ($cb);
1735 eval {
1736 $cb->();
1737 };
1738 warn $@ if $@;
1739 };
1740 2050
1741 $coro->on_destroy (sub { 2051 $coro->on_destroy (sub {
1742 delete $self->{_coro}{$coro+0}; 2052 delete $self->{_coro}{$coro+0};
1743 }); 2053 });
1744 2054
1880The parameter C<$family> should best start with the name of the extension 2190The parameter C<$family> should best start with the name of the extension
1881using it, it should be unique. 2191using it, it should be unique.
1882 2192
1883=over 4 2193=over 4
1884 2194
1885=item $hashref = cf::db_get $family
1886
1887Return a hashref for use by the extension C<$family>, which can be
1888modified. After modifications, you have to call C<cf::db_dirty> or
1889C<cf::db_sync>.
1890
1891=item $value = cf::db_get $family => $key 2195=item $value = cf::db_get $family => $key
1892 2196
1893Returns a single value from the database 2197Returns a single value from the database.
1894
1895=item cf::db_put $family => $hashref
1896
1897Stores the given family hashref into the database. Updates are delayed, if
1898you want the data to be synced to disk immediately, use C<cf::db_sync>.
1899 2198
1900=item cf::db_put $family => $key => $value 2199=item cf::db_put $family => $key => $value
1901 2200
1902Stores the given C<$value> in the family hash. Updates are delayed, if you 2201Stores the given C<$value> in the family.
1903want the data to be synced to disk immediately, use C<cf::db_sync>.
1904
1905=item cf::db_dirty
1906
1907Marks the database as dirty, to be updated at a later time.
1908
1909=item cf::db_sync
1910
1911Immediately write the database to disk I<if it is dirty>.
1912 2202
1913=cut 2203=cut
1914 2204
1915our $DB; 2205our $DB;
1916 2206
1917{ 2207sub db_init {
2208 unless ($DB) {
2209 $DB = BDB::db_create $DB_ENV;
2210
2211 cf::sync_job {
2212 eval {
2213 $DB->set_flags (BDB::CHKSUM);
2214
2215 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2216 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2217 cf::cleanup "db_open(db): $!" if $!;
2218 };
2219 cf::cleanup "db_open(db): $@" if $@;
2220 };
2221
1918 my $path = cf::localdir . "/database.pst"; 2222 my $path = cf::localdir . "/database.pst";
2223 if (stat $path) {
2224 cf::sync_job {
2225 my $pst = Storable::retrieve $path;
1919 2226
1920 sub db_load() { 2227 cf::db_put (board => data => $pst->{board});
1921 $DB = stat $path ? Storable::retrieve $path : { }; 2228 cf::db_put (guildrules => data => $pst->{guildrules});
1922 } 2229 cf::db_put (rent => balance => $pst->{rent}{balance});
2230 BDB::db_env_txn_checkpoint $DB_ENV;
1923 2231
1924 my $pid; 2232 unlink $path;
1925
1926 sub db_save() {
1927 waitpid $pid, 0 if $pid;
1928 if (0 == ($pid = fork)) {
1929 $DB->{_meta}{version} = 1;
1930 Storable::nstore $DB, "$path~";
1931 rename "$path~", $path;
1932 cf::_exit 0 if defined $pid;
1933 } 2233 };
1934 }
1935
1936 my $dirty;
1937
1938 sub db_sync() {
1939 db_save if $dirty;
1940 undef $dirty;
1941 }
1942
1943 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1944 db_sync;
1945 });
1946
1947 sub db_dirty() {
1948 $dirty = 1;
1949 $idle->start;
1950 }
1951
1952 sub db_get($;$) {
1953 @_ >= 2
1954 ? $DB->{$_[0]}{$_[1]}
1955 : ($DB->{$_[0]} ||= { })
1956 }
1957
1958 sub db_put($$;$) {
1959 if (@_ >= 3) {
1960 $DB->{$_[0]}{$_[1]} = $_[2];
1961 } else {
1962 $DB->{$_[0]} = $_[1];
1963 }
1964 db_dirty;
1965 }
1966
1967 cf::global->attach (
1968 prio => 10000,
1969 on_cleanup => sub {
1970 db_sync;
1971 }, 2234 }
1972 ); 2235 }
2236}
2237
2238sub db_get($$) {
2239 my $key = "$_[0]/$_[1]";
2240
2241 cf::sync_job {
2242 BDB::db_get $DB, undef, $key, my $data;
2243
2244 $! ? ()
2245 : Compress::LZF::sthaw $data
2246 }
2247}
2248
2249sub db_put($$$) {
2250 BDB::dbreq_pri 4;
2251 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
1973} 2252}
1974 2253
1975############################################################################# 2254#############################################################################
1976# the server's main() 2255# the server's init and main functions
2256
2257sub init_resources {
2258 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2259 or die "unable to load regions file\n";#d#
2260}
1977 2261
1978sub cfg_load { 2262sub cfg_load {
1979 open my $fh, "<:utf8", cf::confdir . "/config" 2263 open my $fh, "<:utf8", cf::confdir . "/config"
1980 or return; 2264 or return;
1981 2265
1982 local $/; 2266 local $/;
1983 *CFG = YAML::Syck::Load <$fh>; 2267 *CFG = YAML::Syck::Load <$fh>;
2268
2269 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2270
2271 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2272 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2273
2274 if (exists $CFG{mlockall}) {
2275 eval {
2276 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2277 and die "WARNING: m(un)lockall failed: $!\n";
2278 };
2279 warn $@ if $@;
2280 }
2281}
2282
2283sub init {
2284 init_resources;
1984} 2285}
1985 2286
1986sub main { 2287sub main {
1987 # we must not ever block the main coroutine 2288 # we must not ever block the main coroutine
1988 local $Coro::idle = sub { 2289 local $Coro::idle = sub {
1989 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2290 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1990 (Coro::unblock_sub { 2291 (async {
1991 Event::one_event; 2292 Event::one_event;
1992 })->(); 2293 })->prio (Coro::PRIO_MAX);
1993 }; 2294 };
1994 2295
1995 cfg_load; 2296 cfg_load;
1996 db_load; 2297 db_init;
1997 load_extensions; 2298 load_extensions;
2299
2300 $TICK_WATCHER->start;
1998 Event::loop; 2301 Event::loop;
1999} 2302}
2000 2303
2001############################################################################# 2304#############################################################################
2002# initialisation 2305# initialisation and cleanup
2306
2307# install some emergency cleanup handlers
2308BEGIN {
2309 for my $signal (qw(INT HUP TERM)) {
2310 Event->signal (
2311 reentrant => 0,
2312 data => WF_AUTOCANCEL,
2313 signal => $signal,
2314 prio => 0,
2315 cb => sub {
2316 cf::cleanup "SIG$signal";
2317 },
2318 );
2319 }
2320}
2321
2322sub emergency_save() {
2323 my $freeze_guard = cf::freeze_mainloop;
2324
2325 warn "enter emergency perl save\n";
2326
2327 cf::sync_job {
2328 # use a peculiar iteration method to avoid tripping on perl
2329 # refcount bugs in for. also avoids problems with players
2330 # and maps saved/destroyed asynchronously.
2331 warn "begin emergency player save\n";
2332 for my $login (keys %cf::PLAYER) {
2333 my $pl = $cf::PLAYER{$login} or next;
2334 $pl->valid or next;
2335 $pl->save;
2336 }
2337 warn "end emergency player save\n";
2338
2339 warn "begin emergency map save\n";
2340 for my $path (keys %cf::MAP) {
2341 my $map = $cf::MAP{$path} or next;
2342 $map->valid or next;
2343 $map->save;
2344 }
2345 warn "end emergency map save\n";
2346
2347 warn "begin emergency database checkpoint\n";
2348 BDB::db_env_txn_checkpoint $DB_ENV;
2349 warn "end emergency database checkpoint\n";
2350 };
2351
2352 warn "leave emergency perl save\n";
2353}
2354
2355sub post_cleanup {
2356 my ($make_core) = @_;
2357
2358 warn Carp::longmess "post_cleanup backtrace"
2359 if $make_core;
2360}
2003 2361
2004sub reload() { 2362sub reload() {
2005 # can/must only be called in main 2363 # can/must only be called in main
2006 if ($Coro::current != $Coro::main) { 2364 if ($Coro::current != $Coro::main) {
2007 warn "can only reload from main coroutine\n"; 2365 warn "can only reload from main coroutine";
2008 return; 2366 return;
2009 } 2367 }
2010 2368
2011 warn "reloading..."; 2369 warn "reloading...";
2012 2370
2013 local $FREEZE = 1; 2371 warn "entering sync_job";
2372
2373 cf::sync_job {
2374 cf::write_runtime; # external watchdog should not bark
2014 cf::emergency_save; 2375 cf::emergency_save;
2376 cf::write_runtime; # external watchdog should not bark
2015 2377
2016 eval { 2378 warn "syncing database to disk";
2379 BDB::db_env_txn_checkpoint $DB_ENV;
2380
2017 # if anything goes wrong in here, we should simply crash as we already saved 2381 # if anything goes wrong in here, we should simply crash as we already saved
2018 2382
2019 # cancel all watchers 2383 warn "cancelling all WF_AUTOCANCEL watchers";
2020 for (Event::all_watchers) { 2384 for (Event::all_watchers) {
2021 $_->cancel if $_->data & WF_AUTOCANCEL; 2385 $_->cancel if $_->data & WF_AUTOCANCEL;
2022 } 2386 }
2023 2387
2388 warn "flushing outstanding aio requests";
2389 for (;;) {
2390 BDB::flush;
2391 IO::AIO::flush;
2392 Coro::cede;
2393 last unless IO::AIO::nreqs || BDB::nreqs;
2394 warn "iterate...";
2395 }
2396
2024 # cancel all extension coros 2397 warn "cancelling all extension coros";
2025 $_->cancel for values %EXT_CORO; 2398 $_->cancel for values %EXT_CORO;
2026 %EXT_CORO = (); 2399 %EXT_CORO = ();
2027 2400
2028 # unload all extensions 2401 warn "removing commands";
2029 for (@exts) { 2402 %COMMAND = ();
2403
2404 warn "removing ext commands";
2405 %EXTCMD = ();
2406
2407 warn "unloading/nuking all extensions";
2408 for my $pkg (@EXTS) {
2030 warn "unloading <$_>"; 2409 warn "... unloading $pkg";
2031 unload_extension $_; 2410
2411 if (my $cb = $pkg->can ("unload")) {
2412 eval {
2413 $cb->($pkg);
2414 1
2415 } or warn "$pkg unloaded, but with errors: $@";
2032 } 2416 }
2033 2417
2418 warn "... nuking $pkg";
2419 Symbol::delete_package $pkg;
2420 }
2421
2034 # unload all modules loaded from $LIBDIR 2422 warn "unloading all perl modules loaded from $LIBDIR";
2035 while (my ($k, $v) = each %INC) { 2423 while (my ($k, $v) = each %INC) {
2036 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2424 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2037 2425
2038 warn "removing <$k>"; 2426 warn "... unloading $k";
2039 delete $INC{$k}; 2427 delete $INC{$k};
2040 2428
2041 $k =~ s/\.pm$//; 2429 $k =~ s/\.pm$//;
2042 $k =~ s/\//::/g; 2430 $k =~ s/\//::/g;
2043 2431
2046 } 2434 }
2047 2435
2048 Symbol::delete_package $k; 2436 Symbol::delete_package $k;
2049 } 2437 }
2050 2438
2051 # sync database to disk
2052 cf::db_sync;
2053 IO::AIO::flush;
2054
2055 # get rid of safe::, as good as possible 2439 warn "getting rid of safe::, as good as possible";
2056 Symbol::delete_package "safe::$_" 2440 Symbol::delete_package "safe::$_"
2057 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2441 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2058 2442
2059 # remove register_script_function callbacks
2060 # TODO
2061
2062 # unload cf.pm "a bit" 2443 warn "unloading cf.pm \"a bit\"";
2063 delete $INC{"cf.pm"}; 2444 delete $INC{"cf.pm"};
2064 2445
2065 # don't, removes xs symbols, too, 2446 # don't, removes xs symbols, too,
2066 # and global variables created in xs 2447 # and global variables created in xs
2067 #Symbol::delete_package __PACKAGE__; 2448 #Symbol::delete_package __PACKAGE__;
2068 2449
2069 # reload cf.pm 2450 warn "unload completed, starting to reload now";
2451
2070 warn "reloading cf.pm"; 2452 warn "reloading cf.pm";
2071 require cf; 2453 require cf;
2072 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2454 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2073 2455
2074 # load config and database again 2456 warn "loading config and database again";
2075 cf::cfg_load; 2457 cf::cfg_load;
2076 cf::db_load;
2077 2458
2078 # load extensions
2079 warn "load extensions"; 2459 warn "loading extensions";
2080 cf::load_extensions; 2460 cf::load_extensions;
2081 2461
2082 # reattach attachments to objects 2462 warn "reattaching attachments to objects/players";
2083 warn "reattach";
2084 _global_reattach; 2463 _global_reattach;
2085 }; 2464 warn "reattaching attachments to maps";
2465 reattach $_ for values %MAP;
2086 2466
2087 if ($@) { 2467 warn "loading reloadable resources";
2468 init_resources;
2469
2470 warn "leaving sync_job";
2471
2472 1
2473 } or do {
2088 warn $@; 2474 warn $@;
2089 warn "error while reloading, exiting."; 2475 warn "error while reloading, exiting.";
2090 exit 1; 2476 exit 1;
2091 } 2477 };
2092 2478
2093 warn "reloaded successfully"; 2479 warn "reloaded";
2094}; 2480};
2095 2481
2096############################################################################# 2482our $RELOAD_WATCHER; # used only during reload
2097
2098unless ($LINK_MAP) {
2099 $LINK_MAP = cf::map::new;
2100
2101 $LINK_MAP->width (41);
2102 $LINK_MAP->height (41);
2103 $LINK_MAP->alloc;
2104 $LINK_MAP->path ("{link}");
2105 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2106 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2107
2108 # dirty hack because... archetypes are not yet loaded
2109 Event->timer (
2110 after => 2,
2111 cb => sub {
2112 $_[0]->w->cancel;
2113
2114 # provide some exits "home"
2115 my $exit = cf::object::new "exit";
2116
2117 $exit->slaying ($EMERGENCY_POSITION->[0]);
2118 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2119 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2120
2121 $LINK_MAP->insert ($exit->clone, 19, 19);
2122 $LINK_MAP->insert ($exit->clone, 19, 20);
2123 $LINK_MAP->insert ($exit->clone, 19, 21);
2124 $LINK_MAP->insert ($exit->clone, 20, 19);
2125 $LINK_MAP->insert ($exit->clone, 20, 21);
2126 $LINK_MAP->insert ($exit->clone, 21, 19);
2127 $LINK_MAP->insert ($exit->clone, 21, 20);
2128 $LINK_MAP->insert ($exit->clone, 21, 21);
2129
2130 $exit->destroy;
2131 });
2132
2133 $LINK_MAP->{deny_save} = 1;
2134 $LINK_MAP->{deny_reset} = 1;
2135
2136 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2137}
2138
2139register "<global>", __PACKAGE__;
2140 2483
2141register_command "reload" => sub { 2484register_command "reload" => sub {
2142 my ($who, $arg) = @_; 2485 my ($who, $arg) = @_;
2143 2486
2144 if ($who->flag (FLAG_WIZ)) { 2487 if ($who->flag (FLAG_WIZ)) {
2145 $who->message ("start of reload."); 2488 $who->message ("reloading server.");
2489
2490 # doing reload synchronously and two reloads happen back-to-back,
2491 # coro crashes during coro_state_free->destroy here.
2492
2493 $RELOAD_WATCHER ||= Event->timer (
2494 reentrant => 0,
2495 after => 0,
2496 data => WF_AUTOCANCEL,
2497 cb => sub {
2146 reload; 2498 reload;
2147 $who->message ("end of reload."); 2499 undef $RELOAD_WATCHER;
2500 },
2501 );
2148 } 2502 }
2149}; 2503};
2150 2504
2151unshift @INC, $LIBDIR; 2505unshift @INC, $LIBDIR;
2506
2507my $bug_warning = 0;
2152 2508
2153$TICK_WATCHER = Event->timer ( 2509$TICK_WATCHER = Event->timer (
2154 reentrant => 0, 2510 reentrant => 0,
2511 parked => 1,
2155 prio => 0, 2512 prio => 0,
2156 at => $NEXT_TICK || $TICK, 2513 at => $NEXT_TICK || $TICK,
2157 data => WF_AUTOCANCEL, 2514 data => WF_AUTOCANCEL,
2158 cb => sub { 2515 cb => sub {
2159 unless ($FREEZE) { 2516 if ($Coro::current != $Coro::main) {
2517 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2518 unless ++$bug_warning > 10;
2519 return;
2520 }
2521
2522 $NOW = Event::time;
2523
2160 cf::server_tick; # one server iteration 2524 cf::server_tick; # one server iteration
2161 $RUNTIME += $TICK; 2525 $RUNTIME += $TICK;
2162 }
2163
2164 $NEXT_TICK += $TICK; 2526 $NEXT_TICK += $TICK;
2527
2528 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2529 $NEXT_RUNTIME_WRITE = $NOW + 10;
2530 Coro::async_pool {
2531 write_runtime
2532 or warn "ERROR: unable to write runtime file: $!";
2533 };
2534 }
2535
2536 $WAIT_FOR_TICK->broadcast;
2537 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2538
2539# my $AFTER = Event::time;
2540# warn $AFTER - $NOW;#d#
2165 2541
2166 # if we are delayed by four ticks or more, skip them all 2542 # if we are delayed by four ticks or more, skip them all
2167 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2543 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2168 2544
2169 $TICK_WATCHER->at ($NEXT_TICK); 2545 $TICK_WATCHER->at ($NEXT_TICK);
2170 $TICK_WATCHER->start; 2546 $TICK_WATCHER->start;
2171 }, 2547 },
2172); 2548);
2173 2549
2550{
2174IO::AIO::max_poll_time $TICK * 0.2; 2551 BDB::max_poll_time $TICK * 0.1;
2175 2552 $BDB_POLL_WATCHER = Event->io (
2176Event->io ( 2553 reentrant => 0,
2177 fd => IO::AIO::poll_fileno, 2554 fd => BDB::poll_fileno,
2178 poll => 'r', 2555 poll => 'r',
2179 prio => 5, 2556 prio => 0,
2180 data => WF_AUTOCANCEL,
2181 cb => \&IO::AIO::poll_cb,
2182);
2183
2184Event->timer (
2185 data => WF_AUTOCANCEL, 2557 data => WF_AUTOCANCEL,
2186 after => 0, 2558 cb => \&BDB::poll_cb,
2187 interval => 10, 2559 );
2188 cb => sub { 2560 BDB::min_parallel 8;
2189 (Coro::unblock_sub { 2561
2190 write_runtime 2562 BDB::set_sync_prepare {
2191 or warn "ERROR: unable to write runtime file: $!"; 2563 my $status;
2564 my $current = $Coro::current;
2565 (
2566 sub {
2567 $status = $!;
2568 $current->ready; undef $current;
2569 },
2570 sub {
2571 Coro::schedule while defined $current;
2572 $! = $status;
2573 },
2574 )
2575 };
2576
2577 unless ($DB_ENV) {
2578 $DB_ENV = BDB::db_env_create;
2579
2580 cf::sync_job {
2581 eval {
2582 BDB::db_env_open
2583 $DB_ENV,
2584 $BDB_ENV_DIR,
2585 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2586 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2587 0666;
2588
2589 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!;
2590
2591 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2592 $DB_ENV->set_lk_detect;
2593 };
2594
2595 cf::cleanup "db_env_open(db): $@" if $@;
2192 })->(); 2596 };
2193 }, 2597 }
2194); 2598}
2599
2600{
2601 IO::AIO::min_parallel 8;
2602
2603 undef $Coro::AIO::WATCHER;
2604 IO::AIO::max_poll_time $TICK * 0.1;
2605 $AIO_POLL_WATCHER = Event->io (
2606 reentrant => 0,
2607 data => WF_AUTOCANCEL,
2608 fd => IO::AIO::poll_fileno,
2609 poll => 'r',
2610 prio => 6,
2611 cb => \&IO::AIO::poll_cb,
2612 );
2613}
2614
2615END { cf::emergency_save }
2195 2616
21961 26171
2197 2618

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines