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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines