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.208 by root, Mon Feb 12 00:27:20 2007 UTC vs.
Revision 1.298 by root, Sun Jul 8 14:50:07 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;
28 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
29Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 39Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30 40
31use 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
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 42
35# 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?
36$YAML::Syck::ImplicitUnicode = 1; 44$YAML::Syck::ImplicitUnicode = 1;
37 45
38$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
39 47
48sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
49
40our %COMMAND = (); 50our %COMMAND = ();
41our %COMMAND_TIME = (); 51our %COMMAND_TIME = ();
42 52
43our @EXTS = (); # list of extension package names 53our @EXTS = (); # list of extension package names
44our %EXTCMD = (); 54our %EXTCMD = ();
55our %EXTICMD = ();
45our %EXT_CORO = (); # coroutines bound to extensions 56our %EXT_CORO = (); # coroutines bound to extensions
46our %EXT_MAP = (); # pluggable maps 57our %EXT_MAP = (); # pluggable maps
47 58
59our $RELOAD; # number of reloads so far
48our @EVENT; 60our @EVENT;
49our $LIBDIR = datadir . "/ext";
50 61
51our $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(!)
52our $TICK_WATCHER; 75our $TICK_WATCHER;
53our $AIO_POLL_WATCHER; 76our $AIO_POLL_WATCHER;
54our $WRITE_RUNTIME_WATCHER; 77our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55our $NEXT_TICK; 78our $NEXT_TICK;
56our $NOW; 79our $NOW;
57our $USE_FSYNC = 1; # use fsync to write maps - default off 80our $USE_FSYNC = 1; # use fsync to write maps - default off
58 81
59our $BDB_POLL_WATCHER; 82our $BDB_POLL_WATCHER;
65our $RUNTIME; 88our $RUNTIME;
66 89
67our %PLAYER; # all users 90our %PLAYER; # all users
68our %MAP; # all maps 91our %MAP; # all maps
69our $LINK_MAP; # the special {link} map, which is always available 92our $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 93
76# 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 ∕
77our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 95our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78 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
79binmode STDOUT; 101binmode STDOUT;
80binmode STDERR; 102binmode STDERR;
81 103
82# read virtual server time, if available 104# read virtual server time, if available
83unless ($RUNTIME || !-e cf::localdir . "/runtime") { 105unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84 open my $fh, "<", cf::localdir . "/runtime" 106 open my $fh, "<", "$LOCALDIR/runtime"
85 or die "unable to read runtime file: $!"; 107 or die "unable to read runtime file: $!";
86 $RUNTIME = <$fh> + 0.; 108 $RUNTIME = <$fh> + 0.;
87} 109}
88 110
89mkdir cf::localdir; 111mkdir $_
90mkdir cf::localdir . "/" . cf::playerdir; 112 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 113
96our $EMERGENCY_POSITION; 114our $EMERGENCY_POSITION;
97 115
98sub cf::map::normalise; 116sub cf::map::normalise;
99 117
110=item $cf::RUNTIME 128=item $cf::RUNTIME
111 129
112The 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
113every server tick. 131every server tick.
114 132
115=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
116 136
117The perl library directory, where extensions and cf-specific modules can 137Various directories - "/etc", read-only install directory, perl-library
118be 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.
119 141
120=item $cf::NOW 142=item $cf::NOW
121 143
122The time of the last (current) server tick. 144The time of the last (current) server tick.
123 145
124=item $cf::TICK 146=item $cf::TICK
125 147
126The 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.
127 159
128=item %cf::CFG 160=item %cf::CFG
129 161
130Configuration for the server, loaded from C</etc/crossfire/config>, or 162Configuration for the server, loaded from C</etc/crossfire/config>, or
131from wherever your confdir points to. 163from wherever your confdir points to.
132 164
133=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 165=item cf::wait_for_tick, cf::wait_for_tick_begin
134 166
135These 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
136or 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
137processing 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.
138window of cpu time available, or simply to synchronise to the server tick.
139 170
140=back 171=back
141 172
142=cut 173=cut
143 174
144BEGIN { 175BEGIN {
145 *CORE::GLOBAL::warn = sub { 176 *CORE::GLOBAL::warn = sub {
146 my $msg = join "", @_; 177 my $msg = join "", @_;
147 utf8::encode $msg;
148 178
149 $msg .= "\n" 179 $msg .= "\n"
150 unless $msg =~ /\n$/; 180 unless $msg =~ /\n$/;
151 181
182 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
183
184 utf8::encode $msg;
152 LOG llevError, $msg; 185 LOG llevError, $msg;
153 }; 186 };
154} 187}
155 188
156@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 189@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 190@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 191@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 192@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160@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';
161@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)
162 196
163# 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
164# within the Safe compartment. 198# within the Safe compartment.
165for my $pkg (qw( 199for my $pkg (qw(
166 cf::global cf::attachable 200 cf::global cf::attachable
174} 208}
175 209
176$Event::DIED = sub { 210$Event::DIED = sub {
177 warn "error in event callback: @_"; 211 warn "error in event callback: @_";
178}; 212};
213
214#############################################################################
179 215
180=head2 UTILITY FUNCTIONS 216=head2 UTILITY FUNCTIONS
181 217
182=over 4 218=over 4
183 219
202 $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;
203 $d 239 $d
204 } || "[unable to dump $_[0]: '$@']"; 240 } || "[unable to dump $_[0]: '$@']";
205} 241}
206 242
207use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
210 244
211Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
212 246
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 247=item $json = cf::to_json $ref
221 248
222Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
223 250
224=cut 251=cut
225 252
226sub to_json($) { 253our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 254
228 JSON::Syck::Dump $_[0] 255sub to_json ($) { $json_coder->encode ($_[0]) }
229} 256sub from_json ($) { $json_coder->decode ($_[0]) }
230 257
231=item cf::lock_wait $string 258=item cf::lock_wait $string
232 259
233Wait until the given lock is available. See cf::lock_acquire. 260Wait until the given lock is available. See cf::lock_acquire.
234 261
240returned. 267returned.
241 268
242Lock 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
243uses map_find and cf::map::load uses map_load). 270uses map_find and cf::map::load uses map_load).
244 271
272=item $locked = cf::lock_active $string
273
274Return true if the lock is currently active, i.e. somebody has locked it.
275
245=cut 276=cut
246 277
247our %LOCK; 278our %LOCK;
248 279
249sub lock_wait($) { 280sub lock_wait($) {
268 # wake up all waiters, to be on the safe side 299 # wake up all waiters, to be on the safe side
269 $_->ready for @{ delete $LOCK{$key} }; 300 $_->ready for @{ delete $LOCK{$key} };
270 } 301 }
271} 302}
272 303
304sub lock_active($) {
305 my ($key) = @_;
306
307 ! ! $LOCK{$key}
308}
309
273sub freeze_mainloop { 310sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active; 311 return unless $TICK_WATCHER->is_active;
275 312
276 my $guard = Coro::guard { 313 my $guard = Coro::guard {
277 $TICK_WATCHER->start; 314 $TICK_WATCHER->start;
278 $WRITE_RUNTIME_WATCHER->start;
279 }; 315 };
280 $WRITE_RUNTIME_WATCHER->stop;
281 $TICK_WATCHER->stop; 316 $TICK_WATCHER->stop;
282 $guard 317 $guard
283} 318}
284 319
285=item cf::async { BLOCK } 320=item cf::async { BLOCK }
292 327
293BEGIN { *async = \&Coro::async_pool } 328BEGIN { *async = \&Coro::async_pool }
294 329
295=item cf::sync_job { BLOCK } 330=item cf::sync_job { BLOCK }
296 331
297The design of crossfire+ requires that the main coro ($Coro::main) is 332The design of Crossfire TRT requires that the main coroutine ($Coro::main)
298always able to handle events or runnable, as crossfire+ is only partly 333is 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. 334partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
335acceptable.
300 336
301If 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
302the given BLOCK in another coroutine while waiting for the result. The 338the given BLOCK in another coroutine while waiting for the result. The
303server 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
304fast or be very important. 340fast or be very important.
307 343
308sub sync_job(&) { 344sub sync_job(&) {
309 my ($job) = @_; 345 my ($job) = @_;
310 346
311 if ($Coro::current == $Coro::main) { 347 if ($Coro::current == $Coro::main) {
348 my $time = Event::time;
349
312 # this is the main coro, too bad, we have to block 350 # this is the main coro, too bad, we have to block
313 # till the operation succeeds, freezing the server :/ 351 # till the operation succeeds, freezing the server :/
314 352
315 # TODO: use suspend/resume instead 353 # TODO: use suspend/resume instead
316 # (but this is cancel-safe) 354 # (but this is cancel-safe)
327 365
328 while ($busy) { 366 while ($busy) {
329 Coro::cede or Event::one_event; 367 Coro::cede or Event::one_event;
330 } 368 }
331 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
332 wantarray ? @res : $res[0] 377 wantarray ? @res : $res[0]
333 } else { 378 } else {
334 # we are in another coroutine, how wonderful, everything just works 379 # we are in another coroutine, how wonderful, everything just works
335 380
336 $job->() 381 $job->()
355 $EXT_CORO{$coro+0} = $coro; 400 $EXT_CORO{$coro+0} = $coro;
356 401
357 $coro 402 $coro
358} 403}
359 404
360sub write_runtime { 405=item fork_call { }, $args
361 my $runtime = cf::localdir . "/runtime";
362 406
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 407Executes the given code block with the given arguments in a seperate
364 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.
365 411
366 my $value = $cf::RUNTIME + 90 + 10; 412=cut
367 # 10 is the runtime save interval, for a monotonic clock
368 # 60 allows for the watchdog to kill the server.
369 413
370 (aio_write $fh, 0, (length $value), $value, 0) <= 0 414sub fork_call(&@) {
371 and return; 415 my ($cb, @args) = @_;
372 416
373 # always fsync - this file is important 417# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
374 aio_fsync $fh 418# or die "socketpair: $!";
375 and return; 419 pipe my $fh1, my $fh2
420 or die "pipe: $!";
376 421
422 if (my $pid = fork) {
377 close $fh 423 close $fh2;
378 or return;
379 424
380 aio_rename "$runtime~", $runtime 425 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
381 and return; 426 warn "pst<$res>" unless $res =~ /^pst/;
427 $res = Coro::Storable::thaw $res;
382 428
429 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
430
431 Carp::confess $$res unless "ARRAY" eq ref $res;
432
433 return wantarray ? @$res : $res->[-1];
434 } else {
435 reset_signals;
436 local $SIG{__WARN__};
437 local $SIG{__DIE__};
438 local $Coro::idle;
439 $Coro::current->prio (Coro::PRIO_MAX);
440 eval {
441 close $fh1;
442
443 my @res = eval { $cb->(@args) };
444
445 open my $fh, ">", \my $buf
446 or die "fork_call: cannot open fh-to-buf in child : $!";
447 Storable::store_fd +($@ ? \"$@" : \@res), $fh;
448 close $fh;
449
450 warn "writing ", length $buf;
451 my $x;
452 (length $buf) == ($x = syswrite $fh2, $buf)
453 or warn "error writing ".(length $buf)." != $x\n";
454 close $fh2;
455 };
456
457 warn $@ if $@;
458 _exit 0;
383 1 459 }
460}
461
462=item $value = cf::db_get $family => $key
463
464Returns a single value from the environment database.
465
466=item cf::db_put $family => $key => $value
467
468Stores the given C<$value> in the family. It can currently store binary
469data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
470
471=cut
472
473our $DB;
474
475sub db_init {
476 unless ($DB) {
477 $DB = BDB::db_create $DB_ENV;
478
479 cf::sync_job {
480 eval {
481 $DB->set_flags (BDB::CHKSUM);
482
483 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
484 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
485 cf::cleanup "db_open(db): $!" if $!;
486 };
487 cf::cleanup "db_open(db): $@" if $@;
488 };
489 }
490}
491
492sub db_get($$) {
493 my $key = "$_[0]/$_[1]";
494
495 cf::sync_job {
496 BDB::db_get $DB, undef, $key, my $data;
497
498 $! ? ()
499 : $data
500 }
501}
502
503sub db_put($$$) {
504 BDB::dbreq_pri 4;
505 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
506}
507
508=item cf::cache $id => [$paths...], $processversion => $process
509
510Generic caching function that returns the value of the resource $id,
511caching and regenerating as required.
512
513This function can block.
514
515=cut
516
517sub cache {
518 my ($id, $src, $processversion, $process) = @_;
519
520 my $meta =
521 join "\x00",
522 $processversion,
523 map {
524 aio_stat $_
525 and Carp::croak "$_: $!";
526
527 ($_, (stat _)[7,9])
528 } @$src;
529
530 my $dbmeta = db_get cache => "$id/meta";
531 if ($dbmeta ne $meta) {
532 # changed, we may need to process
533
534 my @data;
535 my $md5;
536
537 for (0 .. $#$src) {
538 0 <= aio_load $src->[$_], $data[$_]
539 or Carp::croak "$src->[$_]: $!";
540 }
541
542 # if processing is expensive, check
543 # checksum first
544 if (1) {
545 $md5 =
546 join "\x00",
547 $processversion,
548 map {
549 Coro::cede;
550 ($src->[$_], Digest::MD5::md5_hex $data[$_])
551 } 0.. $#$src;
552
553
554 my $dbmd5 = db_get cache => "$id/md5";
555 if ($dbmd5 eq $md5) {
556 db_put cache => "$id/meta", $meta;
557
558 return db_get cache => "$id/data";
559 }
560 }
561
562 my $t1 = Time::HiRes::time;
563 my $data = $process->(\@data);
564 my $t2 = Time::HiRes::time;
565
566 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
567
568 db_put cache => "$id/data", $data;
569 db_put cache => "$id/md5" , $md5;
570 db_put cache => "$id/meta", $meta;
571
572 return $data;
573 }
574
575 db_get cache => "$id/data"
576}
577
578=item cf::datalog type => key => value, ...
579
580Log a datalog packet of the given type with the given key-value pairs.
581
582=cut
583
584sub datalog($@) {
585 my ($type, %kv) = @_;
586 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384} 587}
385 588
386=back 589=back
387 590
388=cut 591=cut
395attach callbacks/event handlers (a collection of which is called an "attachment") 598attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods. 599to it. All such attachable objects support the following methods.
397 600
398In the following description, CLASS can be any of C<global>, C<object> 601In 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 602C<player>, C<client> or C<map> (i.e. the attachable objects in
400crossfire+). 603Crossfire TRT).
401 604
402=over 4 605=over 4
403 606
404=item $attachable->attach ($attachment, key => $value...) 607=item $attachable->attach ($attachment, key => $value...)
405 608
568 $registry = $CB_TYPE[$object_type] ||= []; 771 $registry = $CB_TYPE[$object_type] ||= [];
569 772
570 } elsif ($type eq "subtype") { 773 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type"; 774 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg; 775 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 776 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574 777
575 } elsif ($type eq "package") { 778 } elsif ($type eq "package") {
576 my $pkg = shift @arg; 779 my $pkg = shift @arg;
577 780
578 while (my ($name, $id) = each %cb_id) { 781 while (my ($name, $id) = each %cb_id) {
607 _attach $registry, $klass, @attach; 810 _attach $registry, $klass, @attach;
608 } 811 }
609 812
610 $obj->{$name} = \%arg; 813 $obj->{$name} = \%arg;
611 } else { 814 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n"; 815 warn "object uses attachment '$name' which is not available, postponing.\n";
613 } 816 }
614 817
615 $obj->{_attachment}{$name} = undef; 818 $obj->{_attachment}{$name} = undef;
616} 819}
617 820
619 if (ref $_[0]) { 822 if (ref $_[0]) {
620 _object_attach @_; 823 _object_attach @_;
621 } else { 824 } else {
622 _attach shift->_attach_registry, @_; 825 _attach shift->_attach_registry, @_;
623 } 826 }
827 _recalc_want;
624}; 828};
625 829
626# all those should be optimised 830# all those should be optimised
627sub cf::attachable::detach { 831sub cf::attachable::detach {
628 my ($obj, $name) = @_; 832 my ($obj, $name) = @_;
631 delete $obj->{_attachment}{$name}; 835 delete $obj->{_attachment}{$name};
632 reattach ($obj); 836 reattach ($obj);
633 } else { 837 } else {
634 Carp::croak "cannot, currently, detach class attachments"; 838 Carp::croak "cannot, currently, detach class attachments";
635 } 839 }
840 _recalc_want;
636}; 841};
637 842
638sub cf::attachable::attached { 843sub cf::attachable::attached {
639 my ($obj, $name) = @_; 844 my ($obj, $name) = @_;
640 845
787 } 992 }
788 } else { 993 } else {
789 aio_unlink $filename; 994 aio_unlink $filename;
790 aio_unlink "$filename.pst"; 995 aio_unlink "$filename.pst";
791 } 996 }
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 } 997 }
799} 998}
800 999
801sub object_freezer_as_string { 1000sub object_freezer_as_string {
802 my ($rdata, $objs) = @_; 1001 my ($rdata, $objs) = @_;
808 1007
809sub object_thawer_load { 1008sub object_thawer_load {
810 my ($filename) = @_; 1009 my ($filename) = @_;
811 1010
812 my ($data, $av); 1011 my ($data, $av);
813
814 #d#TODO remove .map if file does not exist
815 aio_stat $filename and $filename =~ s/\.map$//;
816 1012
817 (aio_load $filename, $data) >= 0 1013 (aio_load $filename, $data) >= 0
818 or return; 1014 or return;
819 1015
820 unless (aio_stat "$filename.pst") { 1016 unless (aio_stat "$filename.pst") {
822 or return; 1018 or return;
823 $av = eval { (Storable::thaw $av)->{objs} }; 1019 $av = eval { (Storable::thaw $av)->{objs} };
824 } 1020 }
825 1021
826 warn sprintf "loading %s (%d)\n", 1022 warn sprintf "loading %s (%d)\n",
827 $filename, length $data, scalar @{$av || []};#d# 1023 $filename, length $data, scalar @{$av || []};
828 return ($data, $av); 1024 return ($data, $av);
829} 1025}
1026
1027=head2 COMMAND CALLBACKS
1028
1029=over 4
1030
1031=cut
830 1032
831############################################################################# 1033#############################################################################
832# command handling &c 1034# command handling &c
833 1035
834=item cf::register_command $name => \&callback($ob,$args); 1036=item cf::register_command $name => \&callback($ob,$args);
847 push @{ $COMMAND{$name} }, [$caller, $cb]; 1049 push @{ $COMMAND{$name} }, [$caller, $cb];
848} 1050}
849 1051
850=item cf::register_extcmd $name => \&callback($pl,$packet); 1052=item cf::register_extcmd $name => \&callback($pl,$packet);
851 1053
852Register a callbackf ro execution when the client sends an extcmd packet. 1054Register a callback for execution when the client sends an (synchronous)
1055extcmd packet. Ext commands will be processed in the order they are
1056received by the server, like other user commands. The first argument is
1057the logged-in player. Ext commands can only be processed after a player
1058has logged in successfully.
853 1059
854If the callback returns something, it is sent back as if reply was being 1060If the callback returns something, it is sent back as if reply was being
855called. 1061called.
856 1062
1063=item cf::register_exticmd $name => \&callback($ns,$packet);
1064
1065Register a callback for execution when the client sends an (asynchronous)
1066exticmd packet. Exti commands are processed by the server as soon as they
1067are received, i.e. out of order w.r.t. other commands. The first argument
1068is a client socket. Exti commands can be received anytime, even before
1069log-in.
1070
1071If the callback returns something, it is sent back as if reply was being
1072called.
1073
857=cut 1074=cut
858 1075
859sub register_extcmd { 1076sub register_extcmd {
860 my ($name, $cb) = @_; 1077 my ($name, $cb) = @_;
861 1078
862 $EXTCMD{$name} = $cb; 1079 $EXTCMD{$name} = $cb;
1080}
1081
1082sub register_exticmd {
1083 my ($name, $cb) = @_;
1084
1085 $EXTICMD{$name} = $cb;
863} 1086}
864 1087
865cf::player->attach ( 1088cf::player->attach (
866 on_command => sub { 1089 on_command => sub {
867 my ($pl, $name, $params) = @_; 1090 my ($pl, $name, $params) = @_;
876 cf::override; 1099 cf::override;
877 }, 1100 },
878 on_extcmd => sub { 1101 on_extcmd => sub {
879 my ($pl, $buf) = @_; 1102 my ($pl, $buf) = @_;
880 1103
881 my $msg = eval { from_json $buf }; 1104 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
882 1105
883 if (ref $msg) { 1106 if (ref $msg) {
884 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1107 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
885 if (my %reply = $cb->($pl, $msg)) { 1108 if (my %reply = $cb->($pl, $msg)) {
886 $pl->ext_reply ($msg->{msgid}, %reply); 1109 $pl->ext_reply ($msg->{msgid}, %reply);
892 1115
893 cf::override; 1116 cf::override;
894 }, 1117 },
895); 1118);
896 1119
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 { 1120sub load_extensions {
1121 cf::sync_job {
1122 my %todo;
1123
932 for my $ext (<$LIBDIR/*.ext>) { 1124 for my $path (<$LIBDIR/*.ext>) {
933 next unless -r $ext; 1125 next unless -r $path;
934 eval { 1126
935 load_extension $ext; 1127 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1128 my $base = $1;
1129 my $pkg = $1;
1130 $pkg =~ s/[^[:word:]]/_/g;
1131 $pkg = "ext::$pkg";
1132
1133 open my $fh, "<:utf8", $path
1134 or die "$path: $!";
1135
1136 my $source = do { local $/; <$fh> };
1137
1138 my %ext = (
1139 path => $path,
1140 base => $base,
1141 pkg => $pkg,
1142 );
1143
1144 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1145 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1146
1147 $ext{source} =
1148 "package $pkg; use strict; use utf8;\n"
1149 . "#line 1 \"$path\"\n{\n"
1150 . $source
1151 . "\n};\n1";
1152
1153 $todo{$base} = \%ext;
1154 }
1155
1156 my %done;
1157 while (%todo) {
1158 my $progress;
1159
1160 while (my ($k, $v) = each %todo) {
1161 for (split /,\s*/, $v->{meta}{depends}) {
1162 goto skip
1163 unless exists $done{$_};
1164 }
1165
1166 warn "... loading '$k' into '$v->{pkg}'\n";
1167
1168 unless (eval $v->{source}) {
1169 my $msg = $@ ? "$v->{path}: $@\n"
1170 : "$v->{base}: extension inactive.\n";
1171
1172 if (exists $v->{meta}{mandatory}) {
1173 warn $msg;
1174 warn "mandatory extension failed to load, exiting.\n";
1175 exit 1;
1176 }
1177
1178 warn $msg;
1179 }
1180
1181 $done{$k} = delete $todo{$k};
1182 push @EXTS, $v->{pkg};
1183 $progress = 1;
936 1 1184 }
937 } or warn "$ext not loaded: $@"; 1185
1186 skip:
1187 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1188 unless $progress;
1189 }
938 } 1190 };
939} 1191}
940 1192
941############################################################################# 1193#############################################################################
942 1194
1195=back
1196
943=head2 CORE EXTENSIONS 1197=head2 CORE EXTENSIONS
944 1198
945Functions and methods that extend core crossfire objects. 1199Functions and methods that extend core crossfire objects.
946 1200
947=cut 1201=cut
959Returns the given player object, loading it if necessary (might block). 1213Returns the given player object, loading it if necessary (might block).
960 1214
961=cut 1215=cut
962 1216
963sub playerdir($) { 1217sub playerdir($) {
964 cf::localdir 1218 "$PLAYERDIR/"
965 . "/"
966 . cf::playerdir
967 . "/"
968 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1219 . (ref $_[0] ? $_[0]->ob->name : $_[0])
969} 1220}
970 1221
971sub path($) { 1222sub path($) {
972 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1223 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
973 1224
974 (playerdir $login) . "/$login.pl" 1225 (playerdir $login) . "/playerdata"
975} 1226}
976 1227
977sub find_active($) { 1228sub find_active($) {
978 $cf::PLAYER{$_[0]} 1229 $cf::PLAYER{$_[0]}
979 and $cf::PLAYER{$_[0]}->active 1230 and $cf::PLAYER{$_[0]}->active
992 my $login = $_[0]; 1243 my $login = $_[0];
993 1244
994 my $guard = cf::lock_acquire "user_find:$login"; 1245 my $guard = cf::lock_acquire "user_find:$login";
995 1246
996 $cf::PLAYER{$_[0]} || do { 1247 $cf::PLAYER{$_[0]} || do {
1248 # rename old playerfiles to new ones
1249 #TODO: remove when no longer required
1250 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1251 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1252 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1253 aio_unlink +(playerdir $login) . "/$login.pl";
1254
997 my $pl = load_pl path $login 1255 my $pl = load_pl path $login
998 or return; 1256 or return;
999 $cf::PLAYER{$login} = $pl 1257 $cf::PLAYER{$login} = $pl
1000 } 1258 }
1001 } 1259 }
1038 1296
1039=cut 1297=cut
1040 1298
1041sub quit_character { 1299sub quit_character {
1042 my ($pl) = @_; 1300 my ($pl) = @_;
1301
1302 my $name = $pl->ob->name;
1043 1303
1044 $pl->{deny_save} = 1; 1304 $pl->{deny_save} = 1;
1045 $pl->password ("*"); # this should lock out the player until we nuked the dir 1305 $pl->password ("*"); # this should lock out the player until we nuked the dir
1046 1306
1047 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1307 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1052 my $path = playerdir $pl; 1312 my $path = playerdir $pl;
1053 my $temp = "$path~$cf::RUNTIME~deleting~"; 1313 my $temp = "$path~$cf::RUNTIME~deleting~";
1054 aio_rename $path, $temp; 1314 aio_rename $path, $temp;
1055 delete $cf::PLAYER{$pl->ob->name}; 1315 delete $cf::PLAYER{$pl->ob->name};
1056 $pl->destroy; 1316 $pl->destroy;
1317
1318 my $prefix = qr<^~\Q$name\E/>;
1319
1320 # nuke player maps
1321 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1322
1057 IO::AIO::aio_rmtree $temp; 1323 IO::AIO::aio_rmtree $temp;
1324}
1325
1326=item $pl->kick
1327
1328Kicks a player out of the game. This destroys the connection.
1329
1330=cut
1331
1332sub kick {
1333 my ($pl, $kicker) = @_;
1334
1335 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1336 $pl->killer ("kicked");
1337 $pl->ns->destroy;
1058} 1338}
1059 1339
1060=item cf::player::list_logins 1340=item cf::player::list_logins
1061 1341
1062Returns am arrayref of all valid playernames in the system, can take a 1342Returns am arrayref of all valid playernames in the system, can take a
1063while and may block, so not sync_job-capable, ever. 1343while and may block, so not sync_job-capable, ever.
1064 1344
1065=cut 1345=cut
1066 1346
1067sub list_logins { 1347sub list_logins {
1068 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1348 my $dirs = aio_readdir $PLAYERDIR
1069 or return []; 1349 or return [];
1070 1350
1071 my @logins; 1351 my @logins;
1072 1352
1073 for my $login (@$dirs) { 1353 for my $login (@$dirs) {
1108 } 1388 }
1109 1389
1110 \@paths 1390 \@paths
1111} 1391}
1112 1392
1393=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1394
1395Expand crossfire pod fragments into protocol xml.
1396
1397=cut
1398
1399sub expand_cfpod {
1400 ((my $self), (local $_)) = @_;
1401
1402 # escape & and <
1403 s/&/&amp;/g;
1404 s/(?<![BIUGH])</&lt;/g;
1405
1406 # this is buggy, it needs to properly take care of nested <'s
1407
1408 1 while
1409 # replace B<>, I<>, U<> etc.
1410 s/B<([^\>]*)>/<b>$1<\/b>/
1411 || s/I<([^\>]*)>/<i>$1<\/i>/
1412 || s/U<([^\>]*)>/<u>$1<\/u>/
1413 # replace G<male|female> tags
1414 || s{G<([^>|]*)\|([^>]*)>}{
1415 $self->gender ? $2 : $1
1416 }ge
1417 # replace H<hint text>
1418 || s{H<([^\>]*)>}
1419 {
1420 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1421 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1422 "")
1423 [$self->{hintmode}]
1424 }ge;
1425
1426 # create single paragraphs (very hackish)
1427 s/(?<=\S)\n(?=\w)/ /g;
1428
1429 # compress some whitespace
1430 s/\s+\n/\n/g; # ws line-ends
1431 s/\n\n+/\n/g; # double lines
1432 s/^\n+//; # beginning lines
1433 s/\n+$//; # ending lines
1434
1435 $_
1436}
1437
1438sub hintmode {
1439 $_[0]{hintmode} = $_[1] if @_ > 1;
1440 $_[0]{hintmode}
1441}
1442
1113=item $player->ext_reply ($msgid, $msgtype, %msg) 1443=item $player->ext_reply ($msgid, %msg)
1114 1444
1115Sends an ext reply to the player. 1445Sends an ext reply to the player.
1116 1446
1117=cut 1447=cut
1118 1448
1119sub ext_reply($$$%) { 1449sub ext_reply($$%) {
1120 my ($self, $id, %msg) = @_; 1450 my ($self, $id, %msg) = @_;
1121 1451
1122 $msg{msgid} = $id; 1452 $msg{msgid} = $id;
1123 1453 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1124 $self->send ("ext " . cf::to_json \%msg);
1125} 1454}
1126 1455
1127package cf; 1456=item $player->ext_event ($type, %msg)
1457
1458Sends an ext event to the client.
1459
1460=cut
1461
1462sub ext_event($$%) {
1463 my ($self, $type, %msg) = @_;
1464
1465 $self->ns->ext_event ($type, %msg);
1466}
1467
1468=head3 cf::region
1469
1470=over 4
1471
1472=cut
1473
1474package cf::region;
1475
1476=item cf::region::find_by_path $path
1477
1478Tries to decuce the likely region for a map knowing only its path.
1479
1480=cut
1481
1482sub find_by_path($) {
1483 my ($path) = @_;
1484
1485 my ($match, $specificity);
1486
1487 for my $region (list) {
1488 if ($region->match && $path =~ $region->match) {
1489 ($match, $specificity) = ($region, $region->specificity)
1490 if $region->specificity > $specificity;
1491 }
1492 }
1493
1494 $match
1495}
1128 1496
1129=back 1497=back
1130
1131 1498
1132=head3 cf::map 1499=head3 cf::map
1133 1500
1134=over 4 1501=over 4
1135 1502
1190 my ($self, $merge) = @_; 1557 my ($self, $merge) = @_;
1191 1558
1192 # we have to keep some variables in memory intact 1559 # we have to keep some variables in memory intact
1193 local $self->{path}; 1560 local $self->{path};
1194 local $self->{load_path}; 1561 local $self->{load_path};
1195 local $self->{deny_save};
1196 local $self->{deny_reset};
1197 1562
1198 $self->SUPER::thawer_merge ($merge); 1563 $self->SUPER::thawer_merge ($merge);
1199} 1564}
1200 1565
1201sub normalise { 1566sub normalise {
1273 1638
1274# the original (read-only) location 1639# the original (read-only) location
1275sub load_path { 1640sub load_path {
1276 my ($self) = @_; 1641 my ($self) = @_;
1277 1642
1278 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1643 "$MAPDIR/$self->{path}.map"
1279} 1644}
1280 1645
1281# the temporary/swap location 1646# the temporary/swap location
1282sub save_path { 1647sub save_path {
1283 my ($self) = @_; 1648 my ($self) = @_;
1284 1649
1285 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1650 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1286 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1651 "$TMPDIR/$path.map"
1287} 1652}
1288 1653
1289# the unique path, undef == no special unique path 1654# the unique path, undef == no special unique path
1290sub uniq_path { 1655sub uniq_path {
1291 my ($self) = @_; 1656 my ($self) = @_;
1292 1657
1293 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1658 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1294 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1659 "$UNIQUEDIR/$path"
1295} 1660}
1296 1661
1297# and all this just because we cannot iterate over 1662# and all this just because we cannot iterate over
1298# all maps in C++... 1663# all maps in C++...
1299sub change_all_map_light { 1664sub change_all_map_light {
1301 1666
1302 $_->change_map_light ($change) 1667 $_->change_map_light ($change)
1303 for grep $_->outdoor, values %cf::MAP; 1668 for grep $_->outdoor, values %cf::MAP;
1304} 1669}
1305 1670
1671sub decay_objects {
1672 my ($self) = @_;
1673
1674 return if $self->{deny_reset};
1675
1676 $self->do_decay_objects;
1677}
1678
1306sub unlink_save { 1679sub unlink_save {
1307 my ($self) = @_; 1680 my ($self) = @_;
1308 1681
1309 utf8::encode (my $save = $self->save_path); 1682 utf8::encode (my $save = $self->save_path);
1310 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1683 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1311 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1684 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} 1685}
1318 1686
1319sub load_header_from($) { 1687sub load_header_from($) {
1320 my ($self, $path) = @_; 1688 my ($self, $path) = @_;
1321 1689
1371 $self->load_header_orig 1739 $self->load_header_orig
1372 or return; 1740 or return;
1373 $self->prepare_orig; 1741 $self->prepare_orig;
1374 } 1742 }
1375 1743
1744 $self->{deny_reset} = 1
1745 if $self->no_reset;
1746
1747 $self->default_region (cf::region::find_by_path $self->{path})
1748 unless $self->default_region;
1749
1376 1 1750 1
1377} 1751}
1378 1752
1379sub find; 1753sub find;
1380sub find { 1754sub find {
1392 $map->{last_save} = $cf::RUNTIME; 1766 $map->{last_save} = $cf::RUNTIME;
1393 1767
1394 $map->load_header 1768 $map->load_header
1395 or return; 1769 or return;
1396 1770
1397 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1771 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398 # doing this can freeze the server in a sync job, obviously 1772 # doing this can freeze the server in a sync job, obviously
1399 #$cf::WAIT_FOR_TICK->wait; 1773 #$cf::WAIT_FOR_TICK->wait;
1400 $map->reset; 1774 $map->reset;
1401 undef $guard; 1775 undef $guard;
1402 return find $path; 1776 return find $path;
1413 my ($self) = @_; 1787 my ($self) = @_;
1414 1788
1415 local $self->{deny_reset} = 1; # loading can take a long time 1789 local $self->{deny_reset} = 1; # loading can take a long time
1416 1790
1417 my $path = $self->{path}; 1791 my $path = $self->{path};
1792
1793 {
1418 my $guard = cf::lock_acquire "map_load:$path"; 1794 my $guard = cf::lock_acquire "map_load:$path";
1419 1795
1420 return if $self->in_memory != cf::MAP_SWAPPED; 1796 return if $self->in_memory != cf::MAP_SWAPPED;
1421 1797
1422 $self->in_memory (cf::MAP_LOADING); 1798 $self->in_memory (cf::MAP_LOADING);
1423 1799
1424 $self->alloc; 1800 $self->alloc;
1425 1801
1426 $self->pre_load; 1802 $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; 1803 Coro::cede;
1452 $self->set_darkness_map; 1804
1805 $self->_load_objects ($self->{load_path}, 1)
1806 or return;
1807
1808 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1809 if delete $self->{load_original};
1810
1811 if (my $uniq = $self->uniq_path) {
1812 utf8::encode $uniq;
1813 if (aio_open $uniq, O_RDONLY, 0) {
1814 $self->clear_unique_items;
1815 $self->_load_objects ($uniq, 0);
1816 }
1817 }
1818
1819 Coro::cede;
1820 # now do the right thing for maps
1821 $self->link_multipart_objects;
1453 $self->difficulty ($self->estimate_difficulty) 1822 $self->difficulty ($self->estimate_difficulty)
1454 unless $self->difficulty; 1823 unless $self->difficulty;
1455 Coro::cede; 1824 Coro::cede;
1825
1826 unless ($self->{deny_activate}) {
1827 $self->decay_objects;
1828 $self->fix_auto_apply;
1829 $self->update_buttons;
1830 Coro::cede;
1831 $self->set_darkness_map;
1832 Coro::cede;
1456 $self->activate; 1833 $self->activate;
1834 }
1835
1836 $self->in_memory (cf::MAP_IN_MEMORY);
1457 } 1837 }
1458 1838
1459 $self->post_load; 1839 $self->post_load;
1460
1461 $self->in_memory (cf::MAP_IN_MEMORY);
1462} 1840}
1463 1841
1464sub customise_for { 1842sub customise_for {
1465 my ($self, $ob) = @_; 1843 my ($self, $ob) = @_;
1466 1844
1467 return find "~" . $ob->name . "/" . $self->{path} 1845 return find "~" . $ob->name . "/" . $self->{path}
1468 if $self->per_player; 1846 if $self->per_player;
1847
1848# return find "?party/" . $ob->name . "/" . $self->{path}
1849# if $self->per_party;
1469 1850
1470 $self 1851 $self
1471} 1852}
1472 1853
1473# find and load all maps in the 3x3 area around a map 1854# find and load all maps in the 3x3 area around a map
1584 1965
1585sub reset_at { 1966sub reset_at {
1586 my ($self) = @_; 1967 my ($self) = @_;
1587 1968
1588 # TODO: safety, remove and allow resettable per-player maps 1969 # 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}; 1970 return 1e99 if $self->{deny_reset};
1591 1971
1592 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1972 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1973 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594 1974
1605 my ($self) = @_; 1985 my ($self) = @_;
1606 1986
1607 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1987 my $lock = cf::lock_acquire "map_data:$self->{path}";
1608 1988
1609 return if $self->players; 1989 return if $self->players;
1610 return if $self->isa ("ext::map_per_player");#d#
1611 1990
1612 warn "resetting map ", $self->path;#d# 1991 warn "resetting map ", $self->path;
1992
1993 $self->in_memory (cf::MAP_SWAPPED);
1994
1995 # need to save uniques path
1996 unless ($self->{deny_save}) {
1997 my $uniq = $self->uniq_path; utf8::encode $uniq;
1998
1999 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2000 if $uniq;
2001 }
1613 2002
1614 delete $cf::MAP{$self->path}; 2003 delete $cf::MAP{$self->path};
1615 2004
1616 $self->in_memory (cf::MAP_SWAPPED);
1617 $self->clear; 2005 $self->clear;
1618 2006
1619 $_->clear_links_to ($self) for values %cf::MAP; 2007 $_->clear_links_to ($self) for values %cf::MAP;
1620 2008
1621 $self->unlink_save; 2009 $self->unlink_save;
1640 $cf::MAP{$self->path} = $self; 2028 $cf::MAP{$self->path} = $self;
1641 2029
1642 $self->reset; # polite request, might not happen 2030 $self->reset; # polite request, might not happen
1643} 2031}
1644 2032
2033=item $maps = cf::map::tmp_maps
2034
2035Returns an arrayref with all map paths of currently instantiated and saved
2036maps. May block.
2037
2038=cut
2039
2040sub tmp_maps() {
2041 [
2042 map {
2043 utf8::decode $_;
2044 /\.map$/
2045 ? normalise $_
2046 : ()
2047 } @{ aio_readdir $TMPDIR or [] }
2048 ]
2049}
2050
2051=item $maps = cf::map::random_maps
2052
2053Returns an arrayref with all map paths of currently instantiated and saved
2054random maps. May block.
2055
2056=cut
2057
2058sub random_maps() {
2059 [
2060 map {
2061 utf8::decode $_;
2062 /\.map$/
2063 ? normalise "?random/$_"
2064 : ()
2065 } @{ aio_readdir $RANDOMDIR or [] }
2066 ]
2067}
2068
1645=item cf::map::unique_maps 2069=item cf::map::unique_maps
1646 2070
1647Returns an arrayref of paths of all shared maps that have 2071Returns an arrayref of paths of all shared maps that have
1648instantiated unique items. May block. 2072instantiated unique items. May block.
1649 2073
1650=cut 2074=cut
1651 2075
1652sub unique_maps() { 2076sub unique_maps() {
1653 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2077 [
1654 or return; 2078 map {
1655
1656 my @paths;
1657
1658 for (@$files) {
1659 utf8::decode $_; 2079 utf8::decode $_;
1660 next if /\.pst$/; 2080 /\.map$/
1661 next unless /^$PATH_SEP/o; 2081 ? normalise $_
1662 2082 : ()
1663 push @paths, cf::map::normalise $_; 2083 } @{ aio_readdir $UNIQUEDIR or [] }
1664 } 2084 ]
1665
1666 \@paths
1667} 2085}
1668 2086
1669package cf; 2087package cf;
1670 2088
1671=back 2089=back
1717 2135
1718 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2136 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1719 2137
1720 if ($self->{record_replies}) { 2138 if ($self->{record_replies}) {
1721 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2139 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2140
1722 } else { 2141 } else {
2142 my $pl = $self->contr;
2143
2144 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2145 my $diag = $pl->{npc_dialog};
2146 $diag->{pl}->ext_reply (
2147 $diag->{id},
2148 msgtype => "reply",
2149 msg => $diag->{pl}->expand_cfpod ($msg),
2150 add_topics => []
2151 );
2152
2153 } else {
1723 $msg = $npc->name . " says: $msg" if $npc; 2154 $msg = $npc->name . " says: $msg" if $npc;
1724 $self->message ($msg, $flags); 2155 $self->message ($msg, $flags);
2156 }
1725 } 2157 }
1726} 2158}
1727 2159
1728=item $player_object->may ("access") 2160=item $player_object->may ("access")
1729 2161
1777 $self->deactivate_recursive; 2209 $self->deactivate_recursive;
1778 2210
1779 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2211 return if UNIVERSAL::isa $self->map, "ext::map_link";
1780 2212
1781 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2213 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1782 if $self->map; 2214 if $self->map && $self->map->{path} ne "{link}";
1783 2215
1784 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2216 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1785} 2217}
1786 2218
1787sub cf::object::player::leave_link { 2219sub cf::object::player::leave_link {
1788 my ($self, $map, $x, $y) = @_; 2220 my ($self, $map, $x, $y) = @_;
2221
2222 return unless $self->contr->active;
1789 2223
1790 my $link_pos = delete $self->{_link_pos}; 2224 my $link_pos = delete $self->{_link_pos};
1791 2225
1792 unless ($map) { 2226 unless ($map) {
1793 # restore original map position 2227 # restore original map position
1811 $map->load; 2245 $map->load;
1812 $map->load_diag; 2246 $map->load_diag;
1813 2247
1814 return unless $self->contr->active; 2248 return unless $self->contr->active;
1815 $self->activate_recursive; 2249 $self->activate_recursive;
2250
2251 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1816 $self->enter_map ($map, $x, $y); 2252 $self->enter_map ($map, $x, $y);
1817} 2253}
1818 2254
1819cf::player->attach (
1820 on_logout => sub {
1821 my ($pl) = @_;
1822
1823 # abort map switching before logout
1824 if ($pl->ob->{_link_pos}) {
1825 cf::sync_job {
1826 $pl->ob->leave_link
1827 };
1828 }
1829 },
1830 on_login => sub {
1831 my ($pl) = @_;
1832
1833 # try to abort aborted map switching on player login :)
1834 # should happen only on crashes
1835 if ($pl->ob->{_link_pos}) {
1836 $pl->ob->enter_link;
1837 (async {
1838 # we need this sleep as the login has a concurrent enter_exit running
1839 # and this sleep increases chances of the player not ending up in scorn
1840 $pl->ob->reply (undef,
1841 "There was an internal problem at your last logout, "
1842 . "the server will try to bring you to your intended destination in a second.",
1843 cf::NDI_RED);
1844 Coro::Timer::sleep 1;
1845 $pl->ob->leave_link;
1846 })->prio (2);
1847 }
1848 },
1849);
1850
1851=item $player_object->goto ($path, $x, $y) 2255=item $player_object->goto ($path, $x, $y[, $check->($map)])
1852 2256
2257Moves the player to the given map-path and coordinates by first freezing
2258her, loading and preparing them map, calling the provided $check callback
2259that has to return the map if sucecssful, and then unfreezes the player on
2260the new (success) or old (failed) map position.
2261
1853=cut 2262=cut
2263
2264our $GOTOGEN;
1854 2265
1855sub cf::object::player::goto { 2266sub cf::object::player::goto {
1856 my ($self, $path, $x, $y) = @_; 2267 my ($self, $path, $x, $y, $check) = @_;
2268
2269 # do generation counting so two concurrent goto's will be executed in-order
2270 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1857 2271
1858 $self->enter_link; 2272 $self->enter_link;
1859 2273
1860 (async { 2274 (async {
1861 my $map = eval { 2275 my $map = eval {
1862 my $map = cf::map::find $path; 2276 my $map = cf::map::find $path;
2277
2278 if ($map) {
1863 $map = $map->customise_for ($self) if $map; 2279 $map = $map->customise_for ($self);
2280 $map = $check->($map) if $check && $map;
2281 } else {
2282 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2283 }
2284
1864 $map 2285 $map
2286 };
2287
2288 if ($@) {
2289 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2290 LOG llevError | logBacktrace, Carp::longmess $@;
1865 } or 2291 }
1866 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1867 2292
2293 if ($gen == $self->{_goto_generation}) {
2294 delete $self->{_goto_generation};
1868 $self->leave_link ($map, $x, $y); 2295 $self->leave_link ($map, $x, $y);
2296 }
1869 })->prio (1); 2297 })->prio (1);
1870} 2298}
1871 2299
1872=item $player_object->enter_exit ($exit_object) 2300=item $player_object->enter_exit ($exit_object)
1873 2301
1912 2340
1913 $rmp->{random_seed} ||= $exit->random_seed; 2341 $rmp->{random_seed} ||= $exit->random_seed;
1914 2342
1915 my $data = cf::to_json $rmp; 2343 my $data = cf::to_json $rmp;
1916 my $md5 = Digest::MD5::md5_hex $data; 2344 my $md5 = Digest::MD5::md5_hex $data;
1917 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2345 my $meta = "$RANDOMDIR/$md5.meta";
1918 2346
1919 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2347 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1920 aio_write $fh, 0, (length $data), $data, 0; 2348 aio_write $fh, 0, (length $data), $data, 0;
1921 undef $fh; 2349 undef $fh;
1922 aio_rename "$meta~", $meta; 2350 aio_rename "$meta~", $meta;
1931 2359
1932 return unless $self->type == cf::PLAYER; 2360 return unless $self->type == cf::PLAYER;
1933 2361
1934 if ($exit->slaying eq "/!") { 2362 if ($exit->slaying eq "/!") {
1935 #TODO: this should de-fi-ni-te-ly not be a sync-job 2363 #TODO: this should de-fi-ni-te-ly not be a sync-job
2364 # the problem is that $exit might not survive long enough
2365 # so it needs to be done right now, right here
1936 cf::sync_job { prepare_random_map $exit }; 2366 cf::sync_job { prepare_random_map $exit };
1937 } 2367 }
1938 2368
1939 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2369 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1940 my $hp = $exit->stats->hp; 2370 my $hp = $exit->stats->hp;
1941 my $sp = $exit->stats->sp; 2371 my $sp = $exit->stats->sp;
1942 2372
1943 $self->enter_link; 2373 $self->enter_link;
2374
2375 # if exit is damned, update players death & WoR home-position
2376 $self->contr->savebed ($slaying, $hp, $sp)
2377 if $exit->flag (FLAG_DAMNED);
1944 2378
1945 (async { 2379 (async {
1946 $self->deactivate_recursive; # just to be sure 2380 $self->deactivate_recursive; # just to be sure
1947 unless (eval { 2381 unless (eval {
1948 $self->goto ($slaying, $hp, $sp); 2382 $self->goto ($slaying, $hp, $sp);
1949 2383
1950 1; 2384 1;
1951 }) { 2385 }) {
1952 $self->message ("Something went wrong deep within the crossfire server. " 2386 $self->message ("Something went wrong deep within the crossfire server. "
1953 . "I'll try to bring you back to the map you were before. " 2387 . "I'll try to bring you back to the map you were before. "
1954 . "Please report this to the dungeon master!", 2388 . "Please report this to the dungeon master!",
1955 cf::NDI_UNIQUE | cf::NDI_RED); 2389 cf::NDI_UNIQUE | cf::NDI_RED);
1956 2390
1957 warn "ERROR in enter_exit: $@"; 2391 warn "ERROR in enter_exit: $@";
1958 $self->leave_link; 2392 $self->leave_link;
1959 } 2393 }
1960 })->prio (1); 2394 })->prio (1);
1973 2407
1974sub cf::client::send_drawinfo { 2408sub cf::client::send_drawinfo {
1975 my ($self, $text, $flags) = @_; 2409 my ($self, $text, $flags) = @_;
1976 2410
1977 utf8::encode $text; 2411 utf8::encode $text;
1978 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2412 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1979} 2413}
1980 2414
2415=item $client->send_msg ($color, $type, $msg, [extra...])
2416
2417Send a drawinfo or msg packet to the client, formatting the msg for the
2418client if neccessary. C<$type> should be a string identifying the type of
2419the message, with C<log> being the default. If C<$color> is negative, suppress
2420the message unless the client supports the msg packet.
2421
2422=cut
2423
2424sub cf::client::send_msg {
2425 my ($self, $color, $type, $msg, @extra) = @_;
2426
2427 $msg = $self->pl->expand_cfpod ($msg);
2428
2429 return unless @extra || length $msg;
2430
2431 if ($self->can_msg) {
2432 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2433 } else {
2434 # replace some tags by gcfclient-compatible ones
2435 for ($msg) {
2436 1 while
2437 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2438 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2439 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2440 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2441 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2442 }
2443
2444 if ($color >= 0) {
2445 if (0 && $msg =~ /\[/) {
2446 $self->send_packet ("drawextinfo $color 4 0 $msg")
2447 } else {
2448 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2449 $self->send_packet ("drawinfo $color $msg")
2450 }
2451 }
2452 }
2453}
2454
2455=item $client->ext_event ($type, %msg)
2456
2457Sends an ext event to the client.
2458
2459=cut
2460
2461sub cf::client::ext_event($$%) {
2462 my ($self, $type, %msg) = @_;
2463
2464 $msg{msgtype} = "event_$type";
2465 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2466}
1981 2467
1982=item $success = $client->query ($flags, "text", \&cb) 2468=item $success = $client->query ($flags, "text", \&cb)
1983 2469
1984Queues a query to the client, calling the given callback with 2470Queues a query to the client, calling the given callback with
1985the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2471the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1986C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2472C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1987 2473
1988Queries can fail, so check the return code. Or don't, as queries will become 2474Queries can fail, so check the return code. Or don't, as queries will
1989reliable at some point in the future. 2475become reliable at some point in the future.
1990 2476
1991=cut 2477=cut
1992 2478
1993sub cf::client::query { 2479sub cf::client::query {
1994 my ($self, $flags, $text, $cb) = @_; 2480 my ($self, $flags, $text, $cb) = @_;
2002 utf8::encode $text; 2488 utf8::encode $text;
2003 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2489 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2004 2490
2005 $self->send_packet ($self->{query_queue}[0][0]) 2491 $self->send_packet ($self->{query_queue}[0][0])
2006 if @{ $self->{query_queue} } == 1; 2492 if @{ $self->{query_queue} } == 1;
2493
2494 1
2007} 2495}
2008 2496
2009cf::client->attach ( 2497cf::client->attach (
2498 on_connect => sub {
2499 my ($ns) = @_;
2500
2501 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2502 },
2010 on_reply => sub { 2503 on_reply => sub {
2011 my ($ns, $msg) = @_; 2504 my ($ns, $msg) = @_;
2012 2505
2013 # this weird shuffling is so that direct followup queries 2506 # this weird shuffling is so that direct followup queries
2014 # get handled first 2507 # get handled first
2026 } else { 2519 } else {
2027 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2520 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2028 } 2521 }
2029 } 2522 }
2030 }, 2523 },
2524 on_exticmd => sub {
2525 my ($ns, $buf) = @_;
2526
2527 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2528
2529 if (ref $msg) {
2530 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2531 if (my %reply = $cb->($ns, $msg)) {
2532 $reply{msgid} = $msg->{msgid};
2533 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2534 }
2535 }
2536 } else {
2537 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2538 }
2539
2540 cf::override;
2541 },
2031); 2542);
2032 2543
2033=item $client->async (\&cb) 2544=item $client->async (\&cb)
2034 2545
2035Create a new coroutine, running the specified callback. The coroutine will 2546Create a new coroutine, running the specified callback. The coroutine will
2082 2593
2083# here we export the classes and methods available to script code 2594# here we export the classes and methods available to script code
2084 2595
2085=pod 2596=pod
2086 2597
2087The following fucntions and emthods are available within a safe environment: 2598The following functions and methods are available within a safe environment:
2088 2599
2089 cf::object contr pay_amount pay_player map 2600 cf::object
2601 contr pay_amount pay_player map x y force_find force_add
2602 insert remove
2603
2090 cf::object::player player 2604 cf::object::player
2091 cf::player peaceful 2605 player
2092 cf::map trigger 2606
2607 cf::player
2608 peaceful
2609
2610 cf::map
2611 trigger
2093 2612
2094=cut 2613=cut
2095 2614
2096for ( 2615for (
2097 ["cf::object" => qw(contr pay_amount pay_player map)], 2616 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2617 insert remove)],
2098 ["cf::object::player" => qw(player)], 2618 ["cf::object::player" => qw(player)],
2099 ["cf::player" => qw(peaceful)], 2619 ["cf::player" => qw(peaceful)],
2100 ["cf::map" => qw(trigger)], 2620 ["cf::map" => qw(trigger)],
2101) { 2621) {
2102 no strict 'refs'; 2622 no strict 'refs';
2173=back 2693=back
2174 2694
2175=cut 2695=cut
2176 2696
2177############################################################################# 2697#############################################################################
2178
2179=head2 EXTENSION DATABASE SUPPORT
2180
2181Crossfire maintains a very simple database for extension use. It can
2182currently store anything that can be serialised using Storable, which
2183excludes objects.
2184
2185The parameter C<$family> should best start with the name of the extension
2186using it, it should be unique.
2187
2188=over 4
2189
2190=item $value = cf::db_get $family => $key
2191
2192Returns a single value from the database.
2193
2194=item cf::db_put $family => $key => $value
2195
2196Stores the given C<$value> in the family.
2197
2198=cut
2199
2200our $DB;
2201
2202sub db_load() {
2203 unless ($DB) {
2204 $DB = BDB::db_create $DB_ENV;
2205
2206 cf::sync_job {
2207 eval {
2208 $DB->set_flags (BDB::CHKSUM);
2209
2210 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2211 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2212 cf::cleanup "db_open(db): $!" if $!;
2213 };
2214 cf::cleanup "db_open(db): $@" if $@;
2215 };
2216
2217 my $path = cf::localdir . "/database.pst";
2218 if (stat $path) {
2219 cf::sync_job {
2220 my $pst = Storable::retrieve $path;
2221
2222 cf::db_put (board => data => $pst->{board});
2223 cf::db_put (guildrules => data => $pst->{guildrules});
2224 cf::db_put (rent => balance => $pst->{rent}{balance});
2225 BDB::db_env_txn_checkpoint $DB_ENV;
2226
2227 unlink $path;
2228 };
2229 }
2230 }
2231}
2232
2233sub db_get($$) {
2234 my $key = "$_[0]/$_[1]";
2235
2236 cf::sync_job {
2237 BDB::db_get $DB, undef, $key, my $data;
2238
2239 $! ? ()
2240 : Compress::LZF::sthaw $data
2241 }
2242}
2243
2244sub db_put($$$) {
2245 BDB::dbreq_pri 4;
2246 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2247}
2248
2249#############################################################################
2250# the server's init and main functions 2698# the server's init and main functions
2251 2699
2252sub load_resources { 2700sub load_facedata($) {
2253 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2701 my ($path) = @_;
2702
2703 warn "loading facedata from $path\n";
2704
2705 my $facedata;
2706 0 < aio_load $path, $facedata
2707 or die "$path: $!";
2708
2709 $facedata = Coro::Storable::thaw $facedata;
2710
2711 $facedata->{version} == 2
2712 or cf::cleanup "$path: version mismatch, cannot proceed.";
2713
2714 {
2715 my $faces = $facedata->{faceinfo};
2716
2717 while (my ($face, $info) = each %$faces) {
2718 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2719 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2720 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2721 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2722 Coro::cede;
2723 }
2724
2725 while (my ($face, $info) = each %$faces) {
2726 next unless $info->{smooth};
2727 my $idx = cf::face::find $face
2728 or next;
2729 if (my $smooth = cf::face::find $info->{smooth}) {
2730 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2731 } else {
2732 warn "smooth face '$info->{smooth}' not found for face '$face'";
2733 }
2734 Coro::cede;
2735 }
2736 }
2737
2738 {
2739 my $anims = $facedata->{animinfo};
2740
2741 while (my ($anim, $info) = each %$anims) {
2742 cf::anim::set $anim, $info->{frames}, $info->{facings};
2743 Coro::cede;
2744 }
2745
2746 cf::anim::invalidate_all; # d'oh
2747 }
2748
2749 1
2750}
2751
2752sub reload_regions {
2753 load_resource_file "$MAPDIR/regions"
2254 or die "unable to load regions file\n";#d# 2754 or die "unable to load regions file\n";
2755}
2756
2757sub reload_facedata {
2758 load_facedata "$DATADIR/facedata"
2759 or die "unable to load facedata\n";
2760}
2761
2762sub reload_archetypes {
2763 load_resource_file "$DATADIR/archetypes"
2764 or die "unable to load archetypes\n";
2765 #d# NEED to laod twice to resolve forward references
2766 # this really needs to be done in an extra post-pass
2767 # (which needs to be synchronous, so solve it differently)
2768 load_resource_file "$DATADIR/archetypes"
2769 or die "unable to load archetypes\n";
2770}
2771
2772sub reload_treasures {
2773 load_resource_file "$DATADIR/treasures"
2774 or die "unable to load treasurelists\n";
2775}
2776
2777sub reload_resources {
2778 warn "reloading resource files...\n";
2779
2780 reload_regions;
2781 reload_facedata;
2782 #reload_archetypes;#d#
2783 reload_archetypes;
2784 reload_treasures;
2785
2786 warn "finished reloading resource files\n";
2787}
2788
2789sub init {
2790 reload_resources;
2255} 2791}
2256 2792
2257sub cfg_load { 2793sub cfg_load {
2258 open my $fh, "<:utf8", cf::confdir . "/config" 2794 open my $fh, "<:utf8", "$CONFDIR/config"
2259 or return; 2795 or return;
2260 2796
2261 local $/; 2797 local $/;
2262 *CFG = YAML::Syck::Load <$fh>; 2798 *CFG = YAML::Syck::Load <$fh>;
2263 2799
2271 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2807 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2272 and die "WARNING: m(un)lockall failed: $!\n"; 2808 and die "WARNING: m(un)lockall failed: $!\n";
2273 }; 2809 };
2274 warn $@ if $@; 2810 warn $@ if $@;
2275 } 2811 }
2276}
2277
2278sub init {
2279 load_resources;
2280} 2812}
2281 2813
2282sub main { 2814sub main {
2283 # we must not ever block the main coroutine 2815 # we must not ever block the main coroutine
2284 local $Coro::idle = sub { 2816 local $Coro::idle = sub {
2287 Event::one_event; 2819 Event::one_event;
2288 })->prio (Coro::PRIO_MAX); 2820 })->prio (Coro::PRIO_MAX);
2289 }; 2821 };
2290 2822
2291 cfg_load; 2823 cfg_load;
2292 db_load; 2824 db_init;
2293 load_extensions; 2825 load_extensions;
2294 2826
2295 $TICK_WATCHER->start; 2827 $TICK_WATCHER->start;
2296 Event::loop; 2828 Event::loop;
2297} 2829}
2312 }, 2844 },
2313 ); 2845 );
2314 } 2846 }
2315} 2847}
2316 2848
2849sub write_runtime {
2850 my $runtime = "$LOCALDIR/runtime";
2851
2852 # first touch the runtime file to show we are still running:
2853 # the fsync below can take a very very long time.
2854
2855 IO::AIO::aio_utime $runtime, undef, undef;
2856
2857 my $guard = cf::lock_acquire "write_runtime";
2858
2859 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2860 or return;
2861
2862 my $value = $cf::RUNTIME + 90 + 10;
2863 # 10 is the runtime save interval, for a monotonic clock
2864 # 60 allows for the watchdog to kill the server.
2865
2866 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2867 and return;
2868
2869 # always fsync - this file is important
2870 aio_fsync $fh
2871 and return;
2872
2873 # touch it again to show we are up-to-date
2874 aio_utime $fh, undef, undef;
2875
2876 close $fh
2877 or return;
2878
2879 aio_rename "$runtime~", $runtime
2880 and return;
2881
2882 warn "runtime file written.\n";
2883
2884 1
2885}
2886
2317sub emergency_save() { 2887sub emergency_save() {
2318 my $freeze_guard = cf::freeze_mainloop; 2888 my $freeze_guard = cf::freeze_mainloop;
2319 2889
2320 warn "enter emergency perl save\n"; 2890 warn "enter emergency perl save\n";
2321 2891
2345 }; 2915 };
2346 2916
2347 warn "leave emergency perl save\n"; 2917 warn "leave emergency perl save\n";
2348} 2918}
2349 2919
2920sub post_cleanup {
2921 my ($make_core) = @_;
2922
2923 warn Carp::longmess "post_cleanup backtrace"
2924 if $make_core;
2925}
2926
2350sub reload() { 2927sub do_reload_perl() {
2351 # can/must only be called in main 2928 # can/must only be called in main
2352 if ($Coro::current != $Coro::main) { 2929 if ($Coro::current != $Coro::main) {
2353 warn "can only reload from main coroutine"; 2930 warn "can only reload from main coroutine";
2354 return; 2931 return;
2355 } 2932 }
2356 2933
2357 warn "reloading..."; 2934 warn "reloading...";
2358 2935
2359 warn "cancelling server ticker"; 2936 warn "entering sync_job";
2360 $TICK_WATCHER->cancel;
2361 2937
2938 cf::sync_job {
2939 cf::write_runtime; # external watchdog should not bark
2362 cf::emergency_save; 2940 cf::emergency_save;
2941 cf::write_runtime; # external watchdog should not bark
2363 2942
2364 eval { 2943 warn "syncing database to disk";
2944 BDB::db_env_txn_checkpoint $DB_ENV;
2945
2365 # if anything goes wrong in here, we should simply crash as we already saved 2946 # if anything goes wrong in here, we should simply crash as we already saved
2366 2947
2367 warn "cancelling all WF_AUTOCANCEL watchers"; 2948 warn "cancelling all WF_AUTOCANCEL watchers";
2368 for (Event::all_watchers) { 2949 for (Event::all_watchers) {
2369 $_->cancel if $_->data & WF_AUTOCANCEL; 2950 $_->cancel if $_->data & WF_AUTOCANCEL;
2370 } 2951 }
2371
2372 warn "syncing database to disk";
2373 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2374 2952
2375 warn "flushing outstanding aio requests"; 2953 warn "flushing outstanding aio requests";
2376 for (;;) { 2954 for (;;) {
2377 BDB::flush; 2955 BDB::flush;
2378 IO::AIO::flush; 2956 IO::AIO::flush;
2379 Coro::cede; 2957 Coro::cede;
2380 last unless IO::AIO::nreqs || BDB::nreqs; 2958 last unless IO::AIO::nreqs || BDB::nreqs;
2381 warn "iterate..."; 2959 warn "iterate...";
2382 } 2960 }
2383 2961
2962 ++$RELOAD;
2963
2384 warn "cancelling all extension coros"; 2964 warn "cancelling all extension coros";
2385 $_->cancel for values %EXT_CORO; 2965 $_->cancel for values %EXT_CORO;
2386 %EXT_CORO = (); 2966 %EXT_CORO = ();
2387 2967
2388 warn "removing commands"; 2968 warn "removing commands";
2389 %COMMAND = (); 2969 %COMMAND = ();
2390 2970
2391 warn "removing ext commands"; 2971 warn "removing ext/exti commands";
2392 %EXTCMD = (); 2972 %EXTCMD = ();
2973 %EXTICMD = ();
2393 2974
2394 warn "unloading/nuking all extensions"; 2975 warn "unloading/nuking all extensions";
2395 for my $pkg (@EXTS) { 2976 for my $pkg (@EXTS) {
2396 warn "... unloading $pkg"; 2977 warn "... unloading $pkg";
2397 2978
2427 Symbol::delete_package "safe::$_" 3008 Symbol::delete_package "safe::$_"
2428 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3009 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2429 3010
2430 warn "unloading cf.pm \"a bit\""; 3011 warn "unloading cf.pm \"a bit\"";
2431 delete $INC{"cf.pm"}; 3012 delete $INC{"cf.pm"};
3013 delete $INC{"cf/pod.pm"};
2432 3014
2433 # don't, removes xs symbols, too, 3015 # don't, removes xs symbols, too,
2434 # and global variables created in xs 3016 # and global variables created in xs
2435 #Symbol::delete_package __PACKAGE__; 3017 #Symbol::delete_package __PACKAGE__;
2436 3018
2440 require cf; 3022 require cf;
2441 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3023 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2442 3024
2443 warn "loading config and database again"; 3025 warn "loading config and database again";
2444 cf::cfg_load; 3026 cf::cfg_load;
2445 cf::db_load;
2446 3027
2447 warn "loading extensions"; 3028 warn "loading extensions";
2448 cf::load_extensions; 3029 cf::load_extensions;
2449 3030
2450 warn "reattaching attachments to objects/players"; 3031 warn "reattaching attachments to objects/players";
2451 _global_reattach; 3032 _global_reattach; # objects, sockets
2452 warn "reattaching attachments to maps"; 3033 warn "reattaching attachments to maps";
2453 reattach $_ for values %MAP; 3034 reattach $_ for values %MAP;
3035 warn "reattaching attachments to players";
3036 reattach $_ for values %PLAYER;
2454 3037
2455 warn "loading reloadable resources"; 3038 warn "leaving sync_job";
2456 load_resources;
2457 3039
2458 warn "restarting server ticker"; 3040 1
2459 3041 } or do {
2460 $TICK_WATCHER->start;
2461 };
2462
2463 if ($@) {
2464 warn $@; 3042 warn $@;
2465 warn "error while reloading, exiting."; 3043 warn "error while reloading, exiting.";
2466 exit 1; 3044 exit 1;
2467 } 3045 };
2468 3046
2469 warn "reloaded"; 3047 warn "reloaded";
2470}; 3048};
2471 3049
2472our $RELOAD_WATCHER; # used only during reload 3050our $RELOAD_WATCHER; # used only during reload
2473 3051
3052sub reload_perl() {
3053 # doing reload synchronously and two reloads happen back-to-back,
3054 # coro crashes during coro_state_free->destroy here.
3055
3056 $RELOAD_WATCHER ||= Event->timer (
3057 reentrant => 0,
3058 after => 0,
3059 data => WF_AUTOCANCEL,
3060 cb => sub {
3061 do_reload_perl;
3062 undef $RELOAD_WATCHER;
3063 },
3064 );
3065}
3066
2474register_command "reload" => sub { 3067register_command "reload" => sub {
2475 my ($who, $arg) = @_; 3068 my ($who, $arg) = @_;
2476 3069
2477 if ($who->flag (FLAG_WIZ)) { 3070 if ($who->flag (FLAG_WIZ)) {
2478 $who->message ("reloading server."); 3071 $who->message ("reloading server.");
2479 3072 async { reload_perl };
2480 # doing reload synchronously and two reloads happen back-to-back,
2481 # coro crashes during coro_state_free->destroy here.
2482
2483 $RELOAD_WATCHER ||= Event->timer (
2484 reentrant => 0,
2485 after => 0,
2486 data => WF_AUTOCANCEL,
2487 cb => sub {
2488 reload;
2489 undef $RELOAD_WATCHER;
2490 },
2491 );
2492 } 3073 }
2493}; 3074};
2494 3075
2495unshift @INC, $LIBDIR; 3076unshift @INC, $LIBDIR;
2496 3077
2497my $bug_warning = 0; 3078my $bug_warning = 0;
2498 3079
3080our @WAIT_FOR_TICK;
3081our @WAIT_FOR_TICK_BEGIN;
3082
3083sub wait_for_tick {
3084 return unless $TICK_WATCHER->is_active;
3085 return if $Coro::current == $Coro::main;
3086
3087 my $signal = new Coro::Signal;
3088 push @WAIT_FOR_TICK, $signal;
3089 $signal->wait;
3090}
3091
3092sub wait_for_tick_begin {
3093 return unless $TICK_WATCHER->is_active;
3094 return if $Coro::current == $Coro::main;
3095
3096 my $signal = new Coro::Signal;
3097 push @WAIT_FOR_TICK_BEGIN, $signal;
3098 $signal->wait;
3099}
3100
3101 my $min = 1e6;#d#
3102 my $avg = 10;
2499$TICK_WATCHER = Event->timer ( 3103$TICK_WATCHER = Event->timer (
2500 reentrant => 0, 3104 reentrant => 0,
2501 parked => 1, 3105 parked => 1,
2502 prio => 0, 3106 prio => 0,
2503 at => $NEXT_TICK || $TICK, 3107 at => $NEXT_TICK || $TICK,
2507 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3111 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2508 unless ++$bug_warning > 10; 3112 unless ++$bug_warning > 10;
2509 return; 3113 return;
2510 } 3114 }
2511 3115
2512 $NOW = Event::time; 3116 $NOW = $tick_start = Event::time;
2513 3117
2514 cf::server_tick; # one server iteration 3118 cf::server_tick; # one server iteration
3119
3120 0 && sync_job {#d#
3121 for(1..10) {
3122 my $t = Event::time;
3123 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3124 or die;
3125
3126 $map->width (50);
3127 $map->height (50);
3128 $map->alloc;
3129 $map->_load_objects ("/tmp/x.map", 1);
3130 my $t = Event::time - $t;
3131
3132 #next unless $t < 0.0013;#d#
3133 if ($t < $min) {
3134 $min = $t;
3135 }
3136 $avg = $avg * 0.99 + $t * 0.01;
3137 }
3138 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3139 exit 0;
3140 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3141 };
3142
2515 $RUNTIME += $TICK; 3143 $RUNTIME += $TICK;
2516 $NEXT_TICK += $TICK; 3144 $NEXT_TICK += $TICK;
2517 3145
2518 $WAIT_FOR_TICK->broadcast; 3146 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2519 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3147 $NEXT_RUNTIME_WRITE = $NOW + 10;
2520 3148 Coro::async_pool {
2521 Event::sweep; 3149 write_runtime
2522 Coro::cede_notself; 3150 or warn "ERROR: unable to write runtime file: $!";
3151 };
2523 3152 }
3153
2524# my $AFTER = Event::time; 3154# my $AFTER = Event::time;
2525# warn $AFTER - $NOW;#d# 3155# warn $AFTER - $NOW;#d#
2526 3156
3157 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3158 $sig->send;
3159 }
3160 while (my $sig = shift @WAIT_FOR_TICK) {
3161 $sig->send;
3162 }
3163
3164 $NOW = Event::time;
3165
2527 # if we are delayed by four ticks or more, skip them all 3166 # if we are delayed by four ticks or more, skip them all
2528 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3167 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2529 3168
2530 $TICK_WATCHER->at ($NEXT_TICK); 3169 $TICK_WATCHER->at ($NEXT_TICK);
2531 $TICK_WATCHER->start; 3170 $TICK_WATCHER->start;
3171
3172 $LOAD = ($NOW - $tick_start) / $TICK;
3173 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3174
3175 _post_tick;
3176
3177
2532 }, 3178 },
2533); 3179);
2534 3180
2535{ 3181{
2536 BDB::max_poll_time $TICK * 0.1; 3182 BDB::max_poll_time $TICK * 0.1;
2564 3210
2565 cf::sync_job { 3211 cf::sync_job {
2566 eval { 3212 eval {
2567 BDB::db_env_open 3213 BDB::db_env_open
2568 $DB_ENV, 3214 $DB_ENV,
2569 $BDB_ENV_DIR, 3215 $BDBDIR,
2570 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3216 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2571 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3217 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2572 0666; 3218 0666;
2573 3219
2574 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3220 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2575 3221
2576 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3222 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2577 $DB_ENV->set_lk_detect; 3223 $DB_ENV->set_lk_detect;
2578 }; 3224 };
2579 3225
2587 3233
2588 undef $Coro::AIO::WATCHER; 3234 undef $Coro::AIO::WATCHER;
2589 IO::AIO::max_poll_time $TICK * 0.1; 3235 IO::AIO::max_poll_time $TICK * 0.1;
2590 $AIO_POLL_WATCHER = Event->io ( 3236 $AIO_POLL_WATCHER = Event->io (
2591 reentrant => 0, 3237 reentrant => 0,
3238 data => WF_AUTOCANCEL,
2592 fd => IO::AIO::poll_fileno, 3239 fd => IO::AIO::poll_fileno,
2593 poll => 'r', 3240 poll => 'r',
2594 prio => 6, 3241 prio => 6,
2595 data => WF_AUTOCANCEL,
2596 cb => \&IO::AIO::poll_cb, 3242 cb => \&IO::AIO::poll_cb,
2597 ); 3243 );
2598} 3244}
2599 3245
2600$WRITE_RUNTIME_WATCHER = Event->timer ( 3246my $_log_backtrace;
2601 reentrant => 0, 3247
2602 data => WF_AUTOCANCEL, 3248sub _log_backtrace {
2603 after => 1, 3249 my ($msg, @addr) = @_;
2604 interval => 10, 3250
2605 prio => 6, # keep it lowest so it acts like a watchdog 3251 $msg =~ s/\n//;
2606 cb => Coro::unblock_sub { 3252
2607 write_runtime 3253 # limit the # of concurrent backtraces
2608 or warn "ERROR: unable to write runtime file: $!"; 3254 if ($_log_backtrace < 2) {
3255 ++$_log_backtrace;
3256 async {
3257 my @bt = fork_call {
3258 @addr = map { sprintf "%x", $_ } @addr;
3259 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3260 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3261 or die "addr2line: $!";
3262
3263 my @funcs;
3264 my @res = <$fh>;
3265 chomp for @res;
3266 while (@res) {
3267 my ($func, $line) = splice @res, 0, 2, ();
3268 push @funcs, "[$func] $line";
3269 }
3270
3271 @funcs
3272 };
3273
3274 LOG llevInfo, "[ABT] $msg\n";
3275 LOG llevInfo, "[ABT] $_\n" for @bt;
3276 --$_log_backtrace;
3277 };
3278 } else {
3279 LOG llevInfo, "[ABT] $msg\n";
3280 LOG llevInfo, "[ABT] [suppressed]\n";
2609 }, 3281 }
2610); 3282}
3283
3284# load additional modules
3285use cf::pod;
2611 3286
2612END { cf::emergency_save } 3287END { cf::emergency_save }
2613 3288
26141 32891
2615 3290

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines