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.137 by root, Fri Jan 5 10:23:05 2007 UTC vs.
Revision 1.231 by root, Wed Apr 4 00:02:06 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines