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.271 by root, Fri Jun 1 06:04:08 2007 UTC vs.
Revision 1.336 by root, Tue Aug 21 00:31:18 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 $self->ns->ext_reply ($id, @msg)
1199
1200 $self->send ("ext " . cf::to_json \%msg);
1201} 1511}
1202 1512
1203=item $player->ext_event ($type, %msg) 1513=item $player->ext_msg ($type, @msg)
1204 1514
1205Sends an ext event to the client. 1515Sends an ext event to the client.
1206 1516
1207=cut 1517=cut
1208 1518
1209sub ext_event($$%) { 1519sub ext_msg($$@) {
1210 my ($self, $type, %msg) = @_; 1520 my ($self, $type, @msg) = @_;
1211 1521
1212 $self->ns->ext_event ($type, %msg); 1522 $self->ns->ext_msg ($type, @msg);
1213} 1523}
1214 1524
1215=head3 cf::region 1525=head3 cf::region
1216 1526
1217=over 4 1527=over 4
1220 1530
1221package cf::region; 1531package cf::region;
1222 1532
1223=item cf::region::find_by_path $path 1533=item cf::region::find_by_path $path
1224 1534
1225Tries to decuce the probable region for a map knowing only its path. 1535Tries to decuce the likely region for a map knowing only its path.
1226 1536
1227=cut 1537=cut
1228 1538
1229sub find_by_path($) { 1539sub find_by_path($) {
1230 my ($path) = @_; 1540 my ($path) = @_;
1231 1541
1232 my ($match, $specificity); 1542 my ($match, $specificity);
1233 1543
1234 for my $region (list) { 1544 for my $region (list) {
1235 if ($region->match && $path =~ $region->match) { 1545 if ($region->{match} && $path =~ $region->{match}) {
1236 ($match, $specificity) = ($region, $region->specificity) 1546 ($match, $specificity) = ($region, $region->specificity)
1237 if $region->specificity > $specificity; 1547 if $region->specificity > $specificity;
1238 } 1548 }
1239 } 1549 }
1240 1550
1304 my ($self, $merge) = @_; 1614 my ($self, $merge) = @_;
1305 1615
1306 # we have to keep some variables in memory intact 1616 # we have to keep some variables in memory intact
1307 local $self->{path}; 1617 local $self->{path};
1308 local $self->{load_path}; 1618 local $self->{load_path};
1309 local $self->{deny_save};
1310 local $self->{deny_reset};
1311 1619
1312 $self->SUPER::thawer_merge ($merge); 1620 $self->SUPER::thawer_merge ($merge);
1313} 1621}
1314 1622
1315sub normalise { 1623sub normalise {
1362 $self->init; # pass $1 etc. 1670 $self->init; # pass $1 etc.
1363 return $self; 1671 return $self;
1364 } 1672 }
1365 } 1673 }
1366 1674
1367 Carp::carp "unable to resolve path '$path' (base '$base')."; 1675 Carp::cluck "unable to resolve path '$path' (base '$base').";
1368 () 1676 ()
1369} 1677}
1370 1678
1371sub init { 1679sub init {
1372 my ($self) = @_; 1680 my ($self) = @_;
1413sub change_all_map_light { 1721sub change_all_map_light {
1414 my ($change) = @_; 1722 my ($change) = @_;
1415 1723
1416 $_->change_map_light ($change) 1724 $_->change_map_light ($change)
1417 for grep $_->outdoor, values %cf::MAP; 1725 for grep $_->outdoor, values %cf::MAP;
1726}
1727
1728sub decay_objects {
1729 my ($self) = @_;
1730
1731 return if $self->{deny_reset};
1732
1733 $self->do_decay_objects;
1418} 1734}
1419 1735
1420sub unlink_save { 1736sub unlink_save {
1421 my ($self) = @_; 1737 my ($self) = @_;
1422 1738
1480 $self->load_header_orig 1796 $self->load_header_orig
1481 or return; 1797 or return;
1482 $self->prepare_orig; 1798 $self->prepare_orig;
1483 } 1799 }
1484 1800
1801 $self->{deny_reset} = 1
1802 if $self->no_reset;
1803
1485 $self->default_region (cf::region::find_by_path $self->{path}) 1804 $self->default_region (cf::region::find_by_path $self->{path})
1486 unless $self->default_region; 1805 unless $self->default_region;
1487 1806
1488 1 1807 1
1489} 1808}
1504 $map->{last_save} = $cf::RUNTIME; 1823 $map->{last_save} = $cf::RUNTIME;
1505 1824
1506 $map->load_header 1825 $map->load_header
1507 or return; 1826 or return;
1508 1827
1509 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1828 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1510 # doing this can freeze the server in a sync job, obviously 1829 # doing this can freeze the server in a sync job, obviously
1511 #$cf::WAIT_FOR_TICK->wait; 1830 #$cf::WAIT_FOR_TICK->wait;
1512 $map->reset; 1831 $map->reset;
1513 undef $guard; 1832 undef $guard;
1514 return find $path; 1833 return find $path;
1569 $self->set_darkness_map; 1888 $self->set_darkness_map;
1570 Coro::cede; 1889 Coro::cede;
1571 $self->activate; 1890 $self->activate;
1572 } 1891 }
1573 1892
1893 $self->{last_save} = $cf::RUNTIME;
1894 $self->last_access ($cf::RUNTIME);
1895
1574 $self->in_memory (cf::MAP_IN_MEMORY); 1896 $self->in_memory (cf::MAP_IN_MEMORY);
1575 } 1897 }
1576 1898
1577 $self->post_load; 1899 $self->post_load;
1578} 1900}
1581 my ($self, $ob) = @_; 1903 my ($self, $ob) = @_;
1582 1904
1583 return find "~" . $ob->name . "/" . $self->{path} 1905 return find "~" . $ob->name . "/" . $self->{path}
1584 if $self->per_player; 1906 if $self->per_player;
1585 1907
1908# return find "?party/" . $ob->name . "/" . $self->{path}
1909# if $self->per_party;
1910
1586 $self 1911 $self
1587} 1912}
1588 1913
1589# find and load all maps in the 3x3 area around a map 1914# find and load all maps in the 3x3 area around a map
1590sub load_diag { 1915sub load_neighbours {
1591 my ($map) = @_; 1916 my ($map) = @_;
1592 1917
1593 my @diag; # diagonal neighbours 1918 my @neigh; # diagonal neighbours
1594 1919
1595 for (0 .. 3) { 1920 for (0 .. 3) {
1596 my $neigh = $map->tile_path ($_) 1921 my $neigh = $map->tile_path ($_)
1597 or next; 1922 or next;
1598 $neigh = find $neigh, $map 1923 $neigh = find $neigh, $map
1599 or next; 1924 or next;
1600 $neigh->load; 1925 $neigh->load;
1601 1926
1927 push @neigh,
1602 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1928 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1603 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1929 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1604 } 1930 }
1605 1931
1606 for (@diag) { 1932 for (grep defined $_->[0], @neigh) {
1933 my ($path, $origin) = @$_;
1607 my $neigh = find @$_ 1934 my $neigh = find $path, $origin
1608 or next; 1935 or next;
1609 $neigh->load; 1936 $neigh->load;
1610 } 1937 }
1611} 1938}
1612 1939
1636 1963
1637 undef $MAP_PREFETCH{$path}; 1964 undef $MAP_PREFETCH{$path};
1638 $MAP_PREFETCHER ||= cf::async { 1965 $MAP_PREFETCHER ||= cf::async {
1639 while (%MAP_PREFETCH) { 1966 while (%MAP_PREFETCH) {
1640 for my $path (keys %MAP_PREFETCH) { 1967 for my $path (keys %MAP_PREFETCH) {
1641 my $map = find $path 1968 if (my $map = find $path) {
1642 or next;
1643 $map->load; 1969 $map->load;
1970 }
1644 1971
1645 delete $MAP_PREFETCH{$path}; 1972 delete $MAP_PREFETCH{$path};
1646 } 1973 }
1647 } 1974 }
1648 undef $MAP_PREFETCHER; 1975 undef $MAP_PREFETCHER;
1700 2027
1701sub reset_at { 2028sub reset_at {
1702 my ($self) = @_; 2029 my ($self) = @_;
1703 2030
1704 # TODO: safety, remove and allow resettable per-player maps 2031 # 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}; 2032 return 1e99 if $self->{deny_reset};
1707 2033
1708 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2034 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1709 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2035 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1710 2036
1721 my ($self) = @_; 2047 my ($self) = @_;
1722 2048
1723 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2049 my $lock = cf::lock_acquire "map_data:$self->{path}";
1724 2050
1725 return if $self->players; 2051 return if $self->players;
1726 return if $self->isa ("ext::map_per_player");#d#
1727 2052
1728 warn "resetting map ", $self->path;#d# 2053 warn "resetting map ", $self->path;
1729 2054
1730 $self->in_memory (cf::MAP_SWAPPED); 2055 $self->in_memory (cf::MAP_SWAPPED);
1731 2056
1732 # need to save uniques path 2057 # need to save uniques path
1733 unless ($self->{deny_save}) { 2058 unless ($self->{deny_save}) {
1765 $cf::MAP{$self->path} = $self; 2090 $cf::MAP{$self->path} = $self;
1766 2091
1767 $self->reset; # polite request, might not happen 2092 $self->reset; # polite request, might not happen
1768} 2093}
1769 2094
2095=item $maps = cf::map::tmp_maps
2096
2097Returns an arrayref with all map paths of currently instantiated and saved
2098maps. May block.
2099
2100=cut
2101
2102sub tmp_maps() {
2103 [
2104 map {
2105 utf8::decode $_;
2106 /\.map$/
2107 ? normalise $_
2108 : ()
2109 } @{ aio_readdir $TMPDIR or [] }
2110 ]
2111}
2112
2113=item $maps = cf::map::random_maps
2114
2115Returns an arrayref with all map paths of currently instantiated and saved
2116random maps. May block.
2117
2118=cut
2119
2120sub random_maps() {
2121 [
2122 map {
2123 utf8::decode $_;
2124 /\.map$/
2125 ? normalise "?random/$_"
2126 : ()
2127 } @{ aio_readdir $RANDOMDIR or [] }
2128 ]
2129}
2130
1770=item cf::map::unique_maps 2131=item cf::map::unique_maps
1771 2132
1772Returns an arrayref of paths of all shared maps that have 2133Returns an arrayref of paths of all shared maps that have
1773instantiated unique items. May block. 2134instantiated unique items. May block.
1774 2135
1775=cut 2136=cut
1776 2137
1777sub unique_maps() { 2138sub unique_maps() {
1778 my $files = aio_readdir $UNIQUEDIR 2139 [
1779 or return; 2140 map {
1780
1781 my @paths;
1782
1783 for (@$files) {
1784 utf8::decode $_; 2141 utf8::decode $_;
1785 next if /\.pst$/; 2142 /\.map$/
1786 next unless /^$PATH_SEP/o; 2143 ? normalise $_
1787 2144 : ()
1788 push @paths, cf::map::normalise $_; 2145 } @{ aio_readdir $UNIQUEDIR or [] }
1789 } 2146 ]
1790
1791 \@paths
1792} 2147}
1793 2148
1794package cf; 2149package cf;
1795 2150
1796=back 2151=back
1842 2197
1843 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2198 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1844 2199
1845 if ($self->{record_replies}) { 2200 if ($self->{record_replies}) {
1846 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2201 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2202
1847 } else { 2203 } else {
2204 my $pl = $self->contr;
2205
2206 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2207 my $dialog = $pl->{npc_dialog};
2208 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2209
2210 } else {
1848 $msg = $npc->name . " says: $msg" if $npc; 2211 $msg = $npc->name . " says: $msg" if $npc;
1849 $self->message ($msg, $flags); 2212 $self->message ($msg, $flags);
2213 }
1850 } 2214 }
2215}
2216
2217=item $object->send_msg ($channel, $msg, $color, [extra...])
2218
2219=cut
2220
2221sub cf::object::send_msg {
2222 my $pl = shift->contr
2223 or return;
2224 $pl->send_msg (@_);
1851} 2225}
1852 2226
1853=item $player_object->may ("access") 2227=item $player_object->may ("access")
1854 2228
1855Returns wether the given player is authorized to access resource "access" 2229Returns wether the given player is authorized to access resource "access"
1934 # use -1 or undef as default coordinates, not 0, 0 2308 # use -1 or undef as default coordinates, not 0, 0
1935 ($x, $y) = ($map->enter_x, $map->enter_y) 2309 ($x, $y) = ($map->enter_x, $map->enter_y)
1936 if $x <=0 && $y <= 0; 2310 if $x <=0 && $y <= 0;
1937 2311
1938 $map->load; 2312 $map->load;
1939 $map->load_diag; 2313 $map->load_neighbours;
1940 2314
1941 return unless $self->contr->active; 2315 return unless $self->contr->active;
1942 $self->activate_recursive; 2316 $self->activate_recursive;
1943 2317
1944 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2318 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945 $self->enter_map ($map, $x, $y); 2319 $self->enter_map ($map, $x, $y);
1946} 2320}
1947 2321
1948=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2322=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1949 2323
1950Moves the player to the given map-path and coordinates by first freezing 2324Moves the player to the given map-path and coordinates by first freezing
1951her, loading and preparing them map, calling the provided $check callback 2325her, loading and preparing them map, calling the provided $check callback
1952that has to return the map if sucecssful, and then unfreezes the player on 2326that has to return the map if sucecssful, and then unfreezes the player on
1953the new (success) or old (failed) map position. 2327the new (success) or old (failed) map position. In either case, $done will
2328be called at the end of this process.
1954 2329
1955=cut 2330=cut
1956 2331
1957our $GOTOGEN; 2332our $GOTOGEN;
1958 2333
1959sub cf::object::player::goto { 2334sub cf::object::player::goto {
1960 my ($self, $path, $x, $y, $check) = @_; 2335 my ($self, $path, $x, $y, $check, $done) = @_;
1961 2336
1962 # do generation counting so two concurrent goto's will be executed in-order 2337 # do generation counting so two concurrent goto's will be executed in-order
1963 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2338 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1964 2339
1965 $self->enter_link; 2340 $self->enter_link;
1985 2360
1986 if ($gen == $self->{_goto_generation}) { 2361 if ($gen == $self->{_goto_generation}) {
1987 delete $self->{_goto_generation}; 2362 delete $self->{_goto_generation};
1988 $self->leave_link ($map, $x, $y); 2363 $self->leave_link ($map, $x, $y);
1989 } 2364 }
2365
2366 $done->() if $done;
1990 })->prio (1); 2367 })->prio (1);
1991} 2368}
1992 2369
1993=item $player_object->enter_exit ($exit_object) 2370=item $player_object->enter_exit ($exit_object)
1994 2371
2063 my $hp = $exit->stats->hp; 2440 my $hp = $exit->stats->hp;
2064 my $sp = $exit->stats->sp; 2441 my $sp = $exit->stats->sp;
2065 2442
2066 $self->enter_link; 2443 $self->enter_link;
2067 2444
2445 # if exit is damned, update players death & WoR home-position
2446 $self->contr->savebed ($slaying, $hp, $sp)
2447 if $exit->flag (FLAG_DAMNED);
2448
2068 (async { 2449 (async {
2069 $self->deactivate_recursive; # just to be sure 2450 $self->deactivate_recursive; # just to be sure
2070 unless (eval { 2451 unless (eval {
2071 $self->goto ($slaying, $hp, $sp); 2452 $self->goto ($slaying, $hp, $sp);
2072 2453
2099 2480
2100 utf8::encode $text; 2481 utf8::encode $text;
2101 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2482 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2102} 2483}
2103 2484
2485=item $client->send_msg ($channel, $msg, $color, [extra...])
2486
2487Send a drawinfo or msg packet to the client, formatting the msg for the
2488client if neccessary. C<$type> should be a string identifying the type of
2489the message, with C<log> being the default. If C<$color> is negative, suppress
2490the message unless the client supports the msg packet.
2491
2492=cut
2493
2494sub cf::client::send_msg {
2495 my ($self, $channel, $msg, $color, @extra) = @_;
2496
2497 $msg = $self->pl->expand_cfpod ($msg);
2498
2499 $color &= cf::NDI_CLIENT_MASK; # just in case...
2500
2501 if (ref $channel) {
2502 # send meta info to client, if not yet sent
2503 unless (exists $self->{channel}{$channel->{id}}) {
2504 $self->{channel}{$channel->{id}} = $channel;
2505 $self->ext_msg (channel_info => $channel);
2506 }
2507
2508 $channel = $channel->{id};
2509 }
2510
2511 return unless @extra || length $msg;
2512
2513 if ($self->can_msg) {
2514 # default colour, mask it out
2515 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2516 if $color & cf::NDI_DEF;
2517
2518 $self->send_packet ("msg " . $self->{json_coder}->encode (
2519 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2520 } else {
2521 if ($color >= 0) {
2522 # replace some tags by gcfclient-compatible ones
2523 for ($msg) {
2524 1 while
2525 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2526 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2527 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2528 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2529 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2530 }
2531
2532 $color &= cf::NDI_COLOR_MASK;
2533
2534 utf8::encode $msg;
2535
2536 if (0 && $msg =~ /\[/) {
2537 # COMMAND/INFO
2538 $self->send_packet ("drawextinfo $color 10 8 $msg")
2539 } else {
2540 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2541 $self->send_packet ("drawinfo $color $msg")
2542 }
2543 }
2544 }
2545}
2546
2104=item $client->ext_event ($type, %msg) 2547=item $client->ext_msg ($type, @msg)
2105 2548
2106Sends an exti event to the client. 2549Sends an ext event to the client.
2107 2550
2108=cut 2551=cut
2109 2552
2110sub cf::client::ext_event($$%) { 2553sub cf::client::ext_msg($$@) {
2111 my ($self, $type, %msg) = @_; 2554 my ($self, $type, @msg) = @_;
2112 2555
2556 my $extcmd = $self->extcmd;
2557
2558 if ($extcmd == 2) {
2559 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2560 } elsif ($extcmd == 1) { # TODO: remove
2113 $msg{msgtype} = "event_$type"; 2561 push @msg, msgtype => "event_$type";
2114 $self->send_packet ("ext " . cf::to_json \%msg); 2562 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2563 }
2564}
2565
2566=item $client->ext_reply ($msgid, @msg)
2567
2568Sends an ext reply to the client.
2569
2570=cut
2571
2572sub cf::client::ext_reply($$@) {
2573 my ($self, $id, @msg) = @_;
2574
2575 if ($self->extcmd == 2) {
2576 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2577 } elsif ($self->ns->extcmd == 1) {
2578 #TODO: version 1, remove
2579 unshift @msg, msgtype => "reply", msgid => $id;
2580 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2581 }
2115} 2582}
2116 2583
2117=item $success = $client->query ($flags, "text", \&cb) 2584=item $success = $client->query ($flags, "text", \&cb)
2118 2585
2119Queues a query to the client, calling the given callback with 2586Queues a query to the client, calling the given callback with
2120the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2587the 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>. 2588C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2122 2589
2123Queries can fail, so check the return code. Or don't, as queries will become 2590Queries can fail, so check the return code. Or don't, as queries will
2124reliable at some point in the future. 2591become reliable at some point in the future.
2125 2592
2126=cut 2593=cut
2127 2594
2128sub cf::client::query { 2595sub cf::client::query {
2129 my ($self, $flags, $text, $cb) = @_; 2596 my ($self, $flags, $text, $cb) = @_;
2137 utf8::encode $text; 2604 utf8::encode $text;
2138 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2605 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2139 2606
2140 $self->send_packet ($self->{query_queue}[0][0]) 2607 $self->send_packet ($self->{query_queue}[0][0])
2141 if @{ $self->{query_queue} } == 1; 2608 if @{ $self->{query_queue} } == 1;
2609
2610 1
2142} 2611}
2143 2612
2144cf::client->attach ( 2613cf::client->attach (
2614 on_connect => sub {
2615 my ($ns) = @_;
2616
2617 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2618 },
2145 on_reply => sub { 2619 on_reply => sub {
2146 my ($ns, $msg) = @_; 2620 my ($ns, $msg) = @_;
2147 2621
2148 # this weird shuffling is so that direct followup queries 2622 # this weird shuffling is so that direct followup queries
2149 # get handled first 2623 # get handled first
2161 } else { 2635 } else {
2162 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2636 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2163 } 2637 }
2164 } 2638 }
2165 }, 2639 },
2640 on_exticmd => sub {
2641 my ($ns, $buf) = @_;
2642
2643 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2644
2645 if (ref $msg) {
2646 my ($type, $reply, @payload) =
2647 "ARRAY" eq ref $msg
2648 ? @$msg
2649 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2650
2651 if (my $cb = $EXTICMD{$type}) {
2652 my @reply = $cb->($ns, @payload);
2653
2654 $ns->ext_reply ($reply, @reply)
2655 if $reply;
2656 }
2657 } else {
2658 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2659 }
2660
2661 cf::override;
2662 },
2166); 2663);
2167 2664
2168=item $client->async (\&cb) 2665=item $client->async (\&cb)
2169 2666
2170Create a new coroutine, running the specified callback. The coroutine will 2667Create a new coroutine, running the specified callback. The coroutine will
2211our $safe = new Safe "safe"; 2708our $safe = new Safe "safe";
2212our $safe_hole = new Safe::Hole; 2709our $safe_hole = new Safe::Hole;
2213 2710
2214$SIG{FPE} = 'IGNORE'; 2711$SIG{FPE} = 'IGNORE';
2215 2712
2216$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2713$safe->permit_only (Opcode::opset qw(
2714 :base_core :base_mem :base_orig :base_math
2715 grepstart grepwhile mapstart mapwhile
2716 sort time
2717));
2217 2718
2218# here we export the classes and methods available to script code 2719# here we export the classes and methods available to script code
2219 2720
2220=pod 2721=pod
2221 2722
2222The following functions and methods are available within a safe environment: 2723The following functions and methods are available within a safe environment:
2223 2724
2224 cf::object contr pay_amount pay_player map 2725 cf::object
2726 contr pay_amount pay_player map x y force_find force_add
2727 insert remove name archname title slaying race
2728
2225 cf::object::player player 2729 cf::object::player
2226 cf::player peaceful 2730 player
2227 cf::map trigger 2731
2732 cf::player
2733 peaceful
2734
2735 cf::map
2736 trigger
2228 2737
2229=cut 2738=cut
2230 2739
2231for ( 2740for (
2232 ["cf::object" => qw(contr pay_amount pay_player map)], 2741 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2742 insert remove inv name archname title slaying race)],
2233 ["cf::object::player" => qw(player)], 2743 ["cf::object::player" => qw(player)],
2234 ["cf::player" => qw(peaceful)], 2744 ["cf::player" => qw(peaceful)],
2235 ["cf::map" => qw(trigger)], 2745 ["cf::map" => qw(trigger)],
2236) { 2746) {
2237 no strict 'refs'; 2747 no strict 'refs';
2308=back 2818=back
2309 2819
2310=cut 2820=cut
2311 2821
2312############################################################################# 2822#############################################################################
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 2823# the server's init and main functions
2486 2824
2487sub load_facedata($) { 2825sub load_facedata($) {
2488 my ($path) = @_; 2826 my ($path) = @_;
2827
2828 my $enc = JSON::XS->new->utf8->canonical;
2489 2829
2490 warn "loading facedata from $path\n"; 2830 warn "loading facedata from $path\n";
2491 2831
2492 my $facedata; 2832 my $facedata;
2493 0 < aio_load $path, $facedata 2833 0 < aio_load $path, $facedata
2496 $facedata = Coro::Storable::thaw $facedata; 2836 $facedata = Coro::Storable::thaw $facedata;
2497 2837
2498 $facedata->{version} == 2 2838 $facedata->{version} == 2
2499 or cf::cleanup "$path: version mismatch, cannot proceed."; 2839 or cf::cleanup "$path: version mismatch, cannot proceed.";
2500 2840
2841 # patch in the exptable
2842 $facedata->{resource}{"res/exp_table"} = {
2843 type => FT_RSRC,
2844 data => $enc->encode ([map cf::level_to_min_exp $_, 0 .. cf::settings->max_level]),
2845 };
2846 cf::cede_to_tick;
2847
2501 { 2848 {
2502 my $faces = $facedata->{faceinfo}; 2849 my $faces = $facedata->{faceinfo};
2503 2850
2504 while (my ($face, $info) = each %$faces) { 2851 while (my ($face, $info) = each %$faces) {
2505 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2852 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2506 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2853 cf::face::set_visibility $idx, $info->{visibility};
2854 cf::face::set_magicmap $idx, $info->{magicmap};
2507 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2855 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2508 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2856 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2509 Coro::cede; 2857
2858 cf::cede_to_tick;
2510 } 2859 }
2511 2860
2512 while (my ($face, $info) = each %$faces) { 2861 while (my ($face, $info) = each %$faces) {
2513 next unless $info->{smooth}; 2862 next unless $info->{smooth};
2514 my $idx = cf::face::find $face 2863 my $idx = cf::face::find $face
2515 or next; 2864 or next;
2516 if (my $smooth = cf::face::find $info->{smooth}) { 2865 if (my $smooth = cf::face::find $info->{smooth}) {
2866 cf::face::set_smooth $idx, $smooth;
2517 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2867 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2518 } else { 2868 } else {
2519 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2869 warn "smooth face '$info->{smooth}' not found for face '$face'";
2520 } 2870 }
2521 Coro::cede; 2871
2872 cf::cede_to_tick;
2522 } 2873 }
2523 } 2874 }
2524 2875
2525 { 2876 {
2526 my $anims = $facedata->{animinfo}; 2877 my $anims = $facedata->{animinfo};
2527 2878
2528 while (my ($anim, $info) = each %$anims) { 2879 while (my ($anim, $info) = each %$anims) {
2529 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2880 cf::anim::set $anim, $info->{frames}, $info->{facings};
2530 Coro::cede; 2881 cf::cede_to_tick;
2531 } 2882 }
2532 2883
2533 cf::anim::invalidate_all; # d'oh 2884 cf::anim::invalidate_all; # d'oh
2534 } 2885 }
2535 2886
2887 {
2888 # TODO: for gcfclient pleasure, we should give resources
2889 # that gcfclient doesn't grok a >10000 face index.
2890 my $res = $facedata->{resource};
2891
2892 my $soundconf = delete $res->{"res/sound.conf"};
2893
2894 while (my ($name, $info) = each %$res) {
2895 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2896 my $data;
2897
2898 if ($info->{type} & 1) {
2899 # prepend meta info
2900
2901 my $meta = $enc->encode ({
2902 name => $name,
2903 %{ $info->{meta} || {} },
2904 });
2905
2906 $data = pack "(w/a*)*", $meta, $info->{data};
2907 }
2908
2909 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2910 cf::face::set_type $idx, $info->{type};
2911
2912 cf::cede_to_tick;
2913 }
2914
2915 if ($soundconf) {
2916 $soundconf = $enc->decode (delete $soundconf->{data});
2917
2918 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2919 my $sound = $soundconf->{compat}[$_]
2920 or next;
2921
2922 my $face = cf::face::find "sound/$sound->[1]";
2923 cf::sound::set $sound->[0] => $face;
2924 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2925 }
2926
2927 while (my ($k, $v) = each %{$soundconf->{event}}) {
2928 my $face = cf::face::find "sound/$v";
2929 cf::sound::set $k => $face;
2930 }
2931 }
2932 }
2933
2536 1 2934 1
2537} 2935}
2936
2937register_exticmd fx_want => sub {
2938 my ($ns, $want) = @_;
2939
2940 while (my ($k, $v) = each %$want) {
2941 $ns->fx_want ($k, $v);
2942 }
2943};
2538 2944
2539sub reload_regions { 2945sub reload_regions {
2540 load_resource_file "$MAPDIR/regions" 2946 load_resource_file "$MAPDIR/regions"
2541 or die "unable to load regions file\n"; 2947 or die "unable to load regions file\n";
2948
2949 for (cf::region::list) {
2950 $_->{match} = qr/$_->{match}/
2951 if exists $_->{match};
2952 }
2542} 2953}
2543 2954
2544sub reload_facedata { 2955sub reload_facedata {
2545 load_facedata "$DATADIR/facedata" 2956 load_facedata "$DATADIR/facedata"
2546 or die "unable to load facedata\n"; 2957 or die "unable to load facedata\n";
2547} 2958}
2548 2959
2549sub reload_archetypes { 2960sub reload_archetypes {
2550 load_resource_file "$DATADIR/archetypes" 2961 load_resource_file "$DATADIR/archetypes"
2551 or die "unable to load archetypes\n"; 2962 or die "unable to load archetypes\n";
2963 #d# NEED to laod twice to resolve forward references
2964 # this really needs to be done in an extra post-pass
2965 # (which needs to be synchronous, so solve it differently)
2966 load_resource_file "$DATADIR/archetypes"
2967 or die "unable to load archetypes\n";
2552} 2968}
2553 2969
2554sub reload_treasures { 2970sub reload_treasures {
2555 load_resource_file "$DATADIR/treasures" 2971 load_resource_file "$DATADIR/treasures"
2556 or die "unable to load treasurelists\n"; 2972 or die "unable to load treasurelists\n";
2559sub reload_resources { 2975sub reload_resources {
2560 warn "reloading resource files...\n"; 2976 warn "reloading resource files...\n";
2561 2977
2562 reload_regions; 2978 reload_regions;
2563 reload_facedata; 2979 reload_facedata;
2980 #reload_archetypes;#d#
2564 reload_archetypes; 2981 reload_archetypes;
2565 reload_treasures; 2982 reload_treasures;
2566 2983
2567 warn "finished reloading resource files\n"; 2984 warn "finished reloading resource files\n";
2568} 2985}
2625 }, 3042 },
2626 ); 3043 );
2627 } 3044 }
2628} 3045}
2629 3046
3047sub write_runtime {
3048 my $runtime = "$LOCALDIR/runtime";
3049
3050 # first touch the runtime file to show we are still running:
3051 # the fsync below can take a very very long time.
3052
3053 IO::AIO::aio_utime $runtime, undef, undef;
3054
3055 my $guard = cf::lock_acquire "write_runtime";
3056
3057 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3058 or return;
3059
3060 my $value = $cf::RUNTIME + 90 + 10;
3061 # 10 is the runtime save interval, for a monotonic clock
3062 # 60 allows for the watchdog to kill the server.
3063
3064 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3065 and return;
3066
3067 # always fsync - this file is important
3068 aio_fsync $fh
3069 and return;
3070
3071 # touch it again to show we are up-to-date
3072 aio_utime $fh, undef, undef;
3073
3074 close $fh
3075 or return;
3076
3077 aio_rename "$runtime~", $runtime
3078 and return;
3079
3080 warn "runtime file written.\n";
3081
3082 1
3083}
3084
2630sub emergency_save() { 3085sub emergency_save() {
2631 my $freeze_guard = cf::freeze_mainloop; 3086 my $freeze_guard = cf::freeze_mainloop;
2632 3087
2633 warn "enter emergency perl save\n"; 3088 warn "enter emergency perl save\n";
2634 3089
2709 %EXT_CORO = (); 3164 %EXT_CORO = ();
2710 3165
2711 warn "removing commands"; 3166 warn "removing commands";
2712 %COMMAND = (); 3167 %COMMAND = ();
2713 3168
2714 warn "removing ext commands"; 3169 warn "removing ext/exti commands";
2715 %EXTCMD = (); 3170 %EXTCMD = ();
3171 %EXTICMD = ();
2716 3172
2717 warn "unloading/nuking all extensions"; 3173 warn "unloading/nuking all extensions";
2718 for my $pkg (@EXTS) { 3174 for my $pkg (@EXTS) {
2719 warn "... unloading $pkg"; 3175 warn "... unloading $pkg";
2720 3176

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines