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.276 by root, Sun Jun 10 04:05:47 2007 UTC vs.
Revision 1.347 by root, Thu Aug 30 05:16:09 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 ();
25use BDB (); 27use BDB ();
26use Data::Dumper; 28use Data::Dumper;
27use Digest::MD5; 29use Digest::MD5;
28use Fcntl; 30use Fcntl;
29use YAML::Syck (); 31use YAML::Syck ();
30use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
31use Time::HiRes; 33use Time::HiRes;
32use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
33 36
34# configure various modules to our taste 37# configure various modules to our taste
35# 38#
36$Storable::canonical = 1; # reduce rsync transfers 39$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator 40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
49our %COMMAND = (); 52our %COMMAND = ();
50our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
51 54
52our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
53our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
56 60
57our $RELOAD; # number of reloads so far 61our $RELOAD; # number of reloads so far
58our @EVENT; 62our @EVENT;
164 168
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only 169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process 170returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing. 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
168 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
178
169=back 179=back
170 180
171=cut 181=cut
172 182
173BEGIN { 183BEGIN {
206} 216}
207 217
208$Event::DIED = sub { 218$Event::DIED = sub {
209 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
210}; 220};
221
222#############################################################################
211 223
212=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
213 225
214=over 4 226=over 4
215 227
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d 247 $d
236 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
237} 249}
238 250
239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
240
241=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
242 252
243Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
244 254
245=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
246 256
247Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
258
259=cut
260
261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
262
263sub to_json ($) { $json_coder->encode ($_[0]) }
264sub from_json ($) { $json_coder->decode ($_[0]) }
248 265
249=item cf::lock_wait $string 266=item cf::lock_wait $string
250 267
251Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
252 269
254 271
255Wait until the given lock is available and then acquires it and returns 272Wait until the given lock is available and then acquires it and returns
256a Coro::guard object. If the guard object gets destroyed (goes out of scope, 273a Coro::guard object. If the guard object gets destroyed (goes out of scope,
257for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
258returned. 275returned.
276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
259 279
260Lock names should begin with a unique identifier (for example, cf::map::find 280Lock names should begin with a unique identifier (for example, cf::map::find
261uses map_find and cf::map::load uses map_load). 281uses map_find and cf::map::load uses map_load).
262 282
263=item $locked = cf::lock_active $string 283=item $locked = cf::lock_active $string
306 }; 326 };
307 $TICK_WATCHER->stop; 327 $TICK_WATCHER->stop;
308 $guard 328 $guard
309} 329}
310 330
331=item cf::get_slot $time[, $priority[, $name]]
332
333Allocate $time seconds of blocking CPU time at priority C<$priority>:
334This call blocks and returns only when you have at least C<$time> seconds
335of cpu time till the next tick. The slot is only valid till the next cede.
336
337The optional C<$name> can be used to identify the job to run. It might be
338used for statistical purposes and should identify the same time-class.
339
340Useful for short background jobs.
341
342=cut
343
344our @SLOT_QUEUE;
345our $SLOT_QUEUE;
346
347$SLOT_QUEUE->cancel if $SLOT_QUEUE;
348$SLOT_QUEUE = Coro::async {
349 my $signal = new Coro::Signal;
350
351 while () {
352 next_job:
353 my $avail = cf::till_tick;
354 if ($avail > 0.01) {
355 for (0 .. $#SLOT_QUEUE) {
356 if ($SLOT_QUEUE[$_][0] < $avail) {
357 my $job = splice @SLOT_QUEUE, $_, 1, ();
358 $job->[2]->send;
359 Coro::cede;
360 goto next_job;
361 }
362 }
363 }
364
365 if (@SLOT_QUEUE) {
366 # we do not use wait_For_tick() as it returns immediately when tick is inactive
367 push @cf::WAIT_FOR_TICK, $signal;
368 $signal->wait;
369 } else {
370 Coro::schedule;
371 }
372 }
373};
374
375sub get_slot($;$$) {
376 my ($time, $pri, $name) = @_;
377
378 $time = $TICK * .6 if $time > $TICK * .6;
379 my $sig = new Coro::Signal;
380
381 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
382 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
383 $SLOT_QUEUE->ready;
384 $sig->wait;
385}
386
311=item cf::async { BLOCK } 387=item cf::async { BLOCK }
312 388
313Currently the same as Coro::async_pool, meaning you cannot use 389Currently the same as Coro::async_pool, meaning you cannot use
314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 390C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it. 391thing you are allowed to do is call C<prio> on it.
318 394
319BEGIN { *async = \&Coro::async_pool } 395BEGIN { *async = \&Coro::async_pool }
320 396
321=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
322 398
323The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
324always able to handle events or runnable, as crossfire+ is only partly 400is always able to handle events or runnable, as Crossfire TRT is only
325reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 401partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
402acceptable.
326 403
327If it must be done, put the blocking parts into C<sync_job>. This will run 404If it must be done, put the blocking parts into C<sync_job>. This will run
328the given BLOCK in another coroutine while waiting for the result. The 405the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish 406server will be frozen during this time, so the block should either finish
330fast or be very important. 407fast or be very important.
390 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
391 468
392 $coro 469 $coro
393} 470}
394 471
395sub write_runtime { 472=item fork_call { }, $args
396 my $runtime = "$LOCALDIR/runtime";
397 473
398 # first touch the runtime file to show we are still running: 474Executes the given code block with the given arguments in a seperate
399 # the fsync below can take a very very long time. 475process, returning the results. Everything must be serialisable with
476Coro::Storable. May, of course, block. Note that the executed sub may
477never block itself or use any form of Event handling.
400 478
401 IO::AIO::aio_utime $runtime, undef, undef; 479=cut
402 480
403 my $guard = cf::lock_acquire "write_runtime"; 481sub fork_call(&@) {
482 my ($cb, @args) = @_;
404 483
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 484 # we seemingly have to make a local copy of the whole thing,
406 or return; 485 # otherwise perl prematurely frees the stuff :/
486 # TODO: investigate and fix (liekly this will be rather laborious)
407 487
408 my $value = $cf::RUNTIME + 90 + 10; 488 my @res = Coro::Util::fork_eval {
409 # 10 is the runtime save interval, for a monotonic clock 489 reset_signals;
410 # 60 allows for the watchdog to kill the server. 490 &$cb
491 }, @args;
411 492
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0 493 wantarray ? @res : $res[-1]
413 and return; 494}
414 495
415 # always fsync - this file is important 496=item $value = cf::db_get $family => $key
416 aio_fsync $fh
417 and return;
418 497
419 # touch it again to show we are up-to-date 498Returns a single value from the environment database.
420 aio_utime $fh, undef, undef;
421 499
422 close $fh 500=item cf::db_put $family => $key => $value
423 or return;
424 501
425 aio_rename "$runtime~", $runtime 502Stores the given C<$value> in the family. It can currently store binary
426 and return; 503data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
427 504
428 warn "runtime file written.\n"; 505=cut
429 506
507our $DB;
508
509sub db_init {
510 unless ($DB) {
511 $DB = BDB::db_create $DB_ENV;
512
513 cf::sync_job {
514 eval {
515 $DB->set_flags (BDB::CHKSUM);
516
517 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
518 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
519 cf::cleanup "db_open(db): $!" if $!;
520 };
521 cf::cleanup "db_open(db): $@" if $@;
522 };
430 1 523 }
524}
525
526sub db_get($$) {
527 my $key = "$_[0]/$_[1]";
528
529 cf::sync_job {
530 BDB::db_get $DB, undef, $key, my $data;
531
532 $! ? ()
533 : $data
534 }
535}
536
537sub db_put($$$) {
538 BDB::dbreq_pri 4;
539 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
540}
541
542=item cf::cache $id => [$paths...], $processversion => $process
543
544Generic caching function that returns the value of the resource $id,
545caching and regenerating as required.
546
547This function can block.
548
549=cut
550
551sub cache {
552 my ($id, $src, $processversion, $process) = @_;
553
554 my $meta =
555 join "\x00",
556 $processversion,
557 map {
558 aio_stat $_
559 and Carp::croak "$_: $!";
560
561 ($_, (stat _)[7,9])
562 } @$src;
563
564 my $dbmeta = db_get cache => "$id/meta";
565 if ($dbmeta ne $meta) {
566 # changed, we may need to process
567
568 my @data;
569 my $md5;
570
571 for (0 .. $#$src) {
572 0 <= aio_load $src->[$_], $data[$_]
573 or Carp::croak "$src->[$_]: $!";
574 }
575
576 # if processing is expensive, check
577 # checksum first
578 if (1) {
579 $md5 =
580 join "\x00",
581 $processversion,
582 map {
583 cf::cede_to_tick;
584 ($src->[$_], Digest::MD5::md5_hex $data[$_])
585 } 0.. $#$src;
586
587
588 my $dbmd5 = db_get cache => "$id/md5";
589 if ($dbmd5 eq $md5) {
590 db_put cache => "$id/meta", $meta;
591
592 return db_get cache => "$id/data";
593 }
594 }
595
596 my $t1 = Time::HiRes::time;
597 my $data = $process->(\@data);
598 my $t2 = Time::HiRes::time;
599
600 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
601
602 db_put cache => "$id/data", $data;
603 db_put cache => "$id/md5" , $md5;
604 db_put cache => "$id/meta", $meta;
605
606 return $data;
607 }
608
609 db_get cache => "$id/data"
431} 610}
432 611
433=item cf::datalog type => key => value, ... 612=item cf::datalog type => key => value, ...
434 613
435Log a datalog packet of the given type with the given key-value pairs. 614Log a datalog packet of the given type with the given key-value pairs.
453attach callbacks/event handlers (a collection of which is called an "attachment") 632attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
455 634
456In the following description, CLASS can be any of C<global>, C<object> 635In the following description, CLASS can be any of C<global>, C<object>
457C<player>, C<client> or C<map> (i.e. the attachable objects in 636C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+). 637Crossfire TRT).
459 638
460=over 4 639=over 4
461 640
462=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
463 642
665 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
666 } 845 }
667 846
668 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
669 } else { 848 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
671 } 850 }
672 851
673 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
674} 853}
675 854
715 "; 894 ";
716 die if $@; 895 die if $@;
717} 896}
718 897
719our $override; 898our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 899our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721 900
722sub override { 901sub override {
723 $override = 1; 902 $override = 1;
724 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
725} 904}
726 905
727sub do_invoke { 906sub do_invoke {
728 my $event = shift; 907 my $event = shift;
729 my $callbacks = shift; 908 my $callbacks = shift;
730 909
731 @invoke_results = (); 910 @INVOKE_RESULTS = ();
732 911
733 local $override; 912 local $override;
734 913
735 for (@$callbacks) { 914 for (@$callbacks) {
736 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
753 932
754Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
755 934
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 935This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757removed in future versions), and there is no public API to access override 936removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
759 938
760=back 939=back
761 940
762=cut 941=cut
763 942
764############################################################################# 943#############################################################################
765# object support 944# object support
945#
946
947sub _can_merge {
948 my ($ob1, $ob2) = @_;
949
950 local $Storable::canonical = 1;
951 my $fob1 = Storable::freeze $ob1;
952 my $fob2 = Storable::freeze $ob2;
953
954 $fob1 eq $fob2
955}
766 956
767sub reattach { 957sub reattach {
768 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
769 my ($obj) = @_; 959 my ($obj) = @_;
770 960
877 warn sprintf "loading %s (%d)\n", 1067 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []}; 1068 $filename, length $data, scalar @{$av || []};
879 return ($data, $av); 1069 return ($data, $av);
880} 1070}
881 1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
1077
882############################################################################# 1078#############################################################################
883# command handling &c 1079# command handling &c
884 1080
885=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
886 1082
898 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
899} 1095}
900 1096
901=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
902 1098
903Register a callbackf ro execution when the client sends an extcmd packet. 1099Register a callback for execution when the client sends an (synchronous)
1100extcmd packet. Ext commands will be processed in the order they are
1101received by the server, like other user commands. The first argument is
1102the logged-in player. Ext commands can only be processed after a player
1103has logged in successfully.
904 1104
905If the callback returns something, it is sent back as if reply was being 1105If the callback returns something, it is sent back as if reply was being
906called. 1106called.
907 1107
1108=item cf::register_exticmd $name => \&callback($ns,$packet);
1109
1110Register a callback for execution when the client sends an (asynchronous)
1111exticmd packet. Exti commands are processed by the server as soon as they
1112are received, i.e. out of order w.r.t. other commands. The first argument
1113is a client socket. Exti commands can be received anytime, even before
1114log-in.
1115
1116If the callback returns something, it is sent back as if reply was being
1117called.
1118
908=cut 1119=cut
909 1120
910sub register_extcmd { 1121sub register_extcmd {
911 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
912 1123
913 $EXTCMD{$name} = $cb; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
914} 1131}
915 1132
916cf::player->attach ( 1133cf::player->attach (
917 on_command => sub { 1134 on_command => sub {
918 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
927 cf::override; 1144 cf::override;
928 }, 1145 },
929 on_extcmd => sub { 1146 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
931 1148
932 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1150
934 if (ref $msg) { 1151 if (ref $msg) {
1152 my ($type, $reply, @payload) =
1153 "ARRAY" eq ref $msg
1154 ? @$msg
1155 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1156
1157 my @reply;
1158
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
936 if (my %reply = $cb->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
937 $pl->ext_reply ($msg->{msgid}, %reply);
938 }
939 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
940 } else { 1166 } else {
941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942 } 1168 }
943 1169
944 cf::override; 1170 cf::override;
945 }, 1171 },
946); 1172);
947 1173
948sub load_extension {
949 my ($path) = @_;
950
951 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
952 my $base = $1;
953 my $pkg = $1;
954 $pkg =~ s/[^[:word:]]/_/g;
955 $pkg = "ext::$pkg";
956
957 warn "... loading '$path' into '$pkg'\n";
958
959 open my $fh, "<:utf8", $path
960 or die "$path: $!";
961
962 my $source =
963 "package $pkg; use strict; use utf8;\n"
964 . "#line 1 \"$path\"\n{\n"
965 . (do { local $/; <$fh> })
966 . "\n};\n1";
967
968 unless (eval $source) {
969 my $msg = $@ ? "$path: $@\n"
970 : "extension disabled.\n";
971 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
972 warn $@;
973 warn "mandatory extension failed to load, exiting.\n";
974 exit 1;
975 }
976 die $@;
977 }
978
979 push @EXTS, $pkg;
980}
981
982sub load_extensions { 1174sub load_extensions {
1175 cf::sync_job {
1176 my %todo;
1177
983 for my $ext (<$LIBDIR/*.ext>) { 1178 for my $path (<$LIBDIR/*.ext>) {
984 next unless -r $ext; 1179 next unless -r $path;
985 eval { 1180
986 load_extension $ext; 1181 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1182 my $base = $1;
1183 my $pkg = $1;
1184 $pkg =~ s/[^[:word:]]/_/g;
1185 $pkg = "ext::$pkg";
1186
1187 open my $fh, "<:utf8", $path
1188 or die "$path: $!";
1189
1190 my $source = do { local $/; <$fh> };
1191
1192 my %ext = (
1193 path => $path,
1194 base => $base,
1195 pkg => $pkg,
1196 );
1197
1198 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1199 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1200
1201 $ext{source} =
1202 "package $pkg; use strict; use utf8;\n"
1203 . "#line 1 \"$path\"\n{\n"
1204 . $source
1205 . "\n};\n1";
1206
1207 $todo{$base} = \%ext;
1208 }
1209
1210 my %done;
1211 while (%todo) {
1212 my $progress;
1213
1214 while (my ($k, $v) = each %todo) {
1215 for (split /,\s*/, $v->{meta}{depends}) {
1216 goto skip
1217 unless exists $done{$_};
1218 }
1219
1220 warn "... loading '$k' into '$v->{pkg}'\n";
1221
1222 unless (eval $v->{source}) {
1223 my $msg = $@ ? "$v->{path}: $@\n"
1224 : "$v->{base}: extension inactive.\n";
1225
1226 if (exists $v->{meta}{mandatory}) {
1227 warn $msg;
1228 warn "mandatory extension failed to load, exiting.\n";
1229 exit 1;
1230 }
1231
1232 warn $msg;
1233 }
1234
1235 $done{$k} = delete $todo{$k};
1236 push @EXTS, $v->{pkg};
1237 $progress = 1;
987 1 1238 }
988 } or warn "$ext not loaded: $@"; 1239
1240 skip:
1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1242 unless $progress;
1243 }
989 } 1244 };
990} 1245}
991 1246
992############################################################################# 1247#############################################################################
1248
1249=back
993 1250
994=head2 CORE EXTENSIONS 1251=head2 CORE EXTENSIONS
995 1252
996Functions and methods that extend core crossfire objects. 1253Functions and methods that extend core crossfire objects.
997 1254
1068 1325
1069 aio_mkdir playerdir $pl, 0770; 1326 aio_mkdir playerdir $pl, 0770;
1070 $pl->{last_save} = $cf::RUNTIME; 1327 $pl->{last_save} = $cf::RUNTIME;
1071 1328
1072 $pl->save_pl ($path); 1329 $pl->save_pl ($path);
1073 Coro::cede; 1330 cf::cede_to_tick;
1074} 1331}
1075 1332
1076sub new($) { 1333sub new($) {
1077 my ($login) = @_; 1334 my ($login) = @_;
1078 1335
1082 $self->{deny_save} = 1; 1339 $self->{deny_save} = 1;
1083 1340
1084 $cf::PLAYER{$login} = $self; 1341 $cf::PLAYER{$login} = $self;
1085 1342
1086 $self 1343 $self
1344}
1345
1346=item $player->send_msg ($channel, $msg, $color, [extra...])
1347
1348=cut
1349
1350sub send_msg {
1351 my $ns = shift->ns
1352 or return;
1353 $ns->send_msg (@_);
1087} 1354}
1088 1355
1089=item $pl->quit_character 1356=item $pl->quit_character
1090 1357
1091Nukes the player without looking back. If logged in, the connection will 1358Nukes the player without looking back. If logged in, the connection will
1185 } 1452 }
1186 1453
1187 \@paths 1454 \@paths
1188} 1455}
1189 1456
1457=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1458
1459Expand crossfire pod fragments into protocol xml.
1460
1461=cut
1462
1463sub expand_cfpod {
1464 ((my $self), (local $_)) = @_;
1465
1466 # escape & and <
1467 s/&/&amp;/g;
1468 s/(?<![BIUGH])</&lt;/g;
1469
1470 # this is buggy, it needs to properly take care of nested <'s
1471
1472 1 while
1473 # replace B<>, I<>, U<> etc.
1474 s/B<([^\>]*)>/<b>$1<\/b>/
1475 || s/I<([^\>]*)>/<i>$1<\/i>/
1476 || s/U<([^\>]*)>/<u>$1<\/u>/
1477 # replace G<male|female> tags
1478 || s{G<([^>|]*)\|([^>]*)>}{
1479 $self->gender ? $2 : $1
1480 }ge
1481 # replace H<hint text>
1482 || s{H<([^\>]*)>}
1483 {
1484 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1485 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1486 "")
1487 [$self->{hintmode}]
1488 }ge;
1489
1490 # create single paragraphs (very hackish)
1491 s/(?<=\S)\n(?=\w)/ /g;
1492
1493 # compress some whitespace
1494 s/\s+\n/\n/g; # ws line-ends
1495 s/\n\n+/\n/g; # double lines
1496 s/^\n+//; # beginning lines
1497 s/\n+$//; # ending lines
1498
1499 $_
1500}
1501
1502sub hintmode {
1503 $_[0]{hintmode} = $_[1] if @_ > 1;
1504 $_[0]{hintmode}
1505}
1506
1190=item $player->ext_reply ($msgid, %msg) 1507=item $player->ext_reply ($msgid, @msg)
1191 1508
1192Sends an ext reply to the player. 1509Sends an ext reply to the player.
1193 1510
1194=cut 1511=cut
1195 1512
1196sub ext_reply($$%) { 1513sub ext_reply($$@) {
1197 my ($self, $id, %msg) = @_; 1514 my ($self, $id, @msg) = @_;
1198 1515
1199 $msg{msgid} = $id; 1516 $self->ns->ext_reply ($id, @msg)
1200
1201 $self->send ("ext " . cf::to_json \%msg);
1202} 1517}
1203 1518
1204=item $player->ext_event ($type, %msg) 1519=item $player->ext_msg ($type, @msg)
1205 1520
1206Sends an ext event to the client. 1521Sends an ext event to the client.
1207 1522
1208=cut 1523=cut
1209 1524
1210sub ext_event($$%) { 1525sub ext_msg($$@) {
1211 my ($self, $type, %msg) = @_; 1526 my ($self, $type, @msg) = @_;
1212 1527
1213 $self->ns->ext_event ($type, %msg); 1528 $self->ns->ext_msg ($type, @msg);
1214} 1529}
1215 1530
1216=head3 cf::region 1531=head3 cf::region
1217 1532
1218=over 4 1533=over 4
1221 1536
1222package cf::region; 1537package cf::region;
1223 1538
1224=item cf::region::find_by_path $path 1539=item cf::region::find_by_path $path
1225 1540
1226Tries to decuce the probable region for a map knowing only its path. 1541Tries to decuce the likely region for a map knowing only its path.
1227 1542
1228=cut 1543=cut
1229 1544
1230sub find_by_path($) { 1545sub find_by_path($) {
1231 my ($path) = @_; 1546 my ($path) = @_;
1232 1547
1233 my ($match, $specificity); 1548 my ($match, $specificity);
1234 1549
1235 for my $region (list) { 1550 for my $region (list) {
1236 if ($region->match && $path =~ $region->match) { 1551 if ($region->{match} && $path =~ $region->{match}) {
1237 ($match, $specificity) = ($region, $region->specificity) 1552 ($match, $specificity) = ($region, $region->specificity)
1238 if $region->specificity > $specificity; 1553 if $region->specificity > $specificity;
1239 } 1554 }
1240 } 1555 }
1241 1556
1361 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1362 return $self; 1677 return $self;
1363 } 1678 }
1364 } 1679 }
1365 1680
1366 Carp::carp "unable to resolve path '$path' (base '$base')."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1367 () 1682 ()
1368} 1683}
1369 1684
1370sub init { 1685sub init {
1371 my ($self) = @_; 1686 my ($self) = @_;
1537 local $self->{deny_reset} = 1; # loading can take a long time 1852 local $self->{deny_reset} = 1; # loading can take a long time
1538 1853
1539 my $path = $self->{path}; 1854 my $path = $self->{path};
1540 1855
1541 { 1856 {
1857 my $guard1 = cf::lock_acquire "map_data:$path";
1542 my $guard = cf::lock_acquire "map_load:$path"; 1858 my $guard2 = cf::lock_acquire "map_load:$path";
1543 1859
1544 return if $self->in_memory != cf::MAP_SWAPPED; 1860 return if $self->in_memory != cf::MAP_SWAPPED;
1545 1861
1546 $self->in_memory (cf::MAP_LOADING); 1862 $self->in_memory (cf::MAP_LOADING);
1547 1863
1548 $self->alloc; 1864 $self->alloc;
1549 1865
1550 $self->pre_load; 1866 $self->pre_load;
1551 Coro::cede; 1867 cf::cede_to_tick;
1552 1868
1553 $self->_load_objects ($self->{load_path}, 1) 1869 $self->_load_objects ($self->{load_path}, 1)
1554 or return; 1870 or return;
1555 1871
1556 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1872 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1562 $self->clear_unique_items; 1878 $self->clear_unique_items;
1563 $self->_load_objects ($uniq, 0); 1879 $self->_load_objects ($uniq, 0);
1564 } 1880 }
1565 } 1881 }
1566 1882
1567 Coro::cede; 1883 cf::cede_to_tick;
1568 # now do the right thing for maps 1884 # now do the right thing for maps
1569 $self->link_multipart_objects; 1885 $self->link_multipart_objects;
1570 $self->difficulty ($self->estimate_difficulty) 1886 $self->difficulty ($self->estimate_difficulty)
1571 unless $self->difficulty; 1887 unless $self->difficulty;
1572 Coro::cede; 1888 cf::cede_to_tick;
1573 1889
1574 unless ($self->{deny_activate}) { 1890 unless ($self->{deny_activate}) {
1575 $self->decay_objects; 1891 $self->decay_objects;
1576 $self->fix_auto_apply; 1892 $self->fix_auto_apply;
1577 $self->update_buttons; 1893 $self->update_buttons;
1578 Coro::cede; 1894 cf::cede_to_tick;
1579 $self->set_darkness_map; 1895 $self->set_darkness_map;
1580 Coro::cede; 1896 cf::cede_to_tick;
1581 $self->activate; 1897 $self->activate;
1582 } 1898 }
1899
1900 $self->{last_save} = $cf::RUNTIME;
1901 $self->last_access ($cf::RUNTIME);
1583 1902
1584 $self->in_memory (cf::MAP_IN_MEMORY); 1903 $self->in_memory (cf::MAP_IN_MEMORY);
1585 } 1904 }
1586 1905
1587 $self->post_load; 1906 $self->post_load;
1598 1917
1599 $self 1918 $self
1600} 1919}
1601 1920
1602# find and load all maps in the 3x3 area around a map 1921# find and load all maps in the 3x3 area around a map
1603sub load_diag { 1922sub load_neighbours {
1604 my ($map) = @_; 1923 my ($map) = @_;
1605 1924
1606 my @diag; # diagonal neighbours 1925 my @neigh; # diagonal neighbours
1607 1926
1608 for (0 .. 3) { 1927 for (0 .. 3) {
1609 my $neigh = $map->tile_path ($_) 1928 my $neigh = $map->tile_path ($_)
1610 or next; 1929 or next;
1611 $neigh = find $neigh, $map 1930 $neigh = find $neigh, $map
1612 or next; 1931 or next;
1613 $neigh->load; 1932 $neigh->load;
1614 1933
1934 push @neigh,
1615 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1935 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1616 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1936 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1617 } 1937 }
1618 1938
1619 for (@diag) { 1939 for (grep defined $_->[0], @neigh) {
1940 my ($path, $origin) = @$_;
1620 my $neigh = find @$_ 1941 my $neigh = find $path, $origin
1621 or next; 1942 or next;
1622 $neigh->load; 1943 $neigh->load;
1623 } 1944 }
1624} 1945}
1625 1946
1630} 1951}
1631 1952
1632sub do_load_sync { 1953sub do_load_sync {
1633 my ($map) = @_; 1954 my ($map) = @_;
1634 1955
1956 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1957 if $Coro::current == $Coro::main;
1958
1635 cf::sync_job { $map->load }; 1959 cf::sync_job { $map->load };
1636} 1960}
1637 1961
1638our %MAP_PREFETCH; 1962our %MAP_PREFETCH;
1639our $MAP_PREFETCHER = undef; 1963our $MAP_PREFETCHER = undef;
1640 1964
1641sub find_async { 1965sub find_async {
1642 my ($path, $origin) = @_; 1966 my ($path, $origin, $load) = @_;
1643 1967
1644 $path = normalise $path, $origin && $origin->{path}; 1968 $path = normalise $path, $origin && $origin->{path};
1645 1969
1646 if (my $map = $cf::MAP{$path}) { 1970 if (my $map = $cf::MAP{$path}) {
1647 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1971 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1648 } 1972 }
1649 1973
1650 undef $MAP_PREFETCH{$path}; 1974 $MAP_PREFETCH{$path} |= $load;
1975
1651 $MAP_PREFETCHER ||= cf::async { 1976 $MAP_PREFETCHER ||= cf::async {
1652 while (%MAP_PREFETCH) { 1977 while (%MAP_PREFETCH) {
1653 for my $path (keys %MAP_PREFETCH) { 1978 while (my ($k, $v) = each %MAP_PREFETCH) {
1654 my $map = find $path 1979 if (my $map = find $k) {
1655 or next;
1656 $map->load; 1980 $map->load if $v;
1981 }
1657 1982
1658 delete $MAP_PREFETCH{$path}; 1983 delete $MAP_PREFETCH{$k};
1659 } 1984 }
1660 } 1985 }
1661 undef $MAP_PREFETCHER; 1986 undef $MAP_PREFETCHER;
1662 }; 1987 };
1663 $MAP_PREFETCHER->prio (6); 1988 $MAP_PREFETCHER->prio (6);
1666} 1991}
1667 1992
1668sub save { 1993sub save {
1669 my ($self) = @_; 1994 my ($self) = @_;
1670 1995
1671 my $lock = cf::lock_acquire "map_data:" . $self->path; 1996 my $lock = cf::lock_acquire "map_data:$self->{path}";
1672 1997
1673 $self->{last_save} = $cf::RUNTIME; 1998 $self->{last_save} = $cf::RUNTIME;
1674 1999
1675 return unless $self->dirty; 2000 return unless $self->dirty;
1676 2001
1699 my ($self) = @_; 2024 my ($self) = @_;
1700 2025
1701 # save first because save cedes 2026 # save first because save cedes
1702 $self->save; 2027 $self->save;
1703 2028
1704 my $lock = cf::lock_acquire "map_data:" . $self->path; 2029 my $lock = cf::lock_acquire "map_data:$self->{path}";
1705 2030
1706 return if $self->players; 2031 return if $self->players;
1707 return if $self->in_memory != cf::MAP_IN_MEMORY; 2032 return if $self->in_memory != cf::MAP_IN_MEMORY;
1708 return if $self->{deny_save}; 2033 return if $self->{deny_save};
1709 2034
1779} 2104}
1780 2105
1781=item $maps = cf::map::tmp_maps 2106=item $maps = cf::map::tmp_maps
1782 2107
1783Returns an arrayref with all map paths of currently instantiated and saved 2108Returns an arrayref with all map paths of currently instantiated and saved
1784maps. 2109maps. May block.
1785 2110
1786=cut 2111=cut
1787 2112
1788sub tmp_maps() { 2113sub tmp_maps() {
1789 [ 2114 [
1790 map { 2115 map {
1791 utf8::decode $_; 2116 utf8::decode $_;
1792 !/\.(?:pst|meta)$/ && /^$PATH_SEP/o 2117 /\.map$/
1793 ? normalise $_ 2118 ? normalise $_
1794 : () 2119 : ()
1795 } @{ aio_readdir $TMPDIR or [] } 2120 } @{ aio_readdir $TMPDIR or [] }
1796 ] 2121 ]
1797} 2122}
1798 2123
2124=item $maps = cf::map::random_maps
2125
2126Returns an arrayref with all map paths of currently instantiated and saved
2127random maps. May block.
2128
2129=cut
2130
2131sub random_maps() {
2132 [
2133 map {
2134 utf8::decode $_;
2135 /\.map$/
2136 ? normalise "?random/$_"
2137 : ()
2138 } @{ aio_readdir $RANDOMDIR or [] }
2139 ]
2140}
2141
1799=item cf::map::unique_maps 2142=item cf::map::unique_maps
1800 2143
1801Returns an arrayref of paths of all shared maps that have 2144Returns an arrayref of paths of all shared maps that have
1802instantiated unique items. May block. 2145instantiated unique items. May block.
1803 2146
1805 2148
1806sub unique_maps() { 2149sub unique_maps() {
1807 [ 2150 [
1808 map { 2151 map {
1809 utf8::decode $_; 2152 utf8::decode $_;
1810 !/\.(?:pst|meta)$/ && /^$PATH_SEP/o 2153 /\.map$/
1811 ? normalise $_ 2154 ? normalise $_
1812 : () 2155 : ()
1813 } @{ aio_readdir $UNIQUEDIR or [] } 2156 } @{ aio_readdir $UNIQUEDIR or [] }
1814 ] 2157 ]
1815} 2158}
1865 2208
1866 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2209 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1867 2210
1868 if ($self->{record_replies}) { 2211 if ($self->{record_replies}) {
1869 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2212 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2213
1870 } else { 2214 } else {
2215 my $pl = $self->contr;
2216
2217 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2218 my $dialog = $pl->{npc_dialog};
2219 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2220
2221 } else {
1871 $msg = $npc->name . " says: $msg" if $npc; 2222 $msg = $npc->name . " says: $msg" if $npc;
1872 $self->message ($msg, $flags); 2223 $self->message ($msg, $flags);
2224 }
1873 } 2225 }
2226}
2227
2228=item $object->send_msg ($channel, $msg, $color, [extra...])
2229
2230=cut
2231
2232sub cf::object::send_msg {
2233 my $pl = shift->contr
2234 or return;
2235 $pl->send_msg (@_);
1874} 2236}
1875 2237
1876=item $player_object->may ("access") 2238=item $player_object->may ("access")
1877 2239
1878Returns wether the given player is authorized to access resource "access" 2240Returns wether the given player is authorized to access resource "access"
1957 # use -1 or undef as default coordinates, not 0, 0 2319 # use -1 or undef as default coordinates, not 0, 0
1958 ($x, $y) = ($map->enter_x, $map->enter_y) 2320 ($x, $y) = ($map->enter_x, $map->enter_y)
1959 if $x <=0 && $y <= 0; 2321 if $x <=0 && $y <= 0;
1960 2322
1961 $map->load; 2323 $map->load;
1962 $map->load_diag; 2324 $map->load_neighbours;
1963 2325
1964 return unless $self->contr->active; 2326 return unless $self->contr->active;
1965 $self->activate_recursive; 2327 $self->activate_recursive;
1966 2328
1967 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2329 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1968 $self->enter_map ($map, $x, $y); 2330 $self->enter_map ($map, $x, $y);
1969} 2331}
1970 2332
1971=item $player_object->goto ($path, $x, $y[, $check->($map)]) 2333=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1972 2334
1973Moves the player to the given map-path and coordinates by first freezing 2335Moves the player to the given map-path and coordinates by first freezing
1974her, loading and preparing them map, calling the provided $check callback 2336her, loading and preparing them map, calling the provided $check callback
1975that has to return the map if sucecssful, and then unfreezes the player on 2337that has to return the map if sucecssful, and then unfreezes the player on
1976the new (success) or old (failed) map position. 2338the new (success) or old (failed) map position. In either case, $done will
2339be called at the end of this process.
1977 2340
1978=cut 2341=cut
1979 2342
1980our $GOTOGEN; 2343our $GOTOGEN;
1981 2344
1982sub cf::object::player::goto { 2345sub cf::object::player::goto {
1983 my ($self, $path, $x, $y, $check) = @_; 2346 my ($self, $path, $x, $y, $check, $done) = @_;
1984 2347
1985 # do generation counting so two concurrent goto's will be executed in-order 2348 # do generation counting so two concurrent goto's will be executed in-order
1986 my $gen = $self->{_goto_generation} = ++$GOTOGEN; 2349 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1987 2350
1988 $self->enter_link; 2351 $self->enter_link;
2008 2371
2009 if ($gen == $self->{_goto_generation}) { 2372 if ($gen == $self->{_goto_generation}) {
2010 delete $self->{_goto_generation}; 2373 delete $self->{_goto_generation};
2011 $self->leave_link ($map, $x, $y); 2374 $self->leave_link ($map, $x, $y);
2012 } 2375 }
2376
2377 $done->() if $done;
2013 })->prio (1); 2378 })->prio (1);
2014} 2379}
2015 2380
2016=item $player_object->enter_exit ($exit_object) 2381=item $player_object->enter_exit ($exit_object)
2017 2382
2086 my $hp = $exit->stats->hp; 2451 my $hp = $exit->stats->hp;
2087 my $sp = $exit->stats->sp; 2452 my $sp = $exit->stats->sp;
2088 2453
2089 $self->enter_link; 2454 $self->enter_link;
2090 2455
2456 # if exit is damned, update players death & WoR home-position
2457 $self->contr->savebed ($slaying, $hp, $sp)
2458 if $exit->flag (FLAG_DAMNED);
2459
2091 (async { 2460 (async {
2092 $self->deactivate_recursive; # just to be sure 2461 $self->deactivate_recursive; # just to be sure
2093 unless (eval { 2462 unless (eval {
2094 $self->goto ($slaying, $hp, $sp); 2463 $self->goto ($slaying, $hp, $sp);
2095 2464
2122 2491
2123 utf8::encode $text; 2492 utf8::encode $text;
2124 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text); 2493 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2125} 2494}
2126 2495
2496=item $client->send_msg ($channel, $msg, $color, [extra...])
2497
2498Send a drawinfo or msg packet to the client, formatting the msg for the
2499client if neccessary. C<$type> should be a string identifying the type of
2500the message, with C<log> being the default. If C<$color> is negative, suppress
2501the message unless the client supports the msg packet.
2502
2503=cut
2504
2505sub cf::client::send_msg {
2506 my ($self, $channel, $msg, $color, @extra) = @_;
2507
2508 $msg = $self->pl->expand_cfpod ($msg);
2509
2510 $color &= cf::NDI_CLIENT_MASK; # just in case...
2511
2512 if (ref $channel) {
2513 # send meta info to client, if not yet sent
2514 unless (exists $self->{channel}{$channel->{id}}) {
2515 $self->{channel}{$channel->{id}} = $channel;
2516 $self->ext_msg (channel_info => $channel);
2517 }
2518
2519 $channel = $channel->{id};
2520 }
2521
2522 return unless @extra || length $msg;
2523
2524 if ($self->can_msg) {
2525 # default colour, mask it out
2526 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2527 if $color & cf::NDI_DEF;
2528
2529 $self->send_packet ("msg " . $self->{json_coder}->encode (
2530 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2531 } else {
2532 if ($color >= 0) {
2533 # replace some tags by gcfclient-compatible ones
2534 for ($msg) {
2535 1 while
2536 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2537 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2538 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2539 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2540 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2541 }
2542
2543 $color &= cf::NDI_COLOR_MASK;
2544
2545 utf8::encode $msg;
2546
2547 if (0 && $msg =~ /\[/) {
2548 # COMMAND/INFO
2549 $self->send_packet ("drawextinfo $color 10 8 $msg")
2550 } else {
2551 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2552 $self->send_packet ("drawinfo $color $msg")
2553 }
2554 }
2555 }
2556}
2557
2127=item $client->ext_event ($type, %msg) 2558=item $client->ext_msg ($type, @msg)
2128 2559
2129Sends an exti event to the client. 2560Sends an ext event to the client.
2130 2561
2131=cut 2562=cut
2132 2563
2133sub cf::client::ext_event($$%) { 2564sub cf::client::ext_msg($$@) {
2134 my ($self, $type, %msg) = @_; 2565 my ($self, $type, @msg) = @_;
2135 2566
2567 if ($self->extcmd == 2) {
2568 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2569 } elsif ($self->extcmd == 1) { # TODO: remove
2136 $msg{msgtype} = "event_$type"; 2570 push @msg, msgtype => "event_$type";
2137 $self->send_packet ("ext " . cf::to_json \%msg); 2571 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2572 }
2573}
2574
2575=item $client->ext_reply ($msgid, @msg)
2576
2577Sends an ext reply to the client.
2578
2579=cut
2580
2581sub cf::client::ext_reply($$@) {
2582 my ($self, $id, @msg) = @_;
2583
2584 if ($self->extcmd == 2) {
2585 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2586 } elsif ($self->extcmd == 1) {
2587 #TODO: version 1, remove
2588 unshift @msg, msgtype => "reply", msgid => $id;
2589 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2590 }
2138} 2591}
2139 2592
2140=item $success = $client->query ($flags, "text", \&cb) 2593=item $success = $client->query ($flags, "text", \&cb)
2141 2594
2142Queues a query to the client, calling the given callback with 2595Queues a query to the client, calling the given callback with
2143the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2596the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2144C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2597C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2145 2598
2146Queries can fail, so check the return code. Or don't, as queries will become 2599Queries can fail, so check the return code. Or don't, as queries will
2147reliable at some point in the future. 2600become reliable at some point in the future.
2148 2601
2149=cut 2602=cut
2150 2603
2151sub cf::client::query { 2604sub cf::client::query {
2152 my ($self, $flags, $text, $cb) = @_; 2605 my ($self, $flags, $text, $cb) = @_;
2160 utf8::encode $text; 2613 utf8::encode $text;
2161 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2614 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2162 2615
2163 $self->send_packet ($self->{query_queue}[0][0]) 2616 $self->send_packet ($self->{query_queue}[0][0])
2164 if @{ $self->{query_queue} } == 1; 2617 if @{ $self->{query_queue} } == 1;
2618
2619 1
2165} 2620}
2166 2621
2167cf::client->attach ( 2622cf::client->attach (
2623 on_connect => sub {
2624 my ($ns) = @_;
2625
2626 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2627 },
2168 on_reply => sub { 2628 on_reply => sub {
2169 my ($ns, $msg) = @_; 2629 my ($ns, $msg) = @_;
2170 2630
2171 # this weird shuffling is so that direct followup queries 2631 # this weird shuffling is so that direct followup queries
2172 # get handled first 2632 # get handled first
2184 } else { 2644 } else {
2185 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2645 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2186 } 2646 }
2187 } 2647 }
2188 }, 2648 },
2649 on_exticmd => sub {
2650 my ($ns, $buf) = @_;
2651
2652 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2653
2654 if (ref $msg) {
2655 my ($type, $reply, @payload) =
2656 "ARRAY" eq ref $msg
2657 ? @$msg
2658 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2659
2660 my @reply;
2661
2662 if (my $cb = $EXTICMD{$type}) {
2663 @reply = $cb->($ns, @payload);
2664 }
2665
2666 $ns->ext_reply ($reply, @reply)
2667 if $reply;
2668
2669 } else {
2670 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2671 }
2672
2673 cf::override;
2674 },
2189); 2675);
2190 2676
2191=item $client->async (\&cb) 2677=item $client->async (\&cb)
2192 2678
2193Create a new coroutine, running the specified callback. The coroutine will 2679Create a new coroutine, running the specified callback. The coroutine will
2234our $safe = new Safe "safe"; 2720our $safe = new Safe "safe";
2235our $safe_hole = new Safe::Hole; 2721our $safe_hole = new Safe::Hole;
2236 2722
2237$SIG{FPE} = 'IGNORE'; 2723$SIG{FPE} = 'IGNORE';
2238 2724
2239$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2725$safe->permit_only (Opcode::opset qw(
2726 :base_core :base_mem :base_orig :base_math
2727 grepstart grepwhile mapstart mapwhile
2728 sort time
2729));
2240 2730
2241# here we export the classes and methods available to script code 2731# here we export the classes and methods available to script code
2242 2732
2243=pod 2733=pod
2244 2734
2245The following functions and methods are available within a safe environment: 2735The following functions and methods are available within a safe environment:
2246 2736
2247 cf::object contr pay_amount pay_player map 2737 cf::object
2738 contr pay_amount pay_player map x y force_find force_add
2739 insert remove name archname title slaying race decrease_ob_nr
2740
2248 cf::object::player player 2741 cf::object::player
2249 cf::player peaceful 2742 player
2250 cf::map trigger 2743
2744 cf::player
2745 peaceful
2746
2747 cf::map
2748 trigger
2251 2749
2252=cut 2750=cut
2253 2751
2254for ( 2752for (
2255 ["cf::object" => qw(contr pay_amount pay_player map)], 2753 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2754 insert remove inv name archname title slaying race
2755 decrease_ob_nr)],
2256 ["cf::object::player" => qw(player)], 2756 ["cf::object::player" => qw(player)],
2257 ["cf::player" => qw(peaceful)], 2757 ["cf::player" => qw(peaceful)],
2258 ["cf::map" => qw(trigger)], 2758 ["cf::map" => qw(trigger)],
2259) { 2759) {
2260 no strict 'refs'; 2760 no strict 'refs';
2331=back 2831=back
2332 2832
2333=cut 2833=cut
2334 2834
2335############################################################################# 2835#############################################################################
2336
2337=head2 EXTENSION DATABASE SUPPORT
2338
2339Crossfire maintains a very simple database for extension use. It can
2340currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
2341convert to/from binary).
2342
2343The parameter C<$family> should best start with the name of the extension
2344using it, it should be unique.
2345
2346=over 4
2347
2348=item $value = cf::db_get $family => $key
2349
2350Returns a single value from the database.
2351
2352=item cf::db_put $family => $key => $value
2353
2354Stores the given C<$value> in the family.
2355
2356=cut
2357
2358our $DB;
2359
2360sub db_init {
2361 unless ($DB) {
2362 $DB = BDB::db_create $DB_ENV;
2363
2364 cf::sync_job {
2365 eval {
2366 $DB->set_flags (BDB::CHKSUM);
2367
2368 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2369 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2370 cf::cleanup "db_open(db): $!" if $!;
2371 };
2372 cf::cleanup "db_open(db): $@" if $@;
2373 };
2374 }
2375}
2376
2377sub db_get($$) {
2378 my $key = "$_[0]/$_[1]";
2379
2380 cf::sync_job {
2381 BDB::db_get $DB, undef, $key, my $data;
2382
2383 $! ? ()
2384 : $data
2385 }
2386}
2387
2388sub db_put($$$) {
2389 BDB::dbreq_pri 4;
2390 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
2391}
2392
2393=item cf::cache $id => [$paths...], $processversion => $process
2394
2395Generic caching function that returns the value of the resource $id,
2396caching and regenerating as required.
2397
2398This function can block.
2399
2400=cut
2401
2402sub cache {
2403 my ($id, $src, $processversion, $process) = @_;
2404
2405 my $meta =
2406 join "\x00",
2407 $processversion,
2408 map {
2409 aio_stat $_
2410 and Carp::croak "$_: $!";
2411
2412 ($_, (stat _)[7,9])
2413 } @$src;
2414
2415 my $dbmeta = db_get cache => "$id/meta";
2416 if ($dbmeta ne $meta) {
2417 # changed, we may need to process
2418
2419 my @data;
2420 my $md5;
2421
2422 for (0 .. $#$src) {
2423 0 <= aio_load $src->[$_], $data[$_]
2424 or Carp::croak "$src->[$_]: $!";
2425 }
2426
2427 # if processing is expensive, check
2428 # checksum first
2429 if (1) {
2430 $md5 =
2431 join "\x00",
2432 $processversion,
2433 map {
2434 Coro::cede;
2435 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2436 } 0.. $#$src;
2437
2438
2439 my $dbmd5 = db_get cache => "$id/md5";
2440 if ($dbmd5 eq $md5) {
2441 db_put cache => "$id/meta", $meta;
2442
2443 return db_get cache => "$id/data";
2444 }
2445 }
2446
2447 my $t1 = Time::HiRes::time;
2448 my $data = $process->(\@data);
2449 my $t2 = Time::HiRes::time;
2450
2451 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2452
2453 db_put cache => "$id/data", $data;
2454 db_put cache => "$id/md5" , $md5;
2455 db_put cache => "$id/meta", $meta;
2456
2457 return $data;
2458 }
2459
2460 db_get cache => "$id/data"
2461}
2462
2463=item fork_call { }, $args
2464
2465Executes the given code block with the given arguments in a seperate
2466process, returning the results. Everything must be serialisable with
2467Coro::Storable. May, of course, block. Note that the executed sub may
2468never block itself or use any form of Event handling.
2469
2470=cut
2471
2472sub fork_call(&@) {
2473 my ($cb, @args) = @_;
2474
2475# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2476# or die "socketpair: $!";
2477 pipe my $fh1, my $fh2
2478 or die "pipe: $!";
2479
2480 if (my $pid = fork) {
2481 close $fh2;
2482
2483 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2484 $res = Coro::Storable::thaw $res;
2485
2486 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2487
2488 die $$res unless "ARRAY" eq ref $res;
2489
2490 return wantarray ? @$res : $res->[-1];
2491 } else {
2492 reset_signals;
2493 local $SIG{__WARN__};
2494 local $SIG{__DIE__};
2495 eval {
2496 close $fh1;
2497
2498 my @res = eval { $cb->(@args) };
2499 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2500 };
2501
2502 warn $@ if $@;
2503 _exit 0;
2504 }
2505}
2506
2507#############################################################################
2508# the server's init and main functions 2836# the server's init and main functions
2509 2837
2510sub load_facedata($) { 2838sub load_facedata($) {
2511 my ($path) = @_; 2839 my ($path) = @_;
2840
2841 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2512 2842
2513 warn "loading facedata from $path\n"; 2843 warn "loading facedata from $path\n";
2514 2844
2515 my $facedata; 2845 my $facedata;
2516 0 < aio_load $path, $facedata 2846 0 < aio_load $path, $facedata
2519 $facedata = Coro::Storable::thaw $facedata; 2849 $facedata = Coro::Storable::thaw $facedata;
2520 2850
2521 $facedata->{version} == 2 2851 $facedata->{version} == 2
2522 or cf::cleanup "$path: version mismatch, cannot proceed."; 2852 or cf::cleanup "$path: version mismatch, cannot proceed.";
2523 2853
2854 # patch in the exptable
2855 $facedata->{resource}{"res/exp_table"} = {
2856 type => FT_RSRC,
2857 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2858 };
2859 cf::cede_to_tick;
2860
2524 { 2861 {
2525 my $faces = $facedata->{faceinfo}; 2862 my $faces = $facedata->{faceinfo};
2526 2863
2527 while (my ($face, $info) = each %$faces) { 2864 while (my ($face, $info) = each %$faces) {
2528 my $idx = (cf::face::find $face) || cf::face::alloc $face; 2865 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2529 cf::face::set $idx, $info->{visibility}, $info->{magicmap}; 2866 cf::face::set_visibility $idx, $info->{visibility};
2867 cf::face::set_magicmap $idx, $info->{magicmap};
2530 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32}; 2868 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2531 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64}; 2869 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2532 Coro::cede; 2870
2871 cf::cede_to_tick;
2533 } 2872 }
2534 2873
2535 while (my ($face, $info) = each %$faces) { 2874 while (my ($face, $info) = each %$faces) {
2536 next unless $info->{smooth}; 2875 next unless $info->{smooth};
2537 my $idx = cf::face::find $face 2876 my $idx = cf::face::find $face
2538 or next; 2877 or next;
2539 if (my $smooth = cf::face::find $info->{smooth}) { 2878 if (my $smooth = cf::face::find $info->{smooth}) {
2879 cf::face::set_smooth $idx, $smooth;
2540 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel}; 2880 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2541 } else { 2881 } else {
2542 warn "smooth face '$info->{smooth}' not found for face '$face'"; 2882 warn "smooth face '$info->{smooth}' not found for face '$face'";
2543 } 2883 }
2544 Coro::cede; 2884
2885 cf::cede_to_tick;
2545 } 2886 }
2546 } 2887 }
2547 2888
2548 { 2889 {
2549 my $anims = $facedata->{animinfo}; 2890 my $anims = $facedata->{animinfo};
2550 2891
2551 while (my ($anim, $info) = each %$anims) { 2892 while (my ($anim, $info) = each %$anims) {
2552 cf::anim::set $anim, $info->{frames}, $info->{facings}; 2893 cf::anim::set $anim, $info->{frames}, $info->{facings};
2553 Coro::cede; 2894 cf::cede_to_tick;
2554 } 2895 }
2555 2896
2556 cf::anim::invalidate_all; # d'oh 2897 cf::anim::invalidate_all; # d'oh
2557 } 2898 }
2558 2899
2900 {
2901 # TODO: for gcfclient pleasure, we should give resources
2902 # that gcfclient doesn't grok a >10000 face index.
2903 my $res = $facedata->{resource};
2904
2905 my $soundconf = delete $res->{"res/sound.conf"};
2906
2907 while (my ($name, $info) = each %$res) {
2908 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2909 my $data;
2910
2911 if ($info->{type} & 1) {
2912 # prepend meta info
2913
2914 my $meta = $enc->encode ({
2915 name => $name,
2916 %{ $info->{meta} || {} },
2917 });
2918
2919 $data = pack "(w/a*)*", $meta, $info->{data};
2920 } else {
2921 $data = $info->{data};
2922 }
2923
2924 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2925 cf::face::set_type $idx, $info->{type};
2926
2927 cf::cede_to_tick;
2928 }
2929
2930 if ($soundconf) {
2931 $soundconf = $enc->decode (delete $soundconf->{data});
2932
2933 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2934 my $sound = $soundconf->{compat}[$_]
2935 or next;
2936
2937 my $face = cf::face::find "sound/$sound->[1]";
2938 cf::sound::set $sound->[0] => $face;
2939 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2940 }
2941
2942 while (my ($k, $v) = each %{$soundconf->{event}}) {
2943 my $face = cf::face::find "sound/$v";
2944 cf::sound::set $k => $face;
2945 }
2946 }
2947 }
2948
2559 1 2949 1
2560} 2950}
2951
2952register_exticmd fx_want => sub {
2953 my ($ns, $want) = @_;
2954
2955 while (my ($k, $v) = each %$want) {
2956 $ns->fx_want ($k, $v);
2957 }
2958};
2561 2959
2562sub reload_regions { 2960sub reload_regions {
2563 load_resource_file "$MAPDIR/regions" 2961 load_resource_file "$MAPDIR/regions"
2564 or die "unable to load regions file\n"; 2962 or die "unable to load regions file\n";
2963
2964 for (cf::region::list) {
2965 $_->{match} = qr/$_->{match}/
2966 if exists $_->{match};
2967 }
2565} 2968}
2566 2969
2567sub reload_facedata { 2970sub reload_facedata {
2568 load_facedata "$DATADIR/facedata" 2971 load_facedata "$DATADIR/facedata"
2569 or die "unable to load facedata\n"; 2972 or die "unable to load facedata\n";
2570} 2973}
2571 2974
2572sub reload_archetypes { 2975sub reload_archetypes {
2976 load_resource_file "$DATADIR/archetypes"
2977 or die "unable to load archetypes\n";
2978 #d# NEED to laod twice to resolve forward references
2979 # this really needs to be done in an extra post-pass
2980 # (which needs to be synchronous, so solve it differently)
2573 load_resource_file "$DATADIR/archetypes" 2981 load_resource_file "$DATADIR/archetypes"
2574 or die "unable to load archetypes\n"; 2982 or die "unable to load archetypes\n";
2575} 2983}
2576 2984
2577sub reload_treasures { 2985sub reload_treasures {
2593 3001
2594sub init { 3002sub init {
2595 reload_resources; 3003 reload_resources;
2596} 3004}
2597 3005
2598sub cfg_load { 3006sub reload_config {
2599 open my $fh, "<:utf8", "$CONFDIR/config" 3007 open my $fh, "<:utf8", "$CONFDIR/config"
2600 or return; 3008 or return;
2601 3009
2602 local $/; 3010 local $/;
2603 *CFG = YAML::Syck::Load <$fh>; 3011 *CFG = YAML::Syck::Load <$fh>;
2623 (async { 3031 (async {
2624 Event::one_event; 3032 Event::one_event;
2625 })->prio (Coro::PRIO_MAX); 3033 })->prio (Coro::PRIO_MAX);
2626 }; 3034 };
2627 3035
2628 cfg_load; 3036 reload_config;
2629 db_init; 3037 db_init;
2630 load_extensions; 3038 load_extensions;
2631 3039
2632 $TICK_WATCHER->start; 3040 $TICK_WATCHER->start;
2633 Event::loop; 3041 Event::loop;
2649 }, 3057 },
2650 ); 3058 );
2651 } 3059 }
2652} 3060}
2653 3061
3062sub write_runtime {
3063 my $runtime = "$LOCALDIR/runtime";
3064
3065 # first touch the runtime file to show we are still running:
3066 # the fsync below can take a very very long time.
3067
3068 IO::AIO::aio_utime $runtime, undef, undef;
3069
3070 my $guard = cf::lock_acquire "write_runtime";
3071
3072 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3073 or return;
3074
3075 my $value = $cf::RUNTIME + 90 + 10;
3076 # 10 is the runtime save interval, for a monotonic clock
3077 # 60 allows for the watchdog to kill the server.
3078
3079 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3080 and return;
3081
3082 # always fsync - this file is important
3083 aio_fsync $fh
3084 and return;
3085
3086 # touch it again to show we are up-to-date
3087 aio_utime $fh, undef, undef;
3088
3089 close $fh
3090 or return;
3091
3092 aio_rename "$runtime~", $runtime
3093 and return;
3094
3095 warn "runtime file written.\n";
3096
3097 1
3098}
3099
2654sub emergency_save() { 3100sub emergency_save() {
2655 my $freeze_guard = cf::freeze_mainloop; 3101 my $freeze_guard = cf::freeze_mainloop;
2656 3102
2657 warn "enter emergency perl save\n"; 3103 warn "enter emergency perl save\n";
2658 3104
2733 %EXT_CORO = (); 3179 %EXT_CORO = ();
2734 3180
2735 warn "removing commands"; 3181 warn "removing commands";
2736 %COMMAND = (); 3182 %COMMAND = ();
2737 3183
2738 warn "removing ext commands"; 3184 warn "removing ext/exti commands";
2739 %EXTCMD = (); 3185 %EXTCMD = ();
3186 %EXTICMD = ();
2740 3187
2741 warn "unloading/nuking all extensions"; 3188 warn "unloading/nuking all extensions";
2742 for my $pkg (@EXTS) { 3189 for my $pkg (@EXTS) {
2743 warn "... unloading $pkg"; 3190 warn "... unloading $pkg";
2744 3191
2787 warn "reloading cf.pm"; 3234 warn "reloading cf.pm";
2788 require cf; 3235 require cf;
2789 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3236 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2790 3237
2791 warn "loading config and database again"; 3238 warn "loading config and database again";
2792 cf::cfg_load; 3239 cf::reload_config;
2793 3240
2794 warn "loading extensions"; 3241 warn "loading extensions";
2795 cf::load_extensions; 3242 cf::load_extensions;
2796 3243
2797 warn "reattaching attachments to objects/players"; 3244 warn "reattaching attachments to objects/players";

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines