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.269 by root, Tue May 22 21:35:26 2007 UTC vs.
Revision 1.338 by root, Tue Aug 21 01:07:47 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 if (my $fh = aio_open $runtime, O_WRONLY, 0) { 476=cut
401 utime undef, undef, $fh;
402 }
403 477
404 my $guard = cf::lock_acquire "write_runtime"; 478sub fork_call(&@) {
479 my ($cb, @args) = @_;
405 480
406 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 481 # we seemingly have to make a local copy of the whole thing,
407 or return; 482 # otherwise perl prematurely frees the stuff :/
483 # TODO: investigate and fix (liekly this will be rather laborious)
408 484
409 my $value = $cf::RUNTIME + 90 + 10; 485 my @res = Coro::Util::fork_eval {
410 # 10 is the runtime save interval, for a monotonic clock 486 reset_signals;
411 # 60 allows for the watchdog to kill the server. 487 &$cb
488 }, @args;
412 489
413 (aio_write $fh, 0, (length $value), $value, 0) <= 0 490 wantarray ? @res : $res[-1]
414 and return; 491}
415 492
416 # always fsync - this file is important 493=item $value = cf::db_get $family => $key
417 aio_fsync $fh
418 and return;
419 494
420 # touch it again to show we are up-to-date 495Returns a single value from the environment database.
421 utime undef, undef, $fh;
422 496
423 close $fh 497=item cf::db_put $family => $key => $value
424 or return;
425 498
426 aio_rename "$runtime~", $runtime 499Stores the given C<$value> in the family. It can currently store binary
427 and return; 500data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
428 501
429 warn "runtime file written.\n";#d# 502=cut
430 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 };
431 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"
432} 607}
433 608
434=item cf::datalog type => key => value, ... 609=item cf::datalog type => key => value, ...
435 610
436Log 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.
454attach callbacks/event handlers (a collection of which is called an "attachment") 629attach callbacks/event handlers (a collection of which is called an "attachment")
455to it. All such attachable objects support the following methods. 630to it. All such attachable objects support the following methods.
456 631
457In 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>
458C<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
459crossfire+). 634Crossfire TRT).
460 635
461=over 4 636=over 4
462 637
463=item $attachable->attach ($attachment, key => $value...) 638=item $attachable->attach ($attachment, key => $value...)
464 639
666 _attach $registry, $klass, @attach; 841 _attach $registry, $klass, @attach;
667 } 842 }
668 843
669 $obj->{$name} = \%arg; 844 $obj->{$name} = \%arg;
670 } else { 845 } else {
671 warn "object uses attachment '$name' that is not available, postponing.\n"; 846 warn "object uses attachment '$name' which is not available, postponing.\n";
672 } 847 }
673 848
674 $obj->{_attachment}{$name} = undef; 849 $obj->{_attachment}{$name} = undef;
675} 850}
676 851
716 "; 891 ";
717 die if $@; 892 die if $@;
718} 893}
719 894
720our $override; 895our $override;
721our @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?
722 897
723sub override { 898sub override {
724 $override = 1; 899 $override = 1;
725 @invoke_results = (); 900 @INVOKE_RESULTS = (@_);
726} 901}
727 902
728sub do_invoke { 903sub do_invoke {
729 my $event = shift; 904 my $event = shift;
730 my $callbacks = shift; 905 my $callbacks = shift;
731 906
732 @invoke_results = (); 907 @INVOKE_RESULTS = ();
733 908
734 local $override; 909 local $override;
735 910
736 for (@$callbacks) { 911 for (@$callbacks) {
737 eval { &{$_->[1]} }; 912 eval { &{$_->[1]} };
754 929
755Generate an object-specific event with the given arguments. 930Generate an object-specific event with the given arguments.
756 931
757This 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
758removed 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
759results (if you must, access C<@cf::invoke_results> directly). 934results (if you must, access C<@cf::INVOKE_RESULTS> directly).
760 935
761=back 936=back
762 937
763=cut 938=cut
764 939
765############################################################################# 940#############################################################################
766# 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}
767 953
768sub reattach { 954sub reattach {
769 # basically do the same as instantiate, without calling instantiate 955 # basically do the same as instantiate, without calling instantiate
770 my ($obj) = @_; 956 my ($obj) = @_;
771 957
874 or return; 1060 or return;
875 $av = eval { (Storable::thaw $av)->{objs} }; 1061 $av = eval { (Storable::thaw $av)->{objs} };
876 } 1062 }
877 1063
878 warn sprintf "loading %s (%d)\n", 1064 warn sprintf "loading %s (%d)\n",
879 $filename, length $data, scalar @{$av || []};#d# 1065 $filename, length $data, scalar @{$av || []};
880 return ($data, $av); 1066 return ($data, $av);
881} 1067}
1068
1069=head2 COMMAND CALLBACKS
1070
1071=over 4
1072
1073=cut
882 1074
883############################################################################# 1075#############################################################################
884# command handling &c 1076# command handling &c
885 1077
886=item cf::register_command $name => \&callback($ob,$args); 1078=item cf::register_command $name => \&callback($ob,$args);
899 push @{ $COMMAND{$name} }, [$caller, $cb]; 1091 push @{ $COMMAND{$name} }, [$caller, $cb];
900} 1092}
901 1093
902=item cf::register_extcmd $name => \&callback($pl,$packet); 1094=item cf::register_extcmd $name => \&callback($pl,$packet);
903 1095
904Register 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.
905 1101
906If 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
907called. 1103called.
908 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
909=cut 1116=cut
910 1117
911sub register_extcmd { 1118sub register_extcmd {
912 my ($name, $cb) = @_; 1119 my ($name, $cb) = @_;
913 1120
914 $EXTCMD{$name} = $cb; 1121 $EXTCMD{$name} = $cb;
1122}
1123
1124sub register_exticmd {
1125 my ($name, $cb) = @_;
1126
1127 $EXTICMD{$name} = $cb;
915} 1128}
916 1129
917cf::player->attach ( 1130cf::player->attach (
918 on_command => sub { 1131 on_command => sub {
919 my ($pl, $name, $params) = @_; 1132 my ($pl, $name, $params) = @_;
928 cf::override; 1141 cf::override;
929 }, 1142 },
930 on_extcmd => sub { 1143 on_extcmd => sub {
931 my ($pl, $buf) = @_; 1144 my ($pl, $buf) = @_;
932 1145
933 my $msg = eval { from_json $buf }; 1146 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934 1147
935 if (ref $msg) { 1148 if (ref $msg) {
1149 my ($type, $reply, @payload) =
1150 "ARRAY" eq ref $msg
1151 ? @$msg
1152 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1153
1154 my @reply;
1155
936 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1156 if (my $cb = $EXTCMD{$type}) {
937 if (my %reply = $cb->($pl, $msg)) { 1157 @reply = $cb->($pl, @payload);
938 $pl->ext_reply ($msg->{msgid}, %reply);
939 }
940 } 1158 }
1159
1160 $pl->ext_reply ($reply, @reply)
1161 if $reply;
1162
941 } else { 1163 } else {
942 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1164 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943 } 1165 }
944 1166
945 cf::override; 1167 cf::override;
946 }, 1168 },
947); 1169);
948 1170
949sub load_extension {
950 my ($path) = @_;
951
952 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
953 my $base = $1;
954 my $pkg = $1;
955 $pkg =~ s/[^[:word:]]/_/g;
956 $pkg = "ext::$pkg";
957
958 warn "... loading '$path' into '$pkg'\n";
959
960 open my $fh, "<:utf8", $path
961 or die "$path: $!";
962
963 my $source =
964 "package $pkg; use strict; use utf8;\n"
965 . "#line 1 \"$path\"\n{\n"
966 . (do { local $/; <$fh> })
967 . "\n};\n1";
968
969 unless (eval $source) {
970 my $msg = $@ ? "$path: $@\n"
971 : "extension disabled.\n";
972 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
973 warn $@;
974 warn "mandatory extension failed to load, exiting.\n";
975 exit 1;
976 }
977 die $@;
978 }
979
980 push @EXTS, $pkg;
981}
982
983sub load_extensions { 1171sub load_extensions {
1172 cf::sync_job {
1173 my %todo;
1174
984 for my $ext (<$LIBDIR/*.ext>) { 1175 for my $path (<$LIBDIR/*.ext>) {
985 next unless -r $ext; 1176 next unless -r $path;
986 eval { 1177
987 load_extension $ext; 1178 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1179 my $base = $1;
1180 my $pkg = $1;
1181 $pkg =~ s/[^[:word:]]/_/g;
1182 $pkg = "ext::$pkg";
1183
1184 open my $fh, "<:utf8", $path
1185 or die "$path: $!";
1186
1187 my $source = do { local $/; <$fh> };
1188
1189 my %ext = (
1190 path => $path,
1191 base => $base,
1192 pkg => $pkg,
1193 );
1194
1195 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1196 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1197
1198 $ext{source} =
1199 "package $pkg; use strict; use utf8;\n"
1200 . "#line 1 \"$path\"\n{\n"
1201 . $source
1202 . "\n};\n1";
1203
1204 $todo{$base} = \%ext;
1205 }
1206
1207 my %done;
1208 while (%todo) {
1209 my $progress;
1210
1211 while (my ($k, $v) = each %todo) {
1212 for (split /,\s*/, $v->{meta}{depends}) {
1213 goto skip
1214 unless exists $done{$_};
1215 }
1216
1217 warn "... loading '$k' into '$v->{pkg}'\n";
1218
1219 unless (eval $v->{source}) {
1220 my $msg = $@ ? "$v->{path}: $@\n"
1221 : "$v->{base}: extension inactive.\n";
1222
1223 if (exists $v->{meta}{mandatory}) {
1224 warn $msg;
1225 warn "mandatory extension failed to load, exiting.\n";
1226 exit 1;
1227 }
1228
1229 warn $msg;
1230 }
1231
1232 $done{$k} = delete $todo{$k};
1233 push @EXTS, $v->{pkg};
1234 $progress = 1;
988 1 1235 }
989 } or warn "$ext not loaded: $@"; 1236
1237 skip:
1238 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1239 unless $progress;
1240 }
990 } 1241 };
991} 1242}
992 1243
993############################################################################# 1244#############################################################################
1245
1246=back
994 1247
995=head2 CORE EXTENSIONS 1248=head2 CORE EXTENSIONS
996 1249
997Functions and methods that extend core crossfire objects. 1250Functions and methods that extend core crossfire objects.
998 1251
1085 $cf::PLAYER{$login} = $self; 1338 $cf::PLAYER{$login} = $self;
1086 1339
1087 $self 1340 $self
1088} 1341}
1089 1342
1343=item $player->send_msg ($channel, $msg, $color, [extra...])
1344
1345=cut
1346
1347sub send_msg {
1348 my $ns = shift->ns
1349 or return;
1350 $ns->send_msg (@_);
1351}
1352
1090=item $pl->quit_character 1353=item $pl->quit_character
1091 1354
1092Nukes the player without looking back. If logged in, the connection will 1355Nukes the player without looking back. If logged in, the connection will
1093be destroyed. May block for a long time. 1356be destroyed. May block for a long time.
1094 1357
1186 } 1449 }
1187 1450
1188 \@paths 1451 \@paths
1189} 1452}
1190 1453
1454=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1455
1456Expand crossfire pod fragments into protocol xml.
1457
1458=cut
1459
1460sub expand_cfpod {
1461 ((my $self), (local $_)) = @_;
1462
1463 # escape & and <
1464 s/&/&amp;/g;
1465 s/(?<![BIUGH])</&lt;/g;
1466
1467 # this is buggy, it needs to properly take care of nested <'s
1468
1469 1 while
1470 # replace B<>, I<>, U<> etc.
1471 s/B<([^\>]*)>/<b>$1<\/b>/
1472 || s/I<([^\>]*)>/<i>$1<\/i>/
1473 || s/U<([^\>]*)>/<u>$1<\/u>/
1474 # replace G<male|female> tags
1475 || s{G<([^>|]*)\|([^>]*)>}{
1476 $self->gender ? $2 : $1
1477 }ge
1478 # replace H<hint text>
1479 || s{H<([^\>]*)>}
1480 {
1481 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1482 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1483 "")
1484 [$self->{hintmode}]
1485 }ge;
1486
1487 # create single paragraphs (very hackish)
1488 s/(?<=\S)\n(?=\w)/ /g;
1489
1490 # compress some whitespace
1491 s/\s+\n/\n/g; # ws line-ends
1492 s/\n\n+/\n/g; # double lines
1493 s/^\n+//; # beginning lines
1494 s/\n+$//; # ending lines
1495
1496 $_
1497}
1498
1499sub hintmode {
1500 $_[0]{hintmode} = $_[1] if @_ > 1;
1501 $_[0]{hintmode}
1502}
1503
1191=item $player->ext_reply ($msgid, %msg) 1504=item $player->ext_reply ($msgid, @msg)
1192 1505
1193Sends an ext reply to the player. 1506Sends an ext reply to the player.
1194 1507
1195=cut 1508=cut
1196 1509
1197sub ext_reply($$%) { 1510sub ext_reply($$@) {
1198 my ($self, $id, %msg) = @_; 1511 my ($self, $id, @msg) = @_;
1199 1512
1200 $msg{msgid} = $id; 1513 $self->ns->ext_reply ($id, @msg)
1201
1202 $self->send ("ext " . cf::to_json \%msg);
1203} 1514}
1204 1515
1205=item $player->ext_event ($type, %msg) 1516=item $player->ext_msg ($type, @msg)
1206 1517
1207Sends an ext event to the client. 1518Sends an ext event to the client.
1208 1519
1209=cut 1520=cut
1210 1521
1211sub ext_event($$%) { 1522sub ext_msg($$@) {
1212 my ($self, $type, %msg) = @_; 1523 my ($self, $type, @msg) = @_;
1213 1524
1214 $self->ns->ext_event ($type, %msg); 1525 $self->ns->ext_msg ($type, @msg);
1215} 1526}
1216 1527
1217=head3 cf::region 1528=head3 cf::region
1218 1529
1219=over 4 1530=over 4
1222 1533
1223package cf::region; 1534package cf::region;
1224 1535
1225=item cf::region::find_by_path $path 1536=item cf::region::find_by_path $path
1226 1537
1227Tries to decuce the probable region for a map knowing only its path. 1538Tries to decuce the likely region for a map knowing only its path.
1228 1539
1229=cut 1540=cut
1230 1541
1231sub find_by_path($) { 1542sub find_by_path($) {
1232 my ($path) = @_; 1543 my ($path) = @_;
1233 1544
1234 my ($match, $specificity); 1545 my ($match, $specificity);
1235 1546
1236 for my $region (list) { 1547 for my $region (list) {
1237 if ($region->match && $path =~ $region->match) { 1548 if ($region->{match} && $path =~ $region->{match}) {
1238 ($match, $specificity) = ($region, $region->specificity) 1549 ($match, $specificity) = ($region, $region->specificity)
1239 if $region->specificity > $specificity; 1550 if $region->specificity > $specificity;
1240 } 1551 }
1241 } 1552 }
1242 1553
1306 my ($self, $merge) = @_; 1617 my ($self, $merge) = @_;
1307 1618
1308 # we have to keep some variables in memory intact 1619 # we have to keep some variables in memory intact
1309 local $self->{path}; 1620 local $self->{path};
1310 local $self->{load_path}; 1621 local $self->{load_path};
1311 local $self->{deny_save};
1312 local $self->{deny_reset};
1313 1622
1314 $self->SUPER::thawer_merge ($merge); 1623 $self->SUPER::thawer_merge ($merge);
1315} 1624}
1316 1625
1317sub normalise { 1626sub normalise {
1364 $self->init; # pass $1 etc. 1673 $self->init; # pass $1 etc.
1365 return $self; 1674 return $self;
1366 } 1675 }
1367 } 1676 }
1368 1677
1369 Carp::carp "unable to resolve path '$path' (base '$base')."; 1678 Carp::cluck "unable to resolve path '$path' (base '$base').";
1370 () 1679 ()
1371} 1680}
1372 1681
1373sub init { 1682sub init {
1374 my ($self) = @_; 1683 my ($self) = @_;
1415sub change_all_map_light { 1724sub change_all_map_light {
1416 my ($change) = @_; 1725 my ($change) = @_;
1417 1726
1418 $_->change_map_light ($change) 1727 $_->change_map_light ($change)
1419 for grep $_->outdoor, values %cf::MAP; 1728 for grep $_->outdoor, values %cf::MAP;
1729}
1730
1731sub decay_objects {
1732 my ($self) = @_;
1733
1734 return if $self->{deny_reset};
1735
1736 $self->do_decay_objects;
1420} 1737}
1421 1738
1422sub unlink_save { 1739sub unlink_save {
1423 my ($self) = @_; 1740 my ($self) = @_;
1424 1741
1482 $self->load_header_orig 1799 $self->load_header_orig
1483 or return; 1800 or return;
1484 $self->prepare_orig; 1801 $self->prepare_orig;
1485 } 1802 }
1486 1803
1804 $self->{deny_reset} = 1
1805 if $self->no_reset;
1806
1487 $self->default_region (cf::region::find_by_path $self->{path}) 1807 $self->default_region (cf::region::find_by_path $self->{path})
1488 unless $self->default_region; 1808 unless $self->default_region;
1489 1809
1490 1 1810 1
1491} 1811}
1506 $map->{last_save} = $cf::RUNTIME; 1826 $map->{last_save} = $cf::RUNTIME;
1507 1827
1508 $map->load_header 1828 $map->load_header
1509 or return; 1829 or return;
1510 1830
1511 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1831 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512 # doing this can freeze the server in a sync job, obviously 1832 # doing this can freeze the server in a sync job, obviously
1513 #$cf::WAIT_FOR_TICK->wait; 1833 #$cf::WAIT_FOR_TICK->wait;
1514 $map->reset; 1834 $map->reset;
1515 undef $guard; 1835 undef $guard;
1516 return find $path; 1836 return find $path;
1571 $self->set_darkness_map; 1891 $self->set_darkness_map;
1572 Coro::cede; 1892 Coro::cede;
1573 $self->activate; 1893 $self->activate;
1574 } 1894 }
1575 1895
1896 $self->{last_save} = $cf::RUNTIME;
1897 $self->last_access ($cf::RUNTIME);
1898
1576 $self->in_memory (cf::MAP_IN_MEMORY); 1899 $self->in_memory (cf::MAP_IN_MEMORY);
1577 } 1900 }
1578 1901
1579 $self->post_load; 1902 $self->post_load;
1580} 1903}
1583 my ($self, $ob) = @_; 1906 my ($self, $ob) = @_;
1584 1907
1585 return find "~" . $ob->name . "/" . $self->{path} 1908 return find "~" . $ob->name . "/" . $self->{path}
1586 if $self->per_player; 1909 if $self->per_player;
1587 1910
1911# return find "?party/" . $ob->name . "/" . $self->{path}
1912# if $self->per_party;
1913
1588 $self 1914 $self
1589} 1915}
1590 1916
1591# find and load all maps in the 3x3 area around a map 1917# find and load all maps in the 3x3 area around a map
1592sub load_diag { 1918sub load_neighbours {
1593 my ($map) = @_; 1919 my ($map) = @_;
1594 1920
1595 my @diag; # diagonal neighbours 1921 my @neigh; # diagonal neighbours
1596 1922
1597 for (0 .. 3) { 1923 for (0 .. 3) {
1598 my $neigh = $map->tile_path ($_) 1924 my $neigh = $map->tile_path ($_)
1599 or next; 1925 or next;
1600 $neigh = find $neigh, $map 1926 $neigh = find $neigh, $map
1601 or next; 1927 or next;
1602 $neigh->load; 1928 $neigh->load;
1603 1929
1930 push @neigh,
1604 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1931 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1605 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1932 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1606 } 1933 }
1607 1934
1608 for (@diag) { 1935 for (grep defined $_->[0], @neigh) {
1936 my ($path, $origin) = @$_;
1609 my $neigh = find @$_ 1937 my $neigh = find $path, $origin
1610 or next; 1938 or next;
1611 $neigh->load; 1939 $neigh->load;
1612 } 1940 }
1613} 1941}
1614 1942
1638 1966
1639 undef $MAP_PREFETCH{$path}; 1967 undef $MAP_PREFETCH{$path};
1640 $MAP_PREFETCHER ||= cf::async { 1968 $MAP_PREFETCHER ||= cf::async {
1641 while (%MAP_PREFETCH) { 1969 while (%MAP_PREFETCH) {
1642 for my $path (keys %MAP_PREFETCH) { 1970 for my $path (keys %MAP_PREFETCH) {
1643 my $map = find $path 1971 if (my $map = find $path) {
1644 or next;
1645 $map->load; 1972 $map->load;
1973 }
1646 1974
1647 delete $MAP_PREFETCH{$path}; 1975 delete $MAP_PREFETCH{$path};
1648 } 1976 }
1649 } 1977 }
1650 undef $MAP_PREFETCHER; 1978 undef $MAP_PREFETCHER;
1702 2030
1703sub reset_at { 2031sub reset_at {
1704 my ($self) = @_; 2032 my ($self) = @_;
1705 2033
1706 # TODO: safety, remove and allow resettable per-player maps 2034 # TODO: safety, remove and allow resettable per-player maps
1707 return 1e99 if $self->isa ("ext::map_per_player");#d#
1708 return 1e99 if $self->{deny_reset}; 2035 return 1e99 if $self->{deny_reset};
1709 2036
1710 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2037 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2038 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1712 2039
1723 my ($self) = @_; 2050 my ($self) = @_;
1724 2051
1725 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2052 my $lock = cf::lock_acquire "map_data:$self->{path}";
1726 2053
1727 return if $self->players; 2054 return if $self->players;
1728 return if $self->isa ("ext::map_per_player");#d#
1729 2055
1730 warn "resetting map ", $self->path;#d# 2056 warn "resetting map ", $self->path;
1731 2057
1732 $self->in_memory (cf::MAP_SWAPPED); 2058 $self->in_memory (cf::MAP_SWAPPED);
1733 2059
1734 # need to save uniques path 2060 # need to save uniques path
1735 unless ($self->{deny_save}) { 2061 unless ($self->{deny_save}) {
1767 $cf::MAP{$self->path} = $self; 2093 $cf::MAP{$self->path} = $self;
1768 2094
1769 $self->reset; # polite request, might not happen 2095 $self->reset; # polite request, might not happen
1770} 2096}
1771 2097
2098=item $maps = cf::map::tmp_maps
2099
2100Returns an arrayref with all map paths of currently instantiated and saved
2101maps. May block.
2102
2103=cut
2104
2105sub tmp_maps() {
2106 [
2107 map {
2108 utf8::decode $_;
2109 /\.map$/
2110 ? normalise $_
2111 : ()
2112 } @{ aio_readdir $TMPDIR or [] }
2113 ]
2114}
2115
2116=item $maps = cf::map::random_maps
2117
2118Returns an arrayref with all map paths of currently instantiated and saved
2119random maps. May block.
2120
2121=cut
2122
2123sub random_maps() {
2124 [
2125 map {
2126 utf8::decode $_;
2127 /\.map$/
2128 ? normalise "?random/$_"
2129 : ()
2130 } @{ aio_readdir $RANDOMDIR or [] }
2131 ]
2132}
2133
1772=item cf::map::unique_maps 2134=item cf::map::unique_maps
1773 2135
1774Returns an arrayref of paths of all shared maps that have 2136Returns an arrayref of paths of all shared maps that have
1775instantiated unique items. May block. 2137instantiated unique items. May block.
1776 2138
1777=cut 2139=cut
1778 2140
1779sub unique_maps() { 2141sub unique_maps() {
1780 my $files = aio_readdir $UNIQUEDIR 2142 [
1781 or return; 2143 map {
1782
1783 my @paths;
1784
1785 for (@$files) {
1786 utf8::decode $_; 2144 utf8::decode $_;
1787 next if /\.pst$/; 2145 /\.map$/
1788 next unless /^$PATH_SEP/o; 2146 ? normalise $_
1789 2147 : ()
1790 push @paths, cf::map::normalise $_; 2148 } @{ aio_readdir $UNIQUEDIR or [] }
1791 } 2149 ]
1792
1793 \@paths
1794} 2150}
1795 2151
1796package cf; 2152package cf;
1797 2153
1798=back 2154=back
1844 2200
1845 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2201 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846 2202
1847 if ($self->{record_replies}) { 2203 if ($self->{record_replies}) {
1848 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2204 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2205
1849 } else { 2206 } else {
2207 my $pl = $self->contr;
2208
2209 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2210 my $dialog = $pl->{npc_dialog};
2211 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2212
2213 } else {
1850 $msg = $npc->name . " says: $msg" if $npc; 2214 $msg = $npc->name . " says: $msg" if $npc;
1851 $self->message ($msg, $flags); 2215 $self->message ($msg, $flags);
2216 }
1852 } 2217 }
2218}
2219
2220=item $object->send_msg ($channel, $msg, $color, [extra...])
2221
2222=cut
2223
2224sub cf::object::send_msg {
2225 my $pl = shift->contr
2226 or return;
2227 $pl->send_msg (@_);
1853} 2228}
1854 2229
1855=item $player_object->may ("access") 2230=item $player_object->may ("access")
1856 2231
1857Returns wether the given player is authorized to access resource "access" 2232Returns wether the given player is authorized to access resource "access"
1904 $self->deactivate_recursive; 2279 $self->deactivate_recursive;
1905 2280
1906 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2281 return if UNIVERSAL::isa $self->map, "ext::map_link";
1907 2282
1908 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2283 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1909 if $self->map; 2284 if $self->map && $self->map->{path} ne "{link}";
1910 2285
1911 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2286 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1912} 2287}
1913 2288
1914sub cf::object::player::leave_link { 2289sub cf::object::player::leave_link {
1915 my ($self, $map, $x, $y) = @_; 2290 my ($self, $map, $x, $y) = @_;
2291
2292 return unless $self->contr->active;
1916 2293
1917 my $link_pos = delete $self->{_link_pos}; 2294 my $link_pos = delete $self->{_link_pos};
1918 2295
1919 unless ($map) { 2296 unless ($map) {
1920 # restore original map position 2297 # restore original map position
1934 # use -1 or undef as default coordinates, not 0, 0 2311 # use -1 or undef as default coordinates, not 0, 0
1935 ($x, $y) = ($map->enter_x, $map->enter_y) 2312 ($x, $y) = ($map->enter_x, $map->enter_y)
1936 if $x <=0 && $y <= 0; 2313 if $x <=0 && $y <= 0;
1937 2314
1938 $map->load; 2315 $map->load;
1939 $map->load_diag; 2316 $map->load_neighbours;
1940 2317
1941 return unless $self->contr->active; 2318 return unless $self->contr->active;
1942 $self->activate_recursive; 2319 $self->activate_recursive;
1943 2320
1944 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2321 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945 $self->enter_map ($map, $x, $y); 2322 $self->enter_map ($map, $x, $y);
1946} 2323}
1947 2324
1948cf::player->attach (
1949 on_logout => sub {
1950 my ($pl) = @_;
1951
1952 # abort map switching before logout
1953 if ($pl->ob->{_link_pos}) {
1954 cf::sync_job {
1955 $pl->ob->leave_link
1956 };
1957 }
1958 },
1959 on_login => sub {
1960 my ($pl) = @_;
1961
1962 # try to abort aborted map switching on player login :)
1963 # should happen only on crashes
1964 if ($pl->ob->{_link_pos}) {
1965 $pl->ob->enter_link;
1966 (async {
1967 $pl->ob->reply (undef,
1968 "There was an internal problem at your last logout, "
1969 . "the server will try to bring you to your intended destination in a second.",
1970 cf::NDI_RED);
1971 # we need this sleep as the login has a concurrent enter_exit running
1972 # and this sleep increases chances of the player not ending up in scorn
1973 Coro::Timer::sleep 1;
1974 $pl->ob->leave_link;
1975 })->prio (2);
1976 }
1977 },
1978);
1979
1980=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2325=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1981 2326
1982Moves the player to the given map-path and coordinates by first freezing 2327Moves the player to the given map-path and coordinates by first freezing
1983her, loading and preparing them map, calling the provided $check callback 2328her, loading and preparing them map, calling the provided $check callback
1984that has to return the map if sucecssful, and then unfreezes the player on 2329that has to return the map if sucecssful, and then unfreezes the player on
1985the new (success) or old (failed) map position. 2330the new (success) or old (failed) map position. In either case, $done will
2331be called at the end of this process.
1986 2332
1987=cut 2333=cut
2334
2335our $GOTOGEN;
1988 2336
1989sub cf::object::player::goto { 2337sub cf::object::player::goto {
1990 my ($self, $path, $x, $y, $check) = @_; 2338 my ($self, $path, $x, $y, $check, $done) = @_;
2339
2340 # do generation counting so two concurrent goto's will be executed in-order
2341 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1991 2342
1992 $self->enter_link; 2343 $self->enter_link;
1993 2344
1994 (async { 2345 (async {
1995 my $map = eval { 2346 my $map = eval {
2008 if ($@) { 2359 if ($@) {
2009 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED); 2360 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2010 LOG llevError | logBacktrace, Carp::longmess $@; 2361 LOG llevError | logBacktrace, Carp::longmess $@;
2011 } 2362 }
2012 2363
2364 if ($gen == $self->{_goto_generation}) {
2365 delete $self->{_goto_generation};
2013 $self->leave_link ($map, $x, $y); 2366 $self->leave_link ($map, $x, $y);
2367 }
2368
2369 $done->() if $done;
2014 })->prio (1); 2370 })->prio (1);
2015} 2371}
2016 2372
2017=item $player_object->enter_exit ($exit_object) 2373=item $player_object->enter_exit ($exit_object)
2018 2374
2087 my $hp = $exit->stats->hp; 2443 my $hp = $exit->stats->hp;
2088 my $sp = $exit->stats->sp; 2444 my $sp = $exit->stats->sp;
2089 2445
2090 $self->enter_link; 2446 $self->enter_link;
2091 2447
2448 # if exit is damned, update players death & WoR home-position
2449 $self->contr->savebed ($slaying, $hp, $sp)
2450 if $exit->flag (FLAG_DAMNED);
2451
2092 (async { 2452 (async {
2093 $self->deactivate_recursive; # just to be sure 2453 $self->deactivate_recursive; # just to be sure
2094 unless (eval { 2454 unless (eval {
2095 $self->goto ($slaying, $hp, $sp); 2455 $self->goto ($slaying, $hp, $sp);
2096 2456
2123 2483
2124 utf8::encode $text; 2484 utf8::encode $text;
2125 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2485 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2126} 2486}
2127 2487
2488=item $client->send_msg ($channel, $msg, $color, [extra...])
2489
2490Send a drawinfo or msg packet to the client, formatting the msg for the
2491client if neccessary. C<$type> should be a string identifying the type of
2492the message, with C<log> being the default. If C<$color> is negative, suppress
2493the message unless the client supports the msg packet.
2494
2495=cut
2496
2497sub cf::client::send_msg {
2498 my ($self, $channel, $msg, $color, @extra) = @_;
2499
2500 $msg = $self->pl->expand_cfpod ($msg);
2501
2502 $color &= cf::NDI_CLIENT_MASK; # just in case...
2503
2504 if (ref $channel) {
2505 # send meta info to client, if not yet sent
2506 unless (exists $self->{channel}{$channel->{id}}) {
2507 $self->{channel}{$channel->{id}} = $channel;
2508 $self->ext_msg (channel_info => $channel);
2509 }
2510
2511 $channel = $channel->{id};
2512 }
2513
2514 return unless @extra || length $msg;
2515
2516 if ($self->can_msg) {
2517 # default colour, mask it out
2518 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2519 if $color & cf::NDI_DEF;
2520
2521 $self->send_packet ("msg " . $self->{json_coder}->encode (
2522 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2523 } else {
2524 if ($color >= 0) {
2525 # replace some tags by gcfclient-compatible ones
2526 for ($msg) {
2527 1 while
2528 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2529 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2530 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2531 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2532 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2533 }
2534
2535 $color &= cf::NDI_COLOR_MASK;
2536
2537 utf8::encode $msg;
2538
2539 if (0 && $msg =~ /\[/) {
2540 # COMMAND/INFO
2541 $self->send_packet ("drawextinfo $color 10 8 $msg")
2542 } else {
2543 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2544 $self->send_packet ("drawinfo $color $msg")
2545 }
2546 }
2547 }
2548}
2549
2128=item $client->ext_event ($type, %msg) 2550=item $client->ext_msg ($type, @msg)
2129 2551
2130Sends an exti event to the client. 2552Sends an ext event to the client.
2131 2553
2132=cut 2554=cut
2133 2555
2134sub cf::client::ext_event($$%) { 2556sub cf::client::ext_msg($$@) {
2135 my ($self, $type, %msg) = @_; 2557 my ($self, $type, @msg) = @_;
2136 2558
2559 my $extcmd = $self->extcmd;
2560
2561 if ($extcmd == 2) {
2562 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2563 } elsif ($extcmd == 1) { # TODO: remove
2137 $msg{msgtype} = "event_$type"; 2564 push @msg, msgtype => "event_$type";
2138 $self->send_packet ("ext " . cf::to_json \%msg); 2565 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2566 }
2567}
2568
2569=item $client->ext_reply ($msgid, @msg)
2570
2571Sends an ext reply to the client.
2572
2573=cut
2574
2575sub cf::client::ext_reply($$@) {
2576 my ($self, $id, @msg) = @_;
2577
2578 if ($self->extcmd == 2) {
2579 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2580 } elsif ($self->ns->extcmd == 1) {
2581 #TODO: version 1, remove
2582 unshift @msg, msgtype => "reply", msgid => $id;
2583 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2584 }
2139} 2585}
2140 2586
2141=item $success = $client->query ($flags, "text", \&cb) 2587=item $success = $client->query ($flags, "text", \&cb)
2142 2588
2143Queues a query to the client, calling the given callback with 2589Queues a query to the client, calling the given callback with
2144the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2590the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2145C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2591C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2146 2592
2147Queries can fail, so check the return code. Or don't, as queries will become 2593Queries can fail, so check the return code. Or don't, as queries will
2148reliable at some point in the future. 2594become reliable at some point in the future.
2149 2595
2150=cut 2596=cut
2151 2597
2152sub cf::client::query { 2598sub cf::client::query {
2153 my ($self, $flags, $text, $cb) = @_; 2599 my ($self, $flags, $text, $cb) = @_;
2161 utf8::encode $text; 2607 utf8::encode $text;
2162 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2608 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2163 2609
2164 $self->send_packet ($self->{query_queue}[0][0]) 2610 $self->send_packet ($self->{query_queue}[0][0])
2165 if @{ $self->{query_queue} } == 1; 2611 if @{ $self->{query_queue} } == 1;
2612
2613 1
2166} 2614}
2167 2615
2168cf::client->attach ( 2616cf::client->attach (
2617 on_connect => sub {
2618 my ($ns) = @_;
2619
2620 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2621 },
2169 on_reply => sub { 2622 on_reply => sub {
2170 my ($ns, $msg) = @_; 2623 my ($ns, $msg) = @_;
2171 2624
2172 # this weird shuffling is so that direct followup queries 2625 # this weird shuffling is so that direct followup queries
2173 # get handled first 2626 # get handled first
2185 } else { 2638 } else {
2186 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2639 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2187 } 2640 }
2188 } 2641 }
2189 }, 2642 },
2643 on_exticmd => sub {
2644 my ($ns, $buf) = @_;
2645
2646 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2647
2648 if (ref $msg) {
2649 my ($type, $reply, @payload) =
2650 "ARRAY" eq ref $msg
2651 ? @$msg
2652 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2653
2654 my @reply;
2655
2656 if (my $cb = $EXTICMD{$type}) {
2657 @reply = $cb->($ns, @payload);
2658 }
2659
2660 $ns->ext_reply ($reply, @reply)
2661 if $reply;
2662
2663 } else {
2664 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2665 }
2666
2667 cf::override;
2668 },
2190); 2669);
2191 2670
2192=item $client->async (\&cb) 2671=item $client->async (\&cb)
2193 2672
2194Create a new coroutine, running the specified callback. The coroutine will 2673Create a new coroutine, running the specified callback. The coroutine will
2235our $safe = new Safe "safe"; 2714our $safe = new Safe "safe";
2236our $safe_hole = new Safe::Hole; 2715our $safe_hole = new Safe::Hole;
2237 2716
2238$SIG{FPE} = 'IGNORE'; 2717$SIG{FPE} = 'IGNORE';
2239 2718
2240$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2719$safe->permit_only (Opcode::opset qw(
2720 :base_core :base_mem :base_orig :base_math
2721 grepstart grepwhile mapstart mapwhile
2722 sort time
2723));
2241 2724
2242# here we export the classes and methods available to script code 2725# here we export the classes and methods available to script code
2243 2726
2244=pod 2727=pod
2245 2728
2246The following functions and methods are available within a safe environment: 2729The following functions and methods are available within a safe environment:
2247 2730
2248 cf::object contr pay_amount pay_player map 2731 cf::object
2732 contr pay_amount pay_player map x y force_find force_add
2733 insert remove name archname title slaying race
2734
2249 cf::object::player player 2735 cf::object::player
2250 cf::player peaceful 2736 player
2251 cf::map trigger 2737
2738 cf::player
2739 peaceful
2740
2741 cf::map
2742 trigger
2252 2743
2253=cut 2744=cut
2254 2745
2255for ( 2746for (
2256 ["cf::object" => qw(contr pay_amount pay_player map)], 2747 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2748 insert remove inv name archname title slaying race)],
2257 ["cf::object::player" => qw(player)], 2749 ["cf::object::player" => qw(player)],
2258 ["cf::player" => qw(peaceful)], 2750 ["cf::player" => qw(peaceful)],
2259 ["cf::map" => qw(trigger)], 2751 ["cf::map" => qw(trigger)],
2260) { 2752) {
2261 no strict 'refs'; 2753 no strict 'refs';
2332=back 2824=back
2333 2825
2334=cut 2826=cut
2335 2827
2336############################################################################# 2828#############################################################################
2337
2338=head2 EXTENSION DATABASE SUPPORT
2339
2340Crossfire maintains a very simple database for extension use. It can
2341currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2342convert to/from binary).
2343
2344The parameter C<$family> should best start with the name of the extension
2345using it, it should be unique.
2346
2347=over 4
2348
2349=item $value = cf::db_get $family => $key
2350
2351Returns a single value from the database.
2352
2353=item cf::db_put $family => $key => $value
2354
2355Stores the given C<$value> in the family.
2356
2357=cut
2358
2359our $DB;
2360
2361sub db_init {
2362 unless ($DB) {
2363 $DB = BDB::db_create $DB_ENV;
2364
2365 cf::sync_job {
2366 eval {
2367 $DB->set_flags (BDB::CHKSUM);
2368
2369 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2370 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2371 cf::cleanup "db_open(db): $!" if $!;
2372 };
2373 cf::cleanup "db_open(db): $@" if $@;
2374 };
2375 }
2376}
2377
2378sub db_get($$) {
2379 my $key = "$_[0]/$_[1]";
2380
2381 cf::sync_job {
2382 BDB::db_get $DB, undef, $key, my $data;
2383
2384 $! ? ()
2385 : $data
2386 }
2387}
2388
2389sub db_put($$$) {
2390 BDB::dbreq_pri 4;
2391 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2392}
2393
2394=item cf::cache $id => [$paths...], $processversion => $process
2395
2396Generic caching function that returns the value of the resource $id,
2397caching and regenerating as required.
2398
2399This function can block.
2400
2401=cut
2402
2403sub cache {
2404 my ($id, $src, $processversion, $process) = @_;
2405
2406 my $meta =
2407 join "\x00",
2408 $processversion,
2409 map {
2410 aio_stat $_
2411 and Carp::croak "$_: $!";
2412
2413 ($_, (stat _)[7,9])
2414 } @$src;
2415
2416 my $dbmeta = db_get cache => "$id/meta";
2417 if ($dbmeta ne $meta) {
2418 # changed, we may need to process
2419
2420 my @data;
2421 my $md5;
2422
2423 for (0 .. $#$src) {
2424 0 <= aio_load $src->[$_], $data[$_]
2425 or Carp::croak "$src->[$_]: $!";
2426 }
2427
2428 # if processing is expensive, check
2429 # checksum first
2430 if (1) {
2431 $md5 =
2432 join "\x00",
2433 $processversion,
2434 map {
2435 Coro::cede;
2436 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2437 } 0.. $#$src;
2438
2439
2440 my $dbmd5 = db_get cache => "$id/md5";
2441 if ($dbmd5 eq $md5) {
2442 db_put cache => "$id/meta", $meta;
2443
2444 return db_get cache => "$id/data";
2445 }
2446 }
2447
2448 my $t1 = Time::HiRes::time;
2449 my $data = $process->(\@data);
2450 my $t2 = Time::HiRes::time;
2451
2452 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2453
2454 db_put cache => "$id/data", $data;
2455 db_put cache => "$id/md5" , $md5;
2456 db_put cache => "$id/meta", $meta;
2457
2458 return $data;
2459 }
2460
2461 db_get cache => "$id/data"
2462}
2463
2464=item fork_call { }, $args
2465
2466Executes the given code block with the given arguments in a seperate
2467process, returning the results. Everything must be serialisable with
2468Coro::Storable. May, of course, block. Note that the executed sub may
2469never block itself or use any form of Event handling.
2470
2471=cut
2472
2473sub fork_call(&@) {
2474 my ($cb, @args) = @_;
2475
2476# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2477# or die "socketpair: $!";
2478 pipe my $fh1, my $fh2
2479 or die "pipe: $!";
2480
2481 if (my $pid = fork) {
2482 close $fh2;
2483
2484 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2485 $res = Coro::Storable::thaw $res;
2486
2487 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2488
2489 die $$res unless "ARRAY" eq ref $res;
2490
2491 return wantarray ? @$res : $res->[-1];
2492 } else {
2493 reset_signals;
2494 local $SIG{__WARN__};
2495 local $SIG{__DIE__};
2496 eval {
2497 close $fh1;
2498
2499 my @res = eval { $cb->(@args) };
2500 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2501 };
2502
2503 warn $@ if $@;
2504 _exit 0;
2505 }
2506}
2507
2508
2509
2510#############################################################################
2511# the server's init and main functions 2829# the server's init and main functions
2512 2830
2513sub load_facedata($) { 2831sub load_facedata($) {
2514 my ($path) = @_; 2832 my ($path) = @_;
2833
2834 my $enc = JSON::XS->new->utf8->canonical;
2515 2835
2516 warn "loading facedata from $path\n"; 2836 warn "loading facedata from $path\n";
2517 2837
2518 my $facedata; 2838 my $facedata;
2519 0 < aio_load $path, $facedata 2839 0 < aio_load $path, $facedata
2522 $facedata = Coro::Storable::thaw $facedata; 2842 $facedata = Coro::Storable::thaw $facedata;
2523 2843
2524 $facedata->{version} == 2 2844 $facedata->{version} == 2
2525 or cf::cleanup "$path: version mismatch, cannot proceed."; 2845 or cf::cleanup "$path: version mismatch, cannot proceed.";
2526 2846
2847 # patch in the exptable
2848 $facedata->{resource}{"res/exp_table"} = {
2849 type => FT_RSRC,
2850 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2851 };
2852 cf::cede_to_tick;
2853
2527 { 2854 {
2528 my $faces = $facedata->{faceinfo}; 2855 my $faces = $facedata->{faceinfo};
2529 2856
2530 while (my ($face, $info) = each %$faces) { 2857 while (my ($face, $info) = each %$faces) {
2531 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2858 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2532 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2859 cf::face::set_visibility $idx, $info->{visibility};
2860 cf::face::set_magicmap $idx, $info->{magicmap};
2533 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2861 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2534 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2862 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2535 Coro::cede; 2863
2864 cf::cede_to_tick;
2536 } 2865 }
2537 2866
2538 while (my ($face, $info) = each %$faces) { 2867 while (my ($face, $info) = each %$faces) {
2539 next unless $info->{smooth}; 2868 next unless $info->{smooth};
2540 my $idx = cf::face::find $face 2869 my $idx = cf::face::find $face
2541 or next; 2870 or next;
2542 if (my $smooth = cf::face::find $info->{smooth}) { 2871 if (my $smooth = cf::face::find $info->{smooth}) {
2872 cf::face::set_smooth $idx, $smooth;
2543 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2873 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2544 } else { 2874 } else {
2545 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2875 warn "smooth face '$info->{smooth}' not found for face '$face'";
2546 } 2876 }
2547 Coro::cede; 2877
2878 cf::cede_to_tick;
2548 } 2879 }
2549 } 2880 }
2550 2881
2551 { 2882 {
2552 my $anims = $facedata->{animinfo}; 2883 my $anims = $facedata->{animinfo};
2553 2884
2554 while (my ($anim, $info) = each %$anims) { 2885 while (my ($anim, $info) = each %$anims) {
2555 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2886 cf::anim::set $anim, $info->{frames}, $info->{facings};
2556 Coro::cede; 2887 cf::cede_to_tick;
2557 } 2888 }
2558 2889
2559 cf::anim::invalidate_all; # d'oh 2890 cf::anim::invalidate_all; # d'oh
2560 } 2891 }
2561 2892
2893 {
2894 # TODO: for gcfclient pleasure, we should give resources
2895 # that gcfclient doesn't grok a >10000 face index.
2896 my $res = $facedata->{resource};
2897
2898 my $soundconf = delete $res->{"res/sound.conf"};
2899
2900 while (my ($name, $info) = each %$res) {
2901 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2902 my $data;
2903
2904 if ($info->{type} & 1) {
2905 # prepend meta info
2906
2907 my $meta = $enc->encode ({
2908 name => $name,
2909 %{ $info->{meta} || {} },
2910 });
2911
2912 $data = pack "(w/a*)*", $meta, $info->{data};
2913 } else {
2914 $data = $info->{data};
2915 }
2916
2917 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2918 cf::face::set_type $idx, $info->{type};
2919
2920 cf::cede_to_tick;
2921 }
2922
2923 if ($soundconf) {
2924 $soundconf = $enc->decode (delete $soundconf->{data});
2925
2926 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2927 my $sound = $soundconf->{compat}[$_]
2928 or next;
2929
2930 my $face = cf::face::find "sound/$sound->[1]";
2931 cf::sound::set $sound->[0] => $face;
2932 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2933 }
2934
2935 while (my ($k, $v) = each %{$soundconf->{event}}) {
2936 my $face = cf::face::find "sound/$v";
2937 cf::sound::set $k => $face;
2938 }
2939 }
2940 }
2941
2562 1 2942 1
2563} 2943}
2944
2945register_exticmd fx_want => sub {
2946 my ($ns, $want) = @_;
2947
2948 while (my ($k, $v) = each %$want) {
2949 $ns->fx_want ($k, $v);
2950 }
2951};
2564 2952
2565sub reload_regions { 2953sub reload_regions {
2566 load_resource_file "$MAPDIR/regions" 2954 load_resource_file "$MAPDIR/regions"
2567 or die "unable to load regions file\n"; 2955 or die "unable to load regions file\n";
2956
2957 for (cf::region::list) {
2958 $_->{match} = qr/$_->{match}/
2959 if exists $_->{match};
2960 }
2568} 2961}
2569 2962
2570sub reload_facedata { 2963sub reload_facedata {
2571 load_facedata "$DATADIR/facedata" 2964 load_facedata "$DATADIR/facedata"
2572 or die "unable to load facedata\n"; 2965 or die "unable to load facedata\n";
2573} 2966}
2574 2967
2575sub reload_archetypes { 2968sub reload_archetypes {
2576 load_resource_file "$DATADIR/archetypes" 2969 load_resource_file "$DATADIR/archetypes"
2577 or die "unable to load archetypes\n"; 2970 or die "unable to load archetypes\n";
2971 #d# NEED to laod twice to resolve forward references
2972 # this really needs to be done in an extra post-pass
2973 # (which needs to be synchronous, so solve it differently)
2974 load_resource_file "$DATADIR/archetypes"
2975 or die "unable to load archetypes\n";
2578} 2976}
2579 2977
2580sub reload_treasures { 2978sub reload_treasures {
2581 load_resource_file "$DATADIR/treasures" 2979 load_resource_file "$DATADIR/treasures"
2582 or die "unable to load treasurelists\n"; 2980 or die "unable to load treasurelists\n";
2585sub reload_resources { 2983sub reload_resources {
2586 warn "reloading resource files...\n"; 2984 warn "reloading resource files...\n";
2587 2985
2588 reload_regions; 2986 reload_regions;
2589 reload_facedata; 2987 reload_facedata;
2988 #reload_archetypes;#d#
2590 reload_archetypes; 2989 reload_archetypes;
2591 reload_treasures; 2990 reload_treasures;
2592 2991
2593 warn "finished reloading resource files\n"; 2992 warn "finished reloading resource files\n";
2594} 2993}
2651 }, 3050 },
2652 ); 3051 );
2653 } 3052 }
2654} 3053}
2655 3054
3055sub write_runtime {
3056 my $runtime = "$LOCALDIR/runtime";
3057
3058 # first touch the runtime file to show we are still running:
3059 # the fsync below can take a very very long time.
3060
3061 IO::AIO::aio_utime $runtime, undef, undef;
3062
3063 my $guard = cf::lock_acquire "write_runtime";
3064
3065 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3066 or return;
3067
3068 my $value = $cf::RUNTIME + 90 + 10;
3069 # 10 is the runtime save interval, for a monotonic clock
3070 # 60 allows for the watchdog to kill the server.
3071
3072 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3073 and return;
3074
3075 # always fsync - this file is important
3076 aio_fsync $fh
3077 and return;
3078
3079 # touch it again to show we are up-to-date
3080 aio_utime $fh, undef, undef;
3081
3082 close $fh
3083 or return;
3084
3085 aio_rename "$runtime~", $runtime
3086 and return;
3087
3088 warn "runtime file written.\n";
3089
3090 1
3091}
3092
2656sub emergency_save() { 3093sub emergency_save() {
2657 my $freeze_guard = cf::freeze_mainloop; 3094 my $freeze_guard = cf::freeze_mainloop;
2658 3095
2659 warn "enter emergency perl save\n"; 3096 warn "enter emergency perl save\n";
2660 3097
2735 %EXT_CORO = (); 3172 %EXT_CORO = ();
2736 3173
2737 warn "removing commands"; 3174 warn "removing commands";
2738 %COMMAND = (); 3175 %COMMAND = ();
2739 3176
2740 warn "removing ext commands"; 3177 warn "removing ext/exti commands";
2741 %EXTCMD = (); 3178 %EXTCMD = ();
3179 %EXTICMD = ();
2742 3180
2743 warn "unloading/nuking all extensions"; 3181 warn "unloading/nuking all extensions";
2744 for my $pkg (@EXTS) { 3182 for my $pkg (@EXTS) {
2745 warn "... unloading $pkg"; 3183 warn "... unloading $pkg";
2746 3184

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines