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.273 by root, Mon Jun 4 12:19:08 2007 UTC vs.
Revision 1.332 by root, Sat Aug 18 17:33:53 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 1.4 ();
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";#d# 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 Coro::cede;
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
873 or return; 1060 or return;
874 $av = eval { (Storable::thaw $av)->{objs} }; 1061 $av = eval { (Storable::thaw $av)->{objs} };
875 } 1062 }
876 1063
877 warn sprintf "loading %s (%d)\n", 1064 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []};#d# 1065 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1066 return ($data, $av);
880} 1067}
1068
1069=head2 COMMAND CALLBACKS
1070
1071=over 4
1072
1073=cut
881 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);
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
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1154 if (my $cb = $EXTCMD{$type}) {
936 if (my %reply = $cb->($pl, $msg)) { 1155 my @reply = $cb->($pl, @payload);
1156
937 $pl->ext_reply ($msg->{msgid}, %reply); 1157 $pl->ext_reply ($reply, @reply)
938 } 1158 if $reply;
939 } 1159 }
940 } else { 1160 } else {
941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1161 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942 } 1162 }
943 1163
944 cf::override; 1164 cf::override;
945 }, 1165 },
946); 1166);
947 1167
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 { 1168sub load_extensions {
1169 cf::sync_job {
1170 my %todo;
1171
983 for my $ext (<$LIBDIR/*.ext>) { 1172 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1173 next unless -r $path;
985 eval { 1174
986 load_extension $ext; 1175 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1176 my $base = $1;
1177 my $pkg = $1;
1178 $pkg =~ s/[^[:word:]]/_/g;
1179 $pkg = "ext::$pkg";
1180
1181 open my $fh, "<:utf8", $path
1182 or die "$path: $!";
1183
1184 my $source = do { local $/; <$fh> };
1185
1186 my %ext = (
1187 path => $path,
1188 base => $base,
1189 pkg => $pkg,
1190 );
1191
1192 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1193 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1194
1195 $ext{source} =
1196 "package $pkg; use strict; use utf8;\n"
1197 . "#line 1 \"$path\"\n{\n"
1198 . $source
1199 . "\n};\n1";
1200
1201 $todo{$base} = \%ext;
1202 }
1203
1204 my %done;
1205 while (%todo) {
1206 my $progress;
1207
1208 while (my ($k, $v) = each %todo) {
1209 for (split /,\s*/, $v->{meta}{depends}) {
1210 goto skip
1211 unless exists $done{$_};
1212 }
1213
1214 warn "... loading '$k' into '$v->{pkg}'\n";
1215
1216 unless (eval $v->{source}) {
1217 my $msg = $@ ? "$v->{path}: $@\n"
1218 : "$v->{base}: extension inactive.\n";
1219
1220 if (exists $v->{meta}{mandatory}) {
1221 warn $msg;
1222 warn "mandatory extension failed to load, exiting.\n";
1223 exit 1;
1224 }
1225
1226 warn $msg;
1227 }
1228
1229 $done{$k} = delete $todo{$k};
1230 push @EXTS, $v->{pkg};
1231 $progress = 1;
987 1 1232 }
988 } or warn "$ext not loaded: $@"; 1233
1234 skip:
1235 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1236 unless $progress;
1237 }
989 } 1238 };
990} 1239}
991 1240
992############################################################################# 1241#############################################################################
1242
1243=back
993 1244
994=head2 CORE EXTENSIONS 1245=head2 CORE EXTENSIONS
995 1246
996Functions and methods that extend core crossfire objects. 1247Functions and methods that extend core crossfire objects.
997 1248
1084 $cf::PLAYER{$login} = $self; 1335 $cf::PLAYER{$login} = $self;
1085 1336
1086 $self 1337 $self
1087} 1338}
1088 1339
1340=item $player->send_msg ($channel, $msg, $color, [extra...])
1341
1342=cut
1343
1344sub send_msg {
1345 my $ns = shift->ns
1346 or return;
1347 $ns->send_msg (@_);
1348}
1349
1089=item $pl->quit_character 1350=item $pl->quit_character
1090 1351
1091Nukes the player without looking back. If logged in, the connection will 1352Nukes the player without looking back. If logged in, the connection will
1092be destroyed. May block for a long time. 1353be destroyed. May block for a long time.
1093 1354
1185 } 1446 }
1186 1447
1187 \@paths 1448 \@paths
1188} 1449}
1189 1450
1451=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1452
1453Expand crossfire pod fragments into protocol xml.
1454
1455=cut
1456
1457sub expand_cfpod {
1458 ((my $self), (local $_)) = @_;
1459
1460 # escape & and <
1461 s/&/&amp;/g;
1462 s/(?<![BIUGH])</&lt;/g;
1463
1464 # this is buggy, it needs to properly take care of nested <'s
1465
1466 1 while
1467 # replace B<>, I<>, U<> etc.
1468 s/B<([^\>]*)>/<b>$1<\/b>/
1469 || s/I<([^\>]*)>/<i>$1<\/i>/
1470 || s/U<([^\>]*)>/<u>$1<\/u>/
1471 # replace G<male|female> tags
1472 || s{G<([^>|]*)\|([^>]*)>}{
1473 $self->gender ? $2 : $1
1474 }ge
1475 # replace H<hint text>
1476 || s{H<([^\>]*)>}
1477 {
1478 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1479 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1480 "")
1481 [$self->{hintmode}]
1482 }ge;
1483
1484 # create single paragraphs (very hackish)
1485 s/(?<=\S)\n(?=\w)/ /g;
1486
1487 # compress some whitespace
1488 s/\s+\n/\n/g; # ws line-ends
1489 s/\n\n+/\n/g; # double lines
1490 s/^\n+//; # beginning lines
1491 s/\n+$//; # ending lines
1492
1493 $_
1494}
1495
1496sub hintmode {
1497 $_[0]{hintmode} = $_[1] if @_ > 1;
1498 $_[0]{hintmode}
1499}
1500
1190=item $player->ext_reply ($msgid, %msg) 1501=item $player->ext_reply ($msgid, @msg)
1191 1502
1192Sends an ext reply to the player. 1503Sends an ext reply to the player.
1193 1504
1194=cut 1505=cut
1195 1506
1196sub ext_reply($$%) { 1507sub ext_reply($$@) {
1197 my ($self, $id, %msg) = @_; 1508 my ($self, $id, @msg) = @_;
1198 1509
1199 $msg{msgid} = $id; 1510 if ($self->ns->extcmd == 2) {
1200 1511 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1201 $self->send ("ext " . cf::to_json \%msg); 1512 } elsif ($self->ns->extcmd == 1) {
1513 #TODO: version 1, remove
1514 unshift @msg, msgtype => "reply", msgid => $id;
1515 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1516 }
1202} 1517}
1203 1518
1204=item $player->ext_event ($type, %msg) 1519=item $player->ext_msg ($type, @msg)
1205 1520
1206Sends an ext event to the client. 1521Sends an ext event to the client.
1207 1522
1208=cut 1523=cut
1209 1524
1210sub ext_event($$%) { 1525sub ext_msg($$@) {
1211 my ($self, $type, %msg) = @_; 1526 my ($self, $type, @msg) = @_;
1212 1527
1213 $self->ns->ext_event ($type, %msg); 1528 $self->ns->ext_msg ($type, @msg);
1214} 1529}
1215 1530
1216=head3 cf::region 1531=head3 cf::region
1217 1532
1218=over 4 1533=over 4
1221 1536
1222package cf::region; 1537package cf::region;
1223 1538
1224=item cf::region::find_by_path $path 1539=item cf::region::find_by_path $path
1225 1540
1226Tries to decuce the probable region for a map knowing only its path. 1541Tries to decuce the likely region for a map knowing only its path.
1227 1542
1228=cut 1543=cut
1229 1544
1230sub find_by_path($) { 1545sub find_by_path($) {
1231 my ($path) = @_; 1546 my ($path) = @_;
1232 1547
1233 my ($match, $specificity); 1548 my ($match, $specificity);
1234 1549
1235 for my $region (list) { 1550 for my $region (list) {
1236 if ($region->match && $path =~ $region->match) { 1551 if ($region->{match} && $path =~ $region->{match}) {
1237 ($match, $specificity) = ($region, $region->specificity) 1552 ($match, $specificity) = ($region, $region->specificity)
1238 if $region->specificity > $specificity; 1553 if $region->specificity > $specificity;
1239 } 1554 }
1240 } 1555 }
1241 1556
1305 my ($self, $merge) = @_; 1620 my ($self, $merge) = @_;
1306 1621
1307 # we have to keep some variables in memory intact 1622 # we have to keep some variables in memory intact
1308 local $self->{path}; 1623 local $self->{path};
1309 local $self->{load_path}; 1624 local $self->{load_path};
1310 local $self->{deny_save};
1311 local $self->{deny_reset};
1312 1625
1313 $self->SUPER::thawer_merge ($merge); 1626 $self->SUPER::thawer_merge ($merge);
1314} 1627}
1315 1628
1316sub normalise { 1629sub normalise {
1363 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1364 return $self; 1677 return $self;
1365 } 1678 }
1366 } 1679 }
1367 1680
1368 Carp::carp "unable to resolve path '$path' (base '$base')."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1369 () 1682 ()
1370} 1683}
1371 1684
1372sub init { 1685sub init {
1373 my ($self) = @_; 1686 my ($self) = @_;
1414sub change_all_map_light { 1727sub change_all_map_light {
1415 my ($change) = @_; 1728 my ($change) = @_;
1416 1729
1417 $_->change_map_light ($change) 1730 $_->change_map_light ($change)
1418 for grep $_->outdoor, values %cf::MAP; 1731 for grep $_->outdoor, values %cf::MAP;
1732}
1733
1734sub decay_objects {
1735 my ($self) = @_;
1736
1737 return if $self->{deny_reset};
1738
1739 $self->do_decay_objects;
1419} 1740}
1420 1741
1421sub unlink_save { 1742sub unlink_save {
1422 my ($self) = @_; 1743 my ($self) = @_;
1423 1744
1481 $self->load_header_orig 1802 $self->load_header_orig
1482 or return; 1803 or return;
1483 $self->prepare_orig; 1804 $self->prepare_orig;
1484 } 1805 }
1485 1806
1807 $self->{deny_reset} = 1
1808 if $self->no_reset;
1809
1486 $self->default_region (cf::region::find_by_path $self->{path}) 1810 $self->default_region (cf::region::find_by_path $self->{path})
1487 unless $self->default_region; 1811 unless $self->default_region;
1488 1812
1489 1 1813 1
1490} 1814}
1505 $map->{last_save} = $cf::RUNTIME; 1829 $map->{last_save} = $cf::RUNTIME;
1506 1830
1507 $map->load_header 1831 $map->load_header
1508 or return; 1832 or return;
1509 1833
1510 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1511 # doing this can freeze the server in a sync job, obviously 1835 # doing this can freeze the server in a sync job, obviously
1512 #$cf::WAIT_FOR_TICK->wait; 1836 #$cf::WAIT_FOR_TICK->wait;
1513 $map->reset; 1837 $map->reset;
1514 undef $guard; 1838 undef $guard;
1515 return find $path; 1839 return find $path;
1570 $self->set_darkness_map; 1894 $self->set_darkness_map;
1571 Coro::cede; 1895 Coro::cede;
1572 $self->activate; 1896 $self->activate;
1573 } 1897 }
1574 1898
1899 $self->{last_save} = $cf::RUNTIME;
1900 $self->last_access ($cf::RUNTIME);
1901
1575 $self->in_memory (cf::MAP_IN_MEMORY); 1902 $self->in_memory (cf::MAP_IN_MEMORY);
1576 } 1903 }
1577 1904
1578 $self->post_load; 1905 $self->post_load;
1579} 1906}
1581sub customise_for { 1908sub customise_for {
1582 my ($self, $ob) = @_; 1909 my ($self, $ob) = @_;
1583 1910
1584 return find "~" . $ob->name . "/" . $self->{path} 1911 return find "~" . $ob->name . "/" . $self->{path}
1585 if $self->per_player; 1912 if $self->per_player;
1913
1914# return find "?party/" . $ob->name . "/" . $self->{path}
1915# if $self->per_party;
1586 1916
1587 $self 1917 $self
1588} 1918}
1589 1919
1590# find and load all maps in the 3x3 area around a map 1920# find and load all maps in the 3x3 area around a map
1637 1967
1638 undef $MAP_PREFETCH{$path}; 1968 undef $MAP_PREFETCH{$path};
1639 $MAP_PREFETCHER ||= cf::async { 1969 $MAP_PREFETCHER ||= cf::async {
1640 while (%MAP_PREFETCH) { 1970 while (%MAP_PREFETCH) {
1641 for my $path (keys %MAP_PREFETCH) { 1971 for my $path (keys %MAP_PREFETCH) {
1642 my $map = find $path 1972 if (my $map = find $path) {
1643 or next;
1644 $map->load; 1973 $map->load;
1974 }
1645 1975
1646 delete $MAP_PREFETCH{$path}; 1976 delete $MAP_PREFETCH{$path};
1647 } 1977 }
1648 } 1978 }
1649 undef $MAP_PREFETCHER; 1979 undef $MAP_PREFETCHER;
1701 2031
1702sub reset_at { 2032sub reset_at {
1703 my ($self) = @_; 2033 my ($self) = @_;
1704 2034
1705 # TODO: safety, remove and allow resettable per-player maps 2035 # TODO: safety, remove and allow resettable per-player maps
1706 return 1e99 if $self->isa ("ext::map_per_player");#d#
1707 return 1e99 if $self->{deny_reset}; 2036 return 1e99 if $self->{deny_reset};
1708 2037
1709 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2038 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1710 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2039 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1711 2040
1722 my ($self) = @_; 2051 my ($self) = @_;
1723 2052
1724 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2053 my $lock = cf::lock_acquire "map_data:$self->{path}";
1725 2054
1726 return if $self->players; 2055 return if $self->players;
1727 return if $self->isa ("ext::map_per_player");#d#
1728 2056
1729 warn "resetting map ", $self->path;#d# 2057 warn "resetting map ", $self->path;
1730 2058
1731 $self->in_memory (cf::MAP_SWAPPED); 2059 $self->in_memory (cf::MAP_SWAPPED);
1732 2060
1733 # need to save uniques path 2061 # need to save uniques path
1734 unless ($self->{deny_save}) { 2062 unless ($self->{deny_save}) {
1766 $cf::MAP{$self->path} = $self; 2094 $cf::MAP{$self->path} = $self;
1767 2095
1768 $self->reset; # polite request, might not happen 2096 $self->reset; # polite request, might not happen
1769} 2097}
1770 2098
2099=item $maps = cf::map::tmp_maps
2100
2101Returns an arrayref with all map paths of currently instantiated and saved
2102maps. May block.
2103
2104=cut
2105
2106sub tmp_maps() {
2107 [
2108 map {
2109 utf8::decode $_;
2110 /\.map$/
2111 ? normalise $_
2112 : ()
2113 } @{ aio_readdir $TMPDIR or [] }
2114 ]
2115}
2116
2117=item $maps = cf::map::random_maps
2118
2119Returns an arrayref with all map paths of currently instantiated and saved
2120random maps. May block.
2121
2122=cut
2123
2124sub random_maps() {
2125 [
2126 map {
2127 utf8::decode $_;
2128 /\.map$/
2129 ? normalise "?random/$_"
2130 : ()
2131 } @{ aio_readdir $RANDOMDIR or [] }
2132 ]
2133}
2134
1771=item cf::map::unique_maps 2135=item cf::map::unique_maps
1772 2136
1773Returns an arrayref of paths of all shared maps that have 2137Returns an arrayref of paths of all shared maps that have
1774instantiated unique items. May block. 2138instantiated unique items. May block.
1775 2139
1776=cut 2140=cut
1777 2141
1778sub unique_maps() { 2142sub unique_maps() {
1779 my $files = aio_readdir $UNIQUEDIR 2143 [
1780 or return; 2144 map {
1781
1782 my @paths;
1783
1784 for (@$files) {
1785 utf8::decode $_; 2145 utf8::decode $_;
1786 next if /\.pst$/; 2146 /\.map$/
1787 next unless /^$PATH_SEP/o; 2147 ? normalise $_
1788 2148 : ()
1789 push @paths, cf::map::normalise $_; 2149 } @{ aio_readdir $UNIQUEDIR or [] }
1790 } 2150 ]
1791
1792 \@paths
1793} 2151}
1794 2152
1795package cf; 2153package cf;
1796 2154
1797=back 2155=back
1843 2201
1844 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2202 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1845 2203
1846 if ($self->{record_replies}) { 2204 if ($self->{record_replies}) {
1847 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2205 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2206
1848 } else { 2207 } else {
2208 my $pl = $self->contr;
2209
2210 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2211 my $dialog = $pl->{npc_dialog};
2212 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2213
2214 } else {
1849 $msg = $npc->name . " says: $msg" if $npc; 2215 $msg = $npc->name . " says: $msg" if $npc;
1850 $self->message ($msg, $flags); 2216 $self->message ($msg, $flags);
2217 }
1851 } 2218 }
2219}
2220
2221=item $object->send_msg ($channel, $msg, $color, [extra...])
2222
2223=cut
2224
2225sub cf::object::send_msg {
2226 my $pl = shift->contr
2227 or return;
2228 $pl->send_msg (@_);
1852} 2229}
1853 2230
1854=item $player_object->may ("access") 2231=item $player_object->may ("access")
1855 2232
1856Returns wether the given player is authorized to access resource "access" 2233Returns wether the given player is authorized to access resource "access"
1944 2321
1945 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2322 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1946 $self->enter_map ($map, $x, $y); 2323 $self->enter_map ($map, $x, $y);
1947} 2324}
1948 2325
1949=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2326=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1950 2327
1951Moves the player to the given map-path and coordinates by first freezing 2328Moves the player to the given map-path and coordinates by first freezing
1952her, loading and preparing them map, calling the provided $check callback 2329her, loading and preparing them map, calling the provided $check callback
1953that has to return the map if sucecssful, and then unfreezes the player on 2330that has to return the map if sucecssful, and then unfreezes the player on
1954the new (success) or old (failed) map position. 2331the new (success) or old (failed) map position. In either case, $done will
2332be called at the end of this process.
1955 2333
1956=cut 2334=cut
1957 2335
1958our $GOTOGEN; 2336our $GOTOGEN;
1959 2337
1960sub cf::object::player::goto { 2338sub cf::object::player::goto {
1961 my ($self, $path, $x, $y, $check) = @_; 2339 my ($self, $path, $x, $y, $check, $done) = @_;
1962 2340
1963 # do generation counting so two concurrent goto's will be executed in-order 2341 # do generation counting so two concurrent goto's will be executed in-order
1964 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2342 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1965 2343
1966 $self->enter_link; 2344 $self->enter_link;
1986 2364
1987 if ($gen == $self->{_goto_generation}) { 2365 if ($gen == $self->{_goto_generation}) {
1988 delete $self->{_goto_generation}; 2366 delete $self->{_goto_generation};
1989 $self->leave_link ($map, $x, $y); 2367 $self->leave_link ($map, $x, $y);
1990 } 2368 }
2369
2370 $done->() if $done;
1991 })->prio (1); 2371 })->prio (1);
1992} 2372}
1993 2373
1994=item $player_object->enter_exit ($exit_object) 2374=item $player_object->enter_exit ($exit_object)
1995 2375
2064 my $hp = $exit->stats->hp; 2444 my $hp = $exit->stats->hp;
2065 my $sp = $exit->stats->sp; 2445 my $sp = $exit->stats->sp;
2066 2446
2067 $self->enter_link; 2447 $self->enter_link;
2068 2448
2449 # if exit is damned, update players death & WoR home-position
2450 $self->contr->savebed ($slaying, $hp, $sp)
2451 if $exit->flag (FLAG_DAMNED);
2452
2069 (async { 2453 (async {
2070 $self->deactivate_recursive; # just to be sure 2454 $self->deactivate_recursive; # just to be sure
2071 unless (eval { 2455 unless (eval {
2072 $self->goto ($slaying, $hp, $sp); 2456 $self->goto ($slaying, $hp, $sp);
2073 2457
2100 2484
2101 utf8::encode $text; 2485 utf8::encode $text;
2102 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2486 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2103} 2487}
2104 2488
2489=item $client->send_msg ($channel, $msg, $color, [extra...])
2490
2491Send a drawinfo or msg packet to the client, formatting the msg for the
2492client if neccessary. C<$type> should be a string identifying the type of
2493the message, with C<log> being the default. If C<$color> is negative, suppress
2494the message unless the client supports the msg packet.
2495
2496=cut
2497
2498sub cf::client::send_msg {
2499 my ($self, $channel, $msg, $color, @extra) = @_;
2500
2501 $msg = $self->pl->expand_cfpod ($msg);
2502
2503 $color &= cf::NDI_CLIENT_MASK; # just in case...
2504
2505 if (ref $channel) {
2506 # send meta info to client, if not yet sent
2507 unless (exists $self->{channel}{$channel->{id}}) {
2508 $self->{channel}{$channel->{id}} = $channel;
2509 $self->ext_msg (channel_info => $channel);
2510 }
2511
2512 $channel = $channel->{id};
2513 }
2514
2515 return unless @extra || length $msg;
2516
2517 if ($self->can_msg) {
2518 # default colour, mask it out
2519 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2520 if $color & cf::NDI_DEF;
2521
2522 $self->send_packet ("msg " . $self->{json_coder}->encode (
2523 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2524 } else {
2525 if ($color >= 0) {
2526 # replace some tags by gcfclient-compatible ones
2527 for ($msg) {
2528 1 while
2529 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2530 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2531 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2532 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2533 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2534 }
2535
2536 $color &= cf::NDI_COLOR_MASK;
2537
2538 utf8::encode $msg;
2539
2540 if (0 && $msg =~ /\[/) {
2541 # COMMAND/INFO
2542 $self->send_packet ("drawextinfo $color 10 8 $msg")
2543 } else {
2544 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2545 $self->send_packet ("drawinfo $color $msg")
2546 }
2547 }
2548 }
2549}
2550
2105=item $client->ext_event ($type, %msg) 2551=item $client->ext_msg ($type, @msg)
2106 2552
2107Sends an exti event to the client. 2553Sends an ext event to the client.
2108 2554
2109=cut 2555=cut
2110 2556
2111sub cf::client::ext_event($$%) { 2557sub cf::client::ext_msg($$@) {
2112 my ($self, $type, %msg) = @_; 2558 my ($self, $type, @msg) = @_;
2113 2559
2560 my $extcmd = $self->extcmd;
2561
2562 if ($extcmd == 2) {
2563 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2564 } elsif ($extcmd == 1) { # TODO: remove
2114 $msg{msgtype} = "event_$type"; 2565 push @msg, msgtype => "event_$type";
2115 $self->send_packet ("ext " . cf::to_json \%msg); 2566 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2567 }
2116} 2568}
2117 2569
2118=item $success = $client->query ($flags, "text", \&cb) 2570=item $success = $client->query ($flags, "text", \&cb)
2119 2571
2120Queues a query to the client, calling the given callback with 2572Queues a query to the client, calling the given callback with
2121the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2573the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2122C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2574C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2123 2575
2124Queries can fail, so check the return code. Or don't, as queries will become 2576Queries can fail, so check the return code. Or don't, as queries will
2125reliable at some point in the future. 2577become reliable at some point in the future.
2126 2578
2127=cut 2579=cut
2128 2580
2129sub cf::client::query { 2581sub cf::client::query {
2130 my ($self, $flags, $text, $cb) = @_; 2582 my ($self, $flags, $text, $cb) = @_;
2138 utf8::encode $text; 2590 utf8::encode $text;
2139 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2591 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2140 2592
2141 $self->send_packet ($self->{query_queue}[0][0]) 2593 $self->send_packet ($self->{query_queue}[0][0])
2142 if @{ $self->{query_queue} } == 1; 2594 if @{ $self->{query_queue} } == 1;
2595
2596 1
2143} 2597}
2144 2598
2145cf::client->attach ( 2599cf::client->attach (
2600 on_connect => sub {
2601 my ($ns) = @_;
2602
2603 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2604 },
2146 on_reply => sub { 2605 on_reply => sub {
2147 my ($ns, $msg) = @_; 2606 my ($ns, $msg) = @_;
2148 2607
2149 # this weird shuffling is so that direct followup queries 2608 # this weird shuffling is so that direct followup queries
2150 # get handled first 2609 # get handled first
2162 } else { 2621 } else {
2163 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2622 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2164 } 2623 }
2165 } 2624 }
2166 }, 2625 },
2626 on_exticmd => sub {
2627 my ($ns, $buf) = @_;
2628
2629 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2630
2631 if (ref $msg) {
2632 my ($type, $reply, @payload) =
2633 "ARRAY" eq ref $msg
2634 ? @$msg
2635 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2636
2637 if (my $cb = $EXTICMD{$type}) {
2638 my @reply = $cb->($ns, @payload);
2639
2640 $ns->ext_reply ($reply, @reply)
2641 if $reply;
2642 }
2643 } else {
2644 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2645 }
2646
2647 cf::override;
2648 },
2167); 2649);
2168 2650
2169=item $client->async (\&cb) 2651=item $client->async (\&cb)
2170 2652
2171Create a new coroutine, running the specified callback. The coroutine will 2653Create a new coroutine, running the specified callback. The coroutine will
2212our $safe = new Safe "safe"; 2694our $safe = new Safe "safe";
2213our $safe_hole = new Safe::Hole; 2695our $safe_hole = new Safe::Hole;
2214 2696
2215$SIG{FPE} = 'IGNORE'; 2697$SIG{FPE} = 'IGNORE';
2216 2698
2217$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2699$safe->permit_only (Opcode::opset qw(
2700 :base_core :base_mem :base_orig :base_math
2701 grepstart grepwhile mapstart mapwhile
2702 sort time
2703));
2218 2704
2219# here we export the classes and methods available to script code 2705# here we export the classes and methods available to script code
2220 2706
2221=pod 2707=pod
2222 2708
2223The following functions and methods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
2224 2710
2225 cf::object contr pay_amount pay_player map 2711 cf::object
2712 contr pay_amount pay_player map x y force_find force_add
2713 insert remove name archname title slaying race
2714
2226 cf::object::player player 2715 cf::object::player
2227 cf::player peaceful 2716 player
2228 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
2229 2723
2230=cut 2724=cut
2231 2725
2232for ( 2726for (
2233 ["cf::object" => qw(contr pay_amount pay_player map)], 2727 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2728 insert remove inv name archname title slaying race)],
2234 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
2235 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
2236 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
2237) { 2732) {
2238 no strict 'refs'; 2733 no strict 'refs';
2309=back 2804=back
2310 2805
2311=cut 2806=cut
2312 2807
2313############################################################################# 2808#############################################################################
2314
2315=head2 EXTENSION DATABASE SUPPORT
2316
2317Crossfire maintains a very simple database for extension use. It can
2318currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2319convert to/from binary).
2320
2321The parameter C<$family> should best start with the name of the extension
2322using it, it should be unique.
2323
2324=over 4
2325
2326=item $value = cf::db_get $family => $key
2327
2328Returns a single value from the database.
2329
2330=item cf::db_put $family => $key => $value
2331
2332Stores the given C<$value> in the family.
2333
2334=cut
2335
2336our $DB;
2337
2338sub db_init {
2339 unless ($DB) {
2340 $DB = BDB::db_create $DB_ENV;
2341
2342 cf::sync_job {
2343 eval {
2344 $DB->set_flags (BDB::CHKSUM);
2345
2346 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2347 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2348 cf::cleanup "db_open(db): $!" if $!;
2349 };
2350 cf::cleanup "db_open(db): $@" if $@;
2351 };
2352 }
2353}
2354
2355sub db_get($$) {
2356 my $key = "$_[0]/$_[1]";
2357
2358 cf::sync_job {
2359 BDB::db_get $DB, undef, $key, my $data;
2360
2361 $! ? ()
2362 : $data
2363 }
2364}
2365
2366sub db_put($$$) {
2367 BDB::dbreq_pri 4;
2368 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2369}
2370
2371=item cf::cache $id => [$paths...], $processversion => $process
2372
2373Generic caching function that returns the value of the resource $id,
2374caching and regenerating as required.
2375
2376This function can block.
2377
2378=cut
2379
2380sub cache {
2381 my ($id, $src, $processversion, $process) = @_;
2382
2383 my $meta =
2384 join "\x00",
2385 $processversion,
2386 map {
2387 aio_stat $_
2388 and Carp::croak "$_: $!";
2389
2390 ($_, (stat _)[7,9])
2391 } @$src;
2392
2393 my $dbmeta = db_get cache => "$id/meta";
2394 if ($dbmeta ne $meta) {
2395 # changed, we may need to process
2396
2397 my @data;
2398 my $md5;
2399
2400 for (0 .. $#$src) {
2401 0 <= aio_load $src->[$_], $data[$_]
2402 or Carp::croak "$src->[$_]: $!";
2403 }
2404
2405 # if processing is expensive, check
2406 # checksum first
2407 if (1) {
2408 $md5 =
2409 join "\x00",
2410 $processversion,
2411 map {
2412 Coro::cede;
2413 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2414 } 0.. $#$src;
2415
2416
2417 my $dbmd5 = db_get cache => "$id/md5";
2418 if ($dbmd5 eq $md5) {
2419 db_put cache => "$id/meta", $meta;
2420
2421 return db_get cache => "$id/data";
2422 }
2423 }
2424
2425 my $t1 = Time::HiRes::time;
2426 my $data = $process->(\@data);
2427 my $t2 = Time::HiRes::time;
2428
2429 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2430
2431 db_put cache => "$id/data", $data;
2432 db_put cache => "$id/md5" , $md5;
2433 db_put cache => "$id/meta", $meta;
2434
2435 return $data;
2436 }
2437
2438 db_get cache => "$id/data"
2439}
2440
2441=item fork_call { }, $args
2442
2443Executes the given code block with the given arguments in a seperate
2444process, returning the results. Everything must be serialisable with
2445Coro::Storable. May, of course, block. Note that the executed sub may
2446never block itself or use any form of Event handling.
2447
2448=cut
2449
2450sub fork_call(&@) {
2451 my ($cb, @args) = @_;
2452
2453# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2454# or die "socketpair: $!";
2455 pipe my $fh1, my $fh2
2456 or die "pipe: $!";
2457
2458 if (my $pid = fork) {
2459 close $fh2;
2460
2461 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2462 $res = Coro::Storable::thaw $res;
2463
2464 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2465
2466 die $$res unless "ARRAY" eq ref $res;
2467
2468 return wantarray ? @$res : $res->[-1];
2469 } else {
2470 reset_signals;
2471 local $SIG{__WARN__};
2472 local $SIG{__DIE__};
2473 eval {
2474 close $fh1;
2475
2476 my @res = eval { $cb->(@args) };
2477 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2478 };
2479
2480 warn $@ if $@;
2481 _exit 0;
2482 }
2483}
2484
2485#############################################################################
2486# the server's init and main functions 2809# the server's init and main functions
2487 2810
2488sub load_facedata($) { 2811sub load_facedata($) {
2489 my ($path) = @_; 2812 my ($path) = @_;
2490 2813
2502 { 2825 {
2503 my $faces = $facedata->{faceinfo}; 2826 my $faces = $facedata->{faceinfo};
2504 2827
2505 while (my ($face, $info) = each %$faces) { 2828 while (my ($face, $info) = each %$faces) {
2506 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2507 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2508 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2509 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2510 Coro::cede; 2834
2835 cf::cede_to_tick;
2511 } 2836 }
2512 2837
2513 while (my ($face, $info) = each %$faces) { 2838 while (my ($face, $info) = each %$faces) {
2514 next unless $info->{smooth}; 2839 next unless $info->{smooth};
2515 my $idx = cf::face::find $face 2840 my $idx = cf::face::find $face
2516 or next; 2841 or next;
2517 if (my $smooth = cf::face::find $info->{smooth}) { 2842 if (my $smooth = cf::face::find $info->{smooth}) {
2843 cf::face::set_smooth $idx, $smooth;
2518 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2519 } else { 2845 } else {
2520 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2521 } 2847 }
2522 Coro::cede; 2848
2849 cf::cede_to_tick;
2523 } 2850 }
2524 } 2851 }
2525 2852
2526 { 2853 {
2527 my $anims = $facedata->{animinfo}; 2854 my $anims = $facedata->{animinfo};
2528 2855
2529 while (my ($anim, $info) = each %$anims) { 2856 while (my ($anim, $info) = each %$anims) {
2530 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2531 Coro::cede; 2858 cf::cede_to_tick;
2532 } 2859 }
2533 2860
2534 cf::anim::invalidate_all; # d'oh 2861 cf::anim::invalidate_all; # d'oh
2535 } 2862 }
2536 2863
2864 {
2865 # TODO: for gcfclient pleasure, we should give resources
2866 # that gcfclient doesn't grok a >10000 face index.
2867 my $res = $facedata->{resource};
2868 my $enc = JSON::XS->new->utf8->canonical;
2869
2870 my $soundconf = delete $res->{"res/sound.conf"};
2871
2872 while (my ($name, $info) = each %$res) {
2873 my $meta = $enc->encode ({
2874 name => $name,
2875 %{ $info->{meta} || {} },
2876 });
2877
2878 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2879
2880 if ($info->{type} & 1) {
2881 # prepend meta info
2882
2883 my $data = pack "(w/a*)*", $meta, $info->{data};
2884 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2885
2886 cf::face::set_data $idx, 0, $data, $chk;
2887 } else {
2888 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2889 }
2890
2891 cf::face::set_type $idx, $info->{type};
2892
2893 cf::cede_to_tick;
2894 }
2895
2896 if ($soundconf) {
2897 $soundconf = $enc->decode (delete $soundconf->{data});
2898
2899 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2900 my $sound = $soundconf->{compat}[$_]
2901 or next;
2902
2903 my $face = cf::face::find "sound/$sound->[1]";
2904 cf::sound::set $sound->[0] => $face;
2905 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2906 }
2907
2908 while (my ($k, $v) = each %{$soundconf->{event}}) {
2909 my $face = cf::face::find "sound/$v";
2910 cf::sound::set $k => $face;
2911 }
2912 }
2913 }
2914
2537 1 2915 1
2538} 2916}
2917
2918register_exticmd fx_want => sub {
2919 my ($ns, $want) = @_;
2920
2921 while (my ($k, $v) = each %$want) {
2922 $ns->fx_want ($k, $v);
2923 }
2924};
2539 2925
2540sub reload_regions { 2926sub reload_regions {
2541 load_resource_file "$MAPDIR/regions" 2927 load_resource_file "$MAPDIR/regions"
2542 or die "unable to load regions file\n"; 2928 or die "unable to load regions file\n";
2929
2930 for (cf::region::list) {
2931 $_->{match} = qr/$_->{match}/
2932 if exists $_->{match};
2933 }
2543} 2934}
2544 2935
2545sub reload_facedata { 2936sub reload_facedata {
2546 load_facedata "$DATADIR/facedata" 2937 load_facedata "$DATADIR/facedata"
2547 or die "unable to load facedata\n"; 2938 or die "unable to load facedata\n";
2548} 2939}
2549 2940
2550sub reload_archetypes { 2941sub reload_archetypes {
2551 load_resource_file "$DATADIR/archetypes" 2942 load_resource_file "$DATADIR/archetypes"
2552 or die "unable to load archetypes\n"; 2943 or die "unable to load archetypes\n";
2944 #d# NEED to laod twice to resolve forward references
2945 # this really needs to be done in an extra post-pass
2946 # (which needs to be synchronous, so solve it differently)
2947 load_resource_file "$DATADIR/archetypes"
2948 or die "unable to load archetypes\n";
2553} 2949}
2554 2950
2555sub reload_treasures { 2951sub reload_treasures {
2556 load_resource_file "$DATADIR/treasures" 2952 load_resource_file "$DATADIR/treasures"
2557 or die "unable to load treasurelists\n"; 2953 or die "unable to load treasurelists\n";
2560sub reload_resources { 2956sub reload_resources {
2561 warn "reloading resource files...\n"; 2957 warn "reloading resource files...\n";
2562 2958
2563 reload_regions; 2959 reload_regions;
2564 reload_facedata; 2960 reload_facedata;
2961 #reload_archetypes;#d#
2565 reload_archetypes; 2962 reload_archetypes;
2566 reload_treasures; 2963 reload_treasures;
2567 2964
2568 warn "finished reloading resource files\n"; 2965 warn "finished reloading resource files\n";
2569} 2966}
2626 }, 3023 },
2627 ); 3024 );
2628 } 3025 }
2629} 3026}
2630 3027
3028sub write_runtime {
3029 my $runtime = "$LOCALDIR/runtime";
3030
3031 # first touch the runtime file to show we are still running:
3032 # the fsync below can take a very very long time.
3033
3034 IO::AIO::aio_utime $runtime, undef, undef;
3035
3036 my $guard = cf::lock_acquire "write_runtime";
3037
3038 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3039 or return;
3040
3041 my $value = $cf::RUNTIME + 90 + 10;
3042 # 10 is the runtime save interval, for a monotonic clock
3043 # 60 allows for the watchdog to kill the server.
3044
3045 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3046 and return;
3047
3048 # always fsync - this file is important
3049 aio_fsync $fh
3050 and return;
3051
3052 # touch it again to show we are up-to-date
3053 aio_utime $fh, undef, undef;
3054
3055 close $fh
3056 or return;
3057
3058 aio_rename "$runtime~", $runtime
3059 and return;
3060
3061 warn "runtime file written.\n";
3062
3063 1
3064}
3065
2631sub emergency_save() { 3066sub emergency_save() {
2632 my $freeze_guard = cf::freeze_mainloop; 3067 my $freeze_guard = cf::freeze_mainloop;
2633 3068
2634 warn "enter emergency perl save\n"; 3069 warn "enter emergency perl save\n";
2635 3070
2710 %EXT_CORO = (); 3145 %EXT_CORO = ();
2711 3146
2712 warn "removing commands"; 3147 warn "removing commands";
2713 %COMMAND = (); 3148 %COMMAND = ();
2714 3149
2715 warn "removing ext commands"; 3150 warn "removing ext/exti commands";
2716 %EXTCMD = (); 3151 %EXTCMD = ();
3152 %EXTICMD = ();
2717 3153
2718 warn "unloading/nuking all extensions"; 3154 warn "unloading/nuking all extensions";
2719 for my $pkg (@EXTS) { 3155 for my $pkg (@EXTS) {
2720 warn "... unloading $pkg"; 3156 warn "... unloading $pkg";
2721 3157

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines