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.353 by root, Sun Sep 2 08:43:46 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/(?<![BIUGHT])</&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 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1478 # replace G<male|female> tags
1479 || s{G<([^>|]*)\|([^>]*)>}{
1480 $self->gender ? $2 : $1
1481 }ge
1482 # replace H<hint text>
1483 || s{H<([^\>]*)>}
1484 {
1485 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1486 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1487 "")
1488 [$self->{hintmode}]
1489 }ge;
1490
1491 # create single paragraphs (very hackish)
1492 s/(?<=\S)\n(?=\w)/ /g;
1493
1494 # compress some whitespace
1495 s/\s+\n/\n/g; # ws line-ends
1496 s/\n\n+/\n/g; # double lines
1497 s/^\n+//; # beginning lines
1498 s/\n+$//; # ending lines
1499
1500 $_
1501}
1502
1503sub hintmode {
1504 $_[0]{hintmode} = $_[1] if @_ > 1;
1505 $_[0]{hintmode}
1506}
1507
1110=item $player->ext_reply ($msgid, $msgtype, %msg) 1508=item $player->ext_reply ($msgid, @msg)
1111 1509
1112Sends an ext reply to the player. 1510Sends an ext reply to the player.
1113 1511
1114=cut 1512=cut
1115 1513
1116sub ext_reply($$$%) { 1514sub ext_reply($$@) {
1117 my ($self, $id, %msg) = @_; 1515 my ($self, $id, @msg) = @_;
1118 1516
1119 $msg{msgid} = $id; 1517 $self->ns->ext_reply ($id, @msg)
1120
1121 $self->send ("ext " . cf::to_json \%msg);
1122} 1518}
1123 1519
1124package cf; 1520=item $player->ext_msg ($type, @msg)
1521
1522Sends an ext event to the client.
1523
1524=cut
1525
1526sub ext_msg($$@) {
1527 my ($self, $type, @msg) = @_;
1528
1529 $self->ns->ext_msg ($type, @msg);
1530}
1531
1532=head3 cf::region
1533
1534=over 4
1535
1536=cut
1537
1538package cf::region;
1539
1540=item cf::region::find_by_path $path
1541
1542Tries to decuce the likely region for a map knowing only its path.
1543
1544=cut
1545
1546sub find_by_path($) {
1547 my ($path) = @_;
1548
1549 my ($match, $specificity);
1550
1551 for my $region (list) {
1552 if ($region->{match} && $path =~ $region->{match}) {
1553 ($match, $specificity) = ($region, $region->specificity)
1554 if $region->specificity > $specificity;
1555 }
1556 }
1557
1558 $match
1559}
1125 1560
1126=back 1561=back
1127
1128 1562
1129=head3 cf::map 1563=head3 cf::map
1130 1564
1131=over 4 1565=over 4
1132 1566
1187 my ($self, $merge) = @_; 1621 my ($self, $merge) = @_;
1188 1622
1189 # we have to keep some variables in memory intact 1623 # we have to keep some variables in memory intact
1190 local $self->{path}; 1624 local $self->{path};
1191 local $self->{load_path}; 1625 local $self->{load_path};
1192 local $self->{deny_save};
1193 local $self->{deny_reset};
1194 1626
1195 $self->SUPER::thawer_merge ($merge); 1627 $self->SUPER::thawer_merge ($merge);
1196} 1628}
1197 1629
1198sub normalise { 1630sub normalise {
1245 $self->init; # pass $1 etc. 1677 $self->init; # pass $1 etc.
1246 return $self; 1678 return $self;
1247 } 1679 }
1248 } 1680 }
1249 1681
1250 Carp::carp "unable to resolve path '$path' (base '$base')."; 1682 Carp::cluck "unable to resolve path '$path' (base '$base').";
1251 () 1683 ()
1252} 1684}
1253 1685
1254sub init { 1686sub init {
1255 my ($self) = @_; 1687 my ($self) = @_;
1270 1702
1271# the original (read-only) location 1703# the original (read-only) location
1272sub load_path { 1704sub load_path {
1273 my ($self) = @_; 1705 my ($self) = @_;
1274 1706
1275 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1707 "$MAPDIR/$self->{path}.map"
1276} 1708}
1277 1709
1278# the temporary/swap location 1710# the temporary/swap location
1279sub save_path { 1711sub save_path {
1280 my ($self) = @_; 1712 my ($self) = @_;
1281 1713
1282 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1714 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1715 "$TMPDIR/$path.map"
1284} 1716}
1285 1717
1286# the unique path, undef == no special unique path 1718# the unique path, undef == no special unique path
1287sub uniq_path { 1719sub uniq_path {
1288 my ($self) = @_; 1720 my ($self) = @_;
1289 1721
1290 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1722 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1291 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1723 "$UNIQUEDIR/$path"
1292} 1724}
1293 1725
1294# and all this just because we cannot iterate over 1726# and all this just because we cannot iterate over
1295# all maps in C++... 1727# all maps in C++...
1296sub change_all_map_light { 1728sub change_all_map_light {
1298 1730
1299 $_->change_map_light ($change) 1731 $_->change_map_light ($change)
1300 for grep $_->outdoor, values %cf::MAP; 1732 for grep $_->outdoor, values %cf::MAP;
1301} 1733}
1302 1734
1735sub decay_objects {
1736 my ($self) = @_;
1737
1738 return if $self->{deny_reset};
1739
1740 $self->do_decay_objects;
1741}
1742
1303sub unlink_save { 1743sub unlink_save {
1304 my ($self) = @_; 1744 my ($self) = @_;
1305 1745
1306 utf8::encode (my $save = $self->save_path); 1746 utf8::encode (my $save = $self->save_path);
1307 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1747 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1308 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1748 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} 1749}
1315 1750
1316sub load_header_from($) { 1751sub load_header_from($) {
1317 my ($self, $path) = @_; 1752 my ($self, $path) = @_;
1318 1753
1368 $self->load_header_orig 1803 $self->load_header_orig
1369 or return; 1804 or return;
1370 $self->prepare_orig; 1805 $self->prepare_orig;
1371 } 1806 }
1372 1807
1808 $self->{deny_reset} = 1
1809 if $self->no_reset;
1810
1811 $self->default_region (cf::region::find_by_path $self->{path})
1812 unless $self->default_region;
1813
1373 1 1814 1
1374} 1815}
1375 1816
1376sub find; 1817sub find;
1377sub find { 1818sub find {
1389 $map->{last_save} = $cf::RUNTIME; 1830 $map->{last_save} = $cf::RUNTIME;
1390 1831
1391 $map->load_header 1832 $map->load_header
1392 or return; 1833 or return;
1393 1834
1394 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1835 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1395 # doing this can freeze the server in a sync job, obviously 1836 # doing this can freeze the server in a sync job, obviously
1396 #$cf::WAIT_FOR_TICK->wait; 1837 #$cf::WAIT_FOR_TICK->wait;
1397 $map->reset; 1838 $map->reset;
1398 undef $guard; 1839 undef $guard;
1399 return find $path; 1840 return find $path;
1410 my ($self) = @_; 1851 my ($self) = @_;
1411 1852
1412 local $self->{deny_reset} = 1; # loading can take a long time 1853 local $self->{deny_reset} = 1; # loading can take a long time
1413 1854
1414 my $path = $self->{path}; 1855 my $path = $self->{path};
1856
1857 {
1858 my $guard1 = cf::lock_acquire "map_data:$path";
1415 my $guard = cf::lock_acquire "map_load:$path"; 1859 my $guard2 = cf::lock_acquire "map_load:$path";
1416 1860
1417 return if $self->in_memory != cf::MAP_SWAPPED; 1861 return if $self->in_memory != cf::MAP_SWAPPED;
1418 1862
1419 $self->in_memory (cf::MAP_LOADING); 1863 $self->in_memory (cf::MAP_LOADING);
1420 1864
1421 $self->alloc; 1865 $self->alloc;
1422 1866
1423 $self->pre_load; 1867 $self->pre_load;
1868 cf::cede_to_tick;
1424 1869
1425 $self->_load_objects ($self->{load_path}, 1) 1870 $self->_load_objects ($self->{load_path}, 1)
1426 or return; 1871 or return;
1427 1872
1428 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1873 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1429 if delete $self->{load_original}; 1874 if delete $self->{load_original};
1430 1875
1431 if (my $uniq = $self->uniq_path) { 1876 if (my $uniq = $self->uniq_path) {
1432 utf8::encode $uniq; 1877 utf8::encode $uniq;
1433 if (aio_open $uniq, O_RDONLY, 0) { 1878 if (aio_open $uniq, O_RDONLY, 0) {
1434 $self->clear_unique_items; 1879 $self->clear_unique_items;
1435 $self->_load_objects ($uniq, 0); 1880 $self->_load_objects ($uniq, 0);
1436 } 1881 }
1437 } 1882 }
1438 1883
1439 Coro::cede; 1884 cf::cede_to_tick;
1440
1441 # now do the right thing for maps 1885 # now do the right thing for maps
1442 $self->link_multipart_objects; 1886 $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) 1887 $self->difficulty ($self->estimate_difficulty)
1451 unless $self->difficulty; 1888 unless $self->difficulty;
1452 Coro::cede; 1889 cf::cede_to_tick;
1890
1891 unless ($self->{deny_activate}) {
1892 $self->decay_objects;
1893 $self->fix_auto_apply;
1894 $self->update_buttons;
1895 cf::cede_to_tick;
1896 $self->set_darkness_map;
1897 cf::cede_to_tick;
1453 $self->activate; 1898 $self->activate;
1899 }
1900
1901 $self->{last_save} = $cf::RUNTIME;
1902 $self->last_access ($cf::RUNTIME);
1903
1904 $self->in_memory (cf::MAP_IN_MEMORY);
1454 } 1905 }
1455 1906
1456 $self->post_load; 1907 $self->post_load;
1457
1458 $self->in_memory (cf::MAP_IN_MEMORY);
1459} 1908}
1460 1909
1461sub customise_for { 1910sub customise_for {
1462 my ($self, $ob) = @_; 1911 my ($self, $ob) = @_;
1463 1912
1464 return find "~" . $ob->name . "/" . $self->{path} 1913 return find "~" . $ob->name . "/" . $self->{path}
1465 if $self->per_player; 1914 if $self->per_player;
1466 1915
1916# return find "?party/" . $ob->name . "/" . $self->{path}
1917# if $self->per_party;
1918
1467 $self 1919 $self
1468} 1920}
1469 1921
1470# find and load all maps in the 3x3 area around a map 1922# find and load all maps in the 3x3 area around a map
1471sub load_diag { 1923sub load_neighbours {
1472 my ($map) = @_; 1924 my ($map) = @_;
1473 1925
1474 my @diag; # diagonal neighbours 1926 my @neigh; # diagonal neighbours
1475 1927
1476 for (0 .. 3) { 1928 for (0 .. 3) {
1477 my $neigh = $map->tile_path ($_) 1929 my $neigh = $map->tile_path ($_)
1478 or next; 1930 or next;
1479 $neigh = find $neigh, $map 1931 $neigh = find $neigh, $map
1480 or next; 1932 or next;
1481 $neigh->load; 1933 $neigh->load;
1482 1934
1935 push @neigh,
1483 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1936 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1484 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1937 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1485 } 1938 }
1486 1939
1487 for (@diag) { 1940 for (grep defined $_->[0], @neigh) {
1941 my ($path, $origin) = @$_;
1488 my $neigh = find @$_ 1942 my $neigh = find $path, $origin
1489 or next; 1943 or next;
1490 $neigh->load; 1944 $neigh->load;
1491 } 1945 }
1492} 1946}
1493 1947
1498} 1952}
1499 1953
1500sub do_load_sync { 1954sub do_load_sync {
1501 my ($map) = @_; 1955 my ($map) = @_;
1502 1956
1957 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1958 if $Coro::current == $Coro::main;
1959
1503 cf::sync_job { $map->load }; 1960 cf::sync_job { $map->load };
1504} 1961}
1505 1962
1506our %MAP_PREFETCH; 1963our %MAP_PREFETCH;
1507our $MAP_PREFETCHER = undef; 1964our $MAP_PREFETCHER = undef;
1508 1965
1509sub find_async { 1966sub find_async {
1510 my ($path, $origin) = @_; 1967 my ($path, $origin, $load) = @_;
1511 1968
1512 $path = normalise $path, $origin && $origin->{path}; 1969 $path = normalise $path, $origin && $origin->{path};
1513 1970
1514 if (my $map = $cf::MAP{$path}) { 1971 if (my $map = $cf::MAP{$path}) {
1515 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1972 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1516 } 1973 }
1517 1974
1518 undef $MAP_PREFETCH{$path}; 1975 $MAP_PREFETCH{$path} |= $load;
1976
1519 $MAP_PREFETCHER ||= cf::async { 1977 $MAP_PREFETCHER ||= cf::async {
1520 while (%MAP_PREFETCH) { 1978 while (%MAP_PREFETCH) {
1521 for my $path (keys %MAP_PREFETCH) { 1979 while (my ($k, $v) = each %MAP_PREFETCH) {
1522 my $map = find $path 1980 if (my $map = find $k) {
1523 or next;
1524 $map->load; 1981 $map->load if $v;
1982 }
1525 1983
1526 delete $MAP_PREFETCH{$path}; 1984 delete $MAP_PREFETCH{$k};
1527 } 1985 }
1528 } 1986 }
1529 undef $MAP_PREFETCHER; 1987 undef $MAP_PREFETCHER;
1530 }; 1988 };
1531 $MAP_PREFETCHER->prio (6); 1989 $MAP_PREFETCHER->prio (6);
1534} 1992}
1535 1993
1536sub save { 1994sub save {
1537 my ($self) = @_; 1995 my ($self) = @_;
1538 1996
1539 my $lock = cf::lock_acquire "map_data:" . $self->path; 1997 my $lock = cf::lock_acquire "map_data:$self->{path}";
1540 1998
1541 $self->{last_save} = $cf::RUNTIME; 1999 $self->{last_save} = $cf::RUNTIME;
1542 2000
1543 return unless $self->dirty; 2001 return unless $self->dirty;
1544 2002
1567 my ($self) = @_; 2025 my ($self) = @_;
1568 2026
1569 # save first because save cedes 2027 # save first because save cedes
1570 $self->save; 2028 $self->save;
1571 2029
1572 my $lock = cf::lock_acquire "map_data:" . $self->path; 2030 my $lock = cf::lock_acquire "map_data:$self->{path}";
1573 2031
1574 return if $self->players; 2032 return if $self->players;
1575 return if $self->in_memory != cf::MAP_IN_MEMORY; 2033 return if $self->in_memory != cf::MAP_IN_MEMORY;
1576 return if $self->{deny_save}; 2034 return if $self->{deny_save};
1577 2035
1581 2039
1582sub reset_at { 2040sub reset_at {
1583 my ($self) = @_; 2041 my ($self) = @_;
1584 2042
1585 # TODO: safety, remove and allow resettable per-player maps 2043 # 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}; 2044 return 1e99 if $self->{deny_reset};
1588 2045
1589 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2046 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1590 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2047 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1591 2048
1602 my ($self) = @_; 2059 my ($self) = @_;
1603 2060
1604 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2061 my $lock = cf::lock_acquire "map_data:$self->{path}";
1605 2062
1606 return if $self->players; 2063 return if $self->players;
1607 return if $self->isa ("ext::map_per_player");#d#
1608 2064
1609 warn "resetting map ", $self->path;#d# 2065 warn "resetting map ", $self->path;
2066
2067 $self->in_memory (cf::MAP_SWAPPED);
2068
2069 # need to save uniques path
2070 unless ($self->{deny_save}) {
2071 my $uniq = $self->uniq_path; utf8::encode $uniq;
2072
2073 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2074 if $uniq;
2075 }
1610 2076
1611 delete $cf::MAP{$self->path}; 2077 delete $cf::MAP{$self->path};
1612 2078
1613 $self->in_memory (cf::MAP_SWAPPED);
1614 $self->clear; 2079 $self->clear;
1615 2080
1616 $_->clear_links_to ($self) for values %cf::MAP; 2081 $_->clear_links_to ($self) for values %cf::MAP;
1617 2082
1618 $self->unlink_save; 2083 $self->unlink_save;
1622my $nuke_counter = "aaaa"; 2087my $nuke_counter = "aaaa";
1623 2088
1624sub nuke { 2089sub nuke {
1625 my ($self) = @_; 2090 my ($self) = @_;
1626 2091
2092 {
2093 my $lock = cf::lock_acquire "map_data:$self->{path}";
2094
1627 delete $cf::MAP{$self->path}; 2095 delete $cf::MAP{$self->path};
1628 2096
1629 $self->unlink_save; 2097 $self->unlink_save;
1630 2098
1631 bless $self, "cf::map"; 2099 bless $self, "cf::map";
1632 delete $self->{deny_reset}; 2100 delete $self->{deny_reset};
1633 $self->{deny_save} = 1; 2101 $self->{deny_save} = 1;
1634 $self->reset_timeout (1); 2102 $self->reset_timeout (1);
1635 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2103 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1636 2104
1637 $cf::MAP{$self->path} = $self; 2105 $cf::MAP{$self->path} = $self;
2106 }
1638 2107
1639 $self->reset; # polite request, might not happen 2108 $self->reset; # polite request, might not happen
2109}
2110
2111=item $maps = cf::map::tmp_maps
2112
2113Returns an arrayref with all map paths of currently instantiated and saved
2114maps. May block.
2115
2116=cut
2117
2118sub tmp_maps() {
2119 [
2120 map {
2121 utf8::decode $_;
2122 /\.map$/
2123 ? normalise $_
2124 : ()
2125 } @{ aio_readdir $TMPDIR or [] }
2126 ]
2127}
2128
2129=item $maps = cf::map::random_maps
2130
2131Returns an arrayref with all map paths of currently instantiated and saved
2132random maps. May block.
2133
2134=cut
2135
2136sub random_maps() {
2137 [
2138 map {
2139 utf8::decode $_;
2140 /\.map$/
2141 ? normalise "?random/$_"
2142 : ()
2143 } @{ aio_readdir $RANDOMDIR or [] }
2144 ]
1640} 2145}
1641 2146
1642=item cf::map::unique_maps 2147=item cf::map::unique_maps
1643 2148
1644Returns an arrayref of paths of all shared maps that have 2149Returns an arrayref of paths of all shared maps that have
1645instantiated unique items. May block. 2150instantiated unique items. May block.
1646 2151
1647=cut 2152=cut
1648 2153
1649sub unique_maps() { 2154sub unique_maps() {
1650 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2155 [
1651 or return; 2156 map {
1652
1653 my @paths;
1654
1655 for (@$files) {
1656 utf8::decode $_; 2157 utf8::decode $_;
1657 next if /\.pst$/; 2158 /\.map$/
1658 next unless /^$PATH_SEP/o; 2159 ? normalise $_
1659 2160 : ()
1660 push @paths, cf::map::normalise $_; 2161 } @{ aio_readdir $UNIQUEDIR or [] }
1661 } 2162 ]
1662
1663 \@paths
1664} 2163}
1665 2164
1666package cf; 2165package cf;
1667 2166
1668=back 2167=back
1714 2213
1715 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2214 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1716 2215
1717 if ($self->{record_replies}) { 2216 if ($self->{record_replies}) {
1718 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2217 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2218
1719 } else { 2219 } else {
2220 my $pl = $self->contr;
2221
2222 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2223 my $dialog = $pl->{npc_dialog};
2224 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2225
2226 } else {
1720 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1721 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1722 } 2230 }
2231}
2232
2233=item $object->send_msg ($channel, $msg, $color, [extra...])
2234
2235=cut
2236
2237sub cf::object::send_msg {
2238 my $pl = shift->contr
2239 or return;
2240 $pl->send_msg (@_);
1723} 2241}
1724 2242
1725=item $player_object->may ("access") 2243=item $player_object->may ("access")
1726 2244
1727Returns wether the given player is authorized to access resource "access" 2245Returns wether the given player is authorized to access resource "access"
1774 $self->deactivate_recursive; 2292 $self->deactivate_recursive;
1775 2293
1776 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2294 return if UNIVERSAL::isa $self->map, "ext::map_link";
1777 2295
1778 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2296 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1779 if $self->map; 2297 if $self->map && $self->map->{path} ne "{link}";
1780 2298
1781 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2299 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1782} 2300}
1783 2301
1784sub cf::object::player::leave_link { 2302sub cf::object::player::leave_link {
1785 my ($self, $map, $x, $y) = @_; 2303 my ($self, $map, $x, $y) = @_;
2304
2305 return unless $self->contr->active;
1786 2306
1787 my $link_pos = delete $self->{_link_pos}; 2307 my $link_pos = delete $self->{_link_pos};
1788 2308
1789 unless ($map) { 2309 unless ($map) {
1790 # restore original map position 2310 # restore original map position
1804 # use -1 or undef as default coordinates, not 0, 0 2324 # use -1 or undef as default coordinates, not 0, 0
1805 ($x, $y) = ($map->enter_x, $map->enter_y) 2325 ($x, $y) = ($map->enter_x, $map->enter_y)
1806 if $x <=0 && $y <= 0; 2326 if $x <=0 && $y <= 0;
1807 2327
1808 $map->load; 2328 $map->load;
1809 $map->load_diag; 2329 $map->load_neighbours;
1810 2330
1811 return unless $self->contr->active; 2331 return unless $self->contr->active;
1812 $self->activate_recursive; 2332 $self->activate_recursive;
2333
2334 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813 $self->enter_map ($map, $x, $y); 2335 $self->enter_map ($map, $x, $y);
1814} 2336}
1815 2337
1816cf::player->attach ( 2338=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1817 on_logout => sub {
1818 my ($pl) = @_;
1819 2339
1820 # abort map switching before logout 2340Moves the player to the given map-path and coordinates by first freezing
1821 if ($pl->ob->{_link_pos}) { 2341her, loading and preparing them map, calling the provided $check callback
1822 cf::sync_job { 2342that has to return the map if sucecssful, and then unfreezes the player on
1823 $pl->ob->leave_link 2343the new (success) or old (failed) map position. In either case, $done will
1824 }; 2344be called at the end of this process.
1825 }
1826 },
1827 on_login => sub {
1828 my ($pl) = @_;
1829 2345
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 2346=cut
2347
2348our $GOTOGEN;
1851 2349
1852sub cf::object::player::goto { 2350sub cf::object::player::goto {
1853 my ($self, $path, $x, $y) = @_; 2351 my ($self, $path, $x, $y, $check, $done) = @_;
2352
2353 # do generation counting so two concurrent goto's will be executed in-order
2354 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1854 2355
1855 $self->enter_link; 2356 $self->enter_link;
1856 2357
1857 (async { 2358 (async {
1858 my $map = eval { 2359 my $map = eval {
1859 my $map = cf::map::find $path; 2360 my $map = cf::map::find $path;
2361
2362 if ($map) {
1860 $map = $map->customise_for ($self) if $map; 2363 $map = $map->customise_for ($self);
2364 $map = $check->($map) if $check && $map;
2365 } else {
2366 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2367 }
2368
1861 $map 2369 $map
2370 };
2371
2372 if ($@) {
2373 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2374 LOG llevError | logBacktrace, Carp::longmess $@;
1862 } or 2375 }
1863 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864 2376
2377 if ($gen == $self->{_goto_generation}) {
2378 delete $self->{_goto_generation};
1865 $self->leave_link ($map, $x, $y); 2379 $self->leave_link ($map, $x, $y);
2380 }
2381
2382 $done->() if $done;
1866 })->prio (1); 2383 })->prio (1);
1867} 2384}
1868 2385
1869=item $player_object->enter_exit ($exit_object) 2386=item $player_object->enter_exit ($exit_object)
1870 2387
1909 2426
1910 $rmp->{random_seed} ||= $exit->random_seed; 2427 $rmp->{random_seed} ||= $exit->random_seed;
1911 2428
1912 my $data = cf::to_json $rmp; 2429 my $data = cf::to_json $rmp;
1913 my $md5 = Digest::MD5::md5_hex $data; 2430 my $md5 = Digest::MD5::md5_hex $data;
1914 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2431 my $meta = "$RANDOMDIR/$md5.meta";
1915 2432
1916 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2433 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917 aio_write $fh, 0, (length $data), $data, 0; 2434 aio_write $fh, 0, (length $data), $data, 0;
1918 undef $fh; 2435 undef $fh;
1919 aio_rename "$meta~", $meta; 2436 aio_rename "$meta~", $meta;
1928 2445
1929 return unless $self->type == cf::PLAYER; 2446 return unless $self->type == cf::PLAYER;
1930 2447
1931 if ($exit->slaying eq "/!") { 2448 if ($exit->slaying eq "/!") {
1932 #TODO: this should de-fi-ni-te-ly not be a sync-job 2449 #TODO: this should de-fi-ni-te-ly not be a sync-job
2450 # the problem is that $exit might not survive long enough
2451 # so it needs to be done right now, right here
1933 cf::sync_job { prepare_random_map $exit }; 2452 cf::sync_job { prepare_random_map $exit };
1934 } 2453 }
1935 2454
1936 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2455 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1937 my $hp = $exit->stats->hp; 2456 my $hp = $exit->stats->hp;
1938 my $sp = $exit->stats->sp; 2457 my $sp = $exit->stats->sp;
1939 2458
1940 $self->enter_link; 2459 $self->enter_link;
2460
2461 # if exit is damned, update players death & WoR home-position
2462 $self->contr->savebed ($slaying, $hp, $sp)
2463 if $exit->flag (FLAG_DAMNED);
1941 2464
1942 (async { 2465 (async {
1943 $self->deactivate_recursive; # just to be sure 2466 $self->deactivate_recursive; # just to be sure
1944 unless (eval { 2467 unless (eval {
1945 $self->goto ($slaying, $hp, $sp); 2468 $self->goto ($slaying, $hp, $sp);
1946 2469
1947 1; 2470 1;
1948 }) { 2471 }) {
1949 $self->message ("Something went wrong deep within the crossfire server. " 2472 $self->message ("Something went wrong deep within the crossfire server. "
1950 . "I'll try to bring you back to the map you were before. " 2473 . "I'll try to bring you back to the map you were before. "
1951 . "Please report this to the dungeon master!", 2474 . "Please report this to the dungeon master!",
1952 cf::NDI_UNIQUE | cf::NDI_RED); 2475 cf::NDI_UNIQUE | cf::NDI_RED);
1953 2476
1954 warn "ERROR in enter_exit: $@"; 2477 warn "ERROR in enter_exit: $@";
1955 $self->leave_link; 2478 $self->leave_link;
1956 } 2479 }
1957 })->prio (1); 2480 })->prio (1);
1970 2493
1971sub cf::client::send_drawinfo { 2494sub cf::client::send_drawinfo {
1972 my ($self, $text, $flags) = @_; 2495 my ($self, $text, $flags) = @_;
1973 2496
1974 utf8::encode $text; 2497 utf8::encode $text;
1975 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2498 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976} 2499}
1977 2500
2501=item $client->send_msg ($channel, $msg, $color, [extra...])
2502
2503Send a drawinfo or msg packet to the client, formatting the msg for the
2504client if neccessary. C<$type> should be a string identifying the type of
2505the message, with C<log> being the default. If C<$color> is negative, suppress
2506the message unless the client supports the msg packet.
2507
2508=cut
2509
2510our %CHANNEL = (
2511 "c/identify" => {
2512 id => "identify",
2513 title => "Identify",
2514 reply => undef,
2515 tooltip => "Items recently identified",
2516 },
2517 "c/examine" => {
2518 id => "examine",
2519 title => "Examine",
2520 reply => undef,
2521 tooltip => "Signs and other items you examined",
2522 },
2523);
2524
2525sub cf::client::send_msg {
2526 my ($self, $channel, $msg, $color, @extra) = @_;
2527
2528 $msg = $self->pl->expand_cfpod ($msg);
2529
2530 $color &= cf::NDI_CLIENT_MASK; # just in case...
2531
2532 # check predefined channels, for the benefit of C
2533 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2534
2535 if (ref $channel) {
2536 # send meta info to client, if not yet sent
2537 unless (exists $self->{channel}{$channel->{id}}) {
2538 $self->{channel}{$channel->{id}} = $channel;
2539 $self->ext_msg (channel_info => $channel)
2540 if $self->can_msg;
2541 }
2542
2543 $channel = $channel->{id};
2544 }
2545
2546 return unless @extra || length $msg;
2547
2548 if ($self->can_msg) {
2549 # default colour, mask it out
2550 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2551 if $color & cf::NDI_DEF;
2552
2553 $self->send_packet ("msg " . $self->{json_coder}->encode (
2554 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2555 } else {
2556 if ($color >= 0) {
2557 # replace some tags by gcfclient-compatible ones
2558 for ($msg) {
2559 1 while
2560 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2561 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2562 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2563 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2564 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2565 }
2566
2567 $color &= cf::NDI_COLOR_MASK;
2568
2569 utf8::encode $msg;
2570
2571 if (0 && $msg =~ /\[/) {
2572 # COMMAND/INFO
2573 $self->send_packet ("drawextinfo $color 10 8 $msg")
2574 } else {
2575 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2576 $self->send_packet ("drawinfo $color $msg")
2577 }
2578 }
2579 }
2580}
2581
2582=item $client->ext_msg ($type, @msg)
2583
2584Sends an ext event to the client.
2585
2586=cut
2587
2588sub cf::client::ext_msg($$@) {
2589 my ($self, $type, @msg) = @_;
2590
2591 if ($self->extcmd == 2) {
2592 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2593 } elsif ($self->extcmd == 1) { # TODO: remove
2594 push @msg, msgtype => "event_$type";
2595 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2596 }
2597}
2598
2599=item $client->ext_reply ($msgid, @msg)
2600
2601Sends an ext reply to the client.
2602
2603=cut
2604
2605sub cf::client::ext_reply($$@) {
2606 my ($self, $id, @msg) = @_;
2607
2608 if ($self->extcmd == 2) {
2609 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2610 } elsif ($self->extcmd == 1) {
2611 #TODO: version 1, remove
2612 unshift @msg, msgtype => "reply", msgid => $id;
2613 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2614 }
2615}
1978 2616
1979=item $success = $client->query ($flags, "text", \&cb) 2617=item $success = $client->query ($flags, "text", \&cb)
1980 2618
1981Queues a query to the client, calling the given callback with 2619Queues a query to the client, calling the given callback with
1982the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2620the 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>. 2621C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1984 2622
1985Queries can fail, so check the return code. Or don't, as queries will become 2623Queries can fail, so check the return code. Or don't, as queries will
1986reliable at some point in the future. 2624become reliable at some point in the future.
1987 2625
1988=cut 2626=cut
1989 2627
1990sub cf::client::query { 2628sub cf::client::query {
1991 my ($self, $flags, $text, $cb) = @_; 2629 my ($self, $flags, $text, $cb) = @_;
1999 utf8::encode $text; 2637 utf8::encode $text;
2000 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2638 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001 2639
2002 $self->send_packet ($self->{query_queue}[0][0]) 2640 $self->send_packet ($self->{query_queue}[0][0])
2003 if @{ $self->{query_queue} } == 1; 2641 if @{ $self->{query_queue} } == 1;
2642
2643 1
2004} 2644}
2005 2645
2006cf::client->attach ( 2646cf::client->attach (
2647 on_connect => sub {
2648 my ($ns) = @_;
2649
2650 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2651 },
2007 on_reply => sub { 2652 on_reply => sub {
2008 my ($ns, $msg) = @_; 2653 my ($ns, $msg) = @_;
2009 2654
2010 # this weird shuffling is so that direct followup queries 2655 # this weird shuffling is so that direct followup queries
2011 # get handled first 2656 # get handled first
2023 } else { 2668 } else {
2024 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2669 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025 } 2670 }
2026 } 2671 }
2027 }, 2672 },
2673 on_exticmd => sub {
2674 my ($ns, $buf) = @_;
2675
2676 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2677
2678 if (ref $msg) {
2679 my ($type, $reply, @payload) =
2680 "ARRAY" eq ref $msg
2681 ? @$msg
2682 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2683
2684 my @reply;
2685
2686 if (my $cb = $EXTICMD{$type}) {
2687 @reply = $cb->($ns, @payload);
2688 }
2689
2690 $ns->ext_reply ($reply, @reply)
2691 if $reply;
2692
2693 } else {
2694 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2695 }
2696
2697 cf::override;
2698 },
2028); 2699);
2029 2700
2030=item $client->async (\&cb) 2701=item $client->async (\&cb)
2031 2702
2032Create a new coroutine, running the specified callback. The coroutine will 2703Create a new coroutine, running the specified callback. The coroutine will
2073our $safe = new Safe "safe"; 2744our $safe = new Safe "safe";
2074our $safe_hole = new Safe::Hole; 2745our $safe_hole = new Safe::Hole;
2075 2746
2076$SIG{FPE} = 'IGNORE'; 2747$SIG{FPE} = 'IGNORE';
2077 2748
2078$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2749$safe->permit_only (Opcode::opset qw(
2750 :base_core :base_mem :base_orig :base_math
2751 grepstart grepwhile mapstart mapwhile
2752 sort time
2753));
2079 2754
2080# here we export the classes and methods available to script code 2755# here we export the classes and methods available to script code
2081 2756
2082=pod 2757=pod
2083 2758
2084The following fucntions and emthods are available within a safe environment: 2759The following functions and methods are available within a safe environment:
2085 2760
2086 cf::object contr pay_amount pay_player map 2761 cf::object
2762 contr pay_amount pay_player map x y force_find force_add
2763 insert remove name archname title slaying race decrease_ob_nr
2764
2087 cf::object::player player 2765 cf::object::player
2088 cf::player peaceful 2766 player
2089 cf::map trigger 2767
2768 cf::player
2769 peaceful
2770
2771 cf::map
2772 trigger
2090 2773
2091=cut 2774=cut
2092 2775
2093for ( 2776for (
2094 ["cf::object" => qw(contr pay_amount pay_player map)], 2777 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2778 insert remove inv name archname title slaying race
2779 decrease_ob_nr)],
2095 ["cf::object::player" => qw(player)], 2780 ["cf::object::player" => qw(player)],
2096 ["cf::player" => qw(peaceful)], 2781 ["cf::player" => qw(peaceful)],
2097 ["cf::map" => qw(trigger)], 2782 ["cf::map" => qw(trigger)],
2098) { 2783) {
2099 no strict 'refs'; 2784 no strict 'refs';
2170=back 2855=back
2171 2856
2172=cut 2857=cut
2173 2858
2174############################################################################# 2859#############################################################################
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 2860# the server's init and main functions
2284 2861
2285sub load_resources { 2862sub load_facedata($) {
2286 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2863 my ($path) = @_;
2864
2865 # HACK to clear player env face cache, we need some signal framework
2866 # for this (global event?)
2867 %ext::player_env::MUSIC_FACE_CACHE = ();
2868
2869 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2870
2871 warn "loading facedata from $path\n";
2872
2873 my $facedata;
2874 0 < aio_load $path, $facedata
2875 or die "$path: $!";
2876
2877 $facedata = Coro::Storable::thaw $facedata;
2878
2879 $facedata->{version} == 2
2880 or cf::cleanup "$path: version mismatch, cannot proceed.";
2881
2882 # patch in the exptable
2883 $facedata->{resource}{"res/exp_table"} = {
2884 type => FT_RSRC,
2885 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2886 };
2887 cf::cede_to_tick;
2888
2889 {
2890 my $faces = $facedata->{faceinfo};
2891
2892 while (my ($face, $info) = each %$faces) {
2893 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2894 cf::face::set_visibility $idx, $info->{visibility};
2895 cf::face::set_magicmap $idx, $info->{magicmap};
2896 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2897 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2898
2899 cf::cede_to_tick;
2900 }
2901
2902 while (my ($face, $info) = each %$faces) {
2903 next unless $info->{smooth};
2904 my $idx = cf::face::find $face
2905 or next;
2906 if (my $smooth = cf::face::find $info->{smooth}) {
2907 cf::face::set_smooth $idx, $smooth;
2908 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2909 } else {
2910 warn "smooth face '$info->{smooth}' not found for face '$face'";
2911 }
2912
2913 cf::cede_to_tick;
2914 }
2915 }
2916
2917 {
2918 my $anims = $facedata->{animinfo};
2919
2920 while (my ($anim, $info) = each %$anims) {
2921 cf::anim::set $anim, $info->{frames}, $info->{facings};
2922 cf::cede_to_tick;
2923 }
2924
2925 cf::anim::invalidate_all; # d'oh
2926 }
2927
2928 {
2929 # TODO: for gcfclient pleasure, we should give resources
2930 # that gcfclient doesn't grok a >10000 face index.
2931 my $res = $facedata->{resource};
2932
2933 my $soundconf = delete $res->{"res/sound.conf"};
2934
2935 while (my ($name, $info) = each %$res) {
2936 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2937 my $data;
2938
2939 if ($info->{type} & 1) {
2940 # prepend meta info
2941
2942 my $meta = $enc->encode ({
2943 name => $name,
2944 %{ $info->{meta} || {} },
2945 });
2946
2947 $data = pack "(w/a*)*", $meta, $info->{data};
2948 } else {
2949 $data = $info->{data};
2950 }
2951
2952 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2953 cf::face::set_type $idx, $info->{type};
2954
2955 cf::cede_to_tick;
2956 }
2957
2958 if ($soundconf) {
2959 $soundconf = $enc->decode (delete $soundconf->{data});
2960
2961 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2962 my $sound = $soundconf->{compat}[$_]
2963 or next;
2964
2965 my $face = cf::face::find "sound/$sound->[1]";
2966 cf::sound::set $sound->[0] => $face;
2967 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2968 }
2969
2970 while (my ($k, $v) = each %{$soundconf->{event}}) {
2971 my $face = cf::face::find "sound/$v";
2972 cf::sound::set $k => $face;
2973 }
2974 }
2975 }
2976
2977 1
2978}
2979
2980register_exticmd fx_want => sub {
2981 my ($ns, $want) = @_;
2982
2983 while (my ($k, $v) = each %$want) {
2984 $ns->fx_want ($k, $v);
2985 }
2986};
2987
2988sub reload_regions {
2989 # HACK to clear player env face cache, we need some signal framework
2990 # for this (global event?)
2991 %ext::player_env::MUSIC_FACE_CACHE = ();
2992
2993 load_resource_file "$MAPDIR/regions"
2287 or die "unable to load regions file\n";#d# 2994 or die "unable to load regions file\n";
2288}
2289 2995
2290sub cfg_load { 2996 for (cf::region::list) {
2997 $_->{match} = qr/$_->{match}/
2998 if exists $_->{match};
2999 }
3000}
3001
3002sub reload_facedata {
3003 load_facedata "$DATADIR/facedata"
3004 or die "unable to load facedata\n";
3005}
3006
3007sub reload_archetypes {
3008 load_resource_file "$DATADIR/archetypes"
3009 or die "unable to load archetypes\n";
3010 #d# NEED to laod twice to resolve forward references
3011 # this really needs to be done in an extra post-pass
3012 # (which needs to be synchronous, so solve it differently)
3013 load_resource_file "$DATADIR/archetypes"
3014 or die "unable to load archetypes\n";
3015}
3016
3017sub reload_treasures {
3018 load_resource_file "$DATADIR/treasures"
3019 or die "unable to load treasurelists\n";
3020}
3021
3022sub reload_resources {
3023 warn "reloading resource files...\n";
3024
3025 reload_regions;
3026 reload_facedata;
3027 #reload_archetypes;#d#
3028 reload_archetypes;
3029 reload_treasures;
3030
3031 warn "finished reloading resource files\n";
3032}
3033
3034sub init {
3035 reload_resources;
3036}
3037
3038sub reload_config {
2291 open my $fh, "<:utf8", cf::confdir . "/config" 3039 open my $fh, "<:utf8", "$CONFDIR/config"
2292 or return; 3040 or return;
2293 3041
2294 local $/; 3042 local $/;
2295 *CFG = YAML::Syck::Load <$fh>; 3043 *CFG = YAML::Syck::Load <$fh>;
2296 3044
2304 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3052 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2305 and die "WARNING: m(un)lockall failed: $!\n"; 3053 and die "WARNING: m(un)lockall failed: $!\n";
2306 }; 3054 };
2307 warn $@ if $@; 3055 warn $@ if $@;
2308 } 3056 }
2309}
2310
2311sub init {
2312 load_resources;
2313} 3057}
2314 3058
2315sub main { 3059sub main {
2316 # we must not ever block the main coroutine 3060 # we must not ever block the main coroutine
2317 local $Coro::idle = sub { 3061 local $Coro::idle = sub {
2319 (async { 3063 (async {
2320 Event::one_event; 3064 Event::one_event;
2321 })->prio (Coro::PRIO_MAX); 3065 })->prio (Coro::PRIO_MAX);
2322 }; 3066 };
2323 3067
2324 cfg_load; 3068 reload_config;
2325 db_load; 3069 db_init;
2326 load_extensions; 3070 load_extensions;
2327 3071
2328 $TICK_WATCHER->start; 3072 $TICK_WATCHER->start;
2329 Event::loop; 3073 Event::loop;
2330} 3074}
2345 }, 3089 },
2346 ); 3090 );
2347 } 3091 }
2348} 3092}
2349 3093
3094sub write_runtime {
3095 my $runtime = "$LOCALDIR/runtime";
3096
3097 # first touch the runtime file to show we are still running:
3098 # the fsync below can take a very very long time.
3099
3100 IO::AIO::aio_utime $runtime, undef, undef;
3101
3102 my $guard = cf::lock_acquire "write_runtime";
3103
3104 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3105 or return;
3106
3107 my $value = $cf::RUNTIME + 90 + 10;
3108 # 10 is the runtime save interval, for a monotonic clock
3109 # 60 allows for the watchdog to kill the server.
3110
3111 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3112 and return;
3113
3114 # always fsync - this file is important
3115 aio_fsync $fh
3116 and return;
3117
3118 # touch it again to show we are up-to-date
3119 aio_utime $fh, undef, undef;
3120
3121 close $fh
3122 or return;
3123
3124 aio_rename "$runtime~", $runtime
3125 and return;
3126
3127 warn "runtime file written.\n";
3128
3129 1
3130}
3131
2350sub emergency_save() { 3132sub emergency_save() {
2351 my $freeze_guard = cf::freeze_mainloop; 3133 my $freeze_guard = cf::freeze_mainloop;
2352 3134
2353 warn "enter emergency perl save\n"; 3135 warn "enter emergency perl save\n";
2354 3136
2369 my $map = $cf::MAP{$path} or next; 3151 my $map = $cf::MAP{$path} or next;
2370 $map->valid or next; 3152 $map->valid or next;
2371 $map->save; 3153 $map->save;
2372 } 3154 }
2373 warn "end emergency map save\n"; 3155 warn "end emergency map save\n";
3156
3157 warn "begin emergency database checkpoint\n";
3158 BDB::db_env_txn_checkpoint $DB_ENV;
3159 warn "end emergency database checkpoint\n";
2374 }; 3160 };
2375 3161
2376 warn "leave emergency perl save\n"; 3162 warn "leave emergency perl save\n";
2377} 3163}
2378 3164
3165sub post_cleanup {
3166 my ($make_core) = @_;
3167
3168 warn Carp::longmess "post_cleanup backtrace"
3169 if $make_core;
3170}
3171
2379sub reload() { 3172sub do_reload_perl() {
2380 # can/must only be called in main 3173 # can/must only be called in main
2381 if ($Coro::current != $Coro::main) { 3174 if ($Coro::current != $Coro::main) {
2382 warn "can only reload from main coroutine"; 3175 warn "can only reload from main coroutine";
2383 return; 3176 return;
2384 } 3177 }
2385 3178
2386 warn "reloading..."; 3179 warn "reloading...";
2387 3180
2388 warn "cancelling server ticker"; 3181 warn "entering sync_job";
2389 $TICK_WATCHER->cancel;
2390 3182
3183 cf::sync_job {
3184 cf::write_runtime; # external watchdog should not bark
2391 cf::emergency_save; 3185 cf::emergency_save;
3186 cf::write_runtime; # external watchdog should not bark
2392 3187
2393 eval { 3188 warn "syncing database to disk";
3189 BDB::db_env_txn_checkpoint $DB_ENV;
3190
2394 # if anything goes wrong in here, we should simply crash as we already saved 3191 # 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 3192
2399 warn "cancelling all WF_AUTOCANCEL watchers"; 3193 warn "cancelling all WF_AUTOCANCEL watchers";
2400 for (Event::all_watchers) { 3194 for (Event::all_watchers) {
2401 $_->cancel if $_->data & WF_AUTOCANCEL; 3195 $_->cancel if $_->data & WF_AUTOCANCEL;
2402 } 3196 }
2403 3197
2404 warn "flushing outstanding aio requests"; 3198 warn "flushing outstanding aio requests";
2405 for (;;) { 3199 for (;;) {
3200 BDB::flush;
2406 IO::AIO::flush; 3201 IO::AIO::flush;
2407 Coro::cede; 3202 Coro::cede;
2408 last unless IO::AIO::nreqs; 3203 last unless IO::AIO::nreqs || BDB::nreqs;
2409 warn "iterate..."; 3204 warn "iterate...";
2410 } 3205 }
3206
3207 ++$RELOAD;
2411 3208
2412 warn "cancelling all extension coros"; 3209 warn "cancelling all extension coros";
2413 $_->cancel for values %EXT_CORO; 3210 $_->cancel for values %EXT_CORO;
2414 %EXT_CORO = (); 3211 %EXT_CORO = ();
2415 3212
2416 warn "removing commands"; 3213 warn "removing commands";
2417 %COMMAND = (); 3214 %COMMAND = ();
2418 3215
2419 warn "removing ext commands"; 3216 warn "removing ext/exti commands";
2420 %EXTCMD = (); 3217 %EXTCMD = ();
3218 %EXTICMD = ();
2421 3219
2422 warn "unloading/nuking all extensions"; 3220 warn "unloading/nuking all extensions";
2423 for my $pkg (@EXTS) { 3221 for my $pkg (@EXTS) {
2424 warn "... unloading $pkg"; 3222 warn "... unloading $pkg";
2425 3223
2455 Symbol::delete_package "safe::$_" 3253 Symbol::delete_package "safe::$_"
2456 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3254 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2457 3255
2458 warn "unloading cf.pm \"a bit\""; 3256 warn "unloading cf.pm \"a bit\"";
2459 delete $INC{"cf.pm"}; 3257 delete $INC{"cf.pm"};
3258 delete $INC{"cf/pod.pm"};
2460 3259
2461 # don't, removes xs symbols, too, 3260 # don't, removes xs symbols, too,
2462 # and global variables created in xs 3261 # and global variables created in xs
2463 #Symbol::delete_package __PACKAGE__; 3262 #Symbol::delete_package __PACKAGE__;
2464 3263
2467 warn "reloading cf.pm"; 3266 warn "reloading cf.pm";
2468 require cf; 3267 require cf;
2469 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3268 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2470 3269
2471 warn "loading config and database again"; 3270 warn "loading config and database again";
2472 cf::cfg_load; 3271 cf::reload_config;
2473 cf::db_load;
2474 3272
2475 warn "loading extensions"; 3273 warn "loading extensions";
2476 cf::load_extensions; 3274 cf::load_extensions;
2477 3275
2478 warn "reattaching attachments to objects/players"; 3276 warn "reattaching attachments to objects/players";
2479 _global_reattach; 3277 _global_reattach; # objects, sockets
2480 warn "reattaching attachments to maps"; 3278 warn "reattaching attachments to maps";
2481 reattach $_ for values %MAP; 3279 reattach $_ for values %MAP;
3280 warn "reattaching attachments to players";
3281 reattach $_ for values %PLAYER;
2482 3282
2483 warn "loading reloadable resources"; 3283 warn "leaving sync_job";
2484 load_resources;
2485 3284
2486 warn "restarting server ticker"; 3285 1
2487 3286 } or do {
2488 $TICK_WATCHER->start;
2489 };
2490
2491 if ($@) {
2492 warn $@; 3287 warn $@;
2493 warn "error while reloading, exiting."; 3288 warn "error while reloading, exiting.";
2494 exit 1; 3289 exit 1;
2495 } 3290 };
2496 3291
2497 warn "reloaded"; 3292 warn "reloaded";
2498}; 3293};
2499 3294
2500our $RELOAD_WATCHER; # used only during reload 3295our $RELOAD_WATCHER; # used only during reload
2501 3296
3297sub reload_perl() {
3298 # doing reload synchronously and two reloads happen back-to-back,
3299 # coro crashes during coro_state_free->destroy here.
3300
3301 $RELOAD_WATCHER ||= Event->timer (
3302 reentrant => 0,
3303 after => 0,
3304 data => WF_AUTOCANCEL,
3305 cb => sub {
3306 do_reload_perl;
3307 undef $RELOAD_WATCHER;
3308 },
3309 );
3310}
3311
2502register_command "reload" => sub { 3312register_command "reload" => sub {
2503 my ($who, $arg) = @_; 3313 my ($who, $arg) = @_;
2504 3314
2505 if ($who->flag (FLAG_WIZ)) { 3315 if ($who->flag (FLAG_WIZ)) {
2506 $who->message ("reloading server."); 3316 $who->message ("reloading server.");
2507 3317 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 } 3318 }
2521}; 3319};
2522 3320
2523unshift @INC, $LIBDIR; 3321unshift @INC, $LIBDIR;
2524 3322
2525my $bug_warning = 0; 3323my $bug_warning = 0;
2526 3324
3325our @WAIT_FOR_TICK;
3326our @WAIT_FOR_TICK_BEGIN;
3327
3328sub wait_for_tick {
3329 return unless $TICK_WATCHER->is_active;
3330 return if $Coro::current == $Coro::main;
3331
3332 my $signal = new Coro::Signal;
3333 push @WAIT_FOR_TICK, $signal;
3334 $signal->wait;
3335}
3336
3337sub wait_for_tick_begin {
3338 return unless $TICK_WATCHER->is_active;
3339 return if $Coro::current == $Coro::main;
3340
3341 my $signal = new Coro::Signal;
3342 push @WAIT_FOR_TICK_BEGIN, $signal;
3343 $signal->wait;
3344}
3345
3346 my $min = 1e6;#d#
3347 my $avg = 10;
2527$TICK_WATCHER = Event->timer ( 3348$TICK_WATCHER = Event->timer (
2528 reentrant => 0, 3349 reentrant => 0,
2529 parked => 1, 3350 parked => 1,
2530 prio => 0, 3351 prio => 0,
2531 at => $NEXT_TICK || $TICK, 3352 at => $NEXT_TICK || $TICK,
2535 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3356 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2536 unless ++$bug_warning > 10; 3357 unless ++$bug_warning > 10;
2537 return; 3358 return;
2538 } 3359 }
2539 3360
2540 $NOW = Event::time; 3361 $NOW = $tick_start = Event::time;
2541 3362
2542 cf::server_tick; # one server iteration 3363 cf::server_tick; # one server iteration
3364
3365 0 && sync_job {#d#
3366 for(1..10) {
3367 my $t = Event::time;
3368 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3369 or die;
3370
3371 $map->width (50);
3372 $map->height (50);
3373 $map->alloc;
3374 $map->_load_objects ("/tmp/x.map", 1);
3375 my $t = Event::time - $t;
3376
3377 #next unless $t < 0.0013;#d#
3378 if ($t < $min) {
3379 $min = $t;
3380 }
3381 $avg = $avg * 0.99 + $t * 0.01;
3382 }
3383 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3384 exit 0;
3385 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3386 };
3387
2543 $RUNTIME += $TICK; 3388 $RUNTIME += $TICK;
2544 $NEXT_TICK += $TICK; 3389 $NEXT_TICK += $TICK;
2545 3390
2546 $WAIT_FOR_TICK->broadcast; 3391 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2547 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3392 $NEXT_RUNTIME_WRITE = $NOW + 10;
2548 3393 Coro::async_pool {
2549 Event::sweep; 3394 write_runtime
2550 Coro::cede_notself; 3395 or warn "ERROR: unable to write runtime file: $!";
3396 };
2551 3397 }
3398
2552# my $AFTER = Event::time; 3399# my $AFTER = Event::time;
2553# warn $AFTER - $NOW;#d# 3400# warn $AFTER - $NOW;#d#
2554 3401
3402 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3403 $sig->send;
3404 }
3405 while (my $sig = shift @WAIT_FOR_TICK) {
3406 $sig->send;
3407 }
3408
3409 $NOW = Event::time;
3410
2555 # if we are delayed by four ticks or more, skip them all 3411 # if we are delayed by four ticks or more, skip them all
2556 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3412 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2557 3413
2558 $TICK_WATCHER->at ($NEXT_TICK); 3414 $TICK_WATCHER->at ($NEXT_TICK);
2559 $TICK_WATCHER->start; 3415 $TICK_WATCHER->start;
3416
3417 $LOAD = ($NOW - $tick_start) / $TICK;
3418 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3419
3420 _post_tick;
3421
3422
2560 }, 3423 },
2561); 3424);
2562 3425
2563{ 3426{
2564 BDB::max_poll_time $TICK * 0.1; 3427 BDB::max_poll_time $TICK * 0.1;
2589 3452
2590 unless ($DB_ENV) { 3453 unless ($DB_ENV) {
2591 $DB_ENV = BDB::db_env_create; 3454 $DB_ENV = BDB::db_env_create;
2592 3455
2593 cf::sync_job { 3456 cf::sync_job {
3457 eval {
2594 BDB::db_env_open 3458 BDB::db_env_open
2595 $DB_ENV, 3459 $DB_ENV,
2596 $BDB_ENV_DIR, 3460 $BDBDIR,
2597 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3461 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2598 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3462 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2599 0666; 3463 0666;
2600 3464
2601 cf::cleanup "$!" if $!; 3465 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2602 3466
2603 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3467 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2604 $DB_ENV->set_lk_detect; 3468 $DB_ENV->set_lk_detect;
3469 };
3470
3471 cf::cleanup "db_env_open(db): $@" if $@;
2605 }; 3472 };
2606 } 3473 }
2607} 3474}
2608 3475
2609{ 3476{
2611 3478
2612 undef $Coro::AIO::WATCHER; 3479 undef $Coro::AIO::WATCHER;
2613 IO::AIO::max_poll_time $TICK * 0.1; 3480 IO::AIO::max_poll_time $TICK * 0.1;
2614 $AIO_POLL_WATCHER = Event->io ( 3481 $AIO_POLL_WATCHER = Event->io (
2615 reentrant => 0, 3482 reentrant => 0,
3483 data => WF_AUTOCANCEL,
2616 fd => IO::AIO::poll_fileno, 3484 fd => IO::AIO::poll_fileno,
2617 poll => 'r', 3485 poll => 'r',
2618 prio => 6, 3486 prio => 6,
2619 data => WF_AUTOCANCEL,
2620 cb => \&IO::AIO::poll_cb, 3487 cb => \&IO::AIO::poll_cb,
2621 ); 3488 );
2622} 3489}
2623 3490
2624$WRITE_RUNTIME_WATCHER = Event->timer ( 3491my $_log_backtrace;
2625 reentrant => 0, 3492
2626 data => WF_AUTOCANCEL, 3493sub _log_backtrace {
2627 after => 1, 3494 my ($msg, @addr) = @_;
2628 interval => 10, 3495
2629 prio => 6, # keep it lowest so it acts like a watchdog 3496 $msg =~ s/\n//;
2630 cb => Coro::unblock_sub { 3497
2631 write_runtime 3498 # limit the # of concurrent backtraces
2632 or warn "ERROR: unable to write runtime file: $!"; 3499 if ($_log_backtrace < 2) {
3500 ++$_log_backtrace;
3501 async {
3502 my @bt = fork_call {
3503 @addr = map { sprintf "%x", $_ } @addr;
3504 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3505 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3506 or die "addr2line: $!";
3507
3508 my @funcs;
3509 my @res = <$fh>;
3510 chomp for @res;
3511 while (@res) {
3512 my ($func, $line) = splice @res, 0, 2, ();
3513 push @funcs, "[$func] $line";
3514 }
3515
3516 @funcs
3517 };
3518
3519 LOG llevInfo, "[ABT] $msg\n";
3520 LOG llevInfo, "[ABT] $_\n" for @bt;
3521 --$_log_backtrace;
3522 };
3523 } else {
3524 LOG llevInfo, "[ABT] $msg\n";
3525 LOG llevInfo, "[ABT] [suppressed]\n";
2633 }, 3526 }
2634); 3527}
3528
3529# load additional modules
3530use cf::pod;
2635 3531
2636END { cf::emergency_save } 3532END { cf::emergency_save }
2637 3533
26381 35341
2639 3535

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines