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.205 by root, Mon Feb 5 18:29:20 2007 UTC vs.
Revision 1.291 by root, Tue Jul 3 00:54:44 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 ();
26use BDB ();
20use Data::Dumper; 27use Data::Dumper;
21use Digest::MD5; 28use Digest::MD5;
22use Fcntl; 29use Fcntl;
30use YAML::Syck ();
23use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
24use YAML::Syck ();
25use Time::HiRes; 32use Time::HiRes;
33use Compress::LZF;
26 34
35# configure various modules to our taste
36#
37$Storable::canonical = 1; # reduce rsync transfers
38Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
39Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
40
27use Event; $Event::Eval = 1; # no idea why this is required, but it is 41$Event::Eval = 1; # no idea why this is required, but it is
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30 42
31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 43# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32$YAML::Syck::ImplicitUnicode = 1; 44$YAML::Syck::ImplicitUnicode = 1;
33 45
34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 46$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35 47
48sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
49
36our %COMMAND = (); 50our %COMMAND = ();
37our %COMMAND_TIME = (); 51our %COMMAND_TIME = ();
38 52
39our @EXTS = (); # list of extension package names 53our @EXTS = (); # list of extension package names
40our %EXTCMD = (); 54our %EXTCMD = ();
55our %EXTICMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions 56our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps 57our %EXT_MAP = (); # pluggable maps
43 58
59our $RELOAD; # number of reloads so far
44our @EVENT; 60our @EVENT;
45our $LIBDIR = datadir . "/ext";
46 61
47our $TICK = MAX_TIME * 1e-6; 62our $CONFDIR = confdir;
63our $DATADIR = datadir;
64our $LIBDIR = "$DATADIR/ext";
65our $PODDIR = "$DATADIR/pod";
66our $MAPDIR = "$DATADIR/" . mapdir;
67our $LOCALDIR = localdir;
68our $TMPDIR = "$LOCALDIR/" . tmpdir;
69our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
70our $PLAYERDIR = "$LOCALDIR/" . playerdir;
71our $RANDOMDIR = "$LOCALDIR/random";
72our $BDBDIR = "$LOCALDIR/db";
73
74our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48our $TICK_WATCHER; 75our $TICK_WATCHER;
49our $AIO_POLL_WATCHER; 76our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER; 77our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51our $NEXT_TICK; 78our $NEXT_TICK;
52our $NOW; 79our $NOW;
53our $USE_FSYNC = 1; # use fsync to write maps - default off 80our $USE_FSYNC = 1; # use fsync to write maps - default off
54 81
82our $BDB_POLL_WATCHER;
83our $DB_ENV;
84
55our %CFG; 85our %CFG;
56 86
57our $UPTIME; $UPTIME ||= time; 87our $UPTIME; $UPTIME ||= time;
58our $RUNTIME; 88our $RUNTIME;
59 89
60our %PLAYER; # all users 90our %PLAYER; # all users
61our %MAP; # all maps 91our %MAP; # all maps
62our $LINK_MAP; # the special {link} map, which is always available 92our $LINK_MAP; # the special {link} map, which is always available
63our $RANDOM_MAPS = cf::localdir . "/random";
64
65our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
66our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
67 93
68# used to convert map paths into valid unix filenames by replacing / by ∕ 94# used to convert map paths into valid unix filenames by replacing / by ∕
69our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 95our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
70 96
97our $LOAD; # a number between 0 (idle) and 1 (too many objects)
98our $LOADAVG; # same thing, but with alpha-smoothing
99our $tick_start; # for load detecting purposes
100
71binmode STDOUT; 101binmode STDOUT;
72binmode STDERR; 102binmode STDERR;
73 103
74# read virtual server time, if available 104# read virtual server time, if available
75unless ($RUNTIME || !-e cf::localdir . "/runtime") { 105unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
76 open my $fh, "<", cf::localdir . "/runtime" 106 open my $fh, "<", "$LOCALDIR/runtime"
77 or die "unable to read runtime file: $!"; 107 or die "unable to read runtime file: $!";
78 $RUNTIME = <$fh> + 0.; 108 $RUNTIME = <$fh> + 0.;
79} 109}
80 110
81mkdir cf::localdir; 111mkdir $_
82mkdir cf::localdir . "/" . cf::playerdir; 112 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
83mkdir cf::localdir . "/" . cf::tmpdir;
84mkdir cf::localdir . "/" . cf::uniquedir;
85mkdir $RANDOM_MAPS;
86 113
87our $EMERGENCY_POSITION; 114our $EMERGENCY_POSITION;
88 115
89sub cf::map::normalise; 116sub cf::map::normalise;
90 117
101=item $cf::RUNTIME 128=item $cf::RUNTIME
102 129
103The time this server has run, starts at 0 and is increased by $cf::TICK on 130The time this server has run, starts at 0 and is increased by $cf::TICK on
104every server tick. 131every server tick.
105 132
106=item $cf::LIBDIR 133=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
134$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
135$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
107 136
108The perl library directory, where extensions and cf-specific modules can 137Various directories - "/etc", read-only install directory, perl-library
109be found. It will be added to C<@INC> automatically. 138directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
139unique-items directory, player file directory, random maps directory and
140database environment.
110 141
111=item $cf::NOW 142=item $cf::NOW
112 143
113The time of the last (current) server tick. 144The time of the last (current) server tick.
114 145
115=item $cf::TICK 146=item $cf::TICK
116 147
117The interval between server ticks, in seconds. 148The interval between server ticks, in seconds.
149
150=item $cf::LOADAVG
151
152The current CPU load on the server (alpha-smoothed), as a value between 0
153(none) and 1 (overloaded), indicating how much time is spent on processing
154objects per tick. Healthy values are < 0.5.
155
156=item $cf::LOAD
157
158The raw value load value from the last tick.
118 159
119=item %cf::CFG 160=item %cf::CFG
120 161
121Configuration for the server, loaded from C</etc/crossfire/config>, or 162Configuration for the server, loaded from C</etc/crossfire/config>, or
122from wherever your confdir points to. 163from wherever your confdir points to.
123 164
124=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 165=item cf::wait_for_tick, cf::wait_for_tick_begin
125 166
126These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 167These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
127or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 168returns directly I<after> the tick processing (and consequently, can only wake one process
128processing has been done. Call C<< ->wait >> on them to maximise the 169per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
129window of cpu time available, or simply to synchronise to the server tick.
130 170
131=back 171=back
132 172
133=cut 173=cut
134 174
135BEGIN { 175BEGIN {
136 *CORE::GLOBAL::warn = sub { 176 *CORE::GLOBAL::warn = sub {
137 my $msg = join "", @_; 177 my $msg = join "", @_;
138 utf8::encode $msg;
139 178
140 $msg .= "\n" 179 $msg .= "\n"
141 unless $msg =~ /\n$/; 180 unless $msg =~ /\n$/;
142 181
182 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
183
184 utf8::encode $msg;
143 LOG llevError, $msg; 185 LOG llevError, $msg;
144 }; 186 };
145} 187}
146 188
147@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 189@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
148@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 190@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
149@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 191@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
150@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 192@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
151@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 193@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
194@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
152@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 195@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
153 196
154# we bless all objects into (empty) derived classes to force a method lookup 197# we bless all objects into (empty) derived classes to force a method lookup
155# within the Safe compartment. 198# within the Safe compartment.
156for my $pkg (qw( 199for my $pkg (qw(
157 cf::global cf::attachable 200 cf::global cf::attachable
165} 208}
166 209
167$Event::DIED = sub { 210$Event::DIED = sub {
168 warn "error in event callback: @_"; 211 warn "error in event callback: @_";
169}; 212};
213
214#############################################################################
170 215
171=head2 UTILITY FUNCTIONS 216=head2 UTILITY FUNCTIONS
172 217
173=over 4 218=over 4
174 219
193 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 238 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
194 $d 239 $d
195 } || "[unable to dump $_[0]: '$@']"; 240 } || "[unable to dump $_[0]: '$@']";
196} 241}
197 242
198use JSON::Syck (); # TODO# replace by JSON::PC once working
199
200=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
201 244
202Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
203 246
204=cut
205
206sub from_json($) {
207 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
208 JSON::Syck::Load $_[0]
209}
210
211=item $json = cf::to_json $ref 247=item $json = cf::to_json $ref
212 248
213Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
214 250
215=cut 251=cut
216 252
217sub to_json($) { 253our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
218 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 254
219 JSON::Syck::Dump $_[0] 255sub to_json ($) { $json_coder->encode ($_[0]) }
220} 256sub from_json ($) { $json_coder->decode ($_[0]) }
221 257
222=item cf::lock_wait $string 258=item cf::lock_wait $string
223 259
224Wait until the given lock is available. See cf::lock_acquire. 260Wait until the given lock is available. See cf::lock_acquire.
225 261
231returned. 267returned.
232 268
233Lock names should begin with a unique identifier (for example, cf::map::find 269Lock names should begin with a unique identifier (for example, cf::map::find
234uses map_find and cf::map::load uses map_load). 270uses map_find and cf::map::load uses map_load).
235 271
272=item $locked = cf::lock_active $string
273
274Return true if the lock is currently active, i.e. somebody has locked it.
275
236=cut 276=cut
237 277
238our %LOCK; 278our %LOCK;
239 279
240sub lock_wait($) { 280sub lock_wait($) {
259 # wake up all waiters, to be on the safe side 299 # wake up all waiters, to be on the safe side
260 $_->ready for @{ delete $LOCK{$key} }; 300 $_->ready for @{ delete $LOCK{$key} };
261 } 301 }
262} 302}
263 303
304sub lock_active($) {
305 my ($key) = @_;
306
307 ! ! $LOCK{$key}
308}
309
264sub freeze_mainloop { 310sub freeze_mainloop {
265 return unless $TICK_WATCHER->is_active; 311 return unless $TICK_WATCHER->is_active;
266 312
267 my $guard = Coro::guard { 313 my $guard = Coro::guard {
268 $TICK_WATCHER->start; 314 $TICK_WATCHER->start;
269 $WRITE_RUNTIME_WATCHER->start;
270 }; 315 };
271 $WRITE_RUNTIME_WATCHER->stop;
272 $TICK_WATCHER->stop; 316 $TICK_WATCHER->stop;
273 $guard 317 $guard
274} 318}
275 319
276=item cf::async { BLOCK } 320=item cf::async { BLOCK }
283 327
284BEGIN { *async = \&Coro::async_pool } 328BEGIN { *async = \&Coro::async_pool }
285 329
286=item cf::sync_job { BLOCK } 330=item cf::sync_job { BLOCK }
287 331
288The design of crossfire+ requires that the main coro ($Coro::main) is 332The design of Crossfire TRT requires that the main coroutine ($Coro::main)
289always able to handle events or runnable, as crossfire+ is only partly 333is always able to handle events or runnable, as Crossfire TRT is only
290reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 334partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
335acceptable.
291 336
292If it must be done, put the blocking parts into C<sync_job>. This will run 337If it must be done, put the blocking parts into C<sync_job>. This will run
293the given BLOCK in another coroutine while waiting for the result. The 338the given BLOCK in another coroutine while waiting for the result. The
294server will be frozen during this time, so the block should either finish 339server will be frozen during this time, so the block should either finish
295fast or be very important. 340fast or be very important.
298 343
299sub sync_job(&) { 344sub sync_job(&) {
300 my ($job) = @_; 345 my ($job) = @_;
301 346
302 if ($Coro::current == $Coro::main) { 347 if ($Coro::current == $Coro::main) {
348 my $time = Event::time;
349
303 # this is the main coro, too bad, we have to block 350 # this is the main coro, too bad, we have to block
304 # till the operation succeeds, freezing the server :/ 351 # till the operation succeeds, freezing the server :/
305 352
306 # TODO: use suspend/resume instead 353 # TODO: use suspend/resume instead
307 # (but this is cancel-safe) 354 # (but this is cancel-safe)
318 365
319 while ($busy) { 366 while ($busy) {
320 Coro::cede or Event::one_event; 367 Coro::cede or Event::one_event;
321 } 368 }
322 369
370 $time = Event::time - $time;
371
372 LOG llevError | logBacktrace, Carp::longmess "long sync job"
373 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
374
375 $tick_start += $time; # do not account sync jobs to server load
376
323 wantarray ? @res : $res[0] 377 wantarray ? @res : $res[0]
324 } else { 378 } else {
325 # we are in another coroutine, how wonderful, everything just works 379 # we are in another coroutine, how wonderful, everything just works
326 380
327 $job->() 381 $job->()
346 $EXT_CORO{$coro+0} = $coro; 400 $EXT_CORO{$coro+0} = $coro;
347 401
348 $coro 402 $coro
349} 403}
350 404
351sub write_runtime { 405=item fork_call { }, $args
352 my $runtime = cf::localdir . "/runtime";
353 406
354 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 407Executes the given code block with the given arguments in a seperate
355 or return; 408process, returning the results. Everything must be serialisable with
409Coro::Storable. May, of course, block. Note that the executed sub may
410never block itself or use any form of Event handling.
356 411
357 my $value = $cf::RUNTIME + 90 + 10; 412=cut
358 # 10 is the runtime save interval, for a monotonic clock
359 # 60 allows for the watchdog to kill the server.
360 413
361 (aio_write $fh, 0, (length $value), $value, 0) <= 0 414sub fork_call(&@) {
362 and return; 415 my ($cb, @args) = @_;
363 416
364 # always fsync - this file is important 417# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
365 aio_fsync $fh 418# or die "socketpair: $!";
366 and return; 419 pipe my $fh1, my $fh2
420 or die "pipe: $!";
367 421
422 if (my $pid = fork) {
368 close $fh 423 close $fh2;
369 or return;
370 424
371 aio_rename "$runtime~", $runtime 425 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
372 and return; 426 $res = Coro::Storable::thaw $res;
373 427
428 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
429
430 die $$res unless "ARRAY" eq ref $res;
431
432 return wantarray ? @$res : $res->[-1];
433 } else {
434 reset_signals;
435 local $SIG{__WARN__};
436 local $SIG{__DIE__};
437 eval {
438 close $fh1;
439
440 my @res = eval { $cb->(@args) };
441 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
442 };
443
444 warn $@ if $@;
445 _exit 0;
374 1 446 }
447}
448
449=item $value = cf::db_get $family => $key
450
451Returns a single value from the environment database.
452
453=item cf::db_put $family => $key => $value
454
455Stores the given C<$value> in the family. It can currently store binary
456data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
457
458=cut
459
460our $DB;
461
462sub db_init {
463 unless ($DB) {
464 $DB = BDB::db_create $DB_ENV;
465
466 cf::sync_job {
467 eval {
468 $DB->set_flags (BDB::CHKSUM);
469
470 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
471 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
472 cf::cleanup "db_open(db): $!" if $!;
473 };
474 cf::cleanup "db_open(db): $@" if $@;
475 };
476 }
477}
478
479sub db_get($$) {
480 my $key = "$_[0]/$_[1]";
481
482 cf::sync_job {
483 BDB::db_get $DB, undef, $key, my $data;
484
485 $! ? ()
486 : $data
487 }
488}
489
490sub db_put($$$) {
491 BDB::dbreq_pri 4;
492 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
493}
494
495=item cf::cache $id => [$paths...], $processversion => $process
496
497Generic caching function that returns the value of the resource $id,
498caching and regenerating as required.
499
500This function can block.
501
502=cut
503
504sub cache {
505 my ($id, $src, $processversion, $process) = @_;
506
507 my $meta =
508 join "\x00",
509 $processversion,
510 map {
511 aio_stat $_
512 and Carp::croak "$_: $!";
513
514 ($_, (stat _)[7,9])
515 } @$src;
516
517 my $dbmeta = db_get cache => "$id/meta";
518 if ($dbmeta ne $meta) {
519 # changed, we may need to process
520
521 my @data;
522 my $md5;
523
524 for (0 .. $#$src) {
525 0 <= aio_load $src->[$_], $data[$_]
526 or Carp::croak "$src->[$_]: $!";
527 }
528
529 # if processing is expensive, check
530 # checksum first
531 if (1) {
532 $md5 =
533 join "\x00",
534 $processversion,
535 map {
536 Coro::cede;
537 ($src->[$_], Digest::MD5::md5_hex $data[$_])
538 } 0.. $#$src;
539
540
541 my $dbmd5 = db_get cache => "$id/md5";
542 if ($dbmd5 eq $md5) {
543 db_put cache => "$id/meta", $meta;
544
545 return db_get cache => "$id/data";
546 }
547 }
548
549 my $t1 = Time::HiRes::time;
550 my $data = $process->(\@data);
551 my $t2 = Time::HiRes::time;
552
553 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
554
555 db_put cache => "$id/data", $data;
556 db_put cache => "$id/md5" , $md5;
557 db_put cache => "$id/meta", $meta;
558
559 return $data;
560 }
561
562 db_get cache => "$id/data"
563}
564
565=item cf::datalog type => key => value, ...
566
567Log a datalog packet of the given type with the given key-value pairs.
568
569=cut
570
571sub datalog($@) {
572 my ($type, %kv) = @_;
573 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
375} 574}
376 575
377=back 576=back
378 577
379=cut 578=cut
386attach callbacks/event handlers (a collection of which is called an "attachment") 585attach callbacks/event handlers (a collection of which is called an "attachment")
387to it. All such attachable objects support the following methods. 586to it. All such attachable objects support the following methods.
388 587
389In the following description, CLASS can be any of C<global>, C<object> 588In the following description, CLASS can be any of C<global>, C<object>
390C<player>, C<client> or C<map> (i.e. the attachable objects in 589C<player>, C<client> or C<map> (i.e. the attachable objects in
391crossfire+). 590Crossfire TRT).
392 591
393=over 4 592=over 4
394 593
395=item $attachable->attach ($attachment, key => $value...) 594=item $attachable->attach ($attachment, key => $value...)
396 595
559 $registry = $CB_TYPE[$object_type] ||= []; 758 $registry = $CB_TYPE[$object_type] ||= [];
560 759
561 } elsif ($type eq "subtype") { 760 } elsif ($type eq "subtype") {
562 defined $object_type or Carp::croak "subtype specified without type"; 761 defined $object_type or Carp::croak "subtype specified without type";
563 my $object_subtype = shift @arg; 762 my $object_subtype = shift @arg;
564 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 763 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
565 764
566 } elsif ($type eq "package") { 765 } elsif ($type eq "package") {
567 my $pkg = shift @arg; 766 my $pkg = shift @arg;
568 767
569 while (my ($name, $id) = each %cb_id) { 768 while (my ($name, $id) = each %cb_id) {
598 _attach $registry, $klass, @attach; 797 _attach $registry, $klass, @attach;
599 } 798 }
600 799
601 $obj->{$name} = \%arg; 800 $obj->{$name} = \%arg;
602 } else { 801 } else {
603 warn "object uses attachment '$name' that is not available, postponing.\n"; 802 warn "object uses attachment '$name' which is not available, postponing.\n";
604 } 803 }
605 804
606 $obj->{_attachment}{$name} = undef; 805 $obj->{_attachment}{$name} = undef;
607} 806}
608 807
610 if (ref $_[0]) { 809 if (ref $_[0]) {
611 _object_attach @_; 810 _object_attach @_;
612 } else { 811 } else {
613 _attach shift->_attach_registry, @_; 812 _attach shift->_attach_registry, @_;
614 } 813 }
814 _recalc_want;
615}; 815};
616 816
617# all those should be optimised 817# all those should be optimised
618sub cf::attachable::detach { 818sub cf::attachable::detach {
619 my ($obj, $name) = @_; 819 my ($obj, $name) = @_;
622 delete $obj->{_attachment}{$name}; 822 delete $obj->{_attachment}{$name};
623 reattach ($obj); 823 reattach ($obj);
624 } else { 824 } else {
625 Carp::croak "cannot, currently, detach class attachments"; 825 Carp::croak "cannot, currently, detach class attachments";
626 } 826 }
827 _recalc_want;
627}; 828};
628 829
629sub cf::attachable::attached { 830sub cf::attachable::attached {
630 my ($obj, $name) = @_; 831 my ($obj, $name) = @_;
631 832
778 } 979 }
779 } else { 980 } else {
780 aio_unlink $filename; 981 aio_unlink $filename;
781 aio_unlink "$filename.pst"; 982 aio_unlink "$filename.pst";
782 } 983 }
783
784 #d##TODO# nuke non .map-files if exist
785 if ($filename =~ s/\.map$//) {
786 aio_unlink $filename;
787 aio_unlink "$filename.pst";
788 }
789 } 984 }
790} 985}
791 986
792sub object_freezer_as_string { 987sub object_freezer_as_string {
793 my ($rdata, $objs) = @_; 988 my ($rdata, $objs) = @_;
799 994
800sub object_thawer_load { 995sub object_thawer_load {
801 my ($filename) = @_; 996 my ($filename) = @_;
802 997
803 my ($data, $av); 998 my ($data, $av);
804
805 #d#TODO remove .map if file does not exist
806 aio_stat $filename and $filename =~ s/\.map$//;
807 999
808 (aio_load $filename, $data) >= 0 1000 (aio_load $filename, $data) >= 0
809 or return; 1001 or return;
810 1002
811 unless (aio_stat "$filename.pst") { 1003 unless (aio_stat "$filename.pst") {
813 or return; 1005 or return;
814 $av = eval { (Storable::thaw $av)->{objs} }; 1006 $av = eval { (Storable::thaw $av)->{objs} };
815 } 1007 }
816 1008
817 warn sprintf "loading %s (%d)\n", 1009 warn sprintf "loading %s (%d)\n",
818 $filename, length $data, scalar @{$av || []};#d# 1010 $filename, length $data, scalar @{$av || []};
819 return ($data, $av); 1011 return ($data, $av);
820} 1012}
1013
1014=head2 COMMAND CALLBACKS
1015
1016=over 4
1017
1018=cut
821 1019
822############################################################################# 1020#############################################################################
823# command handling &c 1021# command handling &c
824 1022
825=item cf::register_command $name => \&callback($ob,$args); 1023=item cf::register_command $name => \&callback($ob,$args);
838 push @{ $COMMAND{$name} }, [$caller, $cb]; 1036 push @{ $COMMAND{$name} }, [$caller, $cb];
839} 1037}
840 1038
841=item cf::register_extcmd $name => \&callback($pl,$packet); 1039=item cf::register_extcmd $name => \&callback($pl,$packet);
842 1040
843Register a callbackf ro execution when the client sends an extcmd packet. 1041Register a callback for execution when the client sends an (synchronous)
1042extcmd packet. Ext commands will be processed in the order they are
1043received by the server, like other user commands. The first argument is
1044the logged-in player. Ext commands can only be processed after a player
1045has logged in successfully.
844 1046
845If the callback returns something, it is sent back as if reply was being 1047If the callback returns something, it is sent back as if reply was being
846called. 1048called.
847 1049
1050=item cf::register_exticmd $name => \&callback($ns,$packet);
1051
1052Register a callback for execution when the client sends an (asynchronous)
1053exticmd packet. Exti commands are processed by the server as soon as they
1054are received, i.e. out of order w.r.t. other commands. The first argument
1055is a client socket. Exti commands can be received anytime, even before
1056log-in.
1057
1058If the callback returns something, it is sent back as if reply was being
1059called.
1060
848=cut 1061=cut
849 1062
850sub register_extcmd { 1063sub register_extcmd {
851 my ($name, $cb) = @_; 1064 my ($name, $cb) = @_;
852 1065
853 $EXTCMD{$name} = $cb; 1066 $EXTCMD{$name} = $cb;
1067}
1068
1069sub register_exticmd {
1070 my ($name, $cb) = @_;
1071
1072 $EXTICMD{$name} = $cb;
854} 1073}
855 1074
856cf::player->attach ( 1075cf::player->attach (
857 on_command => sub { 1076 on_command => sub {
858 my ($pl, $name, $params) = @_; 1077 my ($pl, $name, $params) = @_;
867 cf::override; 1086 cf::override;
868 }, 1087 },
869 on_extcmd => sub { 1088 on_extcmd => sub {
870 my ($pl, $buf) = @_; 1089 my ($pl, $buf) = @_;
871 1090
872 my $msg = eval { from_json $buf }; 1091 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873 1092
874 if (ref $msg) { 1093 if (ref $msg) {
875 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1094 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
876 if (my %reply = $cb->($pl, $msg)) { 1095 if (my %reply = $cb->($pl, $msg)) {
877 $pl->ext_reply ($msg->{msgid}, %reply); 1096 $pl->ext_reply ($msg->{msgid}, %reply);
883 1102
884 cf::override; 1103 cf::override;
885 }, 1104 },
886); 1105);
887 1106
888sub load_extension {
889 my ($path) = @_;
890
891 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
892 my $base = $1;
893 my $pkg = $1;
894 $pkg =~ s/[^[:word:]]/_/g;
895 $pkg = "ext::$pkg";
896
897 warn "... loading '$path' into '$pkg'\n";
898
899 open my $fh, "<:utf8", $path
900 or die "$path: $!";
901
902 my $source =
903 "package $pkg; use strict; use utf8;\n"
904 . "#line 1 \"$path\"\n{\n"
905 . (do { local $/; <$fh> })
906 . "\n};\n1";
907
908 unless (eval $source) {
909 my $msg = $@ ? "$path: $@\n"
910 : "extension disabled.\n";
911 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912 warn $@;
913 warn "mandatory extension failed to load, exiting.\n";
914 exit 1;
915 }
916 die $@;
917 }
918
919 push @EXTS, $pkg;
920}
921
922sub load_extensions { 1107sub load_extensions {
1108 cf::sync_job {
1109 my %todo;
1110
923 for my $ext (<$LIBDIR/*.ext>) { 1111 for my $path (<$LIBDIR/*.ext>) {
924 next unless -r $ext; 1112 next unless -r $path;
925 eval { 1113
926 load_extension $ext; 1114 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1115 my $base = $1;
1116 my $pkg = $1;
1117 $pkg =~ s/[^[:word:]]/_/g;
1118 $pkg = "ext::$pkg";
1119
1120 open my $fh, "<:utf8", $path
1121 or die "$path: $!";
1122
1123 my $source = do { local $/; <$fh> };
1124
1125 my %ext = (
1126 path => $path,
1127 base => $base,
1128 pkg => $pkg,
1129 );
1130
1131 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1132 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1133
1134 $ext{source} =
1135 "package $pkg; use strict; use utf8;\n"
1136 . "#line 1 \"$path\"\n{\n"
1137 . $source
1138 . "\n};\n1";
1139
1140 $todo{$base} = \%ext;
1141 }
1142
1143 my %done;
1144 while (%todo) {
1145 my $progress;
1146
1147 while (my ($k, $v) = each %todo) {
1148 for (split /,\s*/, $v->{meta}{depends}) {
1149 goto skip
1150 unless exists $done{$_};
1151 }
1152
1153 warn "... loading '$k' into '$v->{pkg}'\n";
1154
1155 unless (eval $v->{source}) {
1156 my $msg = $@ ? "$v->{path}: $@\n"
1157 : "$v->{base}: extension inactive.\n";
1158
1159 if (exists $v->{meta}{mandatory}) {
1160 warn $msg;
1161 warn "mandatory extension failed to load, exiting.\n";
1162 exit 1;
1163 }
1164
1165 warn $msg;
1166 }
1167
1168 $done{$k} = delete $todo{$k};
1169 push @EXTS, $v->{pkg};
1170 $progress = 1;
927 1 1171 }
928 } or warn "$ext not loaded: $@"; 1172
1173 skip:
1174 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1175 unless $progress;
1176 }
929 } 1177 };
930} 1178}
931 1179
932############################################################################# 1180#############################################################################
933 1181
1182=back
1183
934=head2 CORE EXTENSIONS 1184=head2 CORE EXTENSIONS
935 1185
936Functions and methods that extend core crossfire objects. 1186Functions and methods that extend core crossfire objects.
937 1187
938=cut 1188=cut
950Returns the given player object, loading it if necessary (might block). 1200Returns the given player object, loading it if necessary (might block).
951 1201
952=cut 1202=cut
953 1203
954sub playerdir($) { 1204sub playerdir($) {
955 cf::localdir 1205 "$PLAYERDIR/"
956 . "/"
957 . cf::playerdir
958 . "/"
959 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1206 . (ref $_[0] ? $_[0]->ob->name : $_[0])
960} 1207}
961 1208
962sub path($) { 1209sub path($) {
963 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1210 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964 1211
965 (playerdir $login) . "/$login.pl" 1212 (playerdir $login) . "/playerdata"
966} 1213}
967 1214
968sub find_active($) { 1215sub find_active($) {
969 $cf::PLAYER{$_[0]} 1216 $cf::PLAYER{$_[0]}
970 and $cf::PLAYER{$_[0]}->active 1217 and $cf::PLAYER{$_[0]}->active
983 my $login = $_[0]; 1230 my $login = $_[0];
984 1231
985 my $guard = cf::lock_acquire "user_find:$login"; 1232 my $guard = cf::lock_acquire "user_find:$login";
986 1233
987 $cf::PLAYER{$_[0]} || do { 1234 $cf::PLAYER{$_[0]} || do {
1235 # rename old playerfiles to new ones
1236 #TODO: remove when no longer required
1237 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1238 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1239 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1240 aio_unlink +(playerdir $login) . "/$login.pl";
1241
988 my $pl = load_pl path $login 1242 my $pl = load_pl path $login
989 or return; 1243 or return;
990 $cf::PLAYER{$login} = $pl 1244 $cf::PLAYER{$login} = $pl
991 } 1245 }
992 } 1246 }
1029 1283
1030=cut 1284=cut
1031 1285
1032sub quit_character { 1286sub quit_character {
1033 my ($pl) = @_; 1287 my ($pl) = @_;
1288
1289 my $name = $pl->ob->name;
1034 1290
1035 $pl->{deny_save} = 1; 1291 $pl->{deny_save} = 1;
1036 $pl->password ("*"); # this should lock out the player until we nuked the dir 1292 $pl->password ("*"); # this should lock out the player until we nuked the dir
1037 1293
1038 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1294 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1043 my $path = playerdir $pl; 1299 my $path = playerdir $pl;
1044 my $temp = "$path~$cf::RUNTIME~deleting~"; 1300 my $temp = "$path~$cf::RUNTIME~deleting~";
1045 aio_rename $path, $temp; 1301 aio_rename $path, $temp;
1046 delete $cf::PLAYER{$pl->ob->name}; 1302 delete $cf::PLAYER{$pl->ob->name};
1047 $pl->destroy; 1303 $pl->destroy;
1304
1305 my $prefix = qr<^~\Q$name\E/>;
1306
1307 # nuke player maps
1308 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1309
1048 IO::AIO::aio_rmtree $temp; 1310 IO::AIO::aio_rmtree $temp;
1311}
1312
1313=item $pl->kick
1314
1315Kicks a player out of the game. This destroys the connection.
1316
1317=cut
1318
1319sub kick {
1320 my ($pl, $kicker) = @_;
1321
1322 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1323 $pl->killer ("kicked");
1324 $pl->ns->destroy;
1049} 1325}
1050 1326
1051=item cf::player::list_logins 1327=item cf::player::list_logins
1052 1328
1053Returns am arrayref of all valid playernames in the system, can take a 1329Returns am arrayref of all valid playernames in the system, can take a
1054while and may block, so not sync_job-capable, ever. 1330while and may block, so not sync_job-capable, ever.
1055 1331
1056=cut 1332=cut
1057 1333
1058sub list_logins { 1334sub list_logins {
1059 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1335 my $dirs = aio_readdir $PLAYERDIR
1060 or return []; 1336 or return [];
1061 1337
1062 my @logins; 1338 my @logins;
1063 1339
1064 for my $login (@$dirs) { 1340 for my $login (@$dirs) {
1099 } 1375 }
1100 1376
1101 \@paths 1377 \@paths
1102} 1378}
1103 1379
1380=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1381
1382Expand crossfire pod fragments into protocol xml.
1383
1384=cut
1385
1386sub expand_cfpod {
1387 ((my $self), (local $_)) = @_;
1388
1389 # escape & and <
1390 s/&/&amp;/g;
1391 s/(?<![BIUGH])</&lt;/g;
1392
1393 # this is buggy, it needs to properly take care of nested <'s
1394
1395 1 while
1396 # replace B<>, I<>, U<> etc.
1397 s/B<([^\>]*)>/<b>$1<\/b>/
1398 || s/I<([^\>]*)>/<i>$1<\/i>/
1399 || s/U<([^\>]*)>/<u>$1<\/u>/
1400 # replace G<male|female> tags
1401 || s{G<([^>|]*)\|([^>]*)>}{
1402 $self->gender ? $2 : $1
1403 }ge
1404 # replace H<hint text>
1405 || s{H<([^\>]*)>}
1406 {
1407 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1408 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1409 "")
1410 [$self->{hintmode}]
1411 }ge;
1412
1413 # create single paragraphs (very hackish)
1414 s/(?<=\S)\n(?=\w)/ /g;
1415
1416 # compress some whitespace
1417 1 while s/\s*\n\s*\n\s*/\n/;
1418
1419 $_
1420}
1421
1422sub hintmode {
1423 warn "hm<$_[0] $_[1]>\n";#d#
1424 $_[0]{hintmode} = $_[1] if @_ > 1;
1425 $_[0]{hintmode}
1426}
1427
1104=item $player->ext_reply ($msgid, $msgtype, %msg) 1428=item $player->ext_reply ($msgid, %msg)
1105 1429
1106Sends an ext reply to the player. 1430Sends an ext reply to the player.
1107 1431
1108=cut 1432=cut
1109 1433
1110sub ext_reply($$$%) { 1434sub ext_reply($$%) {
1111 my ($self, $id, %msg) = @_; 1435 my ($self, $id, %msg) = @_;
1112 1436
1113 $msg{msgid} = $id; 1437 $msg{msgid} = $id;
1114 1438 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1115 $self->send ("ext " . cf::to_json \%msg);
1116} 1439}
1117 1440
1118package cf; 1441=item $player->ext_event ($type, %msg)
1442
1443Sends an ext event to the client.
1444
1445=cut
1446
1447sub ext_event($$%) {
1448 my ($self, $type, %msg) = @_;
1449
1450 $self->ns->ext_event ($type, %msg);
1451}
1452
1453=head3 cf::region
1454
1455=over 4
1456
1457=cut
1458
1459package cf::region;
1460
1461=item cf::region::find_by_path $path
1462
1463Tries to decuce the likely region for a map knowing only its path.
1464
1465=cut
1466
1467sub find_by_path($) {
1468 my ($path) = @_;
1469
1470 my ($match, $specificity);
1471
1472 for my $region (list) {
1473 if ($region->match && $path =~ $region->match) {
1474 ($match, $specificity) = ($region, $region->specificity)
1475 if $region->specificity > $specificity;
1476 }
1477 }
1478
1479 $match
1480}
1119 1481
1120=back 1482=back
1121
1122 1483
1123=head3 cf::map 1484=head3 cf::map
1124 1485
1125=over 4 1486=over 4
1126 1487
1181 my ($self, $merge) = @_; 1542 my ($self, $merge) = @_;
1182 1543
1183 # we have to keep some variables in memory intact 1544 # we have to keep some variables in memory intact
1184 local $self->{path}; 1545 local $self->{path};
1185 local $self->{load_path}; 1546 local $self->{load_path};
1186 local $self->{deny_save};
1187 local $self->{deny_reset};
1188 1547
1189 $self->SUPER::thawer_merge ($merge); 1548 $self->SUPER::thawer_merge ($merge);
1190} 1549}
1191 1550
1192sub normalise { 1551sub normalise {
1264 1623
1265# the original (read-only) location 1624# the original (read-only) location
1266sub load_path { 1625sub load_path {
1267 my ($self) = @_; 1626 my ($self) = @_;
1268 1627
1269 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1628 "$MAPDIR/$self->{path}.map"
1270} 1629}
1271 1630
1272# the temporary/swap location 1631# the temporary/swap location
1273sub save_path { 1632sub save_path {
1274 my ($self) = @_; 1633 my ($self) = @_;
1275 1634
1276 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1635 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1277 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1636 "$TMPDIR/$path.map"
1278} 1637}
1279 1638
1280# the unique path, undef == no special unique path 1639# the unique path, undef == no special unique path
1281sub uniq_path { 1640sub uniq_path {
1282 my ($self) = @_; 1641 my ($self) = @_;
1283 1642
1284 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1643 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1285 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1644 "$UNIQUEDIR/$path"
1286} 1645}
1287 1646
1288# and all this just because we cannot iterate over 1647# and all this just because we cannot iterate over
1289# all maps in C++... 1648# all maps in C++...
1290sub change_all_map_light { 1649sub change_all_map_light {
1292 1651
1293 $_->change_map_light ($change) 1652 $_->change_map_light ($change)
1294 for grep $_->outdoor, values %cf::MAP; 1653 for grep $_->outdoor, values %cf::MAP;
1295} 1654}
1296 1655
1656sub decay_objects {
1657 my ($self) = @_;
1658
1659 return if $self->{deny_reset};
1660
1661 $self->do_decay_objects;
1662}
1663
1297sub unlink_save { 1664sub unlink_save {
1298 my ($self) = @_; 1665 my ($self) = @_;
1299 1666
1300 utf8::encode (my $save = $self->save_path); 1667 utf8::encode (my $save = $self->save_path);
1301 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1668 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1302 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1669 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1303
1304 #d#TODO remove .map and also nuke
1305 $save =~ s/\.map// or return;#d#
1306 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1307 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1308} 1670}
1309 1671
1310sub load_header_from($) { 1672sub load_header_from($) {
1311 my ($self, $path) = @_; 1673 my ($self, $path) = @_;
1312 1674
1362 $self->load_header_orig 1724 $self->load_header_orig
1363 or return; 1725 or return;
1364 $self->prepare_orig; 1726 $self->prepare_orig;
1365 } 1727 }
1366 1728
1729 $self->{deny_reset} = 1
1730 if $self->no_reset;
1731
1732 $self->default_region (cf::region::find_by_path $self->{path})
1733 unless $self->default_region;
1734
1367 1 1735 1
1368} 1736}
1369 1737
1370sub find; 1738sub find;
1371sub find { 1739sub find {
1383 $map->{last_save} = $cf::RUNTIME; 1751 $map->{last_save} = $cf::RUNTIME;
1384 1752
1385 $map->load_header 1753 $map->load_header
1386 or return; 1754 or return;
1387 1755
1388 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1756 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1389 # doing this can freeze the server in a sync job, obviously 1757 # doing this can freeze the server in a sync job, obviously
1390 #$cf::WAIT_FOR_TICK->wait; 1758 #$cf::WAIT_FOR_TICK->wait;
1391 $map->reset; 1759 $map->reset;
1392 undef $guard; 1760 undef $guard;
1393 return find $path; 1761 return find $path;
1404 my ($self) = @_; 1772 my ($self) = @_;
1405 1773
1406 local $self->{deny_reset} = 1; # loading can take a long time 1774 local $self->{deny_reset} = 1; # loading can take a long time
1407 1775
1408 my $path = $self->{path}; 1776 my $path = $self->{path};
1777
1778 {
1409 my $guard = cf::lock_acquire "map_load:$path"; 1779 my $guard = cf::lock_acquire "map_load:$path";
1410 1780
1411 return if $self->in_memory != cf::MAP_SWAPPED; 1781 return if $self->in_memory != cf::MAP_SWAPPED;
1412 1782
1413 $self->in_memory (cf::MAP_LOADING); 1783 $self->in_memory (cf::MAP_LOADING);
1414 1784
1415 $self->alloc; 1785 $self->alloc;
1416 1786
1417 $self->pre_load; 1787 $self->pre_load;
1418
1419 $self->_load_objects ($self->{load_path}, 1)
1420 or return;
1421
1422 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1423 if delete $self->{load_original};
1424
1425 if (my $uniq = $self->uniq_path) {
1426 utf8::encode $uniq;
1427 if (aio_open $uniq, O_RDONLY, 0) {
1428 $self->clear_unique_items;
1429 $self->_load_objects ($uniq, 0);
1430 }
1431 }
1432
1433 Coro::cede;
1434
1435 # now do the right thing for maps
1436 $self->link_multipart_objects;
1437
1438 unless ($self->{deny_activate}) {
1439 $self->decay_objects;
1440 $self->fix_auto_apply;
1441 $self->update_buttons;
1442 Coro::cede; 1788 Coro::cede;
1443 $self->set_darkness_map; 1789
1790 $self->_load_objects ($self->{load_path}, 1)
1791 or return;
1792
1793 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1794 if delete $self->{load_original};
1795
1796 if (my $uniq = $self->uniq_path) {
1797 utf8::encode $uniq;
1798 if (aio_open $uniq, O_RDONLY, 0) {
1799 $self->clear_unique_items;
1800 $self->_load_objects ($uniq, 0);
1801 }
1802 }
1803
1804 Coro::cede;
1805 # now do the right thing for maps
1806 $self->link_multipart_objects;
1444 $self->difficulty ($self->estimate_difficulty) 1807 $self->difficulty ($self->estimate_difficulty)
1445 unless $self->difficulty; 1808 unless $self->difficulty;
1446 Coro::cede; 1809 Coro::cede;
1810
1811 unless ($self->{deny_activate}) {
1812 $self->decay_objects;
1813 $self->fix_auto_apply;
1814 $self->update_buttons;
1815 Coro::cede;
1816 $self->set_darkness_map;
1817 Coro::cede;
1447 $self->activate; 1818 $self->activate;
1819 }
1820
1821 $self->in_memory (cf::MAP_IN_MEMORY);
1448 } 1822 }
1449 1823
1450 $self->post_load; 1824 $self->post_load;
1451
1452 $self->in_memory (cf::MAP_IN_MEMORY);
1453} 1825}
1454 1826
1455sub customise_for { 1827sub customise_for {
1456 my ($self, $ob) = @_; 1828 my ($self, $ob) = @_;
1457 1829
1458 return find "~" . $ob->name . "/" . $self->{path} 1830 return find "~" . $ob->name . "/" . $self->{path}
1459 if $self->per_player; 1831 if $self->per_player;
1832
1833# return find "?party/" . $ob->name . "/" . $self->{path}
1834# if $self->per_party;
1460 1835
1461 $self 1836 $self
1462} 1837}
1463 1838
1464# find and load all maps in the 3x3 area around a map 1839# find and load all maps in the 3x3 area around a map
1575 1950
1576sub reset_at { 1951sub reset_at {
1577 my ($self) = @_; 1952 my ($self) = @_;
1578 1953
1579 # TODO: safety, remove and allow resettable per-player maps 1954 # TODO: safety, remove and allow resettable per-player maps
1580 return 1e99 if $self->isa ("ext::map_per_player");#d#
1581 return 1e99 if $self->{deny_reset}; 1955 return 1e99 if $self->{deny_reset};
1582 1956
1583 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1957 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1584 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1958 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1585 1959
1596 my ($self) = @_; 1970 my ($self) = @_;
1597 1971
1598 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1972 my $lock = cf::lock_acquire "map_data:$self->{path}";
1599 1973
1600 return if $self->players; 1974 return if $self->players;
1601 return if $self->isa ("ext::map_per_player");#d#
1602 1975
1603 warn "resetting map ", $self->path;#d# 1976 warn "resetting map ", $self->path;
1977
1978 $self->in_memory (cf::MAP_SWAPPED);
1979
1980 # need to save uniques path
1981 unless ($self->{deny_save}) {
1982 my $uniq = $self->uniq_path; utf8::encode $uniq;
1983
1984 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1985 if $uniq;
1986 }
1604 1987
1605 delete $cf::MAP{$self->path}; 1988 delete $cf::MAP{$self->path};
1606 1989
1607 $self->in_memory (cf::MAP_SWAPPED);
1608 $self->clear; 1990 $self->clear;
1609 1991
1610 $_->clear_links_to ($self) for values %cf::MAP; 1992 $_->clear_links_to ($self) for values %cf::MAP;
1611 1993
1612 $self->unlink_save; 1994 $self->unlink_save;
1631 $cf::MAP{$self->path} = $self; 2013 $cf::MAP{$self->path} = $self;
1632 2014
1633 $self->reset; # polite request, might not happen 2015 $self->reset; # polite request, might not happen
1634} 2016}
1635 2017
2018=item $maps = cf::map::tmp_maps
2019
2020Returns an arrayref with all map paths of currently instantiated and saved
2021maps. May block.
2022
2023=cut
2024
2025sub tmp_maps() {
2026 [
2027 map {
2028 utf8::decode $_;
2029 /\.map$/
2030 ? normalise $_
2031 : ()
2032 } @{ aio_readdir $TMPDIR or [] }
2033 ]
2034}
2035
2036=item $maps = cf::map::random_maps
2037
2038Returns an arrayref with all map paths of currently instantiated and saved
2039random maps. May block.
2040
2041=cut
2042
2043sub random_maps() {
2044 [
2045 map {
2046 utf8::decode $_;
2047 /\.map$/
2048 ? normalise "?random/$_"
2049 : ()
2050 } @{ aio_readdir $RANDOMDIR or [] }
2051 ]
2052}
2053
1636=item cf::map::unique_maps 2054=item cf::map::unique_maps
1637 2055
1638Returns an arrayref of paths of all shared maps that have 2056Returns an arrayref of paths of all shared maps that have
1639instantiated unique items. May block. 2057instantiated unique items. May block.
1640 2058
1641=cut 2059=cut
1642 2060
1643sub unique_maps() { 2061sub unique_maps() {
1644 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2062 [
1645 or return; 2063 map {
1646
1647 my @paths;
1648
1649 for (@$files) {
1650 utf8::decode $_; 2064 utf8::decode $_;
1651 next if /\.pst$/; 2065 /\.map$/
1652 next unless /^$PATH_SEP/o; 2066 ? normalise $_
1653 2067 : ()
1654 push @paths, cf::map::normalise $_; 2068 } @{ aio_readdir $UNIQUEDIR or [] }
1655 } 2069 ]
1656
1657 \@paths
1658} 2070}
1659 2071
1660package cf; 2072package cf;
1661 2073
1662=back 2074=back
1708 2120
1709 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2121 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1710 2122
1711 if ($self->{record_replies}) { 2123 if ($self->{record_replies}) {
1712 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2124 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2125
1713 } else { 2126 } else {
2127 my $pl = $self->contr;
2128
2129 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2130 my $diag = $pl->{npc_dialog};
2131 $diag->{pl}->ext_reply (
2132 $diag->{id},
2133 msgtype => "reply",
2134 msg => $diag->{pl}->expand_cfpod ($msg),
2135 add_topics => []
2136 );
2137
2138 } else {
1714 $msg = $npc->name . " says: $msg" if $npc; 2139 $msg = $npc->name . " says: $msg" if $npc;
1715 $self->message ($msg, $flags); 2140 $self->message ($msg, $flags);
2141 }
1716 } 2142 }
1717} 2143}
1718 2144
1719=item $player_object->may ("access") 2145=item $player_object->may ("access")
1720 2146
1768 $self->deactivate_recursive; 2194 $self->deactivate_recursive;
1769 2195
1770 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2196 return if UNIVERSAL::isa $self->map, "ext::map_link";
1771 2197
1772 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2198 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1773 if $self->map; 2199 if $self->map && $self->map->{path} ne "{link}";
1774 2200
1775 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2201 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1776} 2202}
1777 2203
1778sub cf::object::player::leave_link { 2204sub cf::object::player::leave_link {
1779 my ($self, $map, $x, $y) = @_; 2205 my ($self, $map, $x, $y) = @_;
2206
2207 return unless $self->contr->active;
1780 2208
1781 my $link_pos = delete $self->{_link_pos}; 2209 my $link_pos = delete $self->{_link_pos};
1782 2210
1783 unless ($map) { 2211 unless ($map) {
1784 # restore original map position 2212 # restore original map position
1802 $map->load; 2230 $map->load;
1803 $map->load_diag; 2231 $map->load_diag;
1804 2232
1805 return unless $self->contr->active; 2233 return unless $self->contr->active;
1806 $self->activate_recursive; 2234 $self->activate_recursive;
2235
2236 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1807 $self->enter_map ($map, $x, $y); 2237 $self->enter_map ($map, $x, $y);
1808} 2238}
1809 2239
1810cf::player->attach (
1811 on_logout => sub {
1812 my ($pl) = @_;
1813
1814 # abort map switching before logout
1815 if ($pl->ob->{_link_pos}) {
1816 cf::sync_job {
1817 $pl->ob->leave_link
1818 };
1819 }
1820 },
1821 on_login => sub {
1822 my ($pl) = @_;
1823
1824 # try to abort aborted map switching on player login :)
1825 # should happen only on crashes
1826 if ($pl->ob->{_link_pos}) {
1827 $pl->ob->enter_link;
1828 (async {
1829 # we need this sleep as the login has a concurrent enter_exit running
1830 # and this sleep increases chances of the player not ending up in scorn
1831 $pl->ob->reply (undef,
1832 "There was an internal problem at your last logout, "
1833 . "the server will try to bring you to your intended destination in a second.",
1834 cf::NDI_RED);
1835 Coro::Timer::sleep 1;
1836 $pl->ob->leave_link;
1837 })->prio (2);
1838 }
1839 },
1840);
1841
1842=item $player_object->goto ($path, $x, $y) 2240=item $player_object->goto ($path, $x, $y[, $check->($map)])
1843 2241
2242Moves the player to the given map-path and coordinates by first freezing
2243her, loading and preparing them map, calling the provided $check callback
2244that has to return the map if sucecssful, and then unfreezes the player on
2245the new (success) or old (failed) map position.
2246
1844=cut 2247=cut
2248
2249our $GOTOGEN;
1845 2250
1846sub cf::object::player::goto { 2251sub cf::object::player::goto {
1847 my ($self, $path, $x, $y) = @_; 2252 my ($self, $path, $x, $y, $check) = @_;
2253
2254 # do generation counting so two concurrent goto's will be executed in-order
2255 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1848 2256
1849 $self->enter_link; 2257 $self->enter_link;
1850 2258
1851 (async { 2259 (async {
1852 my $map = eval { 2260 my $map = eval {
1853 my $map = cf::map::find $path; 2261 my $map = cf::map::find $path;
2262
2263 if ($map) {
1854 $map = $map->customise_for ($self) if $map; 2264 $map = $map->customise_for ($self);
2265 $map = $check->($map) if $check && $map;
2266 } else {
2267 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2268 }
2269
1855 $map 2270 $map
2271 };
2272
2273 if ($@) {
2274 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2275 LOG llevError | logBacktrace, Carp::longmess $@;
1856 } or 2276 }
1857 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1858 2277
2278 if ($gen == $self->{_goto_generation}) {
2279 delete $self->{_goto_generation};
1859 $self->leave_link ($map, $x, $y); 2280 $self->leave_link ($map, $x, $y);
2281 }
1860 })->prio (1); 2282 })->prio (1);
1861} 2283}
1862 2284
1863=item $player_object->enter_exit ($exit_object) 2285=item $player_object->enter_exit ($exit_object)
1864 2286
1903 2325
1904 $rmp->{random_seed} ||= $exit->random_seed; 2326 $rmp->{random_seed} ||= $exit->random_seed;
1905 2327
1906 my $data = cf::to_json $rmp; 2328 my $data = cf::to_json $rmp;
1907 my $md5 = Digest::MD5::md5_hex $data; 2329 my $md5 = Digest::MD5::md5_hex $data;
1908 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2330 my $meta = "$RANDOMDIR/$md5.meta";
1909 2331
1910 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2332 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1911 aio_write $fh, 0, (length $data), $data, 0; 2333 aio_write $fh, 0, (length $data), $data, 0;
1912 undef $fh; 2334 undef $fh;
1913 aio_rename "$meta~", $meta; 2335 aio_rename "$meta~", $meta;
1922 2344
1923 return unless $self->type == cf::PLAYER; 2345 return unless $self->type == cf::PLAYER;
1924 2346
1925 if ($exit->slaying eq "/!") { 2347 if ($exit->slaying eq "/!") {
1926 #TODO: this should de-fi-ni-te-ly not be a sync-job 2348 #TODO: this should de-fi-ni-te-ly not be a sync-job
2349 # the problem is that $exit might not survive long enough
2350 # so it needs to be done right now, right here
1927 cf::sync_job { prepare_random_map $exit }; 2351 cf::sync_job { prepare_random_map $exit };
1928 } 2352 }
1929 2353
1930 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2354 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1931 my $hp = $exit->stats->hp; 2355 my $hp = $exit->stats->hp;
1939 $self->goto ($slaying, $hp, $sp); 2363 $self->goto ($slaying, $hp, $sp);
1940 2364
1941 1; 2365 1;
1942 }) { 2366 }) {
1943 $self->message ("Something went wrong deep within the crossfire server. " 2367 $self->message ("Something went wrong deep within the crossfire server. "
1944 . "I'll try to bring you back to the map you were before. " 2368 . "I'll try to bring you back to the map you were before. "
1945 . "Please report this to the dungeon master!", 2369 . "Please report this to the dungeon master!",
1946 cf::NDI_UNIQUE | cf::NDI_RED); 2370 cf::NDI_UNIQUE | cf::NDI_RED);
1947 2371
1948 warn "ERROR in enter_exit: $@"; 2372 warn "ERROR in enter_exit: $@";
1949 $self->leave_link; 2373 $self->leave_link;
1950 } 2374 }
1951 })->prio (1); 2375 })->prio (1);
1964 2388
1965sub cf::client::send_drawinfo { 2389sub cf::client::send_drawinfo {
1966 my ($self, $text, $flags) = @_; 2390 my ($self, $text, $flags) = @_;
1967 2391
1968 utf8::encode $text; 2392 utf8::encode $text;
1969 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2393 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1970} 2394}
1971 2395
2396=item $client->send_msg ($color, $type, $msg, [extra...])
2397
2398Send a drawinfo or msg packet to the client, formatting the msg for the
2399client if neccessary. C<$type> should be a string identifying the type of
2400the message, with C<log> being the default. If C<$color> is negative, suppress
2401the message unless the client supports the msg packet.
2402
2403=cut
2404
2405sub cf::client::send_msg {
2406 my ($self, $color, $type, $msg, @extra) = @_;
2407
2408 $msg = $self->pl->expand_cfpod ($msg);
2409
2410 if ($self->can_msg) {
2411 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2412 } else {
2413 # replace some tags by gcfclient-compatible ones
2414 for ($msg) {
2415 1 while
2416 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2417 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2418 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2419 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2420 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2421 }
2422
2423 if ($color >= 0) {
2424 if (0 && $msg =~ /\[/) {
2425 $self->send_packet ("drawextinfo $color 4 0 $msg")
2426 } else {
2427 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2428 $self->send_packet ("drawinfo $color $msg")
2429 }
2430 }
2431 }
2432}
2433
2434=item $client->ext_event ($type, %msg)
2435
2436Sends an ext event to the client.
2437
2438=cut
2439
2440sub cf::client::ext_event($$%) {
2441 my ($self, $type, %msg) = @_;
2442
2443 $msg{msgtype} = "event_$type";
2444 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2445}
1972 2446
1973=item $success = $client->query ($flags, "text", \&cb) 2447=item $success = $client->query ($flags, "text", \&cb)
1974 2448
1975Queues a query to the client, calling the given callback with 2449Queues a query to the client, calling the given callback with
1976the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2450the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1977C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2451C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1978 2452
1979Queries can fail, so check the return code. Or don't, as queries will become 2453Queries can fail, so check the return code. Or don't, as queries will
1980reliable at some point in the future. 2454become reliable at some point in the future.
1981 2455
1982=cut 2456=cut
1983 2457
1984sub cf::client::query { 2458sub cf::client::query {
1985 my ($self, $flags, $text, $cb) = @_; 2459 my ($self, $flags, $text, $cb) = @_;
1993 utf8::encode $text; 2467 utf8::encode $text;
1994 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2468 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1995 2469
1996 $self->send_packet ($self->{query_queue}[0][0]) 2470 $self->send_packet ($self->{query_queue}[0][0])
1997 if @{ $self->{query_queue} } == 1; 2471 if @{ $self->{query_queue} } == 1;
2472
2473 1
1998} 2474}
1999 2475
2000cf::client->attach ( 2476cf::client->attach (
2477 on_connect => sub {
2478 my ($ns) = @_;
2479
2480 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2481 },
2001 on_reply => sub { 2482 on_reply => sub {
2002 my ($ns, $msg) = @_; 2483 my ($ns, $msg) = @_;
2003 2484
2004 # this weird shuffling is so that direct followup queries 2485 # this weird shuffling is so that direct followup queries
2005 # get handled first 2486 # get handled first
2017 } else { 2498 } else {
2018 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2499 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2019 } 2500 }
2020 } 2501 }
2021 }, 2502 },
2503 on_exticmd => sub {
2504 my ($ns, $buf) = @_;
2505
2506 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2507
2508 if (ref $msg) {
2509 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2510 if (my %reply = $cb->($ns, $msg)) {
2511 $reply{msgid} = $msg->{msgid};
2512 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2513 }
2514 }
2515 } else {
2516 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2517 }
2518
2519 cf::override;
2520 },
2022); 2521);
2023 2522
2024=item $client->async (\&cb) 2523=item $client->async (\&cb)
2025 2524
2026Create a new coroutine, running the specified callback. The coroutine will 2525Create a new coroutine, running the specified callback. The coroutine will
2073 2572
2074# here we export the classes and methods available to script code 2573# here we export the classes and methods available to script code
2075 2574
2076=pod 2575=pod
2077 2576
2078The following fucntions and emthods are available within a safe environment: 2577The following functions and methods are available within a safe environment:
2079 2578
2080 cf::object contr pay_amount pay_player map 2579 cf::object contr pay_amount pay_player map
2081 cf::object::player player 2580 cf::object::player player
2082 cf::player peaceful 2581 cf::player peaceful
2083 cf::map trigger 2582 cf::map trigger
2164=back 2663=back
2165 2664
2166=cut 2665=cut
2167 2666
2168############################################################################# 2667#############################################################################
2169
2170=head2 EXTENSION DATABASE SUPPORT
2171
2172Crossfire maintains a very simple database for extension use. It can
2173currently store anything that can be serialised using Storable, which
2174excludes objects.
2175
2176The parameter C<$family> should best start with the name of the extension
2177using it, it should be unique.
2178
2179=over 4
2180
2181=item $hashref = cf::db_get $family
2182
2183Return a hashref for use by the extension C<$family>, which can be
2184modified. After modifications, you have to call C<cf::db_dirty> or
2185C<cf::db_sync>.
2186
2187=item $value = cf::db_get $family => $key
2188
2189Returns a single value from the database
2190
2191=item cf::db_put $family => $hashref
2192
2193Stores the given family hashref into the database. Updates are delayed, if
2194you want the data to be synced to disk immediately, use C<cf::db_sync>.
2195
2196=item cf::db_put $family => $key => $value
2197
2198Stores the given C<$value> in the family hash. Updates are delayed, if you
2199want the data to be synced to disk immediately, use C<cf::db_sync>.
2200
2201=item cf::db_dirty
2202
2203Marks the database as dirty, to be updated at a later time.
2204
2205=item cf::db_sync
2206
2207Immediately write the database to disk I<if it is dirty>.
2208
2209=cut
2210
2211our $DB;
2212
2213{
2214 my $path = cf::localdir . "/database.pst";
2215
2216 sub db_load() {
2217 $DB = stat $path ? Storable::retrieve $path : { };
2218 }
2219
2220 my $pid;
2221
2222 sub db_save() {
2223 waitpid $pid, 0 if $pid;
2224 if (0 == ($pid = fork)) {
2225 $DB->{_meta}{version} = 1;
2226 Storable::nstore $DB, "$path~";
2227 rename "$path~", $path;
2228 cf::_exit 0 if defined $pid;
2229 }
2230 }
2231
2232 my $dirty;
2233
2234 sub db_sync() {
2235 db_save if $dirty;
2236 undef $dirty;
2237 }
2238
2239 my $idle = Event->idle (
2240 reentrant => 0,
2241 min => 10,
2242 max => 20,
2243 repeat => 0,
2244 data => WF_AUTOCANCEL,
2245 cb => \&db_sync,
2246 );
2247
2248 sub db_dirty() {
2249 $dirty = 1;
2250 $idle->start;
2251 }
2252
2253 sub db_get($;$) {
2254 @_ >= 2
2255 ? $DB->{$_[0]}{$_[1]}
2256 : ($DB->{$_[0]} ||= { })
2257 }
2258
2259 sub db_put($$;$) {
2260 if (@_ >= 3) {
2261 $DB->{$_[0]}{$_[1]} = $_[2];
2262 } else {
2263 $DB->{$_[0]} = $_[1];
2264 }
2265 db_dirty;
2266 }
2267
2268 cf::global->attach (
2269 prio => 10000,
2270 on_cleanup => sub {
2271 db_sync;
2272 },
2273 );
2274}
2275
2276#############################################################################
2277# the server's init and main functions 2668# the server's init and main functions
2278 2669
2279sub load_resources { 2670sub load_facedata($) {
2280 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2671 my ($path) = @_;
2672
2673 warn "loading facedata from $path\n";
2674
2675 my $facedata;
2676 0 < aio_load $path, $facedata
2677 or die "$path: $!";
2678
2679 $facedata = Coro::Storable::thaw $facedata;
2680
2681 $facedata->{version} == 2
2682 or cf::cleanup "$path: version mismatch, cannot proceed.";
2683
2684 {
2685 my $faces = $facedata->{faceinfo};
2686
2687 while (my ($face, $info) = each %$faces) {
2688 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2689 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2690 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2691 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2692 Coro::cede;
2693 }
2694
2695 while (my ($face, $info) = each %$faces) {
2696 next unless $info->{smooth};
2697 my $idx = cf::face::find $face
2698 or next;
2699 if (my $smooth = cf::face::find $info->{smooth}) {
2700 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2701 } else {
2702 warn "smooth face '$info->{smooth}' not found for face '$face'";
2703 }
2704 Coro::cede;
2705 }
2706 }
2707
2708 {
2709 my $anims = $facedata->{animinfo};
2710
2711 while (my ($anim, $info) = each %$anims) {
2712 cf::anim::set $anim, $info->{frames}, $info->{facings};
2713 Coro::cede;
2714 }
2715
2716 cf::anim::invalidate_all; # d'oh
2717 }
2718
2719 1
2720}
2721
2722sub reload_regions {
2723 load_resource_file "$MAPDIR/regions"
2281 or die "unable to load regions file\n";#d# 2724 or die "unable to load regions file\n";
2725}
2726
2727sub reload_facedata {
2728 load_facedata "$DATADIR/facedata"
2729 or die "unable to load facedata\n";
2730}
2731
2732sub reload_archetypes {
2733 load_resource_file "$DATADIR/archetypes"
2734 or die "unable to load archetypes\n";
2735 #d# NEED to laod twice to resolve forward references
2736 # this really needs to be done in an extra post-pass
2737 # (which needs to be synchronous, so solve it differently)
2738 load_resource_file "$DATADIR/archetypes"
2739 or die "unable to load archetypes\n";
2740}
2741
2742sub reload_treasures {
2743 load_resource_file "$DATADIR/treasures"
2744 or die "unable to load treasurelists\n";
2745}
2746
2747sub reload_resources {
2748 warn "reloading resource files...\n";
2749
2750 reload_regions;
2751 reload_facedata;
2752 #reload_archetypes;#d#
2753 reload_archetypes;
2754 reload_treasures;
2755
2756 warn "finished reloading resource files\n";
2757}
2758
2759sub init {
2760 reload_resources;
2282} 2761}
2283 2762
2284sub cfg_load { 2763sub cfg_load {
2285 open my $fh, "<:utf8", cf::confdir . "/config" 2764 open my $fh, "<:utf8", "$CONFDIR/config"
2286 or return; 2765 or return;
2287 2766
2288 local $/; 2767 local $/;
2289 *CFG = YAML::Syck::Load <$fh>; 2768 *CFG = YAML::Syck::Load <$fh>;
2290 2769
2298 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2777 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2299 and die "WARNING: m(un)lockall failed: $!\n"; 2778 and die "WARNING: m(un)lockall failed: $!\n";
2300 }; 2779 };
2301 warn $@ if $@; 2780 warn $@ if $@;
2302 } 2781 }
2303}
2304
2305sub init {
2306 load_resources;
2307} 2782}
2308 2783
2309sub main { 2784sub main {
2310 # we must not ever block the main coroutine 2785 # we must not ever block the main coroutine
2311 local $Coro::idle = sub { 2786 local $Coro::idle = sub {
2314 Event::one_event; 2789 Event::one_event;
2315 })->prio (Coro::PRIO_MAX); 2790 })->prio (Coro::PRIO_MAX);
2316 }; 2791 };
2317 2792
2318 cfg_load; 2793 cfg_load;
2319 db_load; 2794 db_init;
2320 load_extensions; 2795 load_extensions;
2321 2796
2322 $TICK_WATCHER->start; 2797 $TICK_WATCHER->start;
2323 Event::loop; 2798 Event::loop;
2324} 2799}
2339 }, 2814 },
2340 ); 2815 );
2341 } 2816 }
2342} 2817}
2343 2818
2819sub write_runtime {
2820 my $runtime = "$LOCALDIR/runtime";
2821
2822 # first touch the runtime file to show we are still running:
2823 # the fsync below can take a very very long time.
2824
2825 IO::AIO::aio_utime $runtime, undef, undef;
2826
2827 my $guard = cf::lock_acquire "write_runtime";
2828
2829 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2830 or return;
2831
2832 my $value = $cf::RUNTIME + 90 + 10;
2833 # 10 is the runtime save interval, for a monotonic clock
2834 # 60 allows for the watchdog to kill the server.
2835
2836 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2837 and return;
2838
2839 # always fsync - this file is important
2840 aio_fsync $fh
2841 and return;
2842
2843 # touch it again to show we are up-to-date
2844 aio_utime $fh, undef, undef;
2845
2846 close $fh
2847 or return;
2848
2849 aio_rename "$runtime~", $runtime
2850 and return;
2851
2852 warn "runtime file written.\n";
2853
2854 1
2855}
2856
2344sub emergency_save() { 2857sub emergency_save() {
2345 my $freeze_guard = cf::freeze_mainloop; 2858 my $freeze_guard = cf::freeze_mainloop;
2346 2859
2347 warn "enter emergency perl save\n"; 2860 warn "enter emergency perl save\n";
2348 2861
2363 my $map = $cf::MAP{$path} or next; 2876 my $map = $cf::MAP{$path} or next;
2364 $map->valid or next; 2877 $map->valid or next;
2365 $map->save; 2878 $map->save;
2366 } 2879 }
2367 warn "end emergency map save\n"; 2880 warn "end emergency map save\n";
2881
2882 warn "begin emergency database checkpoint\n";
2883 BDB::db_env_txn_checkpoint $DB_ENV;
2884 warn "end emergency database checkpoint\n";
2368 }; 2885 };
2369 2886
2370 warn "leave emergency perl save\n"; 2887 warn "leave emergency perl save\n";
2371} 2888}
2372 2889
2890sub post_cleanup {
2891 my ($make_core) = @_;
2892
2893 warn Carp::longmess "post_cleanup backtrace"
2894 if $make_core;
2895}
2896
2373sub reload() { 2897sub do_reload_perl() {
2374 # can/must only be called in main 2898 # can/must only be called in main
2375 if ($Coro::current != $Coro::main) { 2899 if ($Coro::current != $Coro::main) {
2376 warn "can only reload from main coroutine"; 2900 warn "can only reload from main coroutine";
2377 return; 2901 return;
2378 } 2902 }
2379 2903
2380 warn "reloading..."; 2904 warn "reloading...";
2381 2905
2382 warn "cancelling server ticker"; 2906 warn "entering sync_job";
2383 $TICK_WATCHER->cancel;
2384 2907
2908 cf::sync_job {
2909 cf::write_runtime; # external watchdog should not bark
2385 cf::emergency_save; 2910 cf::emergency_save;
2911 cf::write_runtime; # external watchdog should not bark
2386 2912
2387 eval { 2913 warn "syncing database to disk";
2914 BDB::db_env_txn_checkpoint $DB_ENV;
2915
2388 # if anything goes wrong in here, we should simply crash as we already saved 2916 # if anything goes wrong in here, we should simply crash as we already saved
2389
2390 warn "syncing database to disk";
2391 cf::db_sync;
2392 2917
2393 warn "cancelling all WF_AUTOCANCEL watchers"; 2918 warn "cancelling all WF_AUTOCANCEL watchers";
2394 for (Event::all_watchers) { 2919 for (Event::all_watchers) {
2395 $_->cancel if $_->data & WF_AUTOCANCEL; 2920 $_->cancel if $_->data & WF_AUTOCANCEL;
2396 } 2921 }
2397 2922
2398 warn "flushing outstanding aio requests"; 2923 warn "flushing outstanding aio requests";
2399 for (;;) { 2924 for (;;) {
2925 BDB::flush;
2400 IO::AIO::flush; 2926 IO::AIO::flush;
2401 Coro::cede; 2927 Coro::cede;
2402 last unless IO::AIO::nreqs; 2928 last unless IO::AIO::nreqs || BDB::nreqs;
2403 warn "iterate..."; 2929 warn "iterate...";
2404 } 2930 }
2931
2932 ++$RELOAD;
2405 2933
2406 warn "cancelling all extension coros"; 2934 warn "cancelling all extension coros";
2407 $_->cancel for values %EXT_CORO; 2935 $_->cancel for values %EXT_CORO;
2408 %EXT_CORO = (); 2936 %EXT_CORO = ();
2409 2937
2410 warn "removing commands"; 2938 warn "removing commands";
2411 %COMMAND = (); 2939 %COMMAND = ();
2412 2940
2413 warn "removing ext commands"; 2941 warn "removing ext/exti commands";
2414 %EXTCMD = (); 2942 %EXTCMD = ();
2943 %EXTICMD = ();
2415 2944
2416 warn "unloading/nuking all extensions"; 2945 warn "unloading/nuking all extensions";
2417 for my $pkg (@EXTS) { 2946 for my $pkg (@EXTS) {
2418 warn "... unloading $pkg"; 2947 warn "... unloading $pkg";
2419 2948
2449 Symbol::delete_package "safe::$_" 2978 Symbol::delete_package "safe::$_"
2450 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2979 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2451 2980
2452 warn "unloading cf.pm \"a bit\""; 2981 warn "unloading cf.pm \"a bit\"";
2453 delete $INC{"cf.pm"}; 2982 delete $INC{"cf.pm"};
2983 delete $INC{"cf/pod.pm"};
2454 2984
2455 # don't, removes xs symbols, too, 2985 # don't, removes xs symbols, too,
2456 # and global variables created in xs 2986 # and global variables created in xs
2457 #Symbol::delete_package __PACKAGE__; 2987 #Symbol::delete_package __PACKAGE__;
2458 2988
2462 require cf; 2992 require cf;
2463 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2993 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2464 2994
2465 warn "loading config and database again"; 2995 warn "loading config and database again";
2466 cf::cfg_load; 2996 cf::cfg_load;
2467 cf::db_load;
2468 2997
2469 warn "loading extensions"; 2998 warn "loading extensions";
2470 cf::load_extensions; 2999 cf::load_extensions;
2471 3000
2472 warn "reattaching attachments to objects/players"; 3001 warn "reattaching attachments to objects/players";
2473 _global_reattach; 3002 _global_reattach; # objects, sockets
2474 warn "reattaching attachments to maps"; 3003 warn "reattaching attachments to maps";
2475 reattach $_ for values %MAP; 3004 reattach $_ for values %MAP;
3005 warn "reattaching attachments to players";
3006 reattach $_ for values %PLAYER;
2476 3007
2477 warn "loading reloadable resources"; 3008 warn "leaving sync_job";
2478 load_resources;
2479 3009
2480 warn "restarting server ticker"; 3010 1
2481 3011 } or do {
2482 $TICK_WATCHER->start;
2483 };
2484
2485 if ($@) {
2486 warn $@; 3012 warn $@;
2487 warn "error while reloading, exiting."; 3013 warn "error while reloading, exiting.";
2488 exit 1; 3014 exit 1;
2489 } 3015 };
2490 3016
2491 warn "reloaded"; 3017 warn "reloaded";
2492}; 3018};
2493 3019
2494our $RELOAD_WATCHER; # used only during reload 3020our $RELOAD_WATCHER; # used only during reload
2495 3021
3022sub reload_perl() {
3023 # doing reload synchronously and two reloads happen back-to-back,
3024 # coro crashes during coro_state_free->destroy here.
3025
3026 $RELOAD_WATCHER ||= Event->timer (
3027 reentrant => 0,
3028 after => 0,
3029 data => WF_AUTOCANCEL,
3030 cb => sub {
3031 do_reload_perl;
3032 undef $RELOAD_WATCHER;
3033 },
3034 );
3035}
3036
2496register_command "reload" => sub { 3037register_command "reload" => sub {
2497 my ($who, $arg) = @_; 3038 my ($who, $arg) = @_;
2498 3039
2499 if ($who->flag (FLAG_WIZ)) { 3040 if ($who->flag (FLAG_WIZ)) {
2500 $who->message ("reloading server."); 3041 $who->message ("reloading server.");
2501 3042 async { reload_perl };
2502 # doing reload synchronously and two reloads happen back-to-back,
2503 # coro crashes during coro_state_free->destroy here.
2504
2505 $RELOAD_WATCHER ||= Event->timer (
2506 reentrant => 0,
2507 after => 0,
2508 data => WF_AUTOCANCEL,
2509 cb => sub {
2510 reload;
2511 undef $RELOAD_WATCHER;
2512 },
2513 );
2514 } 3043 }
2515}; 3044};
2516 3045
2517unshift @INC, $LIBDIR; 3046unshift @INC, $LIBDIR;
2518 3047
2519my $bug_warning = 0; 3048my $bug_warning = 0;
2520 3049
3050our @WAIT_FOR_TICK;
3051our @WAIT_FOR_TICK_BEGIN;
3052
3053sub wait_for_tick {
3054 return unless $TICK_WATCHER->is_active;
3055 return if $Coro::current == $Coro::main;
3056
3057 my $signal = new Coro::Signal;
3058 push @WAIT_FOR_TICK, $signal;
3059 $signal->wait;
3060}
3061
3062sub wait_for_tick_begin {
3063 return unless $TICK_WATCHER->is_active;
3064 return if $Coro::current == $Coro::main;
3065
3066 my $signal = new Coro::Signal;
3067 push @WAIT_FOR_TICK_BEGIN, $signal;
3068 $signal->wait;
3069}
3070
3071 my $min = 1e6;#d#
3072 my $avg = 10;
2521$TICK_WATCHER = Event->timer ( 3073$TICK_WATCHER = Event->timer (
2522 reentrant => 0, 3074 reentrant => 0,
2523 parked => 1, 3075 parked => 1,
2524 prio => 0, 3076 prio => 0,
2525 at => $NEXT_TICK || $TICK, 3077 at => $NEXT_TICK || $TICK,
2529 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3081 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2530 unless ++$bug_warning > 10; 3082 unless ++$bug_warning > 10;
2531 return; 3083 return;
2532 } 3084 }
2533 3085
2534 $NOW = Event::time; 3086 $NOW = $tick_start = Event::time;
2535 3087
2536 cf::server_tick; # one server iteration 3088 cf::server_tick; # one server iteration
3089
3090 0 && sync_job {#d#
3091 for(1..10) {
3092 my $t = Event::time;
3093 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3094 or die;
3095
3096 $map->width (50);
3097 $map->height (50);
3098 $map->alloc;
3099 $map->_load_objects ("/tmp/x.map", 1);
3100 my $t = Event::time - $t;
3101
3102 #next unless $t < 0.0013;#d#
3103 if ($t < $min) {
3104 $min = $t;
3105 }
3106 $avg = $avg * 0.99 + $t * 0.01;
3107 }
3108 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3109 exit 0;
3110 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3111 };
3112
2537 $RUNTIME += $TICK; 3113 $RUNTIME += $TICK;
2538 $NEXT_TICK += $TICK; 3114 $NEXT_TICK += $TICK;
2539 3115
2540 $WAIT_FOR_TICK->broadcast; 3116 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2541 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3117 $NEXT_RUNTIME_WRITE = $NOW + 10;
2542 3118 Coro::async_pool {
2543 Event::sweep; 3119 write_runtime
2544 Coro::cede_notself; 3120 or warn "ERROR: unable to write runtime file: $!";
3121 };
2545 3122 }
3123
2546# my $AFTER = Event::time; 3124# my $AFTER = Event::time;
2547# warn $AFTER - $NOW;#d# 3125# warn $AFTER - $NOW;#d#
2548 3126
3127 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3128 $sig->send;
3129 }
3130 while (my $sig = shift @WAIT_FOR_TICK) {
3131 $sig->send;
3132 }
3133
3134 $NOW = Event::time;
3135
2549 # if we are delayed by four ticks or more, skip them all 3136 # if we are delayed by four ticks or more, skip them all
2550 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3137 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2551 3138
2552 $TICK_WATCHER->at ($NEXT_TICK); 3139 $TICK_WATCHER->at ($NEXT_TICK);
2553 $TICK_WATCHER->start; 3140 $TICK_WATCHER->start;
3141
3142 $LOAD = ($NOW - $tick_start) / $TICK;
3143 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3144
3145 _post_tick;
3146
3147
2554 }, 3148 },
2555); 3149);
2556 3150
3151{
3152 BDB::max_poll_time $TICK * 0.1;
3153 $BDB_POLL_WATCHER = Event->io (
3154 reentrant => 0,
3155 fd => BDB::poll_fileno,
3156 poll => 'r',
3157 prio => 0,
3158 data => WF_AUTOCANCEL,
3159 cb => \&BDB::poll_cb,
3160 );
3161 BDB::min_parallel 8;
3162
3163 BDB::set_sync_prepare {
3164 my $status;
3165 my $current = $Coro::current;
3166 (
3167 sub {
3168 $status = $!;
3169 $current->ready; undef $current;
3170 },
3171 sub {
3172 Coro::schedule while defined $current;
3173 $! = $status;
3174 },
3175 )
3176 };
3177
3178 unless ($DB_ENV) {
3179 $DB_ENV = BDB::db_env_create;
3180
3181 cf::sync_job {
3182 eval {
3183 BDB::db_env_open
3184 $DB_ENV,
3185 $BDBDIR,
3186 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3187 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3188 0666;
3189
3190 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3191
3192 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3193 $DB_ENV->set_lk_detect;
3194 };
3195
3196 cf::cleanup "db_env_open(db): $@" if $@;
3197 };
3198 }
3199}
3200
3201{
3202 IO::AIO::min_parallel 8;
3203
3204 undef $Coro::AIO::WATCHER;
2557IO::AIO::max_poll_time $TICK * 0.1; 3205 IO::AIO::max_poll_time $TICK * 0.1;
2558
2559undef $Coro::AIO::WATCHER;
2560$AIO_POLL_WATCHER = Event->io ( 3206 $AIO_POLL_WATCHER = Event->io (
2561 reentrant => 0, 3207 reentrant => 0,
3208 data => WF_AUTOCANCEL,
2562 fd => IO::AIO::poll_fileno, 3209 fd => IO::AIO::poll_fileno,
2563 poll => 'r', 3210 poll => 'r',
2564 prio => 6, 3211 prio => 6,
2565 data => WF_AUTOCANCEL,
2566 cb => \&IO::AIO::poll_cb, 3212 cb => \&IO::AIO::poll_cb,
2567); 3213 );
3214}
2568 3215
2569$WRITE_RUNTIME_WATCHER = Event->timer ( 3216my $_log_backtrace;
2570 reentrant => 0, 3217
2571 data => WF_AUTOCANCEL, 3218sub _log_backtrace {
2572 after => 1, 3219 my ($msg, @addr) = @_;
2573 interval => 10, 3220
2574 prio => 6, # keep it lowest so it acts like a watchdog 3221 $msg =~ s/\n//;
2575 cb => Coro::unblock_sub { 3222
2576 write_runtime 3223 # limit the # of concurrent backtraces
2577 or warn "ERROR: unable to write runtime file: $!"; 3224 if ($_log_backtrace < 2) {
3225 ++$_log_backtrace;
3226 async {
3227 my @bt = fork_call {
3228 @addr = map { sprintf "%x", $_ } @addr;
3229 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3230 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3231 or die "addr2line: $!";
3232
3233 my @funcs;
3234 my @res = <$fh>;
3235 chomp for @res;
3236 while (@res) {
3237 my ($func, $line) = splice @res, 0, 2, ();
3238 push @funcs, "[$func] $line";
3239 }
3240
3241 @funcs
3242 };
3243
3244 LOG llevInfo, "[ABT] $msg\n";
3245 LOG llevInfo, "[ABT] $_\n" for @bt;
3246 --$_log_backtrace;
3247 };
3248 } else {
3249 LOG llevInfo, "[ABT] $msg\n";
3250 LOG llevInfo, "[ABT] [suppressed]\n";
2578 }, 3251 }
2579); 3252}
3253
3254# load additional modules
3255use cf::pod;
2580 3256
2581END { cf::emergency_save } 3257END { cf::emergency_save }
2582 3258
25831 32591
2584 3260

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines