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.130 by root, Thu Jan 4 00:08:08 2007 UTC vs.
Revision 1.209 by root, Mon Feb 12 01:25:55 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines