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.272 by root, Sun Jun 3 15:32:50 2007 UTC vs.
Revision 1.335 by root, Mon Aug 20 22:21:48 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 {
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 201@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
202@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 203@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193 204
194# we bless all objects into (empty) derived classes to force a method lookup 205# we bless all objects into (empty) derived classes to force a method lookup
195# within the Safe compartment. 206# within the Safe compartment.
196for my $pkg (qw( 207for my $pkg (qw(
197 cf::global cf::attachable 208 cf::global cf::attachable
205} 216}
206 217
207$Event::DIED = sub { 218$Event::DIED = sub {
208 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
209}; 220};
221
222#############################################################################
210 223
211=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
212 225
213=over 4 226=over 4
214 227
233 $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;
234 $d 247 $d
235 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
236} 249}
237 250
238use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
241 252
242Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
243 254
244=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
245 256
246Converts 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]) }
247 265
248=item cf::lock_wait $string 266=item cf::lock_wait $string
249 267
250Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
251 269
305 }; 323 };
306 $TICK_WATCHER->stop; 324 $TICK_WATCHER->stop;
307 $guard 325 $guard
308} 326}
309 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
310=item cf::async { BLOCK } 384=item cf::async { BLOCK }
311 385
312Currently the same as Coro::async_pool, meaning you cannot use 386Currently the same as Coro::async_pool, meaning you cannot use
313C<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
314thing you are allowed to do is call C<prio> on it. 388thing you are allowed to do is call C<prio> on it.
317 391
318BEGIN { *async = \&Coro::async_pool } 392BEGIN { *async = \&Coro::async_pool }
319 393
320=item cf::sync_job { BLOCK } 394=item cf::sync_job { BLOCK }
321 395
322The design of crossfire+ requires that the main coro ($Coro::main) is 396The design of Crossfire TRT requires that the main coroutine ($Coro::main)
323always able to handle events or runnable, as crossfire+ is only partly 397is always able to handle events or runnable, as Crossfire TRT is only
324reentrant. 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.
325 400
326If 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
327the given BLOCK in another coroutine while waiting for the result. The 402the given BLOCK in another coroutine while waiting for the result. The
328server 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
329fast or be very important. 404fast or be very important.
389 $EXT_CORO{$coro+0} = $coro; 464 $EXT_CORO{$coro+0} = $coro;
390 465
391 $coro 466 $coro
392} 467}
393 468
394sub write_runtime { 469=item fork_call { }, $args
395 my $runtime = "$LOCALDIR/runtime";
396 470
397 # first touch the runtime file to show we are still running: 471Executes the given code block with the given arguments in a seperate
398 # 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.
399 475
400 IO::AIO::aio_utime $runtime, undef, undef; 476=cut
401 477
402 my $guard = cf::lock_acquire "write_runtime"; 478sub fork_call(&@) {
479 my ($cb, @args) = @_;
403 480
404 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 481 # we seemingly have to make a local copy of the whole thing,
405 or return; 482 # otherwise perl prematurely frees the stuff :/
483 # TODO: investigate and fix (liekly this will be rather laborious)
406 484
407 my $value = $cf::RUNTIME + 90 + 10; 485 my @res = Coro::Util::fork_eval {
408 # 10 is the runtime save interval, for a monotonic clock 486 reset_signals;
409 # 60 allows for the watchdog to kill the server. 487 &$cb
488 }, @args;
410 489
411 (aio_write $fh, 0, (length $value), $value, 0) <= 0 490 wantarray ? @res : $res[-1]
412 and return; 491}
413 492
414 # always fsync - this file is important 493=item $value = cf::db_get $family => $key
415 aio_fsync $fh
416 and return;
417 494
418 # touch it again to show we are up-to-date 495Returns a single value from the environment database.
419 aio_utime $fh, undef, undef;
420 496
421 close $fh 497=item cf::db_put $family => $key => $value
422 or return;
423 498
424 aio_rename "$runtime~", $runtime 499Stores the given C<$value> in the family. It can currently store binary
425 and return; 500data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
426 501
427 warn "runtime file written.\n";#d# 502=cut
428 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 };
429 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"
430} 607}
431 608
432=item cf::datalog type => key => value, ... 609=item cf::datalog type => key => value, ...
433 610
434Log 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.
452attach callbacks/event handlers (a collection of which is called an "attachment") 629attach callbacks/event handlers (a collection of which is called an "attachment")
453to it. All such attachable objects support the following methods. 630to it. All such attachable objects support the following methods.
454 631
455In 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>
456C<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
457crossfire+). 634Crossfire TRT).
458 635
459=over 4 636=over 4
460 637
461=item $attachable->attach ($attachment, key => $value...) 638=item $attachable->attach ($attachment, key => $value...)
462 639
664 _attach $registry, $klass, @attach; 841 _attach $registry, $klass, @attach;
665 } 842 }
666 843
667 $obj->{$name} = \%arg; 844 $obj->{$name} = \%arg;
668 } else { 845 } else {
669 warn "object uses attachment '$name' that is not available, postponing.\n"; 846 warn "object uses attachment '$name' which is not available, postponing.\n";
670 } 847 }
671 848
672 $obj->{_attachment}{$name} = undef; 849 $obj->{_attachment}{$name} = undef;
673} 850}
674 851
714 "; 891 ";
715 die if $@; 892 die if $@;
716} 893}
717 894
718our $override; 895our $override;
719our @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?
720 897
721sub override { 898sub override {
722 $override = 1; 899 $override = 1;
723 @invoke_results = (); 900 @INVOKE_RESULTS = (@_);
724} 901}
725 902
726sub do_invoke { 903sub do_invoke {
727 my $event = shift; 904 my $event = shift;
728 my $callbacks = shift; 905 my $callbacks = shift;
729 906
730 @invoke_results = (); 907 @INVOKE_RESULTS = ();
731 908
732 local $override; 909 local $override;
733 910
734 for (@$callbacks) { 911 for (@$callbacks) {
735 eval { &{$_->[1]} }; 912 eval { &{$_->[1]} };
752 929
753Generate an object-specific event with the given arguments. 930Generate an object-specific event with the given arguments.
754 931
755This 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
756removed 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
757results (if you must, access C<@cf::invoke_results> directly). 934results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758 935
759=back 936=back
760 937
761=cut 938=cut
762 939
763############################################################################# 940#############################################################################
764# 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}
765 953
766sub reattach { 954sub reattach {
767 # basically do the same as instantiate, without calling instantiate 955 # basically do the same as instantiate, without calling instantiate
768 my ($obj) = @_; 956 my ($obj) = @_;
769 957
872 or return; 1060 or return;
873 $av = eval { (Storable::thaw $av)->{objs} }; 1061 $av = eval { (Storable::thaw $av)->{objs} };
874 } 1062 }
875 1063
876 warn sprintf "loading %s (%d)\n", 1064 warn sprintf "loading %s (%d)\n",
877 $filename, length $data, scalar @{$av || []};#d# 1065 $filename, length $data, scalar @{$av || []};
878 return ($data, $av); 1066 return ($data, $av);
879} 1067}
1068
1069=head2 COMMAND CALLBACKS
1070
1071=over 4
1072
1073=cut
880 1074
881############################################################################# 1075#############################################################################
882# command handling &c 1076# command handling &c
883 1077
884=item cf::register_command $name => \&callback($ob,$args); 1078=item cf::register_command $name => \&callback($ob,$args);
897 push @{ $COMMAND{$name} }, [$caller, $cb]; 1091 push @{ $COMMAND{$name} }, [$caller, $cb];
898} 1092}
899 1093
900=item cf::register_extcmd $name => \&callback($pl,$packet); 1094=item cf::register_extcmd $name => \&callback($pl,$packet);
901 1095
902Register 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.
903 1101
904If 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
905called. 1103called.
906 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
907=cut 1116=cut
908 1117
909sub register_extcmd { 1118sub register_extcmd {
910 my ($name, $cb) = @_; 1119 my ($name, $cb) = @_;
911 1120
912 $EXTCMD{$name} = $cb; 1121 $EXTCMD{$name} = $cb;
1122}
1123
1124sub register_exticmd {
1125 my ($name, $cb) = @_;
1126
1127 $EXTICMD{$name} = $cb;
913} 1128}
914 1129
915cf::player->attach ( 1130cf::player->attach (
916 on_command => sub { 1131 on_command => sub {
917 my ($pl, $name, $params) = @_; 1132 my ($pl, $name, $params) = @_;
926 cf::override; 1141 cf::override;
927 }, 1142 },
928 on_extcmd => sub { 1143 on_extcmd => sub {
929 my ($pl, $buf) = @_; 1144 my ($pl, $buf) = @_;
930 1145
931 my $msg = eval { from_json $buf }; 1146 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
932 1147
933 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
934 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1154 if (my $cb = $EXTCMD{$type}) {
935 if (my %reply = $cb->($pl, $msg)) { 1155 my @reply = $cb->($pl, @payload);
1156
936 $pl->ext_reply ($msg->{msgid}, %reply); 1157 $pl->ext_reply ($reply, @reply)
937 } 1158 if $reply;
938 } 1159 }
939 } else { 1160 } else {
940 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1161 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
941 } 1162 }
942 1163
943 cf::override; 1164 cf::override;
944 }, 1165 },
945); 1166);
946 1167
947sub load_extension {
948 my ($path) = @_;
949
950 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
951 my $base = $1;
952 my $pkg = $1;
953 $pkg =~ s/[^[:word:]]/_/g;
954 $pkg = "ext::$pkg";
955
956 warn "... loading '$path' into '$pkg'\n";
957
958 open my $fh, "<:utf8", $path
959 or die "$path: $!";
960
961 my $source =
962 "package $pkg; use strict; use utf8;\n"
963 . "#line 1 \"$path\"\n{\n"
964 . (do { local $/; <$fh> })
965 . "\n};\n1";
966
967 unless (eval $source) {
968 my $msg = $@ ? "$path: $@\n"
969 : "extension disabled.\n";
970 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
971 warn $@;
972 warn "mandatory extension failed to load, exiting.\n";
973 exit 1;
974 }
975 die $@;
976 }
977
978 push @EXTS, $pkg;
979}
980
981sub load_extensions { 1168sub load_extensions {
1169 cf::sync_job {
1170 my %todo;
1171
982 for my $ext (<$LIBDIR/*.ext>) { 1172 for my $path (<$LIBDIR/*.ext>) {
983 next unless -r $ext; 1173 next unless -r $path;
984 eval { 1174
985 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;
986 1 1232 }
987 } or warn "$ext not loaded: $@"; 1233
1234 skip:
1235 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1236 unless $progress;
1237 }
988 } 1238 };
989} 1239}
990 1240
991############################################################################# 1241#############################################################################
1242
1243=back
992 1244
993=head2 CORE EXTENSIONS 1245=head2 CORE EXTENSIONS
994 1246
995Functions and methods that extend core crossfire objects. 1247Functions and methods that extend core crossfire objects.
996 1248
1083 $cf::PLAYER{$login} = $self; 1335 $cf::PLAYER{$login} = $self;
1084 1336
1085 $self 1337 $self
1086} 1338}
1087 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
1088=item $pl->quit_character 1350=item $pl->quit_character
1089 1351
1090Nukes the player without looking back. If logged in, the connection will 1352Nukes the player without looking back. If logged in, the connection will
1091be destroyed. May block for a long time. 1353be destroyed. May block for a long time.
1092 1354
1184 } 1446 }
1185 1447
1186 \@paths 1448 \@paths
1187} 1449}
1188 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
1189=item $player->ext_reply ($msgid, %msg) 1501=item $player->ext_reply ($msgid, @msg)
1190 1502
1191Sends an ext reply to the player. 1503Sends an ext reply to the player.
1192 1504
1193=cut 1505=cut
1194 1506
1195sub ext_reply($$%) { 1507sub ext_reply($$@) {
1196 my ($self, $id, %msg) = @_; 1508 my ($self, $id, @msg) = @_;
1197 1509
1198 $msg{msgid} = $id; 1510 if ($self->ns->extcmd == 2) {
1199 1511 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1200 $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 }
1201} 1517}
1202 1518
1203=item $player->ext_event ($type, %msg) 1519=item $player->ext_msg ($type, @msg)
1204 1520
1205Sends an ext event to the client. 1521Sends an ext event to the client.
1206 1522
1207=cut 1523=cut
1208 1524
1209sub ext_event($$%) { 1525sub ext_msg($$@) {
1210 my ($self, $type, %msg) = @_; 1526 my ($self, $type, @msg) = @_;
1211 1527
1212 $self->ns->ext_event ($type, %msg); 1528 $self->ns->ext_msg ($type, @msg);
1213} 1529}
1214 1530
1215=head3 cf::region 1531=head3 cf::region
1216 1532
1217=over 4 1533=over 4
1220 1536
1221package cf::region; 1537package cf::region;
1222 1538
1223=item cf::region::find_by_path $path 1539=item cf::region::find_by_path $path
1224 1540
1225Tries 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.
1226 1542
1227=cut 1543=cut
1228 1544
1229sub find_by_path($) { 1545sub find_by_path($) {
1230 my ($path) = @_; 1546 my ($path) = @_;
1231 1547
1232 my ($match, $specificity); 1548 my ($match, $specificity);
1233 1549
1234 for my $region (list) { 1550 for my $region (list) {
1235 if ($region->match && $path =~ $region->match) { 1551 if ($region->{match} && $path =~ $region->{match}) {
1236 ($match, $specificity) = ($region, $region->specificity) 1552 ($match, $specificity) = ($region, $region->specificity)
1237 if $region->specificity > $specificity; 1553 if $region->specificity > $specificity;
1238 } 1554 }
1239 } 1555 }
1240 1556
1304 my ($self, $merge) = @_; 1620 my ($self, $merge) = @_;
1305 1621
1306 # we have to keep some variables in memory intact 1622 # we have to keep some variables in memory intact
1307 local $self->{path}; 1623 local $self->{path};
1308 local $self->{load_path}; 1624 local $self->{load_path};
1309 local $self->{deny_save};
1310 local $self->{deny_reset};
1311 1625
1312 $self->SUPER::thawer_merge ($merge); 1626 $self->SUPER::thawer_merge ($merge);
1313} 1627}
1314 1628
1315sub normalise { 1629sub normalise {
1362 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1363 return $self; 1677 return $self;
1364 } 1678 }
1365 } 1679 }
1366 1680
1367 Carp::carp "unable to resolve path '$path' (base '$base')."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1368 () 1682 ()
1369} 1683}
1370 1684
1371sub init { 1685sub init {
1372 my ($self) = @_; 1686 my ($self) = @_;
1413sub change_all_map_light { 1727sub change_all_map_light {
1414 my ($change) = @_; 1728 my ($change) = @_;
1415 1729
1416 $_->change_map_light ($change) 1730 $_->change_map_light ($change)
1417 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;
1418} 1740}
1419 1741
1420sub unlink_save { 1742sub unlink_save {
1421 my ($self) = @_; 1743 my ($self) = @_;
1422 1744
1480 $self->load_header_orig 1802 $self->load_header_orig
1481 or return; 1803 or return;
1482 $self->prepare_orig; 1804 $self->prepare_orig;
1483 } 1805 }
1484 1806
1807 $self->{deny_reset} = 1
1808 if $self->no_reset;
1809
1485 $self->default_region (cf::region::find_by_path $self->{path}) 1810 $self->default_region (cf::region::find_by_path $self->{path})
1486 unless $self->default_region; 1811 unless $self->default_region;
1487 1812
1488 1 1813 1
1489} 1814}
1504 $map->{last_save} = $cf::RUNTIME; 1829 $map->{last_save} = $cf::RUNTIME;
1505 1830
1506 $map->load_header 1831 $map->load_header
1507 or return; 1832 or return;
1508 1833
1509 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510 # doing this can freeze the server in a sync job, obviously 1835 # doing this can freeze the server in a sync job, obviously
1511 #$cf::WAIT_FOR_TICK->wait; 1836 #$cf::WAIT_FOR_TICK->wait;
1512 $map->reset; 1837 $map->reset;
1513 undef $guard; 1838 undef $guard;
1514 return find $path; 1839 return find $path;
1569 $self->set_darkness_map; 1894 $self->set_darkness_map;
1570 Coro::cede; 1895 Coro::cede;
1571 $self->activate; 1896 $self->activate;
1572 } 1897 }
1573 1898
1899 $self->{last_save} = $cf::RUNTIME;
1900 $self->last_access ($cf::RUNTIME);
1901
1574 $self->in_memory (cf::MAP_IN_MEMORY); 1902 $self->in_memory (cf::MAP_IN_MEMORY);
1575 } 1903 }
1576 1904
1577 $self->post_load; 1905 $self->post_load;
1578} 1906}
1581 my ($self, $ob) = @_; 1909 my ($self, $ob) = @_;
1582 1910
1583 return find "~" . $ob->name . "/" . $self->{path} 1911 return find "~" . $ob->name . "/" . $self->{path}
1584 if $self->per_player; 1912 if $self->per_player;
1585 1913
1914# return find "?party/" . $ob->name . "/" . $self->{path}
1915# if $self->per_party;
1916
1586 $self 1917 $self
1587} 1918}
1588 1919
1589# 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
1590sub load_diag { 1921sub load_neighbours {
1591 my ($map) = @_; 1922 my ($map) = @_;
1592 1923
1593 my @diag; # diagonal neighbours 1924 my @neigh; # diagonal neighbours
1594 1925
1595 for (0 .. 3) { 1926 for (0 .. 3) {
1596 my $neigh = $map->tile_path ($_) 1927 my $neigh = $map->tile_path ($_)
1597 or next; 1928 or next;
1598 $neigh = find $neigh, $map 1929 $neigh = find $neigh, $map
1599 or next; 1930 or next;
1600 $neigh->load; 1931 $neigh->load;
1601 1932
1933 push @neigh,
1602 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1934 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1603 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1935 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1604 } 1936 }
1605 1937
1606 for (@diag) { 1938 for (grep defined $_->[0], @neigh) {
1939 my ($path, $origin) = @$_;
1607 my $neigh = find @$_ 1940 my $neigh = find $path, $origin
1608 or next; 1941 or next;
1609 $neigh->load; 1942 $neigh->load;
1610 } 1943 }
1611} 1944}
1612 1945
1636 1969
1637 undef $MAP_PREFETCH{$path}; 1970 undef $MAP_PREFETCH{$path};
1638 $MAP_PREFETCHER ||= cf::async { 1971 $MAP_PREFETCHER ||= cf::async {
1639 while (%MAP_PREFETCH) { 1972 while (%MAP_PREFETCH) {
1640 for my $path (keys %MAP_PREFETCH) { 1973 for my $path (keys %MAP_PREFETCH) {
1641 my $map = find $path 1974 if (my $map = find $path) {
1642 or next;
1643 $map->load; 1975 $map->load;
1976 }
1644 1977
1645 delete $MAP_PREFETCH{$path}; 1978 delete $MAP_PREFETCH{$path};
1646 } 1979 }
1647 } 1980 }
1648 undef $MAP_PREFETCHER; 1981 undef $MAP_PREFETCHER;
1700 2033
1701sub reset_at { 2034sub reset_at {
1702 my ($self) = @_; 2035 my ($self) = @_;
1703 2036
1704 # TODO: safety, remove and allow resettable per-player maps 2037 # TODO: safety, remove and allow resettable per-player maps
1705 return 1e99 if $self->isa ("ext::map_per_player");#d#
1706 return 1e99 if $self->{deny_reset}; 2038 return 1e99 if $self->{deny_reset};
1707 2039
1708 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2040 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2041 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710 2042
1721 my ($self) = @_; 2053 my ($self) = @_;
1722 2054
1723 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2055 my $lock = cf::lock_acquire "map_data:$self->{path}";
1724 2056
1725 return if $self->players; 2057 return if $self->players;
1726 return if $self->isa ("ext::map_per_player");#d#
1727 2058
1728 warn "resetting map ", $self->path;#d# 2059 warn "resetting map ", $self->path;
1729 2060
1730 $self->in_memory (cf::MAP_SWAPPED); 2061 $self->in_memory (cf::MAP_SWAPPED);
1731 2062
1732 # need to save uniques path 2063 # need to save uniques path
1733 unless ($self->{deny_save}) { 2064 unless ($self->{deny_save}) {
1765 $cf::MAP{$self->path} = $self; 2096 $cf::MAP{$self->path} = $self;
1766 2097
1767 $self->reset; # polite request, might not happen 2098 $self->reset; # polite request, might not happen
1768} 2099}
1769 2100
2101=item $maps = cf::map::tmp_maps
2102
2103Returns an arrayref with all map paths of currently instantiated and saved
2104maps. May block.
2105
2106=cut
2107
2108sub tmp_maps() {
2109 [
2110 map {
2111 utf8::decode $_;
2112 /\.map$/
2113 ? normalise $_
2114 : ()
2115 } @{ aio_readdir $TMPDIR or [] }
2116 ]
2117}
2118
2119=item $maps = cf::map::random_maps
2120
2121Returns an arrayref with all map paths of currently instantiated and saved
2122random maps. May block.
2123
2124=cut
2125
2126sub random_maps() {
2127 [
2128 map {
2129 utf8::decode $_;
2130 /\.map$/
2131 ? normalise "?random/$_"
2132 : ()
2133 } @{ aio_readdir $RANDOMDIR or [] }
2134 ]
2135}
2136
1770=item cf::map::unique_maps 2137=item cf::map::unique_maps
1771 2138
1772Returns an arrayref of paths of all shared maps that have 2139Returns an arrayref of paths of all shared maps that have
1773instantiated unique items. May block. 2140instantiated unique items. May block.
1774 2141
1775=cut 2142=cut
1776 2143
1777sub unique_maps() { 2144sub unique_maps() {
1778 my $files = aio_readdir $UNIQUEDIR 2145 [
1779 or return; 2146 map {
1780
1781 my @paths;
1782
1783 for (@$files) {
1784 utf8::decode $_; 2147 utf8::decode $_;
1785 next if /\.pst$/; 2148 /\.map$/
1786 next unless /^$PATH_SEP/o; 2149 ? normalise $_
1787 2150 : ()
1788 push @paths, cf::map::normalise $_; 2151 } @{ aio_readdir $UNIQUEDIR or [] }
1789 } 2152 ]
1790
1791 \@paths
1792} 2153}
1793 2154
1794package cf; 2155package cf;
1795 2156
1796=back 2157=back
1842 2203
1843 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2204 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844 2205
1845 if ($self->{record_replies}) { 2206 if ($self->{record_replies}) {
1846 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2207 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2208
1847 } else { 2209 } else {
2210 my $pl = $self->contr;
2211
2212 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2213 my $dialog = $pl->{npc_dialog};
2214 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2215
2216 } else {
1848 $msg = $npc->name . " says: $msg" if $npc; 2217 $msg = $npc->name . " says: $msg" if $npc;
1849 $self->message ($msg, $flags); 2218 $self->message ($msg, $flags);
2219 }
1850 } 2220 }
2221}
2222
2223=item $object->send_msg ($channel, $msg, $color, [extra...])
2224
2225=cut
2226
2227sub cf::object::send_msg {
2228 my $pl = shift->contr
2229 or return;
2230 $pl->send_msg (@_);
1851} 2231}
1852 2232
1853=item $player_object->may ("access") 2233=item $player_object->may ("access")
1854 2234
1855Returns wether the given player is authorized to access resource "access" 2235Returns wether the given player is authorized to access resource "access"
1934 # use -1 or undef as default coordinates, not 0, 0 2314 # use -1 or undef as default coordinates, not 0, 0
1935 ($x, $y) = ($map->enter_x, $map->enter_y) 2315 ($x, $y) = ($map->enter_x, $map->enter_y)
1936 if $x <=0 && $y <= 0; 2316 if $x <=0 && $y <= 0;
1937 2317
1938 $map->load; 2318 $map->load;
1939 $map->load_diag; 2319 $map->load_neighbours;
1940 2320
1941 return unless $self->contr->active; 2321 return unless $self->contr->active;
1942 $self->activate_recursive; 2322 $self->activate_recursive;
1943 2323
1944 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2324 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945 $self->enter_map ($map, $x, $y); 2325 $self->enter_map ($map, $x, $y);
1946} 2326}
1947 2327
1948=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2328=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1949 2329
1950Moves the player to the given map-path and coordinates by first freezing 2330Moves the player to the given map-path and coordinates by first freezing
1951her, loading and preparing them map, calling the provided $check callback 2331her, loading and preparing them map, calling the provided $check callback
1952that has to return the map if sucecssful, and then unfreezes the player on 2332that has to return the map if sucecssful, and then unfreezes the player on
1953the new (success) or old (failed) map position. 2333the new (success) or old (failed) map position. In either case, $done will
2334be called at the end of this process.
1954 2335
1955=cut 2336=cut
1956 2337
1957our $GOTOGEN; 2338our $GOTOGEN;
1958 2339
1959sub cf::object::player::goto { 2340sub cf::object::player::goto {
1960 my ($self, $path, $x, $y, $check) = @_; 2341 my ($self, $path, $x, $y, $check, $done) = @_;
1961 2342
1962 # do generation counting so two concurrent goto's will be executed in-order 2343 # do generation counting so two concurrent goto's will be executed in-order
1963 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2344 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1964 2345
1965 $self->enter_link; 2346 $self->enter_link;
1985 2366
1986 if ($gen == $self->{_goto_generation}) { 2367 if ($gen == $self->{_goto_generation}) {
1987 delete $self->{_goto_generation}; 2368 delete $self->{_goto_generation};
1988 $self->leave_link ($map, $x, $y); 2369 $self->leave_link ($map, $x, $y);
1989 } 2370 }
2371
2372 $done->() if $done;
1990 })->prio (1); 2373 })->prio (1);
1991} 2374}
1992 2375
1993=item $player_object->enter_exit ($exit_object) 2376=item $player_object->enter_exit ($exit_object)
1994 2377
2063 my $hp = $exit->stats->hp; 2446 my $hp = $exit->stats->hp;
2064 my $sp = $exit->stats->sp; 2447 my $sp = $exit->stats->sp;
2065 2448
2066 $self->enter_link; 2449 $self->enter_link;
2067 2450
2451 # if exit is damned, update players death & WoR home-position
2452 $self->contr->savebed ($slaying, $hp, $sp)
2453 if $exit->flag (FLAG_DAMNED);
2454
2068 (async { 2455 (async {
2069 $self->deactivate_recursive; # just to be sure 2456 $self->deactivate_recursive; # just to be sure
2070 unless (eval { 2457 unless (eval {
2071 $self->goto ($slaying, $hp, $sp); 2458 $self->goto ($slaying, $hp, $sp);
2072 2459
2099 2486
2100 utf8::encode $text; 2487 utf8::encode $text;
2101 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2488 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2102} 2489}
2103 2490
2491=item $client->send_msg ($channel, $msg, $color, [extra...])
2492
2493Send a drawinfo or msg packet to the client, formatting the msg for the
2494client if neccessary. C<$type> should be a string identifying the type of
2495the message, with C<log> being the default. If C<$color> is negative, suppress
2496the message unless the client supports the msg packet.
2497
2498=cut
2499
2500sub cf::client::send_msg {
2501 my ($self, $channel, $msg, $color, @extra) = @_;
2502
2503 $msg = $self->pl->expand_cfpod ($msg);
2504
2505 $color &= cf::NDI_CLIENT_MASK; # just in case...
2506
2507 if (ref $channel) {
2508 # send meta info to client, if not yet sent
2509 unless (exists $self->{channel}{$channel->{id}}) {
2510 $self->{channel}{$channel->{id}} = $channel;
2511 $self->ext_msg (channel_info => $channel);
2512 }
2513
2514 $channel = $channel->{id};
2515 }
2516
2517 return unless @extra || length $msg;
2518
2519 if ($self->can_msg) {
2520 # default colour, mask it out
2521 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2522 if $color & cf::NDI_DEF;
2523
2524 $self->send_packet ("msg " . $self->{json_coder}->encode (
2525 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2526 } else {
2527 if ($color >= 0) {
2528 # replace some tags by gcfclient-compatible ones
2529 for ($msg) {
2530 1 while
2531 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2532 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2533 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2534 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2535 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2536 }
2537
2538 $color &= cf::NDI_COLOR_MASK;
2539
2540 utf8::encode $msg;
2541
2542 if (0 && $msg =~ /\[/) {
2543 # COMMAND/INFO
2544 $self->send_packet ("drawextinfo $color 10 8 $msg")
2545 } else {
2546 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2547 $self->send_packet ("drawinfo $color $msg")
2548 }
2549 }
2550 }
2551}
2552
2104=item $client->ext_event ($type, %msg) 2553=item $client->ext_msg ($type, @msg)
2105 2554
2106Sends an exti event to the client. 2555Sends an ext event to the client.
2107 2556
2108=cut 2557=cut
2109 2558
2110sub cf::client::ext_event($$%) { 2559sub cf::client::ext_msg($$@) {
2111 my ($self, $type, %msg) = @_; 2560 my ($self, $type, @msg) = @_;
2112 2561
2562 my $extcmd = $self->extcmd;
2563
2564 if ($extcmd == 2) {
2565 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2566 } elsif ($extcmd == 1) { # TODO: remove
2113 $msg{msgtype} = "event_$type"; 2567 push @msg, msgtype => "event_$type";
2114 $self->send_packet ("ext " . cf::to_json \%msg); 2568 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2569 }
2115} 2570}
2116 2571
2117=item $success = $client->query ($flags, "text", \&cb) 2572=item $success = $client->query ($flags, "text", \&cb)
2118 2573
2119Queues a query to the client, calling the given callback with 2574Queues a query to the client, calling the given callback with
2120the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2575the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2121C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2576C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2122 2577
2123Queries can fail, so check the return code. Or don't, as queries will become 2578Queries can fail, so check the return code. Or don't, as queries will
2124reliable at some point in the future. 2579become reliable at some point in the future.
2125 2580
2126=cut 2581=cut
2127 2582
2128sub cf::client::query { 2583sub cf::client::query {
2129 my ($self, $flags, $text, $cb) = @_; 2584 my ($self, $flags, $text, $cb) = @_;
2137 utf8::encode $text; 2592 utf8::encode $text;
2138 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2593 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139 2594
2140 $self->send_packet ($self->{query_queue}[0][0]) 2595 $self->send_packet ($self->{query_queue}[0][0])
2141 if @{ $self->{query_queue} } == 1; 2596 if @{ $self->{query_queue} } == 1;
2597
2598 1
2142} 2599}
2143 2600
2144cf::client->attach ( 2601cf::client->attach (
2602 on_connect => sub {
2603 my ($ns) = @_;
2604
2605 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2606 },
2145 on_reply => sub { 2607 on_reply => sub {
2146 my ($ns, $msg) = @_; 2608 my ($ns, $msg) = @_;
2147 2609
2148 # this weird shuffling is so that direct followup queries 2610 # this weird shuffling is so that direct followup queries
2149 # get handled first 2611 # get handled first
2161 } else { 2623 } else {
2162 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2624 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163 } 2625 }
2164 } 2626 }
2165 }, 2627 },
2628 on_exticmd => sub {
2629 my ($ns, $buf) = @_;
2630
2631 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2632
2633 if (ref $msg) {
2634 my ($type, $reply, @payload) =
2635 "ARRAY" eq ref $msg
2636 ? @$msg
2637 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2638
2639 if (my $cb = $EXTICMD{$type}) {
2640 my @reply = $cb->($ns, @payload);
2641
2642 $ns->ext_reply ($reply, @reply)
2643 if $reply;
2644 }
2645 } else {
2646 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2647 }
2648
2649 cf::override;
2650 },
2166); 2651);
2167 2652
2168=item $client->async (\&cb) 2653=item $client->async (\&cb)
2169 2654
2170Create a new coroutine, running the specified callback. The coroutine will 2655Create a new coroutine, running the specified callback. The coroutine will
2211our $safe = new Safe "safe"; 2696our $safe = new Safe "safe";
2212our $safe_hole = new Safe::Hole; 2697our $safe_hole = new Safe::Hole;
2213 2698
2214$SIG{FPE} = 'IGNORE'; 2699$SIG{FPE} = 'IGNORE';
2215 2700
2216$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2701$safe->permit_only (Opcode::opset qw(
2702 :base_core :base_mem :base_orig :base_math
2703 grepstart grepwhile mapstart mapwhile
2704 sort time
2705));
2217 2706
2218# here we export the classes and methods available to script code 2707# here we export the classes and methods available to script code
2219 2708
2220=pod 2709=pod
2221 2710
2222The following functions and methods are available within a safe environment: 2711The following functions and methods are available within a safe environment:
2223 2712
2224 cf::object contr pay_amount pay_player map 2713 cf::object
2714 contr pay_amount pay_player map x y force_find force_add
2715 insert remove name archname title slaying race
2716
2225 cf::object::player player 2717 cf::object::player
2226 cf::player peaceful 2718 player
2227 cf::map trigger 2719
2720 cf::player
2721 peaceful
2722
2723 cf::map
2724 trigger
2228 2725
2229=cut 2726=cut
2230 2727
2231for ( 2728for (
2232 ["cf::object" => qw(contr pay_amount pay_player map)], 2729 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2730 insert remove inv name archname title slaying race)],
2233 ["cf::object::player" => qw(player)], 2731 ["cf::object::player" => qw(player)],
2234 ["cf::player" => qw(peaceful)], 2732 ["cf::player" => qw(peaceful)],
2235 ["cf::map" => qw(trigger)], 2733 ["cf::map" => qw(trigger)],
2236) { 2734) {
2237 no strict 'refs'; 2735 no strict 'refs';
2308=back 2806=back
2309 2807
2310=cut 2808=cut
2311 2809
2312############################################################################# 2810#############################################################################
2313
2314=head2 EXTENSION DATABASE SUPPORT
2315
2316Crossfire maintains a very simple database for extension use. It can
2317currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2318convert to/from binary).
2319
2320The parameter C<$family> should best start with the name of the extension
2321using it, it should be unique.
2322
2323=over 4
2324
2325=item $value = cf::db_get $family => $key
2326
2327Returns a single value from the database.
2328
2329=item cf::db_put $family => $key => $value
2330
2331Stores the given C<$value> in the family.
2332
2333=cut
2334
2335our $DB;
2336
2337sub db_init {
2338 unless ($DB) {
2339 $DB = BDB::db_create $DB_ENV;
2340
2341 cf::sync_job {
2342 eval {
2343 $DB->set_flags (BDB::CHKSUM);
2344
2345 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2346 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2347 cf::cleanup "db_open(db): $!" if $!;
2348 };
2349 cf::cleanup "db_open(db): $@" if $@;
2350 };
2351 }
2352}
2353
2354sub db_get($$) {
2355 my $key = "$_[0]/$_[1]";
2356
2357 cf::sync_job {
2358 BDB::db_get $DB, undef, $key, my $data;
2359
2360 $! ? ()
2361 : $data
2362 }
2363}
2364
2365sub db_put($$$) {
2366 BDB::dbreq_pri 4;
2367 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2368}
2369
2370=item cf::cache $id => [$paths...], $processversion => $process
2371
2372Generic caching function that returns the value of the resource $id,
2373caching and regenerating as required.
2374
2375This function can block.
2376
2377=cut
2378
2379sub cache {
2380 my ($id, $src, $processversion, $process) = @_;
2381
2382 my $meta =
2383 join "\x00",
2384 $processversion,
2385 map {
2386 aio_stat $_
2387 and Carp::croak "$_: $!";
2388
2389 ($_, (stat _)[7,9])
2390 } @$src;
2391
2392 my $dbmeta = db_get cache => "$id/meta";
2393 if ($dbmeta ne $meta) {
2394 # changed, we may need to process
2395
2396 my @data;
2397 my $md5;
2398
2399 for (0 .. $#$src) {
2400 0 <= aio_load $src->[$_], $data[$_]
2401 or Carp::croak "$src->[$_]: $!";
2402 }
2403
2404 # if processing is expensive, check
2405 # checksum first
2406 if (1) {
2407 $md5 =
2408 join "\x00",
2409 $processversion,
2410 map {
2411 Coro::cede;
2412 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2413 } 0.. $#$src;
2414
2415
2416 my $dbmd5 = db_get cache => "$id/md5";
2417 if ($dbmd5 eq $md5) {
2418 db_put cache => "$id/meta", $meta;
2419
2420 return db_get cache => "$id/data";
2421 }
2422 }
2423
2424 my $t1 = Time::HiRes::time;
2425 my $data = $process->(\@data);
2426 my $t2 = Time::HiRes::time;
2427
2428 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2429
2430 db_put cache => "$id/data", $data;
2431 db_put cache => "$id/md5" , $md5;
2432 db_put cache => "$id/meta", $meta;
2433
2434 return $data;
2435 }
2436
2437 db_get cache => "$id/data"
2438}
2439
2440=item fork_call { }, $args
2441
2442Executes the given code block with the given arguments in a seperate
2443process, returning the results. Everything must be serialisable with
2444Coro::Storable. May, of course, block. Note that the executed sub may
2445never block itself or use any form of Event handling.
2446
2447=cut
2448
2449sub fork_call(&@) {
2450 my ($cb, @args) = @_;
2451
2452# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2453# or die "socketpair: $!";
2454 pipe my $fh1, my $fh2
2455 or die "pipe: $!";
2456
2457 if (my $pid = fork) {
2458 close $fh2;
2459
2460 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2461 $res = Coro::Storable::thaw $res;
2462
2463 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2464
2465 die $$res unless "ARRAY" eq ref $res;
2466
2467 return wantarray ? @$res : $res->[-1];
2468 } else {
2469 reset_signals;
2470 local $SIG{__WARN__};
2471 local $SIG{__DIE__};
2472 eval {
2473 close $fh1;
2474
2475 my @res = eval { $cb->(@args) };
2476 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2477 };
2478
2479 warn $@ if $@;
2480 _exit 0;
2481 }
2482}
2483
2484#############################################################################
2485# the server's init and main functions 2811# the server's init and main functions
2486 2812
2487sub load_facedata($) { 2813sub load_facedata($) {
2488 my ($path) = @_; 2814 my ($path) = @_;
2815
2816 my $enc = JSON::XS->new->utf8->canonical;
2489 2817
2490 warn "loading facedata from $path\n"; 2818 warn "loading facedata from $path\n";
2491 2819
2492 my $facedata; 2820 my $facedata;
2493 0 < aio_load $path, $facedata 2821 0 < aio_load $path, $facedata
2496 $facedata = Coro::Storable::thaw $facedata; 2824 $facedata = Coro::Storable::thaw $facedata;
2497 2825
2498 $facedata->{version} == 2 2826 $facedata->{version} == 2
2499 or cf::cleanup "$path: version mismatch, cannot proceed."; 2827 or cf::cleanup "$path: version mismatch, cannot proceed.";
2500 2828
2829 # patch in the exptable
2830 $facedata->{resource}{"res/exp_table"} = {
2831 type => FT_RSRC,
2832 data => $enc->encode ([map cf::level_to_min_exp $_, 0 .. cf::settings->max_level]),
2833 };
2834 cf::cede_to_tick;
2835
2501 { 2836 {
2502 my $faces = $facedata->{faceinfo}; 2837 my $faces = $facedata->{faceinfo};
2503 2838
2504 while (my ($face, $info) = each %$faces) { 2839 while (my ($face, $info) = each %$faces) {
2505 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2840 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2506 warn "$face $info->{magicmap}\n" if $face =~ /obol/;#d#
2507 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2841 cf::face::set_visibility $idx, $info->{visibility};
2842 cf::face::set_magicmap $idx, $info->{magicmap};
2508 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2843 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2509 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2844 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2510 Coro::cede; 2845
2846 cf::cede_to_tick;
2511 } 2847 }
2512 2848
2513 while (my ($face, $info) = each %$faces) { 2849 while (my ($face, $info) = each %$faces) {
2514 next unless $info->{smooth}; 2850 next unless $info->{smooth};
2515 my $idx = cf::face::find $face 2851 my $idx = cf::face::find $face
2516 or next; 2852 or next;
2517 if (my $smooth = cf::face::find $info->{smooth}) { 2853 if (my $smooth = cf::face::find $info->{smooth}) {
2854 cf::face::set_smooth $idx, $smooth;
2518 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2855 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2519 } else { 2856 } else {
2520 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2857 warn "smooth face '$info->{smooth}' not found for face '$face'";
2521 } 2858 }
2522 Coro::cede; 2859
2860 cf::cede_to_tick;
2523 } 2861 }
2524 } 2862 }
2525 2863
2526 { 2864 {
2527 my $anims = $facedata->{animinfo}; 2865 my $anims = $facedata->{animinfo};
2528 2866
2529 while (my ($anim, $info) = each %$anims) { 2867 while (my ($anim, $info) = each %$anims) {
2530 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2868 cf::anim::set $anim, $info->{frames}, $info->{facings};
2531 Coro::cede; 2869 cf::cede_to_tick;
2532 } 2870 }
2533 2871
2534 cf::anim::invalidate_all; # d'oh 2872 cf::anim::invalidate_all; # d'oh
2535 } 2873 }
2536 2874
2875 {
2876 # TODO: for gcfclient pleasure, we should give resources
2877 # that gcfclient doesn't grok a >10000 face index.
2878 my $res = $facedata->{resource};
2879
2880 my $soundconf = delete $res->{"res/sound.conf"};
2881
2882 while (my ($name, $info) = each %$res) {
2883 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2884 my $data;
2885
2886 if ($info->{type} & 1) {
2887 # prepend meta info
2888
2889 my $meta = $enc->encode ({
2890 name => $name,
2891 %{ $info->{meta} || {} },
2892 });
2893
2894 $data = pack "(w/a*)*", $meta, $info->{data};
2895 }
2896
2897 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2898 cf::face::set_type $idx, $info->{type};
2899
2900 cf::cede_to_tick;
2901 }
2902
2903 if ($soundconf) {
2904 $soundconf = $enc->decode (delete $soundconf->{data});
2905
2906 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2907 my $sound = $soundconf->{compat}[$_]
2908 or next;
2909
2910 my $face = cf::face::find "sound/$sound->[1]";
2911 cf::sound::set $sound->[0] => $face;
2912 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2913 }
2914
2915 while (my ($k, $v) = each %{$soundconf->{event}}) {
2916 my $face = cf::face::find "sound/$v";
2917 cf::sound::set $k => $face;
2918 }
2919 }
2920 }
2921
2537 1 2922 1
2538} 2923}
2924
2925register_exticmd fx_want => sub {
2926 my ($ns, $want) = @_;
2927
2928 while (my ($k, $v) = each %$want) {
2929 $ns->fx_want ($k, $v);
2930 }
2931};
2539 2932
2540sub reload_regions { 2933sub reload_regions {
2541 load_resource_file "$MAPDIR/regions" 2934 load_resource_file "$MAPDIR/regions"
2542 or die "unable to load regions file\n"; 2935 or die "unable to load regions file\n";
2936
2937 for (cf::region::list) {
2938 $_->{match} = qr/$_->{match}/
2939 if exists $_->{match};
2940 }
2543} 2941}
2544 2942
2545sub reload_facedata { 2943sub reload_facedata {
2546 load_facedata "$DATADIR/facedata" 2944 load_facedata "$DATADIR/facedata"
2547 or die "unable to load facedata\n"; 2945 or die "unable to load facedata\n";
2548} 2946}
2549 2947
2550sub reload_archetypes { 2948sub reload_archetypes {
2551 load_resource_file "$DATADIR/archetypes" 2949 load_resource_file "$DATADIR/archetypes"
2552 or die "unable to load archetypes\n"; 2950 or die "unable to load archetypes\n";
2951 #d# NEED to laod twice to resolve forward references
2952 # this really needs to be done in an extra post-pass
2953 # (which needs to be synchronous, so solve it differently)
2954 load_resource_file "$DATADIR/archetypes"
2955 or die "unable to load archetypes\n";
2553} 2956}
2554 2957
2555sub reload_treasures { 2958sub reload_treasures {
2556 load_resource_file "$DATADIR/treasures" 2959 load_resource_file "$DATADIR/treasures"
2557 or die "unable to load treasurelists\n"; 2960 or die "unable to load treasurelists\n";
2560sub reload_resources { 2963sub reload_resources {
2561 warn "reloading resource files...\n"; 2964 warn "reloading resource files...\n";
2562 2965
2563 reload_regions; 2966 reload_regions;
2564 reload_facedata; 2967 reload_facedata;
2968 #reload_archetypes;#d#
2565 reload_archetypes; 2969 reload_archetypes;
2566 reload_treasures; 2970 reload_treasures;
2567 2971
2568 warn "finished reloading resource files\n"; 2972 warn "finished reloading resource files\n";
2569} 2973}
2626 }, 3030 },
2627 ); 3031 );
2628 } 3032 }
2629} 3033}
2630 3034
3035sub write_runtime {
3036 my $runtime = "$LOCALDIR/runtime";
3037
3038 # first touch the runtime file to show we are still running:
3039 # the fsync below can take a very very long time.
3040
3041 IO::AIO::aio_utime $runtime, undef, undef;
3042
3043 my $guard = cf::lock_acquire "write_runtime";
3044
3045 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3046 or return;
3047
3048 my $value = $cf::RUNTIME + 90 + 10;
3049 # 10 is the runtime save interval, for a monotonic clock
3050 # 60 allows for the watchdog to kill the server.
3051
3052 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3053 and return;
3054
3055 # always fsync - this file is important
3056 aio_fsync $fh
3057 and return;
3058
3059 # touch it again to show we are up-to-date
3060 aio_utime $fh, undef, undef;
3061
3062 close $fh
3063 or return;
3064
3065 aio_rename "$runtime~", $runtime
3066 and return;
3067
3068 warn "runtime file written.\n";
3069
3070 1
3071}
3072
2631sub emergency_save() { 3073sub emergency_save() {
2632 my $freeze_guard = cf::freeze_mainloop; 3074 my $freeze_guard = cf::freeze_mainloop;
2633 3075
2634 warn "enter emergency perl save\n"; 3076 warn "enter emergency perl save\n";
2635 3077
2710 %EXT_CORO = (); 3152 %EXT_CORO = ();
2711 3153
2712 warn "removing commands"; 3154 warn "removing commands";
2713 %COMMAND = (); 3155 %COMMAND = ();
2714 3156
2715 warn "removing ext commands"; 3157 warn "removing ext/exti commands";
2716 %EXTCMD = (); 3158 %EXTCMD = ();
3159 %EXTICMD = ();
2717 3160
2718 warn "unloading/nuking all extensions"; 3161 warn "unloading/nuking all extensions";
2719 for my $pkg (@EXTS) { 3162 for my $pkg (@EXTS) {
2720 warn "... unloading $pkg"; 3163 warn "... unloading $pkg";
2721 3164

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines