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.267 by root, Sat May 19 00:08:11 2007 UTC vs.
Revision 1.331 by root, Mon Aug 13 13:10:01 2007 UTC

20use Coro::Signal; 20use Coro::Signal;
21use Coro::Semaphore; 21use Coro::Semaphore;
22use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable; 23use Coro::Storable;
24 24
25use JSON::XS 1.4 ();
25use BDB (); 26use BDB ();
26use Data::Dumper; 27use Data::Dumper;
27use Digest::MD5; 28use Digest::MD5;
28use Fcntl; 29use Fcntl;
29use YAML::Syck (); 30use YAML::Syck ();
30use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
31use Time::HiRes; 32use Time::HiRes;
32use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
33 35
34# configure various modules to our taste 36# configure various modules to our taste
35# 37#
36$Storable::canonical = 1; # reduce rsync transfers 38$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
49our %COMMAND = (); 51our %COMMAND = ();
50our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
51 53
52our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
56 59
57our $RELOAD; # number of reloads so far 60our $RELOAD; # number of reloads so far
58our @EVENT; 61our @EVENT;
164 167
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 168These 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 169returns 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. 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168 171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
177
169=back 178=back
170 179
171=cut 180=cut
172 181
173BEGIN { 182BEGIN {
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 200@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
201@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
192@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 202@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
193 203
194# we bless all objects into (empty) derived classes to force a method lookup 204# we bless all objects into (empty) derived classes to force a method lookup
195# within the Safe compartment. 205# within the Safe compartment.
196for my $pkg (qw( 206for my $pkg (qw(
197 cf::global cf::attachable 207 cf::global cf::attachable
205} 215}
206 216
207$Event::DIED = sub { 217$Event::DIED = sub {
208 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
209}; 219};
220
221#############################################################################
210 222
211=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
212 224
213=over 4 225=over 4
214 226
233 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
234 $d 246 $d
235 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
236} 248}
237 249
238use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
239
240=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
241 251
242Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
243 253
244=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
245 255
246Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
257
258=cut
259
260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
261
262sub to_json ($) { $json_coder->encode ($_[0]) }
263sub from_json ($) { $json_coder->decode ($_[0]) }
247 264
248=item cf::lock_wait $string 265=item cf::lock_wait $string
249 266
250Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
251 268
305 }; 322 };
306 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
307 $guard 324 $guard
308} 325}
309 326
327=item cf::get_slot $time[, $priority[, $name]]
328
329Allocate $time seconds of blocking CPU time at priority C<$priority>:
330This call blocks and returns only when you have at least C<$time> seconds
331of cpu time till the next tick. The slot is only valid till the next cede.
332
333The optional C<$name> can be used to identify the job to run. It might be
334used for statistical purposes and should identify the same time-class.
335
336Useful for short background jobs.
337
338=cut
339
340our @SLOT_QUEUE;
341our $SLOT_QUEUE;
342
343$SLOT_QUEUE->cancel if $SLOT_QUEUE;
344$SLOT_QUEUE = Coro::async {
345 my $signal = new Coro::Signal;
346
347 while () {
348 next_job:
349 my $avail = cf::till_tick;
350 if ($avail > 0.01) {
351 for (0 .. $#SLOT_QUEUE) {
352 if ($SLOT_QUEUE[$_][0] < $avail) {
353 my $job = splice @SLOT_QUEUE, $_, 1, ();
354 $job->[2]->send;
355 Coro::cede;
356 goto next_job;
357 }
358 }
359 }
360
361 if (@SLOT_QUEUE) {
362 # we do not use wait_For_tick() as it returns immediately when tick is inactive
363 push @cf::WAIT_FOR_TICK, $signal;
364 $signal->wait;
365 } else {
366 Coro::schedule;
367 }
368 }
369};
370
371sub get_slot($;$$) {
372 my ($time, $pri, $name) = @_;
373
374 $time = $TICK * .6 if $time > $TICK * .6;
375 my $sig = new Coro::Signal;
376
377 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
378 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
379 $SLOT_QUEUE->ready;
380 $sig->wait;
381}
382
310=item cf::async { BLOCK } 383=item cf::async { BLOCK }
311 384
312Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
313C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 386C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
314thing you are allowed to do is call C<prio> on it. 387thing you are allowed to do is call C<prio> on it.
317 390
318BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
319 392
320=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
321 394
322The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
323always able to handle events or runnable, as crossfire+ is only partly 396is 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. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
325 399
326If it must be done, put the blocking parts into C<sync_job>. This will run 400If 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 401the given BLOCK in another coroutine while waiting for the result. The
328server will be frozen during this time, so the block should either finish 402server will be frozen during this time, so the block should either finish
329fast or be very important. 403fast or be very important.
389 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
390 464
391 $coro 465 $coro
392} 466}
393 467
394sub write_runtime { 468=item fork_call { }, $args
395 my $runtime = "$LOCALDIR/runtime";
396 469
397 # first touch the runtime file to show we are still running: 470Executes the given code block with the given arguments in a seperate
398 # the fsync below can take a very very long time. 471process, returning the results. Everything must be serialisable with
472Coro::Storable. May, of course, block. Note that the executed sub may
473never block itself or use any form of Event handling.
399 474
400 if (my $fh = aio_open $runtime, O_WRONLY, 0) { 475=cut
401 utime undef, undef, $fh;
402 }
403 476
404 my $guard = cf::lock_acquire "write_runtime"; 477sub _store_scalar {
405 478 open my $fh, ">", \my $buf
406 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 479 or die "fork_call: cannot open fh-to-buf in child : $!";
407 or return; 480 Storable::store_fd $_[0], $fh;
408
409 my $value = $cf::RUNTIME + 90 + 10;
410 # 10 is the runtime save interval, for a monotonic clock
411 # 60 allows for the watchdog to kill the server.
412
413 (aio_write $fh, 0, (length $value), $value, 0) <= 0
414 and return;
415
416 # always fsync - this file is important
417 aio_fsync $fh
418 and return;
419
420 # touch it again to show we are up-to-date
421 utime undef, undef, $fh;
422
423 close $fh 481 close $fh;
424 or return;
425 482
426 aio_rename "$runtime~", $runtime 483 $buf
427 and return; 484}
428 485
429 warn "runtime file written.\n";#d# 486sub fork_call(&@) {
487 my ($cb, @args) = @_;
430 488
489# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
490# or die "socketpair: $!";
491 pipe my $fh1, my $fh2
492 or die "pipe: $!";
493
494 if (my $pid = fork) {
495 close $fh2;
496
497 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
498 warn "pst<$res>" unless $res =~ /^pst/;
499 $res = Coro::Storable::thaw $res;
500
501 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
502
503 Carp::confess $$res unless "ARRAY" eq ref $res;
504
505 return wantarray ? @$res : $res->[-1];
506 } else {
507 reset_signals;
508 local $SIG{__WARN__};
509 local $SIG{__DIE__};
510 # just in case, this hack effectively disables event
511 # in the child. cleaner and slower would be canceling all watchers,
512 # but this works for the time being.
513 local $Coro::idle;
514 $Coro::current->prio (Coro::PRIO_MAX);
515
516 eval {
517 close $fh1;
518
519 my @res = eval { $cb->(@args) };
520
521 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
522 close $fh2;
523 };
524
525 warn $@ if $@;
526 _exit 0;
431 1 527 }
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=cut
540
541our $DB;
542
543sub db_init {
544 unless ($DB) {
545 $DB = BDB::db_create $DB_ENV;
546
547 cf::sync_job {
548 eval {
549 $DB->set_flags (BDB::CHKSUM);
550
551 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
552 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
553 cf::cleanup "db_open(db): $!" if $!;
554 };
555 cf::cleanup "db_open(db): $@" if $@;
556 };
557 }
558}
559
560sub db_get($$) {
561 my $key = "$_[0]/$_[1]";
562
563 cf::sync_job {
564 BDB::db_get $DB, undef, $key, my $data;
565
566 $! ? ()
567 : $data
568 }
569}
570
571sub db_put($$$) {
572 BDB::dbreq_pri 4;
573 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
574}
575
576=item cf::cache $id => [$paths...], $processversion => $process
577
578Generic caching function that returns the value of the resource $id,
579caching and regenerating as required.
580
581This function can block.
582
583=cut
584
585sub cache {
586 my ($id, $src, $processversion, $process) = @_;
587
588 my $meta =
589 join "\x00",
590 $processversion,
591 map {
592 aio_stat $_
593 and Carp::croak "$_: $!";
594
595 ($_, (stat _)[7,9])
596 } @$src;
597
598 my $dbmeta = db_get cache => "$id/meta";
599 if ($dbmeta ne $meta) {
600 # changed, we may need to process
601
602 my @data;
603 my $md5;
604
605 for (0 .. $#$src) {
606 0 <= aio_load $src->[$_], $data[$_]
607 or Carp::croak "$src->[$_]: $!";
608 }
609
610 # if processing is expensive, check
611 # checksum first
612 if (1) {
613 $md5 =
614 join "\x00",
615 $processversion,
616 map {
617 Coro::cede;
618 ($src->[$_], Digest::MD5::md5_hex $data[$_])
619 } 0.. $#$src;
620
621
622 my $dbmd5 = db_get cache => "$id/md5";
623 if ($dbmd5 eq $md5) {
624 db_put cache => "$id/meta", $meta;
625
626 return db_get cache => "$id/data";
627 }
628 }
629
630 my $t1 = Time::HiRes::time;
631 my $data = $process->(\@data);
632 my $t2 = Time::HiRes::time;
633
634 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
635
636 db_put cache => "$id/data", $data;
637 db_put cache => "$id/md5" , $md5;
638 db_put cache => "$id/meta", $meta;
639
640 return $data;
641 }
642
643 db_get cache => "$id/data"
432} 644}
433 645
434=item cf::datalog type => key => value, ... 646=item cf::datalog type => key => value, ...
435 647
436Log a datalog packet of the given type with the given key-value pairs. 648Log 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") 666attach callbacks/event handlers (a collection of which is called an "attachment")
455to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
456 668
457In the following description, CLASS can be any of C<global>, C<object> 669In 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 670C<player>, C<client> or C<map> (i.e. the attachable objects in
459crossfire+). 671Crossfire TRT).
460 672
461=over 4 673=over 4
462 674
463=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
464 676
666 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
667 } 879 }
668 880
669 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
670 } else { 882 } else {
671 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
672 } 884 }
673 885
674 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
675} 887}
676 888
716 "; 928 ";
717 die if $@; 929 die if $@;
718} 930}
719 931
720our $override; 932our $override;
721our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 933our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
722 934
723sub override { 935sub override {
724 $override = 1; 936 $override = 1;
725 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
726} 938}
727 939
728sub do_invoke { 940sub do_invoke {
729 my $event = shift; 941 my $event = shift;
730 my $callbacks = shift; 942 my $callbacks = shift;
731 943
732 @invoke_results = (); 944 @INVOKE_RESULTS = ();
733 945
734 local $override; 946 local $override;
735 947
736 for (@$callbacks) { 948 for (@$callbacks) {
737 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
754 966
755Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
756 968
757This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 969This 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 970removed in future versions), and there is no public API to access override
759results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
760 972
761=back 973=back
762 974
763=cut 975=cut
764 976
765############################################################################# 977#############################################################################
766# object support 978# object support
979#
980
981sub _can_merge {
982 my ($ob1, $ob2) = @_;
983
984 local $Storable::canonical = 1;
985 my $fob1 = Storable::freeze $ob1;
986 my $fob2 = Storable::freeze $ob2;
987
988 $fob1 eq $fob2
989}
767 990
768sub reattach { 991sub reattach {
769 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
770 my ($obj) = @_; 993 my ($obj) = @_;
771 994
874 or return; 1097 or return;
875 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
876 } 1099 }
877 1100
878 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
879 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
880 return ($data, $av); 1103 return ($data, $av);
881} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
882 1111
883############################################################################# 1112#############################################################################
884# command handling &c 1113# command handling &c
885 1114
886=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
899 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
900} 1129}
901 1130
902=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
903 1132
904Register a callbackf ro execution when the client sends an extcmd packet. 1133Register a callback for execution when the client sends an (synchronous)
1134extcmd packet. Ext commands will be processed in the order they are
1135received by the server, like other user commands. The first argument is
1136the logged-in player. Ext commands can only be processed after a player
1137has logged in successfully.
905 1138
906If the callback returns something, it is sent back as if reply was being 1139If the callback returns something, it is sent back as if reply was being
907called. 1140called.
908 1141
1142=item cf::register_exticmd $name => \&callback($ns,$packet);
1143
1144Register a callback for execution when the client sends an (asynchronous)
1145exticmd packet. Exti commands are processed by the server as soon as they
1146are received, i.e. out of order w.r.t. other commands. The first argument
1147is a client socket. Exti commands can be received anytime, even before
1148log-in.
1149
1150If the callback returns something, it is sent back as if reply was being
1151called.
1152
909=cut 1153=cut
910 1154
911sub register_extcmd { 1155sub register_extcmd {
912 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
913 1157
914 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
915} 1165}
916 1166
917cf::player->attach ( 1167cf::player->attach (
918 on_command => sub { 1168 on_command => sub {
919 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
928 cf::override; 1178 cf::override;
929 }, 1179 },
930 on_extcmd => sub { 1180 on_extcmd => sub {
931 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
932 1182
933 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
934 1184
935 if (ref $msg) { 1185 if (ref $msg) {
1186 my ($type, $reply, @payload) =
1187 "ARRAY" eq ref $msg
1188 ? @$msg
1189 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1190
936 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
937 if (my %reply = $cb->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
938 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
939 } 1195 if $reply;
940 } 1196 }
941 } else { 1197 } else {
942 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
943 } 1199 }
944 1200
945 cf::override; 1201 cf::override;
946 }, 1202 },
947); 1203);
948 1204
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 { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
984 for my $ext (<$LIBDIR/*.ext>) { 1209 for my $path (<$LIBDIR/*.ext>) {
985 next unless -r $ext; 1210 next unless -r $path;
986 eval { 1211
987 load_extension $ext; 1212 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1213 my $base = $1;
1214 my $pkg = $1;
1215 $pkg =~ s/[^[:word:]]/_/g;
1216 $pkg = "ext::$pkg";
1217
1218 open my $fh, "<:utf8", $path
1219 or die "$path: $!";
1220
1221 my $source = do { local $/; <$fh> };
1222
1223 my %ext = (
1224 path => $path,
1225 base => $base,
1226 pkg => $pkg,
1227 );
1228
1229 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1230 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1231
1232 $ext{source} =
1233 "package $pkg; use strict; use utf8;\n"
1234 . "#line 1 \"$path\"\n{\n"
1235 . $source
1236 . "\n};\n1";
1237
1238 $todo{$base} = \%ext;
1239 }
1240
1241 my %done;
1242 while (%todo) {
1243 my $progress;
1244
1245 while (my ($k, $v) = each %todo) {
1246 for (split /,\s*/, $v->{meta}{depends}) {
1247 goto skip
1248 unless exists $done{$_};
1249 }
1250
1251 warn "... loading '$k' into '$v->{pkg}'\n";
1252
1253 unless (eval $v->{source}) {
1254 my $msg = $@ ? "$v->{path}: $@\n"
1255 : "$v->{base}: extension inactive.\n";
1256
1257 if (exists $v->{meta}{mandatory}) {
1258 warn $msg;
1259 warn "mandatory extension failed to load, exiting.\n";
1260 exit 1;
1261 }
1262
1263 warn $msg;
1264 }
1265
1266 $done{$k} = delete $todo{$k};
1267 push @EXTS, $v->{pkg};
1268 $progress = 1;
988 1 1269 }
989 } or warn "$ext not loaded: $@"; 1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
990 } 1275 };
991} 1276}
992 1277
993############################################################################# 1278#############################################################################
1279
1280=back
994 1281
995=head2 CORE EXTENSIONS 1282=head2 CORE EXTENSIONS
996 1283
997Functions and methods that extend core crossfire objects. 1284Functions and methods that extend core crossfire objects.
998 1285
1085 $cf::PLAYER{$login} = $self; 1372 $cf::PLAYER{$login} = $self;
1086 1373
1087 $self 1374 $self
1088} 1375}
1089 1376
1377=item $player->send_msg ($channel, $msg, $color, [extra...])
1378
1379=cut
1380
1381sub send_msg {
1382 my $ns = shift->ns
1383 or return;
1384 $ns->send_msg (@_);
1385}
1386
1090=item $pl->quit_character 1387=item $pl->quit_character
1091 1388
1092Nukes the player without looking back. If logged in, the connection will 1389Nukes the player without looking back. If logged in, the connection will
1093be destroyed. May block for a long time. 1390be destroyed. May block for a long time.
1094 1391
1186 } 1483 }
1187 1484
1188 \@paths 1485 \@paths
1189} 1486}
1190 1487
1488=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1489
1490Expand crossfire pod fragments into protocol xml.
1491
1492=cut
1493
1494sub expand_cfpod {
1495 ((my $self), (local $_)) = @_;
1496
1497 # escape & and <
1498 s/&/&amp;/g;
1499 s/(?<![BIUGH])</&lt;/g;
1500
1501 # this is buggy, it needs to properly take care of nested <'s
1502
1503 1 while
1504 # replace B<>, I<>, U<> etc.
1505 s/B<([^\>]*)>/<b>$1<\/b>/
1506 || s/I<([^\>]*)>/<i>$1<\/i>/
1507 || s/U<([^\>]*)>/<u>$1<\/u>/
1508 # replace G<male|female> tags
1509 || s{G<([^>|]*)\|([^>]*)>}{
1510 $self->gender ? $2 : $1
1511 }ge
1512 # replace H<hint text>
1513 || s{H<([^\>]*)>}
1514 {
1515 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1516 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1517 "")
1518 [$self->{hintmode}]
1519 }ge;
1520
1521 # create single paragraphs (very hackish)
1522 s/(?<=\S)\n(?=\w)/ /g;
1523
1524 # compress some whitespace
1525 s/\s+\n/\n/g; # ws line-ends
1526 s/\n\n+/\n/g; # double lines
1527 s/^\n+//; # beginning lines
1528 s/\n+$//; # ending lines
1529
1530 $_
1531}
1532
1533sub hintmode {
1534 $_[0]{hintmode} = $_[1] if @_ > 1;
1535 $_[0]{hintmode}
1536}
1537
1191=item $player->ext_reply ($msgid, %msg) 1538=item $player->ext_reply ($msgid, @msg)
1192 1539
1193Sends an ext reply to the player. 1540Sends an ext reply to the player.
1194 1541
1195=cut 1542=cut
1196 1543
1197sub ext_reply($$%) { 1544sub ext_reply($$@) {
1198 my ($self, $id, %msg) = @_; 1545 my ($self, $id, @msg) = @_;
1199 1546
1200 $msg{msgid} = $id; 1547 if ($self->ns->extcmd == 2) {
1201 1548 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1202 $self->send ("ext " . cf::to_json \%msg); 1549 } elsif ($self->ns->extcmd == 1) {
1550 #TODO: version 1, remove
1551 unshift @msg, msgtype => "reply", msgid => $id;
1552 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1553 }
1203} 1554}
1204 1555
1205=item $player->ext_event ($type, %msg) 1556=item $player->ext_msg ($type, @msg)
1206 1557
1207Sends an ext event to the client. 1558Sends an ext event to the client.
1208 1559
1209=cut 1560=cut
1210 1561
1211sub ext_event($$%) { 1562sub ext_msg($$@) {
1212 my ($self, $type, %msg) = @_; 1563 my ($self, $type, @msg) = @_;
1213 1564
1214 $self->ns->ext_event ($type, %msg); 1565 $self->ns->ext_msg ($type, @msg);
1215} 1566}
1216 1567
1217=head3 cf::region 1568=head3 cf::region
1218 1569
1219=over 4 1570=over 4
1222 1573
1223package cf::region; 1574package cf::region;
1224 1575
1225=item cf::region::find_by_path $path 1576=item cf::region::find_by_path $path
1226 1577
1227Tries to decuce the probable region for a map knowing only its path. 1578Tries to decuce the likely region for a map knowing only its path.
1228 1579
1229=cut 1580=cut
1230 1581
1231sub find_by_path($) { 1582sub find_by_path($) {
1232 my ($path) = @_; 1583 my ($path) = @_;
1233 1584
1234 my ($match, $specificity); 1585 my ($match, $specificity);
1235 1586
1236 for my $region (list) { 1587 for my $region (list) {
1237 if ($region->match && $path =~ $region->match) { 1588 if ($region->{match} && $path =~ $region->{match}) {
1238 ($match, $specificity) = ($region, $region->specificity) 1589 ($match, $specificity) = ($region, $region->specificity)
1239 if $region->specificity > $specificity; 1590 if $region->specificity > $specificity;
1240 } 1591 }
1241 } 1592 }
1242 1593
1306 my ($self, $merge) = @_; 1657 my ($self, $merge) = @_;
1307 1658
1308 # we have to keep some variables in memory intact 1659 # we have to keep some variables in memory intact
1309 local $self->{path}; 1660 local $self->{path};
1310 local $self->{load_path}; 1661 local $self->{load_path};
1311 local $self->{deny_save};
1312 local $self->{deny_reset};
1313 1662
1314 $self->SUPER::thawer_merge ($merge); 1663 $self->SUPER::thawer_merge ($merge);
1315} 1664}
1316 1665
1317sub normalise { 1666sub normalise {
1364 $self->init; # pass $1 etc. 1713 $self->init; # pass $1 etc.
1365 return $self; 1714 return $self;
1366 } 1715 }
1367 } 1716 }
1368 1717
1369 Carp::carp "unable to resolve path '$path' (base '$base')."; 1718 Carp::cluck "unable to resolve path '$path' (base '$base').";
1370 () 1719 ()
1371} 1720}
1372 1721
1373sub init { 1722sub init {
1374 my ($self) = @_; 1723 my ($self) = @_;
1415sub change_all_map_light { 1764sub change_all_map_light {
1416 my ($change) = @_; 1765 my ($change) = @_;
1417 1766
1418 $_->change_map_light ($change) 1767 $_->change_map_light ($change)
1419 for grep $_->outdoor, values %cf::MAP; 1768 for grep $_->outdoor, values %cf::MAP;
1769}
1770
1771sub decay_objects {
1772 my ($self) = @_;
1773
1774 return if $self->{deny_reset};
1775
1776 $self->do_decay_objects;
1420} 1777}
1421 1778
1422sub unlink_save { 1779sub unlink_save {
1423 my ($self) = @_; 1780 my ($self) = @_;
1424 1781
1482 $self->load_header_orig 1839 $self->load_header_orig
1483 or return; 1840 or return;
1484 $self->prepare_orig; 1841 $self->prepare_orig;
1485 } 1842 }
1486 1843
1844 $self->{deny_reset} = 1
1845 if $self->no_reset;
1846
1487 $self->default_region (cf::region::find_by_path $self->{path}) 1847 $self->default_region (cf::region::find_by_path $self->{path})
1488 unless $self->default_region; 1848 unless $self->default_region;
1489 1849
1490 1 1850 1
1491} 1851}
1506 $map->{last_save} = $cf::RUNTIME; 1866 $map->{last_save} = $cf::RUNTIME;
1507 1867
1508 $map->load_header 1868 $map->load_header
1509 or return; 1869 or return;
1510 1870
1511 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1871 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1512 # doing this can freeze the server in a sync job, obviously 1872 # doing this can freeze the server in a sync job, obviously
1513 #$cf::WAIT_FOR_TICK->wait; 1873 #$cf::WAIT_FOR_TICK->wait;
1514 $map->reset; 1874 $map->reset;
1515 undef $guard; 1875 undef $guard;
1516 return find $path; 1876 return find $path;
1571 $self->set_darkness_map; 1931 $self->set_darkness_map;
1572 Coro::cede; 1932 Coro::cede;
1573 $self->activate; 1933 $self->activate;
1574 } 1934 }
1575 1935
1936 $self->{last_save} = $cf::RUNTIME;
1937 $self->last_access ($cf::RUNTIME);
1938
1576 $self->in_memory (cf::MAP_IN_MEMORY); 1939 $self->in_memory (cf::MAP_IN_MEMORY);
1577 } 1940 }
1578 1941
1579 $self->post_load; 1942 $self->post_load;
1580} 1943}
1582sub customise_for { 1945sub customise_for {
1583 my ($self, $ob) = @_; 1946 my ($self, $ob) = @_;
1584 1947
1585 return find "~" . $ob->name . "/" . $self->{path} 1948 return find "~" . $ob->name . "/" . $self->{path}
1586 if $self->per_player; 1949 if $self->per_player;
1950
1951# return find "?party/" . $ob->name . "/" . $self->{path}
1952# if $self->per_party;
1587 1953
1588 $self 1954 $self
1589} 1955}
1590 1956
1591# find and load all maps in the 3x3 area around a map 1957# find and load all maps in the 3x3 area around a map
1638 2004
1639 undef $MAP_PREFETCH{$path}; 2005 undef $MAP_PREFETCH{$path};
1640 $MAP_PREFETCHER ||= cf::async { 2006 $MAP_PREFETCHER ||= cf::async {
1641 while (%MAP_PREFETCH) { 2007 while (%MAP_PREFETCH) {
1642 for my $path (keys %MAP_PREFETCH) { 2008 for my $path (keys %MAP_PREFETCH) {
1643 my $map = find $path 2009 if (my $map = find $path) {
1644 or next;
1645 $map->load; 2010 $map->load;
2011 }
1646 2012
1647 delete $MAP_PREFETCH{$path}; 2013 delete $MAP_PREFETCH{$path};
1648 } 2014 }
1649 } 2015 }
1650 undef $MAP_PREFETCHER; 2016 undef $MAP_PREFETCHER;
1702 2068
1703sub reset_at { 2069sub reset_at {
1704 my ($self) = @_; 2070 my ($self) = @_;
1705 2071
1706 # TODO: safety, remove and allow resettable per-player maps 2072 # 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}; 2073 return 1e99 if $self->{deny_reset};
1709 2074
1710 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2075 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1711 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2076 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1712 2077
1723 my ($self) = @_; 2088 my ($self) = @_;
1724 2089
1725 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2090 my $lock = cf::lock_acquire "map_data:$self->{path}";
1726 2091
1727 return if $self->players; 2092 return if $self->players;
1728 return if $self->isa ("ext::map_per_player");#d#
1729 2093
1730 warn "resetting map ", $self->path;#d# 2094 warn "resetting map ", $self->path;
1731 2095
1732 $self->in_memory (cf::MAP_SWAPPED); 2096 $self->in_memory (cf::MAP_SWAPPED);
1733 2097
1734 # need to save uniques path 2098 # need to save uniques path
1735 unless ($self->{deny_save}) { 2099 unless ($self->{deny_save}) {
1767 $cf::MAP{$self->path} = $self; 2131 $cf::MAP{$self->path} = $self;
1768 2132
1769 $self->reset; # polite request, might not happen 2133 $self->reset; # polite request, might not happen
1770} 2134}
1771 2135
2136=item $maps = cf::map::tmp_maps
2137
2138Returns an arrayref with all map paths of currently instantiated and saved
2139maps. May block.
2140
2141=cut
2142
2143sub tmp_maps() {
2144 [
2145 map {
2146 utf8::decode $_;
2147 /\.map$/
2148 ? normalise $_
2149 : ()
2150 } @{ aio_readdir $TMPDIR or [] }
2151 ]
2152}
2153
2154=item $maps = cf::map::random_maps
2155
2156Returns an arrayref with all map paths of currently instantiated and saved
2157random maps. May block.
2158
2159=cut
2160
2161sub random_maps() {
2162 [
2163 map {
2164 utf8::decode $_;
2165 /\.map$/
2166 ? normalise "?random/$_"
2167 : ()
2168 } @{ aio_readdir $RANDOMDIR or [] }
2169 ]
2170}
2171
1772=item cf::map::unique_maps 2172=item cf::map::unique_maps
1773 2173
1774Returns an arrayref of paths of all shared maps that have 2174Returns an arrayref of paths of all shared maps that have
1775instantiated unique items. May block. 2175instantiated unique items. May block.
1776 2176
1777=cut 2177=cut
1778 2178
1779sub unique_maps() { 2179sub unique_maps() {
1780 my $files = aio_readdir $UNIQUEDIR 2180 [
1781 or return; 2181 map {
1782
1783 my @paths;
1784
1785 for (@$files) {
1786 utf8::decode $_; 2182 utf8::decode $_;
1787 next if /\.pst$/; 2183 /\.map$/
1788 next unless /^$PATH_SEP/o; 2184 ? normalise $_
1789 2185 : ()
1790 push @paths, cf::map::normalise $_; 2186 } @{ aio_readdir $UNIQUEDIR or [] }
1791 } 2187 ]
1792
1793 \@paths
1794} 2188}
1795 2189
1796package cf; 2190package cf;
1797 2191
1798=back 2192=back
1844 2238
1845 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2239 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1846 2240
1847 if ($self->{record_replies}) { 2241 if ($self->{record_replies}) {
1848 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2242 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2243
1849 } else { 2244 } else {
2245 my $pl = $self->contr;
2246
2247 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2248 my $dialog = $pl->{npc_dialog};
2249 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2250
2251 } else {
1850 $msg = $npc->name . " says: $msg" if $npc; 2252 $msg = $npc->name . " says: $msg" if $npc;
1851 $self->message ($msg, $flags); 2253 $self->message ($msg, $flags);
2254 }
1852 } 2255 }
2256}
2257
2258=item $object->send_msg ($channel, $msg, $color, [extra...])
2259
2260=cut
2261
2262sub cf::object::send_msg {
2263 my $pl = shift->contr
2264 or return;
2265 $pl->send_msg (@_);
1853} 2266}
1854 2267
1855=item $player_object->may ("access") 2268=item $player_object->may ("access")
1856 2269
1857Returns wether the given player is authorized to access resource "access" 2270Returns wether the given player is authorized to access resource "access"
1904 $self->deactivate_recursive; 2317 $self->deactivate_recursive;
1905 2318
1906 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2319 return if UNIVERSAL::isa $self->map, "ext::map_link";
1907 2320
1908 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2321 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1909 if $self->map; 2322 if $self->map && $self->map->{path} ne "{link}";
1910 2323
1911 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2324 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1912} 2325}
1913 2326
1914sub cf::object::player::leave_link { 2327sub cf::object::player::leave_link {
1915 my ($self, $map, $x, $y) = @_; 2328 my ($self, $map, $x, $y) = @_;
2329
2330 return unless $self->contr->active;
1916 2331
1917 my $link_pos = delete $self->{_link_pos}; 2332 my $link_pos = delete $self->{_link_pos};
1918 2333
1919 unless ($map) { 2334 unless ($map) {
1920 # restore original map position 2335 # restore original map position
1943 2358
1944 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2359 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1945 $self->enter_map ($map, $x, $y); 2360 $self->enter_map ($map, $x, $y);
1946} 2361}
1947 2362
1948cf::player->attach ( 2363=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1949 on_logout => sub {
1950 my ($pl) = @_;
1951 2364
1952 # abort map switching before logout 2365Moves the player to the given map-path and coordinates by first freezing
1953 if ($pl->ob->{_link_pos}) { 2366her, loading and preparing them map, calling the provided $check callback
1954 cf::sync_job { 2367that has to return the map if sucecssful, and then unfreezes the player on
1955 $pl->ob->leave_link 2368the new (success) or old (failed) map position. In either case, $done will
1956 }; 2369be called at the end of this process.
1957 }
1958 },
1959 on_login => sub {
1960 my ($pl) = @_;
1961 2370
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)
1981
1982=cut 2371=cut
2372
2373our $GOTOGEN;
1983 2374
1984sub cf::object::player::goto { 2375sub cf::object::player::goto {
1985 my ($self, $path, $x, $y) = @_; 2376 my ($self, $path, $x, $y, $check, $done) = @_;
2377
2378 # do generation counting so two concurrent goto's will be executed in-order
2379 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1986 2380
1987 $self->enter_link; 2381 $self->enter_link;
1988 2382
1989 (async { 2383 (async {
1990 my $map = eval { 2384 my $map = eval {
1991 my $map = cf::map::find $path; 2385 my $map = cf::map::find $path;
2386
2387 if ($map) {
1992 $map = $map->customise_for ($self) if $map; 2388 $map = $map->customise_for ($self);
2389 $map = $check->($map) if $check && $map;
2390 } else {
2391 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2392 }
2393
1993 $map 2394 $map
2395 };
2396
2397 if ($@) {
2398 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2399 LOG llevError | logBacktrace, Carp::longmess $@;
1994 } or 2400 }
1995 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1996 2401
2402 if ($gen == $self->{_goto_generation}) {
2403 delete $self->{_goto_generation};
1997 $self->leave_link ($map, $x, $y); 2404 $self->leave_link ($map, $x, $y);
2405 }
2406
2407 $done->() if $done;
1998 })->prio (1); 2408 })->prio (1);
1999} 2409}
2000 2410
2001=item $player_object->enter_exit ($exit_object) 2411=item $player_object->enter_exit ($exit_object)
2002 2412
2071 my $hp = $exit->stats->hp; 2481 my $hp = $exit->stats->hp;
2072 my $sp = $exit->stats->sp; 2482 my $sp = $exit->stats->sp;
2073 2483
2074 $self->enter_link; 2484 $self->enter_link;
2075 2485
2486 # if exit is damned, update players death & WoR home-position
2487 $self->contr->savebed ($slaying, $hp, $sp)
2488 if $exit->flag (FLAG_DAMNED);
2489
2076 (async { 2490 (async {
2077 $self->deactivate_recursive; # just to be sure 2491 $self->deactivate_recursive; # just to be sure
2078 unless (eval { 2492 unless (eval {
2079 $self->goto ($slaying, $hp, $sp); 2493 $self->goto ($slaying, $hp, $sp);
2080 2494
2107 2521
2108 utf8::encode $text; 2522 utf8::encode $text;
2109 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2523 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2110} 2524}
2111 2525
2526=item $client->send_msg ($channel, $msg, $color, [extra...])
2527
2528Send a drawinfo or msg packet to the client, formatting the msg for the
2529client if neccessary. C<$type> should be a string identifying the type of
2530the message, with C<log> being the default. If C<$color> is negative, suppress
2531the message unless the client supports the msg packet.
2532
2533=cut
2534
2535sub cf::client::send_msg {
2536 my ($self, $channel, $msg, $color, @extra) = @_;
2537
2538 $msg = $self->pl->expand_cfpod ($msg);
2539
2540 $color &= cf::NDI_CLIENT_MASK; # just in case...
2541
2542 if (ref $channel) {
2543 # send meta info to client, if not yet sent
2544 unless (exists $self->{channel}{$channel->{id}}) {
2545 $self->{channel}{$channel->{id}} = $channel;
2546 $self->ext_msg (channel_info => $channel);
2547 }
2548
2549 $channel = $channel->{id};
2550 }
2551
2552 return unless @extra || length $msg;
2553
2554 if ($self->can_msg) {
2555 # default colour, mask it out
2556 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2557 if $color & cf::NDI_DEF;
2558
2559 $self->send_packet ("msg " . $self->{json_coder}->encode (
2560 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2561 } else {
2562 if ($color >= 0) {
2563 # replace some tags by gcfclient-compatible ones
2564 for ($msg) {
2565 1 while
2566 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2567 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2568 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2569 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2570 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2571 }
2572
2573 $color &= cf::NDI_COLOR_MASK;
2574
2575 utf8::encode $msg;
2576
2577 if (0 && $msg =~ /\[/) {
2578 # COMMAND/INFO
2579 $self->send_packet ("drawextinfo $color 10 8 $msg")
2580 } else {
2581 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2582 $self->send_packet ("drawinfo $color $msg")
2583 }
2584 }
2585 }
2586}
2587
2112=item $client->ext_event ($type, %msg) 2588=item $client->ext_msg ($type, @msg)
2113 2589
2114Sends an exti event to the client. 2590Sends an ext event to the client.
2115 2591
2116=cut 2592=cut
2117 2593
2118sub cf::client::ext_event($$%) { 2594sub cf::client::ext_msg($$@) {
2119 my ($self, $type, %msg) = @_; 2595 my ($self, $type, @msg) = @_;
2120 2596
2597 my $extcmd = $self->extcmd;
2598
2599 if ($extcmd == 2) {
2600 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2601 } elsif ($extcmd == 1) { # TODO: remove
2121 $msg{msgtype} = "event_$type"; 2602 push @msg, msgtype => "event_$type";
2122 $self->send_packet ("ext " . cf::to_json \%msg); 2603 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2604 }
2123} 2605}
2124 2606
2125=item $success = $client->query ($flags, "text", \&cb) 2607=item $success = $client->query ($flags, "text", \&cb)
2126 2608
2127Queues a query to the client, calling the given callback with 2609Queues a query to the client, calling the given callback with
2128the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2610the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2129C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2611C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2130 2612
2131Queries can fail, so check the return code. Or don't, as queries will become 2613Queries can fail, so check the return code. Or don't, as queries will
2132reliable at some point in the future. 2614become reliable at some point in the future.
2133 2615
2134=cut 2616=cut
2135 2617
2136sub cf::client::query { 2618sub cf::client::query {
2137 my ($self, $flags, $text, $cb) = @_; 2619 my ($self, $flags, $text, $cb) = @_;
2145 utf8::encode $text; 2627 utf8::encode $text;
2146 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2628 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2147 2629
2148 $self->send_packet ($self->{query_queue}[0][0]) 2630 $self->send_packet ($self->{query_queue}[0][0])
2149 if @{ $self->{query_queue} } == 1; 2631 if @{ $self->{query_queue} } == 1;
2632
2633 1
2150} 2634}
2151 2635
2152cf::client->attach ( 2636cf::client->attach (
2637 on_connect => sub {
2638 my ($ns) = @_;
2639
2640 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2641 },
2153 on_reply => sub { 2642 on_reply => sub {
2154 my ($ns, $msg) = @_; 2643 my ($ns, $msg) = @_;
2155 2644
2156 # this weird shuffling is so that direct followup queries 2645 # this weird shuffling is so that direct followup queries
2157 # get handled first 2646 # get handled first
2169 } else { 2658 } else {
2170 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2659 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2171 } 2660 }
2172 } 2661 }
2173 }, 2662 },
2663 on_exticmd => sub {
2664 my ($ns, $buf) = @_;
2665
2666 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2667
2668 if (ref $msg) {
2669 my ($type, $reply, @payload) =
2670 "ARRAY" eq ref $msg
2671 ? @$msg
2672 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2673
2674 if (my $cb = $EXTICMD{$type}) {
2675 my @reply = $cb->($ns, @payload);
2676
2677 $ns->ext_reply ($reply, @reply)
2678 if $reply;
2679 }
2680 } else {
2681 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2682 }
2683
2684 cf::override;
2685 },
2174); 2686);
2175 2687
2176=item $client->async (\&cb) 2688=item $client->async (\&cb)
2177 2689
2178Create a new coroutine, running the specified callback. The coroutine will 2690Create a new coroutine, running the specified callback. The coroutine will
2219our $safe = new Safe "safe"; 2731our $safe = new Safe "safe";
2220our $safe_hole = new Safe::Hole; 2732our $safe_hole = new Safe::Hole;
2221 2733
2222$SIG{FPE} = 'IGNORE'; 2734$SIG{FPE} = 'IGNORE';
2223 2735
2224$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2736$safe->permit_only (Opcode::opset qw(
2737 :base_core :base_mem :base_orig :base_math
2738 grepstart grepwhile mapstart mapwhile
2739 sort time
2740));
2225 2741
2226# here we export the classes and methods available to script code 2742# here we export the classes and methods available to script code
2227 2743
2228=pod 2744=pod
2229 2745
2230The following functions and methods are available within a safe environment: 2746The following functions and methods are available within a safe environment:
2231 2747
2232 cf::object contr pay_amount pay_player map 2748 cf::object
2749 contr pay_amount pay_player map x y force_find force_add
2750 insert remove name archname title slaying race
2751
2233 cf::object::player player 2752 cf::object::player
2234 cf::player peaceful 2753 player
2235 cf::map trigger 2754
2755 cf::player
2756 peaceful
2757
2758 cf::map
2759 trigger
2236 2760
2237=cut 2761=cut
2238 2762
2239for ( 2763for (
2240 ["cf::object" => qw(contr pay_amount pay_player map)], 2764 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2765 insert remove inv name archname title slaying race)],
2241 ["cf::object::player" => qw(player)], 2766 ["cf::object::player" => qw(player)],
2242 ["cf::player" => qw(peaceful)], 2767 ["cf::player" => qw(peaceful)],
2243 ["cf::map" => qw(trigger)], 2768 ["cf::map" => qw(trigger)],
2244) { 2769) {
2245 no strict 'refs'; 2770 no strict 'refs';
2316=back 2841=back
2317 2842
2318=cut 2843=cut
2319 2844
2320############################################################################# 2845#############################################################################
2321
2322=head2 EXTENSION DATABASE SUPPORT
2323
2324Crossfire maintains a very simple database for extension use. It can
2325currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2326convert to/from binary).
2327
2328The parameter C<$family> should best start with the name of the extension
2329using it, it should be unique.
2330
2331=over 4
2332
2333=item $value = cf::db_get $family => $key
2334
2335Returns a single value from the database.
2336
2337=item cf::db_put $family => $key => $value
2338
2339Stores the given C<$value> in the family.
2340
2341=cut
2342
2343our $DB;
2344
2345sub db_init {
2346 unless ($DB) {
2347 $DB = BDB::db_create $DB_ENV;
2348
2349 cf::sync_job {
2350 eval {
2351 $DB->set_flags (BDB::CHKSUM);
2352
2353 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2354 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2355 cf::cleanup "db_open(db): $!" if $!;
2356 };
2357 cf::cleanup "db_open(db): $@" if $@;
2358 };
2359 }
2360}
2361
2362sub db_get($$) {
2363 my $key = "$_[0]/$_[1]";
2364
2365 cf::sync_job {
2366 BDB::db_get $DB, undef, $key, my $data;
2367
2368 $! ? ()
2369 : $data
2370 }
2371}
2372
2373sub db_put($$$) {
2374 BDB::dbreq_pri 4;
2375 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2376}
2377
2378=item cf::cache $id => [$paths...], $processversion => $process
2379
2380Generic caching function that returns the value of the resource $id,
2381caching and regenerating as required.
2382
2383This function can block.
2384
2385=cut
2386
2387sub cache {
2388 my ($id, $src, $processversion, $process) = @_;
2389
2390 my $meta =
2391 join "\x00",
2392 $processversion,
2393 map {
2394 aio_stat $_
2395 and Carp::croak "$_: $!";
2396
2397 ($_, (stat _)[7,9])
2398 } @$src;
2399
2400 my $dbmeta = db_get cache => "$id/meta";
2401 if ($dbmeta ne $meta) {
2402 # changed, we may need to process
2403
2404 my @data;
2405 my $md5;
2406
2407 for (0 .. $#$src) {
2408 0 <= aio_load $src->[$_], $data[$_]
2409 or Carp::croak "$src->[$_]: $!";
2410 }
2411
2412 # if processing is expensive, check
2413 # checksum first
2414 if (1) {
2415 $md5 =
2416 join "\x00",
2417 $processversion,
2418 map {
2419 Coro::cede;
2420 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2421 } 0.. $#$src;
2422
2423
2424 my $dbmd5 = db_get cache => "$id/md5";
2425 if ($dbmd5 eq $md5) {
2426 db_put cache => "$id/meta", $meta;
2427
2428 return db_get cache => "$id/data";
2429 }
2430 }
2431
2432 my $t1 = Time::HiRes::time;
2433 my $data = $process->(\@data);
2434 my $t2 = Time::HiRes::time;
2435
2436 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2437
2438 db_put cache => "$id/data", $data;
2439 db_put cache => "$id/md5" , $md5;
2440 db_put cache => "$id/meta", $meta;
2441
2442 return $data;
2443 }
2444
2445 db_get cache => "$id/data"
2446}
2447
2448=item fork_call { }, $args
2449
2450Executes the given code block with the given arguments in a seperate
2451process, returning the results. Everything must be serialisable with
2452Coro::Storable. May, of course, block. Note that the executed sub may
2453never block itself or use any form of Event handling.
2454
2455=cut
2456
2457sub fork_call(&@) {
2458 my ($cb, @args) = @_;
2459
2460# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2461# or die "socketpair: $!";
2462 pipe my $fh1, my $fh2
2463 or die "pipe: $!";
2464
2465 if (my $pid = fork) {
2466 close $fh2;
2467
2468 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2469 $res = Coro::Storable::thaw $res;
2470
2471 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2472
2473 die $$res unless "ARRAY" eq ref $res;
2474
2475 return wantarray ? @$res : $res->[-1];
2476 } else {
2477 reset_signals;
2478 local $SIG{__WARN__};
2479 local $SIG{__DIE__};
2480 eval {
2481 close $fh1;
2482
2483 my @res = eval { $cb->(@args) };
2484 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2485 };
2486
2487 warn $@ if $@;
2488 _exit 0;
2489 }
2490}
2491
2492
2493
2494#############################################################################
2495# the server's init and main functions 2846# the server's init and main functions
2496 2847
2497sub load_facedata($) { 2848sub load_facedata($) {
2498 my ($path) = @_; 2849 my ($path) = @_;
2499 2850
2511 { 2862 {
2512 my $faces = $facedata->{faceinfo}; 2863 my $faces = $facedata->{faceinfo};
2513 2864
2514 while (my ($face, $info) = each %$faces) { 2865 while (my ($face, $info) = each %$faces) {
2515 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2866 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2516 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2867 cf::face::set_visibility $idx, $info->{visibility};
2868 cf::face::set_magicmap $idx, $info->{magicmap};
2517 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2869 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2518 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2870 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2519 Coro::cede; 2871
2872 cf::cede_to_tick;
2520 } 2873 }
2521 2874
2522 while (my ($face, $info) = each %$faces) { 2875 while (my ($face, $info) = each %$faces) {
2523 next unless $info->{smooth}; 2876 next unless $info->{smooth};
2524 my $idx = cf::face::find $face 2877 my $idx = cf::face::find $face
2525 or next; 2878 or next;
2526 if (my $smooth = cf::face::find $info->{smooth}) { 2879 if (my $smooth = cf::face::find $info->{smooth}) {
2880 cf::face::set_smooth $idx, $smooth;
2527 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2881 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2528 } else { 2882 } else {
2529 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2883 warn "smooth face '$info->{smooth}' not found for face '$face'";
2530 } 2884 }
2531 Coro::cede; 2885
2886 cf::cede_to_tick;
2532 } 2887 }
2533 } 2888 }
2534 2889
2535 { 2890 {
2536 my $anims = $facedata->{animinfo}; 2891 my $anims = $facedata->{animinfo};
2537 2892
2538 while (my ($anim, $info) = each %$anims) { 2893 while (my ($anim, $info) = each %$anims) {
2539 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2894 cf::anim::set $anim, $info->{frames}, $info->{facings};
2540 Coro::cede; 2895 cf::cede_to_tick;
2541 } 2896 }
2542 2897
2543 cf::anim::invalidate_all; # d'oh 2898 cf::anim::invalidate_all; # d'oh
2544 } 2899 }
2545 2900
2901 {
2902 # TODO: for gcfclient pleasure, we should give resources
2903 # that gcfclient doesn't grok a >10000 face index.
2904 my $res = $facedata->{resource};
2905 my $enc = JSON::XS->new->utf8->canonical;
2906
2907 my $soundconf = delete $res->{"res/sound.conf"};
2908
2909 while (my ($name, $info) = each %$res) {
2910 my $meta = $enc->encode ({
2911 name => $name,
2912 %{ $info->{meta} || {} },
2913 });
2914
2915 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2916
2917 if ($info->{type} & 1) {
2918 # prepend meta info
2919
2920 my $data = pack "(w/a*)*", $meta, $info->{data};
2921 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2922
2923 cf::face::set_data $idx, 0, $data, $chk;
2924 } else {
2925 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2926 }
2927
2928 cf::face::set_type $idx, $info->{type};
2929
2930 cf::cede_to_tick;
2931 }
2932
2933 if ($soundconf) {
2934 $soundconf = $enc->decode (delete $soundconf->{data});
2935
2936 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2937 my $sound = $soundconf->{compat}[$_]
2938 or next;
2939
2940 my $face = cf::face::find "sound/$sound->[1]";
2941 cf::sound::set $sound->[0] => $face;
2942 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2943 }
2944
2945 while (my ($k, $v) = each %{$soundconf->{event}}) {
2946 my $face = cf::face::find "sound/$v";
2947 cf::sound::set $k => $face;
2948 }
2949 }
2950 }
2951
2546 1 2952 1
2547} 2953}
2954
2955register_exticmd fx_want => sub {
2956 my ($ns, $want) = @_;
2957
2958 while (my ($k, $v) = each %$want) {
2959 $ns->fx_want ($k, $v);
2960 }
2961};
2548 2962
2549sub reload_regions { 2963sub reload_regions {
2550 load_resource_file "$MAPDIR/regions" 2964 load_resource_file "$MAPDIR/regions"
2551 or die "unable to load regions file\n"; 2965 or die "unable to load regions file\n";
2966
2967 for (cf::region::list) {
2968 $_->{match} = qr/$_->{match}/
2969 if exists $_->{match};
2970 }
2552} 2971}
2553 2972
2554sub reload_facedata { 2973sub reload_facedata {
2555 load_facedata "$DATADIR/facedata" 2974 load_facedata "$DATADIR/facedata"
2556 or die "unable to load facedata\n"; 2975 or die "unable to load facedata\n";
2557} 2976}
2558 2977
2559sub reload_archetypes { 2978sub reload_archetypes {
2560 load_resource_file "$DATADIR/archetypes" 2979 load_resource_file "$DATADIR/archetypes"
2561 or die "unable to load archetypes\n"; 2980 or die "unable to load archetypes\n";
2981 #d# NEED to laod twice to resolve forward references
2982 # this really needs to be done in an extra post-pass
2983 # (which needs to be synchronous, so solve it differently)
2984 load_resource_file "$DATADIR/archetypes"
2985 or die "unable to load archetypes\n";
2562} 2986}
2563 2987
2564sub reload_treasures { 2988sub reload_treasures {
2565 load_resource_file "$DATADIR/treasures" 2989 load_resource_file "$DATADIR/treasures"
2566 or die "unable to load treasurelists\n"; 2990 or die "unable to load treasurelists\n";
2569sub reload_resources { 2993sub reload_resources {
2570 warn "reloading resource files...\n"; 2994 warn "reloading resource files...\n";
2571 2995
2572 reload_regions; 2996 reload_regions;
2573 reload_facedata; 2997 reload_facedata;
2998 #reload_archetypes;#d#
2574 reload_archetypes; 2999 reload_archetypes;
2575 reload_treasures; 3000 reload_treasures;
2576 3001
2577 warn "finished reloading resource files\n"; 3002 warn "finished reloading resource files\n";
2578} 3003}
2635 }, 3060 },
2636 ); 3061 );
2637 } 3062 }
2638} 3063}
2639 3064
3065sub write_runtime {
3066 my $runtime = "$LOCALDIR/runtime";
3067
3068 # first touch the runtime file to show we are still running:
3069 # the fsync below can take a very very long time.
3070
3071 IO::AIO::aio_utime $runtime, undef, undef;
3072
3073 my $guard = cf::lock_acquire "write_runtime";
3074
3075 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3076 or return;
3077
3078 my $value = $cf::RUNTIME + 90 + 10;
3079 # 10 is the runtime save interval, for a monotonic clock
3080 # 60 allows for the watchdog to kill the server.
3081
3082 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3083 and return;
3084
3085 # always fsync - this file is important
3086 aio_fsync $fh
3087 and return;
3088
3089 # touch it again to show we are up-to-date
3090 aio_utime $fh, undef, undef;
3091
3092 close $fh
3093 or return;
3094
3095 aio_rename "$runtime~", $runtime
3096 and return;
3097
3098 warn "runtime file written.\n";
3099
3100 1
3101}
3102
2640sub emergency_save() { 3103sub emergency_save() {
2641 my $freeze_guard = cf::freeze_mainloop; 3104 my $freeze_guard = cf::freeze_mainloop;
2642 3105
2643 warn "enter emergency perl save\n"; 3106 warn "enter emergency perl save\n";
2644 3107
2719 %EXT_CORO = (); 3182 %EXT_CORO = ();
2720 3183
2721 warn "removing commands"; 3184 warn "removing commands";
2722 %COMMAND = (); 3185 %COMMAND = ();
2723 3186
2724 warn "removing ext commands"; 3187 warn "removing ext/exti commands";
2725 %EXTCMD = (); 3188 %EXTCMD = ();
3189 %EXTICMD = ();
2726 3190
2727 warn "unloading/nuking all extensions"; 3191 warn "unloading/nuking all extensions";
2728 for my $pkg (@EXTS) { 3192 for my $pkg (@EXTS) {
2729 warn "... unloading $pkg"; 3193 warn "... unloading $pkg";
2730 3194
2848 my $signal = new Coro::Signal; 3312 my $signal = new Coro::Signal;
2849 push @WAIT_FOR_TICK_BEGIN, $signal; 3313 push @WAIT_FOR_TICK_BEGIN, $signal;
2850 $signal->wait; 3314 $signal->wait;
2851} 3315}
2852 3316
3317 my $min = 1e6;#d#
3318 my $avg = 10;
2853$TICK_WATCHER = Event->timer ( 3319$TICK_WATCHER = Event->timer (
2854 reentrant => 0, 3320 reentrant => 0,
2855 parked => 1, 3321 parked => 1,
2856 prio => 0, 3322 prio => 0,
2857 at => $NEXT_TICK || $TICK, 3323 at => $NEXT_TICK || $TICK,
2864 } 3330 }
2865 3331
2866 $NOW = $tick_start = Event::time; 3332 $NOW = $tick_start = Event::time;
2867 3333
2868 cf::server_tick; # one server iteration 3334 cf::server_tick; # one server iteration
3335
3336 0 && sync_job {#d#
3337 for(1..10) {
3338 my $t = Event::time;
3339 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3340 or die;
3341
3342 $map->width (50);
3343 $map->height (50);
3344 $map->alloc;
3345 $map->_load_objects ("/tmp/x.map", 1);
3346 my $t = Event::time - $t;
3347
3348 #next unless $t < 0.0013;#d#
3349 if ($t < $min) {
3350 $min = $t;
3351 }
3352 $avg = $avg * 0.99 + $t * 0.01;
3353 }
3354 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3355 exit 0;
3356 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3357 };
2869 3358
2870 $RUNTIME += $TICK; 3359 $RUNTIME += $TICK;
2871 $NEXT_TICK += $TICK; 3360 $NEXT_TICK += $TICK;
2872 3361
2873 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3362 if ($NOW >= $NEXT_RUNTIME_WRITE) {

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines