ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cf.schmorp.de/server/lib/cf.pm
(Generate patch)

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.126 by root, Tue Jan 2 23:12:47 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
1180sub find_map; 1388sub find;
1181sub find_map { 1389sub find {
1182 my ($path, $origin) = @_; 1390 my ($path, $origin) = @_;
1183 1391
1184 #warn "find_map<$path,$origin>\n";#d#
1185
1186 $path = new cf::path $path, $origin && $origin->path; 1392 $path = normalise $path, $origin && $origin->path;
1187 my $key = $path->as_string;
1188 1393
1189 cf::lock_wait "map_find:$key"; 1394 cf::lock_wait "map_find:$path";
1190 1395
1191 $cf::MAP{$key} || do { 1396 $cf::MAP{$path} || do {
1192 my $guard = cf::lock_acquire "map_find:$key"; 1397 my $guard = cf::lock_acquire "map_find:$path";
1193 1398 my $map = new_from_path cf::map $path
1194 # do it the slow way
1195 my $map = try_load_header $path->save_path;
1196
1197 if ($map) {
1198 # safety
1199 $map->{instantiate_time} = $cf::RUNTIME
1200 if $map->{instantiate_time} > $cf::RUNTIME;
1201 } else {
1202 if (my $rmp = $path->random_map_params) {
1203 $map = generate_random_map $key, $rmp;
1204 } else {
1205 $map = try_load_header $path->load_path;
1206 }
1207
1208 $map or return; 1399 or return;
1209 1400
1210 $map->{load_original} = 1;
1211 $map->{instantiate_time} = $cf::RUNTIME;
1212 $map->instantiate;
1213
1214 # per-player maps become, after loading, normal maps
1215 $map->per_player (0) if $path->{user_rel};
1216 }
1217
1218 $map->path ($key);
1219 $map->{path} = $path;
1220 $map->{last_save} = $cf::RUNTIME; 1401 $map->{last_save} = $cf::RUNTIME;
1221 $map->last_access ($cf::RUNTIME);
1222 1402
1223 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;
1224 $map->reset; 1409 $map->reset;
1225 undef $guard; 1410 undef $guard;
1226 $map = find_map $path 1411 return find $path;
1227 or return;
1228 } 1412 }
1229 1413
1230 $cf::MAP{$key} = $map 1414 $cf::MAP{$path} = $map
1231 } 1415 }
1232} 1416}
1417
1418sub pre_load { }
1419sub post_load { }
1233 1420
1234sub load { 1421sub load {
1235 my ($self) = @_; 1422 my ($self) = @_;
1236 1423
1424 local $self->{deny_reset} = 1; # loading can take a long time
1425
1237 my $path = $self->{path}; 1426 my $path = $self->{path};
1238 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1427 my $guard = cf::lock_acquire "map_load:$path";
1239 1428
1240 return if $self->in_memory != cf::MAP_SWAPPED; 1429 return if $self->in_memory != cf::MAP_SWAPPED;
1241 1430
1242 $self->in_memory (cf::MAP_LOADING); 1431 $self->in_memory (cf::MAP_LOADING);
1243 1432
1244 $self->alloc; 1433 $self->alloc;
1434
1435 $self->pre_load;
1436
1245 $self->load_objects ($self->{load_path}, 1) 1437 $self->_load_objects ($self->{load_path}, 1)
1246 or return; 1438 or return;
1247 1439
1248 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1440 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1249 if delete $self->{load_original}; 1441 if delete $self->{load_original};
1250 1442
1251 if (my $uniq = $path->uniq_path) { 1443 if (my $uniq = $self->uniq_path) {
1252 utf8::encode $uniq; 1444 utf8::encode $uniq;
1253 if (aio_open $uniq, O_RDONLY, 0) { 1445 if (aio_open $uniq, O_RDONLY, 0) {
1254 $self->clear_unique_items; 1446 $self->clear_unique_items;
1255 $self->load_objects ($uniq, 0); 1447 $self->_load_objects ($uniq, 0);
1256 } 1448 }
1257 } 1449 }
1450
1451 Coro::cede;
1258 1452
1259 # now do the right thing for maps 1453 # now do the right thing for maps
1260 $self->link_multipart_objects; 1454 $self->link_multipart_objects;
1261 1455
1262 if ($self->{path}->is_style_map) { 1456 unless ($self->{deny_activate}) {
1263 $self->{deny_save} = 1; 1457 $self->decay_objects;
1264 $self->{deny_reset} = 1;
1265 } else {
1266 $self->fix_auto_apply; 1458 $self->fix_auto_apply;
1267 $self->decay_objects;
1268 $self->update_buttons; 1459 $self->update_buttons;
1460 Coro::cede;
1269 $self->set_darkness_map; 1461 $self->set_darkness_map;
1270 $self->difficulty ($self->estimate_difficulty) 1462 $self->difficulty ($self->estimate_difficulty)
1271 unless $self->difficulty; 1463 unless $self->difficulty;
1464 Coro::cede;
1272 $self->activate; 1465 $self->activate;
1273 } 1466 }
1274 1467
1468 $self->post_load;
1469
1275 $self->in_memory (cf::MAP_IN_MEMORY); 1470 $self->in_memory (cf::MAP_IN_MEMORY);
1276} 1471}
1277 1472
1278sub 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 {
1279 my ($path, $origin) = @_; 1507 my ($path, $origin) = @_;
1280 1508
1281 #warn "load_map_sync<$path, $origin>\n";#d# 1509 cf::sync_job { find $path, $origin }
1510}
1282 1511
1283 cf::sync_job { 1512sub do_load_sync {
1284 my $map = cf::map::find_map $path, $origin 1513 my ($map) = @_;
1285 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;
1286 $map->load; 1536 $map->load;
1287 $map 1537
1538 delete $MAP_PREFETCH{$path};
1539 }
1540 }
1541 undef $MAP_PREFETCHER;
1288 } 1542 };
1543 $MAP_PREFETCHER->prio (6);
1544
1545 ()
1289} 1546}
1290 1547
1291sub save { 1548sub save {
1292 my ($self) = @_; 1549 my ($self) = @_;
1293 1550
1551 my $lock = cf::lock_acquire "map_data:" . $self->path;
1552
1294 $self->{last_save} = $cf::RUNTIME; 1553 $self->{last_save} = $cf::RUNTIME;
1295 1554
1296 return unless $self->dirty; 1555 return unless $self->dirty;
1297 1556
1298 my $save = $self->{path}->save_path; utf8::encode $save; 1557 my $save = $self->save_path; utf8::encode $save;
1299 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1558 my $uniq = $self->uniq_path; utf8::encode $uniq;
1300 1559
1301 $self->{load_path} = $save; 1560 $self->{load_path} = $save;
1302 1561
1303 return if $self->{deny_save}; 1562 return if $self->{deny_save};
1304 1563
1564 local $self->{last_access} = $self->last_access;#d#
1565
1566 cf::async {
1567 $_->contr->save for $self->players;
1568 };
1569
1305 if ($uniq) { 1570 if ($uniq) {
1306 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1571 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1307 $self->save_objects ($uniq, cf::IO_UNIQUES); 1572 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1308 } else { 1573 } else {
1309 $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);
1310 } 1575 }
1311} 1576}
1312 1577
1313sub swap_out { 1578sub swap_out {
1314 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;
1315 1585
1316 return if $self->players; 1586 return if $self->players;
1317 return if $self->in_memory != cf::MAP_IN_MEMORY; 1587 return if $self->in_memory != cf::MAP_IN_MEMORY;
1318 return if $self->{deny_save}; 1588 return if $self->{deny_save};
1319 1589
1320 $self->save;
1321 $self->clear; 1590 $self->clear;
1322 $self->in_memory (cf::MAP_SWAPPED); 1591 $self->in_memory (cf::MAP_SWAPPED);
1323} 1592}
1324 1593
1325sub reset_at { 1594sub reset_at {
1326 my ($self) = @_; 1595 my ($self) = @_;
1327 1596
1328 # TODO: safety, remove and allow resettable per-player maps 1597 # TODO: safety, remove and allow resettable per-player maps
1329 return 1e99 if $self->{path}{user_rel}; 1598 return 1e99 if $self->isa ("ext::map_per_player");#d#
1330 return 1e99 if $self->{deny_reset}; 1599 return 1e99 if $self->{deny_reset};
1331 1600
1332 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1601 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1333 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;
1334 1603
1339 my ($self) = @_; 1608 my ($self) = @_;
1340 1609
1341 $self->reset_at <= $cf::RUNTIME 1610 $self->reset_at <= $cf::RUNTIME
1342} 1611}
1343 1612
1344sub unlink_save {
1345 my ($self) = @_;
1346
1347 utf8::encode (my $save = $self->{path}->save_path);
1348 aioreq_pri 3; IO::AIO::aio_unlink $save;
1349 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1350}
1351
1352sub rename {
1353 my ($self, $new_path) = @_;
1354
1355 $self->unlink_save;
1356
1357 delete $cf::MAP{$self->path};
1358 $self->{path} = new cf::path $new_path;
1359 $self->path ($self->{path}->as_string);
1360 $cf::MAP{$self->path} = $self;
1361
1362 $self->save;
1363}
1364
1365sub reset { 1613sub reset {
1366 my ($self) = @_; 1614 my ($self) = @_;
1367 1615
1616 my $lock = cf::lock_acquire "map_data:$self->{path}";
1617
1368 return if $self->players; 1618 return if $self->players;
1369 return if $self->{path}{user_rel};#d# 1619 return if $self->isa ("ext::map_per_player");#d#
1370 1620
1371 warn "resetting map ", $self->path;#d# 1621 warn "resetting map ", $self->path;#d#
1372 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
1373 delete $cf::MAP{$self->path}; 1633 delete $cf::MAP{$self->path};
1634
1635 $self->clear;
1374 1636
1375 $_->clear_links_to ($self) for values %cf::MAP; 1637 $_->clear_links_to ($self) for values %cf::MAP;
1376 1638
1377 $self->unlink_save; 1639 $self->unlink_save;
1378 $self->destroy; 1640 $self->destroy;
1381my $nuke_counter = "aaaa"; 1643my $nuke_counter = "aaaa";
1382 1644
1383sub nuke { 1645sub nuke {
1384 my ($self) = @_; 1646 my ($self) = @_;
1385 1647
1648 delete $cf::MAP{$self->path};
1649
1650 $self->unlink_save;
1651
1652 bless $self, "cf::map";
1653 delete $self->{deny_reset};
1386 $self->{deny_save} = 1; 1654 $self->{deny_save} = 1;
1387 $self->reset_timeout (1); 1655 $self->reset_timeout (1);
1388 $self->rename ("{nuke}/" . ($nuke_counter++)); 1656 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1657
1658 $cf::MAP{$self->path} = $self;
1659
1389 $self->reset; # polite request, might not happen 1660 $self->reset; # polite request, might not happen
1390} 1661}
1391 1662
1392sub customise_for { 1663=item cf::map::unique_maps
1393 my ($map, $ob) = @_;
1394 1664
1395 if ($map->per_player) { 1665Returns an arrayref of paths of all shared maps that have
1396 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 1666instantiated unique items. May block.
1397 }
1398 1667
1399 $map 1668=cut
1400}
1401 1669
1402sub emergency_save { 1670sub unique_maps() {
1403 local $cf::FREEZE = 1; 1671 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1672 or return;
1404 1673
1405 warn "enter emergency map save\n"; 1674 my @paths;
1406 1675
1407 cf::sync_job { 1676 for (@$files) {
1408 warn "begin emergency map save\n"; 1677 utf8::decode $_;
1409 $_->save for values %cf::MAP; 1678 next if /\.pst$/;
1679 next unless /^$PATH_SEP/o;
1680
1681 push @paths, cf::map::normalise $_;
1410 }; 1682 }
1411 1683
1412 warn "end emergency map save\n"; 1684 \@paths
1413} 1685}
1414 1686
1415package cf; 1687package cf;
1416 1688
1417=back 1689=back
1418 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
1419 1717
1420=head3 cf::object::player 1718=head3 cf::object::player
1421 1719
1422=over 4 1720=over 4
1423 1721
1463 1761
1464=item $player_object->enter_link 1762=item $player_object->enter_link
1465 1763
1466Freezes 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}>).
1467 1765
1468The 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
1469I<MUST> call C<leave_link> as soon as possible, though. 1767I<MUST> call C<leave_link> as soon as possible, though.
1470 1768
1769Will never block.
1770
1471=item $player_object->leave_link ($map, $x, $y) 1771=item $player_object->leave_link ($map, $x, $y)
1472 1772
1473Moves 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
1474map 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
1475location 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
1476to the emergency map position. 1776fails, to the emergency map position.
1477 1777
1478Might block. 1778Might block.
1479 1779
1480=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}
1481 1791
1482sub cf::object::player::enter_link { 1792sub cf::object::player::enter_link {
1483 my ($self) = @_; 1793 my ($self) = @_;
1484 1794
1485 $self->deactivate_recursive; 1795 $self->deactivate_recursive;
1486 1796
1487 return if $self->map == $LINK_MAP; 1797 return if UNIVERSAL::isa $self->map, "ext::map_link";
1488 1798
1489 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 1799 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1490 if $self->map; 1800 if $self->map;
1491 1801
1492 $self->enter_map ($LINK_MAP, 20, 20); 1802 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1493} 1803}
1494 1804
1495sub cf::object::player::leave_link { 1805sub cf::object::player::leave_link {
1496 my ($self, $map, $x, $y) = @_; 1806 my ($self, $map, $x, $y) = @_;
1497 1807
1498 my $link_pos = delete $self->{_link_pos}; 1808 my $link_pos = delete $self->{_link_pos};
1499 1809
1500 unless ($map) { 1810 unless ($map) {
1501 # restore original map position 1811 # restore original map position
1502 ($map, $x, $y) = @{ $link_pos || [] }; 1812 ($map, $x, $y) = @{ $link_pos || [] };
1503 $map = cf::map::find_map $map; 1813 $map = cf::map::find $map;
1504 1814
1505 unless ($map) { 1815 unless ($map) {
1506 ($map, $x, $y) = @$EMERGENCY_POSITION; 1816 ($map, $x, $y) = @$EMERGENCY_POSITION;
1507 $map = cf::map::find_map $map 1817 $map = cf::map::find $map
1508 or die "FATAL: cannot load emergency map\n"; 1818 or die "FATAL: cannot load emergency map\n";
1509 } 1819 }
1510 } 1820 }
1511 1821
1512 ($x, $y) = (-1, -1) 1822 ($x, $y) = (-1, -1)
1515 # use -1 or undef as default coordinates, not 0, 0 1825 # use -1 or undef as default coordinates, not 0, 0
1516 ($x, $y) = ($map->enter_x, $map->enter_y) 1826 ($x, $y) = ($map->enter_x, $map->enter_y)
1517 if $x <=0 && $y <= 0; 1827 if $x <=0 && $y <= 0;
1518 1828
1519 $map->load; 1829 $map->load;
1830 $map->load_diag;
1520 1831
1832 return unless $self->contr->active;
1521 $self->activate_recursive; 1833 $self->activate_recursive;
1834
1835 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1522 $self->enter_map ($map, $x, $y); 1836 $self->enter_map ($map, $x, $y);
1523} 1837}
1524 1838
1525cf::player->attach ( 1839cf::player->attach (
1526 on_logout => sub { 1840 on_logout => sub {
1538 1852
1539 # try to abort aborted map switching on player login :) 1853 # try to abort aborted map switching on player login :)
1540 # should happen only on crashes 1854 # should happen only on crashes
1541 if ($pl->ob->{_link_pos}) { 1855 if ($pl->ob->{_link_pos}) {
1542 $pl->ob->enter_link; 1856 $pl->ob->enter_link;
1543 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);
1544 # 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
1545 # 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
1546 Coro::Timer::sleep 1; 1864 Coro::Timer::sleep 1;
1547 $pl->ob->leave_link; 1865 $pl->ob->leave_link;
1548 }; 1866 })->prio (2);
1549 } 1867 }
1550 }, 1868 },
1551); 1869);
1552 1870
1553=item $player_object->goto_map ($path, $x, $y) 1871=item $player_object->goto ($path, $x, $y)
1554 1872
1555=cut 1873=cut
1556 1874
1557sub cf::object::player::goto_map { 1875sub cf::object::player::goto {
1558 my ($self, $path, $x, $y) = @_; 1876 my ($self, $path, $x, $y) = @_;
1559 1877
1560 $self->enter_link; 1878 $self->enter_link;
1561 1879
1562 (Coro::async { 1880 (async {
1563 $path = new cf::path $path; 1881 my $map = eval {
1564
1565 my $map = cf::map::find_map $path->as_string; 1882 my $map = cf::map::find $path;
1566 $map = $map->customise_for ($self) if $map; 1883 $map = $map->customise_for ($self) if $map;
1567 1884 $map
1568# warn "entering ", $map->path, " at ($x, $y)\n" 1885 } or
1569# if $map;
1570
1571 $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);
1572 1887
1573 $self->leave_link ($map, $x, $y); 1888 $self->leave_link ($map, $x, $y);
1574 })->prio (1); 1889 })->prio (1);
1575} 1890}
1576 1891
1580 1895
1581sub parse_random_map_params { 1896sub parse_random_map_params {
1582 my ($spec) = @_; 1897 my ($spec) = @_;
1583 1898
1584 my $rmp = { # defaults 1899 my $rmp = { # defaults
1585 xsize => 10, 1900 xsize => (cf::rndm 15, 40),
1586 ysize => 10, 1901 ysize => (cf::rndm 15, 40),
1902 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1903 #layout => string,
1587 }; 1904 };
1588 1905
1589 for (split /\n/, $spec) { 1906 for (split /\n/, $spec) {
1590 my ($k, $v) = split /\s+/, $_, 2; 1907 my ($k, $v) = split /\s+/, $_, 2;
1591 1908
1595 $rmp 1912 $rmp
1596} 1913}
1597 1914
1598sub prepare_random_map { 1915sub prepare_random_map {
1599 my ($exit) = @_; 1916 my ($exit) = @_;
1917
1918 my $guard = cf::lock_acquire "exit_prepare:$exit";
1600 1919
1601 # all this does is basically replace the /! path by 1920 # all this does is basically replace the /! path by
1602 # a new random map path (?random/...) with a seed 1921 # a new random map path (?random/...) with a seed
1603 # that depends on the exit object 1922 # that depends on the exit object
1604 1923
1605 my $rmp = parse_random_map_params $exit->msg; 1924 my $rmp = parse_random_map_params $exit->msg;
1606 1925
1607 if ($exit->map) { 1926 if ($exit->map) {
1608 $rmp->{region} = $exit->map->region_name; 1927 $rmp->{region} = $exit->region->name;
1609 $rmp->{origin_map} = $exit->map->path; 1928 $rmp->{origin_map} = $exit->map->path;
1610 $rmp->{origin_x} = $exit->x; 1929 $rmp->{origin_x} = $exit->x;
1611 $rmp->{origin_y} = $exit->y; 1930 $rmp->{origin_y} = $exit->y;
1612 } 1931 }
1613 1932
1614 $rmp->{random_seed} ||= $exit->random_seed; 1933 $rmp->{random_seed} ||= $exit->random_seed;
1615 1934
1616 my $data = cf::to_json $rmp; 1935 my $data = cf::to_json $rmp;
1617 my $md5 = Digest::MD5::md5_hex $data; 1936 my $md5 = Digest::MD5::md5_hex $data;
1937 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1618 1938
1619 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) {
1620 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;
1621 1943
1622 $exit->slaying ("?random/$md5"); 1944 $exit->slaying ("?random/$md5");
1623 $exit->msg (undef); 1945 $exit->msg (undef);
1624 } 1946 }
1625} 1947}
1627sub cf::object::player::enter_exit { 1949sub cf::object::player::enter_exit {
1628 my ($self, $exit) = @_; 1950 my ($self, $exit) = @_;
1629 1951
1630 return unless $self->type == cf::PLAYER; 1952 return unless $self->type == cf::PLAYER;
1631 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
1632 $self->enter_link; 1963 $self->enter_link;
1633 1964
1634 (Coro::async { 1965 (async {
1966 $self->deactivate_recursive; # just to be sure
1635 unless (eval { 1967 unless (eval {
1636 1968 $self->goto ($slaying, $hp, $sp);
1637 prepare_random_map $exit
1638 if $exit->slaying eq "/!";
1639
1640 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1641 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1642 1969
1643 1; 1970 1;
1644 }) { 1971 }) {
1645 $self->message ("Something went wrong deep within the crossfire server. " 1972 $self->message ("Something went wrong deep within the crossfire server. "
1646 . "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. "
1647 . "Please report this to the dungeon master", 1974 . "Please report this to the dungeon master!",
1648 cf::NDI_UNIQUE | cf::NDI_RED); 1975 cf::NDI_UNIQUE | cf::NDI_RED);
1649 1976
1650 warn "ERROR in enter_exit: $@"; 1977 warn "ERROR in enter_exit: $@";
1651 $self->leave_link; 1978 $self->leave_link;
1652 } 1979 }
1703 on_reply => sub { 2030 on_reply => sub {
1704 my ($ns, $msg) = @_; 2031 my ($ns, $msg) = @_;
1705 2032
1706 # this weird shuffling is so that direct followup queries 2033 # this weird shuffling is so that direct followup queries
1707 # get handled first 2034 # get handled first
1708 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
1709 2037
1710 (shift @$queue)->[1]->($msg); 2038 (shift @$queue)->[1]->($msg);
2039 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1711 2040
1712 push @{ $ns->{query_queue} }, @$queue; 2041 push @{ $ns->{query_queue} }, @$queue;
1713 2042
1714 if (@{ $ns->{query_queue} } == @$queue) { 2043 if (@{ $ns->{query_queue} } == @$queue) {
1715 if (@$queue) { 2044 if (@$queue) {
1719 } 2048 }
1720 } 2049 }
1721 }, 2050 },
1722); 2051);
1723 2052
1724=item $client->coro (\&cb) 2053=item $client->async (\&cb)
1725 2054
1726Create a new coroutine, running the specified callback. The coroutine will 2055Create a new coroutine, running the specified callback. The coroutine will
1727be automatically cancelled when the client gets destroyed (e.g. on logout, 2056be automatically cancelled when the client gets destroyed (e.g. on logout,
1728or loss of connection). 2057or loss of connection).
1729 2058
1730=cut 2059=cut
1731 2060
1732sub cf::client::coro { 2061sub cf::client::async {
1733 my ($self, $cb) = @_; 2062 my ($self, $cb) = @_;
1734 2063
1735 my $coro; $coro = async { 2064 my $coro = &Coro::async ($cb);
1736 eval {
1737 $cb->();
1738 };
1739 warn $@ if $@;
1740 };
1741 2065
1742 $coro->on_destroy (sub { 2066 $coro->on_destroy (sub {
1743 delete $self->{_coro}{$coro+0}; 2067 delete $self->{_coro}{$coro+0};
1744 }); 2068 });
1745 2069
1881The 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
1882using it, it should be unique. 2206using it, it should be unique.
1883 2207
1884=over 4 2208=over 4
1885 2209
1886=item $hashref = cf::db_get $family
1887
1888Return a hashref for use by the extension C<$family>, which can be
1889modified. After modifications, you have to call C<cf::db_dirty> or
1890C<cf::db_sync>.
1891
1892=item $value = cf::db_get $family => $key 2210=item $value = cf::db_get $family => $key
1893 2211
1894Returns a single value from the database 2212Returns a single value from the database.
1895
1896=item cf::db_put $family => $hashref
1897
1898Stores the given family hashref into the database. Updates are delayed, if
1899you want the data to be synced to disk immediately, use C<cf::db_sync>.
1900 2213
1901=item cf::db_put $family => $key => $value 2214=item cf::db_put $family => $key => $value
1902 2215
1903Stores the given C<$value> in the family hash. Updates are delayed, if you 2216Stores the given C<$value> in the family.
1904want the data to be synced to disk immediately, use C<cf::db_sync>.
1905
1906=item cf::db_dirty
1907
1908Marks the database as dirty, to be updated at a later time.
1909
1910=item cf::db_sync
1911
1912Immediately write the database to disk I<if it is dirty>.
1913 2217
1914=cut 2218=cut
1915 2219
1916our $DB; 2220our $DB;
1917 2221
1918{ 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
1919 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;
1920 2241
1921 sub db_load() { 2242 cf::db_put (board => data => $pst->{board});
1922 $DB = stat $path ? Storable::retrieve $path : { }; 2243 cf::db_put (guildrules => data => $pst->{guildrules});
1923 } 2244 cf::db_put (rent => balance => $pst->{rent}{balance});
2245 BDB::db_env_txn_checkpoint $DB_ENV;
1924 2246
1925 my $pid; 2247 unlink $path;
1926
1927 sub db_save() {
1928 waitpid $pid, 0 if $pid;
1929 if (0 == ($pid = fork)) {
1930 $DB->{_meta}{version} = 1;
1931 Storable::nstore $DB, "$path~";
1932 rename "$path~", $path;
1933 cf::_exit 0 if defined $pid;
1934 } 2248 };
1935 }
1936
1937 my $dirty;
1938
1939 sub db_sync() {
1940 db_save if $dirty;
1941 undef $dirty;
1942 }
1943
1944 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1945 db_sync;
1946 });
1947
1948 sub db_dirty() {
1949 $dirty = 1;
1950 $idle->start;
1951 }
1952
1953 sub db_get($;$) {
1954 @_ >= 2
1955 ? $DB->{$_[0]}{$_[1]}
1956 : ($DB->{$_[0]} ||= { })
1957 }
1958
1959 sub db_put($$;$) {
1960 if (@_ >= 3) {
1961 $DB->{$_[0]}{$_[1]} = $_[2];
1962 } else {
1963 $DB->{$_[0]} = $_[1];
1964 }
1965 db_dirty;
1966 }
1967
1968 cf::global->attach (
1969 prio => 10000,
1970 on_cleanup => sub {
1971 db_sync;
1972 }, 2249 }
1973 ); 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 { };
1974} 2267}
1975 2268
1976############################################################################# 2269#############################################################################
1977# 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}
1978 2305
1979sub cfg_load { 2306sub cfg_load {
1980 open my $fh, "<:utf8", cf::confdir . "/config" 2307 open my $fh, "<:utf8", cf::confdir . "/config"
1981 or return; 2308 or return;
1982 2309
1983 local $/; 2310 local $/;
1984 *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 }
1985} 2325}
1986 2326
1987sub main { 2327sub main {
1988 # we must not ever block the main coroutine 2328 # we must not ever block the main coroutine
1989 local $Coro::idle = sub { 2329 local $Coro::idle = sub {
1990 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#
1991 (Coro::unblock_sub { 2331 (async {
1992 Event::one_event; 2332 Event::one_event;
1993 })->(); 2333 })->prio (Coro::PRIO_MAX);
1994 }; 2334 };
1995 2335
1996 cfg_load; 2336 cfg_load;
1997 db_load; 2337 db_init;
1998 load_extensions; 2338 load_extensions;
2339
2340 $TICK_WATCHER->start;
1999 Event::loop; 2341 Event::loop;
2000} 2342}
2001 2343
2002############################################################################# 2344#############################################################################
2003# 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}
2004 2401
2005sub reload() { 2402sub reload() {
2006 # can/must only be called in main 2403 # can/must only be called in main
2007 if ($Coro::current != $Coro::main) { 2404 if ($Coro::current != $Coro::main) {
2008 warn "can only reload from main coroutine\n"; 2405 warn "can only reload from main coroutine";
2009 return; 2406 return;
2010 } 2407 }
2011 2408
2012 warn "reloading..."; 2409 warn "reloading...";
2013 2410
2014 local $FREEZE = 1; 2411 warn "entering sync_job";
2412
2413 cf::sync_job {
2414 cf::write_runtime; # external watchdog should not bark
2015 cf::emergency_save; 2415 cf::emergency_save;
2416 cf::write_runtime; # external watchdog should not bark
2016 2417
2017 eval { 2418 warn "syncing database to disk";
2419 BDB::db_env_txn_checkpoint $DB_ENV;
2420
2018 # 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
2019 2422
2020 # cancel all watchers 2423 warn "cancelling all WF_AUTOCANCEL watchers";
2021 for (Event::all_watchers) { 2424 for (Event::all_watchers) {
2022 $_->cancel if $_->data & WF_AUTOCANCEL; 2425 $_->cancel if $_->data & WF_AUTOCANCEL;
2023 } 2426 }
2024 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
2025 # cancel all extension coros 2439 warn "cancelling all extension coros";
2026 $_->cancel for values %EXT_CORO; 2440 $_->cancel for values %EXT_CORO;
2027 %EXT_CORO = (); 2441 %EXT_CORO = ();
2028 2442
2029 # unload all extensions 2443 warn "removing commands";
2030 for (@exts) { 2444 %COMMAND = ();
2445
2446 warn "removing ext commands";
2447 %EXTCMD = ();
2448
2449 warn "unloading/nuking all extensions";
2450 for my $pkg (@EXTS) {
2031 warn "unloading <$_>"; 2451 warn "... unloading $pkg";
2032 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: $@";
2033 } 2458 }
2034 2459
2460 warn "... nuking $pkg";
2461 Symbol::delete_package $pkg;
2462 }
2463
2035 # unload all modules loaded from $LIBDIR 2464 warn "unloading all perl modules loaded from $LIBDIR";
2036 while (my ($k, $v) = each %INC) { 2465 while (my ($k, $v) = each %INC) {
2037 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2466 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2038 2467
2039 warn "removing <$k>"; 2468 warn "... unloading $k";
2040 delete $INC{$k}; 2469 delete $INC{$k};
2041 2470
2042 $k =~ s/\.pm$//; 2471 $k =~ s/\.pm$//;
2043 $k =~ s/\//::/g; 2472 $k =~ s/\//::/g;
2044 2473
2047 } 2476 }
2048 2477
2049 Symbol::delete_package $k; 2478 Symbol::delete_package $k;
2050 } 2479 }
2051 2480
2052 # sync database to disk
2053 cf::db_sync;
2054 IO::AIO::flush;
2055
2056 # get rid of safe::, as good as possible 2481 warn "getting rid of safe::, as good as possible";
2057 Symbol::delete_package "safe::$_" 2482 Symbol::delete_package "safe::$_"
2058 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);
2059 2484
2060 # remove register_script_function callbacks
2061 # TODO
2062
2063 # unload cf.pm "a bit" 2485 warn "unloading cf.pm \"a bit\"";
2064 delete $INC{"cf.pm"}; 2486 delete $INC{"cf.pm"};
2065 2487
2066 # don't, removes xs symbols, too, 2488 # don't, removes xs symbols, too,
2067 # and global variables created in xs 2489 # and global variables created in xs
2068 #Symbol::delete_package __PACKAGE__; 2490 #Symbol::delete_package __PACKAGE__;
2069 2491
2070 # reload cf.pm 2492 warn "unload completed, starting to reload now";
2493
2071 warn "reloading cf.pm"; 2494 warn "reloading cf.pm";
2072 require cf; 2495 require cf;
2073 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2496 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2074 2497
2075 # load config and database again 2498 warn "loading config and database again";
2076 cf::cfg_load; 2499 cf::cfg_load;
2077 cf::db_load;
2078 2500
2079 # load extensions
2080 warn "load extensions"; 2501 warn "loading extensions";
2081 cf::load_extensions; 2502 cf::load_extensions;
2082 2503
2083 # reattach attachments to objects 2504 warn "reattaching attachments to objects/players";
2084 warn "reattach"; 2505 _global_reattach; # objects, sockets
2085 _global_reattach; 2506 warn "reattaching attachments to maps";
2086 }; 2507 reattach $_ for values %MAP;
2508 warn "reattaching attachments to players";
2509 reattach $_ for values %PLAYER;
2087 2510
2088 if ($@) { 2511 warn "loading reloadable resources";
2512 reload_resources;
2513
2514 warn "leaving sync_job";
2515
2516 1
2517 } or do {
2089 warn $@; 2518 warn $@;
2090 warn "error while reloading, exiting."; 2519 warn "error while reloading, exiting.";
2091 exit 1; 2520 exit 1;
2092 } 2521 };
2093 2522
2094 warn "reloaded successfully"; 2523 warn "reloaded";
2095}; 2524};
2096 2525
2097############################################################################# 2526our $RELOAD_WATCHER; # used only during reload
2098
2099unless ($LINK_MAP) {
2100 $LINK_MAP = cf::map::new;
2101
2102 $LINK_MAP->width (41);
2103 $LINK_MAP->height (41);
2104 $LINK_MAP->alloc;
2105 $LINK_MAP->path ("{link}");
2106 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2107 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2108
2109 # dirty hack because... archetypes are not yet loaded
2110 Event->timer (
2111 after => 2,
2112 cb => sub {
2113 $_[0]->w->cancel;
2114
2115 # provide some exits "home"
2116 my $exit = cf::object::new "exit";
2117
2118 $exit->slaying ($EMERGENCY_POSITION->[0]);
2119 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2120 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2121
2122 $LINK_MAP->insert ($exit->clone, 19, 19);
2123 $LINK_MAP->insert ($exit->clone, 19, 20);
2124 $LINK_MAP->insert ($exit->clone, 19, 21);
2125 $LINK_MAP->insert ($exit->clone, 20, 19);
2126 $LINK_MAP->insert ($exit->clone, 20, 21);
2127 $LINK_MAP->insert ($exit->clone, 21, 19);
2128 $LINK_MAP->insert ($exit->clone, 21, 20);
2129 $LINK_MAP->insert ($exit->clone, 21, 21);
2130
2131 $exit->destroy;
2132 });
2133
2134 $LINK_MAP->{deny_save} = 1;
2135 $LINK_MAP->{deny_reset} = 1;
2136
2137 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2138}
2139
2140register "<global>", __PACKAGE__;
2141 2527
2142register_command "reload" => sub { 2528register_command "reload" => sub {
2143 my ($who, $arg) = @_; 2529 my ($who, $arg) = @_;
2144 2530
2145 if ($who->flag (FLAG_WIZ)) { 2531 if ($who->flag (FLAG_WIZ)) {
2146 $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 {
2147 reload; 2542 reload;
2148 $who->message ("end of reload."); 2543 undef $RELOAD_WATCHER;
2544 },
2545 );
2149 } 2546 }
2150}; 2547};
2151 2548
2152unshift @INC, $LIBDIR; 2549unshift @INC, $LIBDIR;
2550
2551my $bug_warning = 0;
2153 2552
2154$TICK_WATCHER = Event->timer ( 2553$TICK_WATCHER = Event->timer (
2155 reentrant => 0, 2554 reentrant => 0,
2555 parked => 1,
2156 prio => 0, 2556 prio => 0,
2157 at => $NEXT_TICK || $TICK, 2557 at => $NEXT_TICK || $TICK,
2158 data => WF_AUTOCANCEL, 2558 data => WF_AUTOCANCEL,
2159 cb => sub { 2559 cb => sub {
2160 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
2161 cf::server_tick; # one server iteration 2568 cf::server_tick; # one server iteration
2162 $RUNTIME += $TICK; 2569 $RUNTIME += $TICK;
2163 }
2164
2165 $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#
2166 2585
2167 # 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
2168 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2587 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2169 2588
2170 $TICK_WATCHER->at ($NEXT_TICK); 2589 $TICK_WATCHER->at ($NEXT_TICK);
2171 $TICK_WATCHER->start; 2590 $TICK_WATCHER->start;
2172 }, 2591 },
2173); 2592);
2174 2593
2594{
2175IO::AIO::max_poll_time $TICK * 0.2; 2595 BDB::max_poll_time $TICK * 0.1;
2176 2596 $BDB_POLL_WATCHER = Event->io (
2177Event->io ( 2597 reentrant => 0,
2178 fd => IO::AIO::poll_fileno, 2598 fd => BDB::poll_fileno,
2179 poll => 'r', 2599 poll => 'r',
2180 prio => 5, 2600 prio => 0,
2181 data => WF_AUTOCANCEL,
2182 cb => \&IO::AIO::poll_cb,
2183);
2184
2185Event->timer (
2186 data => WF_AUTOCANCEL, 2601 data => WF_AUTOCANCEL,
2187 after => 0, 2602 cb => \&BDB::poll_cb,
2188 interval => 10, 2603 );
2189 cb => sub { 2604 BDB::min_parallel 8;
2190 (Coro::unblock_sub { 2605
2191 write_runtime 2606 BDB::set_sync_prepare {
2192 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 $@;
2193 })->(); 2640 };
2194 }, 2641 }
2195); 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}
2196 2658
2197END { cf::emergency_save } 2659END { cf::emergency_save }
2198 2660
21991 26611
2200 2662

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines