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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines