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.211 by root, Tue Feb 13 16:23:32 2007 UTC vs.
Revision 1.306 by root, Sat Jul 14 14:33:30 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.5 (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
19 24
25use JSON::XS 1.4 ();
20use BDB (); 26use BDB ();
21use Data::Dumper; 27use Data::Dumper;
22use Digest::MD5; 28use Digest::MD5;
23use Fcntl; 29use Fcntl;
30use YAML::Syck ();
24use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
25use YAML::Syck ();
26use Time::HiRes; 32use Time::HiRes;
27use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
28 35
36# configure various modules to our taste
37#
38$Storable::canonical = 1; # reduce rsync transfers
39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
29Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30 41
31use Event; $Event::Eval = 1; # no idea why this is required, but it is 42$Event::Eval = 1; # no idea why this is required, but it is
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 43
35# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 44# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
37 46
38$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 47$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39 48
49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
50
40our %COMMAND = (); 51our %COMMAND = ();
41our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
42 53
43our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
44our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
45our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
46our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
47 59
60our $RELOAD; # number of reloads so far
48our @EVENT; 61our @EVENT;
49our $LIBDIR = datadir . "/ext";
50 62
51our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
52our $TICK_WATCHER; 76our $TICK_WATCHER;
53our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
54our $WRITE_RUNTIME_WATCHER; 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55our $NEXT_TICK; 79our $NEXT_TICK;
56our $NOW; 80our $NOW;
57our $USE_FSYNC = 1; # use fsync to write maps - default off 81our $USE_FSYNC = 1; # use fsync to write maps - default off
58 82
59our $BDB_POLL_WATCHER; 83our $BDB_POLL_WATCHER;
65our $RUNTIME; 89our $RUNTIME;
66 90
67our %PLAYER; # all users 91our %PLAYER; # all users
68our %MAP; # all maps 92our %MAP; # all maps
69our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
70our $RANDOM_MAPS = cf::localdir . "/random";
71our $BDB_ENV_DIR = cf::localdir . "/db";
72
73our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75 94
76# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
77our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78 97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
101
79binmode STDOUT; 102binmode STDOUT;
80binmode STDERR; 103binmode STDERR;
81 104
82# read virtual server time, if available 105# read virtual server time, if available
83unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
85 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
86 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
87} 110}
88 111
89mkdir cf::localdir; 112mkdir $_
90mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91mkdir cf::localdir . "/" . cf::tmpdir;
92mkdir cf::localdir . "/" . cf::uniquedir;
93mkdir $RANDOM_MAPS;
94mkdir $BDB_ENV_DIR;
95 114
96our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
97 116
98sub cf::map::normalise; 117sub cf::map::normalise;
99 118
110=item $cf::RUNTIME 129=item $cf::RUNTIME
111 130
112The time this server has run, starts at 0 and is increased by $cf::TICK on 131The time this server has run, starts at 0 and is increased by $cf::TICK on
113every server tick. 132every server tick.
114 133
115=item $cf::LIBDIR 134=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
135$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
136$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
116 137
117The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
118be found. It will be added to C<@INC> automatically. 139directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
140unique-items directory, player file directory, random maps directory and
141database environment.
119 142
120=item $cf::NOW 143=item $cf::NOW
121 144
122The time of the last (current) server tick. 145The time of the last (current) server tick.
123 146
124=item $cf::TICK 147=item $cf::TICK
125 148
126The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
127 160
128=item %cf::CFG 161=item %cf::CFG
129 162
130Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
131from wherever your confdir points to. 164from wherever your confdir points to.
132 165
133=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
134 167
135These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
136or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
137processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
138window of cpu time available, or simply to synchronise to the server tick.
139 171
140=back 172=back
141 173
142=cut 174=cut
143 175
144BEGIN { 176BEGIN {
145 *CORE::GLOBAL::warn = sub { 177 *CORE::GLOBAL::warn = sub {
146 my $msg = join "", @_; 178 my $msg = join "", @_;
147 utf8::encode $msg;
148 179
149 $msg .= "\n" 180 $msg .= "\n"
150 unless $msg =~ /\n$/; 181 unless $msg =~ /\n$/;
151 182
183 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
184
185 utf8::encode $msg;
152 LOG llevError, $msg; 186 LOG llevError, $msg;
153 }; 187 };
154} 188}
155 189
156@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 190@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 191@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 192@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 193@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 194@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
195@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
161@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 196@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
162 197
163# we bless all objects into (empty) derived classes to force a method lookup 198# we bless all objects into (empty) derived classes to force a method lookup
164# within the Safe compartment. 199# within the Safe compartment.
165for my $pkg (qw( 200for my $pkg (qw(
166 cf::global cf::attachable 201 cf::global cf::attachable
174} 209}
175 210
176$Event::DIED = sub { 211$Event::DIED = sub {
177 warn "error in event callback: @_"; 212 warn "error in event callback: @_";
178}; 213};
214
215#############################################################################
179 216
180=head2 UTILITY FUNCTIONS 217=head2 UTILITY FUNCTIONS
181 218
182=over 4 219=over 4
183 220
202 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 239 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203 $d 240 $d
204 } || "[unable to dump $_[0]: '$@']"; 241 } || "[unable to dump $_[0]: '$@']";
205} 242}
206 243
207use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209=item $ref = cf::from_json $json 244=item $ref = cf::from_json $json
210 245
211Converts a JSON string into the corresponding perl data structure. 246Converts a JSON string into the corresponding perl data structure.
212 247
213=cut
214
215sub from_json($) {
216 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217 JSON::Syck::Load $_[0]
218}
219
220=item $json = cf::to_json $ref 248=item $json = cf::to_json $ref
221 249
222Converts a perl data structure into its JSON representation. 250Converts a perl data structure into its JSON representation.
223 251
224=cut 252=cut
225 253
226sub to_json($) { 254our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 255
228 JSON::Syck::Dump $_[0] 256sub to_json ($) { $json_coder->encode ($_[0]) }
229} 257sub from_json ($) { $json_coder->decode ($_[0]) }
230 258
231=item cf::lock_wait $string 259=item cf::lock_wait $string
232 260
233Wait until the given lock is available. See cf::lock_acquire. 261Wait until the given lock is available. See cf::lock_acquire.
234 262
240returned. 268returned.
241 269
242Lock names should begin with a unique identifier (for example, cf::map::find 270Lock names should begin with a unique identifier (for example, cf::map::find
243uses map_find and cf::map::load uses map_load). 271uses map_find and cf::map::load uses map_load).
244 272
273=item $locked = cf::lock_active $string
274
275Return true if the lock is currently active, i.e. somebody has locked it.
276
245=cut 277=cut
246 278
247our %LOCK; 279our %LOCK;
248 280
249sub lock_wait($) { 281sub lock_wait($) {
268 # wake up all waiters, to be on the safe side 300 # wake up all waiters, to be on the safe side
269 $_->ready for @{ delete $LOCK{$key} }; 301 $_->ready for @{ delete $LOCK{$key} };
270 } 302 }
271} 303}
272 304
305sub lock_active($) {
306 my ($key) = @_;
307
308 ! ! $LOCK{$key}
309}
310
273sub freeze_mainloop { 311sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active; 312 return unless $TICK_WATCHER->is_active;
275 313
276 my $guard = Coro::guard { 314 my $guard = Coro::guard {
277 $TICK_WATCHER->start; 315 $TICK_WATCHER->start;
278 $WRITE_RUNTIME_WATCHER->start;
279 }; 316 };
280 $WRITE_RUNTIME_WATCHER->stop;
281 $TICK_WATCHER->stop; 317 $TICK_WATCHER->stop;
282 $guard 318 $guard
283} 319}
284 320
285=item cf::async { BLOCK } 321=item cf::async { BLOCK }
292 328
293BEGIN { *async = \&Coro::async_pool } 329BEGIN { *async = \&Coro::async_pool }
294 330
295=item cf::sync_job { BLOCK } 331=item cf::sync_job { BLOCK }
296 332
297The design of crossfire+ requires that the main coro ($Coro::main) is 333The design of Crossfire TRT requires that the main coroutine ($Coro::main)
298always able to handle events or runnable, as crossfire+ is only partly 334is always able to handle events or runnable, as Crossfire TRT is only
299reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 335partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
336acceptable.
300 337
301If it must be done, put the blocking parts into C<sync_job>. This will run 338If it must be done, put the blocking parts into C<sync_job>. This will run
302the given BLOCK in another coroutine while waiting for the result. The 339the given BLOCK in another coroutine while waiting for the result. The
303server will be frozen during this time, so the block should either finish 340server will be frozen during this time, so the block should either finish
304fast or be very important. 341fast or be very important.
307 344
308sub sync_job(&) { 345sub sync_job(&) {
309 my ($job) = @_; 346 my ($job) = @_;
310 347
311 if ($Coro::current == $Coro::main) { 348 if ($Coro::current == $Coro::main) {
349 my $time = Event::time;
350
312 # this is the main coro, too bad, we have to block 351 # this is the main coro, too bad, we have to block
313 # till the operation succeeds, freezing the server :/ 352 # till the operation succeeds, freezing the server :/
314 353
315 # TODO: use suspend/resume instead 354 # TODO: use suspend/resume instead
316 # (but this is cancel-safe) 355 # (but this is cancel-safe)
327 366
328 while ($busy) { 367 while ($busy) {
329 Coro::cede or Event::one_event; 368 Coro::cede or Event::one_event;
330 } 369 }
331 370
371 $time = Event::time - $time;
372
373 LOG llevError | logBacktrace, Carp::longmess "long sync job"
374 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
375
376 $tick_start += $time; # do not account sync jobs to server load
377
332 wantarray ? @res : $res[0] 378 wantarray ? @res : $res[0]
333 } else { 379 } else {
334 # we are in another coroutine, how wonderful, everything just works 380 # we are in another coroutine, how wonderful, everything just works
335 381
336 $job->() 382 $job->()
355 $EXT_CORO{$coro+0} = $coro; 401 $EXT_CORO{$coro+0} = $coro;
356 402
357 $coro 403 $coro
358} 404}
359 405
360sub write_runtime { 406=item fork_call { }, $args
361 $TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
362 407
363 my $runtime = cf::localdir . "/runtime"; 408Executes the given code block with the given arguments in a seperate
409process, returning the results. Everything must be serialisable with
410Coro::Storable. May, of course, block. Note that the executed sub may
411never block itself or use any form of Event handling.
364 412
365 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 413=cut
366 or return;
367 414
368 my $value = $cf::RUNTIME + 90 + 10; 415sub _store_scalar {
369 # 10 is the runtime save interval, for a monotonic clock 416 open my $fh, ">", \my $buf
370 # 60 allows for the watchdog to kill the server. 417 or die "fork_call: cannot open fh-to-buf in child : $!";
371 418 Storable::store_fd $_[0], $fh;
372 (aio_write $fh, 0, (length $value), $value, 0) <= 0
373 and return;
374
375 # always fsync - this file is important
376 aio_fsync $fh
377 and return;
378
379 close $fh 419 close $fh;
380 or return;
381 420
382 aio_rename "$runtime~", $runtime 421 $buf
383 and return; 422}
384 423
424sub fork_call(&@) {
425 my ($cb, @args) = @_;
426
427# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
428# or die "socketpair: $!";
429 pipe my $fh1, my $fh2
430 or die "pipe: $!";
431
432 if (my $pid = fork) {
433 close $fh2;
434
435 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
436 warn "pst<$res>" unless $res =~ /^pst/;
437 $res = Coro::Storable::thaw $res;
438
439 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
440
441 Carp::confess $$res unless "ARRAY" eq ref $res;
442
443 return wantarray ? @$res : $res->[-1];
444 } else {
445 reset_signals;
446 local $SIG{__WARN__};
447 local $SIG{__DIE__};
448 # just in case, this hack effectively disables event
449 # in the child. cleaner and slower would be canceling all watchers,
450 # but this works for the time being.
451 local $Coro::idle;
452 $Coro::current->prio (Coro::PRIO_MAX);
453
454 eval {
455 close $fh1;
456
457 my @res = eval { $cb->(@args) };
458
459 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
460 close $fh2;
461 };
462
463 warn $@ if $@;
464 _exit 0;
385 1 465 }
466}
467
468=item $value = cf::db_get $family => $key
469
470Returns a single value from the environment database.
471
472=item cf::db_put $family => $key => $value
473
474Stores the given C<$value> in the family. It can currently store binary
475data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
476
477=cut
478
479our $DB;
480
481sub db_init {
482 unless ($DB) {
483 $DB = BDB::db_create $DB_ENV;
484
485 cf::sync_job {
486 eval {
487 $DB->set_flags (BDB::CHKSUM);
488
489 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
490 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
491 cf::cleanup "db_open(db): $!" if $!;
492 };
493 cf::cleanup "db_open(db): $@" if $@;
494 };
495 }
496}
497
498sub db_get($$) {
499 my $key = "$_[0]/$_[1]";
500
501 cf::sync_job {
502 BDB::db_get $DB, undef, $key, my $data;
503
504 $! ? ()
505 : $data
506 }
507}
508
509sub db_put($$$) {
510 BDB::dbreq_pri 4;
511 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
512}
513
514=item cf::cache $id => [$paths...], $processversion => $process
515
516Generic caching function that returns the value of the resource $id,
517caching and regenerating as required.
518
519This function can block.
520
521=cut
522
523sub cache {
524 my ($id, $src, $processversion, $process) = @_;
525
526 my $meta =
527 join "\x00",
528 $processversion,
529 map {
530 aio_stat $_
531 and Carp::croak "$_: $!";
532
533 ($_, (stat _)[7,9])
534 } @$src;
535
536 my $dbmeta = db_get cache => "$id/meta";
537 if ($dbmeta ne $meta) {
538 # changed, we may need to process
539
540 my @data;
541 my $md5;
542
543 for (0 .. $#$src) {
544 0 <= aio_load $src->[$_], $data[$_]
545 or Carp::croak "$src->[$_]: $!";
546 }
547
548 # if processing is expensive, check
549 # checksum first
550 if (1) {
551 $md5 =
552 join "\x00",
553 $processversion,
554 map {
555 Coro::cede;
556 ($src->[$_], Digest::MD5::md5_hex $data[$_])
557 } 0.. $#$src;
558
559
560 my $dbmd5 = db_get cache => "$id/md5";
561 if ($dbmd5 eq $md5) {
562 db_put cache => "$id/meta", $meta;
563
564 return db_get cache => "$id/data";
565 }
566 }
567
568 my $t1 = Time::HiRes::time;
569 my $data = $process->(\@data);
570 my $t2 = Time::HiRes::time;
571
572 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
573
574 db_put cache => "$id/data", $data;
575 db_put cache => "$id/md5" , $md5;
576 db_put cache => "$id/meta", $meta;
577
578 return $data;
579 }
580
581 db_get cache => "$id/data"
582}
583
584=item cf::datalog type => key => value, ...
585
586Log a datalog packet of the given type with the given key-value pairs.
587
588=cut
589
590sub datalog($@) {
591 my ($type, %kv) = @_;
592 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
386} 593}
387 594
388=back 595=back
389 596
390=cut 597=cut
397attach callbacks/event handlers (a collection of which is called an "attachment") 604attach callbacks/event handlers (a collection of which is called an "attachment")
398to it. All such attachable objects support the following methods. 605to it. All such attachable objects support the following methods.
399 606
400In the following description, CLASS can be any of C<global>, C<object> 607In the following description, CLASS can be any of C<global>, C<object>
401C<player>, C<client> or C<map> (i.e. the attachable objects in 608C<player>, C<client> or C<map> (i.e. the attachable objects in
402crossfire+). 609Crossfire TRT).
403 610
404=over 4 611=over 4
405 612
406=item $attachable->attach ($attachment, key => $value...) 613=item $attachable->attach ($attachment, key => $value...)
407 614
570 $registry = $CB_TYPE[$object_type] ||= []; 777 $registry = $CB_TYPE[$object_type] ||= [];
571 778
572 } elsif ($type eq "subtype") { 779 } elsif ($type eq "subtype") {
573 defined $object_type or Carp::croak "subtype specified without type"; 780 defined $object_type or Carp::croak "subtype specified without type";
574 my $object_subtype = shift @arg; 781 my $object_subtype = shift @arg;
575 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 782 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
576 783
577 } elsif ($type eq "package") { 784 } elsif ($type eq "package") {
578 my $pkg = shift @arg; 785 my $pkg = shift @arg;
579 786
580 while (my ($name, $id) = each %cb_id) { 787 while (my ($name, $id) = each %cb_id) {
609 _attach $registry, $klass, @attach; 816 _attach $registry, $klass, @attach;
610 } 817 }
611 818
612 $obj->{$name} = \%arg; 819 $obj->{$name} = \%arg;
613 } else { 820 } else {
614 warn "object uses attachment '$name' that is not available, postponing.\n"; 821 warn "object uses attachment '$name' which is not available, postponing.\n";
615 } 822 }
616 823
617 $obj->{_attachment}{$name} = undef; 824 $obj->{_attachment}{$name} = undef;
618} 825}
619 826
621 if (ref $_[0]) { 828 if (ref $_[0]) {
622 _object_attach @_; 829 _object_attach @_;
623 } else { 830 } else {
624 _attach shift->_attach_registry, @_; 831 _attach shift->_attach_registry, @_;
625 } 832 }
833 _recalc_want;
626}; 834};
627 835
628# all those should be optimised 836# all those should be optimised
629sub cf::attachable::detach { 837sub cf::attachable::detach {
630 my ($obj, $name) = @_; 838 my ($obj, $name) = @_;
633 delete $obj->{_attachment}{$name}; 841 delete $obj->{_attachment}{$name};
634 reattach ($obj); 842 reattach ($obj);
635 } else { 843 } else {
636 Carp::croak "cannot, currently, detach class attachments"; 844 Carp::croak "cannot, currently, detach class attachments";
637 } 845 }
846 _recalc_want;
638}; 847};
639 848
640sub cf::attachable::attached { 849sub cf::attachable::attached {
641 my ($obj, $name) = @_; 850 my ($obj, $name) = @_;
642 851
789 } 998 }
790 } else { 999 } else {
791 aio_unlink $filename; 1000 aio_unlink $filename;
792 aio_unlink "$filename.pst"; 1001 aio_unlink "$filename.pst";
793 } 1002 }
794
795 #d##TODO# nuke non .map-files if exist
796 if ($filename =~ s/\.map$//) {
797 aio_unlink $filename;
798 aio_unlink "$filename.pst";
799 }
800 } 1003 }
801} 1004}
802 1005
803sub object_freezer_as_string { 1006sub object_freezer_as_string {
804 my ($rdata, $objs) = @_; 1007 my ($rdata, $objs) = @_;
810 1013
811sub object_thawer_load { 1014sub object_thawer_load {
812 my ($filename) = @_; 1015 my ($filename) = @_;
813 1016
814 my ($data, $av); 1017 my ($data, $av);
815
816 #d#TODO remove .map if file does not exist
817 aio_stat $filename and $filename =~ s/\.map$//;
818 1018
819 (aio_load $filename, $data) >= 0 1019 (aio_load $filename, $data) >= 0
820 or return; 1020 or return;
821 1021
822 unless (aio_stat "$filename.pst") { 1022 unless (aio_stat "$filename.pst") {
824 or return; 1024 or return;
825 $av = eval { (Storable::thaw $av)->{objs} }; 1025 $av = eval { (Storable::thaw $av)->{objs} };
826 } 1026 }
827 1027
828 warn sprintf "loading %s (%d)\n", 1028 warn sprintf "loading %s (%d)\n",
829 $filename, length $data, scalar @{$av || []};#d# 1029 $filename, length $data, scalar @{$av || []};
830 return ($data, $av); 1030 return ($data, $av);
831} 1031}
1032
1033=head2 COMMAND CALLBACKS
1034
1035=over 4
1036
1037=cut
832 1038
833############################################################################# 1039#############################################################################
834# command handling &c 1040# command handling &c
835 1041
836=item cf::register_command $name => \&callback($ob,$args); 1042=item cf::register_command $name => \&callback($ob,$args);
849 push @{ $COMMAND{$name} }, [$caller, $cb]; 1055 push @{ $COMMAND{$name} }, [$caller, $cb];
850} 1056}
851 1057
852=item cf::register_extcmd $name => \&callback($pl,$packet); 1058=item cf::register_extcmd $name => \&callback($pl,$packet);
853 1059
854Register a callbackf ro execution when the client sends an extcmd packet. 1060Register a callback for execution when the client sends an (synchronous)
1061extcmd packet. Ext commands will be processed in the order they are
1062received by the server, like other user commands. The first argument is
1063the logged-in player. Ext commands can only be processed after a player
1064has logged in successfully.
855 1065
856If the callback returns something, it is sent back as if reply was being 1066If the callback returns something, it is sent back as if reply was being
857called. 1067called.
858 1068
1069=item cf::register_exticmd $name => \&callback($ns,$packet);
1070
1071Register a callback for execution when the client sends an (asynchronous)
1072exticmd packet. Exti commands are processed by the server as soon as they
1073are received, i.e. out of order w.r.t. other commands. The first argument
1074is a client socket. Exti commands can be received anytime, even before
1075log-in.
1076
1077If the callback returns something, it is sent back as if reply was being
1078called.
1079
859=cut 1080=cut
860 1081
861sub register_extcmd { 1082sub register_extcmd {
862 my ($name, $cb) = @_; 1083 my ($name, $cb) = @_;
863 1084
864 $EXTCMD{$name} = $cb; 1085 $EXTCMD{$name} = $cb;
1086}
1087
1088sub register_exticmd {
1089 my ($name, $cb) = @_;
1090
1091 $EXTICMD{$name} = $cb;
865} 1092}
866 1093
867cf::player->attach ( 1094cf::player->attach (
868 on_command => sub { 1095 on_command => sub {
869 my ($pl, $name, $params) = @_; 1096 my ($pl, $name, $params) = @_;
878 cf::override; 1105 cf::override;
879 }, 1106 },
880 on_extcmd => sub { 1107 on_extcmd => sub {
881 my ($pl, $buf) = @_; 1108 my ($pl, $buf) = @_;
882 1109
883 my $msg = eval { from_json $buf }; 1110 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
884 1111
885 if (ref $msg) { 1112 if (ref $msg) {
886 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1113 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
887 if (my %reply = $cb->($pl, $msg)) { 1114 if (my %reply = $cb->($pl, $msg)) {
888 $pl->ext_reply ($msg->{msgid}, %reply); 1115 $pl->ext_reply ($msg->{msgid}, %reply);
894 1121
895 cf::override; 1122 cf::override;
896 }, 1123 },
897); 1124);
898 1125
899sub load_extension {
900 my ($path) = @_;
901
902 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
903 my $base = $1;
904 my $pkg = $1;
905 $pkg =~ s/[^[:word:]]/_/g;
906 $pkg = "ext::$pkg";
907
908 warn "... loading '$path' into '$pkg'\n";
909
910 open my $fh, "<:utf8", $path
911 or die "$path: $!";
912
913 my $source =
914 "package $pkg; use strict; use utf8;\n"
915 . "#line 1 \"$path\"\n{\n"
916 . (do { local $/; <$fh> })
917 . "\n};\n1";
918
919 unless (eval $source) {
920 my $msg = $@ ? "$path: $@\n"
921 : "extension disabled.\n";
922 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
923 warn $@;
924 warn "mandatory extension failed to load, exiting.\n";
925 exit 1;
926 }
927 die $@;
928 }
929
930 push @EXTS, $pkg;
931}
932
933sub load_extensions { 1126sub load_extensions {
1127 cf::sync_job {
1128 my %todo;
1129
934 for my $ext (<$LIBDIR/*.ext>) { 1130 for my $path (<$LIBDIR/*.ext>) {
935 next unless -r $ext; 1131 next unless -r $path;
936 eval { 1132
937 load_extension $ext; 1133 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1134 my $base = $1;
1135 my $pkg = $1;
1136 $pkg =~ s/[^[:word:]]/_/g;
1137 $pkg = "ext::$pkg";
1138
1139 open my $fh, "<:utf8", $path
1140 or die "$path: $!";
1141
1142 my $source = do { local $/; <$fh> };
1143
1144 my %ext = (
1145 path => $path,
1146 base => $base,
1147 pkg => $pkg,
1148 );
1149
1150 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1151 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1152
1153 $ext{source} =
1154 "package $pkg; use strict; use utf8;\n"
1155 . "#line 1 \"$path\"\n{\n"
1156 . $source
1157 . "\n};\n1";
1158
1159 $todo{$base} = \%ext;
1160 }
1161
1162 my %done;
1163 while (%todo) {
1164 my $progress;
1165
1166 while (my ($k, $v) = each %todo) {
1167 for (split /,\s*/, $v->{meta}{depends}) {
1168 goto skip
1169 unless exists $done{$_};
1170 }
1171
1172 warn "... loading '$k' into '$v->{pkg}'\n";
1173
1174 unless (eval $v->{source}) {
1175 my $msg = $@ ? "$v->{path}: $@\n"
1176 : "$v->{base}: extension inactive.\n";
1177
1178 if (exists $v->{meta}{mandatory}) {
1179 warn $msg;
1180 warn "mandatory extension failed to load, exiting.\n";
1181 exit 1;
1182 }
1183
1184 warn $msg;
1185 }
1186
1187 $done{$k} = delete $todo{$k};
1188 push @EXTS, $v->{pkg};
1189 $progress = 1;
938 1 1190 }
939 } or warn "$ext not loaded: $@"; 1191
1192 skip:
1193 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1194 unless $progress;
1195 }
940 } 1196 };
941} 1197}
942 1198
943############################################################################# 1199#############################################################################
944 1200
1201=back
1202
945=head2 CORE EXTENSIONS 1203=head2 CORE EXTENSIONS
946 1204
947Functions and methods that extend core crossfire objects. 1205Functions and methods that extend core crossfire objects.
948 1206
949=cut 1207=cut
961Returns the given player object, loading it if necessary (might block). 1219Returns the given player object, loading it if necessary (might block).
962 1220
963=cut 1221=cut
964 1222
965sub playerdir($) { 1223sub playerdir($) {
966 cf::localdir 1224 "$PLAYERDIR/"
967 . "/"
968 . cf::playerdir
969 . "/"
970 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1225 . (ref $_[0] ? $_[0]->ob->name : $_[0])
971} 1226}
972 1227
973sub path($) { 1228sub path($) {
974 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1229 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
975 1230
976 (playerdir $login) . "/$login.pl" 1231 (playerdir $login) . "/playerdata"
977} 1232}
978 1233
979sub find_active($) { 1234sub find_active($) {
980 $cf::PLAYER{$_[0]} 1235 $cf::PLAYER{$_[0]}
981 and $cf::PLAYER{$_[0]}->active 1236 and $cf::PLAYER{$_[0]}->active
994 my $login = $_[0]; 1249 my $login = $_[0];
995 1250
996 my $guard = cf::lock_acquire "user_find:$login"; 1251 my $guard = cf::lock_acquire "user_find:$login";
997 1252
998 $cf::PLAYER{$_[0]} || do { 1253 $cf::PLAYER{$_[0]} || do {
1254 # rename old playerfiles to new ones
1255 #TODO: remove when no longer required
1256 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1257 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1258 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1259 aio_unlink +(playerdir $login) . "/$login.pl";
1260
999 my $pl = load_pl path $login 1261 my $pl = load_pl path $login
1000 or return; 1262 or return;
1001 $cf::PLAYER{$login} = $pl 1263 $cf::PLAYER{$login} = $pl
1002 } 1264 }
1003 } 1265 }
1040 1302
1041=cut 1303=cut
1042 1304
1043sub quit_character { 1305sub quit_character {
1044 my ($pl) = @_; 1306 my ($pl) = @_;
1307
1308 my $name = $pl->ob->name;
1045 1309
1046 $pl->{deny_save} = 1; 1310 $pl->{deny_save} = 1;
1047 $pl->password ("*"); # this should lock out the player until we nuked the dir 1311 $pl->password ("*"); # this should lock out the player until we nuked the dir
1048 1312
1049 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1313 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1054 my $path = playerdir $pl; 1318 my $path = playerdir $pl;
1055 my $temp = "$path~$cf::RUNTIME~deleting~"; 1319 my $temp = "$path~$cf::RUNTIME~deleting~";
1056 aio_rename $path, $temp; 1320 aio_rename $path, $temp;
1057 delete $cf::PLAYER{$pl->ob->name}; 1321 delete $cf::PLAYER{$pl->ob->name};
1058 $pl->destroy; 1322 $pl->destroy;
1323
1324 my $prefix = qr<^~\Q$name\E/>;
1325
1326 # nuke player maps
1327 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1328
1059 IO::AIO::aio_rmtree $temp; 1329 IO::AIO::aio_rmtree $temp;
1330}
1331
1332=item $pl->kick
1333
1334Kicks a player out of the game. This destroys the connection.
1335
1336=cut
1337
1338sub kick {
1339 my ($pl, $kicker) = @_;
1340
1341 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1342 $pl->killer ("kicked");
1343 $pl->ns->destroy;
1060} 1344}
1061 1345
1062=item cf::player::list_logins 1346=item cf::player::list_logins
1063 1347
1064Returns am arrayref of all valid playernames in the system, can take a 1348Returns am arrayref of all valid playernames in the system, can take a
1065while and may block, so not sync_job-capable, ever. 1349while and may block, so not sync_job-capable, ever.
1066 1350
1067=cut 1351=cut
1068 1352
1069sub list_logins { 1353sub list_logins {
1070 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1354 my $dirs = aio_readdir $PLAYERDIR
1071 or return []; 1355 or return [];
1072 1356
1073 my @logins; 1357 my @logins;
1074 1358
1075 for my $login (@$dirs) { 1359 for my $login (@$dirs) {
1110 } 1394 }
1111 1395
1112 \@paths 1396 \@paths
1113} 1397}
1114 1398
1399=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1400
1401Expand crossfire pod fragments into protocol xml.
1402
1403=cut
1404
1405sub expand_cfpod {
1406 ((my $self), (local $_)) = @_;
1407
1408 # escape & and <
1409 s/&/&amp;/g;
1410 s/(?<![BIUGH])</&lt;/g;
1411
1412 # this is buggy, it needs to properly take care of nested <'s
1413
1414 1 while
1415 # replace B<>, I<>, U<> etc.
1416 s/B<([^\>]*)>/<b>$1<\/b>/
1417 || s/I<([^\>]*)>/<i>$1<\/i>/
1418 || s/U<([^\>]*)>/<u>$1<\/u>/
1419 # replace G<male|female> tags
1420 || s{G<([^>|]*)\|([^>]*)>}{
1421 $self->gender ? $2 : $1
1422 }ge
1423 # replace H<hint text>
1424 || s{H<([^\>]*)>}
1425 {
1426 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1427 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1428 "")
1429 [$self->{hintmode}]
1430 }ge;
1431
1432 # create single paragraphs (very hackish)
1433 s/(?<=\S)\n(?=\w)/ /g;
1434
1435 # compress some whitespace
1436 s/\s+\n/\n/g; # ws line-ends
1437 s/\n\n+/\n/g; # double lines
1438 s/^\n+//; # beginning lines
1439 s/\n+$//; # ending lines
1440
1441 $_
1442}
1443
1444sub hintmode {
1445 $_[0]{hintmode} = $_[1] if @_ > 1;
1446 $_[0]{hintmode}
1447}
1448
1115=item $player->ext_reply ($msgid, $msgtype, %msg) 1449=item $player->ext_reply ($msgid, %msg)
1116 1450
1117Sends an ext reply to the player. 1451Sends an ext reply to the player.
1118 1452
1119=cut 1453=cut
1120 1454
1121sub ext_reply($$$%) { 1455sub ext_reply($$%) {
1122 my ($self, $id, %msg) = @_; 1456 my ($self, $id, %msg) = @_;
1123 1457
1124 $msg{msgid} = $id; 1458 $msg{msgid} = $id;
1125 1459 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1126 $self->send ("ext " . cf::to_json \%msg);
1127} 1460}
1128 1461
1129package cf; 1462=item $player->ext_event ($type, %msg)
1463
1464Sends an ext event to the client.
1465
1466=cut
1467
1468sub ext_event($$%) {
1469 my ($self, $type, %msg) = @_;
1470
1471 $self->ns->ext_event ($type, %msg);
1472}
1473
1474=head3 cf::region
1475
1476=over 4
1477
1478=cut
1479
1480package cf::region;
1481
1482=item cf::region::find_by_path $path
1483
1484Tries to decuce the likely region for a map knowing only its path.
1485
1486=cut
1487
1488sub find_by_path($) {
1489 my ($path) = @_;
1490
1491 my ($match, $specificity);
1492
1493 for my $region (list) {
1494 if ($region->{match} && $path =~ $region->{match}) {
1495 ($match, $specificity) = ($region, $region->specificity)
1496 if $region->specificity > $specificity;
1497 }
1498 }
1499
1500 $match
1501}
1130 1502
1131=back 1503=back
1132
1133 1504
1134=head3 cf::map 1505=head3 cf::map
1135 1506
1136=over 4 1507=over 4
1137 1508
1192 my ($self, $merge) = @_; 1563 my ($self, $merge) = @_;
1193 1564
1194 # we have to keep some variables in memory intact 1565 # we have to keep some variables in memory intact
1195 local $self->{path}; 1566 local $self->{path};
1196 local $self->{load_path}; 1567 local $self->{load_path};
1197 local $self->{deny_save};
1198 local $self->{deny_reset};
1199 1568
1200 $self->SUPER::thawer_merge ($merge); 1569 $self->SUPER::thawer_merge ($merge);
1201} 1570}
1202 1571
1203sub normalise { 1572sub normalise {
1275 1644
1276# the original (read-only) location 1645# the original (read-only) location
1277sub load_path { 1646sub load_path {
1278 my ($self) = @_; 1647 my ($self) = @_;
1279 1648
1280 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1649 "$MAPDIR/$self->{path}.map"
1281} 1650}
1282 1651
1283# the temporary/swap location 1652# the temporary/swap location
1284sub save_path { 1653sub save_path {
1285 my ($self) = @_; 1654 my ($self) = @_;
1286 1655
1287 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1656 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1288 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1657 "$TMPDIR/$path.map"
1289} 1658}
1290 1659
1291# the unique path, undef == no special unique path 1660# the unique path, undef == no special unique path
1292sub uniq_path { 1661sub uniq_path {
1293 my ($self) = @_; 1662 my ($self) = @_;
1294 1663
1295 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1664 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1296 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1665 "$UNIQUEDIR/$path"
1297} 1666}
1298 1667
1299# and all this just because we cannot iterate over 1668# and all this just because we cannot iterate over
1300# all maps in C++... 1669# all maps in C++...
1301sub change_all_map_light { 1670sub change_all_map_light {
1303 1672
1304 $_->change_map_light ($change) 1673 $_->change_map_light ($change)
1305 for grep $_->outdoor, values %cf::MAP; 1674 for grep $_->outdoor, values %cf::MAP;
1306} 1675}
1307 1676
1677sub decay_objects {
1678 my ($self) = @_;
1679
1680 return if $self->{deny_reset};
1681
1682 $self->do_decay_objects;
1683}
1684
1308sub unlink_save { 1685sub unlink_save {
1309 my ($self) = @_; 1686 my ($self) = @_;
1310 1687
1311 utf8::encode (my $save = $self->save_path); 1688 utf8::encode (my $save = $self->save_path);
1312 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1689 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1313 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1690 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1314
1315 #d#TODO remove .map and also nuke
1316 $save =~ s/\.map// or return;#d#
1317 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1318 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1319} 1691}
1320 1692
1321sub load_header_from($) { 1693sub load_header_from($) {
1322 my ($self, $path) = @_; 1694 my ($self, $path) = @_;
1323 1695
1373 $self->load_header_orig 1745 $self->load_header_orig
1374 or return; 1746 or return;
1375 $self->prepare_orig; 1747 $self->prepare_orig;
1376 } 1748 }
1377 1749
1750 $self->{deny_reset} = 1
1751 if $self->no_reset;
1752
1753 $self->default_region (cf::region::find_by_path $self->{path})
1754 unless $self->default_region;
1755
1378 1 1756 1
1379} 1757}
1380 1758
1381sub find; 1759sub find;
1382sub find { 1760sub find {
1394 $map->{last_save} = $cf::RUNTIME; 1772 $map->{last_save} = $cf::RUNTIME;
1395 1773
1396 $map->load_header 1774 $map->load_header
1397 or return; 1775 or return;
1398 1776
1399 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1777 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1400 # doing this can freeze the server in a sync job, obviously 1778 # doing this can freeze the server in a sync job, obviously
1401 #$cf::WAIT_FOR_TICK->wait; 1779 #$cf::WAIT_FOR_TICK->wait;
1402 $map->reset; 1780 $map->reset;
1403 undef $guard; 1781 undef $guard;
1404 return find $path; 1782 return find $path;
1415 my ($self) = @_; 1793 my ($self) = @_;
1416 1794
1417 local $self->{deny_reset} = 1; # loading can take a long time 1795 local $self->{deny_reset} = 1; # loading can take a long time
1418 1796
1419 my $path = $self->{path}; 1797 my $path = $self->{path};
1798
1799 {
1420 my $guard = cf::lock_acquire "map_load:$path"; 1800 my $guard = cf::lock_acquire "map_load:$path";
1421 1801
1422 return if $self->in_memory != cf::MAP_SWAPPED; 1802 return if $self->in_memory != cf::MAP_SWAPPED;
1423 1803
1424 $self->in_memory (cf::MAP_LOADING); 1804 $self->in_memory (cf::MAP_LOADING);
1425 1805
1426 $self->alloc; 1806 $self->alloc;
1427 1807
1428 $self->pre_load; 1808 $self->pre_load;
1429
1430 $self->_load_objects ($self->{load_path}, 1)
1431 or return;
1432
1433 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1434 if delete $self->{load_original};
1435
1436 if (my $uniq = $self->uniq_path) {
1437 utf8::encode $uniq;
1438 if (aio_open $uniq, O_RDONLY, 0) {
1439 $self->clear_unique_items;
1440 $self->_load_objects ($uniq, 0);
1441 }
1442 }
1443
1444 Coro::cede;
1445
1446 # now do the right thing for maps
1447 $self->link_multipart_objects;
1448
1449 unless ($self->{deny_activate}) {
1450 $self->decay_objects;
1451 $self->fix_auto_apply;
1452 $self->update_buttons;
1453 Coro::cede; 1809 Coro::cede;
1454 $self->set_darkness_map; 1810
1811 $self->_load_objects ($self->{load_path}, 1)
1812 or return;
1813
1814 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1815 if delete $self->{load_original};
1816
1817 if (my $uniq = $self->uniq_path) {
1818 utf8::encode $uniq;
1819 if (aio_open $uniq, O_RDONLY, 0) {
1820 $self->clear_unique_items;
1821 $self->_load_objects ($uniq, 0);
1822 }
1823 }
1824
1825 Coro::cede;
1826 # now do the right thing for maps
1827 $self->link_multipart_objects;
1455 $self->difficulty ($self->estimate_difficulty) 1828 $self->difficulty ($self->estimate_difficulty)
1456 unless $self->difficulty; 1829 unless $self->difficulty;
1457 Coro::cede; 1830 Coro::cede;
1831
1832 unless ($self->{deny_activate}) {
1833 $self->decay_objects;
1834 $self->fix_auto_apply;
1835 $self->update_buttons;
1836 Coro::cede;
1837 $self->set_darkness_map;
1838 Coro::cede;
1458 $self->activate; 1839 $self->activate;
1840 }
1841
1842 $self->in_memory (cf::MAP_IN_MEMORY);
1459 } 1843 }
1460 1844
1461 $self->post_load; 1845 $self->post_load;
1462
1463 $self->in_memory (cf::MAP_IN_MEMORY);
1464} 1846}
1465 1847
1466sub customise_for { 1848sub customise_for {
1467 my ($self, $ob) = @_; 1849 my ($self, $ob) = @_;
1468 1850
1469 return find "~" . $ob->name . "/" . $self->{path} 1851 return find "~" . $ob->name . "/" . $self->{path}
1470 if $self->per_player; 1852 if $self->per_player;
1853
1854# return find "?party/" . $ob->name . "/" . $self->{path}
1855# if $self->per_party;
1471 1856
1472 $self 1857 $self
1473} 1858}
1474 1859
1475# find and load all maps in the 3x3 area around a map 1860# find and load all maps in the 3x3 area around a map
1586 1971
1587sub reset_at { 1972sub reset_at {
1588 my ($self) = @_; 1973 my ($self) = @_;
1589 1974
1590 # TODO: safety, remove and allow resettable per-player maps 1975 # TODO: safety, remove and allow resettable per-player maps
1591 return 1e99 if $self->isa ("ext::map_per_player");#d#
1592 return 1e99 if $self->{deny_reset}; 1976 return 1e99 if $self->{deny_reset};
1593 1977
1594 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1978 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1595 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1979 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1596 1980
1607 my ($self) = @_; 1991 my ($self) = @_;
1608 1992
1609 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1993 my $lock = cf::lock_acquire "map_data:$self->{path}";
1610 1994
1611 return if $self->players; 1995 return if $self->players;
1612 return if $self->isa ("ext::map_per_player");#d#
1613 1996
1614 warn "resetting map ", $self->path;#d# 1997 warn "resetting map ", $self->path;
1615 1998
1616 $self->in_memory (cf::MAP_SWAPPED); 1999 $self->in_memory (cf::MAP_SWAPPED);
1617 2000
1618 # need to save uniques path 2001 # need to save uniques path
1619 unless ($self->{deny_save}) { 2002 unless ($self->{deny_save}) {
1651 $cf::MAP{$self->path} = $self; 2034 $cf::MAP{$self->path} = $self;
1652 2035
1653 $self->reset; # polite request, might not happen 2036 $self->reset; # polite request, might not happen
1654} 2037}
1655 2038
2039=item $maps = cf::map::tmp_maps
2040
2041Returns an arrayref with all map paths of currently instantiated and saved
2042maps. May block.
2043
2044=cut
2045
2046sub tmp_maps() {
2047 [
2048 map {
2049 utf8::decode $_;
2050 /\.map$/
2051 ? normalise $_
2052 : ()
2053 } @{ aio_readdir $TMPDIR or [] }
2054 ]
2055}
2056
2057=item $maps = cf::map::random_maps
2058
2059Returns an arrayref with all map paths of currently instantiated and saved
2060random maps. May block.
2061
2062=cut
2063
2064sub random_maps() {
2065 [
2066 map {
2067 utf8::decode $_;
2068 /\.map$/
2069 ? normalise "?random/$_"
2070 : ()
2071 } @{ aio_readdir $RANDOMDIR or [] }
2072 ]
2073}
2074
1656=item cf::map::unique_maps 2075=item cf::map::unique_maps
1657 2076
1658Returns an arrayref of paths of all shared maps that have 2077Returns an arrayref of paths of all shared maps that have
1659instantiated unique items. May block. 2078instantiated unique items. May block.
1660 2079
1661=cut 2080=cut
1662 2081
1663sub unique_maps() { 2082sub unique_maps() {
1664 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2083 [
1665 or return; 2084 map {
1666
1667 my @paths;
1668
1669 for (@$files) {
1670 utf8::decode $_; 2085 utf8::decode $_;
1671 next if /\.pst$/; 2086 /\.map$/
1672 next unless /^$PATH_SEP/o; 2087 ? normalise $_
1673 2088 : ()
1674 push @paths, cf::map::normalise $_; 2089 } @{ aio_readdir $UNIQUEDIR or [] }
1675 } 2090 ]
1676
1677 \@paths
1678} 2091}
1679 2092
1680package cf; 2093package cf;
1681 2094
1682=back 2095=back
1728 2141
1729 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2142 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1730 2143
1731 if ($self->{record_replies}) { 2144 if ($self->{record_replies}) {
1732 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2145 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2146
1733 } else { 2147 } else {
2148 my $pl = $self->contr;
2149
2150 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2151 my $diag = $pl->{npc_dialog};
2152 $diag->{pl}->ext_reply (
2153 $diag->{id},
2154 msgtype => "reply",
2155 msg => $diag->{pl}->expand_cfpod ($msg),
2156 add_topics => []
2157 );
2158
2159 } else {
1734 $msg = $npc->name . " says: $msg" if $npc; 2160 $msg = $npc->name . " says: $msg" if $npc;
1735 $self->message ($msg, $flags); 2161 $self->message ($msg, $flags);
2162 }
1736 } 2163 }
1737} 2164}
1738 2165
1739=item $player_object->may ("access") 2166=item $player_object->may ("access")
1740 2167
1788 $self->deactivate_recursive; 2215 $self->deactivate_recursive;
1789 2216
1790 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2217 return if UNIVERSAL::isa $self->map, "ext::map_link";
1791 2218
1792 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2219 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1793 if $self->map; 2220 if $self->map && $self->map->{path} ne "{link}";
1794 2221
1795 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2222 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1796} 2223}
1797 2224
1798sub cf::object::player::leave_link { 2225sub cf::object::player::leave_link {
1799 my ($self, $map, $x, $y) = @_; 2226 my ($self, $map, $x, $y) = @_;
2227
2228 return unless $self->contr->active;
1800 2229
1801 my $link_pos = delete $self->{_link_pos}; 2230 my $link_pos = delete $self->{_link_pos};
1802 2231
1803 unless ($map) { 2232 unless ($map) {
1804 # restore original map position 2233 # restore original map position
1822 $map->load; 2251 $map->load;
1823 $map->load_diag; 2252 $map->load_diag;
1824 2253
1825 return unless $self->contr->active; 2254 return unless $self->contr->active;
1826 $self->activate_recursive; 2255 $self->activate_recursive;
2256
2257 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827 $self->enter_map ($map, $x, $y); 2258 $self->enter_map ($map, $x, $y);
1828} 2259}
1829 2260
1830cf::player->attach ( 2261=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1831 on_logout => sub {
1832 my ($pl) = @_;
1833 2262
1834 # abort map switching before logout 2263Moves the player to the given map-path and coordinates by first freezing
1835 if ($pl->ob->{_link_pos}) { 2264her, loading and preparing them map, calling the provided $check callback
1836 cf::sync_job { 2265that has to return the map if sucecssful, and then unfreezes the player on
1837 $pl->ob->leave_link 2266the new (success) or old (failed) map position. In either case, $done will
1838 }; 2267be called at the end of this process.
1839 }
1840 },
1841 on_login => sub {
1842 my ($pl) = @_;
1843 2268
1844 # try to abort aborted map switching on player login :)
1845 # should happen only on crashes
1846 if ($pl->ob->{_link_pos}) {
1847 $pl->ob->enter_link;
1848 (async {
1849 # we need this sleep as the login has a concurrent enter_exit running
1850 # and this sleep increases chances of the player not ending up in scorn
1851 $pl->ob->reply (undef,
1852 "There was an internal problem at your last logout, "
1853 . "the server will try to bring you to your intended destination in a second.",
1854 cf::NDI_RED);
1855 Coro::Timer::sleep 1;
1856 $pl->ob->leave_link;
1857 })->prio (2);
1858 }
1859 },
1860);
1861
1862=item $player_object->goto ($path, $x, $y)
1863
1864=cut 2269=cut
2270
2271our $GOTOGEN;
1865 2272
1866sub cf::object::player::goto { 2273sub cf::object::player::goto {
1867 my ($self, $path, $x, $y) = @_; 2274 my ($self, $path, $x, $y, $check, $done) = @_;
2275
2276 # do generation counting so two concurrent goto's will be executed in-order
2277 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1868 2278
1869 $self->enter_link; 2279 $self->enter_link;
1870 2280
1871 (async { 2281 (async {
1872 my $map = eval { 2282 my $map = eval {
1873 my $map = cf::map::find $path; 2283 my $map = cf::map::find $path;
2284
2285 if ($map) {
1874 $map = $map->customise_for ($self) if $map; 2286 $map = $map->customise_for ($self);
2287 $map = $check->($map) if $check && $map;
2288 } else {
2289 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2290 }
2291
1875 $map 2292 $map
2293 };
2294
2295 if ($@) {
2296 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2297 LOG llevError | logBacktrace, Carp::longmess $@;
1876 } or 2298 }
1877 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878 2299
2300 if ($gen == $self->{_goto_generation}) {
2301 delete $self->{_goto_generation};
1879 $self->leave_link ($map, $x, $y); 2302 $self->leave_link ($map, $x, $y);
2303 }
2304
2305 $done->() if $done;
1880 })->prio (1); 2306 })->prio (1);
1881} 2307}
1882 2308
1883=item $player_object->enter_exit ($exit_object) 2309=item $player_object->enter_exit ($exit_object)
1884 2310
1923 2349
1924 $rmp->{random_seed} ||= $exit->random_seed; 2350 $rmp->{random_seed} ||= $exit->random_seed;
1925 2351
1926 my $data = cf::to_json $rmp; 2352 my $data = cf::to_json $rmp;
1927 my $md5 = Digest::MD5::md5_hex $data; 2353 my $md5 = Digest::MD5::md5_hex $data;
1928 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2354 my $meta = "$RANDOMDIR/$md5.meta";
1929 2355
1930 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2356 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931 aio_write $fh, 0, (length $data), $data, 0; 2357 aio_write $fh, 0, (length $data), $data, 0;
1932 undef $fh; 2358 undef $fh;
1933 aio_rename "$meta~", $meta; 2359 aio_rename "$meta~", $meta;
1942 2368
1943 return unless $self->type == cf::PLAYER; 2369 return unless $self->type == cf::PLAYER;
1944 2370
1945 if ($exit->slaying eq "/!") { 2371 if ($exit->slaying eq "/!") {
1946 #TODO: this should de-fi-ni-te-ly not be a sync-job 2372 #TODO: this should de-fi-ni-te-ly not be a sync-job
2373 # the problem is that $exit might not survive long enough
2374 # so it needs to be done right now, right here
1947 cf::sync_job { prepare_random_map $exit }; 2375 cf::sync_job { prepare_random_map $exit };
1948 } 2376 }
1949 2377
1950 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2378 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1951 my $hp = $exit->stats->hp; 2379 my $hp = $exit->stats->hp;
1952 my $sp = $exit->stats->sp; 2380 my $sp = $exit->stats->sp;
1953 2381
1954 $self->enter_link; 2382 $self->enter_link;
2383
2384 # if exit is damned, update players death & WoR home-position
2385 $self->contr->savebed ($slaying, $hp, $sp)
2386 if $exit->flag (FLAG_DAMNED);
1955 2387
1956 (async { 2388 (async {
1957 $self->deactivate_recursive; # just to be sure 2389 $self->deactivate_recursive; # just to be sure
1958 unless (eval { 2390 unless (eval {
1959 $self->goto ($slaying, $hp, $sp); 2391 $self->goto ($slaying, $hp, $sp);
1960 2392
1961 1; 2393 1;
1962 }) { 2394 }) {
1963 $self->message ("Something went wrong deep within the crossfire server. " 2395 $self->message ("Something went wrong deep within the crossfire server. "
1964 . "I'll try to bring you back to the map you were before. " 2396 . "I'll try to bring you back to the map you were before. "
1965 . "Please report this to the dungeon master!", 2397 . "Please report this to the dungeon master!",
1966 cf::NDI_UNIQUE | cf::NDI_RED); 2398 cf::NDI_UNIQUE | cf::NDI_RED);
1967 2399
1968 warn "ERROR in enter_exit: $@"; 2400 warn "ERROR in enter_exit: $@";
1969 $self->leave_link; 2401 $self->leave_link;
1970 } 2402 }
1971 })->prio (1); 2403 })->prio (1);
1984 2416
1985sub cf::client::send_drawinfo { 2417sub cf::client::send_drawinfo {
1986 my ($self, $text, $flags) = @_; 2418 my ($self, $text, $flags) = @_;
1987 2419
1988 utf8::encode $text; 2420 utf8::encode $text;
1989 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2421 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1990} 2422}
1991 2423
2424=item $client->send_msg ($color, $type, $msg, [extra...])
2425
2426Send a drawinfo or msg packet to the client, formatting the msg for the
2427client if neccessary. C<$type> should be a string identifying the type of
2428the message, with C<log> being the default. If C<$color> is negative, suppress
2429the message unless the client supports the msg packet.
2430
2431=cut
2432
2433sub cf::client::send_msg {
2434 my ($self, $color, $type, $msg, @extra) = @_;
2435
2436 $msg = $self->pl->expand_cfpod ($msg);
2437
2438 return unless @extra || length $msg;
2439
2440 if ($self->can_msg) {
2441 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2442 } else {
2443 # replace some tags by gcfclient-compatible ones
2444 for ($msg) {
2445 1 while
2446 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2447 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2448 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2449 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2450 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2451 }
2452
2453 if ($color >= 0) {
2454 if (0 && $msg =~ /\[/) {
2455 $self->send_packet ("drawextinfo $color 4 0 $msg")
2456 } else {
2457 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2458 $self->send_packet ("drawinfo $color $msg")
2459 }
2460 }
2461 }
2462}
2463
2464=item $client->ext_event ($type, %msg)
2465
2466Sends an ext event to the client.
2467
2468=cut
2469
2470sub cf::client::ext_event($$%) {
2471 my ($self, $type, %msg) = @_;
2472
2473 return unless $self->extcmd;
2474
2475 $msg{msgtype} = "event_$type";
2476 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2477}
1992 2478
1993=item $success = $client->query ($flags, "text", \&cb) 2479=item $success = $client->query ($flags, "text", \&cb)
1994 2480
1995Queues a query to the client, calling the given callback with 2481Queues a query to the client, calling the given callback with
1996the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2482the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1997C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2483C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1998 2484
1999Queries can fail, so check the return code. Or don't, as queries will become 2485Queries can fail, so check the return code. Or don't, as queries will
2000reliable at some point in the future. 2486become reliable at some point in the future.
2001 2487
2002=cut 2488=cut
2003 2489
2004sub cf::client::query { 2490sub cf::client::query {
2005 my ($self, $flags, $text, $cb) = @_; 2491 my ($self, $flags, $text, $cb) = @_;
2013 utf8::encode $text; 2499 utf8::encode $text;
2014 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2500 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015 2501
2016 $self->send_packet ($self->{query_queue}[0][0]) 2502 $self->send_packet ($self->{query_queue}[0][0])
2017 if @{ $self->{query_queue} } == 1; 2503 if @{ $self->{query_queue} } == 1;
2504
2505 1
2018} 2506}
2019 2507
2020cf::client->attach ( 2508cf::client->attach (
2509 on_connect => sub {
2510 my ($ns) = @_;
2511
2512 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2513 },
2021 on_reply => sub { 2514 on_reply => sub {
2022 my ($ns, $msg) = @_; 2515 my ($ns, $msg) = @_;
2023 2516
2024 # this weird shuffling is so that direct followup queries 2517 # this weird shuffling is so that direct followup queries
2025 # get handled first 2518 # get handled first
2037 } else { 2530 } else {
2038 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2531 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039 } 2532 }
2040 } 2533 }
2041 }, 2534 },
2535 on_exticmd => sub {
2536 my ($ns, $buf) = @_;
2537
2538 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2539
2540 if (ref $msg) {
2541 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2542 if (my %reply = $cb->($ns, $msg)) {
2543 $reply{msgid} = $msg->{msgid};
2544 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2545 }
2546 }
2547 } else {
2548 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2549 }
2550
2551 cf::override;
2552 },
2042); 2553);
2043 2554
2044=item $client->async (\&cb) 2555=item $client->async (\&cb)
2045 2556
2046Create a new coroutine, running the specified callback. The coroutine will 2557Create a new coroutine, running the specified callback. The coroutine will
2093 2604
2094# here we export the classes and methods available to script code 2605# here we export the classes and methods available to script code
2095 2606
2096=pod 2607=pod
2097 2608
2098The following fucntions and emthods are available within a safe environment: 2609The following functions and methods are available within a safe environment:
2099 2610
2100 cf::object contr pay_amount pay_player map 2611 cf::object
2612 contr pay_amount pay_player map x y force_find force_add
2613 insert remove
2614
2101 cf::object::player player 2615 cf::object::player
2102 cf::player peaceful 2616 player
2103 cf::map trigger 2617
2618 cf::player
2619 peaceful
2620
2621 cf::map
2622 trigger
2104 2623
2105=cut 2624=cut
2106 2625
2107for ( 2626for (
2108 ["cf::object" => qw(contr pay_amount pay_player map)], 2627 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2628 insert remove)],
2109 ["cf::object::player" => qw(player)], 2629 ["cf::object::player" => qw(player)],
2110 ["cf::player" => qw(peaceful)], 2630 ["cf::player" => qw(peaceful)],
2111 ["cf::map" => qw(trigger)], 2631 ["cf::map" => qw(trigger)],
2112) { 2632) {
2113 no strict 'refs'; 2633 no strict 'refs';
2184=back 2704=back
2185 2705
2186=cut 2706=cut
2187 2707
2188############################################################################# 2708#############################################################################
2189
2190=head2 EXTENSION DATABASE SUPPORT
2191
2192Crossfire maintains a very simple database for extension use. It can
2193currently store anything that can be serialised using Storable, which
2194excludes objects.
2195
2196The parameter C<$family> should best start with the name of the extension
2197using it, it should be unique.
2198
2199=over 4
2200
2201=item $value = cf::db_get $family => $key
2202
2203Returns a single value from the database.
2204
2205=item cf::db_put $family => $key => $value
2206
2207Stores the given C<$value> in the family.
2208
2209=cut
2210
2211our $DB;
2212
2213sub db_init {
2214 unless ($DB) {
2215 $DB = BDB::db_create $DB_ENV;
2216
2217 cf::sync_job {
2218 eval {
2219 $DB->set_flags (BDB::CHKSUM);
2220
2221 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223 cf::cleanup "db_open(db): $!" if $!;
2224 };
2225 cf::cleanup "db_open(db): $@" if $@;
2226 };
2227
2228 my $path = cf::localdir . "/database.pst";
2229 if (stat $path) {
2230 cf::sync_job {
2231 my $pst = Storable::retrieve $path;
2232
2233 cf::db_put (board => data => $pst->{board});
2234 cf::db_put (guildrules => data => $pst->{guildrules});
2235 cf::db_put (rent => balance => $pst->{rent}{balance});
2236 BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238 unlink $path;
2239 };
2240 }
2241 }
2242}
2243
2244sub db_get($$) {
2245 my $key = "$_[0]/$_[1]";
2246
2247 cf::sync_job {
2248 BDB::db_get $DB, undef, $key, my $data;
2249
2250 $! ? ()
2251 : Compress::LZF::sthaw $data
2252 }
2253}
2254
2255sub db_put($$$) {
2256 BDB::dbreq_pri 4;
2257 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258}
2259
2260#############################################################################
2261# the server's init and main functions 2709# the server's init and main functions
2262 2710
2263sub load_resources { 2711sub load_facedata($) {
2264 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2712 my ($path) = @_;
2713
2714 warn "loading facedata from $path\n";
2715
2716 my $facedata;
2717 0 < aio_load $path, $facedata
2718 or die "$path: $!";
2719
2720 $facedata = Coro::Storable::thaw $facedata;
2721
2722 $facedata->{version} == 2
2723 or cf::cleanup "$path: version mismatch, cannot proceed.";
2724
2725 {
2726 my $faces = $facedata->{faceinfo};
2727
2728 while (my ($face, $info) = each %$faces) {
2729 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2730 cf::face::set_visibility $idx, $info->{visibility};
2731 cf::face::set_magicmap $idx, $info->{magicmap};
2732 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2733 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2734
2735 cf::cede_to_tick;
2736 }
2737
2738 while (my ($face, $info) = each %$faces) {
2739 next unless $info->{smooth};
2740 my $idx = cf::face::find $face
2741 or next;
2742 if (my $smooth = cf::face::find $info->{smooth}) {
2743 cf::face::set_smooth $idx, $smooth;
2744 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2745 } else {
2746 warn "smooth face '$info->{smooth}' not found for face '$face'";
2747 }
2748
2749 cf::cede_to_tick;
2750 }
2751 }
2752
2753 {
2754 my $anims = $facedata->{animinfo};
2755
2756 while (my ($anim, $info) = each %$anims) {
2757 cf::anim::set $anim, $info->{frames}, $info->{facings};
2758 cf::cede_to_tick;
2759 }
2760
2761 cf::anim::invalidate_all; # d'oh
2762 }
2763
2764 {
2765 # TODO: for gcfclient pleasure, we should give resources
2766 # that gcfclient doesn't grok a >10000 face index.
2767 my $res = $facedata->{resource};
2768 my $enc = JSON::XS->new->utf8->canonical;
2769
2770 while (my ($name, $info) = each %$res) {
2771 my $meta = $enc->encode ({
2772 name => $name,
2773 type => $info->{type},
2774 copyright => $info->{copyright}, #TODO#
2775 });
2776 my $data = pack "(w/a*)*", $meta, $info->{data};
2777 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2778
2779 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2780 cf::face::set_type $idx, 1;
2781 cf::face::set_data $idx, 0, $data, $chk;
2782
2783 cf::cede_to_tick;
2784 }
2785 }
2786
2787 1
2788}
2789
2790sub reload_regions {
2791 load_resource_file "$MAPDIR/regions"
2265 or die "unable to load regions file\n";#d# 2792 or die "unable to load regions file\n";
2793
2794 for (cf::region::list) {
2795 $_->{match} = qr/$_->{match}/
2796 if exists $_->{match};
2797 }
2798}
2799
2800sub reload_facedata {
2801 load_facedata "$DATADIR/facedata"
2802 or die "unable to load facedata\n";
2803}
2804
2805sub reload_archetypes {
2806 load_resource_file "$DATADIR/archetypes"
2807 or die "unable to load archetypes\n";
2808 #d# NEED to laod twice to resolve forward references
2809 # this really needs to be done in an extra post-pass
2810 # (which needs to be synchronous, so solve it differently)
2811 load_resource_file "$DATADIR/archetypes"
2812 or die "unable to load archetypes\n";
2813}
2814
2815sub reload_treasures {
2816 load_resource_file "$DATADIR/treasures"
2817 or die "unable to load treasurelists\n";
2818}
2819
2820sub reload_resources {
2821 warn "reloading resource files...\n";
2822
2823 reload_regions;
2824 reload_facedata;
2825 #reload_archetypes;#d#
2826 reload_archetypes;
2827 reload_treasures;
2828
2829 warn "finished reloading resource files\n";
2830}
2831
2832sub init {
2833 reload_resources;
2266} 2834}
2267 2835
2268sub cfg_load { 2836sub cfg_load {
2269 open my $fh, "<:utf8", cf::confdir . "/config" 2837 open my $fh, "<:utf8", "$CONFDIR/config"
2270 or return; 2838 or return;
2271 2839
2272 local $/; 2840 local $/;
2273 *CFG = YAML::Syck::Load <$fh>; 2841 *CFG = YAML::Syck::Load <$fh>;
2274 2842
2282 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2850 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2283 and die "WARNING: m(un)lockall failed: $!\n"; 2851 and die "WARNING: m(un)lockall failed: $!\n";
2284 }; 2852 };
2285 warn $@ if $@; 2853 warn $@ if $@;
2286 } 2854 }
2287}
2288
2289sub init {
2290 load_resources;
2291} 2855}
2292 2856
2293sub main { 2857sub main {
2294 # we must not ever block the main coroutine 2858 # we must not ever block the main coroutine
2295 local $Coro::idle = sub { 2859 local $Coro::idle = sub {
2323 }, 2887 },
2324 ); 2888 );
2325 } 2889 }
2326} 2890}
2327 2891
2892sub write_runtime {
2893 my $runtime = "$LOCALDIR/runtime";
2894
2895 # first touch the runtime file to show we are still running:
2896 # the fsync below can take a very very long time.
2897
2898 IO::AIO::aio_utime $runtime, undef, undef;
2899
2900 my $guard = cf::lock_acquire "write_runtime";
2901
2902 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2903 or return;
2904
2905 my $value = $cf::RUNTIME + 90 + 10;
2906 # 10 is the runtime save interval, for a monotonic clock
2907 # 60 allows for the watchdog to kill the server.
2908
2909 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2910 and return;
2911
2912 # always fsync - this file is important
2913 aio_fsync $fh
2914 and return;
2915
2916 # touch it again to show we are up-to-date
2917 aio_utime $fh, undef, undef;
2918
2919 close $fh
2920 or return;
2921
2922 aio_rename "$runtime~", $runtime
2923 and return;
2924
2925 warn "runtime file written.\n";
2926
2927 1
2928}
2929
2328sub emergency_save() { 2930sub emergency_save() {
2329 my $freeze_guard = cf::freeze_mainloop; 2931 my $freeze_guard = cf::freeze_mainloop;
2330 2932
2331 warn "enter emergency perl save\n"; 2933 warn "enter emergency perl save\n";
2332 2934
2363 2965
2364 warn Carp::longmess "post_cleanup backtrace" 2966 warn Carp::longmess "post_cleanup backtrace"
2365 if $make_core; 2967 if $make_core;
2366} 2968}
2367 2969
2368sub reload() { 2970sub do_reload_perl() {
2369 # can/must only be called in main 2971 # can/must only be called in main
2370 if ($Coro::current != $Coro::main) { 2972 if ($Coro::current != $Coro::main) {
2371 warn "can only reload from main coroutine"; 2973 warn "can only reload from main coroutine";
2372 return; 2974 return;
2373 } 2975 }
2374 2976
2375 warn "reloading..."; 2977 warn "reloading...";
2376 2978
2377 warn "cancelling server ticker"; 2979 warn "entering sync_job";
2378 $TICK_WATCHER->cancel;
2379 2980
2981 cf::sync_job {
2982 cf::write_runtime; # external watchdog should not bark
2380 cf::emergency_save; 2983 cf::emergency_save;
2984 cf::write_runtime; # external watchdog should not bark
2381 2985
2382 eval { 2986 warn "syncing database to disk";
2987 BDB::db_env_txn_checkpoint $DB_ENV;
2988
2383 # if anything goes wrong in here, we should simply crash as we already saved 2989 # if anything goes wrong in here, we should simply crash as we already saved
2384 2990
2385 warn "cancelling all WF_AUTOCANCEL watchers"; 2991 warn "cancelling all WF_AUTOCANCEL watchers";
2386 for (Event::all_watchers) { 2992 for (Event::all_watchers) {
2387 $_->cancel if $_->data & WF_AUTOCANCEL; 2993 $_->cancel if $_->data & WF_AUTOCANCEL;
2388 } 2994 }
2389
2390 warn "syncing database to disk";
2391 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2392 2995
2393 warn "flushing outstanding aio requests"; 2996 warn "flushing outstanding aio requests";
2394 for (;;) { 2997 for (;;) {
2395 BDB::flush; 2998 BDB::flush;
2396 IO::AIO::flush; 2999 IO::AIO::flush;
2397 Coro::cede; 3000 Coro::cede;
2398 last unless IO::AIO::nreqs || BDB::nreqs; 3001 last unless IO::AIO::nreqs || BDB::nreqs;
2399 warn "iterate..."; 3002 warn "iterate...";
2400 } 3003 }
2401 3004
3005 ++$RELOAD;
3006
2402 warn "cancelling all extension coros"; 3007 warn "cancelling all extension coros";
2403 $_->cancel for values %EXT_CORO; 3008 $_->cancel for values %EXT_CORO;
2404 %EXT_CORO = (); 3009 %EXT_CORO = ();
2405 3010
2406 warn "removing commands"; 3011 warn "removing commands";
2407 %COMMAND = (); 3012 %COMMAND = ();
2408 3013
2409 warn "removing ext commands"; 3014 warn "removing ext/exti commands";
2410 %EXTCMD = (); 3015 %EXTCMD = ();
3016 %EXTICMD = ();
2411 3017
2412 warn "unloading/nuking all extensions"; 3018 warn "unloading/nuking all extensions";
2413 for my $pkg (@EXTS) { 3019 for my $pkg (@EXTS) {
2414 warn "... unloading $pkg"; 3020 warn "... unloading $pkg";
2415 3021
2445 Symbol::delete_package "safe::$_" 3051 Symbol::delete_package "safe::$_"
2446 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3052 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2447 3053
2448 warn "unloading cf.pm \"a bit\""; 3054 warn "unloading cf.pm \"a bit\"";
2449 delete $INC{"cf.pm"}; 3055 delete $INC{"cf.pm"};
3056 delete $INC{"cf/pod.pm"};
2450 3057
2451 # don't, removes xs symbols, too, 3058 # don't, removes xs symbols, too,
2452 # and global variables created in xs 3059 # and global variables created in xs
2453 #Symbol::delete_package __PACKAGE__; 3060 #Symbol::delete_package __PACKAGE__;
2454 3061
2463 3070
2464 warn "loading extensions"; 3071 warn "loading extensions";
2465 cf::load_extensions; 3072 cf::load_extensions;
2466 3073
2467 warn "reattaching attachments to objects/players"; 3074 warn "reattaching attachments to objects/players";
2468 _global_reattach; 3075 _global_reattach; # objects, sockets
2469 warn "reattaching attachments to maps"; 3076 warn "reattaching attachments to maps";
2470 reattach $_ for values %MAP; 3077 reattach $_ for values %MAP;
3078 warn "reattaching attachments to players";
3079 reattach $_ for values %PLAYER;
2471 3080
2472 warn "loading reloadable resources"; 3081 warn "leaving sync_job";
2473 load_resources;
2474 3082
2475 warn "restarting server ticker"; 3083 1
2476 3084 } or do {
2477 $TICK_WATCHER->start;
2478 };
2479
2480 if ($@) {
2481 warn $@; 3085 warn $@;
2482 warn "error while reloading, exiting."; 3086 warn "error while reloading, exiting.";
2483 exit 1; 3087 exit 1;
2484 } 3088 };
2485 3089
2486 warn "reloaded"; 3090 warn "reloaded";
2487}; 3091};
2488 3092
2489our $RELOAD_WATCHER; # used only during reload 3093our $RELOAD_WATCHER; # used only during reload
2490 3094
3095sub reload_perl() {
3096 # doing reload synchronously and two reloads happen back-to-back,
3097 # coro crashes during coro_state_free->destroy here.
3098
3099 $RELOAD_WATCHER ||= Event->timer (
3100 reentrant => 0,
3101 after => 0,
3102 data => WF_AUTOCANCEL,
3103 cb => sub {
3104 do_reload_perl;
3105 undef $RELOAD_WATCHER;
3106 },
3107 );
3108}
3109
2491register_command "reload" => sub { 3110register_command "reload" => sub {
2492 my ($who, $arg) = @_; 3111 my ($who, $arg) = @_;
2493 3112
2494 if ($who->flag (FLAG_WIZ)) { 3113 if ($who->flag (FLAG_WIZ)) {
2495 $who->message ("reloading server."); 3114 $who->message ("reloading server.");
2496 3115 async { reload_perl };
2497 # doing reload synchronously and two reloads happen back-to-back,
2498 # coro crashes during coro_state_free->destroy here.
2499
2500 $RELOAD_WATCHER ||= Event->timer (
2501 reentrant => 0,
2502 after => 0,
2503 data => WF_AUTOCANCEL,
2504 cb => sub {
2505 reload;
2506 undef $RELOAD_WATCHER;
2507 },
2508 );
2509 } 3116 }
2510}; 3117};
2511 3118
2512unshift @INC, $LIBDIR; 3119unshift @INC, $LIBDIR;
2513 3120
2514my $bug_warning = 0; 3121my $bug_warning = 0;
2515 3122
3123our @WAIT_FOR_TICK;
3124our @WAIT_FOR_TICK_BEGIN;
3125
3126sub wait_for_tick {
3127 return unless $TICK_WATCHER->is_active;
3128 return if $Coro::current == $Coro::main;
3129
3130 my $signal = new Coro::Signal;
3131 push @WAIT_FOR_TICK, $signal;
3132 $signal->wait;
3133}
3134
3135sub wait_for_tick_begin {
3136 return unless $TICK_WATCHER->is_active;
3137 return if $Coro::current == $Coro::main;
3138
3139 my $signal = new Coro::Signal;
3140 push @WAIT_FOR_TICK_BEGIN, $signal;
3141 $signal->wait;
3142}
3143
3144 my $min = 1e6;#d#
3145 my $avg = 10;
2516$TICK_WATCHER = Event->timer ( 3146$TICK_WATCHER = Event->timer (
2517 reentrant => 0, 3147 reentrant => 0,
2518 parked => 1, 3148 parked => 1,
2519 prio => 0, 3149 prio => 0,
2520 at => $NEXT_TICK || $TICK, 3150 at => $NEXT_TICK || $TICK,
2524 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3154 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2525 unless ++$bug_warning > 10; 3155 unless ++$bug_warning > 10;
2526 return; 3156 return;
2527 } 3157 }
2528 3158
2529 $NOW = Event::time; 3159 $NOW = $tick_start = Event::time;
2530 3160
2531 cf::server_tick; # one server iteration 3161 cf::server_tick; # one server iteration
3162
3163 0 && sync_job {#d#
3164 for(1..10) {
3165 my $t = Event::time;
3166 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3167 or die;
3168
3169 $map->width (50);
3170 $map->height (50);
3171 $map->alloc;
3172 $map->_load_objects ("/tmp/x.map", 1);
3173 my $t = Event::time - $t;
3174
3175 #next unless $t < 0.0013;#d#
3176 if ($t < $min) {
3177 $min = $t;
3178 }
3179 $avg = $avg * 0.99 + $t * 0.01;
3180 }
3181 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3182 exit 0;
3183 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3184 };
3185
2532 $RUNTIME += $TICK; 3186 $RUNTIME += $TICK;
2533 $NEXT_TICK += $TICK; 3187 $NEXT_TICK += $TICK;
2534 3188
2535 $WAIT_FOR_TICK->broadcast; 3189 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2536 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3190 $NEXT_RUNTIME_WRITE = $NOW + 10;
2537 3191 Coro::async_pool {
2538 Event::sweep; 3192 write_runtime
2539 Coro::cede_notself; 3193 or warn "ERROR: unable to write runtime file: $!";
3194 };
2540 3195 }
3196
2541# my $AFTER = Event::time; 3197# my $AFTER = Event::time;
2542# warn $AFTER - $NOW;#d# 3198# warn $AFTER - $NOW;#d#
2543 3199
3200 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3201 $sig->send;
3202 }
3203 while (my $sig = shift @WAIT_FOR_TICK) {
3204 $sig->send;
3205 }
3206
3207 $NOW = Event::time;
3208
2544 # if we are delayed by four ticks or more, skip them all 3209 # if we are delayed by four ticks or more, skip them all
2545 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3210 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2546 3211
2547 $TICK_WATCHER->at ($NEXT_TICK); 3212 $TICK_WATCHER->at ($NEXT_TICK);
2548 $TICK_WATCHER->start; 3213 $TICK_WATCHER->start;
3214
3215 $LOAD = ($NOW - $tick_start) / $TICK;
3216 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3217
3218 _post_tick;
3219
3220
2549 }, 3221 },
2550); 3222);
2551 3223
2552{ 3224{
2553 BDB::max_poll_time $TICK * 0.1; 3225 BDB::max_poll_time $TICK * 0.1;
2581 3253
2582 cf::sync_job { 3254 cf::sync_job {
2583 eval { 3255 eval {
2584 BDB::db_env_open 3256 BDB::db_env_open
2585 $DB_ENV, 3257 $DB_ENV,
2586 $BDB_ENV_DIR, 3258 $BDBDIR,
2587 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3259 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2588 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3260 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2589 0666; 3261 0666;
2590 3262
2591 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3263 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2592 3264
2593 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3265 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2594 $DB_ENV->set_lk_detect; 3266 $DB_ENV->set_lk_detect;
2595 }; 3267 };
2596 3268
2604 3276
2605 undef $Coro::AIO::WATCHER; 3277 undef $Coro::AIO::WATCHER;
2606 IO::AIO::max_poll_time $TICK * 0.1; 3278 IO::AIO::max_poll_time $TICK * 0.1;
2607 $AIO_POLL_WATCHER = Event->io ( 3279 $AIO_POLL_WATCHER = Event->io (
2608 reentrant => 0, 3280 reentrant => 0,
3281 data => WF_AUTOCANCEL,
2609 fd => IO::AIO::poll_fileno, 3282 fd => IO::AIO::poll_fileno,
2610 poll => 'r', 3283 poll => 'r',
2611 prio => 6, 3284 prio => 6,
2612 data => WF_AUTOCANCEL,
2613 cb => \&IO::AIO::poll_cb, 3285 cb => \&IO::AIO::poll_cb,
2614 ); 3286 );
2615} 3287}
2616 3288
2617$WRITE_RUNTIME_WATCHER = Event->timer ( 3289my $_log_backtrace;
2618 reentrant => 0, 3290
2619 data => WF_AUTOCANCEL, 3291sub _log_backtrace {
2620 after => 1, 3292 my ($msg, @addr) = @_;
2621 interval => 10, 3293
2622 prio => 6, # keep it lowest so it acts like a watchdog 3294 $msg =~ s/\n//;
2623 cb => Coro::unblock_sub { 3295
2624 write_runtime 3296 # limit the # of concurrent backtraces
2625 or warn "ERROR: unable to write runtime file: $!"; 3297 if ($_log_backtrace < 2) {
3298 ++$_log_backtrace;
3299 async {
3300 my @bt = fork_call {
3301 @addr = map { sprintf "%x", $_ } @addr;
3302 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3303 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3304 or die "addr2line: $!";
3305
3306 my @funcs;
3307 my @res = <$fh>;
3308 chomp for @res;
3309 while (@res) {
3310 my ($func, $line) = splice @res, 0, 2, ();
3311 push @funcs, "[$func] $line";
3312 }
3313
3314 @funcs
3315 };
3316
3317 LOG llevInfo, "[ABT] $msg\n";
3318 LOG llevInfo, "[ABT] $_\n" for @bt;
3319 --$_log_backtrace;
3320 };
3321 } else {
3322 LOG llevInfo, "[ABT] $msg\n";
3323 LOG llevInfo, "[ABT] [suppressed]\n";
2626 }, 3324 }
2627); 3325}
3326
3327# load additional modules
3328use cf::pod;
2628 3329
2629END { cf::emergency_save } 3330END { cf::emergency_save }
2630 3331
26311 33321
2632 3333

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines