ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.211 by root, Tue Feb 13 16:23:32 2007 UTC vs.
Revision 1.301 by root, Tue Jul 10 07:01:51 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 $TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
362 406
363 my $runtime = cf::localdir . "/runtime"; 407Executes the given code block with the given arguments in a seperate
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.
364 411
365 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 412=cut
366 or return;
367 413
368 my $value = $cf::RUNTIME + 90 + 10; 414sub _store_scalar {
369 # 10 is the runtime save interval, for a monotonic clock 415 open my $fh, ">", \my $buf
370 # 60 allows for the watchdog to kill the server. 416 or die "fork_call: cannot open fh-to-buf in child : $!";
371 417 Storable::store_fd $_[0], $fh;
372 (aio_write $fh, 0, (length $value), $value, 0) <= 0
373 and return;
374
375 # always fsync - this file is important
376 aio_fsync $fh
377 and return;
378
379 close $fh 418 close $fh;
380 or return;
381 419
382 aio_rename "$runtime~", $runtime 420 $buf
383 and return; 421}
384 422
423sub fork_call(&@) {
424 my ($cb, @args) = @_;
425
426# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
427# or die "socketpair: $!";
428 pipe my $fh1, my $fh2
429 or die "pipe: $!";
430
431 if (my $pid = fork) {
432 close $fh2;
433
434 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
435 warn "pst<$res>" unless $res =~ /^pst/;
436 $res = Coro::Storable::thaw $res;
437
438 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
439
440 Carp::confess $$res unless "ARRAY" eq ref $res;
441
442 return wantarray ? @$res : $res->[-1];
443 } else {
444 reset_signals;
445 local $SIG{__WARN__};
446 local $SIG{__DIE__};
447 # just in case, this hack effectively disables event
448 # in the child. cleaner and slower would be canceling all watchers,
449 # but this works for the time being.
450 local $Coro::idle;
451 $Coro::current->prio (Coro::PRIO_MAX);
452
453 eval {
454 close $fh1;
455
456 my @res = eval { $cb->(@args) };
457
458 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
459 close $fh2;
460 };
461
462 warn $@ if $@;
463 _exit 0;
385 1 464 }
465}
466
467=item $value = cf::db_get $family => $key
468
469Returns a single value from the environment database.
470
471=item cf::db_put $family => $key => $value
472
473Stores the given C<$value> in the family. It can currently store binary
474data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
475
476=cut
477
478our $DB;
479
480sub db_init {
481 unless ($DB) {
482 $DB = BDB::db_create $DB_ENV;
483
484 cf::sync_job {
485 eval {
486 $DB->set_flags (BDB::CHKSUM);
487
488 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
489 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
490 cf::cleanup "db_open(db): $!" if $!;
491 };
492 cf::cleanup "db_open(db): $@" if $@;
493 };
494 }
495}
496
497sub db_get($$) {
498 my $key = "$_[0]/$_[1]";
499
500 cf::sync_job {
501 BDB::db_get $DB, undef, $key, my $data;
502
503 $! ? ()
504 : $data
505 }
506}
507
508sub db_put($$$) {
509 BDB::dbreq_pri 4;
510 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
511}
512
513=item cf::cache $id => [$paths...], $processversion => $process
514
515Generic caching function that returns the value of the resource $id,
516caching and regenerating as required.
517
518This function can block.
519
520=cut
521
522sub cache {
523 my ($id, $src, $processversion, $process) = @_;
524
525 my $meta =
526 join "\x00",
527 $processversion,
528 map {
529 aio_stat $_
530 and Carp::croak "$_: $!";
531
532 ($_, (stat _)[7,9])
533 } @$src;
534
535 my $dbmeta = db_get cache => "$id/meta";
536 if ($dbmeta ne $meta) {
537 # changed, we may need to process
538
539 my @data;
540 my $md5;
541
542 for (0 .. $#$src) {
543 0 <= aio_load $src->[$_], $data[$_]
544 or Carp::croak "$src->[$_]: $!";
545 }
546
547 # if processing is expensive, check
548 # checksum first
549 if (1) {
550 $md5 =
551 join "\x00",
552 $processversion,
553 map {
554 Coro::cede;
555 ($src->[$_], Digest::MD5::md5_hex $data[$_])
556 } 0.. $#$src;
557
558
559 my $dbmd5 = db_get cache => "$id/md5";
560 if ($dbmd5 eq $md5) {
561 db_put cache => "$id/meta", $meta;
562
563 return db_get cache => "$id/data";
564 }
565 }
566
567 my $t1 = Time::HiRes::time;
568 my $data = $process->(\@data);
569 my $t2 = Time::HiRes::time;
570
571 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
572
573 db_put cache => "$id/data", $data;
574 db_put cache => "$id/md5" , $md5;
575 db_put cache => "$id/meta", $meta;
576
577 return $data;
578 }
579
580 db_get cache => "$id/data"
581}
582
583=item cf::datalog type => key => value, ...
584
585Log a datalog packet of the given type with the given key-value pairs.
586
587=cut
588
589sub datalog($@) {
590 my ($type, %kv) = @_;
591 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
386} 592}
387 593
388=back 594=back
389 595
390=cut 596=cut
397attach callbacks/event handlers (a collection of which is called an "attachment") 603attach callbacks/event handlers (a collection of which is called an "attachment")
398to it. All such attachable objects support the following methods. 604to it. All such attachable objects support the following methods.
399 605
400In the following description, CLASS can be any of C<global>, C<object> 606In the following description, CLASS can be any of C<global>, C<object>
401C<player>, C<client> or C<map> (i.e. the attachable objects in 607C<player>, C<client> or C<map> (i.e. the attachable objects in
402crossfire+). 608Crossfire TRT).
403 609
404=over 4 610=over 4
405 611
406=item $attachable->attach ($attachment, key => $value...) 612=item $attachable->attach ($attachment, key => $value...)
407 613
570 $registry = $CB_TYPE[$object_type] ||= []; 776 $registry = $CB_TYPE[$object_type] ||= [];
571 777
572 } elsif ($type eq "subtype") { 778 } elsif ($type eq "subtype") {
573 defined $object_type or Carp::croak "subtype specified without type"; 779 defined $object_type or Carp::croak "subtype specified without type";
574 my $object_subtype = shift @arg; 780 my $object_subtype = shift @arg;
575 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 781 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
576 782
577 } elsif ($type eq "package") { 783 } elsif ($type eq "package") {
578 my $pkg = shift @arg; 784 my $pkg = shift @arg;
579 785
580 while (my ($name, $id) = each %cb_id) { 786 while (my ($name, $id) = each %cb_id) {
609 _attach $registry, $klass, @attach; 815 _attach $registry, $klass, @attach;
610 } 816 }
611 817
612 $obj->{$name} = \%arg; 818 $obj->{$name} = \%arg;
613 } else { 819 } else {
614 warn "object uses attachment '$name' that is not available, postponing.\n"; 820 warn "object uses attachment '$name' which is not available, postponing.\n";
615 } 821 }
616 822
617 $obj->{_attachment}{$name} = undef; 823 $obj->{_attachment}{$name} = undef;
618} 824}
619 825
621 if (ref $_[0]) { 827 if (ref $_[0]) {
622 _object_attach @_; 828 _object_attach @_;
623 } else { 829 } else {
624 _attach shift->_attach_registry, @_; 830 _attach shift->_attach_registry, @_;
625 } 831 }
832 _recalc_want;
626}; 833};
627 834
628# all those should be optimised 835# all those should be optimised
629sub cf::attachable::detach { 836sub cf::attachable::detach {
630 my ($obj, $name) = @_; 837 my ($obj, $name) = @_;
633 delete $obj->{_attachment}{$name}; 840 delete $obj->{_attachment}{$name};
634 reattach ($obj); 841 reattach ($obj);
635 } else { 842 } else {
636 Carp::croak "cannot, currently, detach class attachments"; 843 Carp::croak "cannot, currently, detach class attachments";
637 } 844 }
845 _recalc_want;
638}; 846};
639 847
640sub cf::attachable::attached { 848sub cf::attachable::attached {
641 my ($obj, $name) = @_; 849 my ($obj, $name) = @_;
642 850
789 } 997 }
790 } else { 998 } else {
791 aio_unlink $filename; 999 aio_unlink $filename;
792 aio_unlink "$filename.pst"; 1000 aio_unlink "$filename.pst";
793 } 1001 }
794
795 #d##TODO# nuke non .map-files if exist
796 if ($filename =~ s/\.map$//) {
797 aio_unlink $filename;
798 aio_unlink "$filename.pst";
799 }
800 } 1002 }
801} 1003}
802 1004
803sub object_freezer_as_string { 1005sub object_freezer_as_string {
804 my ($rdata, $objs) = @_; 1006 my ($rdata, $objs) = @_;
810 1012
811sub object_thawer_load { 1013sub object_thawer_load {
812 my ($filename) = @_; 1014 my ($filename) = @_;
813 1015
814 my ($data, $av); 1016 my ($data, $av);
815
816 #d#TODO remove .map if file does not exist
817 aio_stat $filename and $filename =~ s/\.map$//;
818 1017
819 (aio_load $filename, $data) >= 0 1018 (aio_load $filename, $data) >= 0
820 or return; 1019 or return;
821 1020
822 unless (aio_stat "$filename.pst") { 1021 unless (aio_stat "$filename.pst") {
824 or return; 1023 or return;
825 $av = eval { (Storable::thaw $av)->{objs} }; 1024 $av = eval { (Storable::thaw $av)->{objs} };
826 } 1025 }
827 1026
828 warn sprintf "loading %s (%d)\n", 1027 warn sprintf "loading %s (%d)\n",
829 $filename, length $data, scalar @{$av || []};#d# 1028 $filename, length $data, scalar @{$av || []};
830 return ($data, $av); 1029 return ($data, $av);
831} 1030}
1031
1032=head2 COMMAND CALLBACKS
1033
1034=over 4
1035
1036=cut
832 1037
833############################################################################# 1038#############################################################################
834# command handling &c 1039# command handling &c
835 1040
836=item cf::register_command $name => \&callback($ob,$args); 1041=item cf::register_command $name => \&callback($ob,$args);
849 push @{ $COMMAND{$name} }, [$caller, $cb]; 1054 push @{ $COMMAND{$name} }, [$caller, $cb];
850} 1055}
851 1056
852=item cf::register_extcmd $name => \&callback($pl,$packet); 1057=item cf::register_extcmd $name => \&callback($pl,$packet);
853 1058
854Register a callbackf ro execution when the client sends an extcmd packet. 1059Register a callback for execution when the client sends an (synchronous)
1060extcmd packet. Ext commands will be processed in the order they are
1061received by the server, like other user commands. The first argument is
1062the logged-in player. Ext commands can only be processed after a player
1063has logged in successfully.
855 1064
856If the callback returns something, it is sent back as if reply was being 1065If the callback returns something, it is sent back as if reply was being
857called. 1066called.
858 1067
1068=item cf::register_exticmd $name => \&callback($ns,$packet);
1069
1070Register a callback for execution when the client sends an (asynchronous)
1071exticmd packet. Exti commands are processed by the server as soon as they
1072are received, i.e. out of order w.r.t. other commands. The first argument
1073is a client socket. Exti commands can be received anytime, even before
1074log-in.
1075
1076If the callback returns something, it is sent back as if reply was being
1077called.
1078
859=cut 1079=cut
860 1080
861sub register_extcmd { 1081sub register_extcmd {
862 my ($name, $cb) = @_; 1082 my ($name, $cb) = @_;
863 1083
864 $EXTCMD{$name} = $cb; 1084 $EXTCMD{$name} = $cb;
1085}
1086
1087sub register_exticmd {
1088 my ($name, $cb) = @_;
1089
1090 $EXTICMD{$name} = $cb;
865} 1091}
866 1092
867cf::player->attach ( 1093cf::player->attach (
868 on_command => sub { 1094 on_command => sub {
869 my ($pl, $name, $params) = @_; 1095 my ($pl, $name, $params) = @_;
878 cf::override; 1104 cf::override;
879 }, 1105 },
880 on_extcmd => sub { 1106 on_extcmd => sub {
881 my ($pl, $buf) = @_; 1107 my ($pl, $buf) = @_;
882 1108
883 my $msg = eval { from_json $buf }; 1109 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
884 1110
885 if (ref $msg) { 1111 if (ref $msg) {
886 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1112 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
887 if (my %reply = $cb->($pl, $msg)) { 1113 if (my %reply = $cb->($pl, $msg)) {
888 $pl->ext_reply ($msg->{msgid}, %reply); 1114 $pl->ext_reply ($msg->{msgid}, %reply);
894 1120
895 cf::override; 1121 cf::override;
896 }, 1122 },
897); 1123);
898 1124
899sub load_extension {
900 my ($path) = @_;
901
902 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
903 my $base = $1;
904 my $pkg = $1;
905 $pkg =~ s/[^[:word:]]/_/g;
906 $pkg = "ext::$pkg";
907
908 warn "... loading '$path' into '$pkg'\n";
909
910 open my $fh, "<:utf8", $path
911 or die "$path: $!";
912
913 my $source =
914 "package $pkg; use strict; use utf8;\n"
915 . "#line 1 \"$path\"\n{\n"
916 . (do { local $/; <$fh> })
917 . "\n};\n1";
918
919 unless (eval $source) {
920 my $msg = $@ ? "$path: $@\n"
921 : "extension disabled.\n";
922 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
923 warn $@;
924 warn "mandatory extension failed to load, exiting.\n";
925 exit 1;
926 }
927 die $@;
928 }
929
930 push @EXTS, $pkg;
931}
932
933sub load_extensions { 1125sub load_extensions {
1126 cf::sync_job {
1127 my %todo;
1128
934 for my $ext (<$LIBDIR/*.ext>) { 1129 for my $path (<$LIBDIR/*.ext>) {
935 next unless -r $ext; 1130 next unless -r $path;
936 eval { 1131
937 load_extension $ext; 1132 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1133 my $base = $1;
1134 my $pkg = $1;
1135 $pkg =~ s/[^[:word:]]/_/g;
1136 $pkg = "ext::$pkg";
1137
1138 open my $fh, "<:utf8", $path
1139 or die "$path: $!";
1140
1141 my $source = do { local $/; <$fh> };
1142
1143 my %ext = (
1144 path => $path,
1145 base => $base,
1146 pkg => $pkg,
1147 );
1148
1149 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1150 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1151
1152 $ext{source} =
1153 "package $pkg; use strict; use utf8;\n"
1154 . "#line 1 \"$path\"\n{\n"
1155 . $source
1156 . "\n};\n1";
1157
1158 $todo{$base} = \%ext;
1159 }
1160
1161 my %done;
1162 while (%todo) {
1163 my $progress;
1164
1165 while (my ($k, $v) = each %todo) {
1166 for (split /,\s*/, $v->{meta}{depends}) {
1167 goto skip
1168 unless exists $done{$_};
1169 }
1170
1171 warn "... loading '$k' into '$v->{pkg}'\n";
1172
1173 unless (eval $v->{source}) {
1174 my $msg = $@ ? "$v->{path}: $@\n"
1175 : "$v->{base}: extension inactive.\n";
1176
1177 if (exists $v->{meta}{mandatory}) {
1178 warn $msg;
1179 warn "mandatory extension failed to load, exiting.\n";
1180 exit 1;
1181 }
1182
1183 warn $msg;
1184 }
1185
1186 $done{$k} = delete $todo{$k};
1187 push @EXTS, $v->{pkg};
1188 $progress = 1;
938 1 1189 }
939 } or warn "$ext not loaded: $@"; 1190
1191 skip:
1192 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1193 unless $progress;
1194 }
940 } 1195 };
941} 1196}
942 1197
943############################################################################# 1198#############################################################################
944 1199
1200=back
1201
945=head2 CORE EXTENSIONS 1202=head2 CORE EXTENSIONS
946 1203
947Functions and methods that extend core crossfire objects. 1204Functions and methods that extend core crossfire objects.
948 1205
949=cut 1206=cut
961Returns the given player object, loading it if necessary (might block). 1218Returns the given player object, loading it if necessary (might block).
962 1219
963=cut 1220=cut
964 1221
965sub playerdir($) { 1222sub playerdir($) {
966 cf::localdir 1223 "$PLAYERDIR/"
967 . "/"
968 . cf::playerdir
969 . "/"
970 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1224 . (ref $_[0] ? $_[0]->ob->name : $_[0])
971} 1225}
972 1226
973sub path($) { 1227sub path($) {
974 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1228 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
975 1229
976 (playerdir $login) . "/$login.pl" 1230 (playerdir $login) . "/playerdata"
977} 1231}
978 1232
979sub find_active($) { 1233sub find_active($) {
980 $cf::PLAYER{$_[0]} 1234 $cf::PLAYER{$_[0]}
981 and $cf::PLAYER{$_[0]}->active 1235 and $cf::PLAYER{$_[0]}->active
994 my $login = $_[0]; 1248 my $login = $_[0];
995 1249
996 my $guard = cf::lock_acquire "user_find:$login"; 1250 my $guard = cf::lock_acquire "user_find:$login";
997 1251
998 $cf::PLAYER{$_[0]} || do { 1252 $cf::PLAYER{$_[0]} || do {
1253 # rename old playerfiles to new ones
1254 #TODO: remove when no longer required
1255 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1256 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1257 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1258 aio_unlink +(playerdir $login) . "/$login.pl";
1259
999 my $pl = load_pl path $login 1260 my $pl = load_pl path $login
1000 or return; 1261 or return;
1001 $cf::PLAYER{$login} = $pl 1262 $cf::PLAYER{$login} = $pl
1002 } 1263 }
1003 } 1264 }
1040 1301
1041=cut 1302=cut
1042 1303
1043sub quit_character { 1304sub quit_character {
1044 my ($pl) = @_; 1305 my ($pl) = @_;
1306
1307 my $name = $pl->ob->name;
1045 1308
1046 $pl->{deny_save} = 1; 1309 $pl->{deny_save} = 1;
1047 $pl->password ("*"); # this should lock out the player until we nuked the dir 1310 $pl->password ("*"); # this should lock out the player until we nuked the dir
1048 1311
1049 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1312 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1054 my $path = playerdir $pl; 1317 my $path = playerdir $pl;
1055 my $temp = "$path~$cf::RUNTIME~deleting~"; 1318 my $temp = "$path~$cf::RUNTIME~deleting~";
1056 aio_rename $path, $temp; 1319 aio_rename $path, $temp;
1057 delete $cf::PLAYER{$pl->ob->name}; 1320 delete $cf::PLAYER{$pl->ob->name};
1058 $pl->destroy; 1321 $pl->destroy;
1322
1323 my $prefix = qr<^~\Q$name\E/>;
1324
1325 # nuke player maps
1326 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1327
1059 IO::AIO::aio_rmtree $temp; 1328 IO::AIO::aio_rmtree $temp;
1329}
1330
1331=item $pl->kick
1332
1333Kicks a player out of the game. This destroys the connection.
1334
1335=cut
1336
1337sub kick {
1338 my ($pl, $kicker) = @_;
1339
1340 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1341 $pl->killer ("kicked");
1342 $pl->ns->destroy;
1060} 1343}
1061 1344
1062=item cf::player::list_logins 1345=item cf::player::list_logins
1063 1346
1064Returns am arrayref of all valid playernames in the system, can take a 1347Returns am arrayref of all valid playernames in the system, can take a
1065while and may block, so not sync_job-capable, ever. 1348while and may block, so not sync_job-capable, ever.
1066 1349
1067=cut 1350=cut
1068 1351
1069sub list_logins { 1352sub list_logins {
1070 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1353 my $dirs = aio_readdir $PLAYERDIR
1071 or return []; 1354 or return [];
1072 1355
1073 my @logins; 1356 my @logins;
1074 1357
1075 for my $login (@$dirs) { 1358 for my $login (@$dirs) {
1110 } 1393 }
1111 1394
1112 \@paths 1395 \@paths
1113} 1396}
1114 1397
1398=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1399
1400Expand crossfire pod fragments into protocol xml.
1401
1402=cut
1403
1404sub expand_cfpod {
1405 ((my $self), (local $_)) = @_;
1406
1407 # escape & and <
1408 s/&/&amp;/g;
1409 s/(?<![BIUGH])</&lt;/g;
1410
1411 # this is buggy, it needs to properly take care of nested <'s
1412
1413 1 while
1414 # replace B<>, I<>, U<> etc.
1415 s/B<([^\>]*)>/<b>$1<\/b>/
1416 || s/I<([^\>]*)>/<i>$1<\/i>/
1417 || s/U<([^\>]*)>/<u>$1<\/u>/
1418 # replace G<male|female> tags
1419 || s{G<([^>|]*)\|([^>]*)>}{
1420 $self->gender ? $2 : $1
1421 }ge
1422 # replace H<hint text>
1423 || s{H<([^\>]*)>}
1424 {
1425 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1426 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1427 "")
1428 [$self->{hintmode}]
1429 }ge;
1430
1431 # create single paragraphs (very hackish)
1432 s/(?<=\S)\n(?=\w)/ /g;
1433
1434 # compress some whitespace
1435 s/\s+\n/\n/g; # ws line-ends
1436 s/\n\n+/\n/g; # double lines
1437 s/^\n+//; # beginning lines
1438 s/\n+$//; # ending lines
1439
1440 $_
1441}
1442
1443sub hintmode {
1444 $_[0]{hintmode} = $_[1] if @_ > 1;
1445 $_[0]{hintmode}
1446}
1447
1115=item $player->ext_reply ($msgid, $msgtype, %msg) 1448=item $player->ext_reply ($msgid, %msg)
1116 1449
1117Sends an ext reply to the player. 1450Sends an ext reply to the player.
1118 1451
1119=cut 1452=cut
1120 1453
1121sub ext_reply($$$%) { 1454sub ext_reply($$%) {
1122 my ($self, $id, %msg) = @_; 1455 my ($self, $id, %msg) = @_;
1123 1456
1124 $msg{msgid} = $id; 1457 $msg{msgid} = $id;
1125 1458 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1126 $self->send ("ext " . cf::to_json \%msg);
1127} 1459}
1128 1460
1129package cf; 1461=item $player->ext_event ($type, %msg)
1462
1463Sends an ext event to the client.
1464
1465=cut
1466
1467sub ext_event($$%) {
1468 my ($self, $type, %msg) = @_;
1469
1470 $self->ns->ext_event ($type, %msg);
1471}
1472
1473=head3 cf::region
1474
1475=over 4
1476
1477=cut
1478
1479package cf::region;
1480
1481=item cf::region::find_by_path $path
1482
1483Tries to decuce the likely region for a map knowing only its path.
1484
1485=cut
1486
1487sub find_by_path($) {
1488 my ($path) = @_;
1489
1490 my ($match, $specificity);
1491
1492 for my $region (list) {
1493 if ($region->match && $path =~ $region->match) {
1494 ($match, $specificity) = ($region, $region->specificity)
1495 if $region->specificity > $specificity;
1496 }
1497 }
1498
1499 $match
1500}
1130 1501
1131=back 1502=back
1132
1133 1503
1134=head3 cf::map 1504=head3 cf::map
1135 1505
1136=over 4 1506=over 4
1137 1507
1192 my ($self, $merge) = @_; 1562 my ($self, $merge) = @_;
1193 1563
1194 # we have to keep some variables in memory intact 1564 # we have to keep some variables in memory intact
1195 local $self->{path}; 1565 local $self->{path};
1196 local $self->{load_path}; 1566 local $self->{load_path};
1197 local $self->{deny_save};
1198 local $self->{deny_reset};
1199 1567
1200 $self->SUPER::thawer_merge ($merge); 1568 $self->SUPER::thawer_merge ($merge);
1201} 1569}
1202 1570
1203sub normalise { 1571sub normalise {
1275 1643
1276# the original (read-only) location 1644# the original (read-only) location
1277sub load_path { 1645sub load_path {
1278 my ($self) = @_; 1646 my ($self) = @_;
1279 1647
1280 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1648 "$MAPDIR/$self->{path}.map"
1281} 1649}
1282 1650
1283# the temporary/swap location 1651# the temporary/swap location
1284sub save_path { 1652sub save_path {
1285 my ($self) = @_; 1653 my ($self) = @_;
1286 1654
1287 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1655 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1288 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1656 "$TMPDIR/$path.map"
1289} 1657}
1290 1658
1291# the unique path, undef == no special unique path 1659# the unique path, undef == no special unique path
1292sub uniq_path { 1660sub uniq_path {
1293 my ($self) = @_; 1661 my ($self) = @_;
1294 1662
1295 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1663 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1296 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1664 "$UNIQUEDIR/$path"
1297} 1665}
1298 1666
1299# and all this just because we cannot iterate over 1667# and all this just because we cannot iterate over
1300# all maps in C++... 1668# all maps in C++...
1301sub change_all_map_light { 1669sub change_all_map_light {
1303 1671
1304 $_->change_map_light ($change) 1672 $_->change_map_light ($change)
1305 for grep $_->outdoor, values %cf::MAP; 1673 for grep $_->outdoor, values %cf::MAP;
1306} 1674}
1307 1675
1676sub decay_objects {
1677 my ($self) = @_;
1678
1679 return if $self->{deny_reset};
1680
1681 $self->do_decay_objects;
1682}
1683
1308sub unlink_save { 1684sub unlink_save {
1309 my ($self) = @_; 1685 my ($self) = @_;
1310 1686
1311 utf8::encode (my $save = $self->save_path); 1687 utf8::encode (my $save = $self->save_path);
1312 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1688 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1313 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1689 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1314
1315 #d#TODO remove .map and also nuke
1316 $save =~ s/\.map// or return;#d#
1317 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1318 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1319} 1690}
1320 1691
1321sub load_header_from($) { 1692sub load_header_from($) {
1322 my ($self, $path) = @_; 1693 my ($self, $path) = @_;
1323 1694
1373 $self->load_header_orig 1744 $self->load_header_orig
1374 or return; 1745 or return;
1375 $self->prepare_orig; 1746 $self->prepare_orig;
1376 } 1747 }
1377 1748
1749 $self->{deny_reset} = 1
1750 if $self->no_reset;
1751
1752 $self->default_region (cf::region::find_by_path $self->{path})
1753 unless $self->default_region;
1754
1378 1 1755 1
1379} 1756}
1380 1757
1381sub find; 1758sub find;
1382sub find { 1759sub find {
1394 $map->{last_save} = $cf::RUNTIME; 1771 $map->{last_save} = $cf::RUNTIME;
1395 1772
1396 $map->load_header 1773 $map->load_header
1397 or return; 1774 or return;
1398 1775
1399 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1776 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1400 # doing this can freeze the server in a sync job, obviously 1777 # doing this can freeze the server in a sync job, obviously
1401 #$cf::WAIT_FOR_TICK->wait; 1778 #$cf::WAIT_FOR_TICK->wait;
1402 $map->reset; 1779 $map->reset;
1403 undef $guard; 1780 undef $guard;
1404 return find $path; 1781 return find $path;
1415 my ($self) = @_; 1792 my ($self) = @_;
1416 1793
1417 local $self->{deny_reset} = 1; # loading can take a long time 1794 local $self->{deny_reset} = 1; # loading can take a long time
1418 1795
1419 my $path = $self->{path}; 1796 my $path = $self->{path};
1797
1798 {
1420 my $guard = cf::lock_acquire "map_load:$path"; 1799 my $guard = cf::lock_acquire "map_load:$path";
1421 1800
1422 return if $self->in_memory != cf::MAP_SWAPPED; 1801 return if $self->in_memory != cf::MAP_SWAPPED;
1423 1802
1424 $self->in_memory (cf::MAP_LOADING); 1803 $self->in_memory (cf::MAP_LOADING);
1425 1804
1426 $self->alloc; 1805 $self->alloc;
1427 1806
1428 $self->pre_load; 1807 $self->pre_load;
1429
1430 $self->_load_objects ($self->{load_path}, 1)
1431 or return;
1432
1433 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1434 if delete $self->{load_original};
1435
1436 if (my $uniq = $self->uniq_path) {
1437 utf8::encode $uniq;
1438 if (aio_open $uniq, O_RDONLY, 0) {
1439 $self->clear_unique_items;
1440 $self->_load_objects ($uniq, 0);
1441 }
1442 }
1443
1444 Coro::cede;
1445
1446 # now do the right thing for maps
1447 $self->link_multipart_objects;
1448
1449 unless ($self->{deny_activate}) {
1450 $self->decay_objects;
1451 $self->fix_auto_apply;
1452 $self->update_buttons;
1453 Coro::cede; 1808 Coro::cede;
1454 $self->set_darkness_map; 1809
1810 $self->_load_objects ($self->{load_path}, 1)
1811 or return;
1812
1813 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1814 if delete $self->{load_original};
1815
1816 if (my $uniq = $self->uniq_path) {
1817 utf8::encode $uniq;
1818 if (aio_open $uniq, O_RDONLY, 0) {
1819 $self->clear_unique_items;
1820 $self->_load_objects ($uniq, 0);
1821 }
1822 }
1823
1824 Coro::cede;
1825 # now do the right thing for maps
1826 $self->link_multipart_objects;
1455 $self->difficulty ($self->estimate_difficulty) 1827 $self->difficulty ($self->estimate_difficulty)
1456 unless $self->difficulty; 1828 unless $self->difficulty;
1457 Coro::cede; 1829 Coro::cede;
1830
1831 unless ($self->{deny_activate}) {
1832 $self->decay_objects;
1833 $self->fix_auto_apply;
1834 $self->update_buttons;
1835 Coro::cede;
1836 $self->set_darkness_map;
1837 Coro::cede;
1458 $self->activate; 1838 $self->activate;
1839 }
1840
1841 $self->in_memory (cf::MAP_IN_MEMORY);
1459 } 1842 }
1460 1843
1461 $self->post_load; 1844 $self->post_load;
1462
1463 $self->in_memory (cf::MAP_IN_MEMORY);
1464} 1845}
1465 1846
1466sub customise_for { 1847sub customise_for {
1467 my ($self, $ob) = @_; 1848 my ($self, $ob) = @_;
1468 1849
1469 return find "~" . $ob->name . "/" . $self->{path} 1850 return find "~" . $ob->name . "/" . $self->{path}
1470 if $self->per_player; 1851 if $self->per_player;
1852
1853# return find "?party/" . $ob->name . "/" . $self->{path}
1854# if $self->per_party;
1471 1855
1472 $self 1856 $self
1473} 1857}
1474 1858
1475# find and load all maps in the 3x3 area around a map 1859# find and load all maps in the 3x3 area around a map
1586 1970
1587sub reset_at { 1971sub reset_at {
1588 my ($self) = @_; 1972 my ($self) = @_;
1589 1973
1590 # TODO: safety, remove and allow resettable per-player maps 1974 # TODO: safety, remove and allow resettable per-player maps
1591 return 1e99 if $self->isa ("ext::map_per_player");#d#
1592 return 1e99 if $self->{deny_reset}; 1975 return 1e99 if $self->{deny_reset};
1593 1976
1594 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1977 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1595 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1978 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1596 1979
1607 my ($self) = @_; 1990 my ($self) = @_;
1608 1991
1609 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1992 my $lock = cf::lock_acquire "map_data:$self->{path}";
1610 1993
1611 return if $self->players; 1994 return if $self->players;
1612 return if $self->isa ("ext::map_per_player");#d#
1613 1995
1614 warn "resetting map ", $self->path;#d# 1996 warn "resetting map ", $self->path;
1615 1997
1616 $self->in_memory (cf::MAP_SWAPPED); 1998 $self->in_memory (cf::MAP_SWAPPED);
1617 1999
1618 # need to save uniques path 2000 # need to save uniques path
1619 unless ($self->{deny_save}) { 2001 unless ($self->{deny_save}) {
1651 $cf::MAP{$self->path} = $self; 2033 $cf::MAP{$self->path} = $self;
1652 2034
1653 $self->reset; # polite request, might not happen 2035 $self->reset; # polite request, might not happen
1654} 2036}
1655 2037
2038=item $maps = cf::map::tmp_maps
2039
2040Returns an arrayref with all map paths of currently instantiated and saved
2041maps. May block.
2042
2043=cut
2044
2045sub tmp_maps() {
2046 [
2047 map {
2048 utf8::decode $_;
2049 /\.map$/
2050 ? normalise $_
2051 : ()
2052 } @{ aio_readdir $TMPDIR or [] }
2053 ]
2054}
2055
2056=item $maps = cf::map::random_maps
2057
2058Returns an arrayref with all map paths of currently instantiated and saved
2059random maps. May block.
2060
2061=cut
2062
2063sub random_maps() {
2064 [
2065 map {
2066 utf8::decode $_;
2067 /\.map$/
2068 ? normalise "?random/$_"
2069 : ()
2070 } @{ aio_readdir $RANDOMDIR or [] }
2071 ]
2072}
2073
1656=item cf::map::unique_maps 2074=item cf::map::unique_maps
1657 2075
1658Returns an arrayref of paths of all shared maps that have 2076Returns an arrayref of paths of all shared maps that have
1659instantiated unique items. May block. 2077instantiated unique items. May block.
1660 2078
1661=cut 2079=cut
1662 2080
1663sub unique_maps() { 2081sub unique_maps() {
1664 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2082 [
1665 or return; 2083 map {
1666
1667 my @paths;
1668
1669 for (@$files) {
1670 utf8::decode $_; 2084 utf8::decode $_;
1671 next if /\.pst$/; 2085 /\.map$/
1672 next unless /^$PATH_SEP/o; 2086 ? normalise $_
1673 2087 : ()
1674 push @paths, cf::map::normalise $_; 2088 } @{ aio_readdir $UNIQUEDIR or [] }
1675 } 2089 ]
1676
1677 \@paths
1678} 2090}
1679 2091
1680package cf; 2092package cf;
1681 2093
1682=back 2094=back
1728 2140
1729 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2141 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1730 2142
1731 if ($self->{record_replies}) { 2143 if ($self->{record_replies}) {
1732 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2144 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2145
1733 } else { 2146 } else {
2147 my $pl = $self->contr;
2148
2149 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2150 my $diag = $pl->{npc_dialog};
2151 $diag->{pl}->ext_reply (
2152 $diag->{id},
2153 msgtype => "reply",
2154 msg => $diag->{pl}->expand_cfpod ($msg),
2155 add_topics => []
2156 );
2157
2158 } else {
1734 $msg = $npc->name . " says: $msg" if $npc; 2159 $msg = $npc->name . " says: $msg" if $npc;
1735 $self->message ($msg, $flags); 2160 $self->message ($msg, $flags);
2161 }
1736 } 2162 }
1737} 2163}
1738 2164
1739=item $player_object->may ("access") 2165=item $player_object->may ("access")
1740 2166
1788 $self->deactivate_recursive; 2214 $self->deactivate_recursive;
1789 2215
1790 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2216 return if UNIVERSAL::isa $self->map, "ext::map_link";
1791 2217
1792 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2218 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1793 if $self->map; 2219 if $self->map && $self->map->{path} ne "{link}";
1794 2220
1795 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2221 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1796} 2222}
1797 2223
1798sub cf::object::player::leave_link { 2224sub cf::object::player::leave_link {
1799 my ($self, $map, $x, $y) = @_; 2225 my ($self, $map, $x, $y) = @_;
2226
2227 return unless $self->contr->active;
1800 2228
1801 my $link_pos = delete $self->{_link_pos}; 2229 my $link_pos = delete $self->{_link_pos};
1802 2230
1803 unless ($map) { 2231 unless ($map) {
1804 # restore original map position 2232 # restore original map position
1822 $map->load; 2250 $map->load;
1823 $map->load_diag; 2251 $map->load_diag;
1824 2252
1825 return unless $self->contr->active; 2253 return unless $self->contr->active;
1826 $self->activate_recursive; 2254 $self->activate_recursive;
2255
2256 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827 $self->enter_map ($map, $x, $y); 2257 $self->enter_map ($map, $x, $y);
1828} 2258}
1829 2259
1830cf::player->attach (
1831 on_logout => sub {
1832 my ($pl) = @_;
1833
1834 # abort map switching before logout
1835 if ($pl->ob->{_link_pos}) {
1836 cf::sync_job {
1837 $pl->ob->leave_link
1838 };
1839 }
1840 },
1841 on_login => sub {
1842 my ($pl) = @_;
1843
1844 # try to abort aborted map switching on player login :)
1845 # should happen only on crashes
1846 if ($pl->ob->{_link_pos}) {
1847 $pl->ob->enter_link;
1848 (async {
1849 # we need this sleep as the login has a concurrent enter_exit running
1850 # and this sleep increases chances of the player not ending up in scorn
1851 $pl->ob->reply (undef,
1852 "There was an internal problem at your last logout, "
1853 . "the server will try to bring you to your intended destination in a second.",
1854 cf::NDI_RED);
1855 Coro::Timer::sleep 1;
1856 $pl->ob->leave_link;
1857 })->prio (2);
1858 }
1859 },
1860);
1861
1862=item $player_object->goto ($path, $x, $y) 2260=item $player_object->goto ($path, $x, $y[, $check->($map)])
1863 2261
2262Moves the player to the given map-path and coordinates by first freezing
2263her, loading and preparing them map, calling the provided $check callback
2264that has to return the map if sucecssful, and then unfreezes the player on
2265the new (success) or old (failed) map position.
2266
1864=cut 2267=cut
2268
2269our $GOTOGEN;
1865 2270
1866sub cf::object::player::goto { 2271sub cf::object::player::goto {
1867 my ($self, $path, $x, $y) = @_; 2272 my ($self, $path, $x, $y, $check) = @_;
2273
2274 # do generation counting so two concurrent goto's will be executed in-order
2275 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1868 2276
1869 $self->enter_link; 2277 $self->enter_link;
1870 2278
1871 (async { 2279 (async {
1872 my $map = eval { 2280 my $map = eval {
1873 my $map = cf::map::find $path; 2281 my $map = cf::map::find $path;
2282
2283 if ($map) {
1874 $map = $map->customise_for ($self) if $map; 2284 $map = $map->customise_for ($self);
2285 $map = $check->($map) if $check && $map;
2286 } else {
2287 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2288 }
2289
1875 $map 2290 $map
2291 };
2292
2293 if ($@) {
2294 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2295 LOG llevError | logBacktrace, Carp::longmess $@;
1876 } or 2296 }
1877 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878 2297
2298 if ($gen == $self->{_goto_generation}) {
2299 delete $self->{_goto_generation};
1879 $self->leave_link ($map, $x, $y); 2300 $self->leave_link ($map, $x, $y);
2301 }
1880 })->prio (1); 2302 })->prio (1);
1881} 2303}
1882 2304
1883=item $player_object->enter_exit ($exit_object) 2305=item $player_object->enter_exit ($exit_object)
1884 2306
1923 2345
1924 $rmp->{random_seed} ||= $exit->random_seed; 2346 $rmp->{random_seed} ||= $exit->random_seed;
1925 2347
1926 my $data = cf::to_json $rmp; 2348 my $data = cf::to_json $rmp;
1927 my $md5 = Digest::MD5::md5_hex $data; 2349 my $md5 = Digest::MD5::md5_hex $data;
1928 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2350 my $meta = "$RANDOMDIR/$md5.meta";
1929 2351
1930 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2352 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931 aio_write $fh, 0, (length $data), $data, 0; 2353 aio_write $fh, 0, (length $data), $data, 0;
1932 undef $fh; 2354 undef $fh;
1933 aio_rename "$meta~", $meta; 2355 aio_rename "$meta~", $meta;
1942 2364
1943 return unless $self->type == cf::PLAYER; 2365 return unless $self->type == cf::PLAYER;
1944 2366
1945 if ($exit->slaying eq "/!") { 2367 if ($exit->slaying eq "/!") {
1946 #TODO: this should de-fi-ni-te-ly not be a sync-job 2368 #TODO: this should de-fi-ni-te-ly not be a sync-job
2369 # the problem is that $exit might not survive long enough
2370 # so it needs to be done right now, right here
1947 cf::sync_job { prepare_random_map $exit }; 2371 cf::sync_job { prepare_random_map $exit };
1948 } 2372 }
1949 2373
1950 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2374 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1951 my $hp = $exit->stats->hp; 2375 my $hp = $exit->stats->hp;
1952 my $sp = $exit->stats->sp; 2376 my $sp = $exit->stats->sp;
1953 2377
1954 $self->enter_link; 2378 $self->enter_link;
2379
2380 # if exit is damned, update players death & WoR home-position
2381 $self->contr->savebed ($slaying, $hp, $sp)
2382 if $exit->flag (FLAG_DAMNED);
1955 2383
1956 (async { 2384 (async {
1957 $self->deactivate_recursive; # just to be sure 2385 $self->deactivate_recursive; # just to be sure
1958 unless (eval { 2386 unless (eval {
1959 $self->goto ($slaying, $hp, $sp); 2387 $self->goto ($slaying, $hp, $sp);
1960 2388
1961 1; 2389 1;
1962 }) { 2390 }) {
1963 $self->message ("Something went wrong deep within the crossfire server. " 2391 $self->message ("Something went wrong deep within the crossfire server. "
1964 . "I'll try to bring you back to the map you were before. " 2392 . "I'll try to bring you back to the map you were before. "
1965 . "Please report this to the dungeon master!", 2393 . "Please report this to the dungeon master!",
1966 cf::NDI_UNIQUE | cf::NDI_RED); 2394 cf::NDI_UNIQUE | cf::NDI_RED);
1967 2395
1968 warn "ERROR in enter_exit: $@"; 2396 warn "ERROR in enter_exit: $@";
1969 $self->leave_link; 2397 $self->leave_link;
1970 } 2398 }
1971 })->prio (1); 2399 })->prio (1);
1984 2412
1985sub cf::client::send_drawinfo { 2413sub cf::client::send_drawinfo {
1986 my ($self, $text, $flags) = @_; 2414 my ($self, $text, $flags) = @_;
1987 2415
1988 utf8::encode $text; 2416 utf8::encode $text;
1989 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2417 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1990} 2418}
1991 2419
2420=item $client->send_msg ($color, $type, $msg, [extra...])
2421
2422Send a drawinfo or msg packet to the client, formatting the msg for the
2423client if neccessary. C<$type> should be a string identifying the type of
2424the message, with C<log> being the default. If C<$color> is negative, suppress
2425the message unless the client supports the msg packet.
2426
2427=cut
2428
2429sub cf::client::send_msg {
2430 my ($self, $color, $type, $msg, @extra) = @_;
2431
2432 $msg = $self->pl->expand_cfpod ($msg);
2433
2434 return unless @extra || length $msg;
2435
2436 if ($self->can_msg) {
2437 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2438 } else {
2439 # replace some tags by gcfclient-compatible ones
2440 for ($msg) {
2441 1 while
2442 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2443 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2444 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2445 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2446 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2447 }
2448
2449 if ($color >= 0) {
2450 if (0 && $msg =~ /\[/) {
2451 $self->send_packet ("drawextinfo $color 4 0 $msg")
2452 } else {
2453 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2454 $self->send_packet ("drawinfo $color $msg")
2455 }
2456 }
2457 }
2458}
2459
2460=item $client->ext_event ($type, %msg)
2461
2462Sends an ext event to the client.
2463
2464=cut
2465
2466sub cf::client::ext_event($$%) {
2467 my ($self, $type, %msg) = @_;
2468
2469 $msg{msgtype} = "event_$type";
2470 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2471}
1992 2472
1993=item $success = $client->query ($flags, "text", \&cb) 2473=item $success = $client->query ($flags, "text", \&cb)
1994 2474
1995Queues a query to the client, calling the given callback with 2475Queues a query to the client, calling the given callback with
1996the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2476the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1997C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2477C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1998 2478
1999Queries can fail, so check the return code. Or don't, as queries will become 2479Queries can fail, so check the return code. Or don't, as queries will
2000reliable at some point in the future. 2480become reliable at some point in the future.
2001 2481
2002=cut 2482=cut
2003 2483
2004sub cf::client::query { 2484sub cf::client::query {
2005 my ($self, $flags, $text, $cb) = @_; 2485 my ($self, $flags, $text, $cb) = @_;
2013 utf8::encode $text; 2493 utf8::encode $text;
2014 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2494 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015 2495
2016 $self->send_packet ($self->{query_queue}[0][0]) 2496 $self->send_packet ($self->{query_queue}[0][0])
2017 if @{ $self->{query_queue} } == 1; 2497 if @{ $self->{query_queue} } == 1;
2498
2499 1
2018} 2500}
2019 2501
2020cf::client->attach ( 2502cf::client->attach (
2503 on_connect => sub {
2504 my ($ns) = @_;
2505
2506 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2507 },
2021 on_reply => sub { 2508 on_reply => sub {
2022 my ($ns, $msg) = @_; 2509 my ($ns, $msg) = @_;
2023 2510
2024 # this weird shuffling is so that direct followup queries 2511 # this weird shuffling is so that direct followup queries
2025 # get handled first 2512 # get handled first
2037 } else { 2524 } else {
2038 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2525 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039 } 2526 }
2040 } 2527 }
2041 }, 2528 },
2529 on_exticmd => sub {
2530 my ($ns, $buf) = @_;
2531
2532 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2533
2534 if (ref $msg) {
2535 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2536 if (my %reply = $cb->($ns, $msg)) {
2537 $reply{msgid} = $msg->{msgid};
2538 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2539 }
2540 }
2541 } else {
2542 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2543 }
2544
2545 cf::override;
2546 },
2042); 2547);
2043 2548
2044=item $client->async (\&cb) 2549=item $client->async (\&cb)
2045 2550
2046Create a new coroutine, running the specified callback. The coroutine will 2551Create a new coroutine, running the specified callback. The coroutine will
2093 2598
2094# here we export the classes and methods available to script code 2599# here we export the classes and methods available to script code
2095 2600
2096=pod 2601=pod
2097 2602
2098The following fucntions and emthods are available within a safe environment: 2603The following functions and methods are available within a safe environment:
2099 2604
2100 cf::object contr pay_amount pay_player map 2605 cf::object
2606 contr pay_amount pay_player map x y force_find force_add
2607 insert remove
2608
2101 cf::object::player player 2609 cf::object::player
2102 cf::player peaceful 2610 player
2103 cf::map trigger 2611
2612 cf::player
2613 peaceful
2614
2615 cf::map
2616 trigger
2104 2617
2105=cut 2618=cut
2106 2619
2107for ( 2620for (
2108 ["cf::object" => qw(contr pay_amount pay_player map)], 2621 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2622 insert remove)],
2109 ["cf::object::player" => qw(player)], 2623 ["cf::object::player" => qw(player)],
2110 ["cf::player" => qw(peaceful)], 2624 ["cf::player" => qw(peaceful)],
2111 ["cf::map" => qw(trigger)], 2625 ["cf::map" => qw(trigger)],
2112) { 2626) {
2113 no strict 'refs'; 2627 no strict 'refs';
2184=back 2698=back
2185 2699
2186=cut 2700=cut
2187 2701
2188############################################################################# 2702#############################################################################
2189
2190=head2 EXTENSION DATABASE SUPPORT
2191
2192Crossfire maintains a very simple database for extension use. It can
2193currently store anything that can be serialised using Storable, which
2194excludes objects.
2195
2196The parameter C<$family> should best start with the name of the extension
2197using it, it should be unique.
2198
2199=over 4
2200
2201=item $value = cf::db_get $family => $key
2202
2203Returns a single value from the database.
2204
2205=item cf::db_put $family => $key => $value
2206
2207Stores the given C<$value> in the family.
2208
2209=cut
2210
2211our $DB;
2212
2213sub db_init {
2214 unless ($DB) {
2215 $DB = BDB::db_create $DB_ENV;
2216
2217 cf::sync_job {
2218 eval {
2219 $DB->set_flags (BDB::CHKSUM);
2220
2221 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223 cf::cleanup "db_open(db): $!" if $!;
2224 };
2225 cf::cleanup "db_open(db): $@" if $@;
2226 };
2227
2228 my $path = cf::localdir . "/database.pst";
2229 if (stat $path) {
2230 cf::sync_job {
2231 my $pst = Storable::retrieve $path;
2232
2233 cf::db_put (board => data => $pst->{board});
2234 cf::db_put (guildrules => data => $pst->{guildrules});
2235 cf::db_put (rent => balance => $pst->{rent}{balance});
2236 BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238 unlink $path;
2239 };
2240 }
2241 }
2242}
2243
2244sub db_get($$) {
2245 my $key = "$_[0]/$_[1]";
2246
2247 cf::sync_job {
2248 BDB::db_get $DB, undef, $key, my $data;
2249
2250 $! ? ()
2251 : Compress::LZF::sthaw $data
2252 }
2253}
2254
2255sub db_put($$$) {
2256 BDB::dbreq_pri 4;
2257 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258}
2259
2260#############################################################################
2261# the server's init and main functions 2703# the server's init and main functions
2262 2704
2263sub load_resources { 2705sub load_facedata($) {
2264 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2706 my ($path) = @_;
2707
2708 warn "loading facedata from $path\n";
2709
2710 my $facedata;
2711 0 < aio_load $path, $facedata
2712 or die "$path: $!";
2713
2714 $facedata = Coro::Storable::thaw $facedata;
2715
2716 $facedata->{version} == 2
2717 or cf::cleanup "$path: version mismatch, cannot proceed.";
2718
2719 {
2720 my $faces = $facedata->{faceinfo};
2721
2722 while (my ($face, $info) = each %$faces) {
2723 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2724 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2725 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2726 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2727 Coro::cede;
2728 }
2729
2730 while (my ($face, $info) = each %$faces) {
2731 next unless $info->{smooth};
2732 my $idx = cf::face::find $face
2733 or next;
2734 if (my $smooth = cf::face::find $info->{smooth}) {
2735 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2736 } else {
2737 warn "smooth face '$info->{smooth}' not found for face '$face'";
2738 }
2739 Coro::cede;
2740 }
2741 }
2742
2743 {
2744 my $anims = $facedata->{animinfo};
2745
2746 while (my ($anim, $info) = each %$anims) {
2747 cf::anim::set $anim, $info->{frames}, $info->{facings};
2748 Coro::cede;
2749 }
2750
2751 cf::anim::invalidate_all; # d'oh
2752 }
2753
2754 1
2755}
2756
2757sub reload_regions {
2758 load_resource_file "$MAPDIR/regions"
2265 or die "unable to load regions file\n";#d# 2759 or die "unable to load regions file\n";
2760}
2761
2762sub reload_facedata {
2763 load_facedata "$DATADIR/facedata"
2764 or die "unable to load facedata\n";
2765}
2766
2767sub reload_archetypes {
2768 load_resource_file "$DATADIR/archetypes"
2769 or die "unable to load archetypes\n";
2770 #d# NEED to laod twice to resolve forward references
2771 # this really needs to be done in an extra post-pass
2772 # (which needs to be synchronous, so solve it differently)
2773 load_resource_file "$DATADIR/archetypes"
2774 or die "unable to load archetypes\n";
2775}
2776
2777sub reload_treasures {
2778 load_resource_file "$DATADIR/treasures"
2779 or die "unable to load treasurelists\n";
2780}
2781
2782sub reload_resources {
2783 warn "reloading resource files...\n";
2784
2785 reload_regions;
2786 reload_facedata;
2787 #reload_archetypes;#d#
2788 reload_archetypes;
2789 reload_treasures;
2790
2791 warn "finished reloading resource files\n";
2792}
2793
2794sub init {
2795 reload_resources;
2266} 2796}
2267 2797
2268sub cfg_load { 2798sub cfg_load {
2269 open my $fh, "<:utf8", cf::confdir . "/config" 2799 open my $fh, "<:utf8", "$CONFDIR/config"
2270 or return; 2800 or return;
2271 2801
2272 local $/; 2802 local $/;
2273 *CFG = YAML::Syck::Load <$fh>; 2803 *CFG = YAML::Syck::Load <$fh>;
2274 2804
2282 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2812 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2283 and die "WARNING: m(un)lockall failed: $!\n"; 2813 and die "WARNING: m(un)lockall failed: $!\n";
2284 }; 2814 };
2285 warn $@ if $@; 2815 warn $@ if $@;
2286 } 2816 }
2287}
2288
2289sub init {
2290 load_resources;
2291} 2817}
2292 2818
2293sub main { 2819sub main {
2294 # we must not ever block the main coroutine 2820 # we must not ever block the main coroutine
2295 local $Coro::idle = sub { 2821 local $Coro::idle = sub {
2323 }, 2849 },
2324 ); 2850 );
2325 } 2851 }
2326} 2852}
2327 2853
2854sub write_runtime {
2855 my $runtime = "$LOCALDIR/runtime";
2856
2857 # first touch the runtime file to show we are still running:
2858 # the fsync below can take a very very long time.
2859
2860 IO::AIO::aio_utime $runtime, undef, undef;
2861
2862 my $guard = cf::lock_acquire "write_runtime";
2863
2864 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2865 or return;
2866
2867 my $value = $cf::RUNTIME + 90 + 10;
2868 # 10 is the runtime save interval, for a monotonic clock
2869 # 60 allows for the watchdog to kill the server.
2870
2871 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2872 and return;
2873
2874 # always fsync - this file is important
2875 aio_fsync $fh
2876 and return;
2877
2878 # touch it again to show we are up-to-date
2879 aio_utime $fh, undef, undef;
2880
2881 close $fh
2882 or return;
2883
2884 aio_rename "$runtime~", $runtime
2885 and return;
2886
2887 warn "runtime file written.\n";
2888
2889 1
2890}
2891
2328sub emergency_save() { 2892sub emergency_save() {
2329 my $freeze_guard = cf::freeze_mainloop; 2893 my $freeze_guard = cf::freeze_mainloop;
2330 2894
2331 warn "enter emergency perl save\n"; 2895 warn "enter emergency perl save\n";
2332 2896
2363 2927
2364 warn Carp::longmess "post_cleanup backtrace" 2928 warn Carp::longmess "post_cleanup backtrace"
2365 if $make_core; 2929 if $make_core;
2366} 2930}
2367 2931
2368sub reload() { 2932sub do_reload_perl() {
2369 # can/must only be called in main 2933 # can/must only be called in main
2370 if ($Coro::current != $Coro::main) { 2934 if ($Coro::current != $Coro::main) {
2371 warn "can only reload from main coroutine"; 2935 warn "can only reload from main coroutine";
2372 return; 2936 return;
2373 } 2937 }
2374 2938
2375 warn "reloading..."; 2939 warn "reloading...";
2376 2940
2377 warn "cancelling server ticker"; 2941 warn "entering sync_job";
2378 $TICK_WATCHER->cancel;
2379 2942
2943 cf::sync_job {
2944 cf::write_runtime; # external watchdog should not bark
2380 cf::emergency_save; 2945 cf::emergency_save;
2946 cf::write_runtime; # external watchdog should not bark
2381 2947
2382 eval { 2948 warn "syncing database to disk";
2949 BDB::db_env_txn_checkpoint $DB_ENV;
2950
2383 # if anything goes wrong in here, we should simply crash as we already saved 2951 # if anything goes wrong in here, we should simply crash as we already saved
2384 2952
2385 warn "cancelling all WF_AUTOCANCEL watchers"; 2953 warn "cancelling all WF_AUTOCANCEL watchers";
2386 for (Event::all_watchers) { 2954 for (Event::all_watchers) {
2387 $_->cancel if $_->data & WF_AUTOCANCEL; 2955 $_->cancel if $_->data & WF_AUTOCANCEL;
2388 } 2956 }
2389
2390 warn "syncing database to disk";
2391 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2392 2957
2393 warn "flushing outstanding aio requests"; 2958 warn "flushing outstanding aio requests";
2394 for (;;) { 2959 for (;;) {
2395 BDB::flush; 2960 BDB::flush;
2396 IO::AIO::flush; 2961 IO::AIO::flush;
2397 Coro::cede; 2962 Coro::cede;
2398 last unless IO::AIO::nreqs || BDB::nreqs; 2963 last unless IO::AIO::nreqs || BDB::nreqs;
2399 warn "iterate..."; 2964 warn "iterate...";
2400 } 2965 }
2401 2966
2967 ++$RELOAD;
2968
2402 warn "cancelling all extension coros"; 2969 warn "cancelling all extension coros";
2403 $_->cancel for values %EXT_CORO; 2970 $_->cancel for values %EXT_CORO;
2404 %EXT_CORO = (); 2971 %EXT_CORO = ();
2405 2972
2406 warn "removing commands"; 2973 warn "removing commands";
2407 %COMMAND = (); 2974 %COMMAND = ();
2408 2975
2409 warn "removing ext commands"; 2976 warn "removing ext/exti commands";
2410 %EXTCMD = (); 2977 %EXTCMD = ();
2978 %EXTICMD = ();
2411 2979
2412 warn "unloading/nuking all extensions"; 2980 warn "unloading/nuking all extensions";
2413 for my $pkg (@EXTS) { 2981 for my $pkg (@EXTS) {
2414 warn "... unloading $pkg"; 2982 warn "... unloading $pkg";
2415 2983
2445 Symbol::delete_package "safe::$_" 3013 Symbol::delete_package "safe::$_"
2446 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3014 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2447 3015
2448 warn "unloading cf.pm \"a bit\""; 3016 warn "unloading cf.pm \"a bit\"";
2449 delete $INC{"cf.pm"}; 3017 delete $INC{"cf.pm"};
3018 delete $INC{"cf/pod.pm"};
2450 3019
2451 # don't, removes xs symbols, too, 3020 # don't, removes xs symbols, too,
2452 # and global variables created in xs 3021 # and global variables created in xs
2453 #Symbol::delete_package __PACKAGE__; 3022 #Symbol::delete_package __PACKAGE__;
2454 3023
2463 3032
2464 warn "loading extensions"; 3033 warn "loading extensions";
2465 cf::load_extensions; 3034 cf::load_extensions;
2466 3035
2467 warn "reattaching attachments to objects/players"; 3036 warn "reattaching attachments to objects/players";
2468 _global_reattach; 3037 _global_reattach; # objects, sockets
2469 warn "reattaching attachments to maps"; 3038 warn "reattaching attachments to maps";
2470 reattach $_ for values %MAP; 3039 reattach $_ for values %MAP;
3040 warn "reattaching attachments to players";
3041 reattach $_ for values %PLAYER;
2471 3042
2472 warn "loading reloadable resources"; 3043 warn "leaving sync_job";
2473 load_resources;
2474 3044
2475 warn "restarting server ticker"; 3045 1
2476 3046 } or do {
2477 $TICK_WATCHER->start;
2478 };
2479
2480 if ($@) {
2481 warn $@; 3047 warn $@;
2482 warn "error while reloading, exiting."; 3048 warn "error while reloading, exiting.";
2483 exit 1; 3049 exit 1;
2484 } 3050 };
2485 3051
2486 warn "reloaded"; 3052 warn "reloaded";
2487}; 3053};
2488 3054
2489our $RELOAD_WATCHER; # used only during reload 3055our $RELOAD_WATCHER; # used only during reload
2490 3056
3057sub reload_perl() {
3058 # doing reload synchronously and two reloads happen back-to-back,
3059 # coro crashes during coro_state_free->destroy here.
3060
3061 $RELOAD_WATCHER ||= Event->timer (
3062 reentrant => 0,
3063 after => 0,
3064 data => WF_AUTOCANCEL,
3065 cb => sub {
3066 do_reload_perl;
3067 undef $RELOAD_WATCHER;
3068 },
3069 );
3070}
3071
2491register_command "reload" => sub { 3072register_command "reload" => sub {
2492 my ($who, $arg) = @_; 3073 my ($who, $arg) = @_;
2493 3074
2494 if ($who->flag (FLAG_WIZ)) { 3075 if ($who->flag (FLAG_WIZ)) {
2495 $who->message ("reloading server."); 3076 $who->message ("reloading server.");
2496 3077 async { reload_perl };
2497 # doing reload synchronously and two reloads happen back-to-back,
2498 # coro crashes during coro_state_free->destroy here.
2499
2500 $RELOAD_WATCHER ||= Event->timer (
2501 reentrant => 0,
2502 after => 0,
2503 data => WF_AUTOCANCEL,
2504 cb => sub {
2505 reload;
2506 undef $RELOAD_WATCHER;
2507 },
2508 );
2509 } 3078 }
2510}; 3079};
2511 3080
2512unshift @INC, $LIBDIR; 3081unshift @INC, $LIBDIR;
2513 3082
2514my $bug_warning = 0; 3083my $bug_warning = 0;
2515 3084
3085our @WAIT_FOR_TICK;
3086our @WAIT_FOR_TICK_BEGIN;
3087
3088sub wait_for_tick {
3089 return unless $TICK_WATCHER->is_active;
3090 return if $Coro::current == $Coro::main;
3091
3092 my $signal = new Coro::Signal;
3093 push @WAIT_FOR_TICK, $signal;
3094 $signal->wait;
3095}
3096
3097sub wait_for_tick_begin {
3098 return unless $TICK_WATCHER->is_active;
3099 return if $Coro::current == $Coro::main;
3100
3101 my $signal = new Coro::Signal;
3102 push @WAIT_FOR_TICK_BEGIN, $signal;
3103 $signal->wait;
3104}
3105
3106 my $min = 1e6;#d#
3107 my $avg = 10;
2516$TICK_WATCHER = Event->timer ( 3108$TICK_WATCHER = Event->timer (
2517 reentrant => 0, 3109 reentrant => 0,
2518 parked => 1, 3110 parked => 1,
2519 prio => 0, 3111 prio => 0,
2520 at => $NEXT_TICK || $TICK, 3112 at => $NEXT_TICK || $TICK,
2524 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3116 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2525 unless ++$bug_warning > 10; 3117 unless ++$bug_warning > 10;
2526 return; 3118 return;
2527 } 3119 }
2528 3120
2529 $NOW = Event::time; 3121 $NOW = $tick_start = Event::time;
2530 3122
2531 cf::server_tick; # one server iteration 3123 cf::server_tick; # one server iteration
3124
3125 0 && sync_job {#d#
3126 for(1..10) {
3127 my $t = Event::time;
3128 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3129 or die;
3130
3131 $map->width (50);
3132 $map->height (50);
3133 $map->alloc;
3134 $map->_load_objects ("/tmp/x.map", 1);
3135 my $t = Event::time - $t;
3136
3137 #next unless $t < 0.0013;#d#
3138 if ($t < $min) {
3139 $min = $t;
3140 }
3141 $avg = $avg * 0.99 + $t * 0.01;
3142 }
3143 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3144 exit 0;
3145 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3146 };
3147
2532 $RUNTIME += $TICK; 3148 $RUNTIME += $TICK;
2533 $NEXT_TICK += $TICK; 3149 $NEXT_TICK += $TICK;
2534 3150
2535 $WAIT_FOR_TICK->broadcast; 3151 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2536 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3152 $NEXT_RUNTIME_WRITE = $NOW + 10;
2537 3153 Coro::async_pool {
2538 Event::sweep; 3154 write_runtime
2539 Coro::cede_notself; 3155 or warn "ERROR: unable to write runtime file: $!";
3156 };
2540 3157 }
3158
2541# my $AFTER = Event::time; 3159# my $AFTER = Event::time;
2542# warn $AFTER - $NOW;#d# 3160# warn $AFTER - $NOW;#d#
2543 3161
3162 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3163 $sig->send;
3164 }
3165 while (my $sig = shift @WAIT_FOR_TICK) {
3166 $sig->send;
3167 }
3168
3169 $NOW = Event::time;
3170
2544 # if we are delayed by four ticks or more, skip them all 3171 # if we are delayed by four ticks or more, skip them all
2545 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3172 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2546 3173
2547 $TICK_WATCHER->at ($NEXT_TICK); 3174 $TICK_WATCHER->at ($NEXT_TICK);
2548 $TICK_WATCHER->start; 3175 $TICK_WATCHER->start;
3176
3177 $LOAD = ($NOW - $tick_start) / $TICK;
3178 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3179
3180 _post_tick;
3181
3182
2549 }, 3183 },
2550); 3184);
2551 3185
2552{ 3186{
2553 BDB::max_poll_time $TICK * 0.1; 3187 BDB::max_poll_time $TICK * 0.1;
2581 3215
2582 cf::sync_job { 3216 cf::sync_job {
2583 eval { 3217 eval {
2584 BDB::db_env_open 3218 BDB::db_env_open
2585 $DB_ENV, 3219 $DB_ENV,
2586 $BDB_ENV_DIR, 3220 $BDBDIR,
2587 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3221 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2588 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3222 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2589 0666; 3223 0666;
2590 3224
2591 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3225 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2592 3226
2593 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3227 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2594 $DB_ENV->set_lk_detect; 3228 $DB_ENV->set_lk_detect;
2595 }; 3229 };
2596 3230
2604 3238
2605 undef $Coro::AIO::WATCHER; 3239 undef $Coro::AIO::WATCHER;
2606 IO::AIO::max_poll_time $TICK * 0.1; 3240 IO::AIO::max_poll_time $TICK * 0.1;
2607 $AIO_POLL_WATCHER = Event->io ( 3241 $AIO_POLL_WATCHER = Event->io (
2608 reentrant => 0, 3242 reentrant => 0,
3243 data => WF_AUTOCANCEL,
2609 fd => IO::AIO::poll_fileno, 3244 fd => IO::AIO::poll_fileno,
2610 poll => 'r', 3245 poll => 'r',
2611 prio => 6, 3246 prio => 6,
2612 data => WF_AUTOCANCEL,
2613 cb => \&IO::AIO::poll_cb, 3247 cb => \&IO::AIO::poll_cb,
2614 ); 3248 );
2615} 3249}
2616 3250
2617$WRITE_RUNTIME_WATCHER = Event->timer ( 3251my $_log_backtrace;
2618 reentrant => 0, 3252
2619 data => WF_AUTOCANCEL, 3253sub _log_backtrace {
2620 after => 1, 3254 my ($msg, @addr) = @_;
2621 interval => 10, 3255
2622 prio => 6, # keep it lowest so it acts like a watchdog 3256 $msg =~ s/\n//;
2623 cb => Coro::unblock_sub { 3257
2624 write_runtime 3258 # limit the # of concurrent backtraces
2625 or warn "ERROR: unable to write runtime file: $!"; 3259 if ($_log_backtrace < 2) {
3260 ++$_log_backtrace;
3261 async {
3262 my @bt = fork_call {
3263 @addr = map { sprintf "%x", $_ } @addr;
3264 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3265 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3266 or die "addr2line: $!";
3267
3268 my @funcs;
3269 my @res = <$fh>;
3270 chomp for @res;
3271 while (@res) {
3272 my ($func, $line) = splice @res, 0, 2, ();
3273 push @funcs, "[$func] $line";
3274 }
3275
3276 @funcs
3277 };
3278
3279 LOG llevInfo, "[ABT] $msg\n";
3280 LOG llevInfo, "[ABT] $_\n" for @bt;
3281 --$_log_backtrace;
3282 };
3283 } else {
3284 LOG llevInfo, "[ABT] $msg\n";
3285 LOG llevInfo, "[ABT] [suppressed]\n";
2626 }, 3286 }
2627); 3287}
3288
3289# load additional modules
3290use cf::pod;
2628 3291
2629END { cf::emergency_save } 3292END { cf::emergency_save }
2630 3293
26311 32941
2632 3295

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines