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.209 by root, Mon Feb 12 01:25:55 2007 UTC vs.
Revision 1.300 by root, Tue Jul 10 06:44:29 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 _store_scalar {
371 and return; 415 open my $fh, ">", \my $buf
372 416 or die "fork_call: cannot open fh-to-buf in child : $!";
373 # always fsync - this file is important 417 Storable::store_fd $_[0], $fh;
374 aio_fsync $fh
375 and return;
376
377 close $fh 418 close $fh;
378 or return;
379 419
380 aio_rename "$runtime~", $runtime 420 $buf
381 and return; 421}
382 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;
383 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 });
384} 592}
385 593
386=back 594=back
387 595
388=cut 596=cut
395attach callbacks/event handlers (a collection of which is called an "attachment") 603attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods. 604to it. All such attachable objects support the following methods.
397 605
398In 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>
399C<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
400crossfire+). 608Crossfire TRT).
401 609
402=over 4 610=over 4
403 611
404=item $attachable->attach ($attachment, key => $value...) 612=item $attachable->attach ($attachment, key => $value...)
405 613
568 $registry = $CB_TYPE[$object_type] ||= []; 776 $registry = $CB_TYPE[$object_type] ||= [];
569 777
570 } elsif ($type eq "subtype") { 778 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type"; 779 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg; 780 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 781 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574 782
575 } elsif ($type eq "package") { 783 } elsif ($type eq "package") {
576 my $pkg = shift @arg; 784 my $pkg = shift @arg;
577 785
578 while (my ($name, $id) = each %cb_id) { 786 while (my ($name, $id) = each %cb_id) {
607 _attach $registry, $klass, @attach; 815 _attach $registry, $klass, @attach;
608 } 816 }
609 817
610 $obj->{$name} = \%arg; 818 $obj->{$name} = \%arg;
611 } else { 819 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n"; 820 warn "object uses attachment '$name' which is not available, postponing.\n";
613 } 821 }
614 822
615 $obj->{_attachment}{$name} = undef; 823 $obj->{_attachment}{$name} = undef;
616} 824}
617 825
619 if (ref $_[0]) { 827 if (ref $_[0]) {
620 _object_attach @_; 828 _object_attach @_;
621 } else { 829 } else {
622 _attach shift->_attach_registry, @_; 830 _attach shift->_attach_registry, @_;
623 } 831 }
832 _recalc_want;
624}; 833};
625 834
626# all those should be optimised 835# all those should be optimised
627sub cf::attachable::detach { 836sub cf::attachable::detach {
628 my ($obj, $name) = @_; 837 my ($obj, $name) = @_;
631 delete $obj->{_attachment}{$name}; 840 delete $obj->{_attachment}{$name};
632 reattach ($obj); 841 reattach ($obj);
633 } else { 842 } else {
634 Carp::croak "cannot, currently, detach class attachments"; 843 Carp::croak "cannot, currently, detach class attachments";
635 } 844 }
845 _recalc_want;
636}; 846};
637 847
638sub cf::attachable::attached { 848sub cf::attachable::attached {
639 my ($obj, $name) = @_; 849 my ($obj, $name) = @_;
640 850
787 } 997 }
788 } else { 998 } else {
789 aio_unlink $filename; 999 aio_unlink $filename;
790 aio_unlink "$filename.pst"; 1000 aio_unlink "$filename.pst";
791 } 1001 }
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 } 1002 }
799} 1003}
800 1004
801sub object_freezer_as_string { 1005sub object_freezer_as_string {
802 my ($rdata, $objs) = @_; 1006 my ($rdata, $objs) = @_;
808 1012
809sub object_thawer_load { 1013sub object_thawer_load {
810 my ($filename) = @_; 1014 my ($filename) = @_;
811 1015
812 my ($data, $av); 1016 my ($data, $av);
813
814 #d#TODO remove .map if file does not exist
815 aio_stat $filename and $filename =~ s/\.map$//;
816 1017
817 (aio_load $filename, $data) >= 0 1018 (aio_load $filename, $data) >= 0
818 or return; 1019 or return;
819 1020
820 unless (aio_stat "$filename.pst") { 1021 unless (aio_stat "$filename.pst") {
822 or return; 1023 or return;
823 $av = eval { (Storable::thaw $av)->{objs} }; 1024 $av = eval { (Storable::thaw $av)->{objs} };
824 } 1025 }
825 1026
826 warn sprintf "loading %s (%d)\n", 1027 warn sprintf "loading %s (%d)\n",
827 $filename, length $data, scalar @{$av || []};#d# 1028 $filename, length $data, scalar @{$av || []};
828 return ($data, $av); 1029 return ($data, $av);
829} 1030}
1031
1032=head2 COMMAND CALLBACKS
1033
1034=over 4
1035
1036=cut
830 1037
831############################################################################# 1038#############################################################################
832# command handling &c 1039# command handling &c
833 1040
834=item cf::register_command $name => \&callback($ob,$args); 1041=item cf::register_command $name => \&callback($ob,$args);
847 push @{ $COMMAND{$name} }, [$caller, $cb]; 1054 push @{ $COMMAND{$name} }, [$caller, $cb];
848} 1055}
849 1056
850=item cf::register_extcmd $name => \&callback($pl,$packet); 1057=item cf::register_extcmd $name => \&callback($pl,$packet);
851 1058
852Register 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.
853 1064
854If 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
855called. 1066called.
856 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
857=cut 1079=cut
858 1080
859sub register_extcmd { 1081sub register_extcmd {
860 my ($name, $cb) = @_; 1082 my ($name, $cb) = @_;
861 1083
862 $EXTCMD{$name} = $cb; 1084 $EXTCMD{$name} = $cb;
1085}
1086
1087sub register_exticmd {
1088 my ($name, $cb) = @_;
1089
1090 $EXTICMD{$name} = $cb;
863} 1091}
864 1092
865cf::player->attach ( 1093cf::player->attach (
866 on_command => sub { 1094 on_command => sub {
867 my ($pl, $name, $params) = @_; 1095 my ($pl, $name, $params) = @_;
876 cf::override; 1104 cf::override;
877 }, 1105 },
878 on_extcmd => sub { 1106 on_extcmd => sub {
879 my ($pl, $buf) = @_; 1107 my ($pl, $buf) = @_;
880 1108
881 my $msg = eval { from_json $buf }; 1109 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
882 1110
883 if (ref $msg) { 1111 if (ref $msg) {
884 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1112 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
885 if (my %reply = $cb->($pl, $msg)) { 1113 if (my %reply = $cb->($pl, $msg)) {
886 $pl->ext_reply ($msg->{msgid}, %reply); 1114 $pl->ext_reply ($msg->{msgid}, %reply);
892 1120
893 cf::override; 1121 cf::override;
894 }, 1122 },
895); 1123);
896 1124
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 { 1125sub load_extensions {
1126 cf::sync_job {
1127 my %todo;
1128
932 for my $ext (<$LIBDIR/*.ext>) { 1129 for my $path (<$LIBDIR/*.ext>) {
933 next unless -r $ext; 1130 next unless -r $path;
934 eval { 1131
935 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;
936 1 1189 }
937 } or warn "$ext not loaded: $@"; 1190
1191 skip:
1192 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1193 unless $progress;
1194 }
938 } 1195 };
939} 1196}
940 1197
941############################################################################# 1198#############################################################################
942 1199
1200=back
1201
943=head2 CORE EXTENSIONS 1202=head2 CORE EXTENSIONS
944 1203
945Functions and methods that extend core crossfire objects. 1204Functions and methods that extend core crossfire objects.
946 1205
947=cut 1206=cut
959Returns the given player object, loading it if necessary (might block). 1218Returns the given player object, loading it if necessary (might block).
960 1219
961=cut 1220=cut
962 1221
963sub playerdir($) { 1222sub playerdir($) {
964 cf::localdir 1223 "$PLAYERDIR/"
965 . "/"
966 . cf::playerdir
967 . "/"
968 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1224 . (ref $_[0] ? $_[0]->ob->name : $_[0])
969} 1225}
970 1226
971sub path($) { 1227sub path($) {
972 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1228 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
973 1229
974 (playerdir $login) . "/$login.pl" 1230 (playerdir $login) . "/playerdata"
975} 1231}
976 1232
977sub find_active($) { 1233sub find_active($) {
978 $cf::PLAYER{$_[0]} 1234 $cf::PLAYER{$_[0]}
979 and $cf::PLAYER{$_[0]}->active 1235 and $cf::PLAYER{$_[0]}->active
992 my $login = $_[0]; 1248 my $login = $_[0];
993 1249
994 my $guard = cf::lock_acquire "user_find:$login"; 1250 my $guard = cf::lock_acquire "user_find:$login";
995 1251
996 $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
997 my $pl = load_pl path $login 1260 my $pl = load_pl path $login
998 or return; 1261 or return;
999 $cf::PLAYER{$login} = $pl 1262 $cf::PLAYER{$login} = $pl
1000 } 1263 }
1001 } 1264 }
1038 1301
1039=cut 1302=cut
1040 1303
1041sub quit_character { 1304sub quit_character {
1042 my ($pl) = @_; 1305 my ($pl) = @_;
1306
1307 my $name = $pl->ob->name;
1043 1308
1044 $pl->{deny_save} = 1; 1309 $pl->{deny_save} = 1;
1045 $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
1046 1311
1047 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1312 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1052 my $path = playerdir $pl; 1317 my $path = playerdir $pl;
1053 my $temp = "$path~$cf::RUNTIME~deleting~"; 1318 my $temp = "$path~$cf::RUNTIME~deleting~";
1054 aio_rename $path, $temp; 1319 aio_rename $path, $temp;
1055 delete $cf::PLAYER{$pl->ob->name}; 1320 delete $cf::PLAYER{$pl->ob->name};
1056 $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
1057 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;
1058} 1343}
1059 1344
1060=item cf::player::list_logins 1345=item cf::player::list_logins
1061 1346
1062Returns 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
1063while and may block, so not sync_job-capable, ever. 1348while and may block, so not sync_job-capable, ever.
1064 1349
1065=cut 1350=cut
1066 1351
1067sub list_logins { 1352sub list_logins {
1068 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1353 my $dirs = aio_readdir $PLAYERDIR
1069 or return []; 1354 or return [];
1070 1355
1071 my @logins; 1356 my @logins;
1072 1357
1073 for my $login (@$dirs) { 1358 for my $login (@$dirs) {
1108 } 1393 }
1109 1394
1110 \@paths 1395 \@paths
1111} 1396}
1112 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 warn $_;#d#
1441 $_
1442}
1443
1444sub hintmode {
1445 $_[0]{hintmode} = $_[1] if @_ > 1;
1446 $_[0]{hintmode}
1447}
1448
1113=item $player->ext_reply ($msgid, $msgtype, %msg) 1449=item $player->ext_reply ($msgid, %msg)
1114 1450
1115Sends an ext reply to the player. 1451Sends an ext reply to the player.
1116 1452
1117=cut 1453=cut
1118 1454
1119sub ext_reply($$$%) { 1455sub ext_reply($$%) {
1120 my ($self, $id, %msg) = @_; 1456 my ($self, $id, %msg) = @_;
1121 1457
1122 $msg{msgid} = $id; 1458 $msg{msgid} = $id;
1123 1459 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1124 $self->send ("ext " . cf::to_json \%msg);
1125} 1460}
1126 1461
1127package cf; 1462=item $player->ext_event ($type, %msg)
1463
1464Sends an ext event to the client.
1465
1466=cut
1467
1468sub ext_event($$%) {
1469 my ($self, $type, %msg) = @_;
1470
1471 $self->ns->ext_event ($type, %msg);
1472}
1473
1474=head3 cf::region
1475
1476=over 4
1477
1478=cut
1479
1480package cf::region;
1481
1482=item cf::region::find_by_path $path
1483
1484Tries to decuce the likely region for a map knowing only its path.
1485
1486=cut
1487
1488sub find_by_path($) {
1489 my ($path) = @_;
1490
1491 my ($match, $specificity);
1492
1493 for my $region (list) {
1494 if ($region->match && $path =~ $region->match) {
1495 ($match, $specificity) = ($region, $region->specificity)
1496 if $region->specificity > $specificity;
1497 }
1498 }
1499
1500 $match
1501}
1128 1502
1129=back 1503=back
1130
1131 1504
1132=head3 cf::map 1505=head3 cf::map
1133 1506
1134=over 4 1507=over 4
1135 1508
1190 my ($self, $merge) = @_; 1563 my ($self, $merge) = @_;
1191 1564
1192 # we have to keep some variables in memory intact 1565 # we have to keep some variables in memory intact
1193 local $self->{path}; 1566 local $self->{path};
1194 local $self->{load_path}; 1567 local $self->{load_path};
1195 local $self->{deny_save};
1196 local $self->{deny_reset};
1197 1568
1198 $self->SUPER::thawer_merge ($merge); 1569 $self->SUPER::thawer_merge ($merge);
1199} 1570}
1200 1571
1201sub normalise { 1572sub normalise {
1273 1644
1274# the original (read-only) location 1645# the original (read-only) location
1275sub load_path { 1646sub load_path {
1276 my ($self) = @_; 1647 my ($self) = @_;
1277 1648
1278 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1649 "$MAPDIR/$self->{path}.map"
1279} 1650}
1280 1651
1281# the temporary/swap location 1652# the temporary/swap location
1282sub save_path { 1653sub save_path {
1283 my ($self) = @_; 1654 my ($self) = @_;
1284 1655
1285 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1656 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1286 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1657 "$TMPDIR/$path.map"
1287} 1658}
1288 1659
1289# the unique path, undef == no special unique path 1660# the unique path, undef == no special unique path
1290sub uniq_path { 1661sub uniq_path {
1291 my ($self) = @_; 1662 my ($self) = @_;
1292 1663
1293 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1664 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1294 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1665 "$UNIQUEDIR/$path"
1295} 1666}
1296 1667
1297# and all this just because we cannot iterate over 1668# and all this just because we cannot iterate over
1298# all maps in C++... 1669# all maps in C++...
1299sub change_all_map_light { 1670sub change_all_map_light {
1301 1672
1302 $_->change_map_light ($change) 1673 $_->change_map_light ($change)
1303 for grep $_->outdoor, values %cf::MAP; 1674 for grep $_->outdoor, values %cf::MAP;
1304} 1675}
1305 1676
1677sub decay_objects {
1678 my ($self) = @_;
1679
1680 return if $self->{deny_reset};
1681
1682 $self->do_decay_objects;
1683}
1684
1306sub unlink_save { 1685sub unlink_save {
1307 my ($self) = @_; 1686 my ($self) = @_;
1308 1687
1309 utf8::encode (my $save = $self->save_path); 1688 utf8::encode (my $save = $self->save_path);
1310 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1689 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1311 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1690 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1312
1313 #d#TODO remove .map and also nuke
1314 $save =~ s/\.map// or return;#d#
1315 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1316 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1317} 1691}
1318 1692
1319sub load_header_from($) { 1693sub load_header_from($) {
1320 my ($self, $path) = @_; 1694 my ($self, $path) = @_;
1321 1695
1371 $self->load_header_orig 1745 $self->load_header_orig
1372 or return; 1746 or return;
1373 $self->prepare_orig; 1747 $self->prepare_orig;
1374 } 1748 }
1375 1749
1750 $self->{deny_reset} = 1
1751 if $self->no_reset;
1752
1753 $self->default_region (cf::region::find_by_path $self->{path})
1754 unless $self->default_region;
1755
1376 1 1756 1
1377} 1757}
1378 1758
1379sub find; 1759sub find;
1380sub find { 1760sub find {
1392 $map->{last_save} = $cf::RUNTIME; 1772 $map->{last_save} = $cf::RUNTIME;
1393 1773
1394 $map->load_header 1774 $map->load_header
1395 or return; 1775 or return;
1396 1776
1397 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1777 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398 # doing this can freeze the server in a sync job, obviously 1778 # doing this can freeze the server in a sync job, obviously
1399 #$cf::WAIT_FOR_TICK->wait; 1779 #$cf::WAIT_FOR_TICK->wait;
1400 $map->reset; 1780 $map->reset;
1401 undef $guard; 1781 undef $guard;
1402 return find $path; 1782 return find $path;
1413 my ($self) = @_; 1793 my ($self) = @_;
1414 1794
1415 local $self->{deny_reset} = 1; # loading can take a long time 1795 local $self->{deny_reset} = 1; # loading can take a long time
1416 1796
1417 my $path = $self->{path}; 1797 my $path = $self->{path};
1798
1799 {
1418 my $guard = cf::lock_acquire "map_load:$path"; 1800 my $guard = cf::lock_acquire "map_load:$path";
1419 1801
1420 return if $self->in_memory != cf::MAP_SWAPPED; 1802 return if $self->in_memory != cf::MAP_SWAPPED;
1421 1803
1422 $self->in_memory (cf::MAP_LOADING); 1804 $self->in_memory (cf::MAP_LOADING);
1423 1805
1424 $self->alloc; 1806 $self->alloc;
1425 1807
1426 $self->pre_load; 1808 $self->pre_load;
1427
1428 $self->_load_objects ($self->{load_path}, 1)
1429 or return;
1430
1431 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432 if delete $self->{load_original};
1433
1434 if (my $uniq = $self->uniq_path) {
1435 utf8::encode $uniq;
1436 if (aio_open $uniq, O_RDONLY, 0) {
1437 $self->clear_unique_items;
1438 $self->_load_objects ($uniq, 0);
1439 }
1440 }
1441
1442 Coro::cede;
1443
1444 # now do the right thing for maps
1445 $self->link_multipart_objects;
1446
1447 unless ($self->{deny_activate}) {
1448 $self->decay_objects;
1449 $self->fix_auto_apply;
1450 $self->update_buttons;
1451 Coro::cede; 1809 Coro::cede;
1452 $self->set_darkness_map; 1810
1811 $self->_load_objects ($self->{load_path}, 1)
1812 or return;
1813
1814 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1815 if delete $self->{load_original};
1816
1817 if (my $uniq = $self->uniq_path) {
1818 utf8::encode $uniq;
1819 if (aio_open $uniq, O_RDONLY, 0) {
1820 $self->clear_unique_items;
1821 $self->_load_objects ($uniq, 0);
1822 }
1823 }
1824
1825 Coro::cede;
1826 # now do the right thing for maps
1827 $self->link_multipart_objects;
1453 $self->difficulty ($self->estimate_difficulty) 1828 $self->difficulty ($self->estimate_difficulty)
1454 unless $self->difficulty; 1829 unless $self->difficulty;
1455 Coro::cede; 1830 Coro::cede;
1831
1832 unless ($self->{deny_activate}) {
1833 $self->decay_objects;
1834 $self->fix_auto_apply;
1835 $self->update_buttons;
1836 Coro::cede;
1837 $self->set_darkness_map;
1838 Coro::cede;
1456 $self->activate; 1839 $self->activate;
1840 }
1841
1842 $self->in_memory (cf::MAP_IN_MEMORY);
1457 } 1843 }
1458 1844
1459 $self->post_load; 1845 $self->post_load;
1460
1461 $self->in_memory (cf::MAP_IN_MEMORY);
1462} 1846}
1463 1847
1464sub customise_for { 1848sub customise_for {
1465 my ($self, $ob) = @_; 1849 my ($self, $ob) = @_;
1466 1850
1467 return find "~" . $ob->name . "/" . $self->{path} 1851 return find "~" . $ob->name . "/" . $self->{path}
1468 if $self->per_player; 1852 if $self->per_player;
1853
1854# return find "?party/" . $ob->name . "/" . $self->{path}
1855# if $self->per_party;
1469 1856
1470 $self 1857 $self
1471} 1858}
1472 1859
1473# find and load all maps in the 3x3 area around a map 1860# find and load all maps in the 3x3 area around a map
1584 1971
1585sub reset_at { 1972sub reset_at {
1586 my ($self) = @_; 1973 my ($self) = @_;
1587 1974
1588 # TODO: safety, remove and allow resettable per-player maps 1975 # TODO: safety, remove and allow resettable per-player maps
1589 return 1e99 if $self->isa ("ext::map_per_player");#d#
1590 return 1e99 if $self->{deny_reset}; 1976 return 1e99 if $self->{deny_reset};
1591 1977
1592 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1978 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1979 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594 1980
1605 my ($self) = @_; 1991 my ($self) = @_;
1606 1992
1607 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1993 my $lock = cf::lock_acquire "map_data:$self->{path}";
1608 1994
1609 return if $self->players; 1995 return if $self->players;
1610 return if $self->isa ("ext::map_per_player");#d#
1611 1996
1612 warn "resetting map ", $self->path;#d# 1997 warn "resetting map ", $self->path;
1998
1999 $self->in_memory (cf::MAP_SWAPPED);
2000
2001 # need to save uniques path
2002 unless ($self->{deny_save}) {
2003 my $uniq = $self->uniq_path; utf8::encode $uniq;
2004
2005 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2006 if $uniq;
2007 }
1613 2008
1614 delete $cf::MAP{$self->path}; 2009 delete $cf::MAP{$self->path};
1615 2010
1616 $self->in_memory (cf::MAP_SWAPPED);
1617 $self->clear; 2011 $self->clear;
1618 2012
1619 $_->clear_links_to ($self) for values %cf::MAP; 2013 $_->clear_links_to ($self) for values %cf::MAP;
1620 2014
1621 $self->unlink_save; 2015 $self->unlink_save;
1640 $cf::MAP{$self->path} = $self; 2034 $cf::MAP{$self->path} = $self;
1641 2035
1642 $self->reset; # polite request, might not happen 2036 $self->reset; # polite request, might not happen
1643} 2037}
1644 2038
2039=item $maps = cf::map::tmp_maps
2040
2041Returns an arrayref with all map paths of currently instantiated and saved
2042maps. May block.
2043
2044=cut
2045
2046sub tmp_maps() {
2047 [
2048 map {
2049 utf8::decode $_;
2050 /\.map$/
2051 ? normalise $_
2052 : ()
2053 } @{ aio_readdir $TMPDIR or [] }
2054 ]
2055}
2056
2057=item $maps = cf::map::random_maps
2058
2059Returns an arrayref with all map paths of currently instantiated and saved
2060random maps. May block.
2061
2062=cut
2063
2064sub random_maps() {
2065 [
2066 map {
2067 utf8::decode $_;
2068 /\.map$/
2069 ? normalise "?random/$_"
2070 : ()
2071 } @{ aio_readdir $RANDOMDIR or [] }
2072 ]
2073}
2074
1645=item cf::map::unique_maps 2075=item cf::map::unique_maps
1646 2076
1647Returns an arrayref of paths of all shared maps that have 2077Returns an arrayref of paths of all shared maps that have
1648instantiated unique items. May block. 2078instantiated unique items. May block.
1649 2079
1650=cut 2080=cut
1651 2081
1652sub unique_maps() { 2082sub unique_maps() {
1653 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2083 [
1654 or return; 2084 map {
1655
1656 my @paths;
1657
1658 for (@$files) {
1659 utf8::decode $_; 2085 utf8::decode $_;
1660 next if /\.pst$/; 2086 /\.map$/
1661 next unless /^$PATH_SEP/o; 2087 ? normalise $_
1662 2088 : ()
1663 push @paths, cf::map::normalise $_; 2089 } @{ aio_readdir $UNIQUEDIR or [] }
1664 } 2090 ]
1665
1666 \@paths
1667} 2091}
1668 2092
1669package cf; 2093package cf;
1670 2094
1671=back 2095=back
1717 2141
1718 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2142 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1719 2143
1720 if ($self->{record_replies}) { 2144 if ($self->{record_replies}) {
1721 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2145 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2146
1722 } else { 2147 } else {
2148 my $pl = $self->contr;
2149
2150 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2151 my $diag = $pl->{npc_dialog};
2152 $diag->{pl}->ext_reply (
2153 $diag->{id},
2154 msgtype => "reply",
2155 msg => $diag->{pl}->expand_cfpod ($msg),
2156 add_topics => []
2157 );
2158
2159 } else {
1723 $msg = $npc->name . " says: $msg" if $npc; 2160 $msg = $npc->name . " says: $msg" if $npc;
1724 $self->message ($msg, $flags); 2161 $self->message ($msg, $flags);
2162 }
1725 } 2163 }
1726} 2164}
1727 2165
1728=item $player_object->may ("access") 2166=item $player_object->may ("access")
1729 2167
1777 $self->deactivate_recursive; 2215 $self->deactivate_recursive;
1778 2216
1779 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2217 return if UNIVERSAL::isa $self->map, "ext::map_link";
1780 2218
1781 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2219 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1782 if $self->map; 2220 if $self->map && $self->map->{path} ne "{link}";
1783 2221
1784 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2222 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1785} 2223}
1786 2224
1787sub cf::object::player::leave_link { 2225sub cf::object::player::leave_link {
1788 my ($self, $map, $x, $y) = @_; 2226 my ($self, $map, $x, $y) = @_;
2227
2228 return unless $self->contr->active;
1789 2229
1790 my $link_pos = delete $self->{_link_pos}; 2230 my $link_pos = delete $self->{_link_pos};
1791 2231
1792 unless ($map) { 2232 unless ($map) {
1793 # restore original map position 2233 # restore original map position
1811 $map->load; 2251 $map->load;
1812 $map->load_diag; 2252 $map->load_diag;
1813 2253
1814 return unless $self->contr->active; 2254 return unless $self->contr->active;
1815 $self->activate_recursive; 2255 $self->activate_recursive;
2256
2257 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1816 $self->enter_map ($map, $x, $y); 2258 $self->enter_map ($map, $x, $y);
1817} 2259}
1818 2260
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) 2261=item $player_object->goto ($path, $x, $y[, $check->($map)])
1852 2262
2263Moves the player to the given map-path and coordinates by first freezing
2264her, loading and preparing them map, calling the provided $check callback
2265that has to return the map if sucecssful, and then unfreezes the player on
2266the new (success) or old (failed) map position.
2267
1853=cut 2268=cut
2269
2270our $GOTOGEN;
1854 2271
1855sub cf::object::player::goto { 2272sub cf::object::player::goto {
1856 my ($self, $path, $x, $y) = @_; 2273 my ($self, $path, $x, $y, $check) = @_;
2274
2275 # do generation counting so two concurrent goto's will be executed in-order
2276 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1857 2277
1858 $self->enter_link; 2278 $self->enter_link;
1859 2279
1860 (async { 2280 (async {
1861 my $map = eval { 2281 my $map = eval {
1862 my $map = cf::map::find $path; 2282 my $map = cf::map::find $path;
2283
2284 if ($map) {
1863 $map = $map->customise_for ($self) if $map; 2285 $map = $map->customise_for ($self);
2286 $map = $check->($map) if $check && $map;
2287 } else {
2288 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2289 }
2290
1864 $map 2291 $map
2292 };
2293
2294 if ($@) {
2295 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2296 LOG llevError | logBacktrace, Carp::longmess $@;
1865 } or 2297 }
1866 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1867 2298
2299 if ($gen == $self->{_goto_generation}) {
2300 delete $self->{_goto_generation};
1868 $self->leave_link ($map, $x, $y); 2301 $self->leave_link ($map, $x, $y);
2302 }
1869 })->prio (1); 2303 })->prio (1);
1870} 2304}
1871 2305
1872=item $player_object->enter_exit ($exit_object) 2306=item $player_object->enter_exit ($exit_object)
1873 2307
1912 2346
1913 $rmp->{random_seed} ||= $exit->random_seed; 2347 $rmp->{random_seed} ||= $exit->random_seed;
1914 2348
1915 my $data = cf::to_json $rmp; 2349 my $data = cf::to_json $rmp;
1916 my $md5 = Digest::MD5::md5_hex $data; 2350 my $md5 = Digest::MD5::md5_hex $data;
1917 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2351 my $meta = "$RANDOMDIR/$md5.meta";
1918 2352
1919 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2353 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1920 aio_write $fh, 0, (length $data), $data, 0; 2354 aio_write $fh, 0, (length $data), $data, 0;
1921 undef $fh; 2355 undef $fh;
1922 aio_rename "$meta~", $meta; 2356 aio_rename "$meta~", $meta;
1931 2365
1932 return unless $self->type == cf::PLAYER; 2366 return unless $self->type == cf::PLAYER;
1933 2367
1934 if ($exit->slaying eq "/!") { 2368 if ($exit->slaying eq "/!") {
1935 #TODO: this should de-fi-ni-te-ly not be a sync-job 2369 #TODO: this should de-fi-ni-te-ly not be a sync-job
2370 # the problem is that $exit might not survive long enough
2371 # so it needs to be done right now, right here
1936 cf::sync_job { prepare_random_map $exit }; 2372 cf::sync_job { prepare_random_map $exit };
1937 } 2373 }
1938 2374
1939 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2375 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1940 my $hp = $exit->stats->hp; 2376 my $hp = $exit->stats->hp;
1941 my $sp = $exit->stats->sp; 2377 my $sp = $exit->stats->sp;
1942 2378
1943 $self->enter_link; 2379 $self->enter_link;
2380
2381 # if exit is damned, update players death & WoR home-position
2382 $self->contr->savebed ($slaying, $hp, $sp)
2383 if $exit->flag (FLAG_DAMNED);
1944 2384
1945 (async { 2385 (async {
1946 $self->deactivate_recursive; # just to be sure 2386 $self->deactivate_recursive; # just to be sure
1947 unless (eval { 2387 unless (eval {
1948 $self->goto ($slaying, $hp, $sp); 2388 $self->goto ($slaying, $hp, $sp);
1949 2389
1950 1; 2390 1;
1951 }) { 2391 }) {
1952 $self->message ("Something went wrong deep within the crossfire server. " 2392 $self->message ("Something went wrong deep within the crossfire server. "
1953 . "I'll try to bring you back to the map you were before. " 2393 . "I'll try to bring you back to the map you were before. "
1954 . "Please report this to the dungeon master!", 2394 . "Please report this to the dungeon master!",
1955 cf::NDI_UNIQUE | cf::NDI_RED); 2395 cf::NDI_UNIQUE | cf::NDI_RED);
1956 2396
1957 warn "ERROR in enter_exit: $@"; 2397 warn "ERROR in enter_exit: $@";
1958 $self->leave_link; 2398 $self->leave_link;
1959 } 2399 }
1960 })->prio (1); 2400 })->prio (1);
1973 2413
1974sub cf::client::send_drawinfo { 2414sub cf::client::send_drawinfo {
1975 my ($self, $text, $flags) = @_; 2415 my ($self, $text, $flags) = @_;
1976 2416
1977 utf8::encode $text; 2417 utf8::encode $text;
1978 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2418 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1979} 2419}
1980 2420
2421=item $client->send_msg ($color, $type, $msg, [extra...])
2422
2423Send a drawinfo or msg packet to the client, formatting the msg for the
2424client if neccessary. C<$type> should be a string identifying the type of
2425the message, with C<log> being the default. If C<$color> is negative, suppress
2426the message unless the client supports the msg packet.
2427
2428=cut
2429
2430sub cf::client::send_msg {
2431 my ($self, $color, $type, $msg, @extra) = @_;
2432
2433 $msg = $self->pl->expand_cfpod ($msg);
2434
2435 return unless @extra || length $msg;
2436
2437 if ($self->can_msg) {
2438 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2439 } else {
2440 # replace some tags by gcfclient-compatible ones
2441 for ($msg) {
2442 1 while
2443 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2444 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2445 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2446 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2447 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2448 }
2449
2450 if ($color >= 0) {
2451 if (0 && $msg =~ /\[/) {
2452 $self->send_packet ("drawextinfo $color 4 0 $msg")
2453 } else {
2454 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2455 $self->send_packet ("drawinfo $color $msg")
2456 }
2457 }
2458 }
2459}
2460
2461=item $client->ext_event ($type, %msg)
2462
2463Sends an ext event to the client.
2464
2465=cut
2466
2467sub cf::client::ext_event($$%) {
2468 my ($self, $type, %msg) = @_;
2469
2470 $msg{msgtype} = "event_$type";
2471 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2472}
1981 2473
1982=item $success = $client->query ($flags, "text", \&cb) 2474=item $success = $client->query ($flags, "text", \&cb)
1983 2475
1984Queues a query to the client, calling the given callback with 2476Queues a query to the client, calling the given callback with
1985the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2477the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1986C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2478C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1987 2479
1988Queries can fail, so check the return code. Or don't, as queries will become 2480Queries can fail, so check the return code. Or don't, as queries will
1989reliable at some point in the future. 2481become reliable at some point in the future.
1990 2482
1991=cut 2483=cut
1992 2484
1993sub cf::client::query { 2485sub cf::client::query {
1994 my ($self, $flags, $text, $cb) = @_; 2486 my ($self, $flags, $text, $cb) = @_;
2002 utf8::encode $text; 2494 utf8::encode $text;
2003 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2495 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2004 2496
2005 $self->send_packet ($self->{query_queue}[0][0]) 2497 $self->send_packet ($self->{query_queue}[0][0])
2006 if @{ $self->{query_queue} } == 1; 2498 if @{ $self->{query_queue} } == 1;
2499
2500 1
2007} 2501}
2008 2502
2009cf::client->attach ( 2503cf::client->attach (
2504 on_connect => sub {
2505 my ($ns) = @_;
2506
2507 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2508 },
2010 on_reply => sub { 2509 on_reply => sub {
2011 my ($ns, $msg) = @_; 2510 my ($ns, $msg) = @_;
2012 2511
2013 # this weird shuffling is so that direct followup queries 2512 # this weird shuffling is so that direct followup queries
2014 # get handled first 2513 # get handled first
2026 } else { 2525 } else {
2027 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2526 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2028 } 2527 }
2029 } 2528 }
2030 }, 2529 },
2530 on_exticmd => sub {
2531 my ($ns, $buf) = @_;
2532
2533 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2534
2535 if (ref $msg) {
2536 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2537 if (my %reply = $cb->($ns, $msg)) {
2538 $reply{msgid} = $msg->{msgid};
2539 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2540 }
2541 }
2542 } else {
2543 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2544 }
2545
2546 cf::override;
2547 },
2031); 2548);
2032 2549
2033=item $client->async (\&cb) 2550=item $client->async (\&cb)
2034 2551
2035Create a new coroutine, running the specified callback. The coroutine will 2552Create a new coroutine, running the specified callback. The coroutine will
2082 2599
2083# here we export the classes and methods available to script code 2600# here we export the classes and methods available to script code
2084 2601
2085=pod 2602=pod
2086 2603
2087The following fucntions and emthods are available within a safe environment: 2604The following functions and methods are available within a safe environment:
2088 2605
2089 cf::object contr pay_amount pay_player map 2606 cf::object
2607 contr pay_amount pay_player map x y force_find force_add
2608 insert remove
2609
2090 cf::object::player player 2610 cf::object::player
2091 cf::player peaceful 2611 player
2092 cf::map trigger 2612
2613 cf::player
2614 peaceful
2615
2616 cf::map
2617 trigger
2093 2618
2094=cut 2619=cut
2095 2620
2096for ( 2621for (
2097 ["cf::object" => qw(contr pay_amount pay_player map)], 2622 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2623 insert remove)],
2098 ["cf::object::player" => qw(player)], 2624 ["cf::object::player" => qw(player)],
2099 ["cf::player" => qw(peaceful)], 2625 ["cf::player" => qw(peaceful)],
2100 ["cf::map" => qw(trigger)], 2626 ["cf::map" => qw(trigger)],
2101) { 2627) {
2102 no strict 'refs'; 2628 no strict 'refs';
2173=back 2699=back
2174 2700
2175=cut 2701=cut
2176 2702
2177############################################################################# 2703#############################################################################
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
2202unless ($DB) {
2203 $DB = BDB::db_create $DB_ENV;
2204
2205 cf::sync_job {
2206 eval {
2207 $DB->set_flags (BDB::CHKSUM);
2208
2209 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2210 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2211 cf::cleanup "db_open(db): $!" if $!;
2212 };
2213 cf::cleanup "db_open(db): $@" if $@;
2214 };
2215
2216 my $path = cf::localdir . "/database.pst";
2217 if (stat $path) {
2218 cf::sync_job {
2219 my $pst = Storable::retrieve $path;
2220
2221 cf::db_put (board => data => $pst->{board});
2222 cf::db_put (guildrules => data => $pst->{guildrules});
2223 cf::db_put (rent => balance => $pst->{rent}{balance});
2224 BDB::db_env_txn_checkpoint $DB_ENV;
2225
2226 unlink $path;
2227 };
2228 }
2229}
2230
2231sub db_get($$) {
2232 my $key = "$_[0]/$_[1]";
2233
2234 cf::sync_job {
2235 BDB::db_get $DB, undef, $key, my $data;
2236
2237 $! ? ()
2238 : Compress::LZF::sthaw $data
2239 }
2240}
2241
2242sub db_put($$$) {
2243 BDB::dbreq_pri 4;
2244 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2245}
2246
2247#############################################################################
2248# the server's init and main functions 2704# the server's init and main functions
2249 2705
2250sub load_resources { 2706sub load_facedata($) {
2251 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2707 my ($path) = @_;
2708
2709 warn "loading facedata from $path\n";
2710
2711 my $facedata;
2712 0 < aio_load $path, $facedata
2713 or die "$path: $!";
2714
2715 $facedata = Coro::Storable::thaw $facedata;
2716
2717 $facedata->{version} == 2
2718 or cf::cleanup "$path: version mismatch, cannot proceed.";
2719
2720 {
2721 my $faces = $facedata->{faceinfo};
2722
2723 while (my ($face, $info) = each %$faces) {
2724 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2725 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2726 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2727 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2728 Coro::cede;
2729 }
2730
2731 while (my ($face, $info) = each %$faces) {
2732 next unless $info->{smooth};
2733 my $idx = cf::face::find $face
2734 or next;
2735 if (my $smooth = cf::face::find $info->{smooth}) {
2736 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2737 } else {
2738 warn "smooth face '$info->{smooth}' not found for face '$face'";
2739 }
2740 Coro::cede;
2741 }
2742 }
2743
2744 {
2745 my $anims = $facedata->{animinfo};
2746
2747 while (my ($anim, $info) = each %$anims) {
2748 cf::anim::set $anim, $info->{frames}, $info->{facings};
2749 Coro::cede;
2750 }
2751
2752 cf::anim::invalidate_all; # d'oh
2753 }
2754
2755 1
2756}
2757
2758sub reload_regions {
2759 load_resource_file "$MAPDIR/regions"
2252 or die "unable to load regions file\n";#d# 2760 or die "unable to load regions file\n";
2761}
2762
2763sub reload_facedata {
2764 load_facedata "$DATADIR/facedata"
2765 or die "unable to load facedata\n";
2766}
2767
2768sub reload_archetypes {
2769 load_resource_file "$DATADIR/archetypes"
2770 or die "unable to load archetypes\n";
2771 #d# NEED to laod twice to resolve forward references
2772 # this really needs to be done in an extra post-pass
2773 # (which needs to be synchronous, so solve it differently)
2774 load_resource_file "$DATADIR/archetypes"
2775 or die "unable to load archetypes\n";
2776}
2777
2778sub reload_treasures {
2779 load_resource_file "$DATADIR/treasures"
2780 or die "unable to load treasurelists\n";
2781}
2782
2783sub reload_resources {
2784 warn "reloading resource files...\n";
2785
2786 reload_regions;
2787 reload_facedata;
2788 #reload_archetypes;#d#
2789 reload_archetypes;
2790 reload_treasures;
2791
2792 warn "finished reloading resource files\n";
2793}
2794
2795sub init {
2796 reload_resources;
2253} 2797}
2254 2798
2255sub cfg_load { 2799sub cfg_load {
2256 open my $fh, "<:utf8", cf::confdir . "/config" 2800 open my $fh, "<:utf8", "$CONFDIR/config"
2257 or return; 2801 or return;
2258 2802
2259 local $/; 2803 local $/;
2260 *CFG = YAML::Syck::Load <$fh>; 2804 *CFG = YAML::Syck::Load <$fh>;
2261 2805
2269 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2813 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2270 and die "WARNING: m(un)lockall failed: $!\n"; 2814 and die "WARNING: m(un)lockall failed: $!\n";
2271 }; 2815 };
2272 warn $@ if $@; 2816 warn $@ if $@;
2273 } 2817 }
2274}
2275
2276sub init {
2277 load_resources;
2278} 2818}
2279 2819
2280sub main { 2820sub main {
2281 # we must not ever block the main coroutine 2821 # we must not ever block the main coroutine
2282 local $Coro::idle = sub { 2822 local $Coro::idle = sub {
2285 Event::one_event; 2825 Event::one_event;
2286 })->prio (Coro::PRIO_MAX); 2826 })->prio (Coro::PRIO_MAX);
2287 }; 2827 };
2288 2828
2289 cfg_load; 2829 cfg_load;
2830 db_init;
2290 load_extensions; 2831 load_extensions;
2291 2832
2292 $TICK_WATCHER->start; 2833 $TICK_WATCHER->start;
2293 Event::loop; 2834 Event::loop;
2294} 2835}
2309 }, 2850 },
2310 ); 2851 );
2311 } 2852 }
2312} 2853}
2313 2854
2855sub write_runtime {
2856 my $runtime = "$LOCALDIR/runtime";
2857
2858 # first touch the runtime file to show we are still running:
2859 # the fsync below can take a very very long time.
2860
2861 IO::AIO::aio_utime $runtime, undef, undef;
2862
2863 my $guard = cf::lock_acquire "write_runtime";
2864
2865 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2866 or return;
2867
2868 my $value = $cf::RUNTIME + 90 + 10;
2869 # 10 is the runtime save interval, for a monotonic clock
2870 # 60 allows for the watchdog to kill the server.
2871
2872 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2873 and return;
2874
2875 # always fsync - this file is important
2876 aio_fsync $fh
2877 and return;
2878
2879 # touch it again to show we are up-to-date
2880 aio_utime $fh, undef, undef;
2881
2882 close $fh
2883 or return;
2884
2885 aio_rename "$runtime~", $runtime
2886 and return;
2887
2888 warn "runtime file written.\n";
2889
2890 1
2891}
2892
2314sub emergency_save() { 2893sub emergency_save() {
2315 my $freeze_guard = cf::freeze_mainloop; 2894 my $freeze_guard = cf::freeze_mainloop;
2316 2895
2317 warn "enter emergency perl save\n"; 2896 warn "enter emergency perl save\n";
2318 2897
2342 }; 2921 };
2343 2922
2344 warn "leave emergency perl save\n"; 2923 warn "leave emergency perl save\n";
2345} 2924}
2346 2925
2926sub post_cleanup {
2927 my ($make_core) = @_;
2928
2929 warn Carp::longmess "post_cleanup backtrace"
2930 if $make_core;
2931}
2932
2347sub reload() { 2933sub do_reload_perl() {
2348 # can/must only be called in main 2934 # can/must only be called in main
2349 if ($Coro::current != $Coro::main) { 2935 if ($Coro::current != $Coro::main) {
2350 warn "can only reload from main coroutine"; 2936 warn "can only reload from main coroutine";
2351 return; 2937 return;
2352 } 2938 }
2353 2939
2354 warn "reloading..."; 2940 warn "reloading...";
2355 2941
2356 warn "cancelling server ticker"; 2942 warn "entering sync_job";
2357 $TICK_WATCHER->cancel;
2358 2943
2944 cf::sync_job {
2945 cf::write_runtime; # external watchdog should not bark
2359 cf::emergency_save; 2946 cf::emergency_save;
2947 cf::write_runtime; # external watchdog should not bark
2360 2948
2361 eval { 2949 warn "syncing database to disk";
2950 BDB::db_env_txn_checkpoint $DB_ENV;
2951
2362 # if anything goes wrong in here, we should simply crash as we already saved 2952 # if anything goes wrong in here, we should simply crash as we already saved
2363 2953
2364 warn "cancelling all WF_AUTOCANCEL watchers"; 2954 warn "cancelling all WF_AUTOCANCEL watchers";
2365 for (Event::all_watchers) { 2955 for (Event::all_watchers) {
2366 $_->cancel if $_->data & WF_AUTOCANCEL; 2956 $_->cancel if $_->data & WF_AUTOCANCEL;
2367 } 2957 }
2368
2369 warn "syncing database to disk";
2370 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2371 2958
2372 warn "flushing outstanding aio requests"; 2959 warn "flushing outstanding aio requests";
2373 for (;;) { 2960 for (;;) {
2374 BDB::flush; 2961 BDB::flush;
2375 IO::AIO::flush; 2962 IO::AIO::flush;
2376 Coro::cede; 2963 Coro::cede;
2377 last unless IO::AIO::nreqs || BDB::nreqs; 2964 last unless IO::AIO::nreqs || BDB::nreqs;
2378 warn "iterate..."; 2965 warn "iterate...";
2379 } 2966 }
2380 2967
2968 ++$RELOAD;
2969
2381 warn "cancelling all extension coros"; 2970 warn "cancelling all extension coros";
2382 $_->cancel for values %EXT_CORO; 2971 $_->cancel for values %EXT_CORO;
2383 %EXT_CORO = (); 2972 %EXT_CORO = ();
2384 2973
2385 warn "removing commands"; 2974 warn "removing commands";
2386 %COMMAND = (); 2975 %COMMAND = ();
2387 2976
2388 warn "removing ext commands"; 2977 warn "removing ext/exti commands";
2389 %EXTCMD = (); 2978 %EXTCMD = ();
2979 %EXTICMD = ();
2390 2980
2391 warn "unloading/nuking all extensions"; 2981 warn "unloading/nuking all extensions";
2392 for my $pkg (@EXTS) { 2982 for my $pkg (@EXTS) {
2393 warn "... unloading $pkg"; 2983 warn "... unloading $pkg";
2394 2984
2424 Symbol::delete_package "safe::$_" 3014 Symbol::delete_package "safe::$_"
2425 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3015 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2426 3016
2427 warn "unloading cf.pm \"a bit\""; 3017 warn "unloading cf.pm \"a bit\"";
2428 delete $INC{"cf.pm"}; 3018 delete $INC{"cf.pm"};
3019 delete $INC{"cf/pod.pm"};
2429 3020
2430 # don't, removes xs symbols, too, 3021 # don't, removes xs symbols, too,
2431 # and global variables created in xs 3022 # and global variables created in xs
2432 #Symbol::delete_package __PACKAGE__; 3023 #Symbol::delete_package __PACKAGE__;
2433 3024
2442 3033
2443 warn "loading extensions"; 3034 warn "loading extensions";
2444 cf::load_extensions; 3035 cf::load_extensions;
2445 3036
2446 warn "reattaching attachments to objects/players"; 3037 warn "reattaching attachments to objects/players";
2447 _global_reattach; 3038 _global_reattach; # objects, sockets
2448 warn "reattaching attachments to maps"; 3039 warn "reattaching attachments to maps";
2449 reattach $_ for values %MAP; 3040 reattach $_ for values %MAP;
3041 warn "reattaching attachments to players";
3042 reattach $_ for values %PLAYER;
2450 3043
2451 warn "loading reloadable resources"; 3044 warn "leaving sync_job";
2452 load_resources;
2453 3045
2454 warn "restarting server ticker"; 3046 1
2455 3047 } or do {
2456 $TICK_WATCHER->start;
2457 };
2458
2459 if ($@) {
2460 warn $@; 3048 warn $@;
2461 warn "error while reloading, exiting."; 3049 warn "error while reloading, exiting.";
2462 exit 1; 3050 exit 1;
2463 } 3051 };
2464 3052
2465 warn "reloaded"; 3053 warn "reloaded";
2466}; 3054};
2467 3055
2468our $RELOAD_WATCHER; # used only during reload 3056our $RELOAD_WATCHER; # used only during reload
2469 3057
3058sub reload_perl() {
3059 # doing reload synchronously and two reloads happen back-to-back,
3060 # coro crashes during coro_state_free->destroy here.
3061
3062 $RELOAD_WATCHER ||= Event->timer (
3063 reentrant => 0,
3064 after => 0,
3065 data => WF_AUTOCANCEL,
3066 cb => sub {
3067 do_reload_perl;
3068 undef $RELOAD_WATCHER;
3069 },
3070 );
3071}
3072
2470register_command "reload" => sub { 3073register_command "reload" => sub {
2471 my ($who, $arg) = @_; 3074 my ($who, $arg) = @_;
2472 3075
2473 if ($who->flag (FLAG_WIZ)) { 3076 if ($who->flag (FLAG_WIZ)) {
2474 $who->message ("reloading server."); 3077 $who->message ("reloading server.");
2475 3078 async { reload_perl };
2476 # doing reload synchronously and two reloads happen back-to-back,
2477 # coro crashes during coro_state_free->destroy here.
2478
2479 $RELOAD_WATCHER ||= Event->timer (
2480 reentrant => 0,
2481 after => 0,
2482 data => WF_AUTOCANCEL,
2483 cb => sub {
2484 reload;
2485 undef $RELOAD_WATCHER;
2486 },
2487 );
2488 } 3079 }
2489}; 3080};
2490 3081
2491unshift @INC, $LIBDIR; 3082unshift @INC, $LIBDIR;
2492 3083
2493my $bug_warning = 0; 3084my $bug_warning = 0;
2494 3085
3086our @WAIT_FOR_TICK;
3087our @WAIT_FOR_TICK_BEGIN;
3088
3089sub wait_for_tick {
3090 return unless $TICK_WATCHER->is_active;
3091 return if $Coro::current == $Coro::main;
3092
3093 my $signal = new Coro::Signal;
3094 push @WAIT_FOR_TICK, $signal;
3095 $signal->wait;
3096}
3097
3098sub wait_for_tick_begin {
3099 return unless $TICK_WATCHER->is_active;
3100 return if $Coro::current == $Coro::main;
3101
3102 my $signal = new Coro::Signal;
3103 push @WAIT_FOR_TICK_BEGIN, $signal;
3104 $signal->wait;
3105}
3106
3107 my $min = 1e6;#d#
3108 my $avg = 10;
2495$TICK_WATCHER = Event->timer ( 3109$TICK_WATCHER = Event->timer (
2496 reentrant => 0, 3110 reentrant => 0,
2497 parked => 1, 3111 parked => 1,
2498 prio => 0, 3112 prio => 0,
2499 at => $NEXT_TICK || $TICK, 3113 at => $NEXT_TICK || $TICK,
2503 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3117 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2504 unless ++$bug_warning > 10; 3118 unless ++$bug_warning > 10;
2505 return; 3119 return;
2506 } 3120 }
2507 3121
2508 $NOW = Event::time; 3122 $NOW = $tick_start = Event::time;
2509 3123
2510 cf::server_tick; # one server iteration 3124 cf::server_tick; # one server iteration
3125
3126 0 && sync_job {#d#
3127 for(1..10) {
3128 my $t = Event::time;
3129 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3130 or die;
3131
3132 $map->width (50);
3133 $map->height (50);
3134 $map->alloc;
3135 $map->_load_objects ("/tmp/x.map", 1);
3136 my $t = Event::time - $t;
3137
3138 #next unless $t < 0.0013;#d#
3139 if ($t < $min) {
3140 $min = $t;
3141 }
3142 $avg = $avg * 0.99 + $t * 0.01;
3143 }
3144 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3145 exit 0;
3146 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3147 };
3148
2511 $RUNTIME += $TICK; 3149 $RUNTIME += $TICK;
2512 $NEXT_TICK += $TICK; 3150 $NEXT_TICK += $TICK;
2513 3151
2514 $WAIT_FOR_TICK->broadcast; 3152 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2515 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3153 $NEXT_RUNTIME_WRITE = $NOW + 10;
2516 3154 Coro::async_pool {
2517 Event::sweep; 3155 write_runtime
2518 Coro::cede_notself; 3156 or warn "ERROR: unable to write runtime file: $!";
3157 };
2519 3158 }
3159
2520# my $AFTER = Event::time; 3160# my $AFTER = Event::time;
2521# warn $AFTER - $NOW;#d# 3161# warn $AFTER - $NOW;#d#
2522 3162
3163 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3164 $sig->send;
3165 }
3166 while (my $sig = shift @WAIT_FOR_TICK) {
3167 $sig->send;
3168 }
3169
3170 $NOW = Event::time;
3171
2523 # if we are delayed by four ticks or more, skip them all 3172 # if we are delayed by four ticks or more, skip them all
2524 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3173 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2525 3174
2526 $TICK_WATCHER->at ($NEXT_TICK); 3175 $TICK_WATCHER->at ($NEXT_TICK);
2527 $TICK_WATCHER->start; 3176 $TICK_WATCHER->start;
3177
3178 $LOAD = ($NOW - $tick_start) / $TICK;
3179 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3180
3181 _post_tick;
3182
3183
2528 }, 3184 },
2529); 3185);
2530 3186
2531{ 3187{
2532 BDB::max_poll_time $TICK * 0.1; 3188 BDB::max_poll_time $TICK * 0.1;
2560 3216
2561 cf::sync_job { 3217 cf::sync_job {
2562 eval { 3218 eval {
2563 BDB::db_env_open 3219 BDB::db_env_open
2564 $DB_ENV, 3220 $DB_ENV,
2565 $BDB_ENV_DIR, 3221 $BDBDIR,
2566 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3222 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2567 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3223 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2568 0666; 3224 0666;
2569 3225
2570 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3226 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2571 3227
2572 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3228 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2573 $DB_ENV->set_lk_detect; 3229 $DB_ENV->set_lk_detect;
2574 }; 3230 };
2575 3231
2583 3239
2584 undef $Coro::AIO::WATCHER; 3240 undef $Coro::AIO::WATCHER;
2585 IO::AIO::max_poll_time $TICK * 0.1; 3241 IO::AIO::max_poll_time $TICK * 0.1;
2586 $AIO_POLL_WATCHER = Event->io ( 3242 $AIO_POLL_WATCHER = Event->io (
2587 reentrant => 0, 3243 reentrant => 0,
3244 data => WF_AUTOCANCEL,
2588 fd => IO::AIO::poll_fileno, 3245 fd => IO::AIO::poll_fileno,
2589 poll => 'r', 3246 poll => 'r',
2590 prio => 6, 3247 prio => 6,
2591 data => WF_AUTOCANCEL,
2592 cb => \&IO::AIO::poll_cb, 3248 cb => \&IO::AIO::poll_cb,
2593 ); 3249 );
2594} 3250}
2595 3251
2596$WRITE_RUNTIME_WATCHER = Event->timer ( 3252my $_log_backtrace;
2597 reentrant => 0, 3253
2598 data => WF_AUTOCANCEL, 3254sub _log_backtrace {
2599 after => 1, 3255 my ($msg, @addr) = @_;
2600 interval => 10, 3256
2601 prio => 6, # keep it lowest so it acts like a watchdog 3257 $msg =~ s/\n//;
2602 cb => Coro::unblock_sub { 3258
2603 write_runtime 3259 # limit the # of concurrent backtraces
2604 or warn "ERROR: unable to write runtime file: $!"; 3260 if ($_log_backtrace < 2) {
3261 ++$_log_backtrace;
3262 async {
3263 my @bt = fork_call {
3264 @addr = map { sprintf "%x", $_ } @addr;
3265 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3266 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3267 or die "addr2line: $!";
3268
3269 my @funcs;
3270 my @res = <$fh>;
3271 chomp for @res;
3272 while (@res) {
3273 my ($func, $line) = splice @res, 0, 2, ();
3274 push @funcs, "[$func] $line";
3275 }
3276
3277 @funcs
3278 };
3279
3280 LOG llevInfo, "[ABT] $msg\n";
3281 LOG llevInfo, "[ABT] $_\n" for @bt;
3282 --$_log_backtrace;
3283 };
3284 } else {
3285 LOG llevInfo, "[ABT] $msg\n";
3286 LOG llevInfo, "[ABT] [suppressed]\n";
2605 }, 3287 }
2606); 3288}
3289
3290# load additional modules
3291use cf::pod;
2607 3292
2608END { cf::emergency_save } 3293END { cf::emergency_save }
2609 3294
26101 32951
2611 3296

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines