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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines