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.207 by root, Sun Feb 11 22:42:09 2007 UTC vs.
Revision 1.350 by root, Sat Sep 1 08:03:45 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.64 ();
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;
24use Coro::Util ();
19 25
26use JSON::XS ();
20use BDB (); 27use BDB ();
21use Data::Dumper; 28use Data::Dumper;
22use Digest::MD5; 29use Digest::MD5;
23use Fcntl; 30use Fcntl;
31use YAML::Syck ();
24use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
25use YAML::Syck ();
26use Time::HiRes; 33use Time::HiRes;
34use Compress::LZF;
35use Digest::MD5 ();
27 36
37# configure various modules to our taste
38#
39$Storable::canonical = 1; # reduce rsync transfers
40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
41Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
42
28use Event; $Event::Eval = 1; # no idea why this is required, but it is 43$Event::Eval = 1; # no idea why this is required, but it is
29
30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31 44
32# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 45# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
33$YAML::Syck::ImplicitUnicode = 1; 46$YAML::Syck::ImplicitUnicode = 1;
34 47
35$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 48$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
36 49
50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
51
37our %COMMAND = (); 52our %COMMAND = ();
38our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
39 54
40our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
41our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
42our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
43our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
44 60
61our $RELOAD; # number of reloads so far
45our @EVENT; 62our @EVENT;
46our $LIBDIR = datadir . "/ext";
47 63
48our $TICK = MAX_TIME * 1e-6; 64our $CONFDIR = confdir;
65our $DATADIR = datadir;
66our $LIBDIR = "$DATADIR/ext";
67our $PODDIR = "$DATADIR/pod";
68our $MAPDIR = "$DATADIR/" . mapdir;
69our $LOCALDIR = localdir;
70our $TMPDIR = "$LOCALDIR/" . tmpdir;
71our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
72our $PLAYERDIR = "$LOCALDIR/" . playerdir;
73our $RANDOMDIR = "$LOCALDIR/random";
74our $BDBDIR = "$LOCALDIR/db";
75
76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
49our $TICK_WATCHER; 77our $TICK_WATCHER;
50our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
51our $WRITE_RUNTIME_WATCHER; 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
52our $NEXT_TICK; 80our $NEXT_TICK;
53our $NOW; 81our $NOW;
54our $USE_FSYNC = 1; # use fsync to write maps - default off 82our $USE_FSYNC = 1; # use fsync to write maps - default off
55 83
56our $BDB_POLL_WATCHER; 84our $BDB_POLL_WATCHER;
62our $RUNTIME; 90our $RUNTIME;
63 91
64our %PLAYER; # all users 92our %PLAYER; # all users
65our %MAP; # all maps 93our %MAP; # all maps
66our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
67our $RANDOM_MAPS = cf::localdir . "/random";
68our $BDB_ENV_DIR = cf::localdir . "/db";
69
70our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
71our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
72 95
73# used to convert map paths into valid unix filenames by replacing / by ∕ 96# used to convert map paths into valid unix filenames by replacing / by ∕
74our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
75 98
99our $LOAD; # a number between 0 (idle) and 1 (too many objects)
100our $LOADAVG; # same thing, but with alpha-smoothing
101our $tick_start; # for load detecting purposes
102
76binmode STDOUT; 103binmode STDOUT;
77binmode STDERR; 104binmode STDERR;
78 105
79# read virtual server time, if available 106# read virtual server time, if available
80unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
81 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
82 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
83 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
84} 111}
85 112
86mkdir cf::localdir; 113mkdir $_
87mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
88mkdir cf::localdir . "/" . cf::tmpdir;
89mkdir cf::localdir . "/" . cf::uniquedir;
90mkdir $RANDOM_MAPS;
91mkdir $BDB_ENV_DIR;
92 115
93our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
94 117
95sub cf::map::normalise; 118sub cf::map::normalise;
96 119
107=item $cf::RUNTIME 130=item $cf::RUNTIME
108 131
109The time this server has run, starts at 0 and is increased by $cf::TICK on 132The time this server has run, starts at 0 and is increased by $cf::TICK on
110every server tick. 133every server tick.
111 134
112=item $cf::LIBDIR 135=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
136$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
137$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
113 138
114The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
115be found. It will be added to C<@INC> automatically. 140directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
141unique-items directory, player file directory, random maps directory and
142database environment.
116 143
117=item $cf::NOW 144=item $cf::NOW
118 145
119The time of the last (current) server tick. 146The time of the last (current) server tick.
120 147
121=item $cf::TICK 148=item $cf::TICK
122 149
123The interval between server ticks, in seconds. 150The interval between server ticks, in seconds.
151
152=item $cf::LOADAVG
153
154The current CPU load on the server (alpha-smoothed), as a value between 0
155(none) and 1 (overloaded), indicating how much time is spent on processing
156objects per tick. Healthy values are < 0.5.
157
158=item $cf::LOAD
159
160The raw value load value from the last tick.
124 161
125=item %cf::CFG 162=item %cf::CFG
126 163
127Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
128from wherever your confdir points to. 165from wherever your confdir points to.
129 166
130=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 167=item cf::wait_for_tick, cf::wait_for_tick_begin
131 168
132These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
133or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 170returns directly I<after> the tick processing (and consequently, can only wake one process
134processing has been done. Call C<< ->wait >> on them to maximise the 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
135window of cpu time available, or simply to synchronise to the server tick. 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
136 178
137=back 179=back
138 180
139=cut 181=cut
140 182
141BEGIN { 183BEGIN {
142 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
143 my $msg = join "", @_; 185 my $msg = join "", @_;
144 utf8::encode $msg;
145 186
146 $msg .= "\n" 187 $msg .= "\n"
147 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
148 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
149 LOG llevError, $msg; 193 LOG llevError, $msg;
150 }; 194 };
151} 195}
152 196
153@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
154@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
155@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
156@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
157@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 201@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
202@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
158@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 203@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
159 204
160# we bless all objects into (empty) derived classes to force a method lookup 205# we bless all objects into (empty) derived classes to force a method lookup
161# within the Safe compartment. 206# within the Safe compartment.
162for my $pkg (qw( 207for my $pkg (qw(
163 cf::global cf::attachable 208 cf::global cf::attachable
171} 216}
172 217
173$Event::DIED = sub { 218$Event::DIED = sub {
174 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
175}; 220};
221
222#############################################################################
176 223
177=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
178 225
179=over 4 226=over 4
180 227
199 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
200 $d 247 $d
201 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
202} 249}
203 250
204use JSON::Syck (); # TODO# replace by JSON::PC once working
205
206=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
207 252
208Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
209 254
210=cut
211
212sub from_json($) {
213 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
214 JSON::Syck::Load $_[0]
215}
216
217=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
218 256
219Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
220 258
221=cut 259=cut
222 260
223sub to_json($) { 261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
224 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 262
225 JSON::Syck::Dump $_[0] 263sub to_json ($) { $json_coder->encode ($_[0]) }
226} 264sub from_json ($) { $json_coder->decode ($_[0]) }
227 265
228=item cf::lock_wait $string 266=item cf::lock_wait $string
229 267
230Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
231 269
234Wait until the given lock is available and then acquires it and returns 272Wait until the given lock is available and then acquires it and returns
235a Coro::guard object. If the guard object gets destroyed (goes out of scope, 273a Coro::guard object. If the guard object gets destroyed (goes out of scope,
236for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
237returned. 275returned.
238 276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
279
239Lock names should begin with a unique identifier (for example, cf::map::find 280Lock names should begin with a unique identifier (for example, cf::map::find
240uses map_find and cf::map::load uses map_load). 281uses map_find and cf::map::load uses map_load).
282
283=item $locked = cf::lock_active $string
284
285Return true if the lock is currently active, i.e. somebody has locked it.
241 286
242=cut 287=cut
243 288
244our %LOCK; 289our %LOCK;
245 290
265 # wake up all waiters, to be on the safe side 310 # wake up all waiters, to be on the safe side
266 $_->ready for @{ delete $LOCK{$key} }; 311 $_->ready for @{ delete $LOCK{$key} };
267 } 312 }
268} 313}
269 314
315sub lock_active($) {
316 my ($key) = @_;
317
318 ! ! $LOCK{$key}
319}
320
270sub freeze_mainloop { 321sub freeze_mainloop {
271 return unless $TICK_WATCHER->is_active; 322 return unless $TICK_WATCHER->is_active;
272 323
273 my $guard = Coro::guard { 324 my $guard = Coro::guard {
274 $TICK_WATCHER->start; 325 $TICK_WATCHER->start;
275 $WRITE_RUNTIME_WATCHER->start;
276 }; 326 };
277 $WRITE_RUNTIME_WATCHER->stop;
278 $TICK_WATCHER->stop; 327 $TICK_WATCHER->stop;
279 $guard 328 $guard
329}
330
331=item cf::get_slot $time[, $priority[, $name]]
332
333Allocate $time seconds of blocking CPU time at priority C<$priority>:
334This call blocks and returns only when you have at least C<$time> seconds
335of cpu time till the next tick. The slot is only valid till the next cede.
336
337The optional C<$name> can be used to identify the job to run. It might be
338used for statistical purposes and should identify the same time-class.
339
340Useful for short background jobs.
341
342=cut
343
344our @SLOT_QUEUE;
345our $SLOT_QUEUE;
346
347$SLOT_QUEUE->cancel if $SLOT_QUEUE;
348$SLOT_QUEUE = Coro::async {
349 my $signal = new Coro::Signal;
350
351 while () {
352 next_job:
353 my $avail = cf::till_tick;
354 if ($avail > 0.01) {
355 for (0 .. $#SLOT_QUEUE) {
356 if ($SLOT_QUEUE[$_][0] < $avail) {
357 my $job = splice @SLOT_QUEUE, $_, 1, ();
358 $job->[2]->send;
359 Coro::cede;
360 goto next_job;
361 }
362 }
363 }
364
365 if (@SLOT_QUEUE) {
366 # we do not use wait_For_tick() as it returns immediately when tick is inactive
367 push @cf::WAIT_FOR_TICK, $signal;
368 $signal->wait;
369 } else {
370 Coro::schedule;
371 }
372 }
373};
374
375sub get_slot($;$$) {
376 my ($time, $pri, $name) = @_;
377
378 $time = $TICK * .6 if $time > $TICK * .6;
379 my $sig = new Coro::Signal;
380
381 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
382 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
383 $SLOT_QUEUE->ready;
384 $sig->wait;
280} 385}
281 386
282=item cf::async { BLOCK } 387=item cf::async { BLOCK }
283 388
284Currently the same as Coro::async_pool, meaning you cannot use 389Currently the same as Coro::async_pool, meaning you cannot use
289 394
290BEGIN { *async = \&Coro::async_pool } 395BEGIN { *async = \&Coro::async_pool }
291 396
292=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
293 398
294The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
295always able to handle events or runnable, as crossfire+ is only partly 400is always able to handle events or runnable, as Crossfire TRT is only
296reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 401partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
402acceptable.
297 403
298If it must be done, put the blocking parts into C<sync_job>. This will run 404If it must be done, put the blocking parts into C<sync_job>. This will run
299the given BLOCK in another coroutine while waiting for the result. The 405the given BLOCK in another coroutine while waiting for the result. The
300server will be frozen during this time, so the block should either finish 406server will be frozen during this time, so the block should either finish
301fast or be very important. 407fast or be very important.
304 410
305sub sync_job(&) { 411sub sync_job(&) {
306 my ($job) = @_; 412 my ($job) = @_;
307 413
308 if ($Coro::current == $Coro::main) { 414 if ($Coro::current == $Coro::main) {
415 my $time = Event::time;
416
309 # this is the main coro, too bad, we have to block 417 # this is the main coro, too bad, we have to block
310 # till the operation succeeds, freezing the server :/ 418 # till the operation succeeds, freezing the server :/
311 419
312 # TODO: use suspend/resume instead 420 # TODO: use suspend/resume instead
313 # (but this is cancel-safe) 421 # (but this is cancel-safe)
324 432
325 while ($busy) { 433 while ($busy) {
326 Coro::cede or Event::one_event; 434 Coro::cede or Event::one_event;
327 } 435 }
328 436
437 $time = Event::time - $time;
438
439 LOG llevError | logBacktrace, Carp::longmess "long sync job"
440 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
441
442 $tick_start += $time; # do not account sync jobs to server load
443
329 wantarray ? @res : $res[0] 444 wantarray ? @res : $res[0]
330 } else { 445 } else {
331 # we are in another coroutine, how wonderful, everything just works 446 # we are in another coroutine, how wonderful, everything just works
332 447
333 $job->() 448 $job->()
352 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
353 468
354 $coro 469 $coro
355} 470}
356 471
357sub write_runtime { 472=item fork_call { }, $args
358 my $runtime = cf::localdir . "/runtime";
359 473
360 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 474Executes the given code block with the given arguments in a seperate
361 or return; 475process, returning the results. Everything must be serialisable with
476Coro::Storable. May, of course, block. Note that the executed sub may
477never block itself or use any form of Event handling.
362 478
363 my $value = $cf::RUNTIME + 90 + 10; 479=cut
364 # 10 is the runtime save interval, for a monotonic clock
365 # 60 allows for the watchdog to kill the server.
366 480
367 (aio_write $fh, 0, (length $value), $value, 0) <= 0 481sub fork_call(&@) {
368 and return; 482 my ($cb, @args) = @_;
369 483
370 # always fsync - this file is important 484 # we seemingly have to make a local copy of the whole thing,
371 aio_fsync $fh 485 # otherwise perl prematurely frees the stuff :/
372 and return; 486 # TODO: investigate and fix (liekly this will be rather laborious)
373 487
374 close $fh 488 my @res = Coro::Util::fork_eval {
375 or return; 489 reset_signals;
490 &$cb
491 }, @args;
376 492
377 aio_rename "$runtime~", $runtime 493 wantarray ? @res : $res[-1]
378 and return; 494}
379 495
496=item $value = cf::db_get $family => $key
497
498Returns a single value from the environment database.
499
500=item cf::db_put $family => $key => $value
501
502Stores the given C<$value> in the family. It can currently store binary
503data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
504
505=cut
506
507our $DB;
508
509sub db_init {
510 unless ($DB) {
511 $DB = BDB::db_create $DB_ENV;
512
513 cf::sync_job {
514 eval {
515 $DB->set_flags (BDB::CHKSUM);
516
517 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
518 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
519 cf::cleanup "db_open(db): $!" if $!;
520 };
521 cf::cleanup "db_open(db): $@" if $@;
522 };
380 1 523 }
524}
525
526sub db_get($$) {
527 my $key = "$_[0]/$_[1]";
528
529 cf::sync_job {
530 BDB::db_get $DB, undef, $key, my $data;
531
532 $! ? ()
533 : $data
534 }
535}
536
537sub db_put($$$) {
538 BDB::dbreq_pri 4;
539 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
540}
541
542=item cf::cache $id => [$paths...], $processversion => $process
543
544Generic caching function that returns the value of the resource $id,
545caching and regenerating as required.
546
547This function can block.
548
549=cut
550
551sub cache {
552 my ($id, $src, $processversion, $process) = @_;
553
554 my $meta =
555 join "\x00",
556 $processversion,
557 map {
558 aio_stat $_
559 and Carp::croak "$_: $!";
560
561 ($_, (stat _)[7,9])
562 } @$src;
563
564 my $dbmeta = db_get cache => "$id/meta";
565 if ($dbmeta ne $meta) {
566 # changed, we may need to process
567
568 my @data;
569 my $md5;
570
571 for (0 .. $#$src) {
572 0 <= aio_load $src->[$_], $data[$_]
573 or Carp::croak "$src->[$_]: $!";
574 }
575
576 # if processing is expensive, check
577 # checksum first
578 if (1) {
579 $md5 =
580 join "\x00",
581 $processversion,
582 map {
583 cf::cede_to_tick;
584 ($src->[$_], Digest::MD5::md5_hex $data[$_])
585 } 0.. $#$src;
586
587
588 my $dbmd5 = db_get cache => "$id/md5";
589 if ($dbmd5 eq $md5) {
590 db_put cache => "$id/meta", $meta;
591
592 return db_get cache => "$id/data";
593 }
594 }
595
596 my $t1 = Time::HiRes::time;
597 my $data = $process->(\@data);
598 my $t2 = Time::HiRes::time;
599
600 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
601
602 db_put cache => "$id/data", $data;
603 db_put cache => "$id/md5" , $md5;
604 db_put cache => "$id/meta", $meta;
605
606 return $data;
607 }
608
609 db_get cache => "$id/data"
610}
611
612=item cf::datalog type => key => value, ...
613
614Log a datalog packet of the given type with the given key-value pairs.
615
616=cut
617
618sub datalog($@) {
619 my ($type, %kv) = @_;
620 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
381} 621}
382 622
383=back 623=back
384 624
385=cut 625=cut
392attach callbacks/event handlers (a collection of which is called an "attachment") 632attach callbacks/event handlers (a collection of which is called an "attachment")
393to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
394 634
395In the following description, CLASS can be any of C<global>, C<object> 635In the following description, CLASS can be any of C<global>, C<object>
396C<player>, C<client> or C<map> (i.e. the attachable objects in 636C<player>, C<client> or C<map> (i.e. the attachable objects in
397crossfire+). 637Crossfire TRT).
398 638
399=over 4 639=over 4
400 640
401=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
402 642
565 $registry = $CB_TYPE[$object_type] ||= []; 805 $registry = $CB_TYPE[$object_type] ||= [];
566 806
567 } elsif ($type eq "subtype") { 807 } elsif ($type eq "subtype") {
568 defined $object_type or Carp::croak "subtype specified without type"; 808 defined $object_type or Carp::croak "subtype specified without type";
569 my $object_subtype = shift @arg; 809 my $object_subtype = shift @arg;
570 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 810 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571 811
572 } elsif ($type eq "package") { 812 } elsif ($type eq "package") {
573 my $pkg = shift @arg; 813 my $pkg = shift @arg;
574 814
575 while (my ($name, $id) = each %cb_id) { 815 while (my ($name, $id) = each %cb_id) {
604 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
605 } 845 }
606 846
607 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
608 } else { 848 } else {
609 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
610 } 850 }
611 851
612 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
613} 853}
614 854
616 if (ref $_[0]) { 856 if (ref $_[0]) {
617 _object_attach @_; 857 _object_attach @_;
618 } else { 858 } else {
619 _attach shift->_attach_registry, @_; 859 _attach shift->_attach_registry, @_;
620 } 860 }
861 _recalc_want;
621}; 862};
622 863
623# all those should be optimised 864# all those should be optimised
624sub cf::attachable::detach { 865sub cf::attachable::detach {
625 my ($obj, $name) = @_; 866 my ($obj, $name) = @_;
628 delete $obj->{_attachment}{$name}; 869 delete $obj->{_attachment}{$name};
629 reattach ($obj); 870 reattach ($obj);
630 } else { 871 } else {
631 Carp::croak "cannot, currently, detach class attachments"; 872 Carp::croak "cannot, currently, detach class attachments";
632 } 873 }
874 _recalc_want;
633}; 875};
634 876
635sub cf::attachable::attached { 877sub cf::attachable::attached {
636 my ($obj, $name) = @_; 878 my ($obj, $name) = @_;
637 879
652 "; 894 ";
653 die if $@; 895 die if $@;
654} 896}
655 897
656our $override; 898our $override;
657our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 899our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
658 900
659sub override { 901sub override {
660 $override = 1; 902 $override = 1;
661 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
662} 904}
663 905
664sub do_invoke { 906sub do_invoke {
665 my $event = shift; 907 my $event = shift;
666 my $callbacks = shift; 908 my $callbacks = shift;
667 909
668 @invoke_results = (); 910 @INVOKE_RESULTS = ();
669 911
670 local $override; 912 local $override;
671 913
672 for (@$callbacks) { 914 for (@$callbacks) {
673 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
690 932
691Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
692 934
693This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 935This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
694removed in future versions), and there is no public API to access override 936removed in future versions), and there is no public API to access override
695results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696 938
697=back 939=back
698 940
699=cut 941=cut
700 942
701############################################################################# 943#############################################################################
702# object support 944# object support
945#
946
947sub _can_merge {
948 my ($ob1, $ob2) = @_;
949
950 local $Storable::canonical = 1;
951 my $fob1 = Storable::freeze $ob1;
952 my $fob2 = Storable::freeze $ob2;
953
954 $fob1 eq $fob2
955}
703 956
704sub reattach { 957sub reattach {
705 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
706 my ($obj) = @_; 959 my ($obj) = @_;
707 960
784 } 1037 }
785 } else { 1038 } else {
786 aio_unlink $filename; 1039 aio_unlink $filename;
787 aio_unlink "$filename.pst"; 1040 aio_unlink "$filename.pst";
788 } 1041 }
789
790 #d##TODO# nuke non .map-files if exist
791 if ($filename =~ s/\.map$//) {
792 aio_unlink $filename;
793 aio_unlink "$filename.pst";
794 }
795 } 1042 }
796} 1043}
797 1044
798sub object_freezer_as_string { 1045sub object_freezer_as_string {
799 my ($rdata, $objs) = @_; 1046 my ($rdata, $objs) = @_;
805 1052
806sub object_thawer_load { 1053sub object_thawer_load {
807 my ($filename) = @_; 1054 my ($filename) = @_;
808 1055
809 my ($data, $av); 1056 my ($data, $av);
810
811 #d#TODO remove .map if file does not exist
812 aio_stat $filename and $filename =~ s/\.map$//;
813 1057
814 (aio_load $filename, $data) >= 0 1058 (aio_load $filename, $data) >= 0
815 or return; 1059 or return;
816 1060
817 unless (aio_stat "$filename.pst") { 1061 unless (aio_stat "$filename.pst") {
819 or return; 1063 or return;
820 $av = eval { (Storable::thaw $av)->{objs} }; 1064 $av = eval { (Storable::thaw $av)->{objs} };
821 } 1065 }
822 1066
823 warn sprintf "loading %s (%d)\n", 1067 warn sprintf "loading %s (%d)\n",
824 $filename, length $data, scalar @{$av || []};#d# 1068 $filename, length $data, scalar @{$av || []};
825 return ($data, $av); 1069 return ($data, $av);
826} 1070}
1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
827 1077
828############################################################################# 1078#############################################################################
829# command handling &c 1079# command handling &c
830 1080
831=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
844 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
845} 1095}
846 1096
847=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
848 1098
849Register a callbackf ro execution when the client sends an extcmd packet. 1099Register a callback for execution when the client sends an (synchronous)
1100extcmd packet. Ext commands will be processed in the order they are
1101received by the server, like other user commands. The first argument is
1102the logged-in player. Ext commands can only be processed after a player
1103has logged in successfully.
850 1104
851If the callback returns something, it is sent back as if reply was being 1105If the callback returns something, it is sent back as if reply was being
852called. 1106called.
853 1107
1108=item cf::register_exticmd $name => \&callback($ns,$packet);
1109
1110Register a callback for execution when the client sends an (asynchronous)
1111exticmd packet. Exti commands are processed by the server as soon as they
1112are received, i.e. out of order w.r.t. other commands. The first argument
1113is a client socket. Exti commands can be received anytime, even before
1114log-in.
1115
1116If the callback returns something, it is sent back as if reply was being
1117called.
1118
854=cut 1119=cut
855 1120
856sub register_extcmd { 1121sub register_extcmd {
857 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
858 1123
859 $EXTCMD{$name} = $cb; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
860} 1131}
861 1132
862cf::player->attach ( 1133cf::player->attach (
863 on_command => sub { 1134 on_command => sub {
864 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
873 cf::override; 1144 cf::override;
874 }, 1145 },
875 on_extcmd => sub { 1146 on_extcmd => sub {
876 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
877 1148
878 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
879 1150
880 if (ref $msg) { 1151 if (ref $msg) {
1152 my ($type, $reply, @payload) =
1153 "ARRAY" eq ref $msg
1154 ? @$msg
1155 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1156
1157 my @reply;
1158
881 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
882 if (my %reply = $cb->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
883 $pl->ext_reply ($msg->{msgid}, %reply);
884 }
885 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
886 } else { 1166 } else {
887 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
888 } 1168 }
889 1169
890 cf::override; 1170 cf::override;
891 }, 1171 },
892); 1172);
893 1173
894sub load_extension {
895 my ($path) = @_;
896
897 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
898 my $base = $1;
899 my $pkg = $1;
900 $pkg =~ s/[^[:word:]]/_/g;
901 $pkg = "ext::$pkg";
902
903 warn "... loading '$path' into '$pkg'\n";
904
905 open my $fh, "<:utf8", $path
906 or die "$path: $!";
907
908 my $source =
909 "package $pkg; use strict; use utf8;\n"
910 . "#line 1 \"$path\"\n{\n"
911 . (do { local $/; <$fh> })
912 . "\n};\n1";
913
914 unless (eval $source) {
915 my $msg = $@ ? "$path: $@\n"
916 : "extension disabled.\n";
917 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
918 warn $@;
919 warn "mandatory extension failed to load, exiting.\n";
920 exit 1;
921 }
922 die $@;
923 }
924
925 push @EXTS, $pkg;
926}
927
928sub load_extensions { 1174sub load_extensions {
1175 cf::sync_job {
1176 my %todo;
1177
929 for my $ext (<$LIBDIR/*.ext>) { 1178 for my $path (<$LIBDIR/*.ext>) {
930 next unless -r $ext; 1179 next unless -r $path;
931 eval { 1180
932 load_extension $ext; 1181 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1182 my $base = $1;
1183 my $pkg = $1;
1184 $pkg =~ s/[^[:word:]]/_/g;
1185 $pkg = "ext::$pkg";
1186
1187 open my $fh, "<:utf8", $path
1188 or die "$path: $!";
1189
1190 my $source = do { local $/; <$fh> };
1191
1192 my %ext = (
1193 path => $path,
1194 base => $base,
1195 pkg => $pkg,
1196 );
1197
1198 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1199 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1200
1201 $ext{source} =
1202 "package $pkg; use strict; use utf8;\n"
1203 . "#line 1 \"$path\"\n{\n"
1204 . $source
1205 . "\n};\n1";
1206
1207 $todo{$base} = \%ext;
1208 }
1209
1210 my %done;
1211 while (%todo) {
1212 my $progress;
1213
1214 while (my ($k, $v) = each %todo) {
1215 for (split /,\s*/, $v->{meta}{depends}) {
1216 goto skip
1217 unless exists $done{$_};
1218 }
1219
1220 warn "... loading '$k' into '$v->{pkg}'\n";
1221
1222 unless (eval $v->{source}) {
1223 my $msg = $@ ? "$v->{path}: $@\n"
1224 : "$v->{base}: extension inactive.\n";
1225
1226 if (exists $v->{meta}{mandatory}) {
1227 warn $msg;
1228 warn "mandatory extension failed to load, exiting.\n";
1229 exit 1;
1230 }
1231
1232 warn $msg;
1233 }
1234
1235 $done{$k} = delete $todo{$k};
1236 push @EXTS, $v->{pkg};
1237 $progress = 1;
933 1 1238 }
934 } or warn "$ext not loaded: $@"; 1239
1240 skip:
1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1242 unless $progress;
1243 }
935 } 1244 };
936} 1245}
937 1246
938############################################################################# 1247#############################################################################
939 1248
1249=back
1250
940=head2 CORE EXTENSIONS 1251=head2 CORE EXTENSIONS
941 1252
942Functions and methods that extend core crossfire objects. 1253Functions and methods that extend core crossfire objects.
943 1254
944=cut 1255=cut
956Returns the given player object, loading it if necessary (might block). 1267Returns the given player object, loading it if necessary (might block).
957 1268
958=cut 1269=cut
959 1270
960sub playerdir($) { 1271sub playerdir($) {
961 cf::localdir 1272 "$PLAYERDIR/"
962 . "/"
963 . cf::playerdir
964 . "/"
965 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1273 . (ref $_[0] ? $_[0]->ob->name : $_[0])
966} 1274}
967 1275
968sub path($) { 1276sub path($) {
969 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1277 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
970 1278
971 (playerdir $login) . "/$login.pl" 1279 (playerdir $login) . "/playerdata"
972} 1280}
973 1281
974sub find_active($) { 1282sub find_active($) {
975 $cf::PLAYER{$_[0]} 1283 $cf::PLAYER{$_[0]}
976 and $cf::PLAYER{$_[0]}->active 1284 and $cf::PLAYER{$_[0]}->active
989 my $login = $_[0]; 1297 my $login = $_[0];
990 1298
991 my $guard = cf::lock_acquire "user_find:$login"; 1299 my $guard = cf::lock_acquire "user_find:$login";
992 1300
993 $cf::PLAYER{$_[0]} || do { 1301 $cf::PLAYER{$_[0]} || do {
1302 # rename old playerfiles to new ones
1303 #TODO: remove when no longer required
1304 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1305 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1306 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1307 aio_unlink +(playerdir $login) . "/$login.pl";
1308
994 my $pl = load_pl path $login 1309 my $pl = load_pl path $login
995 or return; 1310 or return;
996 $cf::PLAYER{$login} = $pl 1311 $cf::PLAYER{$login} = $pl
997 } 1312 }
998 } 1313 }
1010 1325
1011 aio_mkdir playerdir $pl, 0770; 1326 aio_mkdir playerdir $pl, 0770;
1012 $pl->{last_save} = $cf::RUNTIME; 1327 $pl->{last_save} = $cf::RUNTIME;
1013 1328
1014 $pl->save_pl ($path); 1329 $pl->save_pl ($path);
1015 Coro::cede; 1330 cf::cede_to_tick;
1016} 1331}
1017 1332
1018sub new($) { 1333sub new($) {
1019 my ($login) = @_; 1334 my ($login) = @_;
1020 1335
1026 $cf::PLAYER{$login} = $self; 1341 $cf::PLAYER{$login} = $self;
1027 1342
1028 $self 1343 $self
1029} 1344}
1030 1345
1346=item $player->send_msg ($channel, $msg, $color, [extra...])
1347
1348=cut
1349
1350sub send_msg {
1351 my $ns = shift->ns
1352 or return;
1353 $ns->send_msg (@_);
1354}
1355
1031=item $pl->quit_character 1356=item $pl->quit_character
1032 1357
1033Nukes the player without looking back. If logged in, the connection will 1358Nukes the player without looking back. If logged in, the connection will
1034be destroyed. May block for a long time. 1359be destroyed. May block for a long time.
1035 1360
1036=cut 1361=cut
1037 1362
1038sub quit_character { 1363sub quit_character {
1039 my ($pl) = @_; 1364 my ($pl) = @_;
1365
1366 my $name = $pl->ob->name;
1040 1367
1041 $pl->{deny_save} = 1; 1368 $pl->{deny_save} = 1;
1042 $pl->password ("*"); # this should lock out the player until we nuked the dir 1369 $pl->password ("*"); # this should lock out the player until we nuked the dir
1043 1370
1044 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1371 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1049 my $path = playerdir $pl; 1376 my $path = playerdir $pl;
1050 my $temp = "$path~$cf::RUNTIME~deleting~"; 1377 my $temp = "$path~$cf::RUNTIME~deleting~";
1051 aio_rename $path, $temp; 1378 aio_rename $path, $temp;
1052 delete $cf::PLAYER{$pl->ob->name}; 1379 delete $cf::PLAYER{$pl->ob->name};
1053 $pl->destroy; 1380 $pl->destroy;
1381
1382 my $prefix = qr<^~\Q$name\E/>;
1383
1384 # nuke player maps
1385 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1386
1054 IO::AIO::aio_rmtree $temp; 1387 IO::AIO::aio_rmtree $temp;
1388}
1389
1390=item $pl->kick
1391
1392Kicks a player out of the game. This destroys the connection.
1393
1394=cut
1395
1396sub kick {
1397 my ($pl, $kicker) = @_;
1398
1399 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1400 $pl->killer ("kicked");
1401 $pl->ns->destroy;
1055} 1402}
1056 1403
1057=item cf::player::list_logins 1404=item cf::player::list_logins
1058 1405
1059Returns am arrayref of all valid playernames in the system, can take a 1406Returns am arrayref of all valid playernames in the system, can take a
1060while and may block, so not sync_job-capable, ever. 1407while and may block, so not sync_job-capable, ever.
1061 1408
1062=cut 1409=cut
1063 1410
1064sub list_logins { 1411sub list_logins {
1065 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1412 my $dirs = aio_readdir $PLAYERDIR
1066 or return []; 1413 or return [];
1067 1414
1068 my @logins; 1415 my @logins;
1069 1416
1070 for my $login (@$dirs) { 1417 for my $login (@$dirs) {
1105 } 1452 }
1106 1453
1107 \@paths 1454 \@paths
1108} 1455}
1109 1456
1457=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1458
1459Expand crossfire pod fragments into protocol xml.
1460
1461=cut
1462
1463sub expand_cfpod {
1464 ((my $self), (local $_)) = @_;
1465
1466 # escape & and <
1467 s/&/&amp;/g;
1468 s/(?<![BIUGH])</&lt;/g;
1469
1470 # this is buggy, it needs to properly take care of nested <'s
1471
1472 1 while
1473 # replace B<>, I<>, U<> etc.
1474 s/B<([^\>]*)>/<b>$1<\/b>/
1475 || s/I<([^\>]*)>/<i>$1<\/i>/
1476 || s/U<([^\>]*)>/<u>$1<\/u>/
1477 # replace G<male|female> tags
1478 || s{G<([^>|]*)\|([^>]*)>}{
1479 $self->gender ? $2 : $1
1480 }ge
1481 # replace H<hint text>
1482 || s{H<([^\>]*)>}
1483 {
1484 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1485 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1486 "")
1487 [$self->{hintmode}]
1488 }ge;
1489
1490 # create single paragraphs (very hackish)
1491 s/(?<=\S)\n(?=\w)/ /g;
1492
1493 # compress some whitespace
1494 s/\s+\n/\n/g; # ws line-ends
1495 s/\n\n+/\n/g; # double lines
1496 s/^\n+//; # beginning lines
1497 s/\n+$//; # ending lines
1498
1499 $_
1500}
1501
1502sub hintmode {
1503 $_[0]{hintmode} = $_[1] if @_ > 1;
1504 $_[0]{hintmode}
1505}
1506
1110=item $player->ext_reply ($msgid, $msgtype, %msg) 1507=item $player->ext_reply ($msgid, @msg)
1111 1508
1112Sends an ext reply to the player. 1509Sends an ext reply to the player.
1113 1510
1114=cut 1511=cut
1115 1512
1116sub ext_reply($$$%) { 1513sub ext_reply($$@) {
1117 my ($self, $id, %msg) = @_; 1514 my ($self, $id, @msg) = @_;
1118 1515
1119 $msg{msgid} = $id; 1516 $self->ns->ext_reply ($id, @msg)
1120
1121 $self->send ("ext " . cf::to_json \%msg);
1122} 1517}
1123 1518
1124package cf; 1519=item $player->ext_msg ($type, @msg)
1520
1521Sends an ext event to the client.
1522
1523=cut
1524
1525sub ext_msg($$@) {
1526 my ($self, $type, @msg) = @_;
1527
1528 $self->ns->ext_msg ($type, @msg);
1529}
1530
1531=head3 cf::region
1532
1533=over 4
1534
1535=cut
1536
1537package cf::region;
1538
1539=item cf::region::find_by_path $path
1540
1541Tries to decuce the likely region for a map knowing only its path.
1542
1543=cut
1544
1545sub find_by_path($) {
1546 my ($path) = @_;
1547
1548 my ($match, $specificity);
1549
1550 for my $region (list) {
1551 if ($region->{match} && $path =~ $region->{match}) {
1552 ($match, $specificity) = ($region, $region->specificity)
1553 if $region->specificity > $specificity;
1554 }
1555 }
1556
1557 $match
1558}
1125 1559
1126=back 1560=back
1127
1128 1561
1129=head3 cf::map 1562=head3 cf::map
1130 1563
1131=over 4 1564=over 4
1132 1565
1187 my ($self, $merge) = @_; 1620 my ($self, $merge) = @_;
1188 1621
1189 # we have to keep some variables in memory intact 1622 # we have to keep some variables in memory intact
1190 local $self->{path}; 1623 local $self->{path};
1191 local $self->{load_path}; 1624 local $self->{load_path};
1192 local $self->{deny_save};
1193 local $self->{deny_reset};
1194 1625
1195 $self->SUPER::thawer_merge ($merge); 1626 $self->SUPER::thawer_merge ($merge);
1196} 1627}
1197 1628
1198sub normalise { 1629sub normalise {
1245 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1246 return $self; 1677 return $self;
1247 } 1678 }
1248 } 1679 }
1249 1680
1250 Carp::carp "unable to resolve path '$path' (base '$base')."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1251 () 1682 ()
1252} 1683}
1253 1684
1254sub init { 1685sub init {
1255 my ($self) = @_; 1686 my ($self) = @_;
1270 1701
1271# the original (read-only) location 1702# the original (read-only) location
1272sub load_path { 1703sub load_path {
1273 my ($self) = @_; 1704 my ($self) = @_;
1274 1705
1275 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1706 "$MAPDIR/$self->{path}.map"
1276} 1707}
1277 1708
1278# the temporary/swap location 1709# the temporary/swap location
1279sub save_path { 1710sub save_path {
1280 my ($self) = @_; 1711 my ($self) = @_;
1281 1712
1282 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1713 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1714 "$TMPDIR/$path.map"
1284} 1715}
1285 1716
1286# the unique path, undef == no special unique path 1717# the unique path, undef == no special unique path
1287sub uniq_path { 1718sub uniq_path {
1288 my ($self) = @_; 1719 my ($self) = @_;
1289 1720
1290 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1721 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1291 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1722 "$UNIQUEDIR/$path"
1292} 1723}
1293 1724
1294# and all this just because we cannot iterate over 1725# and all this just because we cannot iterate over
1295# all maps in C++... 1726# all maps in C++...
1296sub change_all_map_light { 1727sub change_all_map_light {
1298 1729
1299 $_->change_map_light ($change) 1730 $_->change_map_light ($change)
1300 for grep $_->outdoor, values %cf::MAP; 1731 for grep $_->outdoor, values %cf::MAP;
1301} 1732}
1302 1733
1734sub decay_objects {
1735 my ($self) = @_;
1736
1737 return if $self->{deny_reset};
1738
1739 $self->do_decay_objects;
1740}
1741
1303sub unlink_save { 1742sub unlink_save {
1304 my ($self) = @_; 1743 my ($self) = @_;
1305 1744
1306 utf8::encode (my $save = $self->save_path); 1745 utf8::encode (my $save = $self->save_path);
1307 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1746 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1308 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1747 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1309
1310 #d#TODO remove .map and also nuke
1311 $save =~ s/\.map// or return;#d#
1312 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1313 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1314} 1748}
1315 1749
1316sub load_header_from($) { 1750sub load_header_from($) {
1317 my ($self, $path) = @_; 1751 my ($self, $path) = @_;
1318 1752
1368 $self->load_header_orig 1802 $self->load_header_orig
1369 or return; 1803 or return;
1370 $self->prepare_orig; 1804 $self->prepare_orig;
1371 } 1805 }
1372 1806
1807 $self->{deny_reset} = 1
1808 if $self->no_reset;
1809
1810 $self->default_region (cf::region::find_by_path $self->{path})
1811 unless $self->default_region;
1812
1373 1 1813 1
1374} 1814}
1375 1815
1376sub find; 1816sub find;
1377sub find { 1817sub find {
1389 $map->{last_save} = $cf::RUNTIME; 1829 $map->{last_save} = $cf::RUNTIME;
1390 1830
1391 $map->load_header 1831 $map->load_header
1392 or return; 1832 or return;
1393 1833
1394 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1395 # doing this can freeze the server in a sync job, obviously 1835 # doing this can freeze the server in a sync job, obviously
1396 #$cf::WAIT_FOR_TICK->wait; 1836 #$cf::WAIT_FOR_TICK->wait;
1397 $map->reset; 1837 $map->reset;
1398 undef $guard; 1838 undef $guard;
1399 return find $path; 1839 return find $path;
1410 my ($self) = @_; 1850 my ($self) = @_;
1411 1851
1412 local $self->{deny_reset} = 1; # loading can take a long time 1852 local $self->{deny_reset} = 1; # loading can take a long time
1413 1853
1414 my $path = $self->{path}; 1854 my $path = $self->{path};
1855
1856 {
1857 my $guard1 = cf::lock_acquire "map_data:$path";
1415 my $guard = cf::lock_acquire "map_load:$path"; 1858 my $guard2 = cf::lock_acquire "map_load:$path";
1416 1859
1417 return if $self->in_memory != cf::MAP_SWAPPED; 1860 return if $self->in_memory != cf::MAP_SWAPPED;
1418 1861
1419 $self->in_memory (cf::MAP_LOADING); 1862 $self->in_memory (cf::MAP_LOADING);
1420 1863
1421 $self->alloc; 1864 $self->alloc;
1422 1865
1423 $self->pre_load; 1866 $self->pre_load;
1867 cf::cede_to_tick;
1424 1868
1425 $self->_load_objects ($self->{load_path}, 1) 1869 $self->_load_objects ($self->{load_path}, 1)
1426 or return; 1870 or return;
1427 1871
1428 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1872 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1429 if delete $self->{load_original}; 1873 if delete $self->{load_original};
1430 1874
1431 if (my $uniq = $self->uniq_path) { 1875 if (my $uniq = $self->uniq_path) {
1432 utf8::encode $uniq; 1876 utf8::encode $uniq;
1433 if (aio_open $uniq, O_RDONLY, 0) { 1877 if (aio_open $uniq, O_RDONLY, 0) {
1434 $self->clear_unique_items; 1878 $self->clear_unique_items;
1435 $self->_load_objects ($uniq, 0); 1879 $self->_load_objects ($uniq, 0);
1436 } 1880 }
1437 } 1881 }
1438 1882
1439 Coro::cede; 1883 cf::cede_to_tick;
1440
1441 # now do the right thing for maps 1884 # now do the right thing for maps
1442 $self->link_multipart_objects; 1885 $self->link_multipart_objects;
1443
1444 unless ($self->{deny_activate}) {
1445 $self->decay_objects;
1446 $self->fix_auto_apply;
1447 $self->update_buttons;
1448 Coro::cede;
1449 $self->set_darkness_map;
1450 $self->difficulty ($self->estimate_difficulty) 1886 $self->difficulty ($self->estimate_difficulty)
1451 unless $self->difficulty; 1887 unless $self->difficulty;
1452 Coro::cede; 1888 cf::cede_to_tick;
1889
1890 unless ($self->{deny_activate}) {
1891 $self->decay_objects;
1892 $self->fix_auto_apply;
1893 $self->update_buttons;
1894 cf::cede_to_tick;
1895 $self->set_darkness_map;
1896 cf::cede_to_tick;
1453 $self->activate; 1897 $self->activate;
1898 }
1899
1900 $self->{last_save} = $cf::RUNTIME;
1901 $self->last_access ($cf::RUNTIME);
1902
1903 $self->in_memory (cf::MAP_IN_MEMORY);
1454 } 1904 }
1455 1905
1456 $self->post_load; 1906 $self->post_load;
1457
1458 $self->in_memory (cf::MAP_IN_MEMORY);
1459} 1907}
1460 1908
1461sub customise_for { 1909sub customise_for {
1462 my ($self, $ob) = @_; 1910 my ($self, $ob) = @_;
1463 1911
1464 return find "~" . $ob->name . "/" . $self->{path} 1912 return find "~" . $ob->name . "/" . $self->{path}
1465 if $self->per_player; 1913 if $self->per_player;
1466 1914
1915# return find "?party/" . $ob->name . "/" . $self->{path}
1916# if $self->per_party;
1917
1467 $self 1918 $self
1468} 1919}
1469 1920
1470# find and load all maps in the 3x3 area around a map 1921# find and load all maps in the 3x3 area around a map
1471sub load_diag { 1922sub load_neighbours {
1472 my ($map) = @_; 1923 my ($map) = @_;
1473 1924
1474 my @diag; # diagonal neighbours 1925 my @neigh; # diagonal neighbours
1475 1926
1476 for (0 .. 3) { 1927 for (0 .. 3) {
1477 my $neigh = $map->tile_path ($_) 1928 my $neigh = $map->tile_path ($_)
1478 or next; 1929 or next;
1479 $neigh = find $neigh, $map 1930 $neigh = find $neigh, $map
1480 or next; 1931 or next;
1481 $neigh->load; 1932 $neigh->load;
1482 1933
1934 push @neigh,
1483 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1935 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1484 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1936 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1485 } 1937 }
1486 1938
1487 for (@diag) { 1939 for (grep defined $_->[0], @neigh) {
1940 my ($path, $origin) = @$_;
1488 my $neigh = find @$_ 1941 my $neigh = find $path, $origin
1489 or next; 1942 or next;
1490 $neigh->load; 1943 $neigh->load;
1491 } 1944 }
1492} 1945}
1493 1946
1498} 1951}
1499 1952
1500sub do_load_sync { 1953sub do_load_sync {
1501 my ($map) = @_; 1954 my ($map) = @_;
1502 1955
1956 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1957 if $Coro::current == $Coro::main;
1958
1503 cf::sync_job { $map->load }; 1959 cf::sync_job { $map->load };
1504} 1960}
1505 1961
1506our %MAP_PREFETCH; 1962our %MAP_PREFETCH;
1507our $MAP_PREFETCHER = undef; 1963our $MAP_PREFETCHER = undef;
1508 1964
1509sub find_async { 1965sub find_async {
1510 my ($path, $origin) = @_; 1966 my ($path, $origin, $load) = @_;
1511 1967
1512 $path = normalise $path, $origin && $origin->{path}; 1968 $path = normalise $path, $origin && $origin->{path};
1513 1969
1514 if (my $map = $cf::MAP{$path}) { 1970 if (my $map = $cf::MAP{$path}) {
1515 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1971 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1516 } 1972 }
1517 1973
1518 undef $MAP_PREFETCH{$path}; 1974 $MAP_PREFETCH{$path} |= $load;
1975
1519 $MAP_PREFETCHER ||= cf::async { 1976 $MAP_PREFETCHER ||= cf::async {
1520 while (%MAP_PREFETCH) { 1977 while (%MAP_PREFETCH) {
1521 for my $path (keys %MAP_PREFETCH) { 1978 while (my ($k, $v) = each %MAP_PREFETCH) {
1522 my $map = find $path 1979 if (my $map = find $k) {
1523 or next;
1524 $map->load; 1980 $map->load if $v;
1981 }
1525 1982
1526 delete $MAP_PREFETCH{$path}; 1983 delete $MAP_PREFETCH{$k};
1527 } 1984 }
1528 } 1985 }
1529 undef $MAP_PREFETCHER; 1986 undef $MAP_PREFETCHER;
1530 }; 1987 };
1531 $MAP_PREFETCHER->prio (6); 1988 $MAP_PREFETCHER->prio (6);
1534} 1991}
1535 1992
1536sub save { 1993sub save {
1537 my ($self) = @_; 1994 my ($self) = @_;
1538 1995
1539 my $lock = cf::lock_acquire "map_data:" . $self->path; 1996 my $lock = cf::lock_acquire "map_data:$self->{path}";
1540 1997
1541 $self->{last_save} = $cf::RUNTIME; 1998 $self->{last_save} = $cf::RUNTIME;
1542 1999
1543 return unless $self->dirty; 2000 return unless $self->dirty;
1544 2001
1567 my ($self) = @_; 2024 my ($self) = @_;
1568 2025
1569 # save first because save cedes 2026 # save first because save cedes
1570 $self->save; 2027 $self->save;
1571 2028
1572 my $lock = cf::lock_acquire "map_data:" . $self->path; 2029 my $lock = cf::lock_acquire "map_data:$self->{path}";
1573 2030
1574 return if $self->players; 2031 return if $self->players;
1575 return if $self->in_memory != cf::MAP_IN_MEMORY; 2032 return if $self->in_memory != cf::MAP_IN_MEMORY;
1576 return if $self->{deny_save}; 2033 return if $self->{deny_save};
1577 2034
1581 2038
1582sub reset_at { 2039sub reset_at {
1583 my ($self) = @_; 2040 my ($self) = @_;
1584 2041
1585 # TODO: safety, remove and allow resettable per-player maps 2042 # TODO: safety, remove and allow resettable per-player maps
1586 return 1e99 if $self->isa ("ext::map_per_player");#d#
1587 return 1e99 if $self->{deny_reset}; 2043 return 1e99 if $self->{deny_reset};
1588 2044
1589 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2045 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1590 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2046 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1591 2047
1602 my ($self) = @_; 2058 my ($self) = @_;
1603 2059
1604 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
1605 2061
1606 return if $self->players; 2062 return if $self->players;
1607 return if $self->isa ("ext::map_per_player");#d#
1608 2063
1609 warn "resetting map ", $self->path;#d# 2064 warn "resetting map ", $self->path;
2065
2066 $self->in_memory (cf::MAP_SWAPPED);
2067
2068 # need to save uniques path
2069 unless ($self->{deny_save}) {
2070 my $uniq = $self->uniq_path; utf8::encode $uniq;
2071
2072 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2073 if $uniq;
2074 }
1610 2075
1611 delete $cf::MAP{$self->path}; 2076 delete $cf::MAP{$self->path};
1612 2077
1613 $self->in_memory (cf::MAP_SWAPPED);
1614 $self->clear; 2078 $self->clear;
1615 2079
1616 $_->clear_links_to ($self) for values %cf::MAP; 2080 $_->clear_links_to ($self) for values %cf::MAP;
1617 2081
1618 $self->unlink_save; 2082 $self->unlink_save;
1622my $nuke_counter = "aaaa"; 2086my $nuke_counter = "aaaa";
1623 2087
1624sub nuke { 2088sub nuke {
1625 my ($self) = @_; 2089 my ($self) = @_;
1626 2090
2091 {
2092 my $lock = cf::lock_acquire "map_data:$self->{path}";
2093
1627 delete $cf::MAP{$self->path}; 2094 delete $cf::MAP{$self->path};
1628 2095
1629 $self->unlink_save;
1630
1631 bless $self, "cf::map"; 2096 bless $self, "cf::map";
1632 delete $self->{deny_reset}; 2097 delete $self->{deny_reset};
1633 $self->{deny_save} = 1; 2098 $self->{deny_save} = 1;
1634 $self->reset_timeout (1); 2099 $self->reset_timeout (1);
1635 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2100 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1636 2101
2102 $self->unlink_save;
2103
1637 $cf::MAP{$self->path} = $self; 2104 $cf::MAP{$self->path} = $self;
2105 }
1638 2106
1639 $self->reset; # polite request, might not happen 2107 $self->reset; # polite request, might not happen
2108}
2109
2110=item $maps = cf::map::tmp_maps
2111
2112Returns an arrayref with all map paths of currently instantiated and saved
2113maps. May block.
2114
2115=cut
2116
2117sub tmp_maps() {
2118 [
2119 map {
2120 utf8::decode $_;
2121 /\.map$/
2122 ? normalise $_
2123 : ()
2124 } @{ aio_readdir $TMPDIR or [] }
2125 ]
2126}
2127
2128=item $maps = cf::map::random_maps
2129
2130Returns an arrayref with all map paths of currently instantiated and saved
2131random maps. May block.
2132
2133=cut
2134
2135sub random_maps() {
2136 [
2137 map {
2138 utf8::decode $_;
2139 /\.map$/
2140 ? normalise "?random/$_"
2141 : ()
2142 } @{ aio_readdir $RANDOMDIR or [] }
2143 ]
1640} 2144}
1641 2145
1642=item cf::map::unique_maps 2146=item cf::map::unique_maps
1643 2147
1644Returns an arrayref of paths of all shared maps that have 2148Returns an arrayref of paths of all shared maps that have
1645instantiated unique items. May block. 2149instantiated unique items. May block.
1646 2150
1647=cut 2151=cut
1648 2152
1649sub unique_maps() { 2153sub unique_maps() {
1650 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2154 [
1651 or return; 2155 map {
1652
1653 my @paths;
1654
1655 for (@$files) {
1656 utf8::decode $_; 2156 utf8::decode $_;
1657 next if /\.pst$/; 2157 /\.map$/
1658 next unless /^$PATH_SEP/o; 2158 ? normalise $_
1659 2159 : ()
1660 push @paths, cf::map::normalise $_; 2160 } @{ aio_readdir $UNIQUEDIR or [] }
1661 } 2161 ]
1662
1663 \@paths
1664} 2162}
1665 2163
1666package cf; 2164package cf;
1667 2165
1668=back 2166=back
1714 2212
1715 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2213 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1716 2214
1717 if ($self->{record_replies}) { 2215 if ($self->{record_replies}) {
1718 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2216 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2217
1719 } else { 2218 } else {
2219 my $pl = $self->contr;
2220
2221 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2222 my $dialog = $pl->{npc_dialog};
2223 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2224
2225 } else {
1720 $msg = $npc->name . " says: $msg" if $npc; 2226 $msg = $npc->name . " says: $msg" if $npc;
1721 $self->message ($msg, $flags); 2227 $self->message ($msg, $flags);
2228 }
1722 } 2229 }
2230}
2231
2232=item $object->send_msg ($channel, $msg, $color, [extra...])
2233
2234=cut
2235
2236sub cf::object::send_msg {
2237 my $pl = shift->contr
2238 or return;
2239 $pl->send_msg (@_);
1723} 2240}
1724 2241
1725=item $player_object->may ("access") 2242=item $player_object->may ("access")
1726 2243
1727Returns wether the given player is authorized to access resource "access" 2244Returns wether the given player is authorized to access resource "access"
1774 $self->deactivate_recursive; 2291 $self->deactivate_recursive;
1775 2292
1776 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2293 return if UNIVERSAL::isa $self->map, "ext::map_link";
1777 2294
1778 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2295 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1779 if $self->map; 2296 if $self->map && $self->map->{path} ne "{link}";
1780 2297
1781 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2298 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1782} 2299}
1783 2300
1784sub cf::object::player::leave_link { 2301sub cf::object::player::leave_link {
1785 my ($self, $map, $x, $y) = @_; 2302 my ($self, $map, $x, $y) = @_;
2303
2304 return unless $self->contr->active;
1786 2305
1787 my $link_pos = delete $self->{_link_pos}; 2306 my $link_pos = delete $self->{_link_pos};
1788 2307
1789 unless ($map) { 2308 unless ($map) {
1790 # restore original map position 2309 # restore original map position
1804 # use -1 or undef as default coordinates, not 0, 0 2323 # use -1 or undef as default coordinates, not 0, 0
1805 ($x, $y) = ($map->enter_x, $map->enter_y) 2324 ($x, $y) = ($map->enter_x, $map->enter_y)
1806 if $x <=0 && $y <= 0; 2325 if $x <=0 && $y <= 0;
1807 2326
1808 $map->load; 2327 $map->load;
1809 $map->load_diag; 2328 $map->load_neighbours;
1810 2329
1811 return unless $self->contr->active; 2330 return unless $self->contr->active;
1812 $self->activate_recursive; 2331 $self->activate_recursive;
2332
2333 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813 $self->enter_map ($map, $x, $y); 2334 $self->enter_map ($map, $x, $y);
1814} 2335}
1815 2336
1816cf::player->attach ( 2337=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1817 on_logout => sub {
1818 my ($pl) = @_;
1819 2338
1820 # abort map switching before logout 2339Moves the player to the given map-path and coordinates by first freezing
1821 if ($pl->ob->{_link_pos}) { 2340her, loading and preparing them map, calling the provided $check callback
1822 cf::sync_job { 2341that has to return the map if sucecssful, and then unfreezes the player on
1823 $pl->ob->leave_link 2342the new (success) or old (failed) map position. In either case, $done will
1824 }; 2343be called at the end of this process.
1825 }
1826 },
1827 on_login => sub {
1828 my ($pl) = @_;
1829 2344
1830 # try to abort aborted map switching on player login :)
1831 # should happen only on crashes
1832 if ($pl->ob->{_link_pos}) {
1833 $pl->ob->enter_link;
1834 (async {
1835 # we need this sleep as the login has a concurrent enter_exit running
1836 # and this sleep increases chances of the player not ending up in scorn
1837 $pl->ob->reply (undef,
1838 "There was an internal problem at your last logout, "
1839 . "the server will try to bring you to your intended destination in a second.",
1840 cf::NDI_RED);
1841 Coro::Timer::sleep 1;
1842 $pl->ob->leave_link;
1843 })->prio (2);
1844 }
1845 },
1846);
1847
1848=item $player_object->goto ($path, $x, $y)
1849
1850=cut 2345=cut
2346
2347our $GOTOGEN;
1851 2348
1852sub cf::object::player::goto { 2349sub cf::object::player::goto {
1853 my ($self, $path, $x, $y) = @_; 2350 my ($self, $path, $x, $y, $check, $done) = @_;
2351
2352 # do generation counting so two concurrent goto's will be executed in-order
2353 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1854 2354
1855 $self->enter_link; 2355 $self->enter_link;
1856 2356
1857 (async { 2357 (async {
1858 my $map = eval { 2358 my $map = eval {
1859 my $map = cf::map::find $path; 2359 my $map = cf::map::find $path;
2360
2361 if ($map) {
1860 $map = $map->customise_for ($self) if $map; 2362 $map = $map->customise_for ($self);
2363 $map = $check->($map) if $check && $map;
2364 } else {
2365 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2366 }
2367
1861 $map 2368 $map
2369 };
2370
2371 if ($@) {
2372 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2373 LOG llevError | logBacktrace, Carp::longmess $@;
1862 } or 2374 }
1863 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864 2375
2376 if ($gen == $self->{_goto_generation}) {
2377 delete $self->{_goto_generation};
1865 $self->leave_link ($map, $x, $y); 2378 $self->leave_link ($map, $x, $y);
2379 }
2380
2381 $done->() if $done;
1866 })->prio (1); 2382 })->prio (1);
1867} 2383}
1868 2384
1869=item $player_object->enter_exit ($exit_object) 2385=item $player_object->enter_exit ($exit_object)
1870 2386
1909 2425
1910 $rmp->{random_seed} ||= $exit->random_seed; 2426 $rmp->{random_seed} ||= $exit->random_seed;
1911 2427
1912 my $data = cf::to_json $rmp; 2428 my $data = cf::to_json $rmp;
1913 my $md5 = Digest::MD5::md5_hex $data; 2429 my $md5 = Digest::MD5::md5_hex $data;
1914 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2430 my $meta = "$RANDOMDIR/$md5.meta";
1915 2431
1916 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2432 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917 aio_write $fh, 0, (length $data), $data, 0; 2433 aio_write $fh, 0, (length $data), $data, 0;
1918 undef $fh; 2434 undef $fh;
1919 aio_rename "$meta~", $meta; 2435 aio_rename "$meta~", $meta;
1928 2444
1929 return unless $self->type == cf::PLAYER; 2445 return unless $self->type == cf::PLAYER;
1930 2446
1931 if ($exit->slaying eq "/!") { 2447 if ($exit->slaying eq "/!") {
1932 #TODO: this should de-fi-ni-te-ly not be a sync-job 2448 #TODO: this should de-fi-ni-te-ly not be a sync-job
2449 # the problem is that $exit might not survive long enough
2450 # so it needs to be done right now, right here
1933 cf::sync_job { prepare_random_map $exit }; 2451 cf::sync_job { prepare_random_map $exit };
1934 } 2452 }
1935 2453
1936 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2454 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1937 my $hp = $exit->stats->hp; 2455 my $hp = $exit->stats->hp;
1938 my $sp = $exit->stats->sp; 2456 my $sp = $exit->stats->sp;
1939 2457
1940 $self->enter_link; 2458 $self->enter_link;
2459
2460 # if exit is damned, update players death & WoR home-position
2461 $self->contr->savebed ($slaying, $hp, $sp)
2462 if $exit->flag (FLAG_DAMNED);
1941 2463
1942 (async { 2464 (async {
1943 $self->deactivate_recursive; # just to be sure 2465 $self->deactivate_recursive; # just to be sure
1944 unless (eval { 2466 unless (eval {
1945 $self->goto ($slaying, $hp, $sp); 2467 $self->goto ($slaying, $hp, $sp);
1946 2468
1947 1; 2469 1;
1948 }) { 2470 }) {
1949 $self->message ("Something went wrong deep within the crossfire server. " 2471 $self->message ("Something went wrong deep within the crossfire server. "
1950 . "I'll try to bring you back to the map you were before. " 2472 . "I'll try to bring you back to the map you were before. "
1951 . "Please report this to the dungeon master!", 2473 . "Please report this to the dungeon master!",
1952 cf::NDI_UNIQUE | cf::NDI_RED); 2474 cf::NDI_UNIQUE | cf::NDI_RED);
1953 2475
1954 warn "ERROR in enter_exit: $@"; 2476 warn "ERROR in enter_exit: $@";
1955 $self->leave_link; 2477 $self->leave_link;
1956 } 2478 }
1957 })->prio (1); 2479 })->prio (1);
1970 2492
1971sub cf::client::send_drawinfo { 2493sub cf::client::send_drawinfo {
1972 my ($self, $text, $flags) = @_; 2494 my ($self, $text, $flags) = @_;
1973 2495
1974 utf8::encode $text; 2496 utf8::encode $text;
1975 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2497 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976} 2498}
1977 2499
2500=item $client->send_msg ($channel, $msg, $color, [extra...])
2501
2502Send a drawinfo or msg packet to the client, formatting the msg for the
2503client if neccessary. C<$type> should be a string identifying the type of
2504the message, with C<log> being the default. If C<$color> is negative, suppress
2505the message unless the client supports the msg packet.
2506
2507=cut
2508
2509our %CHANNEL = (
2510 "c/identify" => {
2511 id => "identify",
2512 title => "Identify",
2513 reply => undef,
2514 tooltip => "Items recently identified",
2515 },
2516);
2517
2518sub cf::client::send_msg {
2519 my ($self, $channel, $msg, $color, @extra) = @_;
2520
2521 $msg = $self->pl->expand_cfpod ($msg);
2522
2523 $color &= cf::NDI_CLIENT_MASK; # just in case...
2524
2525 # check predefined channels, for the benefit of C
2526 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2527
2528 if (ref $channel) {
2529 # send meta info to client, if not yet sent
2530 unless (exists $self->{channel}{$channel->{id}}) {
2531 $self->{channel}{$channel->{id}} = $channel;
2532 $self->ext_msg (channel_info => $channel);
2533 }
2534
2535 $channel = $channel->{id};
2536 }
2537
2538 return unless @extra || length $msg;
2539
2540 if ($self->can_msg) {
2541 # default colour, mask it out
2542 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2543 if $color & cf::NDI_DEF;
2544
2545 $self->send_packet ("msg " . $self->{json_coder}->encode (
2546 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2547 } else {
2548 if ($color >= 0) {
2549 # replace some tags by gcfclient-compatible ones
2550 for ($msg) {
2551 1 while
2552 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2553 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2554 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2555 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2556 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2557 }
2558
2559 $color &= cf::NDI_COLOR_MASK;
2560
2561 utf8::encode $msg;
2562
2563 if (0 && $msg =~ /\[/) {
2564 # COMMAND/INFO
2565 $self->send_packet ("drawextinfo $color 10 8 $msg")
2566 } else {
2567 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2568 $self->send_packet ("drawinfo $color $msg")
2569 }
2570 }
2571 }
2572}
2573
2574=item $client->ext_msg ($type, @msg)
2575
2576Sends an ext event to the client.
2577
2578=cut
2579
2580sub cf::client::ext_msg($$@) {
2581 my ($self, $type, @msg) = @_;
2582
2583 if ($self->extcmd == 2) {
2584 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2585 } elsif ($self->extcmd == 1) { # TODO: remove
2586 push @msg, msgtype => "event_$type";
2587 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2588 }
2589}
2590
2591=item $client->ext_reply ($msgid, @msg)
2592
2593Sends an ext reply to the client.
2594
2595=cut
2596
2597sub cf::client::ext_reply($$@) {
2598 my ($self, $id, @msg) = @_;
2599
2600 if ($self->extcmd == 2) {
2601 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2602 } elsif ($self->extcmd == 1) {
2603 #TODO: version 1, remove
2604 unshift @msg, msgtype => "reply", msgid => $id;
2605 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2606 }
2607}
1978 2608
1979=item $success = $client->query ($flags, "text", \&cb) 2609=item $success = $client->query ($flags, "text", \&cb)
1980 2610
1981Queues a query to the client, calling the given callback with 2611Queues a query to the client, calling the given callback with
1982the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2612the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1983C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2613C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1984 2614
1985Queries can fail, so check the return code. Or don't, as queries will become 2615Queries can fail, so check the return code. Or don't, as queries will
1986reliable at some point in the future. 2616become reliable at some point in the future.
1987 2617
1988=cut 2618=cut
1989 2619
1990sub cf::client::query { 2620sub cf::client::query {
1991 my ($self, $flags, $text, $cb) = @_; 2621 my ($self, $flags, $text, $cb) = @_;
1999 utf8::encode $text; 2629 utf8::encode $text;
2000 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2630 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001 2631
2002 $self->send_packet ($self->{query_queue}[0][0]) 2632 $self->send_packet ($self->{query_queue}[0][0])
2003 if @{ $self->{query_queue} } == 1; 2633 if @{ $self->{query_queue} } == 1;
2634
2635 1
2004} 2636}
2005 2637
2006cf::client->attach ( 2638cf::client->attach (
2639 on_connect => sub {
2640 my ($ns) = @_;
2641
2642 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2643 },
2007 on_reply => sub { 2644 on_reply => sub {
2008 my ($ns, $msg) = @_; 2645 my ($ns, $msg) = @_;
2009 2646
2010 # this weird shuffling is so that direct followup queries 2647 # this weird shuffling is so that direct followup queries
2011 # get handled first 2648 # get handled first
2023 } else { 2660 } else {
2024 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2661 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025 } 2662 }
2026 } 2663 }
2027 }, 2664 },
2665 on_exticmd => sub {
2666 my ($ns, $buf) = @_;
2667
2668 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2669
2670 if (ref $msg) {
2671 my ($type, $reply, @payload) =
2672 "ARRAY" eq ref $msg
2673 ? @$msg
2674 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2675
2676 my @reply;
2677
2678 if (my $cb = $EXTICMD{$type}) {
2679 @reply = $cb->($ns, @payload);
2680 }
2681
2682 $ns->ext_reply ($reply, @reply)
2683 if $reply;
2684
2685 } else {
2686 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2687 }
2688
2689 cf::override;
2690 },
2028); 2691);
2029 2692
2030=item $client->async (\&cb) 2693=item $client->async (\&cb)
2031 2694
2032Create a new coroutine, running the specified callback. The coroutine will 2695Create a new coroutine, running the specified callback. The coroutine will
2073our $safe = new Safe "safe"; 2736our $safe = new Safe "safe";
2074our $safe_hole = new Safe::Hole; 2737our $safe_hole = new Safe::Hole;
2075 2738
2076$SIG{FPE} = 'IGNORE'; 2739$SIG{FPE} = 'IGNORE';
2077 2740
2078$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2741$safe->permit_only (Opcode::opset qw(
2742 :base_core :base_mem :base_orig :base_math
2743 grepstart grepwhile mapstart mapwhile
2744 sort time
2745));
2079 2746
2080# here we export the classes and methods available to script code 2747# here we export the classes and methods available to script code
2081 2748
2082=pod 2749=pod
2083 2750
2084The following fucntions and emthods are available within a safe environment: 2751The following functions and methods are available within a safe environment:
2085 2752
2086 cf::object contr pay_amount pay_player map 2753 cf::object
2754 contr pay_amount pay_player map x y force_find force_add
2755 insert remove name archname title slaying race decrease_ob_nr
2756
2087 cf::object::player player 2757 cf::object::player
2088 cf::player peaceful 2758 player
2089 cf::map trigger 2759
2760 cf::player
2761 peaceful
2762
2763 cf::map
2764 trigger
2090 2765
2091=cut 2766=cut
2092 2767
2093for ( 2768for (
2094 ["cf::object" => qw(contr pay_amount pay_player map)], 2769 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2770 insert remove inv name archname title slaying race
2771 decrease_ob_nr)],
2095 ["cf::object::player" => qw(player)], 2772 ["cf::object::player" => qw(player)],
2096 ["cf::player" => qw(peaceful)], 2773 ["cf::player" => qw(peaceful)],
2097 ["cf::map" => qw(trigger)], 2774 ["cf::map" => qw(trigger)],
2098) { 2775) {
2099 no strict 'refs'; 2776 no strict 'refs';
2170=back 2847=back
2171 2848
2172=cut 2849=cut
2173 2850
2174############################################################################# 2851#############################################################################
2175
2176=head2 EXTENSION DATABASE SUPPORT
2177
2178Crossfire maintains a very simple database for extension use. It can
2179currently store anything that can be serialised using Storable, which
2180excludes objects.
2181
2182The parameter C<$family> should best start with the name of the extension
2183using it, it should be unique.
2184
2185=over 4
2186
2187=item $hashref = cf::db_get $family
2188
2189Return a hashref for use by the extension C<$family>, which can be
2190modified. After modifications, you have to call C<cf::db_dirty> or
2191C<cf::db_sync>.
2192
2193=item $value = cf::db_get $family => $key
2194
2195Returns a single value from the database
2196
2197=item cf::db_put $family => $hashref
2198
2199Stores the given family hashref into the database. Updates are delayed, if
2200you want the data to be synced to disk immediately, use C<cf::db_sync>.
2201
2202=item cf::db_put $family => $key => $value
2203
2204Stores the given C<$value> in the family hash. Updates are delayed, if you
2205want the data to be synced to disk immediately, use C<cf::db_sync>.
2206
2207=item cf::db_dirty
2208
2209Marks the database as dirty, to be updated at a later time.
2210
2211=item cf::db_sync
2212
2213Immediately write the database to disk I<if it is dirty>.
2214
2215=cut
2216
2217our $DB;
2218
2219{
2220 my $path = cf::localdir . "/database.pst";
2221
2222 sub db_load() {
2223 $DB = stat $path ? Storable::retrieve $path : { };
2224 }
2225
2226 my $pid;
2227
2228 sub db_save() {
2229 waitpid $pid, 0 if $pid;
2230 if (0 == ($pid = fork)) {
2231 $DB->{_meta}{version} = 1;
2232 Storable::nstore $DB, "$path~";
2233 rename "$path~", $path;
2234 cf::_exit 0 if defined $pid;
2235 }
2236 }
2237
2238 my $dirty;
2239
2240 sub db_sync() {
2241 db_save if $dirty;
2242 undef $dirty;
2243 }
2244
2245 my $idle = Event->idle (
2246 reentrant => 0,
2247 min => 10,
2248 max => 20,
2249 repeat => 0,
2250 data => WF_AUTOCANCEL,
2251 cb => \&db_sync,
2252 );
2253
2254 sub db_dirty() {
2255 $dirty = 1;
2256 $idle->start;
2257 }
2258
2259 sub db_get($;$) {
2260 @_ >= 2
2261 ? $DB->{$_[0]}{$_[1]}
2262 : ($DB->{$_[0]} ||= { })
2263 }
2264
2265 sub db_put($$;$) {
2266 if (@_ >= 3) {
2267 $DB->{$_[0]}{$_[1]} = $_[2];
2268 } else {
2269 $DB->{$_[0]} = $_[1];
2270 }
2271 db_dirty;
2272 }
2273
2274 cf::global->attach (
2275 prio => 10000,
2276 on_cleanup => sub {
2277 db_sync;
2278 },
2279 );
2280}
2281
2282#############################################################################
2283# the server's init and main functions 2852# the server's init and main functions
2284 2853
2285sub load_resources { 2854sub load_facedata($) {
2286 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2855 my ($path) = @_;
2856
2857 # HACK to clear player env face cache, we need some signal framework
2858 # for this (global event?)
2859 %ext::player_env::MUSIC_FACE_CACHE = ();
2860
2861 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2862
2863 warn "loading facedata from $path\n";
2864
2865 my $facedata;
2866 0 < aio_load $path, $facedata
2867 or die "$path: $!";
2868
2869 $facedata = Coro::Storable::thaw $facedata;
2870
2871 $facedata->{version} == 2
2872 or cf::cleanup "$path: version mismatch, cannot proceed.";
2873
2874 # patch in the exptable
2875 $facedata->{resource}{"res/exp_table"} = {
2876 type => FT_RSRC,
2877 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2878 };
2879 cf::cede_to_tick;
2880
2881 {
2882 my $faces = $facedata->{faceinfo};
2883
2884 while (my ($face, $info) = each %$faces) {
2885 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2886 cf::face::set_visibility $idx, $info->{visibility};
2887 cf::face::set_magicmap $idx, $info->{magicmap};
2888 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2889 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2890
2891 cf::cede_to_tick;
2892 }
2893
2894 while (my ($face, $info) = each %$faces) {
2895 next unless $info->{smooth};
2896 my $idx = cf::face::find $face
2897 or next;
2898 if (my $smooth = cf::face::find $info->{smooth}) {
2899 cf::face::set_smooth $idx, $smooth;
2900 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2901 } else {
2902 warn "smooth face '$info->{smooth}' not found for face '$face'";
2903 }
2904
2905 cf::cede_to_tick;
2906 }
2907 }
2908
2909 {
2910 my $anims = $facedata->{animinfo};
2911
2912 while (my ($anim, $info) = each %$anims) {
2913 cf::anim::set $anim, $info->{frames}, $info->{facings};
2914 cf::cede_to_tick;
2915 }
2916
2917 cf::anim::invalidate_all; # d'oh
2918 }
2919
2920 {
2921 # TODO: for gcfclient pleasure, we should give resources
2922 # that gcfclient doesn't grok a >10000 face index.
2923 my $res = $facedata->{resource};
2924
2925 my $soundconf = delete $res->{"res/sound.conf"};
2926
2927 while (my ($name, $info) = each %$res) {
2928 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2929 my $data;
2930
2931 if ($info->{type} & 1) {
2932 # prepend meta info
2933
2934 my $meta = $enc->encode ({
2935 name => $name,
2936 %{ $info->{meta} || {} },
2937 });
2938
2939 $data = pack "(w/a*)*", $meta, $info->{data};
2940 } else {
2941 $data = $info->{data};
2942 }
2943
2944 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2945 cf::face::set_type $idx, $info->{type};
2946
2947 cf::cede_to_tick;
2948 }
2949
2950 if ($soundconf) {
2951 $soundconf = $enc->decode (delete $soundconf->{data});
2952
2953 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2954 my $sound = $soundconf->{compat}[$_]
2955 or next;
2956
2957 my $face = cf::face::find "sound/$sound->[1]";
2958 cf::sound::set $sound->[0] => $face;
2959 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2960 }
2961
2962 while (my ($k, $v) = each %{$soundconf->{event}}) {
2963 my $face = cf::face::find "sound/$v";
2964 cf::sound::set $k => $face;
2965 }
2966 }
2967 }
2968
2969 1
2970}
2971
2972register_exticmd fx_want => sub {
2973 my ($ns, $want) = @_;
2974
2975 while (my ($k, $v) = each %$want) {
2976 $ns->fx_want ($k, $v);
2977 }
2978};
2979
2980sub reload_regions {
2981 # HACK to clear player env face cache, we need some signal framework
2982 # for this (global event?)
2983 %ext::player_env::MUSIC_FACE_CACHE = ();
2984
2985 load_resource_file "$MAPDIR/regions"
2287 or die "unable to load regions file\n";#d# 2986 or die "unable to load regions file\n";
2288}
2289 2987
2290sub cfg_load { 2988 for (cf::region::list) {
2989 $_->{match} = qr/$_->{match}/
2990 if exists $_->{match};
2991 }
2992}
2993
2994sub reload_facedata {
2995 load_facedata "$DATADIR/facedata"
2996 or die "unable to load facedata\n";
2997}
2998
2999sub reload_archetypes {
3000 load_resource_file "$DATADIR/archetypes"
3001 or die "unable to load archetypes\n";
3002 #d# NEED to laod twice to resolve forward references
3003 # this really needs to be done in an extra post-pass
3004 # (which needs to be synchronous, so solve it differently)
3005 load_resource_file "$DATADIR/archetypes"
3006 or die "unable to load archetypes\n";
3007}
3008
3009sub reload_treasures {
3010 load_resource_file "$DATADIR/treasures"
3011 or die "unable to load treasurelists\n";
3012}
3013
3014sub reload_resources {
3015 warn "reloading resource files...\n";
3016
3017 reload_regions;
3018 reload_facedata;
3019 #reload_archetypes;#d#
3020 reload_archetypes;
3021 reload_treasures;
3022
3023 warn "finished reloading resource files\n";
3024}
3025
3026sub init {
3027 reload_resources;
3028}
3029
3030sub reload_config {
2291 open my $fh, "<:utf8", cf::confdir . "/config" 3031 open my $fh, "<:utf8", "$CONFDIR/config"
2292 or return; 3032 or return;
2293 3033
2294 local $/; 3034 local $/;
2295 *CFG = YAML::Syck::Load <$fh>; 3035 *CFG = YAML::Syck::Load <$fh>;
2296 3036
2304 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3044 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2305 and die "WARNING: m(un)lockall failed: $!\n"; 3045 and die "WARNING: m(un)lockall failed: $!\n";
2306 }; 3046 };
2307 warn $@ if $@; 3047 warn $@ if $@;
2308 } 3048 }
2309}
2310
2311sub init {
2312 load_resources;
2313} 3049}
2314 3050
2315sub main { 3051sub main {
2316 # we must not ever block the main coroutine 3052 # we must not ever block the main coroutine
2317 local $Coro::idle = sub { 3053 local $Coro::idle = sub {
2319 (async { 3055 (async {
2320 Event::one_event; 3056 Event::one_event;
2321 })->prio (Coro::PRIO_MAX); 3057 })->prio (Coro::PRIO_MAX);
2322 }; 3058 };
2323 3059
2324 cfg_load; 3060 reload_config;
2325 db_load; 3061 db_init;
2326 load_extensions; 3062 load_extensions;
2327 3063
2328 $TICK_WATCHER->start; 3064 $TICK_WATCHER->start;
2329 Event::loop; 3065 Event::loop;
2330} 3066}
2345 }, 3081 },
2346 ); 3082 );
2347 } 3083 }
2348} 3084}
2349 3085
3086sub write_runtime {
3087 my $runtime = "$LOCALDIR/runtime";
3088
3089 # first touch the runtime file to show we are still running:
3090 # the fsync below can take a very very long time.
3091
3092 IO::AIO::aio_utime $runtime, undef, undef;
3093
3094 my $guard = cf::lock_acquire "write_runtime";
3095
3096 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3097 or return;
3098
3099 my $value = $cf::RUNTIME + 90 + 10;
3100 # 10 is the runtime save interval, for a monotonic clock
3101 # 60 allows for the watchdog to kill the server.
3102
3103 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3104 and return;
3105
3106 # always fsync - this file is important
3107 aio_fsync $fh
3108 and return;
3109
3110 # touch it again to show we are up-to-date
3111 aio_utime $fh, undef, undef;
3112
3113 close $fh
3114 or return;
3115
3116 aio_rename "$runtime~", $runtime
3117 and return;
3118
3119 warn "runtime file written.\n";
3120
3121 1
3122}
3123
2350sub emergency_save() { 3124sub emergency_save() {
2351 my $freeze_guard = cf::freeze_mainloop; 3125 my $freeze_guard = cf::freeze_mainloop;
2352 3126
2353 warn "enter emergency perl save\n"; 3127 warn "enter emergency perl save\n";
2354 3128
2369 my $map = $cf::MAP{$path} or next; 3143 my $map = $cf::MAP{$path} or next;
2370 $map->valid or next; 3144 $map->valid or next;
2371 $map->save; 3145 $map->save;
2372 } 3146 }
2373 warn "end emergency map save\n"; 3147 warn "end emergency map save\n";
3148
3149 warn "begin emergency database checkpoint\n";
3150 BDB::db_env_txn_checkpoint $DB_ENV;
3151 warn "end emergency database checkpoint\n";
2374 }; 3152 };
2375 3153
2376 warn "leave emergency perl save\n"; 3154 warn "leave emergency perl save\n";
2377} 3155}
2378 3156
3157sub post_cleanup {
3158 my ($make_core) = @_;
3159
3160 warn Carp::longmess "post_cleanup backtrace"
3161 if $make_core;
3162}
3163
2379sub reload() { 3164sub do_reload_perl() {
2380 # can/must only be called in main 3165 # can/must only be called in main
2381 if ($Coro::current != $Coro::main) { 3166 if ($Coro::current != $Coro::main) {
2382 warn "can only reload from main coroutine"; 3167 warn "can only reload from main coroutine";
2383 return; 3168 return;
2384 } 3169 }
2385 3170
2386 warn "reloading..."; 3171 warn "reloading...";
2387 3172
2388 warn "cancelling server ticker"; 3173 warn "entering sync_job";
2389 $TICK_WATCHER->cancel;
2390 3174
3175 cf::sync_job {
3176 cf::write_runtime; # external watchdog should not bark
2391 cf::emergency_save; 3177 cf::emergency_save;
3178 cf::write_runtime; # external watchdog should not bark
2392 3179
2393 eval { 3180 warn "syncing database to disk";
3181 BDB::db_env_txn_checkpoint $DB_ENV;
3182
2394 # if anything goes wrong in here, we should simply crash as we already saved 3183 # if anything goes wrong in here, we should simply crash as we already saved
2395
2396 warn "syncing database to disk";
2397 cf::db_sync;
2398 3184
2399 warn "cancelling all WF_AUTOCANCEL watchers"; 3185 warn "cancelling all WF_AUTOCANCEL watchers";
2400 for (Event::all_watchers) { 3186 for (Event::all_watchers) {
2401 $_->cancel if $_->data & WF_AUTOCANCEL; 3187 $_->cancel if $_->data & WF_AUTOCANCEL;
2402 } 3188 }
2403 3189
2404 warn "flushing outstanding aio requests"; 3190 warn "flushing outstanding aio requests";
2405 for (;;) { 3191 for (;;) {
3192 BDB::flush;
2406 IO::AIO::flush; 3193 IO::AIO::flush;
2407 Coro::cede; 3194 Coro::cede;
2408 last unless IO::AIO::nreqs; 3195 last unless IO::AIO::nreqs || BDB::nreqs;
2409 warn "iterate..."; 3196 warn "iterate...";
2410 } 3197 }
3198
3199 ++$RELOAD;
2411 3200
2412 warn "cancelling all extension coros"; 3201 warn "cancelling all extension coros";
2413 $_->cancel for values %EXT_CORO; 3202 $_->cancel for values %EXT_CORO;
2414 %EXT_CORO = (); 3203 %EXT_CORO = ();
2415 3204
2416 warn "removing commands"; 3205 warn "removing commands";
2417 %COMMAND = (); 3206 %COMMAND = ();
2418 3207
2419 warn "removing ext commands"; 3208 warn "removing ext/exti commands";
2420 %EXTCMD = (); 3209 %EXTCMD = ();
3210 %EXTICMD = ();
2421 3211
2422 warn "unloading/nuking all extensions"; 3212 warn "unloading/nuking all extensions";
2423 for my $pkg (@EXTS) { 3213 for my $pkg (@EXTS) {
2424 warn "... unloading $pkg"; 3214 warn "... unloading $pkg";
2425 3215
2455 Symbol::delete_package "safe::$_" 3245 Symbol::delete_package "safe::$_"
2456 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3246 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2457 3247
2458 warn "unloading cf.pm \"a bit\""; 3248 warn "unloading cf.pm \"a bit\"";
2459 delete $INC{"cf.pm"}; 3249 delete $INC{"cf.pm"};
3250 delete $INC{"cf/pod.pm"};
2460 3251
2461 # don't, removes xs symbols, too, 3252 # don't, removes xs symbols, too,
2462 # and global variables created in xs 3253 # and global variables created in xs
2463 #Symbol::delete_package __PACKAGE__; 3254 #Symbol::delete_package __PACKAGE__;
2464 3255
2467 warn "reloading cf.pm"; 3258 warn "reloading cf.pm";
2468 require cf; 3259 require cf;
2469 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3260 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2470 3261
2471 warn "loading config and database again"; 3262 warn "loading config and database again";
2472 cf::cfg_load; 3263 cf::reload_config;
2473 cf::db_load;
2474 3264
2475 warn "loading extensions"; 3265 warn "loading extensions";
2476 cf::load_extensions; 3266 cf::load_extensions;
2477 3267
2478 warn "reattaching attachments to objects/players"; 3268 warn "reattaching attachments to objects/players";
2479 _global_reattach; 3269 _global_reattach; # objects, sockets
2480 warn "reattaching attachments to maps"; 3270 warn "reattaching attachments to maps";
2481 reattach $_ for values %MAP; 3271 reattach $_ for values %MAP;
3272 warn "reattaching attachments to players";
3273 reattach $_ for values %PLAYER;
2482 3274
2483 warn "loading reloadable resources"; 3275 warn "leaving sync_job";
2484 load_resources;
2485 3276
2486 warn "restarting server ticker"; 3277 1
2487 3278 } or do {
2488 $TICK_WATCHER->start;
2489 };
2490
2491 if ($@) {
2492 warn $@; 3279 warn $@;
2493 warn "error while reloading, exiting."; 3280 warn "error while reloading, exiting.";
2494 exit 1; 3281 exit 1;
2495 } 3282 };
2496 3283
2497 warn "reloaded"; 3284 warn "reloaded";
2498}; 3285};
2499 3286
2500our $RELOAD_WATCHER; # used only during reload 3287our $RELOAD_WATCHER; # used only during reload
2501 3288
3289sub reload_perl() {
3290 # doing reload synchronously and two reloads happen back-to-back,
3291 # coro crashes during coro_state_free->destroy here.
3292
3293 $RELOAD_WATCHER ||= Event->timer (
3294 reentrant => 0,
3295 after => 0,
3296 data => WF_AUTOCANCEL,
3297 cb => sub {
3298 do_reload_perl;
3299 undef $RELOAD_WATCHER;
3300 },
3301 );
3302}
3303
2502register_command "reload" => sub { 3304register_command "reload" => sub {
2503 my ($who, $arg) = @_; 3305 my ($who, $arg) = @_;
2504 3306
2505 if ($who->flag (FLAG_WIZ)) { 3307 if ($who->flag (FLAG_WIZ)) {
2506 $who->message ("reloading server."); 3308 $who->message ("reloading server.");
2507 3309 async { reload_perl };
2508 # doing reload synchronously and two reloads happen back-to-back,
2509 # coro crashes during coro_state_free->destroy here.
2510
2511 $RELOAD_WATCHER ||= Event->timer (
2512 reentrant => 0,
2513 after => 0,
2514 data => WF_AUTOCANCEL,
2515 cb => sub {
2516 reload;
2517 undef $RELOAD_WATCHER;
2518 },
2519 );
2520 } 3310 }
2521}; 3311};
2522 3312
2523unshift @INC, $LIBDIR; 3313unshift @INC, $LIBDIR;
2524 3314
2525my $bug_warning = 0; 3315my $bug_warning = 0;
2526 3316
3317our @WAIT_FOR_TICK;
3318our @WAIT_FOR_TICK_BEGIN;
3319
3320sub wait_for_tick {
3321 return unless $TICK_WATCHER->is_active;
3322 return if $Coro::current == $Coro::main;
3323
3324 my $signal = new Coro::Signal;
3325 push @WAIT_FOR_TICK, $signal;
3326 $signal->wait;
3327}
3328
3329sub wait_for_tick_begin {
3330 return unless $TICK_WATCHER->is_active;
3331 return if $Coro::current == $Coro::main;
3332
3333 my $signal = new Coro::Signal;
3334 push @WAIT_FOR_TICK_BEGIN, $signal;
3335 $signal->wait;
3336}
3337
3338 my $min = 1e6;#d#
3339 my $avg = 10;
2527$TICK_WATCHER = Event->timer ( 3340$TICK_WATCHER = Event->timer (
2528 reentrant => 0, 3341 reentrant => 0,
2529 parked => 1, 3342 parked => 1,
2530 prio => 0, 3343 prio => 0,
2531 at => $NEXT_TICK || $TICK, 3344 at => $NEXT_TICK || $TICK,
2535 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3348 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2536 unless ++$bug_warning > 10; 3349 unless ++$bug_warning > 10;
2537 return; 3350 return;
2538 } 3351 }
2539 3352
2540 $NOW = Event::time; 3353 $NOW = $tick_start = Event::time;
2541 3354
2542 cf::server_tick; # one server iteration 3355 cf::server_tick; # one server iteration
3356
3357 0 && sync_job {#d#
3358 for(1..10) {
3359 my $t = Event::time;
3360 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3361 or die;
3362
3363 $map->width (50);
3364 $map->height (50);
3365 $map->alloc;
3366 $map->_load_objects ("/tmp/x.map", 1);
3367 my $t = Event::time - $t;
3368
3369 #next unless $t < 0.0013;#d#
3370 if ($t < $min) {
3371 $min = $t;
3372 }
3373 $avg = $avg * 0.99 + $t * 0.01;
3374 }
3375 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3376 exit 0;
3377 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3378 };
3379
2543 $RUNTIME += $TICK; 3380 $RUNTIME += $TICK;
2544 $NEXT_TICK += $TICK; 3381 $NEXT_TICK += $TICK;
2545 3382
2546 $WAIT_FOR_TICK->broadcast; 3383 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2547 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3384 $NEXT_RUNTIME_WRITE = $NOW + 10;
2548 3385 Coro::async_pool {
2549 Event::sweep; 3386 write_runtime
2550 Coro::cede_notself; 3387 or warn "ERROR: unable to write runtime file: $!";
3388 };
2551 3389 }
3390
2552# my $AFTER = Event::time; 3391# my $AFTER = Event::time;
2553# warn $AFTER - $NOW;#d# 3392# warn $AFTER - $NOW;#d#
2554 3393
3394 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3395 $sig->send;
3396 }
3397 while (my $sig = shift @WAIT_FOR_TICK) {
3398 $sig->send;
3399 }
3400
3401 $NOW = Event::time;
3402
2555 # if we are delayed by four ticks or more, skip them all 3403 # if we are delayed by four ticks or more, skip them all
2556 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3404 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2557 3405
2558 $TICK_WATCHER->at ($NEXT_TICK); 3406 $TICK_WATCHER->at ($NEXT_TICK);
2559 $TICK_WATCHER->start; 3407 $TICK_WATCHER->start;
3408
3409 $LOAD = ($NOW - $tick_start) / $TICK;
3410 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3411
3412 _post_tick;
3413
3414
2560 }, 3415 },
2561); 3416);
2562 3417
2563{ 3418{
2564 BDB::max_poll_time $TICK * 0.1; 3419 BDB::max_poll_time $TICK * 0.1;
2589 3444
2590 unless ($DB_ENV) { 3445 unless ($DB_ENV) {
2591 $DB_ENV = BDB::db_env_create; 3446 $DB_ENV = BDB::db_env_create;
2592 3447
2593 cf::sync_job { 3448 cf::sync_job {
3449 eval {
2594 BDB::db_env_open 3450 BDB::db_env_open
2595 $DB_ENV, 3451 $DB_ENV,
2596 $BDB_ENV_DIR, 3452 $BDBDIR,
2597 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3453 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2598 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3454 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2599 0666; 3455 0666;
2600 3456
2601 cf::cleanup "$!" if $!; 3457 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2602 3458
2603 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3459 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2604 $DB_ENV->set_lk_detect; 3460 $DB_ENV->set_lk_detect;
3461 };
3462
3463 cf::cleanup "db_env_open(db): $@" if $@;
2605 }; 3464 };
2606 } 3465 }
2607} 3466}
2608 3467
2609{ 3468{
2611 3470
2612 undef $Coro::AIO::WATCHER; 3471 undef $Coro::AIO::WATCHER;
2613 IO::AIO::max_poll_time $TICK * 0.1; 3472 IO::AIO::max_poll_time $TICK * 0.1;
2614 $AIO_POLL_WATCHER = Event->io ( 3473 $AIO_POLL_WATCHER = Event->io (
2615 reentrant => 0, 3474 reentrant => 0,
3475 data => WF_AUTOCANCEL,
2616 fd => IO::AIO::poll_fileno, 3476 fd => IO::AIO::poll_fileno,
2617 poll => 'r', 3477 poll => 'r',
2618 prio => 6, 3478 prio => 6,
2619 data => WF_AUTOCANCEL,
2620 cb => \&IO::AIO::poll_cb, 3479 cb => \&IO::AIO::poll_cb,
2621 ); 3480 );
2622} 3481}
2623 3482
2624$WRITE_RUNTIME_WATCHER = Event->timer ( 3483my $_log_backtrace;
2625 reentrant => 0, 3484
2626 data => WF_AUTOCANCEL, 3485sub _log_backtrace {
2627 after => 1, 3486 my ($msg, @addr) = @_;
2628 interval => 10, 3487
2629 prio => 6, # keep it lowest so it acts like a watchdog 3488 $msg =~ s/\n//;
2630 cb => Coro::unblock_sub { 3489
2631 write_runtime 3490 # limit the # of concurrent backtraces
2632 or warn "ERROR: unable to write runtime file: $!"; 3491 if ($_log_backtrace < 2) {
3492 ++$_log_backtrace;
3493 async {
3494 my @bt = fork_call {
3495 @addr = map { sprintf "%x", $_ } @addr;
3496 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3497 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3498 or die "addr2line: $!";
3499
3500 my @funcs;
3501 my @res = <$fh>;
3502 chomp for @res;
3503 while (@res) {
3504 my ($func, $line) = splice @res, 0, 2, ();
3505 push @funcs, "[$func] $line";
3506 }
3507
3508 @funcs
3509 };
3510
3511 LOG llevInfo, "[ABT] $msg\n";
3512 LOG llevInfo, "[ABT] $_\n" for @bt;
3513 --$_log_backtrace;
3514 };
3515 } else {
3516 LOG llevInfo, "[ABT] $msg\n";
3517 LOG llevInfo, "[ABT] [suppressed]\n";
2633 }, 3518 }
2634); 3519}
3520
3521# load additional modules
3522use cf::pod;
2635 3523
2636END { cf::emergency_save } 3524END { cf::emergency_save }
2637 3525
26381 35261
2639 3527

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines