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.275 by root, Thu Jun 7 19:12:22 2007 UTC vs.
Revision 1.346 by root, Tue Aug 28 19:38:40 2007 UTC

10use Event; 10use Event;
11use Opcode; 11use Opcode;
12use Safe; 12use Safe;
13use Safe::Hole; 13use Safe::Hole;
14 14
15use Coro 3.61 (); 15use Coro 3.64 ();
16use Coro::State; 16use Coro::State;
17use Coro::Handle; 17use Coro::Handle;
18use Coro::Event; 18use Coro::Event;
19use Coro::Timer; 19use Coro::Timer;
20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24use Coro::Util ();
24 25
26use JSON::XS ();
25use BDB (); 27use BDB ();
26use Data::Dumper; 28use Data::Dumper;
27use Digest::MD5; 29use Digest::MD5;
28use Fcntl; 30use Fcntl;
29use YAML::Syck (); 31use YAML::Syck ();
30use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
31use Time::HiRes; 33use Time::HiRes;
32use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
33 36
34# configure various modules to our taste 37# configure various modules to our taste
35# 38#
36$Storable::canonical = 1; # reduce rsync transfers 39$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
49our %COMMAND = (); 52our %COMMAND = ();
50our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
51 54
52our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
56 60
57our $RELOAD; # number of reloads so far 61our $RELOAD; # number of reloads so far
58our @EVENT; 62our @EVENT;
164 168
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process 170returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing. 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
178
169=back 179=back
170 180
171=cut 181=cut
172 182
173BEGIN { 183BEGIN {
206} 216}
207 217
208$Event::DIED = sub { 218$Event::DIED = sub {
209 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
210}; 220};
221
222#############################################################################
211 223
212=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
213 225
214=over 4 226=over 4
215 227
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 247 $d
236 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
237} 249}
238 250
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
242 252
243Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
244 254
245=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
246 256
247Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
258
259=cut
260
261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
262
263sub to_json ($) { $json_coder->encode ($_[0]) }
264sub from_json ($) { $json_coder->decode ($_[0]) }
248 265
249=item cf::lock_wait $string 266=item cf::lock_wait $string
250 267
251Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
252 269
306 }; 323 };
307 $TICK_WATCHER->stop; 324 $TICK_WATCHER->stop;
308 $guard 325 $guard
309} 326}
310 327
328=item cf::get_slot $time[, $priority[, $name]]
329
330Allocate $time seconds of blocking CPU time at priority C<$priority>:
331This call blocks and returns only when you have at least C<$time> seconds
332of cpu time till the next tick. The slot is only valid till the next cede.
333
334The optional C<$name> can be used to identify the job to run. It might be
335used for statistical purposes and should identify the same time-class.
336
337Useful for short background jobs.
338
339=cut
340
341our @SLOT_QUEUE;
342our $SLOT_QUEUE;
343
344$SLOT_QUEUE->cancel if $SLOT_QUEUE;
345$SLOT_QUEUE = Coro::async {
346 my $signal = new Coro::Signal;
347
348 while () {
349 next_job:
350 my $avail = cf::till_tick;
351 if ($avail > 0.01) {
352 for (0 .. $#SLOT_QUEUE) {
353 if ($SLOT_QUEUE[$_][0] < $avail) {
354 my $job = splice @SLOT_QUEUE, $_, 1, ();
355 $job->[2]->send;
356 Coro::cede;
357 goto next_job;
358 }
359 }
360 }
361
362 if (@SLOT_QUEUE) {
363 # we do not use wait_For_tick() as it returns immediately when tick is inactive
364 push @cf::WAIT_FOR_TICK, $signal;
365 $signal->wait;
366 } else {
367 Coro::schedule;
368 }
369 }
370};
371
372sub get_slot($;$$) {
373 my ($time, $pri, $name) = @_;
374
375 $time = $TICK * .6 if $time > $TICK * .6;
376 my $sig = new Coro::Signal;
377
378 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
379 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
380 $SLOT_QUEUE->ready;
381 $sig->wait;
382}
383
311=item cf::async { BLOCK } 384=item cf::async { BLOCK }
312 385
313Currently the same as Coro::async_pool, meaning you cannot use 386Currently the same as Coro::async_pool, meaning you cannot use
314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 387C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it. 388thing you are allowed to do is call C<prio> on it.
318 391
319BEGIN { *async = \&Coro::async_pool } 392BEGIN { *async = \&Coro::async_pool }
320 393
321=item cf::sync_job { BLOCK } 394=item cf::sync_job { BLOCK }
322 395
323The design of crossfire+ requires that the main coro ($Coro::main) is 396The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 397is always able to handle events or runnable, as Crossfire TRT is only
325reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 398partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
399acceptable.
326 400
327If it must be done, put the blocking parts into C<sync_job>. This will run 401If it must be done, put the blocking parts into C<sync_job>. This will run
328the given BLOCK in another coroutine while waiting for the result. The 402the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 403server will be frozen during this time, so the block should either finish
330fast or be very important. 404fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 464 $EXT_CORO{$coro+0} = $coro;
391 465
392 $coro 466 $coro
393} 467}
394 468
395sub write_runtime { 469=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 470
398 # first touch the runtime file to show we are still running: 471Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 472process, returning the results. Everything must be serialisable with
473Coro::Storable. May, of course, block. Note that the executed sub may
474never block itself or use any form of Event handling.
400 475
401 IO::AIO::aio_utime $runtime, undef, undef; 476=cut
402 477
403 my $guard = cf::lock_acquire "write_runtime"; 478sub fork_call(&@) {
479 my ($cb, @args) = @_;
404 480
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 481 # we seemingly have to make a local copy of the whole thing,
406 or return; 482 # otherwise perl prematurely frees the stuff :/
483 # TODO: investigate and fix (liekly this will be rather laborious)
407 484
408 my $value = $cf::RUNTIME + 90 + 10; 485 my @res = Coro::Util::fork_eval {
409 # 10 is the runtime save interval, for a monotonic clock 486 reset_signals;
410 # 60 allows for the watchdog to kill the server. 487 &$cb
488 }, @args;
411 489
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0 490 wantarray ? @res : $res[-1]
413 and return; 491}
414 492
415 # always fsync - this file is important 493=item $value = cf::db_get $family => $key
416 aio_fsync $fh
417 and return;
418 494
419 # touch it again to show we are up-to-date 495Returns a single value from the environment database.
420 aio_utime $fh, undef, undef;
421 496
422 close $fh 497=item cf::db_put $family => $key => $value
423 or return;
424 498
425 aio_rename "$runtime~", $runtime 499Stores the given C<$value> in the family. It can currently store binary
426 and return; 500data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427 501
428 warn "runtime file written.\n"; 502=cut
429 503
504our $DB;
505
506sub db_init {
507 unless ($DB) {
508 $DB = BDB::db_create $DB_ENV;
509
510 cf::sync_job {
511 eval {
512 $DB->set_flags (BDB::CHKSUM);
513
514 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
515 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
516 cf::cleanup "db_open(db): $!" if $!;
517 };
518 cf::cleanup "db_open(db): $@" if $@;
519 };
430 1 520 }
521}
522
523sub db_get($$) {
524 my $key = "$_[0]/$_[1]";
525
526 cf::sync_job {
527 BDB::db_get $DB, undef, $key, my $data;
528
529 $! ? ()
530 : $data
531 }
532}
533
534sub db_put($$$) {
535 BDB::dbreq_pri 4;
536 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
537}
538
539=item cf::cache $id => [$paths...], $processversion => $process
540
541Generic caching function that returns the value of the resource $id,
542caching and regenerating as required.
543
544This function can block.
545
546=cut
547
548sub cache {
549 my ($id, $src, $processversion, $process) = @_;
550
551 my $meta =
552 join "\x00",
553 $processversion,
554 map {
555 aio_stat $_
556 and Carp::croak "$_: $!";
557
558 ($_, (stat _)[7,9])
559 } @$src;
560
561 my $dbmeta = db_get cache => "$id/meta";
562 if ($dbmeta ne $meta) {
563 # changed, we may need to process
564
565 my @data;
566 my $md5;
567
568 for (0 .. $#$src) {
569 0 <= aio_load $src->[$_], $data[$_]
570 or Carp::croak "$src->[$_]: $!";
571 }
572
573 # if processing is expensive, check
574 # checksum first
575 if (1) {
576 $md5 =
577 join "\x00",
578 $processversion,
579 map {
580 cf::cede_to_tick;
581 ($src->[$_], Digest::MD5::md5_hex $data[$_])
582 } 0.. $#$src;
583
584
585 my $dbmd5 = db_get cache => "$id/md5";
586 if ($dbmd5 eq $md5) {
587 db_put cache => "$id/meta", $meta;
588
589 return db_get cache => "$id/data";
590 }
591 }
592
593 my $t1 = Time::HiRes::time;
594 my $data = $process->(\@data);
595 my $t2 = Time::HiRes::time;
596
597 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
598
599 db_put cache => "$id/data", $data;
600 db_put cache => "$id/md5" , $md5;
601 db_put cache => "$id/meta", $meta;
602
603 return $data;
604 }
605
606 db_get cache => "$id/data"
431} 607}
432 608
433=item cf::datalog type => key => value, ... 609=item cf::datalog type => key => value, ...
434 610
435Log a datalog packet of the given type with the given key-value pairs. 611Log a datalog packet of the given type with the given key-value pairs.
453attach callbacks/event handlers (a collection of which is called an "attachment") 629attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 630to it. All such attachable objects support the following methods.
455 631
456In the following description, CLASS can be any of C<global>, C<object> 632In the following description, CLASS can be any of C<global>, C<object>
457C<player>, C<client> or C<map> (i.e. the attachable objects in 633C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 634Crossfire TRT).
459 635
460=over 4 636=over 4
461 637
462=item $attachable->attach ($attachment, key => $value...) 638=item $attachable->attach ($attachment, key => $value...)
463 639
665 _attach $registry, $klass, @attach; 841 _attach $registry, $klass, @attach;
666 } 842 }
667 843
668 $obj->{$name} = \%arg; 844 $obj->{$name} = \%arg;
669 } else { 845 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 846 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 847 }
672 848
673 $obj->{_attachment}{$name} = undef; 849 $obj->{_attachment}{$name} = undef;
674} 850}
675 851
715 "; 891 ";
716 die if $@; 892 die if $@;
717} 893}
718 894
719our $override; 895our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 896our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 897
722sub override { 898sub override {
723 $override = 1; 899 $override = 1;
724 @invoke_results = (); 900 @INVOKE_RESULTS = (@_);
725} 901}
726 902
727sub do_invoke { 903sub do_invoke {
728 my $event = shift; 904 my $event = shift;
729 my $callbacks = shift; 905 my $callbacks = shift;
730 906
731 @invoke_results = (); 907 @INVOKE_RESULTS = ();
732 908
733 local $override; 909 local $override;
734 910
735 for (@$callbacks) { 911 for (@$callbacks) {
736 eval { &{$_->[1]} }; 912 eval { &{$_->[1]} };
753 929
754Generate an object-specific event with the given arguments. 930Generate an object-specific event with the given arguments.
755 931
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 932This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757removed in future versions), and there is no public API to access override 933removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly). 934results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 935
760=back 936=back
761 937
762=cut 938=cut
763 939
764############################################################################# 940#############################################################################
765# object support 941# object support
942#
943
944sub _can_merge {
945 my ($ob1, $ob2) = @_;
946
947 local $Storable::canonical = 1;
948 my $fob1 = Storable::freeze $ob1;
949 my $fob2 = Storable::freeze $ob2;
950
951 $fob1 eq $fob2
952}
766 953
767sub reattach { 954sub reattach {
768 # basically do the same as instantiate, without calling instantiate 955 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 956 my ($obj) = @_;
770 957
877 warn sprintf "loading %s (%d)\n", 1064 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1065 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1066 return ($data, $av);
880} 1067}
881 1068
1069=head2 COMMAND CALLBACKS
1070
1071=over 4
1072
1073=cut
1074
882############################################################################# 1075#############################################################################
883# command handling &c 1076# command handling &c
884 1077
885=item cf::register_command $name => \&callback($ob,$args); 1078=item cf::register_command $name => \&callback($ob,$args);
886 1079
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1091 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1092}
900 1093
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1094=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1095
903Register a callbackf ro execution when the client sends an extcmd packet. 1096Register a callback for execution when the client sends an (synchronous)
1097extcmd packet. Ext commands will be processed in the order they are
1098received by the server, like other user commands. The first argument is
1099the logged-in player. Ext commands can only be processed after a player
1100has logged in successfully.
904 1101
905If the callback returns something, it is sent back as if reply was being 1102If the callback returns something, it is sent back as if reply was being
906called. 1103called.
907 1104
1105=item cf::register_exticmd $name => \&callback($ns,$packet);
1106
1107Register a callback for execution when the client sends an (asynchronous)
1108exticmd packet. Exti commands are processed by the server as soon as they
1109are received, i.e. out of order w.r.t. other commands. The first argument
1110is a client socket. Exti commands can be received anytime, even before
1111log-in.
1112
1113If the callback returns something, it is sent back as if reply was being
1114called.
1115
908=cut 1116=cut
909 1117
910sub register_extcmd { 1118sub register_extcmd {
911 my ($name, $cb) = @_; 1119 my ($name, $cb) = @_;
912 1120
913 $EXTCMD{$name} = $cb; 1121 $EXTCMD{$name} = $cb;
1122}
1123
1124sub register_exticmd {
1125 my ($name, $cb) = @_;
1126
1127 $EXTICMD{$name} = $cb;
914} 1128}
915 1129
916cf::player->attach ( 1130cf::player->attach (
917 on_command => sub { 1131 on_command => sub {
918 my ($pl, $name, $params) = @_; 1132 my ($pl, $name, $params) = @_;
927 cf::override; 1141 cf::override;
928 }, 1142 },
929 on_extcmd => sub { 1143 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1144 my ($pl, $buf) = @_;
931 1145
932 my $msg = eval { from_json $buf }; 1146 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1147
934 if (ref $msg) { 1148 if (ref $msg) {
1149 my ($type, $reply, @payload) =
1150 "ARRAY" eq ref $msg
1151 ? @$msg
1152 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1153
1154 my @reply;
1155
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1156 if (my $cb = $EXTCMD{$type}) {
936 if (my %reply = $cb->($pl, $msg)) { 1157 @reply = $cb->($pl, @payload);
937 $pl->ext_reply ($msg->{msgid}, %reply);
938 }
939 } 1158 }
1159
1160 $pl->ext_reply ($reply, @reply)
1161 if $reply;
1162
940 } else { 1163 } else {
941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1164 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942 } 1165 }
943 1166
944 cf::override; 1167 cf::override;
945 }, 1168 },
946); 1169);
947 1170
948sub load_extension {
949 my ($path) = @_;
950
951 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
952 my $base = $1;
953 my $pkg = $1;
954 $pkg =~ s/[^[:word:]]/_/g;
955 $pkg = "ext::$pkg";
956
957 warn "... loading '$path' into '$pkg'\n";
958
959 open my $fh, "<:utf8", $path
960 or die "$path: $!";
961
962 my $source =
963 "package $pkg; use strict; use utf8;\n"
964 . "#line 1 \"$path\"\n{\n"
965 . (do { local $/; <$fh> })
966 . "\n};\n1";
967
968 unless (eval $source) {
969 my $msg = $@ ? "$path: $@\n"
970 : "extension disabled.\n";
971 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
972 warn $@;
973 warn "mandatory extension failed to load, exiting.\n";
974 exit 1;
975 }
976 die $@;
977 }
978
979 push @EXTS, $pkg;
980}
981
982sub load_extensions { 1171sub load_extensions {
1172 cf::sync_job {
1173 my %todo;
1174
983 for my $ext (<$LIBDIR/*.ext>) { 1175 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1176 next unless -r $path;
985 eval { 1177
986 load_extension $ext; 1178 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1179 my $base = $1;
1180 my $pkg = $1;
1181 $pkg =~ s/[^[:word:]]/_/g;
1182 $pkg = "ext::$pkg";
1183
1184 open my $fh, "<:utf8", $path
1185 or die "$path: $!";
1186
1187 my $source = do { local $/; <$fh> };
1188
1189 my %ext = (
1190 path => $path,
1191 base => $base,
1192 pkg => $pkg,
1193 );
1194
1195 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1196 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1197
1198 $ext{source} =
1199 "package $pkg; use strict; use utf8;\n"
1200 . "#line 1 \"$path\"\n{\n"
1201 . $source
1202 . "\n};\n1";
1203
1204 $todo{$base} = \%ext;
1205 }
1206
1207 my %done;
1208 while (%todo) {
1209 my $progress;
1210
1211 while (my ($k, $v) = each %todo) {
1212 for (split /,\s*/, $v->{meta}{depends}) {
1213 goto skip
1214 unless exists $done{$_};
1215 }
1216
1217 warn "... loading '$k' into '$v->{pkg}'\n";
1218
1219 unless (eval $v->{source}) {
1220 my $msg = $@ ? "$v->{path}: $@\n"
1221 : "$v->{base}: extension inactive.\n";
1222
1223 if (exists $v->{meta}{mandatory}) {
1224 warn $msg;
1225 warn "mandatory extension failed to load, exiting.\n";
1226 exit 1;
1227 }
1228
1229 warn $msg;
1230 }
1231
1232 $done{$k} = delete $todo{$k};
1233 push @EXTS, $v->{pkg};
1234 $progress = 1;
987 1 1235 }
988 } or warn "$ext not loaded: $@"; 1236
1237 skip:
1238 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1239 unless $progress;
1240 }
989 } 1241 };
990} 1242}
991 1243
992############################################################################# 1244#############################################################################
1245
1246=back
993 1247
994=head2 CORE EXTENSIONS 1248=head2 CORE EXTENSIONS
995 1249
996Functions and methods that extend core crossfire objects. 1250Functions and methods that extend core crossfire objects.
997 1251
1068 1322
1069 aio_mkdir playerdir $pl, 0770; 1323 aio_mkdir playerdir $pl, 0770;
1070 $pl->{last_save} = $cf::RUNTIME; 1324 $pl->{last_save} = $cf::RUNTIME;
1071 1325
1072 $pl->save_pl ($path); 1326 $pl->save_pl ($path);
1073 Coro::cede; 1327 cf::cede_to_tick;
1074} 1328}
1075 1329
1076sub new($) { 1330sub new($) {
1077 my ($login) = @_; 1331 my ($login) = @_;
1078 1332
1082 $self->{deny_save} = 1; 1336 $self->{deny_save} = 1;
1083 1337
1084 $cf::PLAYER{$login} = $self; 1338 $cf::PLAYER{$login} = $self;
1085 1339
1086 $self 1340 $self
1341}
1342
1343=item $player->send_msg ($channel, $msg, $color, [extra...])
1344
1345=cut
1346
1347sub send_msg {
1348 my $ns = shift->ns
1349 or return;
1350 $ns->send_msg (@_);
1087} 1351}
1088 1352
1089=item $pl->quit_character 1353=item $pl->quit_character
1090 1354
1091Nukes the player without looking back. If logged in, the connection will 1355Nukes the player without looking back. If logged in, the connection will
1185 } 1449 }
1186 1450
1187 \@paths 1451 \@paths
1188} 1452}
1189 1453
1454=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1455
1456Expand crossfire pod fragments into protocol xml.
1457
1458=cut
1459
1460sub expand_cfpod {
1461 ((my $self), (local $_)) = @_;
1462
1463 # escape & and <
1464 s/&/&amp;/g;
1465 s/(?<![BIUGH])</&lt;/g;
1466
1467 # this is buggy, it needs to properly take care of nested <'s
1468
1469 1 while
1470 # replace B<>, I<>, U<> etc.
1471 s/B<([^\>]*)>/<b>$1<\/b>/
1472 || s/I<([^\>]*)>/<i>$1<\/i>/
1473 || s/U<([^\>]*)>/<u>$1<\/u>/
1474 # replace G<male|female> tags
1475 || s{G<([^>|]*)\|([^>]*)>}{
1476 $self->gender ? $2 : $1
1477 }ge
1478 # replace H<hint text>
1479 || s{H<([^\>]*)>}
1480 {
1481 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1482 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1483 "")
1484 [$self->{hintmode}]
1485 }ge;
1486
1487 # create single paragraphs (very hackish)
1488 s/(?<=\S)\n(?=\w)/ /g;
1489
1490 # compress some whitespace
1491 s/\s+\n/\n/g; # ws line-ends
1492 s/\n\n+/\n/g; # double lines
1493 s/^\n+//; # beginning lines
1494 s/\n+$//; # ending lines
1495
1496 $_
1497}
1498
1499sub hintmode {
1500 $_[0]{hintmode} = $_[1] if @_ > 1;
1501 $_[0]{hintmode}
1502}
1503
1190=item $player->ext_reply ($msgid, %msg) 1504=item $player->ext_reply ($msgid, @msg)
1191 1505
1192Sends an ext reply to the player. 1506Sends an ext reply to the player.
1193 1507
1194=cut 1508=cut
1195 1509
1196sub ext_reply($$%) { 1510sub ext_reply($$@) {
1197 my ($self, $id, %msg) = @_; 1511 my ($self, $id, @msg) = @_;
1198 1512
1199 $msg{msgid} = $id; 1513 $self->ns->ext_reply ($id, @msg)
1200
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1514}
1203 1515
1204=item $player->ext_event ($type, %msg) 1516=item $player->ext_msg ($type, @msg)
1205 1517
1206Sends an ext event to the client. 1518Sends an ext event to the client.
1207 1519
1208=cut 1520=cut
1209 1521
1210sub ext_event($$%) { 1522sub ext_msg($$@) {
1211 my ($self, $type, %msg) = @_; 1523 my ($self, $type, @msg) = @_;
1212 1524
1213 $self->ns->ext_event ($type, %msg); 1525 $self->ns->ext_msg ($type, @msg);
1214} 1526}
1215 1527
1216=head3 cf::region 1528=head3 cf::region
1217 1529
1218=over 4 1530=over 4
1221 1533
1222package cf::region; 1534package cf::region;
1223 1535
1224=item cf::region::find_by_path $path 1536=item cf::region::find_by_path $path
1225 1537
1226Tries to decuce the probable region for a map knowing only its path. 1538Tries to decuce the likely region for a map knowing only its path.
1227 1539
1228=cut 1540=cut
1229 1541
1230sub find_by_path($) { 1542sub find_by_path($) {
1231 my ($path) = @_; 1543 my ($path) = @_;
1232 1544
1233 my ($match, $specificity); 1545 my ($match, $specificity);
1234 1546
1235 for my $region (list) { 1547 for my $region (list) {
1236 if ($region->match && $path =~ $region->match) { 1548 if ($region->{match} && $path =~ $region->{match}) {
1237 ($match, $specificity) = ($region, $region->specificity) 1549 ($match, $specificity) = ($region, $region->specificity)
1238 if $region->specificity > $specificity; 1550 if $region->specificity > $specificity;
1239 } 1551 }
1240 } 1552 }
1241 1553
1361 $self->init; # pass $1 etc. 1673 $self->init; # pass $1 etc.
1362 return $self; 1674 return $self;
1363 } 1675 }
1364 } 1676 }
1365 1677
1366 Carp::carp "unable to resolve path '$path' (base '$base')."; 1678 Carp::cluck "unable to resolve path '$path' (base '$base').";
1367 () 1679 ()
1368} 1680}
1369 1681
1370sub init { 1682sub init {
1371 my ($self) = @_; 1683 my ($self) = @_;
1537 local $self->{deny_reset} = 1; # loading can take a long time 1849 local $self->{deny_reset} = 1; # loading can take a long time
1538 1850
1539 my $path = $self->{path}; 1851 my $path = $self->{path};
1540 1852
1541 { 1853 {
1854 my $guard1 = cf::lock_acquire "map_data:$path";
1542 my $guard = cf::lock_acquire "map_load:$path"; 1855 my $guard2 = cf::lock_acquire "map_load:$path";
1543 1856
1544 return if $self->in_memory != cf::MAP_SWAPPED; 1857 return if $self->in_memory != cf::MAP_SWAPPED;
1545 1858
1546 $self->in_memory (cf::MAP_LOADING); 1859 $self->in_memory (cf::MAP_LOADING);
1547 1860
1548 $self->alloc; 1861 $self->alloc;
1549 1862
1550 $self->pre_load; 1863 $self->pre_load;
1551 Coro::cede; 1864 cf::cede_to_tick;
1552 1865
1553 $self->_load_objects ($self->{load_path}, 1) 1866 $self->_load_objects ($self->{load_path}, 1)
1554 or return; 1867 or return;
1555 1868
1556 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1869 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1562 $self->clear_unique_items; 1875 $self->clear_unique_items;
1563 $self->_load_objects ($uniq, 0); 1876 $self->_load_objects ($uniq, 0);
1564 } 1877 }
1565 } 1878 }
1566 1879
1567 Coro::cede; 1880 cf::cede_to_tick;
1568 # now do the right thing for maps 1881 # now do the right thing for maps
1569 $self->link_multipart_objects; 1882 $self->link_multipart_objects;
1570 $self->difficulty ($self->estimate_difficulty) 1883 $self->difficulty ($self->estimate_difficulty)
1571 unless $self->difficulty; 1884 unless $self->difficulty;
1572 Coro::cede; 1885 cf::cede_to_tick;
1573 1886
1574 unless ($self->{deny_activate}) { 1887 unless ($self->{deny_activate}) {
1575 $self->decay_objects; 1888 $self->decay_objects;
1576 $self->fix_auto_apply; 1889 $self->fix_auto_apply;
1577 $self->update_buttons; 1890 $self->update_buttons;
1578 Coro::cede; 1891 cf::cede_to_tick;
1579 $self->set_darkness_map; 1892 $self->set_darkness_map;
1580 Coro::cede; 1893 cf::cede_to_tick;
1581 $self->activate; 1894 $self->activate;
1582 } 1895 }
1896
1897 $self->{last_save} = $cf::RUNTIME;
1898 $self->last_access ($cf::RUNTIME);
1583 1899
1584 $self->in_memory (cf::MAP_IN_MEMORY); 1900 $self->in_memory (cf::MAP_IN_MEMORY);
1585 } 1901 }
1586 1902
1587 $self->post_load; 1903 $self->post_load;
1598 1914
1599 $self 1915 $self
1600} 1916}
1601 1917
1602# find and load all maps in the 3x3 area around a map 1918# find and load all maps in the 3x3 area around a map
1603sub load_diag { 1919sub load_neighbours {
1604 my ($map) = @_; 1920 my ($map) = @_;
1605 1921
1606 my @diag; # diagonal neighbours 1922 my @neigh; # diagonal neighbours
1607 1923
1608 for (0 .. 3) { 1924 for (0 .. 3) {
1609 my $neigh = $map->tile_path ($_) 1925 my $neigh = $map->tile_path ($_)
1610 or next; 1926 or next;
1611 $neigh = find $neigh, $map 1927 $neigh = find $neigh, $map
1612 or next; 1928 or next;
1613 $neigh->load; 1929 $neigh->load;
1614 1930
1931 push @neigh,
1615 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1932 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1616 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1933 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1617 } 1934 }
1618 1935
1619 for (@diag) { 1936 for (grep defined $_->[0], @neigh) {
1937 my ($path, $origin) = @$_;
1620 my $neigh = find @$_ 1938 my $neigh = find $path, $origin
1621 or next; 1939 or next;
1622 $neigh->load; 1940 $neigh->load;
1623 } 1941 }
1624} 1942}
1625 1943
1630} 1948}
1631 1949
1632sub do_load_sync { 1950sub do_load_sync {
1633 my ($map) = @_; 1951 my ($map) = @_;
1634 1952
1953 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1954 if $Coro::current == $Coro::main;
1955
1635 cf::sync_job { $map->load }; 1956 cf::sync_job { $map->load };
1636} 1957}
1637 1958
1638our %MAP_PREFETCH; 1959our %MAP_PREFETCH;
1639our $MAP_PREFETCHER = undef; 1960our $MAP_PREFETCHER = undef;
1640 1961
1641sub find_async { 1962sub find_async {
1642 my ($path, $origin) = @_; 1963 my ($path, $origin, $load) = @_;
1643 1964
1644 $path = normalise $path, $origin && $origin->{path}; 1965 $path = normalise $path, $origin && $origin->{path};
1645 1966
1646 if (my $map = $cf::MAP{$path}) { 1967 if (my $map = $cf::MAP{$path}) {
1647 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1968 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1648 } 1969 }
1649 1970
1650 undef $MAP_PREFETCH{$path}; 1971 $MAP_PREFETCH{$path} |= $load;
1972
1651 $MAP_PREFETCHER ||= cf::async { 1973 $MAP_PREFETCHER ||= cf::async {
1652 while (%MAP_PREFETCH) { 1974 while (%MAP_PREFETCH) {
1653 for my $path (keys %MAP_PREFETCH) { 1975 while (my ($k, $v) = each %MAP_PREFETCH) {
1654 my $map = find $path 1976 if (my $map = find $k) {
1655 or next;
1656 $map->load; 1977 $map->load if $v;
1978 }
1657 1979
1658 delete $MAP_PREFETCH{$path}; 1980 delete $MAP_PREFETCH{$k};
1659 } 1981 }
1660 } 1982 }
1661 undef $MAP_PREFETCHER; 1983 undef $MAP_PREFETCHER;
1662 }; 1984 };
1663 $MAP_PREFETCHER->prio (6); 1985 $MAP_PREFETCHER->prio (6);
1666} 1988}
1667 1989
1668sub save { 1990sub save {
1669 my ($self) = @_; 1991 my ($self) = @_;
1670 1992
1671 my $lock = cf::lock_acquire "map_data:" . $self->path; 1993 my $lock = cf::lock_acquire "map_data:$self->{path}";
1672 1994
1673 $self->{last_save} = $cf::RUNTIME; 1995 $self->{last_save} = $cf::RUNTIME;
1674 1996
1675 return unless $self->dirty; 1997 return unless $self->dirty;
1676 1998
1699 my ($self) = @_; 2021 my ($self) = @_;
1700 2022
1701 # save first because save cedes 2023 # save first because save cedes
1702 $self->save; 2024 $self->save;
1703 2025
1704 my $lock = cf::lock_acquire "map_data:" . $self->path; 2026 my $lock = cf::lock_acquire "map_data:$self->{path}";
1705 2027
1706 return if $self->players; 2028 return if $self->players;
1707 return if $self->in_memory != cf::MAP_IN_MEMORY; 2029 return if $self->in_memory != cf::MAP_IN_MEMORY;
1708 return if $self->{deny_save}; 2030 return if $self->{deny_save};
1709 2031
1776 $cf::MAP{$self->path} = $self; 2098 $cf::MAP{$self->path} = $self;
1777 2099
1778 $self->reset; # polite request, might not happen 2100 $self->reset; # polite request, might not happen
1779} 2101}
1780 2102
2103=item $maps = cf::map::tmp_maps
2104
2105Returns an arrayref with all map paths of currently instantiated and saved
2106maps. May block.
2107
2108=cut
2109
2110sub tmp_maps() {
2111 [
2112 map {
2113 utf8::decode $_;
2114 /\.map$/
2115 ? normalise $_
2116 : ()
2117 } @{ aio_readdir $TMPDIR or [] }
2118 ]
2119}
2120
2121=item $maps = cf::map::random_maps
2122
2123Returns an arrayref with all map paths of currently instantiated and saved
2124random maps. May block.
2125
2126=cut
2127
2128sub random_maps() {
2129 [
2130 map {
2131 utf8::decode $_;
2132 /\.map$/
2133 ? normalise "?random/$_"
2134 : ()
2135 } @{ aio_readdir $RANDOMDIR or [] }
2136 ]
2137}
2138
1781=item cf::map::unique_maps 2139=item cf::map::unique_maps
1782 2140
1783Returns an arrayref of paths of all shared maps that have 2141Returns an arrayref of paths of all shared maps that have
1784instantiated unique items. May block. 2142instantiated unique items. May block.
1785 2143
1786=cut 2144=cut
1787 2145
1788sub unique_maps() { 2146sub unique_maps() {
1789 my $files = aio_readdir $UNIQUEDIR 2147 [
1790 or return; 2148 map {
1791
1792 my @paths;
1793
1794 for (@$files) {
1795 utf8::decode $_; 2149 utf8::decode $_;
1796 next if /\.pst$/; 2150 /\.map$/
1797 next unless /^$PATH_SEP/o; 2151 ? normalise $_
1798 2152 : ()
1799 push @paths, cf::map::normalise $_; 2153 } @{ aio_readdir $UNIQUEDIR or [] }
1800 } 2154 ]
1801
1802 \@paths
1803} 2155}
1804 2156
1805package cf; 2157package cf;
1806 2158
1807=back 2159=back
1853 2205
1854 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2206 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1855 2207
1856 if ($self->{record_replies}) { 2208 if ($self->{record_replies}) {
1857 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2209 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2210
1858 } else { 2211 } else {
2212 my $pl = $self->contr;
2213
2214 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2215 my $dialog = $pl->{npc_dialog};
2216 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2217
2218 } else {
1859 $msg = $npc->name . " says: $msg" if $npc; 2219 $msg = $npc->name . " says: $msg" if $npc;
1860 $self->message ($msg, $flags); 2220 $self->message ($msg, $flags);
2221 }
1861 } 2222 }
2223}
2224
2225=item $object->send_msg ($channel, $msg, $color, [extra...])
2226
2227=cut
2228
2229sub cf::object::send_msg {
2230 my $pl = shift->contr
2231 or return;
2232 $pl->send_msg (@_);
1862} 2233}
1863 2234
1864=item $player_object->may ("access") 2235=item $player_object->may ("access")
1865 2236
1866Returns wether the given player is authorized to access resource "access" 2237Returns wether the given player is authorized to access resource "access"
1945 # use -1 or undef as default coordinates, not 0, 0 2316 # use -1 or undef as default coordinates, not 0, 0
1946 ($x, $y) = ($map->enter_x, $map->enter_y) 2317 ($x, $y) = ($map->enter_x, $map->enter_y)
1947 if $x <=0 && $y <= 0; 2318 if $x <=0 && $y <= 0;
1948 2319
1949 $map->load; 2320 $map->load;
1950 $map->load_diag; 2321 $map->load_neighbours;
1951 2322
1952 return unless $self->contr->active; 2323 return unless $self->contr->active;
1953 $self->activate_recursive; 2324 $self->activate_recursive;
1954 2325
1955 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2326 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1956 $self->enter_map ($map, $x, $y); 2327 $self->enter_map ($map, $x, $y);
1957} 2328}
1958 2329
1959=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2330=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1960 2331
1961Moves the player to the given map-path and coordinates by first freezing 2332Moves the player to the given map-path and coordinates by first freezing
1962her, loading and preparing them map, calling the provided $check callback 2333her, loading and preparing them map, calling the provided $check callback
1963that has to return the map if sucecssful, and then unfreezes the player on 2334that has to return the map if sucecssful, and then unfreezes the player on
1964the new (success) or old (failed) map position. 2335the new (success) or old (failed) map position. In either case, $done will
2336be called at the end of this process.
1965 2337
1966=cut 2338=cut
1967 2339
1968our $GOTOGEN; 2340our $GOTOGEN;
1969 2341
1970sub cf::object::player::goto { 2342sub cf::object::player::goto {
1971 my ($self, $path, $x, $y, $check) = @_; 2343 my ($self, $path, $x, $y, $check, $done) = @_;
1972 2344
1973 # do generation counting so two concurrent goto's will be executed in-order 2345 # do generation counting so two concurrent goto's will be executed in-order
1974 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2346 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1975 2347
1976 $self->enter_link; 2348 $self->enter_link;
1996 2368
1997 if ($gen == $self->{_goto_generation}) { 2369 if ($gen == $self->{_goto_generation}) {
1998 delete $self->{_goto_generation}; 2370 delete $self->{_goto_generation};
1999 $self->leave_link ($map, $x, $y); 2371 $self->leave_link ($map, $x, $y);
2000 } 2372 }
2373
2374 $done->() if $done;
2001 })->prio (1); 2375 })->prio (1);
2002} 2376}
2003 2377
2004=item $player_object->enter_exit ($exit_object) 2378=item $player_object->enter_exit ($exit_object)
2005 2379
2074 my $hp = $exit->stats->hp; 2448 my $hp = $exit->stats->hp;
2075 my $sp = $exit->stats->sp; 2449 my $sp = $exit->stats->sp;
2076 2450
2077 $self->enter_link; 2451 $self->enter_link;
2078 2452
2453 # if exit is damned, update players death & WoR home-position
2454 $self->contr->savebed ($slaying, $hp, $sp)
2455 if $exit->flag (FLAG_DAMNED);
2456
2079 (async { 2457 (async {
2080 $self->deactivate_recursive; # just to be sure 2458 $self->deactivate_recursive; # just to be sure
2081 unless (eval { 2459 unless (eval {
2082 $self->goto ($slaying, $hp, $sp); 2460 $self->goto ($slaying, $hp, $sp);
2083 2461
2110 2488
2111 utf8::encode $text; 2489 utf8::encode $text;
2112 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2490 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2113} 2491}
2114 2492
2493=item $client->send_msg ($channel, $msg, $color, [extra...])
2494
2495Send a drawinfo or msg packet to the client, formatting the msg for the
2496client if neccessary. C<$type> should be a string identifying the type of
2497the message, with C<log> being the default. If C<$color> is negative, suppress
2498the message unless the client supports the msg packet.
2499
2500=cut
2501
2502sub cf::client::send_msg {
2503 my ($self, $channel, $msg, $color, @extra) = @_;
2504
2505 $msg = $self->pl->expand_cfpod ($msg);
2506
2507 $color &= cf::NDI_CLIENT_MASK; # just in case...
2508
2509 if (ref $channel) {
2510 # send meta info to client, if not yet sent
2511 unless (exists $self->{channel}{$channel->{id}}) {
2512 $self->{channel}{$channel->{id}} = $channel;
2513 $self->ext_msg (channel_info => $channel);
2514 }
2515
2516 $channel = $channel->{id};
2517 }
2518
2519 return unless @extra || length $msg;
2520
2521 if ($self->can_msg) {
2522 # default colour, mask it out
2523 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2524 if $color & cf::NDI_DEF;
2525
2526 $self->send_packet ("msg " . $self->{json_coder}->encode (
2527 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2528 } else {
2529 if ($color >= 0) {
2530 # replace some tags by gcfclient-compatible ones
2531 for ($msg) {
2532 1 while
2533 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2534 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2535 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2536 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2537 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2538 }
2539
2540 $color &= cf::NDI_COLOR_MASK;
2541
2542 utf8::encode $msg;
2543
2544 if (0 && $msg =~ /\[/) {
2545 # COMMAND/INFO
2546 $self->send_packet ("drawextinfo $color 10 8 $msg")
2547 } else {
2548 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2549 $self->send_packet ("drawinfo $color $msg")
2550 }
2551 }
2552 }
2553}
2554
2115=item $client->ext_event ($type, %msg) 2555=item $client->ext_msg ($type, @msg)
2116 2556
2117Sends an exti event to the client. 2557Sends an ext event to the client.
2118 2558
2119=cut 2559=cut
2120 2560
2121sub cf::client::ext_event($$%) { 2561sub cf::client::ext_msg($$@) {
2122 my ($self, $type, %msg) = @_; 2562 my ($self, $type, @msg) = @_;
2123 2563
2564 if ($self->extcmd == 2) {
2565 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2566 } elsif ($self->extcmd == 1) { # TODO: remove
2124 $msg{msgtype} = "event_$type"; 2567 push @msg, msgtype => "event_$type";
2125 $self->send_packet ("ext " . cf::to_json \%msg); 2568 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2569 }
2570}
2571
2572=item $client->ext_reply ($msgid, @msg)
2573
2574Sends an ext reply to the client.
2575
2576=cut
2577
2578sub cf::client::ext_reply($$@) {
2579 my ($self, $id, @msg) = @_;
2580
2581 if ($self->extcmd == 2) {
2582 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2583 } elsif ($self->extcmd == 1) {
2584 #TODO: version 1, remove
2585 unshift @msg, msgtype => "reply", msgid => $id;
2586 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2587 }
2126} 2588}
2127 2589
2128=item $success = $client->query ($flags, "text", \&cb) 2590=item $success = $client->query ($flags, "text", \&cb)
2129 2591
2130Queues a query to the client, calling the given callback with 2592Queues a query to the client, calling the given callback with
2131the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2593the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2132C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2594C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2133 2595
2134Queries can fail, so check the return code. Or don't, as queries will become 2596Queries can fail, so check the return code. Or don't, as queries will
2135reliable at some point in the future. 2597become reliable at some point in the future.
2136 2598
2137=cut 2599=cut
2138 2600
2139sub cf::client::query { 2601sub cf::client::query {
2140 my ($self, $flags, $text, $cb) = @_; 2602 my ($self, $flags, $text, $cb) = @_;
2148 utf8::encode $text; 2610 utf8::encode $text;
2149 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2611 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2150 2612
2151 $self->send_packet ($self->{query_queue}[0][0]) 2613 $self->send_packet ($self->{query_queue}[0][0])
2152 if @{ $self->{query_queue} } == 1; 2614 if @{ $self->{query_queue} } == 1;
2615
2616 1
2153} 2617}
2154 2618
2155cf::client->attach ( 2619cf::client->attach (
2620 on_connect => sub {
2621 my ($ns) = @_;
2622
2623 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2624 },
2156 on_reply => sub { 2625 on_reply => sub {
2157 my ($ns, $msg) = @_; 2626 my ($ns, $msg) = @_;
2158 2627
2159 # this weird shuffling is so that direct followup queries 2628 # this weird shuffling is so that direct followup queries
2160 # get handled first 2629 # get handled first
2172 } else { 2641 } else {
2173 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2642 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2174 } 2643 }
2175 } 2644 }
2176 }, 2645 },
2646 on_exticmd => sub {
2647 my ($ns, $buf) = @_;
2648
2649 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2650
2651 if (ref $msg) {
2652 my ($type, $reply, @payload) =
2653 "ARRAY" eq ref $msg
2654 ? @$msg
2655 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2656
2657 my @reply;
2658
2659 if (my $cb = $EXTICMD{$type}) {
2660 @reply = $cb->($ns, @payload);
2661 }
2662
2663 $ns->ext_reply ($reply, @reply)
2664 if $reply;
2665
2666 } else {
2667 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2668 }
2669
2670 cf::override;
2671 },
2177); 2672);
2178 2673
2179=item $client->async (\&cb) 2674=item $client->async (\&cb)
2180 2675
2181Create a new coroutine, running the specified callback. The coroutine will 2676Create a new coroutine, running the specified callback. The coroutine will
2222our $safe = new Safe "safe"; 2717our $safe = new Safe "safe";
2223our $safe_hole = new Safe::Hole; 2718our $safe_hole = new Safe::Hole;
2224 2719
2225$SIG{FPE} = 'IGNORE'; 2720$SIG{FPE} = 'IGNORE';
2226 2721
2227$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2722$safe->permit_only (Opcode::opset qw(
2723 :base_core :base_mem :base_orig :base_math
2724 grepstart grepwhile mapstart mapwhile
2725 sort time
2726));
2228 2727
2229# here we export the classes and methods available to script code 2728# here we export the classes and methods available to script code
2230 2729
2231=pod 2730=pod
2232 2731
2233The following functions and methods are available within a safe environment: 2732The following functions and methods are available within a safe environment:
2234 2733
2235 cf::object contr pay_amount pay_player map 2734 cf::object
2735 contr pay_amount pay_player map x y force_find force_add
2736 insert remove name archname title slaying race decrease_ob_nr
2737
2236 cf::object::player player 2738 cf::object::player
2237 cf::player peaceful 2739 player
2238 cf::map trigger 2740
2741 cf::player
2742 peaceful
2743
2744 cf::map
2745 trigger
2239 2746
2240=cut 2747=cut
2241 2748
2242for ( 2749for (
2243 ["cf::object" => qw(contr pay_amount pay_player map)], 2750 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2751 insert remove inv name archname title slaying race
2752 decrease_ob_nr)],
2244 ["cf::object::player" => qw(player)], 2753 ["cf::object::player" => qw(player)],
2245 ["cf::player" => qw(peaceful)], 2754 ["cf::player" => qw(peaceful)],
2246 ["cf::map" => qw(trigger)], 2755 ["cf::map" => qw(trigger)],
2247) { 2756) {
2248 no strict 'refs'; 2757 no strict 'refs';
2319=back 2828=back
2320 2829
2321=cut 2830=cut
2322 2831
2323############################################################################# 2832#############################################################################
2324
2325=head2 EXTENSION DATABASE SUPPORT
2326
2327Crossfire maintains a very simple database for extension use. It can
2328currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2329convert to/from binary).
2330
2331The parameter C<$family> should best start with the name of the extension
2332using it, it should be unique.
2333
2334=over 4
2335
2336=item $value = cf::db_get $family => $key
2337
2338Returns a single value from the database.
2339
2340=item cf::db_put $family => $key => $value
2341
2342Stores the given C<$value> in the family.
2343
2344=cut
2345
2346our $DB;
2347
2348sub db_init {
2349 unless ($DB) {
2350 $DB = BDB::db_create $DB_ENV;
2351
2352 cf::sync_job {
2353 eval {
2354 $DB->set_flags (BDB::CHKSUM);
2355
2356 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2357 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2358 cf::cleanup "db_open(db): $!" if $!;
2359 };
2360 cf::cleanup "db_open(db): $@" if $@;
2361 };
2362 }
2363}
2364
2365sub db_get($$) {
2366 my $key = "$_[0]/$_[1]";
2367
2368 cf::sync_job {
2369 BDB::db_get $DB, undef, $key, my $data;
2370
2371 $! ? ()
2372 : $data
2373 }
2374}
2375
2376sub db_put($$$) {
2377 BDB::dbreq_pri 4;
2378 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2379}
2380
2381=item cf::cache $id => [$paths...], $processversion => $process
2382
2383Generic caching function that returns the value of the resource $id,
2384caching and regenerating as required.
2385
2386This function can block.
2387
2388=cut
2389
2390sub cache {
2391 my ($id, $src, $processversion, $process) = @_;
2392
2393 my $meta =
2394 join "\x00",
2395 $processversion,
2396 map {
2397 aio_stat $_
2398 and Carp::croak "$_: $!";
2399
2400 ($_, (stat _)[7,9])
2401 } @$src;
2402
2403 my $dbmeta = db_get cache => "$id/meta";
2404 if ($dbmeta ne $meta) {
2405 # changed, we may need to process
2406
2407 my @data;
2408 my $md5;
2409
2410 for (0 .. $#$src) {
2411 0 <= aio_load $src->[$_], $data[$_]
2412 or Carp::croak "$src->[$_]: $!";
2413 }
2414
2415 # if processing is expensive, check
2416 # checksum first
2417 if (1) {
2418 $md5 =
2419 join "\x00",
2420 $processversion,
2421 map {
2422 Coro::cede;
2423 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2424 } 0.. $#$src;
2425
2426
2427 my $dbmd5 = db_get cache => "$id/md5";
2428 if ($dbmd5 eq $md5) {
2429 db_put cache => "$id/meta", $meta;
2430
2431 return db_get cache => "$id/data";
2432 }
2433 }
2434
2435 my $t1 = Time::HiRes::time;
2436 my $data = $process->(\@data);
2437 my $t2 = Time::HiRes::time;
2438
2439 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2440
2441 db_put cache => "$id/data", $data;
2442 db_put cache => "$id/md5" , $md5;
2443 db_put cache => "$id/meta", $meta;
2444
2445 return $data;
2446 }
2447
2448 db_get cache => "$id/data"
2449}
2450
2451=item fork_call { }, $args
2452
2453Executes the given code block with the given arguments in a seperate
2454process, returning the results. Everything must be serialisable with
2455Coro::Storable. May, of course, block. Note that the executed sub may
2456never block itself or use any form of Event handling.
2457
2458=cut
2459
2460sub fork_call(&@) {
2461 my ($cb, @args) = @_;
2462
2463# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2464# or die "socketpair: $!";
2465 pipe my $fh1, my $fh2
2466 or die "pipe: $!";
2467
2468 if (my $pid = fork) {
2469 close $fh2;
2470
2471 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2472 $res = Coro::Storable::thaw $res;
2473
2474 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2475
2476 die $$res unless "ARRAY" eq ref $res;
2477
2478 return wantarray ? @$res : $res->[-1];
2479 } else {
2480 reset_signals;
2481 local $SIG{__WARN__};
2482 local $SIG{__DIE__};
2483 eval {
2484 close $fh1;
2485
2486 my @res = eval { $cb->(@args) };
2487 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2488 };
2489
2490 warn $@ if $@;
2491 _exit 0;
2492 }
2493}
2494
2495#############################################################################
2496# the server's init and main functions 2833# the server's init and main functions
2497 2834
2498sub load_facedata($) { 2835sub load_facedata($) {
2499 my ($path) = @_; 2836 my ($path) = @_;
2837
2838 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2500 2839
2501 warn "loading facedata from $path\n"; 2840 warn "loading facedata from $path\n";
2502 2841
2503 my $facedata; 2842 my $facedata;
2504 0 < aio_load $path, $facedata 2843 0 < aio_load $path, $facedata
2507 $facedata = Coro::Storable::thaw $facedata; 2846 $facedata = Coro::Storable::thaw $facedata;
2508 2847
2509 $facedata->{version} == 2 2848 $facedata->{version} == 2
2510 or cf::cleanup "$path: version mismatch, cannot proceed."; 2849 or cf::cleanup "$path: version mismatch, cannot proceed.";
2511 2850
2851 # patch in the exptable
2852 $facedata->{resource}{"res/exp_table"} = {
2853 type => FT_RSRC,
2854 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2855 };
2856 cf::cede_to_tick;
2857
2512 { 2858 {
2513 my $faces = $facedata->{faceinfo}; 2859 my $faces = $facedata->{faceinfo};
2514 2860
2515 while (my ($face, $info) = each %$faces) { 2861 while (my ($face, $info) = each %$faces) {
2516 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2862 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2517 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2863 cf::face::set_visibility $idx, $info->{visibility};
2864 cf::face::set_magicmap $idx, $info->{magicmap};
2518 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2865 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2519 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2866 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2520 Coro::cede; 2867
2868 cf::cede_to_tick;
2521 } 2869 }
2522 2870
2523 while (my ($face, $info) = each %$faces) { 2871 while (my ($face, $info) = each %$faces) {
2524 next unless $info->{smooth}; 2872 next unless $info->{smooth};
2525 my $idx = cf::face::find $face 2873 my $idx = cf::face::find $face
2526 or next; 2874 or next;
2527 if (my $smooth = cf::face::find $info->{smooth}) { 2875 if (my $smooth = cf::face::find $info->{smooth}) {
2876 cf::face::set_smooth $idx, $smooth;
2528 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2877 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2529 } else { 2878 } else {
2530 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2879 warn "smooth face '$info->{smooth}' not found for face '$face'";
2531 } 2880 }
2532 Coro::cede; 2881
2882 cf::cede_to_tick;
2533 } 2883 }
2534 } 2884 }
2535 2885
2536 { 2886 {
2537 my $anims = $facedata->{animinfo}; 2887 my $anims = $facedata->{animinfo};
2538 2888
2539 while (my ($anim, $info) = each %$anims) { 2889 while (my ($anim, $info) = each %$anims) {
2540 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2890 cf::anim::set $anim, $info->{frames}, $info->{facings};
2541 Coro::cede; 2891 cf::cede_to_tick;
2542 } 2892 }
2543 2893
2544 cf::anim::invalidate_all; # d'oh 2894 cf::anim::invalidate_all; # d'oh
2545 } 2895 }
2546 2896
2897 {
2898 # TODO: for gcfclient pleasure, we should give resources
2899 # that gcfclient doesn't grok a >10000 face index.
2900 my $res = $facedata->{resource};
2901
2902 my $soundconf = delete $res->{"res/sound.conf"};
2903
2904 while (my ($name, $info) = each %$res) {
2905 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2906 my $data;
2907
2908 if ($info->{type} & 1) {
2909 # prepend meta info
2910
2911 my $meta = $enc->encode ({
2912 name => $name,
2913 %{ $info->{meta} || {} },
2914 });
2915
2916 $data = pack "(w/a*)*", $meta, $info->{data};
2917 } else {
2918 $data = $info->{data};
2919 }
2920
2921 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2922 cf::face::set_type $idx, $info->{type};
2923
2924 cf::cede_to_tick;
2925 }
2926
2927 if ($soundconf) {
2928 $soundconf = $enc->decode (delete $soundconf->{data});
2929
2930 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2931 my $sound = $soundconf->{compat}[$_]
2932 or next;
2933
2934 my $face = cf::face::find "sound/$sound->[1]";
2935 cf::sound::set $sound->[0] => $face;
2936 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2937 }
2938
2939 while (my ($k, $v) = each %{$soundconf->{event}}) {
2940 my $face = cf::face::find "sound/$v";
2941 cf::sound::set $k => $face;
2942 }
2943 }
2944 }
2945
2547 1 2946 1
2548} 2947}
2948
2949register_exticmd fx_want => sub {
2950 my ($ns, $want) = @_;
2951
2952 while (my ($k, $v) = each %$want) {
2953 $ns->fx_want ($k, $v);
2954 }
2955};
2549 2956
2550sub reload_regions { 2957sub reload_regions {
2551 load_resource_file "$MAPDIR/regions" 2958 load_resource_file "$MAPDIR/regions"
2552 or die "unable to load regions file\n"; 2959 or die "unable to load regions file\n";
2960
2961 for (cf::region::list) {
2962 $_->{match} = qr/$_->{match}/
2963 if exists $_->{match};
2964 }
2553} 2965}
2554 2966
2555sub reload_facedata { 2967sub reload_facedata {
2556 load_facedata "$DATADIR/facedata" 2968 load_facedata "$DATADIR/facedata"
2557 or die "unable to load facedata\n"; 2969 or die "unable to load facedata\n";
2558} 2970}
2559 2971
2560sub reload_archetypes { 2972sub reload_archetypes {
2973 load_resource_file "$DATADIR/archetypes"
2974 or die "unable to load archetypes\n";
2975 #d# NEED to laod twice to resolve forward references
2976 # this really needs to be done in an extra post-pass
2977 # (which needs to be synchronous, so solve it differently)
2561 load_resource_file "$DATADIR/archetypes" 2978 load_resource_file "$DATADIR/archetypes"
2562 or die "unable to load archetypes\n"; 2979 or die "unable to load archetypes\n";
2563} 2980}
2564 2981
2565sub reload_treasures { 2982sub reload_treasures {
2581 2998
2582sub init { 2999sub init {
2583 reload_resources; 3000 reload_resources;
2584} 3001}
2585 3002
2586sub cfg_load { 3003sub reload_config {
2587 open my $fh, "<:utf8", "$CONFDIR/config" 3004 open my $fh, "<:utf8", "$CONFDIR/config"
2588 or return; 3005 or return;
2589 3006
2590 local $/; 3007 local $/;
2591 *CFG = YAML::Syck::Load <$fh>; 3008 *CFG = YAML::Syck::Load <$fh>;
2611 (async { 3028 (async {
2612 Event::one_event; 3029 Event::one_event;
2613 })->prio (Coro::PRIO_MAX); 3030 })->prio (Coro::PRIO_MAX);
2614 }; 3031 };
2615 3032
2616 cfg_load; 3033 reload_config;
2617 db_init; 3034 db_init;
2618 load_extensions; 3035 load_extensions;
2619 3036
2620 $TICK_WATCHER->start; 3037 $TICK_WATCHER->start;
2621 Event::loop; 3038 Event::loop;
2637 }, 3054 },
2638 ); 3055 );
2639 } 3056 }
2640} 3057}
2641 3058
3059sub write_runtime {
3060 my $runtime = "$LOCALDIR/runtime";
3061
3062 # first touch the runtime file to show we are still running:
3063 # the fsync below can take a very very long time.
3064
3065 IO::AIO::aio_utime $runtime, undef, undef;
3066
3067 my $guard = cf::lock_acquire "write_runtime";
3068
3069 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3070 or return;
3071
3072 my $value = $cf::RUNTIME + 90 + 10;
3073 # 10 is the runtime save interval, for a monotonic clock
3074 # 60 allows for the watchdog to kill the server.
3075
3076 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3077 and return;
3078
3079 # always fsync - this file is important
3080 aio_fsync $fh
3081 and return;
3082
3083 # touch it again to show we are up-to-date
3084 aio_utime $fh, undef, undef;
3085
3086 close $fh
3087 or return;
3088
3089 aio_rename "$runtime~", $runtime
3090 and return;
3091
3092 warn "runtime file written.\n";
3093
3094 1
3095}
3096
2642sub emergency_save() { 3097sub emergency_save() {
2643 my $freeze_guard = cf::freeze_mainloop; 3098 my $freeze_guard = cf::freeze_mainloop;
2644 3099
2645 warn "enter emergency perl save\n"; 3100 warn "enter emergency perl save\n";
2646 3101
2721 %EXT_CORO = (); 3176 %EXT_CORO = ();
2722 3177
2723 warn "removing commands"; 3178 warn "removing commands";
2724 %COMMAND = (); 3179 %COMMAND = ();
2725 3180
2726 warn "removing ext commands"; 3181 warn "removing ext/exti commands";
2727 %EXTCMD = (); 3182 %EXTCMD = ();
3183 %EXTICMD = ();
2728 3184
2729 warn "unloading/nuking all extensions"; 3185 warn "unloading/nuking all extensions";
2730 for my $pkg (@EXTS) { 3186 for my $pkg (@EXTS) {
2731 warn "... unloading $pkg"; 3187 warn "... unloading $pkg";
2732 3188
2775 warn "reloading cf.pm"; 3231 warn "reloading cf.pm";
2776 require cf; 3232 require cf;
2777 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3233 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2778 3234
2779 warn "loading config and database again"; 3235 warn "loading config and database again";
2780 cf::cfg_load; 3236 cf::reload_config;
2781 3237
2782 warn "loading extensions"; 3238 warn "loading extensions";
2783 cf::load_extensions; 3239 cf::load_extensions;
2784 3240
2785 warn "reattaching attachments to objects/players"; 3241 warn "reattaching attachments to objects/players";

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines