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.213 by root, Tue Feb 13 20:01:04 2007 UTC vs.
Revision 1.303 by root, Wed Jul 11 15:57:31 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 my $runtime = cf::localdir . "/runtime";
362 407
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 408Executes the given code block with the given arguments in a seperate
364 or return; 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.
365 412
366 my $value = $cf::RUNTIME + 90 + 10; 413=cut
367 # 10 is the runtime save interval, for a monotonic clock
368 # 60 allows for the watchdog to kill the server.
369 414
370 (aio_write $fh, 0, (length $value), $value, 0) <= 0 415sub _store_scalar {
371 and return; 416 open my $fh, ">", \my $buf
372 417 or die "fork_call: cannot open fh-to-buf in child : $!";
373 # always fsync - this file is important 418 Storable::store_fd $_[0], $fh;
374 aio_fsync $fh
375 and return;
376
377 close $fh 419 close $fh;
378 or return;
379 420
380 aio_rename "$runtime~", $runtime 421 $buf
381 and return; 422}
382 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;
383 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 });
384} 593}
385 594
386=back 595=back
387 596
388=cut 597=cut
395attach callbacks/event handlers (a collection of which is called an "attachment") 604attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods. 605to it. All such attachable objects support the following methods.
397 606
398In 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>
399C<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
400crossfire+). 609Crossfire TRT).
401 610
402=over 4 611=over 4
403 612
404=item $attachable->attach ($attachment, key => $value...) 613=item $attachable->attach ($attachment, key => $value...)
405 614
568 $registry = $CB_TYPE[$object_type] ||= []; 777 $registry = $CB_TYPE[$object_type] ||= [];
569 778
570 } elsif ($type eq "subtype") { 779 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type"; 780 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg; 781 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 782 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574 783
575 } elsif ($type eq "package") { 784 } elsif ($type eq "package") {
576 my $pkg = shift @arg; 785 my $pkg = shift @arg;
577 786
578 while (my ($name, $id) = each %cb_id) { 787 while (my ($name, $id) = each %cb_id) {
607 _attach $registry, $klass, @attach; 816 _attach $registry, $klass, @attach;
608 } 817 }
609 818
610 $obj->{$name} = \%arg; 819 $obj->{$name} = \%arg;
611 } else { 820 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n"; 821 warn "object uses attachment '$name' which is not available, postponing.\n";
613 } 822 }
614 823
615 $obj->{_attachment}{$name} = undef; 824 $obj->{_attachment}{$name} = undef;
616} 825}
617 826
619 if (ref $_[0]) { 828 if (ref $_[0]) {
620 _object_attach @_; 829 _object_attach @_;
621 } else { 830 } else {
622 _attach shift->_attach_registry, @_; 831 _attach shift->_attach_registry, @_;
623 } 832 }
833 _recalc_want;
624}; 834};
625 835
626# all those should be optimised 836# all those should be optimised
627sub cf::attachable::detach { 837sub cf::attachable::detach {
628 my ($obj, $name) = @_; 838 my ($obj, $name) = @_;
631 delete $obj->{_attachment}{$name}; 841 delete $obj->{_attachment}{$name};
632 reattach ($obj); 842 reattach ($obj);
633 } else { 843 } else {
634 Carp::croak "cannot, currently, detach class attachments"; 844 Carp::croak "cannot, currently, detach class attachments";
635 } 845 }
846 _recalc_want;
636}; 847};
637 848
638sub cf::attachable::attached { 849sub cf::attachable::attached {
639 my ($obj, $name) = @_; 850 my ($obj, $name) = @_;
640 851
787 } 998 }
788 } else { 999 } else {
789 aio_unlink $filename; 1000 aio_unlink $filename;
790 aio_unlink "$filename.pst"; 1001 aio_unlink "$filename.pst";
791 } 1002 }
792
793 #d##TODO# nuke non .map-files if exist
794 if ($filename =~ s/\.map$//) {
795 aio_unlink $filename;
796 aio_unlink "$filename.pst";
797 }
798 } 1003 }
799} 1004}
800 1005
801sub object_freezer_as_string { 1006sub object_freezer_as_string {
802 my ($rdata, $objs) = @_; 1007 my ($rdata, $objs) = @_;
808 1013
809sub object_thawer_load { 1014sub object_thawer_load {
810 my ($filename) = @_; 1015 my ($filename) = @_;
811 1016
812 my ($data, $av); 1017 my ($data, $av);
813
814 #d#TODO remove .map if file does not exist
815 aio_stat $filename and $filename =~ s/\.map$//;
816 1018
817 (aio_load $filename, $data) >= 0 1019 (aio_load $filename, $data) >= 0
818 or return; 1020 or return;
819 1021
820 unless (aio_stat "$filename.pst") { 1022 unless (aio_stat "$filename.pst") {
822 or return; 1024 or return;
823 $av = eval { (Storable::thaw $av)->{objs} }; 1025 $av = eval { (Storable::thaw $av)->{objs} };
824 } 1026 }
825 1027
826 warn sprintf "loading %s (%d)\n", 1028 warn sprintf "loading %s (%d)\n",
827 $filename, length $data, scalar @{$av || []};#d# 1029 $filename, length $data, scalar @{$av || []};
828 return ($data, $av); 1030 return ($data, $av);
829} 1031}
1032
1033=head2 COMMAND CALLBACKS
1034
1035=over 4
1036
1037=cut
830 1038
831############################################################################# 1039#############################################################################
832# command handling &c 1040# command handling &c
833 1041
834=item cf::register_command $name => \&callback($ob,$args); 1042=item cf::register_command $name => \&callback($ob,$args);
847 push @{ $COMMAND{$name} }, [$caller, $cb]; 1055 push @{ $COMMAND{$name} }, [$caller, $cb];
848} 1056}
849 1057
850=item cf::register_extcmd $name => \&callback($pl,$packet); 1058=item cf::register_extcmd $name => \&callback($pl,$packet);
851 1059
852Register 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.
853 1065
854If 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
855called. 1067called.
856 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
857=cut 1080=cut
858 1081
859sub register_extcmd { 1082sub register_extcmd {
860 my ($name, $cb) = @_; 1083 my ($name, $cb) = @_;
861 1084
862 $EXTCMD{$name} = $cb; 1085 $EXTCMD{$name} = $cb;
1086}
1087
1088sub register_exticmd {
1089 my ($name, $cb) = @_;
1090
1091 $EXTICMD{$name} = $cb;
863} 1092}
864 1093
865cf::player->attach ( 1094cf::player->attach (
866 on_command => sub { 1095 on_command => sub {
867 my ($pl, $name, $params) = @_; 1096 my ($pl, $name, $params) = @_;
876 cf::override; 1105 cf::override;
877 }, 1106 },
878 on_extcmd => sub { 1107 on_extcmd => sub {
879 my ($pl, $buf) = @_; 1108 my ($pl, $buf) = @_;
880 1109
881 my $msg = eval { from_json $buf }; 1110 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
882 1111
883 if (ref $msg) { 1112 if (ref $msg) {
884 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1113 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
885 if (my %reply = $cb->($pl, $msg)) { 1114 if (my %reply = $cb->($pl, $msg)) {
886 $pl->ext_reply ($msg->{msgid}, %reply); 1115 $pl->ext_reply ($msg->{msgid}, %reply);
892 1121
893 cf::override; 1122 cf::override;
894 }, 1123 },
895); 1124);
896 1125
897sub load_extension {
898 my ($path) = @_;
899
900 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
901 my $base = $1;
902 my $pkg = $1;
903 $pkg =~ s/[^[:word:]]/_/g;
904 $pkg = "ext::$pkg";
905
906 warn "... loading '$path' into '$pkg'\n";
907
908 open my $fh, "<:utf8", $path
909 or die "$path: $!";
910
911 my $source =
912 "package $pkg; use strict; use utf8;\n"
913 . "#line 1 \"$path\"\n{\n"
914 . (do { local $/; <$fh> })
915 . "\n};\n1";
916
917 unless (eval $source) {
918 my $msg = $@ ? "$path: $@\n"
919 : "extension disabled.\n";
920 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
921 warn $@;
922 warn "mandatory extension failed to load, exiting.\n";
923 exit 1;
924 }
925 die $@;
926 }
927
928 push @EXTS, $pkg;
929}
930
931sub load_extensions { 1126sub load_extensions {
1127 cf::sync_job {
1128 my %todo;
1129
932 for my $ext (<$LIBDIR/*.ext>) { 1130 for my $path (<$LIBDIR/*.ext>) {
933 next unless -r $ext; 1131 next unless -r $path;
934 eval { 1132
935 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;
936 1 1190 }
937 } or warn "$ext not loaded: $@"; 1191
1192 skip:
1193 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1194 unless $progress;
1195 }
938 } 1196 };
939} 1197}
940 1198
941############################################################################# 1199#############################################################################
942 1200
1201=back
1202
943=head2 CORE EXTENSIONS 1203=head2 CORE EXTENSIONS
944 1204
945Functions and methods that extend core crossfire objects. 1205Functions and methods that extend core crossfire objects.
946 1206
947=cut 1207=cut
959Returns the given player object, loading it if necessary (might block). 1219Returns the given player object, loading it if necessary (might block).
960 1220
961=cut 1221=cut
962 1222
963sub playerdir($) { 1223sub playerdir($) {
964 cf::localdir 1224 "$PLAYERDIR/"
965 . "/"
966 . cf::playerdir
967 . "/"
968 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1225 . (ref $_[0] ? $_[0]->ob->name : $_[0])
969} 1226}
970 1227
971sub path($) { 1228sub path($) {
972 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1229 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
973 1230
974 (playerdir $login) . "/$login.pl" 1231 (playerdir $login) . "/playerdata"
975} 1232}
976 1233
977sub find_active($) { 1234sub find_active($) {
978 $cf::PLAYER{$_[0]} 1235 $cf::PLAYER{$_[0]}
979 and $cf::PLAYER{$_[0]}->active 1236 and $cf::PLAYER{$_[0]}->active
992 my $login = $_[0]; 1249 my $login = $_[0];
993 1250
994 my $guard = cf::lock_acquire "user_find:$login"; 1251 my $guard = cf::lock_acquire "user_find:$login";
995 1252
996 $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
997 my $pl = load_pl path $login 1261 my $pl = load_pl path $login
998 or return; 1262 or return;
999 $cf::PLAYER{$login} = $pl 1263 $cf::PLAYER{$login} = $pl
1000 } 1264 }
1001 } 1265 }
1038 1302
1039=cut 1303=cut
1040 1304
1041sub quit_character { 1305sub quit_character {
1042 my ($pl) = @_; 1306 my ($pl) = @_;
1307
1308 my $name = $pl->ob->name;
1043 1309
1044 $pl->{deny_save} = 1; 1310 $pl->{deny_save} = 1;
1045 $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
1046 1312
1047 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1313 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1052 my $path = playerdir $pl; 1318 my $path = playerdir $pl;
1053 my $temp = "$path~$cf::RUNTIME~deleting~"; 1319 my $temp = "$path~$cf::RUNTIME~deleting~";
1054 aio_rename $path, $temp; 1320 aio_rename $path, $temp;
1055 delete $cf::PLAYER{$pl->ob->name}; 1321 delete $cf::PLAYER{$pl->ob->name};
1056 $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
1057 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;
1058} 1344}
1059 1345
1060=item cf::player::list_logins 1346=item cf::player::list_logins
1061 1347
1062Returns 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
1063while and may block, so not sync_job-capable, ever. 1349while and may block, so not sync_job-capable, ever.
1064 1350
1065=cut 1351=cut
1066 1352
1067sub list_logins { 1353sub list_logins {
1068 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1354 my $dirs = aio_readdir $PLAYERDIR
1069 or return []; 1355 or return [];
1070 1356
1071 my @logins; 1357 my @logins;
1072 1358
1073 for my $login (@$dirs) { 1359 for my $login (@$dirs) {
1108 } 1394 }
1109 1395
1110 \@paths 1396 \@paths
1111} 1397}
1112 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
1113=item $player->ext_reply ($msgid, $msgtype, %msg) 1449=item $player->ext_reply ($msgid, %msg)
1114 1450
1115Sends an ext reply to the player. 1451Sends an ext reply to the player.
1116 1452
1117=cut 1453=cut
1118 1454
1119sub ext_reply($$$%) { 1455sub ext_reply($$%) {
1120 my ($self, $id, %msg) = @_; 1456 my ($self, $id, %msg) = @_;
1121 1457
1122 $msg{msgid} = $id; 1458 $msg{msgid} = $id;
1123 1459 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1124 $self->send ("ext " . cf::to_json \%msg);
1125} 1460}
1126 1461
1127package 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}
1128 1502
1129=back 1503=back
1130
1131 1504
1132=head3 cf::map 1505=head3 cf::map
1133 1506
1134=over 4 1507=over 4
1135 1508
1190 my ($self, $merge) = @_; 1563 my ($self, $merge) = @_;
1191 1564
1192 # we have to keep some variables in memory intact 1565 # we have to keep some variables in memory intact
1193 local $self->{path}; 1566 local $self->{path};
1194 local $self->{load_path}; 1567 local $self->{load_path};
1195 local $self->{deny_save};
1196 local $self->{deny_reset};
1197 1568
1198 $self->SUPER::thawer_merge ($merge); 1569 $self->SUPER::thawer_merge ($merge);
1199} 1570}
1200 1571
1201sub normalise { 1572sub normalise {
1273 1644
1274# the original (read-only) location 1645# the original (read-only) location
1275sub load_path { 1646sub load_path {
1276 my ($self) = @_; 1647 my ($self) = @_;
1277 1648
1278 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1649 "$MAPDIR/$self->{path}.map"
1279} 1650}
1280 1651
1281# the temporary/swap location 1652# the temporary/swap location
1282sub save_path { 1653sub save_path {
1283 my ($self) = @_; 1654 my ($self) = @_;
1284 1655
1285 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1656 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1286 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1657 "$TMPDIR/$path.map"
1287} 1658}
1288 1659
1289# the unique path, undef == no special unique path 1660# the unique path, undef == no special unique path
1290sub uniq_path { 1661sub uniq_path {
1291 my ($self) = @_; 1662 my ($self) = @_;
1292 1663
1293 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1664 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1294 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1665 "$UNIQUEDIR/$path"
1295} 1666}
1296 1667
1297# and all this just because we cannot iterate over 1668# and all this just because we cannot iterate over
1298# all maps in C++... 1669# all maps in C++...
1299sub change_all_map_light { 1670sub change_all_map_light {
1301 1672
1302 $_->change_map_light ($change) 1673 $_->change_map_light ($change)
1303 for grep $_->outdoor, values %cf::MAP; 1674 for grep $_->outdoor, values %cf::MAP;
1304} 1675}
1305 1676
1677sub decay_objects {
1678 my ($self) = @_;
1679
1680 return if $self->{deny_reset};
1681
1682 $self->do_decay_objects;
1683}
1684
1306sub unlink_save { 1685sub unlink_save {
1307 my ($self) = @_; 1686 my ($self) = @_;
1308 1687
1309 utf8::encode (my $save = $self->save_path); 1688 utf8::encode (my $save = $self->save_path);
1310 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1689 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1311 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1690 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1312
1313 #d#TODO remove .map and also nuke
1314 $save =~ s/\.map// or return;#d#
1315 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1316 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1317} 1691}
1318 1692
1319sub load_header_from($) { 1693sub load_header_from($) {
1320 my ($self, $path) = @_; 1694 my ($self, $path) = @_;
1321 1695
1371 $self->load_header_orig 1745 $self->load_header_orig
1372 or return; 1746 or return;
1373 $self->prepare_orig; 1747 $self->prepare_orig;
1374 } 1748 }
1375 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
1376 1 1756 1
1377} 1757}
1378 1758
1379sub find; 1759sub find;
1380sub find { 1760sub find {
1392 $map->{last_save} = $cf::RUNTIME; 1772 $map->{last_save} = $cf::RUNTIME;
1393 1773
1394 $map->load_header 1774 $map->load_header
1395 or return; 1775 or return;
1396 1776
1397 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1777 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398 # doing this can freeze the server in a sync job, obviously 1778 # doing this can freeze the server in a sync job, obviously
1399 #$cf::WAIT_FOR_TICK->wait; 1779 #$cf::WAIT_FOR_TICK->wait;
1400 $map->reset; 1780 $map->reset;
1401 undef $guard; 1781 undef $guard;
1402 return find $path; 1782 return find $path;
1413 my ($self) = @_; 1793 my ($self) = @_;
1414 1794
1415 local $self->{deny_reset} = 1; # loading can take a long time 1795 local $self->{deny_reset} = 1; # loading can take a long time
1416 1796
1417 my $path = $self->{path}; 1797 my $path = $self->{path};
1798
1799 {
1418 my $guard = cf::lock_acquire "map_load:$path"; 1800 my $guard = cf::lock_acquire "map_load:$path";
1419 1801
1420 return if $self->in_memory != cf::MAP_SWAPPED; 1802 return if $self->in_memory != cf::MAP_SWAPPED;
1421 1803
1422 $self->in_memory (cf::MAP_LOADING); 1804 $self->in_memory (cf::MAP_LOADING);
1423 1805
1424 $self->alloc; 1806 $self->alloc;
1425 1807
1426 $self->pre_load; 1808 $self->pre_load;
1427
1428 $self->_load_objects ($self->{load_path}, 1)
1429 or return;
1430
1431 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432 if delete $self->{load_original};
1433
1434 if (my $uniq = $self->uniq_path) {
1435 utf8::encode $uniq;
1436 if (aio_open $uniq, O_RDONLY, 0) {
1437 $self->clear_unique_items;
1438 $self->_load_objects ($uniq, 0);
1439 }
1440 }
1441
1442 Coro::cede;
1443
1444 # now do the right thing for maps
1445 $self->link_multipart_objects;
1446
1447 unless ($self->{deny_activate}) {
1448 $self->decay_objects;
1449 $self->fix_auto_apply;
1450 $self->update_buttons;
1451 Coro::cede; 1809 Coro::cede;
1452 $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;
1453 $self->difficulty ($self->estimate_difficulty) 1828 $self->difficulty ($self->estimate_difficulty)
1454 unless $self->difficulty; 1829 unless $self->difficulty;
1455 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;
1456 $self->activate; 1839 $self->activate;
1840 }
1841
1842 $self->in_memory (cf::MAP_IN_MEMORY);
1457 } 1843 }
1458 1844
1459 $self->post_load; 1845 $self->post_load;
1460
1461 $self->in_memory (cf::MAP_IN_MEMORY);
1462} 1846}
1463 1847
1464sub customise_for { 1848sub customise_for {
1465 my ($self, $ob) = @_; 1849 my ($self, $ob) = @_;
1466 1850
1467 return find "~" . $ob->name . "/" . $self->{path} 1851 return find "~" . $ob->name . "/" . $self->{path}
1468 if $self->per_player; 1852 if $self->per_player;
1853
1854# return find "?party/" . $ob->name . "/" . $self->{path}
1855# if $self->per_party;
1469 1856
1470 $self 1857 $self
1471} 1858}
1472 1859
1473# 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
1584 1971
1585sub reset_at { 1972sub reset_at {
1586 my ($self) = @_; 1973 my ($self) = @_;
1587 1974
1588 # TODO: safety, remove and allow resettable per-player maps 1975 # TODO: safety, remove and allow resettable per-player maps
1589 return 1e99 if $self->isa ("ext::map_per_player");#d#
1590 return 1e99 if $self->{deny_reset}; 1976 return 1e99 if $self->{deny_reset};
1591 1977
1592 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1978 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593 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;
1594 1980
1605 my ($self) = @_; 1991 my ($self) = @_;
1606 1992
1607 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1993 my $lock = cf::lock_acquire "map_data:$self->{path}";
1608 1994
1609 return if $self->players; 1995 return if $self->players;
1610 return if $self->isa ("ext::map_per_player");#d#
1611 1996
1612 warn "resetting map ", $self->path;#d# 1997 warn "resetting map ", $self->path;
1613 1998
1614 $self->in_memory (cf::MAP_SWAPPED); 1999 $self->in_memory (cf::MAP_SWAPPED);
1615 2000
1616 # need to save uniques path 2001 # need to save uniques path
1617 unless ($self->{deny_save}) { 2002 unless ($self->{deny_save}) {
1649 $cf::MAP{$self->path} = $self; 2034 $cf::MAP{$self->path} = $self;
1650 2035
1651 $self->reset; # polite request, might not happen 2036 $self->reset; # polite request, might not happen
1652} 2037}
1653 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
1654=item cf::map::unique_maps 2075=item cf::map::unique_maps
1655 2076
1656Returns an arrayref of paths of all shared maps that have 2077Returns an arrayref of paths of all shared maps that have
1657instantiated unique items. May block. 2078instantiated unique items. May block.
1658 2079
1659=cut 2080=cut
1660 2081
1661sub unique_maps() { 2082sub unique_maps() {
1662 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2083 [
1663 or return; 2084 map {
1664
1665 my @paths;
1666
1667 for (@$files) {
1668 utf8::decode $_; 2085 utf8::decode $_;
1669 next if /\.pst$/; 2086 /\.map$/
1670 next unless /^$PATH_SEP/o; 2087 ? normalise $_
1671 2088 : ()
1672 push @paths, cf::map::normalise $_; 2089 } @{ aio_readdir $UNIQUEDIR or [] }
1673 } 2090 ]
1674
1675 \@paths
1676} 2091}
1677 2092
1678package cf; 2093package cf;
1679 2094
1680=back 2095=back
1726 2141
1727 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2142 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1728 2143
1729 if ($self->{record_replies}) { 2144 if ($self->{record_replies}) {
1730 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2145 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2146
1731 } 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 {
1732 $msg = $npc->name . " says: $msg" if $npc; 2160 $msg = $npc->name . " says: $msg" if $npc;
1733 $self->message ($msg, $flags); 2161 $self->message ($msg, $flags);
2162 }
1734 } 2163 }
1735} 2164}
1736 2165
1737=item $player_object->may ("access") 2166=item $player_object->may ("access")
1738 2167
1786 $self->deactivate_recursive; 2215 $self->deactivate_recursive;
1787 2216
1788 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2217 return if UNIVERSAL::isa $self->map, "ext::map_link";
1789 2218
1790 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2219 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1791 if $self->map; 2220 if $self->map && $self->map->{path} ne "{link}";
1792 2221
1793 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2222 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1794} 2223}
1795 2224
1796sub cf::object::player::leave_link { 2225sub cf::object::player::leave_link {
1797 my ($self, $map, $x, $y) = @_; 2226 my ($self, $map, $x, $y) = @_;
2227
2228 return unless $self->contr->active;
1798 2229
1799 my $link_pos = delete $self->{_link_pos}; 2230 my $link_pos = delete $self->{_link_pos};
1800 2231
1801 unless ($map) { 2232 unless ($map) {
1802 # restore original map position 2233 # restore original map position
1820 $map->load; 2251 $map->load;
1821 $map->load_diag; 2252 $map->load_diag;
1822 2253
1823 return unless $self->contr->active; 2254 return unless $self->contr->active;
1824 $self->activate_recursive; 2255 $self->activate_recursive;
2256
2257 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1825 $self->enter_map ($map, $x, $y); 2258 $self->enter_map ($map, $x, $y);
1826} 2259}
1827 2260
1828cf::player->attach (
1829 on_logout => sub {
1830 my ($pl) = @_;
1831
1832 # abort map switching before logout
1833 if ($pl->ob->{_link_pos}) {
1834 cf::sync_job {
1835 $pl->ob->leave_link
1836 };
1837 }
1838 },
1839 on_login => sub {
1840 my ($pl) = @_;
1841
1842 # try to abort aborted map switching on player login :)
1843 # should happen only on crashes
1844 if ($pl->ob->{_link_pos}) {
1845 $pl->ob->enter_link;
1846 (async {
1847 # we need this sleep as the login has a concurrent enter_exit running
1848 # and this sleep increases chances of the player not ending up in scorn
1849 $pl->ob->reply (undef,
1850 "There was an internal problem at your last logout, "
1851 . "the server will try to bring you to your intended destination in a second.",
1852 cf::NDI_RED);
1853 Coro::Timer::sleep 1;
1854 $pl->ob->leave_link;
1855 })->prio (2);
1856 }
1857 },
1858);
1859
1860=item $player_object->goto ($path, $x, $y) 2261=item $player_object->goto ($path, $x, $y[, $check->($map)])
1861 2262
2263Moves the player to the given map-path and coordinates by first freezing
2264her, loading and preparing them map, calling the provided $check callback
2265that has to return the map if sucecssful, and then unfreezes the player on
2266the new (success) or old (failed) map position.
2267
1862=cut 2268=cut
2269
2270our $GOTOGEN;
1863 2271
1864sub cf::object::player::goto { 2272sub cf::object::player::goto {
1865 my ($self, $path, $x, $y) = @_; 2273 my ($self, $path, $x, $y, $check) = @_;
2274
2275 # do generation counting so two concurrent goto's will be executed in-order
2276 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1866 2277
1867 $self->enter_link; 2278 $self->enter_link;
1868 2279
1869 (async { 2280 (async {
1870 my $map = eval { 2281 my $map = eval {
1871 my $map = cf::map::find $path; 2282 my $map = cf::map::find $path;
2283
2284 if ($map) {
1872 $map = $map->customise_for ($self) if $map; 2285 $map = $map->customise_for ($self);
2286 $map = $check->($map) if $check && $map;
2287 } else {
2288 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2289 }
2290
1873 $map 2291 $map
2292 };
2293
2294 if ($@) {
2295 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2296 LOG llevError | logBacktrace, Carp::longmess $@;
1874 } or 2297 }
1875 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1876 2298
2299 if ($gen == $self->{_goto_generation}) {
2300 delete $self->{_goto_generation};
1877 $self->leave_link ($map, $x, $y); 2301 $self->leave_link ($map, $x, $y);
2302 }
1878 })->prio (1); 2303 })->prio (1);
1879} 2304}
1880 2305
1881=item $player_object->enter_exit ($exit_object) 2306=item $player_object->enter_exit ($exit_object)
1882 2307
1921 2346
1922 $rmp->{random_seed} ||= $exit->random_seed; 2347 $rmp->{random_seed} ||= $exit->random_seed;
1923 2348
1924 my $data = cf::to_json $rmp; 2349 my $data = cf::to_json $rmp;
1925 my $md5 = Digest::MD5::md5_hex $data; 2350 my $md5 = Digest::MD5::md5_hex $data;
1926 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2351 my $meta = "$RANDOMDIR/$md5.meta";
1927 2352
1928 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2353 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1929 aio_write $fh, 0, (length $data), $data, 0; 2354 aio_write $fh, 0, (length $data), $data, 0;
1930 undef $fh; 2355 undef $fh;
1931 aio_rename "$meta~", $meta; 2356 aio_rename "$meta~", $meta;
1940 2365
1941 return unless $self->type == cf::PLAYER; 2366 return unless $self->type == cf::PLAYER;
1942 2367
1943 if ($exit->slaying eq "/!") { 2368 if ($exit->slaying eq "/!") {
1944 #TODO: this should de-fi-ni-te-ly not be a sync-job 2369 #TODO: this should de-fi-ni-te-ly not be a sync-job
2370 # the problem is that $exit might not survive long enough
2371 # so it needs to be done right now, right here
1945 cf::sync_job { prepare_random_map $exit }; 2372 cf::sync_job { prepare_random_map $exit };
1946 } 2373 }
1947 2374
1948 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2375 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1949 my $hp = $exit->stats->hp; 2376 my $hp = $exit->stats->hp;
1950 my $sp = $exit->stats->sp; 2377 my $sp = $exit->stats->sp;
1951 2378
1952 $self->enter_link; 2379 $self->enter_link;
2380
2381 # if exit is damned, update players death & WoR home-position
2382 $self->contr->savebed ($slaying, $hp, $sp)
2383 if $exit->flag (FLAG_DAMNED);
1953 2384
1954 (async { 2385 (async {
1955 $self->deactivate_recursive; # just to be sure 2386 $self->deactivate_recursive; # just to be sure
1956 unless (eval { 2387 unless (eval {
1957 $self->goto ($slaying, $hp, $sp); 2388 $self->goto ($slaying, $hp, $sp);
1958 2389
1959 1; 2390 1;
1960 }) { 2391 }) {
1961 $self->message ("Something went wrong deep within the crossfire server. " 2392 $self->message ("Something went wrong deep within the crossfire server. "
1962 . "I'll try to bring you back to the map you were before. " 2393 . "I'll try to bring you back to the map you were before. "
1963 . "Please report this to the dungeon master!", 2394 . "Please report this to the dungeon master!",
1964 cf::NDI_UNIQUE | cf::NDI_RED); 2395 cf::NDI_UNIQUE | cf::NDI_RED);
1965 2396
1966 warn "ERROR in enter_exit: $@"; 2397 warn "ERROR in enter_exit: $@";
1967 $self->leave_link; 2398 $self->leave_link;
1968 } 2399 }
1969 })->prio (1); 2400 })->prio (1);
1982 2413
1983sub cf::client::send_drawinfo { 2414sub cf::client::send_drawinfo {
1984 my ($self, $text, $flags) = @_; 2415 my ($self, $text, $flags) = @_;
1985 2416
1986 utf8::encode $text; 2417 utf8::encode $text;
1987 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2418 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1988} 2419}
1989 2420
2421=item $client->send_msg ($color, $type, $msg, [extra...])
2422
2423Send a drawinfo or msg packet to the client, formatting the msg for the
2424client if neccessary. C<$type> should be a string identifying the type of
2425the message, with C<log> being the default. If C<$color> is negative, suppress
2426the message unless the client supports the msg packet.
2427
2428=cut
2429
2430sub cf::client::send_msg {
2431 my ($self, $color, $type, $msg, @extra) = @_;
2432
2433 $msg = $self->pl->expand_cfpod ($msg);
2434
2435 return unless @extra || length $msg;
2436
2437 if ($self->can_msg) {
2438 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2439 } else {
2440 # replace some tags by gcfclient-compatible ones
2441 for ($msg) {
2442 1 while
2443 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2444 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2445 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2446 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2447 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2448 }
2449
2450 if ($color >= 0) {
2451 if (0 && $msg =~ /\[/) {
2452 $self->send_packet ("drawextinfo $color 4 0 $msg")
2453 } else {
2454 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2455 $self->send_packet ("drawinfo $color $msg")
2456 }
2457 }
2458 }
2459}
2460
2461=item $client->ext_event ($type, %msg)
2462
2463Sends an ext event to the client.
2464
2465=cut
2466
2467sub cf::client::ext_event($$%) {
2468 my ($self, $type, %msg) = @_;
2469
2470 $msg{msgtype} = "event_$type";
2471 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2472}
1990 2473
1991=item $success = $client->query ($flags, "text", \&cb) 2474=item $success = $client->query ($flags, "text", \&cb)
1992 2475
1993Queues a query to the client, calling the given callback with 2476Queues a query to the client, calling the given callback with
1994the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2477the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1995C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2478C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1996 2479
1997Queries can fail, so check the return code. Or don't, as queries will become 2480Queries can fail, so check the return code. Or don't, as queries will
1998reliable at some point in the future. 2481become reliable at some point in the future.
1999 2482
2000=cut 2483=cut
2001 2484
2002sub cf::client::query { 2485sub cf::client::query {
2003 my ($self, $flags, $text, $cb) = @_; 2486 my ($self, $flags, $text, $cb) = @_;
2011 utf8::encode $text; 2494 utf8::encode $text;
2012 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2495 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2013 2496
2014 $self->send_packet ($self->{query_queue}[0][0]) 2497 $self->send_packet ($self->{query_queue}[0][0])
2015 if @{ $self->{query_queue} } == 1; 2498 if @{ $self->{query_queue} } == 1;
2499
2500 1
2016} 2501}
2017 2502
2018cf::client->attach ( 2503cf::client->attach (
2504 on_connect => sub {
2505 my ($ns) = @_;
2506
2507 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2508 },
2019 on_reply => sub { 2509 on_reply => sub {
2020 my ($ns, $msg) = @_; 2510 my ($ns, $msg) = @_;
2021 2511
2022 # this weird shuffling is so that direct followup queries 2512 # this weird shuffling is so that direct followup queries
2023 # get handled first 2513 # get handled first
2035 } else { 2525 } else {
2036 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2526 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2037 } 2527 }
2038 } 2528 }
2039 }, 2529 },
2530 on_exticmd => sub {
2531 my ($ns, $buf) = @_;
2532
2533 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2534
2535 if (ref $msg) {
2536 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2537 if (my %reply = $cb->($ns, $msg)) {
2538 $reply{msgid} = $msg->{msgid};
2539 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2540 }
2541 }
2542 } else {
2543 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2544 }
2545
2546 cf::override;
2547 },
2040); 2548);
2041 2549
2042=item $client->async (\&cb) 2550=item $client->async (\&cb)
2043 2551
2044Create a new coroutine, running the specified callback. The coroutine will 2552Create a new coroutine, running the specified callback. The coroutine will
2091 2599
2092# here we export the classes and methods available to script code 2600# here we export the classes and methods available to script code
2093 2601
2094=pod 2602=pod
2095 2603
2096The following fucntions and emthods are available within a safe environment: 2604The following functions and methods are available within a safe environment:
2097 2605
2098 cf::object contr pay_amount pay_player map 2606 cf::object
2607 contr pay_amount pay_player map x y force_find force_add
2608 insert remove
2609
2099 cf::object::player player 2610 cf::object::player
2100 cf::player peaceful 2611 player
2101 cf::map trigger 2612
2613 cf::player
2614 peaceful
2615
2616 cf::map
2617 trigger
2102 2618
2103=cut 2619=cut
2104 2620
2105for ( 2621for (
2106 ["cf::object" => qw(contr pay_amount pay_player map)], 2622 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2623 insert remove)],
2107 ["cf::object::player" => qw(player)], 2624 ["cf::object::player" => qw(player)],
2108 ["cf::player" => qw(peaceful)], 2625 ["cf::player" => qw(peaceful)],
2109 ["cf::map" => qw(trigger)], 2626 ["cf::map" => qw(trigger)],
2110) { 2627) {
2111 no strict 'refs'; 2628 no strict 'refs';
2182=back 2699=back
2183 2700
2184=cut 2701=cut
2185 2702
2186############################################################################# 2703#############################################################################
2187
2188=head2 EXTENSION DATABASE SUPPORT
2189
2190Crossfire maintains a very simple database for extension use. It can
2191currently store anything that can be serialised using Storable, which
2192excludes objects.
2193
2194The parameter C<$family> should best start with the name of the extension
2195using it, it should be unique.
2196
2197=over 4
2198
2199=item $value = cf::db_get $family => $key
2200
2201Returns a single value from the database.
2202
2203=item cf::db_put $family => $key => $value
2204
2205Stores the given C<$value> in the family.
2206
2207=cut
2208
2209our $DB;
2210
2211sub db_init {
2212 unless ($DB) {
2213 $DB = BDB::db_create $DB_ENV;
2214
2215 cf::sync_job {
2216 eval {
2217 $DB->set_flags (BDB::CHKSUM);
2218
2219 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2220 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2221 cf::cleanup "db_open(db): $!" if $!;
2222 };
2223 cf::cleanup "db_open(db): $@" if $@;
2224 };
2225
2226 my $path = cf::localdir . "/database.pst";
2227 if (stat $path) {
2228 cf::sync_job {
2229 my $pst = Storable::retrieve $path;
2230
2231 cf::db_put (board => data => $pst->{board});
2232 cf::db_put (guildrules => data => $pst->{guildrules});
2233 cf::db_put (rent => balance => $pst->{rent}{balance});
2234 BDB::db_env_txn_checkpoint $DB_ENV;
2235
2236 unlink $path;
2237 };
2238 }
2239 }
2240}
2241
2242sub db_get($$) {
2243 my $key = "$_[0]/$_[1]";
2244
2245 cf::sync_job {
2246 BDB::db_get $DB, undef, $key, my $data;
2247
2248 $! ? ()
2249 : Compress::LZF::sthaw $data
2250 }
2251}
2252
2253sub db_put($$$) {
2254 BDB::dbreq_pri 4;
2255 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2256}
2257
2258#############################################################################
2259# the server's init and main functions 2704# the server's init and main functions
2260 2705
2261sub load_resources { 2706sub load_facedata($) {
2262 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2707 my ($path) = @_;
2708
2709 warn "loading facedata from $path\n";
2710
2711 my $facedata;
2712 0 < aio_load $path, $facedata
2713 or die "$path: $!";
2714
2715 $facedata = Coro::Storable::thaw $facedata;
2716
2717 $facedata->{version} == 2
2718 or cf::cleanup "$path: version mismatch, cannot proceed.";
2719
2720 {
2721 my $faces = $facedata->{faceinfo};
2722
2723 while (my ($face, $info) = each %$faces) {
2724 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2725 cf::face::set_visibility $idx, $info->{visibility};
2726 cf::face::set_magicmap $idx, $info->{magicmap};
2727 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2728 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2729
2730 cf::cede_to_tick;
2731 }
2732
2733 while (my ($face, $info) = each %$faces) {
2734 next unless $info->{smooth};
2735 my $idx = cf::face::find $face
2736 or next;
2737 if (my $smooth = cf::face::find $info->{smooth}) {
2738 cf::face::set_smooth $idx, $smooth;
2739 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2740 } else {
2741 warn "smooth face '$info->{smooth}' not found for face '$face'";
2742 }
2743
2744 cf::cede_to_tick;
2745 }
2746 }
2747
2748 {
2749 my $anims = $facedata->{animinfo};
2750
2751 while (my ($anim, $info) = each %$anims) {
2752 cf::anim::set $anim, $info->{frames}, $info->{facings};
2753 cf::cede_to_tick;
2754 }
2755
2756 cf::anim::invalidate_all; # d'oh
2757 }
2758
2759 {
2760 # TODO: for gcfclient pleasure, we should give resources
2761 # that gcfclient doesn't grok a >10000 face index.
2762 my $res = $facedata->{resource};
2763 my $enc = JSON::XS->new->utf8->canonical;
2764
2765 while (my ($name, $info) = each %$res) {
2766 my $meta = $enc->encode ({
2767 name => $name,
2768 type => $info->{type},
2769 copyright => $info->{copyright}, #TODO#
2770 });
2771 my $data = pack "(w/a*)*", $meta, $info->{data};
2772 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2773
2774 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2775 cf::face::set_type $idx, 1;
2776 cf::face::set_data $idx, 0, $data, $chk;
2777
2778 cf::cede_to_tick;
2779 }
2780 }
2781
2782 1
2783}
2784
2785sub reload_regions {
2786 load_resource_file "$MAPDIR/regions"
2263 or die "unable to load regions file\n";#d# 2787 or die "unable to load regions file\n";
2788}
2789
2790sub reload_facedata {
2791 load_facedata "$DATADIR/facedata"
2792 or die "unable to load facedata\n";
2793}
2794
2795sub reload_archetypes {
2796 load_resource_file "$DATADIR/archetypes"
2797 or die "unable to load archetypes\n";
2798 #d# NEED to laod twice to resolve forward references
2799 # this really needs to be done in an extra post-pass
2800 # (which needs to be synchronous, so solve it differently)
2801 load_resource_file "$DATADIR/archetypes"
2802 or die "unable to load archetypes\n";
2803}
2804
2805sub reload_treasures {
2806 load_resource_file "$DATADIR/treasures"
2807 or die "unable to load treasurelists\n";
2808}
2809
2810sub reload_resources {
2811 warn "reloading resource files...\n";
2812
2813 reload_regions;
2814 reload_facedata;
2815 #reload_archetypes;#d#
2816 reload_archetypes;
2817 reload_treasures;
2818
2819 warn "finished reloading resource files\n";
2820}
2821
2822sub init {
2823 reload_resources;
2264} 2824}
2265 2825
2266sub cfg_load { 2826sub cfg_load {
2267 open my $fh, "<:utf8", cf::confdir . "/config" 2827 open my $fh, "<:utf8", "$CONFDIR/config"
2268 or return; 2828 or return;
2269 2829
2270 local $/; 2830 local $/;
2271 *CFG = YAML::Syck::Load <$fh>; 2831 *CFG = YAML::Syck::Load <$fh>;
2272 2832
2280 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2840 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2281 and die "WARNING: m(un)lockall failed: $!\n"; 2841 and die "WARNING: m(un)lockall failed: $!\n";
2282 }; 2842 };
2283 warn $@ if $@; 2843 warn $@ if $@;
2284 } 2844 }
2285}
2286
2287sub init {
2288 load_resources;
2289} 2845}
2290 2846
2291sub main { 2847sub main {
2292 # we must not ever block the main coroutine 2848 # we must not ever block the main coroutine
2293 local $Coro::idle = sub { 2849 local $Coro::idle = sub {
2300 cfg_load; 2856 cfg_load;
2301 db_init; 2857 db_init;
2302 load_extensions; 2858 load_extensions;
2303 2859
2304 $TICK_WATCHER->start; 2860 $TICK_WATCHER->start;
2305 $WRITE_RUNTIME_WATCHER->start;
2306 Event::loop; 2861 Event::loop;
2307} 2862}
2308 2863
2309############################################################################# 2864#############################################################################
2310# initialisation and cleanup 2865# initialisation and cleanup
2322 }, 2877 },
2323 ); 2878 );
2324 } 2879 }
2325} 2880}
2326 2881
2882sub write_runtime {
2883 my $runtime = "$LOCALDIR/runtime";
2884
2885 # first touch the runtime file to show we are still running:
2886 # the fsync below can take a very very long time.
2887
2888 IO::AIO::aio_utime $runtime, undef, undef;
2889
2890 my $guard = cf::lock_acquire "write_runtime";
2891
2892 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2893 or return;
2894
2895 my $value = $cf::RUNTIME + 90 + 10;
2896 # 10 is the runtime save interval, for a monotonic clock
2897 # 60 allows for the watchdog to kill the server.
2898
2899 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2900 and return;
2901
2902 # always fsync - this file is important
2903 aio_fsync $fh
2904 and return;
2905
2906 # touch it again to show we are up-to-date
2907 aio_utime $fh, undef, undef;
2908
2909 close $fh
2910 or return;
2911
2912 aio_rename "$runtime~", $runtime
2913 and return;
2914
2915 warn "runtime file written.\n";
2916
2917 1
2918}
2919
2327sub emergency_save() { 2920sub emergency_save() {
2328 my $freeze_guard = cf::freeze_mainloop; 2921 my $freeze_guard = cf::freeze_mainloop;
2329 2922
2330 warn "enter emergency perl save\n"; 2923 warn "enter emergency perl save\n";
2331 2924
2362 2955
2363 warn Carp::longmess "post_cleanup backtrace" 2956 warn Carp::longmess "post_cleanup backtrace"
2364 if $make_core; 2957 if $make_core;
2365} 2958}
2366 2959
2367sub reload() { 2960sub do_reload_perl() {
2368 # can/must only be called in main 2961 # can/must only be called in main
2369 if ($Coro::current != $Coro::main) { 2962 if ($Coro::current != $Coro::main) {
2370 warn "can only reload from main coroutine"; 2963 warn "can only reload from main coroutine";
2371 return; 2964 return;
2372 } 2965 }
2374 warn "reloading..."; 2967 warn "reloading...";
2375 2968
2376 warn "entering sync_job"; 2969 warn "entering sync_job";
2377 2970
2378 cf::sync_job { 2971 cf::sync_job {
2379 cf::write_runtime; 2972 cf::write_runtime; # external watchdog should not bark
2380 cf::emergency_save; 2973 cf::emergency_save;
2381 cf::write_runtime; 2974 cf::write_runtime; # external watchdog should not bark
2382 2975
2383 warn "syncing database to disk"; 2976 warn "syncing database to disk";
2384 BDB::db_env_txn_checkpoint $DB_ENV; 2977 BDB::db_env_txn_checkpoint $DB_ENV;
2385 2978
2386 # if anything goes wrong in here, we should simply crash as we already saved 2979 # if anything goes wrong in here, we should simply crash as we already saved
2397 Coro::cede; 2990 Coro::cede;
2398 last unless IO::AIO::nreqs || BDB::nreqs; 2991 last unless IO::AIO::nreqs || BDB::nreqs;
2399 warn "iterate..."; 2992 warn "iterate...";
2400 } 2993 }
2401 2994
2995 ++$RELOAD;
2996
2402 warn "cancelling all extension coros"; 2997 warn "cancelling all extension coros";
2403 $_->cancel for values %EXT_CORO; 2998 $_->cancel for values %EXT_CORO;
2404 %EXT_CORO = (); 2999 %EXT_CORO = ();
2405 3000
2406 warn "removing commands"; 3001 warn "removing commands";
2407 %COMMAND = (); 3002 %COMMAND = ();
2408 3003
2409 warn "removing ext commands"; 3004 warn "removing ext/exti commands";
2410 %EXTCMD = (); 3005 %EXTCMD = ();
3006 %EXTICMD = ();
2411 3007
2412 warn "unloading/nuking all extensions"; 3008 warn "unloading/nuking all extensions";
2413 for my $pkg (@EXTS) { 3009 for my $pkg (@EXTS) {
2414 warn "... unloading $pkg"; 3010 warn "... unloading $pkg";
2415 3011
2445 Symbol::delete_package "safe::$_" 3041 Symbol::delete_package "safe::$_"
2446 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3042 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2447 3043
2448 warn "unloading cf.pm \"a bit\""; 3044 warn "unloading cf.pm \"a bit\"";
2449 delete $INC{"cf.pm"}; 3045 delete $INC{"cf.pm"};
3046 delete $INC{"cf/pod.pm"};
2450 3047
2451 # don't, removes xs symbols, too, 3048 # don't, removes xs symbols, too,
2452 # and global variables created in xs 3049 # and global variables created in xs
2453 #Symbol::delete_package __PACKAGE__; 3050 #Symbol::delete_package __PACKAGE__;
2454 3051
2463 3060
2464 warn "loading extensions"; 3061 warn "loading extensions";
2465 cf::load_extensions; 3062 cf::load_extensions;
2466 3063
2467 warn "reattaching attachments to objects/players"; 3064 warn "reattaching attachments to objects/players";
2468 _global_reattach; 3065 _global_reattach; # objects, sockets
2469 warn "reattaching attachments to maps"; 3066 warn "reattaching attachments to maps";
2470 reattach $_ for values %MAP; 3067 reattach $_ for values %MAP;
2471 3068 warn "reattaching attachments to players";
2472 warn "loading reloadable resources"; 3069 reattach $_ for values %PLAYER;
2473 load_resources;
2474 3070
2475 warn "leaving sync_job"; 3071 warn "leaving sync_job";
2476 3072
2477 1 3073 1
2478 } or do { 3074 } or do {
2484 warn "reloaded"; 3080 warn "reloaded";
2485}; 3081};
2486 3082
2487our $RELOAD_WATCHER; # used only during reload 3083our $RELOAD_WATCHER; # used only during reload
2488 3084
3085sub reload_perl() {
3086 # doing reload synchronously and two reloads happen back-to-back,
3087 # coro crashes during coro_state_free->destroy here.
3088
3089 $RELOAD_WATCHER ||= Event->timer (
3090 reentrant => 0,
3091 after => 0,
3092 data => WF_AUTOCANCEL,
3093 cb => sub {
3094 do_reload_perl;
3095 undef $RELOAD_WATCHER;
3096 },
3097 );
3098}
3099
2489register_command "reload" => sub { 3100register_command "reload" => sub {
2490 my ($who, $arg) = @_; 3101 my ($who, $arg) = @_;
2491 3102
2492 if ($who->flag (FLAG_WIZ)) { 3103 if ($who->flag (FLAG_WIZ)) {
2493 $who->message ("reloading server."); 3104 $who->message ("reloading server.");
2494 3105 async { reload_perl };
2495 # doing reload synchronously and two reloads happen back-to-back,
2496 # coro crashes during coro_state_free->destroy here.
2497
2498 $RELOAD_WATCHER ||= Event->timer (
2499 reentrant => 0,
2500 after => 0,
2501 data => WF_AUTOCANCEL,
2502 cb => sub {
2503 reload;
2504 undef $RELOAD_WATCHER;
2505 },
2506 );
2507 } 3106 }
2508}; 3107};
2509 3108
2510unshift @INC, $LIBDIR; 3109unshift @INC, $LIBDIR;
2511 3110
2512my $bug_warning = 0; 3111my $bug_warning = 0;
2513 3112
3113our @WAIT_FOR_TICK;
3114our @WAIT_FOR_TICK_BEGIN;
3115
3116sub wait_for_tick {
3117 return unless $TICK_WATCHER->is_active;
3118 return if $Coro::current == $Coro::main;
3119
3120 my $signal = new Coro::Signal;
3121 push @WAIT_FOR_TICK, $signal;
3122 $signal->wait;
3123}
3124
3125sub wait_for_tick_begin {
3126 return unless $TICK_WATCHER->is_active;
3127 return if $Coro::current == $Coro::main;
3128
3129 my $signal = new Coro::Signal;
3130 push @WAIT_FOR_TICK_BEGIN, $signal;
3131 $signal->wait;
3132}
3133
3134 my $min = 1e6;#d#
3135 my $avg = 10;
2514$TICK_WATCHER = Event->timer ( 3136$TICK_WATCHER = Event->timer (
2515 reentrant => 0, 3137 reentrant => 0,
2516 parked => 1, 3138 parked => 1,
2517 prio => 0, 3139 prio => 0,
2518 at => $NEXT_TICK || $TICK, 3140 at => $NEXT_TICK || $TICK,
2522 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3144 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2523 unless ++$bug_warning > 10; 3145 unless ++$bug_warning > 10;
2524 return; 3146 return;
2525 } 3147 }
2526 3148
2527 $NOW = Event::time; 3149 $NOW = $tick_start = Event::time;
2528 3150
2529 cf::server_tick; # one server iteration 3151 cf::server_tick; # one server iteration
3152
3153 0 && sync_job {#d#
3154 for(1..10) {
3155 my $t = Event::time;
3156 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3157 or die;
3158
3159 $map->width (50);
3160 $map->height (50);
3161 $map->alloc;
3162 $map->_load_objects ("/tmp/x.map", 1);
3163 my $t = Event::time - $t;
3164
3165 #next unless $t < 0.0013;#d#
3166 if ($t < $min) {
3167 $min = $t;
3168 }
3169 $avg = $avg * 0.99 + $t * 0.01;
3170 }
3171 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3172 exit 0;
3173 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3174 };
3175
2530 $RUNTIME += $TICK; 3176 $RUNTIME += $TICK;
2531 $NEXT_TICK += $TICK; 3177 $NEXT_TICK += $TICK;
2532 3178
2533 $WAIT_FOR_TICK->broadcast; 3179 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2534 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3180 $NEXT_RUNTIME_WRITE = $NOW + 10;
3181 Coro::async_pool {
3182 write_runtime
3183 or warn "ERROR: unable to write runtime file: $!";
3184 };
3185 }
2535 3186
2536# my $AFTER = Event::time; 3187# my $AFTER = Event::time;
2537# warn $AFTER - $NOW;#d# 3188# warn $AFTER - $NOW;#d#
2538 3189
3190 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3191 $sig->send;
3192 }
3193 while (my $sig = shift @WAIT_FOR_TICK) {
3194 $sig->send;
3195 }
3196
3197 $NOW = Event::time;
3198
2539 # if we are delayed by four ticks or more, skip them all 3199 # if we are delayed by four ticks or more, skip them all
2540 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3200 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2541 3201
2542 $TICK_WATCHER->at ($NEXT_TICK); 3202 $TICK_WATCHER->at ($NEXT_TICK);
2543 $TICK_WATCHER->start; 3203 $TICK_WATCHER->start;
3204
3205 $LOAD = ($NOW - $tick_start) / $TICK;
3206 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3207
3208 _post_tick;
3209
3210
2544 }, 3211 },
2545); 3212);
2546 3213
2547{ 3214{
2548 BDB::max_poll_time $TICK * 0.1; 3215 BDB::max_poll_time $TICK * 0.1;
2576 3243
2577 cf::sync_job { 3244 cf::sync_job {
2578 eval { 3245 eval {
2579 BDB::db_env_open 3246 BDB::db_env_open
2580 $DB_ENV, 3247 $DB_ENV,
2581 $BDB_ENV_DIR, 3248 $BDBDIR,
2582 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3249 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2583 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3250 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2584 0666; 3251 0666;
2585 3252
2586 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3253 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2587 3254
2588 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3255 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2589 $DB_ENV->set_lk_detect; 3256 $DB_ENV->set_lk_detect;
2590 }; 3257 };
2591 3258
2599 3266
2600 undef $Coro::AIO::WATCHER; 3267 undef $Coro::AIO::WATCHER;
2601 IO::AIO::max_poll_time $TICK * 0.1; 3268 IO::AIO::max_poll_time $TICK * 0.1;
2602 $AIO_POLL_WATCHER = Event->io ( 3269 $AIO_POLL_WATCHER = Event->io (
2603 reentrant => 0, 3270 reentrant => 0,
3271 data => WF_AUTOCANCEL,
2604 fd => IO::AIO::poll_fileno, 3272 fd => IO::AIO::poll_fileno,
2605 poll => 'r', 3273 poll => 'r',
2606 prio => 6, 3274 prio => 6,
2607 data => WF_AUTOCANCEL,
2608 cb => \&IO::AIO::poll_cb, 3275 cb => \&IO::AIO::poll_cb,
2609 ); 3276 );
2610} 3277}
2611 3278
2612$WRITE_RUNTIME_WATCHER = Event->timer ( 3279my $_log_backtrace;
2613 reentrant => 0,
2614 data => WF_AUTOCANCEL,
2615 parked => 1,
2616 after => 1,
2617 interval => 10,
2618 prio => 6, # keep it lowest so it acts like a watchdog
2619 cb => sub {
2620 $TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
2621 3280
2622 Coro::async_pool { 3281sub _log_backtrace {
2623 write_runtime 3282 my ($msg, @addr) = @_;
2624 or warn "ERROR: unable to write runtime file: $!"; 3283
3284 $msg =~ s/\n//;
3285
3286 # limit the # of concurrent backtraces
3287 if ($_log_backtrace < 2) {
3288 ++$_log_backtrace;
3289 async {
3290 my @bt = fork_call {
3291 @addr = map { sprintf "%x", $_ } @addr;
3292 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3293 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3294 or die "addr2line: $!";
3295
3296 my @funcs;
3297 my @res = <$fh>;
3298 chomp for @res;
3299 while (@res) {
3300 my ($func, $line) = splice @res, 0, 2, ();
3301 push @funcs, "[$func] $line";
3302 }
3303
3304 @funcs
3305 };
3306
3307 LOG llevInfo, "[ABT] $msg\n";
3308 LOG llevInfo, "[ABT] $_\n" for @bt;
3309 --$_log_backtrace;
2625 }; 3310 };
3311 } else {
3312 LOG llevInfo, "[ABT] $msg\n";
3313 LOG llevInfo, "[ABT] [suppressed]\n";
2626 }, 3314 }
2627); 3315}
3316
3317# load additional modules
3318use cf::pod;
2628 3319
2629END { cf::emergency_save } 3320END { cf::emergency_save }
2630 3321
26311 33221
2632 3323

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines