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.133 by root, Thu Jan 4 16:19:32 2007 UTC vs.
Revision 1.215 by root, Thu Feb 15 03:19:02 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines