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.195 by root, Fri Jan 26 20:59:57 2007 UTC vs.
Revision 1.352 by root, Sun Sep 2 04:57:14 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 ();
27use BDB ();
20use Data::Dumper; 28use Data::Dumper;
21use Digest::MD5; 29use Digest::MD5;
22use Fcntl; 30use Fcntl;
31use YAML::Syck ();
23use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
24use YAML::Syck ();
25use Time::HiRes; 33use Time::HiRes;
34use Compress::LZF;
35use Digest::MD5 ();
26 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
27use 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
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30 44
31# 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?
32$YAML::Syck::ImplicitUnicode = 1; 46$YAML::Syck::ImplicitUnicode = 1;
33 47
34$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
35 49
50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
51
36our %COMMAND = (); 52our %COMMAND = ();
37our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
38 54
39our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
40our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
43 60
61our $RELOAD; # number of reloads so far
44our @EVENT; 62our @EVENT;
45our $LIBDIR = datadir . "/ext";
46 63
47our $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(!)
48our $TICK_WATCHER; 77our $TICK_WATCHER;
49our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER; 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51our $NEXT_TICK; 80our $NEXT_TICK;
52our $NOW; 81our $NOW;
82our $USE_FSYNC = 1; # use fsync to write maps - default off
83
84our $BDB_POLL_WATCHER;
85our $DB_ENV;
53 86
54our %CFG; 87our %CFG;
55 88
56our $UPTIME; $UPTIME ||= time; 89our $UPTIME; $UPTIME ||= time;
57our $RUNTIME; 90our $RUNTIME;
58 91
59our %PLAYER; # all users 92our %PLAYER; # all users
60our %MAP; # all maps 93our %MAP; # all maps
61our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
62our $RANDOM_MAPS = cf::localdir . "/random";
63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66 95
67# 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 ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69 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
70binmode STDOUT; 103binmode STDOUT;
71binmode STDERR; 104binmode STDERR;
72 105
73# read virtual server time, if available 106# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
76 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
77 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
78} 111}
79 112
80mkdir cf::localdir; 113mkdir $_
81mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82mkdir cf::localdir . "/" . cf::tmpdir;
83mkdir cf::localdir . "/" . cf::uniquedir;
84mkdir $RANDOM_MAPS;
85 115
86our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
117
118sub cf::map::normalise;
87 119
88############################################################################# 120#############################################################################
89 121
90=head2 GLOBAL VARIABLES 122=head2 GLOBAL VARIABLES
91 123
98=item $cf::RUNTIME 130=item $cf::RUNTIME
99 131
100The 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
101every server tick. 133every server tick.
102 134
103=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
104 138
105The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
106be 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.
107 143
108=item $cf::NOW 144=item $cf::NOW
109 145
110The time of the last (current) server tick. 146The time of the last (current) server tick.
111 147
112=item $cf::TICK 148=item $cf::TICK
113 149
114The 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.
115 161
116=item %cf::CFG 162=item %cf::CFG
117 163
118Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
119from wherever your confdir points to. 165from wherever your confdir points to.
120 166
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 167=item cf::wait_for_tick, cf::wait_for_tick_begin
122 168
123These 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
124or 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
125processing 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.
126window 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.
127 178
128=back 179=back
129 180
130=cut 181=cut
131 182
132BEGIN { 183BEGIN {
133 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
134 my $msg = join "", @_; 185 my $msg = join "", @_;
135 utf8::encode $msg;
136 186
137 $msg .= "\n" 187 $msg .= "\n"
138 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
139 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
140 LOG llevError, $msg; 193 LOG llevError, $msg;
141 }; 194 };
142} 195}
143 196
144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148@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';
149@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)
150 204
151# 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
152# within the Safe compartment. 206# within the Safe compartment.
153for my $pkg (qw( 207for my $pkg (qw(
154 cf::global cf::attachable 208 cf::global cf::attachable
162} 216}
163 217
164$Event::DIED = sub { 218$Event::DIED = sub {
165 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
166}; 220};
221
222#############################################################################
167 223
168=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
169 225
170=over 4 226=over 4
171 227
190 $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;
191 $d 247 $d
192 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
193} 249}
194 250
195use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
198 252
199Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
200 254
201=cut
202
203sub from_json($) {
204 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205 JSON::Syck::Load $_[0]
206}
207
208=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
209 256
210Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
211 258
212=cut 259=cut
213 260
214sub to_json($) { 261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 262
216 JSON::Syck::Dump $_[0] 263sub to_json ($) { $json_coder->encode ($_[0]) }
217} 264sub from_json ($) { $json_coder->decode ($_[0]) }
218 265
219=item cf::lock_wait $string 266=item cf::lock_wait $string
220 267
221Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
222 269
225Wait 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
226a 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,
227for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
228returned. 275returned.
229 276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
279
230Lock 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
231uses 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.
232 286
233=cut 287=cut
234 288
235our %LOCK; 289our %LOCK;
236 290
256 # wake up all waiters, to be on the safe side 310 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} }; 311 $_->ready for @{ delete $LOCK{$key} };
258 } 312 }
259} 313}
260 314
315sub lock_active($) {
316 my ($key) = @_;
317
318 ! ! $LOCK{$key}
319}
320
261sub freeze_mainloop { 321sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active; 322 return unless $TICK_WATCHER->is_active;
263 323
264 my $guard = Coro::guard { 324 my $guard = Coro::guard {
265 $TICK_WATCHER->start; 325 $TICK_WATCHER->start;
266 $WRITE_RUNTIME_WATCHER->start;
267 }; 326 };
268 $WRITE_RUNTIME_WATCHER->stop;
269 $TICK_WATCHER->stop; 327 $TICK_WATCHER->stop;
270 $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;
271} 385}
272 386
273=item cf::async { BLOCK } 387=item cf::async { BLOCK }
274 388
275Currently the same as Coro::async_pool, meaning you cannot use 389Currently the same as Coro::async_pool, meaning you cannot use
280 394
281BEGIN { *async = \&Coro::async_pool } 395BEGIN { *async = \&Coro::async_pool }
282 396
283=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
284 398
285The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 400is always able to handle events or runnable, as Crossfire TRT is only
287reentrant. 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.
288 403
289If 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
290the given BLOCK in another coroutine while waiting for the result. The 405the given BLOCK in another coroutine while waiting for the result. The
291server 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
292fast or be very important. 407fast or be very important.
295 410
296sub sync_job(&) { 411sub sync_job(&) {
297 my ($job) = @_; 412 my ($job) = @_;
298 413
299 if ($Coro::current == $Coro::main) { 414 if ($Coro::current == $Coro::main) {
415 my $time = Event::time;
416
300 # this is the main coro, too bad, we have to block 417 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 418 # till the operation succeeds, freezing the server :/
302 419
303 # TODO: use suspend/resume instead 420 # TODO: use suspend/resume instead
304 # (but this is cancel-safe) 421 # (but this is cancel-safe)
315 432
316 while ($busy) { 433 while ($busy) {
317 Coro::cede or Event::one_event; 434 Coro::cede or Event::one_event;
318 } 435 }
319 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
320 wantarray ? @res : $res[0] 444 wantarray ? @res : $res[0]
321 } else { 445 } else {
322 # we are in another coroutine, how wonderful, everything just works 446 # we are in another coroutine, how wonderful, everything just works
323 447
324 $job->() 448 $job->()
343 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
344 468
345 $coro 469 $coro
346} 470}
347 471
348sub write_runtime { 472=item fork_call { }, $args
349 my $runtime = cf::localdir . "/runtime";
350 473
351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 474Executes the given code block with the given arguments in a seperate
352 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.
353 478
354 my $value = $cf::RUNTIME + 90 + 10; 479=cut
355 # 10 is the runtime save interval, for a monotonic clock
356 # 60 allows for the watchdog to kill the server.
357 480
358 (aio_write $fh, 0, (length $value), $value, 0) <= 0 481sub fork_call(&@) {
359 and return; 482 my ($cb, @args) = @_;
360 483
361 aio_fsync $fh 484 # we seemingly have to make a local copy of the whole thing,
362 and return; 485 # otherwise perl prematurely frees the stuff :/
486 # TODO: investigate and fix (liekly this will be rather laborious)
363 487
364 close $fh 488 my @res = Coro::Util::fork_eval {
365 or return; 489 reset_signals;
490 &$cb
491 }, @args;
366 492
367 aio_rename "$runtime~", $runtime 493 wantarray ? @res : $res[-1]
368 and return; 494}
369 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 };
370 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 });
371} 621}
372 622
373=back 623=back
374 624
375=cut 625=cut
382attach callbacks/event handlers (a collection of which is called an "attachment") 632attach callbacks/event handlers (a collection of which is called an "attachment")
383to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
384 634
385In 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>
386C<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
387crossfire+). 637Crossfire TRT).
388 638
389=over 4 639=over 4
390 640
391=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
392 642
555 $registry = $CB_TYPE[$object_type] ||= []; 805 $registry = $CB_TYPE[$object_type] ||= [];
556 806
557 } elsif ($type eq "subtype") { 807 } elsif ($type eq "subtype") {
558 defined $object_type or Carp::croak "subtype specified without type"; 808 defined $object_type or Carp::croak "subtype specified without type";
559 my $object_subtype = shift @arg; 809 my $object_subtype = shift @arg;
560 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 810 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
561 811
562 } elsif ($type eq "package") { 812 } elsif ($type eq "package") {
563 my $pkg = shift @arg; 813 my $pkg = shift @arg;
564 814
565 while (my ($name, $id) = each %cb_id) { 815 while (my ($name, $id) = each %cb_id) {
594 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
595 } 845 }
596 846
597 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
598 } else { 848 } else {
599 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
600 } 850 }
601 851
602 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
603} 853}
604 854
606 if (ref $_[0]) { 856 if (ref $_[0]) {
607 _object_attach @_; 857 _object_attach @_;
608 } else { 858 } else {
609 _attach shift->_attach_registry, @_; 859 _attach shift->_attach_registry, @_;
610 } 860 }
861 _recalc_want;
611}; 862};
612 863
613# all those should be optimised 864# all those should be optimised
614sub cf::attachable::detach { 865sub cf::attachable::detach {
615 my ($obj, $name) = @_; 866 my ($obj, $name) = @_;
618 delete $obj->{_attachment}{$name}; 869 delete $obj->{_attachment}{$name};
619 reattach ($obj); 870 reattach ($obj);
620 } else { 871 } else {
621 Carp::croak "cannot, currently, detach class attachments"; 872 Carp::croak "cannot, currently, detach class attachments";
622 } 873 }
874 _recalc_want;
623}; 875};
624 876
625sub cf::attachable::attached { 877sub cf::attachable::attached {
626 my ($obj, $name) = @_; 878 my ($obj, $name) = @_;
627 879
642 "; 894 ";
643 die if $@; 895 die if $@;
644} 896}
645 897
646our $override; 898our $override;
647our @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?
648 900
649sub override { 901sub override {
650 $override = 1; 902 $override = 1;
651 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
652} 904}
653 905
654sub do_invoke { 906sub do_invoke {
655 my $event = shift; 907 my $event = shift;
656 my $callbacks = shift; 908 my $callbacks = shift;
657 909
658 @invoke_results = (); 910 @INVOKE_RESULTS = ();
659 911
660 local $override; 912 local $override;
661 913
662 for (@$callbacks) { 914 for (@$callbacks) {
663 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
680 932
681Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
682 934
683This 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
684removed 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
685results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
686 938
687=back 939=back
688 940
689=cut 941=cut
690 942
691############################################################################# 943#############################################################################
692# 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}
693 956
694sub reattach { 957sub reattach {
695 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
696 my ($obj) = @_; 959 my ($obj) = @_;
697 960
750 $filename, length $$rdata, scalar @$objs; 1013 $filename, length $$rdata, scalar @$objs;
751 1014
752 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1015 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
753 chmod SAVE_MODE, $fh; 1016 chmod SAVE_MODE, $fh;
754 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1017 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
755 aio_fsync $fh; 1018 aio_fsync $fh if $cf::USE_FSYNC;
756 close $fh; 1019 close $fh;
757 1020
758 if (@$objs) { 1021 if (@$objs) {
759 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1022 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
760 chmod SAVE_MODE, $fh; 1023 chmod SAVE_MODE, $fh;
761 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1024 my $data = Storable::nfreeze { version => 1, objs => $objs };
762 aio_write $fh, 0, (length $data), $data, 0; 1025 aio_write $fh, 0, (length $data), $data, 0;
763 aio_fsync $fh; 1026 aio_fsync $fh if $cf::USE_FSYNC;
764 close $fh; 1027 close $fh;
765 aio_rename "$filename.pst~", "$filename.pst"; 1028 aio_rename "$filename.pst~", "$filename.pst";
766 } 1029 }
767 } else { 1030 } else {
768 aio_unlink "$filename.pst"; 1031 aio_unlink "$filename.pst";
800 or return; 1063 or return;
801 $av = eval { (Storable::thaw $av)->{objs} }; 1064 $av = eval { (Storable::thaw $av)->{objs} };
802 } 1065 }
803 1066
804 warn sprintf "loading %s (%d)\n", 1067 warn sprintf "loading %s (%d)\n",
805 $filename, length $data, scalar @{$av || []};#d# 1068 $filename, length $data, scalar @{$av || []};
806 return ($data, $av); 1069 return ($data, $av);
807} 1070}
1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
808 1077
809############################################################################# 1078#############################################################################
810# command handling &c 1079# command handling &c
811 1080
812=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
825 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
826} 1095}
827 1096
828=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
829 1098
830Register 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.
831 1104
832If 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
833called. 1106called.
834 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
835=cut 1119=cut
836 1120
837sub register_extcmd { 1121sub register_extcmd {
838 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
839 1123
840 $EXTCMD{$name} = $cb; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
841} 1131}
842 1132
843cf::player->attach ( 1133cf::player->attach (
844 on_command => sub { 1134 on_command => sub {
845 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
854 cf::override; 1144 cf::override;
855 }, 1145 },
856 on_extcmd => sub { 1146 on_extcmd => sub {
857 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
858 1148
859 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
860 1150
861 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
862 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
863 if (my %reply = $cb->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
864 $pl->ext_reply ($msg->{msgid}, %reply);
865 }
866 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
867 } else { 1166 } else {
868 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
869 } 1168 }
870 1169
871 cf::override; 1170 cf::override;
872 }, 1171 },
873); 1172);
874 1173
875sub load_extension {
876 my ($path) = @_;
877
878 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
879 my $base = $1;
880 my $pkg = $1;
881 $pkg =~ s/[^[:word:]]/_/g;
882 $pkg = "ext::$pkg";
883
884 warn "... loading '$path' into '$pkg'\n";
885
886 open my $fh, "<:utf8", $path
887 or die "$path: $!";
888
889 my $source =
890 "package $pkg; use strict; use utf8;\n"
891 . "#line 1 \"$path\"\n{\n"
892 . (do { local $/; <$fh> })
893 . "\n};\n1";
894
895 unless (eval $source) {
896 my $msg = $@ ? "$path: $@\n"
897 : "extension disabled.\n";
898 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
899 warn $@;
900 warn "mandatory extension failed to load, exiting.\n";
901 exit 1;
902 }
903 die $@;
904 }
905
906 push @EXTS, $pkg;
907}
908
909sub load_extensions { 1174sub load_extensions {
1175 cf::sync_job {
1176 my %todo;
1177
910 for my $ext (<$LIBDIR/*.ext>) { 1178 for my $path (<$LIBDIR/*.ext>) {
911 next unless -r $ext; 1179 next unless -r $path;
912 eval { 1180
913 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;
914 1 1238 }
915 } or warn "$ext not loaded: $@"; 1239
1240 skip:
1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1242 unless $progress;
1243 }
916 } 1244 };
917} 1245}
918 1246
919############################################################################# 1247#############################################################################
920 1248
1249=back
1250
921=head2 CORE EXTENSIONS 1251=head2 CORE EXTENSIONS
922 1252
923Functions and methods that extend core crossfire objects. 1253Functions and methods that extend core crossfire objects.
924 1254
925=cut 1255=cut
937Returns the given player object, loading it if necessary (might block). 1267Returns the given player object, loading it if necessary (might block).
938 1268
939=cut 1269=cut
940 1270
941sub playerdir($) { 1271sub playerdir($) {
942 cf::localdir 1272 "$PLAYERDIR/"
943 . "/"
944 . cf::playerdir
945 . "/"
946 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1273 . (ref $_[0] ? $_[0]->ob->name : $_[0])
947} 1274}
948 1275
949sub path($) { 1276sub path($) {
950 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1277 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
951 1278
952 (playerdir $login) . "/$login.pl" 1279 (playerdir $login) . "/playerdata"
953} 1280}
954 1281
955sub find_active($) { 1282sub find_active($) {
956 $cf::PLAYER{$_[0]} 1283 $cf::PLAYER{$_[0]}
957 and $cf::PLAYER{$_[0]}->active 1284 and $cf::PLAYER{$_[0]}->active
970 my $login = $_[0]; 1297 my $login = $_[0];
971 1298
972 my $guard = cf::lock_acquire "user_find:$login"; 1299 my $guard = cf::lock_acquire "user_find:$login";
973 1300
974 $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
975 my $pl = load_pl path $login 1309 my $pl = load_pl path $login
976 or return; 1310 or return;
977 $cf::PLAYER{$login} = $pl 1311 $cf::PLAYER{$login} = $pl
978 } 1312 }
979 } 1313 }
991 1325
992 aio_mkdir playerdir $pl, 0770; 1326 aio_mkdir playerdir $pl, 0770;
993 $pl->{last_save} = $cf::RUNTIME; 1327 $pl->{last_save} = $cf::RUNTIME;
994 1328
995 $pl->save_pl ($path); 1329 $pl->save_pl ($path);
996 Coro::cede; 1330 cf::cede_to_tick;
997} 1331}
998 1332
999sub new($) { 1333sub new($) {
1000 my ($login) = @_; 1334 my ($login) = @_;
1001 1335
1007 $cf::PLAYER{$login} = $self; 1341 $cf::PLAYER{$login} = $self;
1008 1342
1009 $self 1343 $self
1010} 1344}
1011 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
1012=item $pl->quit_character 1356=item $pl->quit_character
1013 1357
1014Nukes the player without looking back. If logged in, the connection will 1358Nukes the player without looking back. If logged in, the connection will
1015be destroyed. May block for a long time. 1359be destroyed. May block for a long time.
1016 1360
1017=cut 1361=cut
1018 1362
1019sub quit_character { 1363sub quit_character {
1020 my ($pl) = @_; 1364 my ($pl) = @_;
1365
1366 my $name = $pl->ob->name;
1021 1367
1022 $pl->{deny_save} = 1; 1368 $pl->{deny_save} = 1;
1023 $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
1024 1370
1025 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1371 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1030 my $path = playerdir $pl; 1376 my $path = playerdir $pl;
1031 my $temp = "$path~$cf::RUNTIME~deleting~"; 1377 my $temp = "$path~$cf::RUNTIME~deleting~";
1032 aio_rename $path, $temp; 1378 aio_rename $path, $temp;
1033 delete $cf::PLAYER{$pl->ob->name}; 1379 delete $cf::PLAYER{$pl->ob->name};
1034 $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
1035 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;
1036} 1402}
1037 1403
1038=item cf::player::list_logins 1404=item cf::player::list_logins
1039 1405
1040Returns 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
1041while and may block, so not sync_job-capable, ever. 1407while and may block, so not sync_job-capable, ever.
1042 1408
1043=cut 1409=cut
1044 1410
1045sub list_logins { 1411sub list_logins {
1046 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1412 my $dirs = aio_readdir $PLAYERDIR
1047 or return []; 1413 or return [];
1048 1414
1049 my @logins; 1415 my @logins;
1050 1416
1051 for my $login (@$dirs) { 1417 for my $login (@$dirs) {
1068=cut 1434=cut
1069 1435
1070sub maps($) { 1436sub maps($) {
1071 my ($pl) = @_; 1437 my ($pl) = @_;
1072 1438
1439 $pl = ref $pl ? $pl->ob->name : $pl;
1440
1073 my $files = aio_readdir playerdir $pl 1441 my $files = aio_readdir playerdir $pl
1074 or return; 1442 or return;
1075 1443
1076 my @paths; 1444 my @paths;
1077 1445
1078 for (@$files) { 1446 for (@$files) {
1079 utf8::decode $_; 1447 utf8::decode $_;
1080 next if /\.(?:pl|pst)$/; 1448 next if /\.(?:pl|pst)$/;
1081 next unless /^$PATH_SEP/o; 1449 next unless /^$PATH_SEP/o;
1082 1450
1083 s/\.map$//; 1451 push @paths, cf::map::normalise "~$pl/$_";
1084 push @paths, "~" . $pl->ob->name . "/" . $_;
1085 } 1452 }
1086 1453
1087 \@paths 1454 \@paths
1088} 1455}
1089 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
1090=item $player->ext_reply ($msgid, $msgtype, %msg) 1508=item $player->ext_reply ($msgid, @msg)
1091 1509
1092Sends an ext reply to the player. 1510Sends an ext reply to the player.
1093 1511
1094=cut 1512=cut
1095 1513
1096sub ext_reply($$$%) { 1514sub ext_reply($$@) {
1097 my ($self, $id, %msg) = @_; 1515 my ($self, $id, @msg) = @_;
1098 1516
1099 $msg{msgid} = $id; 1517 $self->ns->ext_reply ($id, @msg)
1100
1101 $self->send ("ext " . cf::to_json \%msg);
1102} 1518}
1103 1519
1104package 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}
1105 1560
1106=back 1561=back
1107
1108 1562
1109=head3 cf::map 1563=head3 cf::map
1110 1564
1111=over 4 1565=over 4
1112 1566
1167 my ($self, $merge) = @_; 1621 my ($self, $merge) = @_;
1168 1622
1169 # we have to keep some variables in memory intact 1623 # we have to keep some variables in memory intact
1170 local $self->{path}; 1624 local $self->{path};
1171 local $self->{load_path}; 1625 local $self->{load_path};
1172 local $self->{deny_save};
1173 local $self->{deny_reset};
1174 1626
1175 $self->SUPER::thawer_merge ($merge); 1627 $self->SUPER::thawer_merge ($merge);
1176} 1628}
1177 1629
1178sub normalise { 1630sub normalise {
1179 my ($path, $base) = @_; 1631 my ($path, $base) = @_;
1180 1632
1181 $path = "$path"; # make sure its a string 1633 $path = "$path"; # make sure its a string
1634
1635 $path =~ s/\.map$//;
1182 1636
1183 # map plan: 1637 # map plan:
1184 # 1638 #
1185 # /! non-realised random map exit (special hack!) 1639 # /! non-realised random map exit (special hack!)
1186 # {... are special paths that are not being touched 1640 # {... are special paths that are not being touched
1223 $self->init; # pass $1 etc. 1677 $self->init; # pass $1 etc.
1224 return $self; 1678 return $self;
1225 } 1679 }
1226 } 1680 }
1227 1681
1228 Carp::carp "unable to resolve path '$path' (base '$base')."; 1682 Carp::cluck "unable to resolve path '$path' (base '$base').";
1229 () 1683 ()
1230} 1684}
1231 1685
1232sub init { 1686sub init {
1233 my ($self) = @_; 1687 my ($self) = @_;
1248 1702
1249# the original (read-only) location 1703# the original (read-only) location
1250sub load_path { 1704sub load_path {
1251 my ($self) = @_; 1705 my ($self) = @_;
1252 1706
1253 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1707 "$MAPDIR/$self->{path}.map"
1254} 1708}
1255 1709
1256# the temporary/swap location 1710# the temporary/swap location
1257sub save_path { 1711sub save_path {
1258 my ($self) = @_; 1712 my ($self) = @_;
1259 1713
1260 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1714 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1261 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1715 "$TMPDIR/$path.map"
1262} 1716}
1263 1717
1264# the unique path, undef == no special unique path 1718# the unique path, undef == no special unique path
1265sub uniq_path { 1719sub uniq_path {
1266 my ($self) = @_; 1720 my ($self) = @_;
1267 1721
1268 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1722 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1269 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1723 "$UNIQUEDIR/$path"
1270} 1724}
1271 1725
1272# and all this just because we cannot iterate over 1726# and all this just because we cannot iterate over
1273# all maps in C++... 1727# all maps in C++...
1274sub change_all_map_light { 1728sub change_all_map_light {
1276 1730
1277 $_->change_map_light ($change) 1731 $_->change_map_light ($change)
1278 for grep $_->outdoor, values %cf::MAP; 1732 for grep $_->outdoor, values %cf::MAP;
1279} 1733}
1280 1734
1735sub decay_objects {
1736 my ($self) = @_;
1737
1738 return if $self->{deny_reset};
1739
1740 $self->do_decay_objects;
1741}
1742
1281sub unlink_save { 1743sub unlink_save {
1282 my ($self) = @_; 1744 my ($self) = @_;
1283 1745
1284 utf8::encode (my $save = $self->save_path); 1746 utf8::encode (my $save = $self->save_path);
1285 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1747 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1288 1750
1289sub load_header_from($) { 1751sub load_header_from($) {
1290 my ($self, $path) = @_; 1752 my ($self, $path) = @_;
1291 1753
1292 utf8::encode $path; 1754 utf8::encode $path;
1293 aio_open $path, O_RDONLY, 0 1755 #aio_open $path, O_RDONLY, 0
1294 or return; 1756 # or return;
1295 1757
1296 $self->_load_header ($path) 1758 $self->_load_header ($path)
1297 or return; 1759 or return;
1298 1760
1299 $self->{load_path} = $path; 1761 $self->{load_path} = $path;
1341 $self->load_header_orig 1803 $self->load_header_orig
1342 or return; 1804 or return;
1343 $self->prepare_orig; 1805 $self->prepare_orig;
1344 } 1806 }
1345 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
1346 1 1814 1
1347} 1815}
1348 1816
1349sub find; 1817sub find;
1350sub find { 1818sub find {
1362 $map->{last_save} = $cf::RUNTIME; 1830 $map->{last_save} = $cf::RUNTIME;
1363 1831
1364 $map->load_header 1832 $map->load_header
1365 or return; 1833 or return;
1366 1834
1367 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1835 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1368 # doing this can freeze the server in a sync job, obviously 1836 # doing this can freeze the server in a sync job, obviously
1369 #$cf::WAIT_FOR_TICK->wait; 1837 #$cf::WAIT_FOR_TICK->wait;
1370 $map->reset; 1838 $map->reset;
1371 undef $guard; 1839 undef $guard;
1372 return find $path; 1840 return find $path;
1380sub post_load { } 1848sub post_load { }
1381 1849
1382sub load { 1850sub load {
1383 my ($self) = @_; 1851 my ($self) = @_;
1384 1852
1853 local $self->{deny_reset} = 1; # loading can take a long time
1854
1385 my $path = $self->{path}; 1855 my $path = $self->{path};
1856
1857 {
1858 my $guard1 = cf::lock_acquire "map_data:$path";
1386 my $guard = cf::lock_acquire "map_load:$path"; 1859 my $guard2 = cf::lock_acquire "map_load:$path";
1387 1860
1388 return if $self->in_memory != cf::MAP_SWAPPED; 1861 return if $self->in_memory != cf::MAP_SWAPPED;
1389 1862
1390 $self->in_memory (cf::MAP_LOADING); 1863 $self->in_memory (cf::MAP_LOADING);
1391 1864
1392 $self->alloc; 1865 $self->alloc;
1393 1866
1394 $self->pre_load; 1867 $self->pre_load;
1868 cf::cede_to_tick;
1395 1869
1396 $self->_load_objects ($self->{load_path}, 1) 1870 $self->_load_objects ($self->{load_path}, 1)
1397 or return; 1871 or return;
1398 1872
1399 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1873 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1400 if delete $self->{load_original}; 1874 if delete $self->{load_original};
1401 1875
1402 if (my $uniq = $self->uniq_path) { 1876 if (my $uniq = $self->uniq_path) {
1403 utf8::encode $uniq; 1877 utf8::encode $uniq;
1404 if (aio_open $uniq, O_RDONLY, 0) { 1878 if (aio_open $uniq, O_RDONLY, 0) {
1405 $self->clear_unique_items; 1879 $self->clear_unique_items;
1406 $self->_load_objects ($uniq, 0); 1880 $self->_load_objects ($uniq, 0);
1407 } 1881 }
1408 } 1882 }
1409 1883
1410 Coro::cede; 1884 cf::cede_to_tick;
1411
1412 # now do the right thing for maps 1885 # now do the right thing for maps
1413 $self->link_multipart_objects; 1886 $self->link_multipart_objects;
1414
1415 unless ($self->{deny_activate}) {
1416 $self->decay_objects;
1417 $self->fix_auto_apply;
1418 $self->update_buttons;
1419 Coro::cede;
1420 $self->set_darkness_map;
1421 $self->difficulty ($self->estimate_difficulty) 1887 $self->difficulty ($self->estimate_difficulty)
1422 unless $self->difficulty; 1888 unless $self->difficulty;
1423 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;
1424 $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);
1425 } 1905 }
1426 1906
1427 $self->post_load; 1907 $self->post_load;
1428
1429 $self->in_memory (cf::MAP_IN_MEMORY);
1430} 1908}
1431 1909
1432sub customise_for { 1910sub customise_for {
1433 my ($self, $ob) = @_; 1911 my ($self, $ob) = @_;
1434 1912
1435 return find "~" . $ob->name . "/" . $self->{path} 1913 return find "~" . $ob->name . "/" . $self->{path}
1436 if $self->per_player; 1914 if $self->per_player;
1437 1915
1916# return find "?party/" . $ob->name . "/" . $self->{path}
1917# if $self->per_party;
1918
1438 $self 1919 $self
1439} 1920}
1440 1921
1441# 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
1442sub load_diag { 1923sub load_neighbours {
1443 my ($map) = @_; 1924 my ($map) = @_;
1444 1925
1445 my @diag; # diagonal neighbours 1926 my @neigh; # diagonal neighbours
1446 1927
1447 for (0 .. 3) { 1928 for (0 .. 3) {
1448 my $neigh = $map->tile_path ($_) 1929 my $neigh = $map->tile_path ($_)
1449 or next; 1930 or next;
1450 $neigh = find $neigh, $map 1931 $neigh = find $neigh, $map
1451 or next; 1932 or next;
1452 $neigh->load; 1933 $neigh->load;
1453 1934
1935 push @neigh,
1454 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1936 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1455 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1937 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1456 } 1938 }
1457 1939
1458 for (@diag) { 1940 for (grep defined $_->[0], @neigh) {
1941 my ($path, $origin) = @$_;
1459 my $neigh = find @$_ 1942 my $neigh = find $path, $origin
1460 or next; 1943 or next;
1461 $neigh->load; 1944 $neigh->load;
1462 } 1945 }
1463} 1946}
1464 1947
1469} 1952}
1470 1953
1471sub do_load_sync { 1954sub do_load_sync {
1472 my ($map) = @_; 1955 my ($map) = @_;
1473 1956
1957 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1958 if $Coro::current == $Coro::main;
1959
1474 cf::sync_job { $map->load }; 1960 cf::sync_job { $map->load };
1475} 1961}
1476 1962
1477our %MAP_PREFETCH; 1963our %MAP_PREFETCH;
1478our $MAP_PREFETCHER = undef; 1964our $MAP_PREFETCHER = undef;
1479 1965
1480sub find_async { 1966sub find_async {
1481 my ($path, $origin) = @_; 1967 my ($path, $origin, $load) = @_;
1482 1968
1483 $path = normalise $path, $origin && $origin->{path}; 1969 $path = normalise $path, $origin && $origin->{path};
1484 1970
1485 if (my $map = $cf::MAP{$path}) { 1971 if (my $map = $cf::MAP{$path}) {
1486 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1972 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1487 } 1973 }
1488 1974
1489 undef $MAP_PREFETCH{$path}; 1975 $MAP_PREFETCH{$path} |= $load;
1976
1490 $MAP_PREFETCHER ||= cf::async { 1977 $MAP_PREFETCHER ||= cf::async {
1491 while (%MAP_PREFETCH) { 1978 while (%MAP_PREFETCH) {
1492 for my $path (keys %MAP_PREFETCH) { 1979 while (my ($k, $v) = each %MAP_PREFETCH) {
1493 my $map = find $path 1980 if (my $map = find $k) {
1494 or next;
1495 $map->load; 1981 $map->load if $v;
1982 }
1496 1983
1497 delete $MAP_PREFETCH{$path}; 1984 delete $MAP_PREFETCH{$k};
1498 } 1985 }
1499 } 1986 }
1500 undef $MAP_PREFETCHER; 1987 undef $MAP_PREFETCHER;
1501 }; 1988 };
1502 $MAP_PREFETCHER->prio (6); 1989 $MAP_PREFETCHER->prio (6);
1505} 1992}
1506 1993
1507sub save { 1994sub save {
1508 my ($self) = @_; 1995 my ($self) = @_;
1509 1996
1510 my $lock = cf::lock_acquire "map_data:" . $self->path; 1997 my $lock = cf::lock_acquire "map_data:$self->{path}";
1511 1998
1512 $self->{last_save} = $cf::RUNTIME; 1999 $self->{last_save} = $cf::RUNTIME;
1513 2000
1514 return unless $self->dirty; 2001 return unless $self->dirty;
1515 2002
1538 my ($self) = @_; 2025 my ($self) = @_;
1539 2026
1540 # save first because save cedes 2027 # save first because save cedes
1541 $self->save; 2028 $self->save;
1542 2029
1543 my $lock = cf::lock_acquire "map_data:" . $self->path; 2030 my $lock = cf::lock_acquire "map_data:$self->{path}";
1544 2031
1545 return if $self->players; 2032 return if $self->players;
1546 return if $self->in_memory != cf::MAP_IN_MEMORY; 2033 return if $self->in_memory != cf::MAP_IN_MEMORY;
1547 return if $self->{deny_save}; 2034 return if $self->{deny_save};
1548 2035
1552 2039
1553sub reset_at { 2040sub reset_at {
1554 my ($self) = @_; 2041 my ($self) = @_;
1555 2042
1556 # TODO: safety, remove and allow resettable per-player maps 2043 # TODO: safety, remove and allow resettable per-player maps
1557 return 1e99 if $self->isa ("ext::map_per_player");#d#
1558 return 1e99 if $self->{deny_reset}; 2044 return 1e99 if $self->{deny_reset};
1559 2045
1560 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2046 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1561 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;
1562 2048
1573 my ($self) = @_; 2059 my ($self) = @_;
1574 2060
1575 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2061 my $lock = cf::lock_acquire "map_data:$self->{path}";
1576 2062
1577 return if $self->players; 2063 return if $self->players;
1578 return if $self->isa ("ext::map_per_player");#d#
1579 2064
1580 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 }
1581 2076
1582 delete $cf::MAP{$self->path}; 2077 delete $cf::MAP{$self->path};
1583 2078
1584 $self->in_memory (cf::MAP_SWAPPED);
1585 $self->clear; 2079 $self->clear;
1586 2080
1587 $_->clear_links_to ($self) for values %cf::MAP; 2081 $_->clear_links_to ($self) for values %cf::MAP;
1588 2082
1589 $self->unlink_save; 2083 $self->unlink_save;
1593my $nuke_counter = "aaaa"; 2087my $nuke_counter = "aaaa";
1594 2088
1595sub nuke { 2089sub nuke {
1596 my ($self) = @_; 2090 my ($self) = @_;
1597 2091
2092 {
2093 my $lock = cf::lock_acquire "map_data:$self->{path}";
2094
1598 delete $cf::MAP{$self->path}; 2095 delete $cf::MAP{$self->path};
1599 2096
1600 $self->unlink_save; 2097 $self->unlink_save;
1601 2098
1602 bless $self, "cf::map"; 2099 bless $self, "cf::map";
1603 delete $self->{deny_reset}; 2100 delete $self->{deny_reset};
1604 $self->{deny_save} = 1; 2101 $self->{deny_save} = 1;
1605 $self->reset_timeout (1); 2102 $self->reset_timeout (1);
1606 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2103 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1607 2104
1608 $cf::MAP{$self->path} = $self; 2105 $cf::MAP{$self->path} = $self;
2106 }
1609 2107
1610 $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 ]
1611} 2145}
1612 2146
1613=item cf::map::unique_maps 2147=item cf::map::unique_maps
1614 2148
1615Returns an arrayref of paths of all shared maps that have 2149Returns an arrayref of paths of all shared maps that have
1616instantiated unique items. May block. 2150instantiated unique items. May block.
1617 2151
1618=cut 2152=cut
1619 2153
1620sub unique_maps() { 2154sub unique_maps() {
1621 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2155 [
1622 or return; 2156 map {
1623
1624 my @paths;
1625
1626 for (@$files) {
1627 utf8::decode $_; 2157 utf8::decode $_;
1628 next if /\.pst$/;
1629 next unless /^$PATH_SEP/o;
1630
1631 s/\.map$//; 2158 /\.map$/
1632 push @paths, $_; 2159 ? normalise $_
2160 : ()
2161 } @{ aio_readdir $UNIQUEDIR or [] }
1633 } 2162 ]
1634
1635 \@paths
1636} 2163}
1637 2164
1638package cf; 2165package cf;
1639 2166
1640=back 2167=back
1686 2213
1687 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2214 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1688 2215
1689 if ($self->{record_replies}) { 2216 if ($self->{record_replies}) {
1690 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2217 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2218
1691 } 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 {
1692 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1693 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1694 } 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 (@_);
1695} 2241}
1696 2242
1697=item $player_object->may ("access") 2243=item $player_object->may ("access")
1698 2244
1699Returns wether the given player is authorized to access resource "access" 2245Returns wether the given player is authorized to access resource "access"
1731=cut 2277=cut
1732 2278
1733sub link_map { 2279sub link_map {
1734 unless ($LINK_MAP) { 2280 unless ($LINK_MAP) {
1735 $LINK_MAP = cf::map::find "{link}" 2281 $LINK_MAP = cf::map::find "{link}"
1736 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2282 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1737 $LINK_MAP->load; 2283 $LINK_MAP->load;
1738 } 2284 }
1739 2285
1740 $LINK_MAP 2286 $LINK_MAP
1741} 2287}
1746 $self->deactivate_recursive; 2292 $self->deactivate_recursive;
1747 2293
1748 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2294 return if UNIVERSAL::isa $self->map, "ext::map_link";
1749 2295
1750 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2296 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1751 if $self->map; 2297 if $self->map && $self->map->{path} ne "{link}";
1752 2298
1753 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2299 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1754} 2300}
1755 2301
1756sub cf::object::player::leave_link { 2302sub cf::object::player::leave_link {
1757 my ($self, $map, $x, $y) = @_; 2303 my ($self, $map, $x, $y) = @_;
2304
2305 return unless $self->contr->active;
1758 2306
1759 my $link_pos = delete $self->{_link_pos}; 2307 my $link_pos = delete $self->{_link_pos};
1760 2308
1761 unless ($map) { 2309 unless ($map) {
1762 # restore original map position 2310 # restore original map position
1776 # use -1 or undef as default coordinates, not 0, 0 2324 # use -1 or undef as default coordinates, not 0, 0
1777 ($x, $y) = ($map->enter_x, $map->enter_y) 2325 ($x, $y) = ($map->enter_x, $map->enter_y)
1778 if $x <=0 && $y <= 0; 2326 if $x <=0 && $y <= 0;
1779 2327
1780 $map->load; 2328 $map->load;
1781 $map->load_diag; 2329 $map->load_neighbours;
1782 2330
1783 return unless $self->contr->active; 2331 return unless $self->contr->active;
1784 $self->activate_recursive; 2332 $self->activate_recursive;
2333
2334 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1785 $self->enter_map ($map, $x, $y); 2335 $self->enter_map ($map, $x, $y);
1786} 2336}
1787 2337
1788cf::player->attach ( 2338=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1789 on_logout => sub {
1790 my ($pl) = @_;
1791 2339
1792 # abort map switching before logout 2340Moves the player to the given map-path and coordinates by first freezing
1793 if ($pl->ob->{_link_pos}) { 2341her, loading and preparing them map, calling the provided $check callback
1794 cf::sync_job { 2342that has to return the map if sucecssful, and then unfreezes the player on
1795 $pl->ob->leave_link 2343the new (success) or old (failed) map position. In either case, $done will
1796 }; 2344be called at the end of this process.
1797 }
1798 },
1799 on_login => sub {
1800 my ($pl) = @_;
1801 2345
1802 # try to abort aborted map switching on player login :)
1803 # should happen only on crashes
1804 if ($pl->ob->{_link_pos}) {
1805 $pl->ob->enter_link;
1806 (async {
1807 # we need this sleep as the login has a concurrent enter_exit running
1808 # and this sleep increases chances of the player not ending up in scorn
1809 $pl->ob->reply (undef,
1810 "There was an internal problem at your last logout, "
1811 . "the server will try to bring you to your intended destination in a second.",
1812 cf::NDI_RED);
1813 Coro::Timer::sleep 1;
1814 $pl->ob->leave_link;
1815 })->prio (2);
1816 }
1817 },
1818);
1819
1820=item $player_object->goto ($path, $x, $y)
1821
1822=cut 2346=cut
2347
2348our $GOTOGEN;
1823 2349
1824sub cf::object::player::goto { 2350sub cf::object::player::goto {
1825 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;
1826 2355
1827 $self->enter_link; 2356 $self->enter_link;
1828 2357
1829 (async { 2358 (async {
2359 my $map = eval {
1830 my $map = cf::map::find $path; 2360 my $map = cf::map::find $path;
2361
2362 if ($map) {
1831 $map = $map->customise_for ($self) if $map; 2363 $map = $map->customise_for ($self);
1832 2364 $map = $check->($map) if $check && $map;
1833# warn "entering ", $map->path, " at ($x, $y)\n" 2365 } else {
1834# if $map;
1835
1836 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2366 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2367 }
1837 2368
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 $@;
2375 }
2376
2377 if ($gen == $self->{_goto_generation}) {
2378 delete $self->{_goto_generation};
1838 $self->leave_link ($map, $x, $y); 2379 $self->leave_link ($map, $x, $y);
2380 }
2381
2382 $done->() if $done;
1839 })->prio (1); 2383 })->prio (1);
1840} 2384}
1841 2385
1842=item $player_object->enter_exit ($exit_object) 2386=item $player_object->enter_exit ($exit_object)
1843 2387
1872 # that depends on the exit object 2416 # that depends on the exit object
1873 2417
1874 my $rmp = parse_random_map_params $exit->msg; 2418 my $rmp = parse_random_map_params $exit->msg;
1875 2419
1876 if ($exit->map) { 2420 if ($exit->map) {
1877 $rmp->{region} = $exit->map->region_name; 2421 $rmp->{region} = $exit->region->name;
1878 $rmp->{origin_map} = $exit->map->path; 2422 $rmp->{origin_map} = $exit->map->path;
1879 $rmp->{origin_x} = $exit->x; 2423 $rmp->{origin_x} = $exit->x;
1880 $rmp->{origin_y} = $exit->y; 2424 $rmp->{origin_y} = $exit->y;
1881 } 2425 }
1882 2426
1883 $rmp->{random_seed} ||= $exit->random_seed; 2427 $rmp->{random_seed} ||= $exit->random_seed;
1884 2428
1885 my $data = cf::to_json $rmp; 2429 my $data = cf::to_json $rmp;
1886 my $md5 = Digest::MD5::md5_hex $data; 2430 my $md5 = Digest::MD5::md5_hex $data;
1887 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2431 my $meta = "$RANDOMDIR/$md5.meta";
1888 2432
1889 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2433 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1890 aio_write $fh, 0, (length $data), $data, 0; 2434 aio_write $fh, 0, (length $data), $data, 0;
1891 undef $fh; 2435 undef $fh;
1892 aio_rename "$meta~", $meta; 2436 aio_rename "$meta~", $meta;
1901 2445
1902 return unless $self->type == cf::PLAYER; 2446 return unless $self->type == cf::PLAYER;
1903 2447
1904 if ($exit->slaying eq "/!") { 2448 if ($exit->slaying eq "/!") {
1905 #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
1906 cf::sync_job { prepare_random_map $exit }; 2452 cf::sync_job { prepare_random_map $exit };
1907 } 2453 }
1908 2454
1909 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;
1910 my $hp = $exit->stats->hp; 2456 my $hp = $exit->stats->hp;
1911 my $sp = $exit->stats->sp; 2457 my $sp = $exit->stats->sp;
1912 2458
1913 $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);
1914 2464
1915 (async { 2465 (async {
1916 $self->deactivate_recursive; # just to be sure 2466 $self->deactivate_recursive; # just to be sure
1917 unless (eval { 2467 unless (eval {
1918 $self->goto ($slaying, $hp, $sp); 2468 $self->goto ($slaying, $hp, $sp);
1919 2469
1920 1; 2470 1;
1921 }) { 2471 }) {
1922 $self->message ("Something went wrong deep within the crossfire server. " 2472 $self->message ("Something went wrong deep within the crossfire server. "
1923 . "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. "
1924 . "Please report this to the dungeon master!", 2474 . "Please report this to the dungeon master!",
1925 cf::NDI_UNIQUE | cf::NDI_RED); 2475 cf::NDI_UNIQUE | cf::NDI_RED);
1926 2476
1927 warn "ERROR in enter_exit: $@"; 2477 warn "ERROR in enter_exit: $@";
1928 $self->leave_link; 2478 $self->leave_link;
1929 } 2479 }
1930 })->prio (1); 2480 })->prio (1);
1943 2493
1944sub cf::client::send_drawinfo { 2494sub cf::client::send_drawinfo {
1945 my ($self, $text, $flags) = @_; 2495 my ($self, $text, $flags) = @_;
1946 2496
1947 utf8::encode $text; 2497 utf8::encode $text;
1948 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2498 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1949} 2499}
1950 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 }
2541
2542 $channel = $channel->{id};
2543 }
2544
2545 return unless @extra || length $msg;
2546
2547 if ($self->can_msg) {
2548 # default colour, mask it out
2549 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2550 if $color & cf::NDI_DEF;
2551
2552 $self->send_packet ("msg " . $self->{json_coder}->encode (
2553 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2554 } else {
2555 if ($color >= 0) {
2556 # replace some tags by gcfclient-compatible ones
2557 for ($msg) {
2558 1 while
2559 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2560 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2561 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2562 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2563 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2564 }
2565
2566 $color &= cf::NDI_COLOR_MASK;
2567
2568 utf8::encode $msg;
2569
2570 if (0 && $msg =~ /\[/) {
2571 # COMMAND/INFO
2572 $self->send_packet ("drawextinfo $color 10 8 $msg")
2573 } else {
2574 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2575 $self->send_packet ("drawinfo $color $msg")
2576 }
2577 }
2578 }
2579}
2580
2581=item $client->ext_msg ($type, @msg)
2582
2583Sends an ext event to the client.
2584
2585=cut
2586
2587sub cf::client::ext_msg($$@) {
2588 my ($self, $type, @msg) = @_;
2589
2590 if ($self->extcmd == 2) {
2591 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2592 } elsif ($self->extcmd == 1) { # TODO: remove
2593 push @msg, msgtype => "event_$type";
2594 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2595 }
2596}
2597
2598=item $client->ext_reply ($msgid, @msg)
2599
2600Sends an ext reply to the client.
2601
2602=cut
2603
2604sub cf::client::ext_reply($$@) {
2605 my ($self, $id, @msg) = @_;
2606
2607 if ($self->extcmd == 2) {
2608 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2609 } elsif ($self->extcmd == 1) {
2610 #TODO: version 1, remove
2611 unshift @msg, msgtype => "reply", msgid => $id;
2612 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2613 }
2614}
1951 2615
1952=item $success = $client->query ($flags, "text", \&cb) 2616=item $success = $client->query ($flags, "text", \&cb)
1953 2617
1954Queues a query to the client, calling the given callback with 2618Queues a query to the client, calling the given callback with
1955the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2619the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1956C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2620C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1957 2621
1958Queries can fail, so check the return code. Or don't, as queries will become 2622Queries can fail, so check the return code. Or don't, as queries will
1959reliable at some point in the future. 2623become reliable at some point in the future.
1960 2624
1961=cut 2625=cut
1962 2626
1963sub cf::client::query { 2627sub cf::client::query {
1964 my ($self, $flags, $text, $cb) = @_; 2628 my ($self, $flags, $text, $cb) = @_;
1972 utf8::encode $text; 2636 utf8::encode $text;
1973 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2637 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1974 2638
1975 $self->send_packet ($self->{query_queue}[0][0]) 2639 $self->send_packet ($self->{query_queue}[0][0])
1976 if @{ $self->{query_queue} } == 1; 2640 if @{ $self->{query_queue} } == 1;
2641
2642 1
1977} 2643}
1978 2644
1979cf::client->attach ( 2645cf::client->attach (
2646 on_connect => sub {
2647 my ($ns) = @_;
2648
2649 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2650 },
1980 on_reply => sub { 2651 on_reply => sub {
1981 my ($ns, $msg) = @_; 2652 my ($ns, $msg) = @_;
1982 2653
1983 # this weird shuffling is so that direct followup queries 2654 # this weird shuffling is so that direct followup queries
1984 # get handled first 2655 # get handled first
1985 my $queue = delete $ns->{query_queue} 2656 my $queue = delete $ns->{query_queue}
1986 or return; # be conservative, not sure how that can happen, but we saw a crash here 2657 or return; # be conservative, not sure how that can happen, but we saw a crash here
1987 2658
1988 (shift @$queue)->[1]->($msg); 2659 (shift @$queue)->[1]->($msg);
2660 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1989 2661
1990 push @{ $ns->{query_queue} }, @$queue; 2662 push @{ $ns->{query_queue} }, @$queue;
1991 2663
1992 if (@{ $ns->{query_queue} } == @$queue) { 2664 if (@{ $ns->{query_queue} } == @$queue) {
1993 if (@$queue) { 2665 if (@$queue) {
1995 } else { 2667 } else {
1996 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2668 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1997 } 2669 }
1998 } 2670 }
1999 }, 2671 },
2672 on_exticmd => sub {
2673 my ($ns, $buf) = @_;
2674
2675 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2676
2677 if (ref $msg) {
2678 my ($type, $reply, @payload) =
2679 "ARRAY" eq ref $msg
2680 ? @$msg
2681 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2682
2683 my @reply;
2684
2685 if (my $cb = $EXTICMD{$type}) {
2686 @reply = $cb->($ns, @payload);
2687 }
2688
2689 $ns->ext_reply ($reply, @reply)
2690 if $reply;
2691
2692 } else {
2693 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2694 }
2695
2696 cf::override;
2697 },
2000); 2698);
2001 2699
2002=item $client->async (\&cb) 2700=item $client->async (\&cb)
2003 2701
2004Create a new coroutine, running the specified callback. The coroutine will 2702Create a new coroutine, running the specified callback. The coroutine will
2045our $safe = new Safe "safe"; 2743our $safe = new Safe "safe";
2046our $safe_hole = new Safe::Hole; 2744our $safe_hole = new Safe::Hole;
2047 2745
2048$SIG{FPE} = 'IGNORE'; 2746$SIG{FPE} = 'IGNORE';
2049 2747
2050$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2748$safe->permit_only (Opcode::opset qw(
2749 :base_core :base_mem :base_orig :base_math
2750 grepstart grepwhile mapstart mapwhile
2751 sort time
2752));
2051 2753
2052# here we export the classes and methods available to script code 2754# here we export the classes and methods available to script code
2053 2755
2054=pod 2756=pod
2055 2757
2056The following fucntions and emthods are available within a safe environment: 2758The following functions and methods are available within a safe environment:
2057 2759
2058 cf::object contr pay_amount pay_player map 2760 cf::object
2761 contr pay_amount pay_player map x y force_find force_add
2762 insert remove name archname title slaying race decrease_ob_nr
2763
2059 cf::object::player player 2764 cf::object::player
2060 cf::player peaceful 2765 player
2061 cf::map trigger 2766
2767 cf::player
2768 peaceful
2769
2770 cf::map
2771 trigger
2062 2772
2063=cut 2773=cut
2064 2774
2065for ( 2775for (
2066 ["cf::object" => qw(contr pay_amount pay_player map)], 2776 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2777 insert remove inv name archname title slaying race
2778 decrease_ob_nr)],
2067 ["cf::object::player" => qw(player)], 2779 ["cf::object::player" => qw(player)],
2068 ["cf::player" => qw(peaceful)], 2780 ["cf::player" => qw(peaceful)],
2069 ["cf::map" => qw(trigger)], 2781 ["cf::map" => qw(trigger)],
2070) { 2782) {
2071 no strict 'refs'; 2783 no strict 'refs';
2142=back 2854=back
2143 2855
2144=cut 2856=cut
2145 2857
2146############################################################################# 2858#############################################################################
2859# the server's init and main functions
2147 2860
2148=head2 EXTENSION DATABASE SUPPORT 2861sub load_facedata($) {
2862 my ($path) = @_;
2149 2863
2150Crossfire maintains a very simple database for extension use. It can 2864 # HACK to clear player env face cache, we need some signal framework
2151currently store anything that can be serialised using Storable, which 2865 # for this (global event?)
2152excludes objects. 2866 %ext::player_env::MUSIC_FACE_CACHE = ();
2153 2867
2154The parameter C<$family> should best start with the name of the extension 2868 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2155using it, it should be unique.
2156 2869
2157=over 4 2870 warn "loading facedata from $path\n";
2158 2871
2159=item $hashref = cf::db_get $family 2872 my $facedata;
2873 0 < aio_load $path, $facedata
2874 or die "$path: $!";
2160 2875
2161Return a hashref for use by the extension C<$family>, which can be 2876 $facedata = Coro::Storable::thaw $facedata;
2162modified. After modifications, you have to call C<cf::db_dirty> or
2163C<cf::db_sync>.
2164 2877
2165=item $value = cf::db_get $family => $key 2878 $facedata->{version} == 2
2879 or cf::cleanup "$path: version mismatch, cannot proceed.";
2166 2880
2167Returns a single value from the database 2881 # patch in the exptable
2168 2882 $facedata->{resource}{"res/exp_table"} = {
2169=item cf::db_put $family => $hashref 2883 type => FT_RSRC,
2170 2884 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2171Stores the given family hashref into the database. Updates are delayed, if
2172you want the data to be synced to disk immediately, use C<cf::db_sync>.
2173
2174=item cf::db_put $family => $key => $value
2175
2176Stores the given C<$value> in the family hash. Updates are delayed, if you
2177want the data to be synced to disk immediately, use C<cf::db_sync>.
2178
2179=item cf::db_dirty
2180
2181Marks the database as dirty, to be updated at a later time.
2182
2183=item cf::db_sync
2184
2185Immediately write the database to disk I<if it is dirty>.
2186
2187=cut
2188
2189our $DB;
2190
2191{
2192 my $path = cf::localdir . "/database.pst";
2193
2194 sub db_load() {
2195 $DB = stat $path ? Storable::retrieve $path : { };
2196 } 2885 };
2886 cf::cede_to_tick;
2197 2887
2198 my $pid;
2199
2200 sub db_save() {
2201 waitpid $pid, 0 if $pid;
2202 if (0 == ($pid = fork)) {
2203 $DB->{_meta}{version} = 1;
2204 Storable::nstore $DB, "$path~";
2205 rename "$path~", $path;
2206 cf::_exit 0 if defined $pid;
2207 }
2208 } 2888 {
2889 my $faces = $facedata->{faceinfo};
2209 2890
2210 my $dirty; 2891 while (my ($face, $info) = each %$faces) {
2892 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2893 cf::face::set_visibility $idx, $info->{visibility};
2894 cf::face::set_magicmap $idx, $info->{magicmap};
2895 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2896 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2211 2897
2212 sub db_sync() { 2898 cf::cede_to_tick;
2213 db_save if $dirty;
2214 undef $dirty;
2215 }
2216
2217 my $idle = Event->idle (
2218 reentrant => 0,
2219 min => 10,
2220 max => 20,
2221 repeat => 0,
2222 data => WF_AUTOCANCEL,
2223 cb => \&db_sync,
2224 );
2225
2226 sub db_dirty() {
2227 $dirty = 1;
2228 $idle->start;
2229 }
2230
2231 sub db_get($;$) {
2232 @_ >= 2
2233 ? $DB->{$_[0]}{$_[1]}
2234 : ($DB->{$_[0]} ||= { })
2235 }
2236
2237 sub db_put($$;$) {
2238 if (@_ >= 3) {
2239 $DB->{$_[0]}{$_[1]} = $_[2];
2240 } else {
2241 $DB->{$_[0]} = $_[1];
2242 }
2243 db_dirty;
2244 }
2245
2246 cf::global->attach (
2247 prio => 10000,
2248 on_cleanup => sub {
2249 db_sync;
2250 }, 2899 }
2251 );
2252}
2253 2900
2254############################################################################# 2901 while (my ($face, $info) = each %$faces) {
2255# the server's main() 2902 next unless $info->{smooth};
2903 my $idx = cf::face::find $face
2904 or next;
2905 if (my $smooth = cf::face::find $info->{smooth}) {
2906 cf::face::set_smooth $idx, $smooth;
2907 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2908 } else {
2909 warn "smooth face '$info->{smooth}' not found for face '$face'";
2910 }
2256 2911
2257sub cfg_load { 2912 cf::cede_to_tick;
2913 }
2914 }
2915
2916 {
2917 my $anims = $facedata->{animinfo};
2918
2919 while (my ($anim, $info) = each %$anims) {
2920 cf::anim::set $anim, $info->{frames}, $info->{facings};
2921 cf::cede_to_tick;
2922 }
2923
2924 cf::anim::invalidate_all; # d'oh
2925 }
2926
2927 {
2928 # TODO: for gcfclient pleasure, we should give resources
2929 # that gcfclient doesn't grok a >10000 face index.
2930 my $res = $facedata->{resource};
2931
2932 my $soundconf = delete $res->{"res/sound.conf"};
2933
2934 while (my ($name, $info) = each %$res) {
2935 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2936 my $data;
2937
2938 if ($info->{type} & 1) {
2939 # prepend meta info
2940
2941 my $meta = $enc->encode ({
2942 name => $name,
2943 %{ $info->{meta} || {} },
2944 });
2945
2946 $data = pack "(w/a*)*", $meta, $info->{data};
2947 } else {
2948 $data = $info->{data};
2949 }
2950
2951 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2952 cf::face::set_type $idx, $info->{type};
2953
2954 cf::cede_to_tick;
2955 }
2956
2957 if ($soundconf) {
2958 $soundconf = $enc->decode (delete $soundconf->{data});
2959
2960 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2961 my $sound = $soundconf->{compat}[$_]
2962 or next;
2963
2964 my $face = cf::face::find "sound/$sound->[1]";
2965 cf::sound::set $sound->[0] => $face;
2966 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2967 }
2968
2969 while (my ($k, $v) = each %{$soundconf->{event}}) {
2970 my $face = cf::face::find "sound/$v";
2971 cf::sound::set $k => $face;
2972 }
2973 }
2974 }
2975
2976 1
2977}
2978
2979register_exticmd fx_want => sub {
2980 my ($ns, $want) = @_;
2981
2982 while (my ($k, $v) = each %$want) {
2983 $ns->fx_want ($k, $v);
2984 }
2985};
2986
2987sub reload_regions {
2988 # HACK to clear player env face cache, we need some signal framework
2989 # for this (global event?)
2990 %ext::player_env::MUSIC_FACE_CACHE = ();
2991
2992 load_resource_file "$MAPDIR/regions"
2993 or die "unable to load regions file\n";
2994
2995 for (cf::region::list) {
2996 $_->{match} = qr/$_->{match}/
2997 if exists $_->{match};
2998 }
2999}
3000
3001sub reload_facedata {
3002 load_facedata "$DATADIR/facedata"
3003 or die "unable to load facedata\n";
3004}
3005
3006sub reload_archetypes {
3007 load_resource_file "$DATADIR/archetypes"
3008 or die "unable to load archetypes\n";
3009 #d# NEED to laod twice to resolve forward references
3010 # this really needs to be done in an extra post-pass
3011 # (which needs to be synchronous, so solve it differently)
3012 load_resource_file "$DATADIR/archetypes"
3013 or die "unable to load archetypes\n";
3014}
3015
3016sub reload_treasures {
3017 load_resource_file "$DATADIR/treasures"
3018 or die "unable to load treasurelists\n";
3019}
3020
3021sub reload_resources {
3022 warn "reloading resource files...\n";
3023
3024 reload_regions;
3025 reload_facedata;
3026 #reload_archetypes;#d#
3027 reload_archetypes;
3028 reload_treasures;
3029
3030 warn "finished reloading resource files\n";
3031}
3032
3033sub init {
3034 reload_resources;
3035}
3036
3037sub reload_config {
2258 open my $fh, "<:utf8", cf::confdir . "/config" 3038 open my $fh, "<:utf8", "$CONFDIR/config"
2259 or return; 3039 or return;
2260 3040
2261 local $/; 3041 local $/;
2262 *CFG = YAML::Syck::Load <$fh>; 3042 *CFG = YAML::Syck::Load <$fh>;
2263 3043
2282 (async { 3062 (async {
2283 Event::one_event; 3063 Event::one_event;
2284 })->prio (Coro::PRIO_MAX); 3064 })->prio (Coro::PRIO_MAX);
2285 }; 3065 };
2286 3066
2287 cfg_load; 3067 reload_config;
2288 db_load; 3068 db_init;
2289 load_extensions; 3069 load_extensions;
2290 3070
2291 $TICK_WATCHER->start; 3071 $TICK_WATCHER->start;
2292 Event::loop; 3072 Event::loop;
2293} 3073}
2308 }, 3088 },
2309 ); 3089 );
2310 } 3090 }
2311} 3091}
2312 3092
3093sub write_runtime {
3094 my $runtime = "$LOCALDIR/runtime";
3095
3096 # first touch the runtime file to show we are still running:
3097 # the fsync below can take a very very long time.
3098
3099 IO::AIO::aio_utime $runtime, undef, undef;
3100
3101 my $guard = cf::lock_acquire "write_runtime";
3102
3103 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3104 or return;
3105
3106 my $value = $cf::RUNTIME + 90 + 10;
3107 # 10 is the runtime save interval, for a monotonic clock
3108 # 60 allows for the watchdog to kill the server.
3109
3110 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3111 and return;
3112
3113 # always fsync - this file is important
3114 aio_fsync $fh
3115 and return;
3116
3117 # touch it again to show we are up-to-date
3118 aio_utime $fh, undef, undef;
3119
3120 close $fh
3121 or return;
3122
3123 aio_rename "$runtime~", $runtime
3124 and return;
3125
3126 warn "runtime file written.\n";
3127
3128 1
3129}
3130
2313sub emergency_save() { 3131sub emergency_save() {
2314 my $freeze_guard = cf::freeze_mainloop; 3132 my $freeze_guard = cf::freeze_mainloop;
2315 3133
2316 warn "enter emergency perl save\n"; 3134 warn "enter emergency perl save\n";
2317 3135
2332 my $map = $cf::MAP{$path} or next; 3150 my $map = $cf::MAP{$path} or next;
2333 $map->valid or next; 3151 $map->valid or next;
2334 $map->save; 3152 $map->save;
2335 } 3153 }
2336 warn "end emergency map save\n"; 3154 warn "end emergency map save\n";
3155
3156 warn "begin emergency database checkpoint\n";
3157 BDB::db_env_txn_checkpoint $DB_ENV;
3158 warn "end emergency database checkpoint\n";
2337 }; 3159 };
2338 3160
2339 warn "leave emergency perl save\n"; 3161 warn "leave emergency perl save\n";
2340} 3162}
2341 3163
3164sub post_cleanup {
3165 my ($make_core) = @_;
3166
3167 warn Carp::longmess "post_cleanup backtrace"
3168 if $make_core;
3169}
3170
2342sub reload() { 3171sub do_reload_perl() {
2343 # can/must only be called in main 3172 # can/must only be called in main
2344 if ($Coro::current != $Coro::main) { 3173 if ($Coro::current != $Coro::main) {
2345 warn "can only reload from main coroutine"; 3174 warn "can only reload from main coroutine";
2346 return; 3175 return;
2347 } 3176 }
2348 3177
2349 warn "reloading..."; 3178 warn "reloading...";
2350 3179
2351 warn "cancelling server ticker"; 3180 warn "entering sync_job";
2352 $TICK_WATCHER->cancel;
2353 3181
3182 cf::sync_job {
3183 cf::write_runtime; # external watchdog should not bark
2354 cf::emergency_save; 3184 cf::emergency_save;
3185 cf::write_runtime; # external watchdog should not bark
2355 3186
2356 eval { 3187 warn "syncing database to disk";
3188 BDB::db_env_txn_checkpoint $DB_ENV;
3189
2357 # if anything goes wrong in here, we should simply crash as we already saved 3190 # if anything goes wrong in here, we should simply crash as we already saved
2358
2359 warn "syncing database to disk";
2360 cf::db_sync;
2361 3191
2362 warn "cancelling all WF_AUTOCANCEL watchers"; 3192 warn "cancelling all WF_AUTOCANCEL watchers";
2363 for (Event::all_watchers) { 3193 for (Event::all_watchers) {
2364 $_->cancel if $_->data & WF_AUTOCANCEL; 3194 $_->cancel if $_->data & WF_AUTOCANCEL;
2365 } 3195 }
2366 3196
2367 warn "flushing outstanding aio requests"; 3197 warn "flushing outstanding aio requests";
2368 for (;;) { 3198 for (;;) {
3199 BDB::flush;
2369 IO::AIO::flush; 3200 IO::AIO::flush;
2370 Coro::cede; 3201 Coro::cede;
2371 last unless IO::AIO::nreqs; 3202 last unless IO::AIO::nreqs || BDB::nreqs;
2372 warn "iterate..."; 3203 warn "iterate...";
2373 } 3204 }
3205
3206 ++$RELOAD;
2374 3207
2375 warn "cancelling all extension coros"; 3208 warn "cancelling all extension coros";
2376 $_->cancel for values %EXT_CORO; 3209 $_->cancel for values %EXT_CORO;
2377 %EXT_CORO = (); 3210 %EXT_CORO = ();
2378 3211
2379 warn "removing commands"; 3212 warn "removing commands";
2380 %COMMAND = (); 3213 %COMMAND = ();
2381 3214
2382 warn "removing ext commands"; 3215 warn "removing ext/exti commands";
2383 %EXTCMD = (); 3216 %EXTCMD = ();
3217 %EXTICMD = ();
2384 3218
2385 warn "unloading/nuking all extensions"; 3219 warn "unloading/nuking all extensions";
2386 for my $pkg (@EXTS) { 3220 for my $pkg (@EXTS) {
2387 warn "... unloading $pkg"; 3221 warn "... unloading $pkg";
2388 3222
2418 Symbol::delete_package "safe::$_" 3252 Symbol::delete_package "safe::$_"
2419 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3253 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2420 3254
2421 warn "unloading cf.pm \"a bit\""; 3255 warn "unloading cf.pm \"a bit\"";
2422 delete $INC{"cf.pm"}; 3256 delete $INC{"cf.pm"};
3257 delete $INC{"cf/pod.pm"};
2423 3258
2424 # don't, removes xs symbols, too, 3259 # don't, removes xs symbols, too,
2425 # and global variables created in xs 3260 # and global variables created in xs
2426 #Symbol::delete_package __PACKAGE__; 3261 #Symbol::delete_package __PACKAGE__;
2427 3262
2430 warn "reloading cf.pm"; 3265 warn "reloading cf.pm";
2431 require cf; 3266 require cf;
2432 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3267 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2433 3268
2434 warn "loading config and database again"; 3269 warn "loading config and database again";
2435 cf::cfg_load; 3270 cf::reload_config;
2436 cf::db_load;
2437 3271
2438 warn "loading extensions"; 3272 warn "loading extensions";
2439 cf::load_extensions; 3273 cf::load_extensions;
2440 3274
2441 warn "reattaching attachments to objects/players"; 3275 warn "reattaching attachments to objects/players";
2442 _global_reattach; 3276 _global_reattach; # objects, sockets
2443 warn "reattaching attachments to maps"; 3277 warn "reattaching attachments to maps";
2444 reattach $_ for values %MAP; 3278 reattach $_ for values %MAP;
3279 warn "reattaching attachments to players";
3280 reattach $_ for values %PLAYER;
2445 3281
2446 warn "restarting server ticker"; 3282 warn "leaving sync_job";
2447 3283
2448 $TICK_WATCHER->start; 3284 1
2449 }; 3285 } or do {
2450
2451 if ($@) {
2452 warn $@; 3286 warn $@;
2453 warn "error while reloading, exiting."; 3287 warn "error while reloading, exiting.";
2454 exit 1; 3288 exit 1;
2455 } 3289 };
2456 3290
2457 warn "reloaded"; 3291 warn "reloaded";
2458}; 3292};
2459 3293
2460our $RELOAD_WATCHER; # used only during reload 3294our $RELOAD_WATCHER; # used only during reload
2461 3295
3296sub reload_perl() {
3297 # doing reload synchronously and two reloads happen back-to-back,
3298 # coro crashes during coro_state_free->destroy here.
3299
3300 $RELOAD_WATCHER ||= Event->timer (
3301 reentrant => 0,
3302 after => 0,
3303 data => WF_AUTOCANCEL,
3304 cb => sub {
3305 do_reload_perl;
3306 undef $RELOAD_WATCHER;
3307 },
3308 );
3309}
3310
2462register_command "reload" => sub { 3311register_command "reload" => sub {
2463 my ($who, $arg) = @_; 3312 my ($who, $arg) = @_;
2464 3313
2465 if ($who->flag (FLAG_WIZ)) { 3314 if ($who->flag (FLAG_WIZ)) {
2466 $who->message ("reloading server."); 3315 $who->message ("reloading server.");
2467 3316 async { reload_perl };
2468 # doing reload synchronously and two reloads happen back-to-back,
2469 # coro crashes during coro_state_free->destroy here.
2470
2471 $RELOAD_WATCHER ||= Event->timer (
2472 reentrant => 0,
2473 after => 0,
2474 data => WF_AUTOCANCEL,
2475 cb => sub {
2476 reload;
2477 undef $RELOAD_WATCHER;
2478 },
2479 );
2480 } 3317 }
2481}; 3318};
2482 3319
2483unshift @INC, $LIBDIR; 3320unshift @INC, $LIBDIR;
2484 3321
2485my $bug_warning = 0; 3322my $bug_warning = 0;
2486 3323
3324our @WAIT_FOR_TICK;
3325our @WAIT_FOR_TICK_BEGIN;
3326
3327sub wait_for_tick {
3328 return unless $TICK_WATCHER->is_active;
3329 return if $Coro::current == $Coro::main;
3330
3331 my $signal = new Coro::Signal;
3332 push @WAIT_FOR_TICK, $signal;
3333 $signal->wait;
3334}
3335
3336sub wait_for_tick_begin {
3337 return unless $TICK_WATCHER->is_active;
3338 return if $Coro::current == $Coro::main;
3339
3340 my $signal = new Coro::Signal;
3341 push @WAIT_FOR_TICK_BEGIN, $signal;
3342 $signal->wait;
3343}
3344
3345 my $min = 1e6;#d#
3346 my $avg = 10;
2487$TICK_WATCHER = Event->timer ( 3347$TICK_WATCHER = Event->timer (
2488 reentrant => 0, 3348 reentrant => 0,
2489 parked => 1, 3349 parked => 1,
2490 prio => 0, 3350 prio => 0,
2491 at => $NEXT_TICK || $TICK, 3351 at => $NEXT_TICK || $TICK,
2495 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3355 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2496 unless ++$bug_warning > 10; 3356 unless ++$bug_warning > 10;
2497 return; 3357 return;
2498 } 3358 }
2499 3359
2500 $NOW = Event::time; 3360 $NOW = $tick_start = Event::time;
2501 3361
2502 cf::server_tick; # one server iteration 3362 cf::server_tick; # one server iteration
3363
3364 0 && sync_job {#d#
3365 for(1..10) {
3366 my $t = Event::time;
3367 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3368 or die;
3369
3370 $map->width (50);
3371 $map->height (50);
3372 $map->alloc;
3373 $map->_load_objects ("/tmp/x.map", 1);
3374 my $t = Event::time - $t;
3375
3376 #next unless $t < 0.0013;#d#
3377 if ($t < $min) {
3378 $min = $t;
3379 }
3380 $avg = $avg * 0.99 + $t * 0.01;
3381 }
3382 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3383 exit 0;
3384 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3385 };
3386
2503 $RUNTIME += $TICK; 3387 $RUNTIME += $TICK;
2504 $NEXT_TICK += $TICK; 3388 $NEXT_TICK += $TICK;
2505 3389
2506 $WAIT_FOR_TICK->broadcast; 3390 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2507 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3391 $NEXT_RUNTIME_WRITE = $NOW + 10;
2508 3392 Coro::async_pool {
2509 Event::sweep; 3393 write_runtime
2510 Coro::cede_notself; 3394 or warn "ERROR: unable to write runtime file: $!";
3395 };
2511 3396 }
3397
2512# my $AFTER = Event::time; 3398# my $AFTER = Event::time;
2513# warn $AFTER - $NOW;#d# 3399# warn $AFTER - $NOW;#d#
2514 3400
3401 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3402 $sig->send;
3403 }
3404 while (my $sig = shift @WAIT_FOR_TICK) {
3405 $sig->send;
3406 }
3407
3408 $NOW = Event::time;
3409
2515 # if we are delayed by four ticks or more, skip them all 3410 # if we are delayed by four ticks or more, skip them all
2516 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3411 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2517 3412
2518 $TICK_WATCHER->at ($NEXT_TICK); 3413 $TICK_WATCHER->at ($NEXT_TICK);
2519 $TICK_WATCHER->start; 3414 $TICK_WATCHER->start;
3415
3416 $LOAD = ($NOW - $tick_start) / $TICK;
3417 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3418
3419 _post_tick;
3420
3421
2520 }, 3422 },
2521); 3423);
2522 3424
3425{
3426 BDB::max_poll_time $TICK * 0.1;
3427 $BDB_POLL_WATCHER = Event->io (
3428 reentrant => 0,
3429 fd => BDB::poll_fileno,
3430 poll => 'r',
3431 prio => 0,
3432 data => WF_AUTOCANCEL,
3433 cb => \&BDB::poll_cb,
3434 );
3435 BDB::min_parallel 8;
3436
3437 BDB::set_sync_prepare {
3438 my $status;
3439 my $current = $Coro::current;
3440 (
3441 sub {
3442 $status = $!;
3443 $current->ready; undef $current;
3444 },
3445 sub {
3446 Coro::schedule while defined $current;
3447 $! = $status;
3448 },
3449 )
3450 };
3451
3452 unless ($DB_ENV) {
3453 $DB_ENV = BDB::db_env_create;
3454
3455 cf::sync_job {
3456 eval {
3457 BDB::db_env_open
3458 $DB_ENV,
3459 $BDBDIR,
3460 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3461 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3462 0666;
3463
3464 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3465
3466 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3467 $DB_ENV->set_lk_detect;
3468 };
3469
3470 cf::cleanup "db_env_open(db): $@" if $@;
3471 };
3472 }
3473}
3474
3475{
3476 IO::AIO::min_parallel 8;
3477
3478 undef $Coro::AIO::WATCHER;
2523IO::AIO::max_poll_time $TICK * 0.1; 3479 IO::AIO::max_poll_time $TICK * 0.1;
2524
2525undef $Coro::AIO::WATCHER;
2526$AIO_POLL_WATCHER = Event->io ( 3480 $AIO_POLL_WATCHER = Event->io (
2527 reentrant => 0, 3481 reentrant => 0,
3482 data => WF_AUTOCANCEL,
2528 fd => IO::AIO::poll_fileno, 3483 fd => IO::AIO::poll_fileno,
2529 poll => 'r', 3484 poll => 'r',
2530 prio => 6, 3485 prio => 6,
2531 data => WF_AUTOCANCEL,
2532 cb => \&IO::AIO::poll_cb, 3486 cb => \&IO::AIO::poll_cb,
2533); 3487 );
3488}
2534 3489
2535$WRITE_RUNTIME_WATCHER = Event->timer ( 3490my $_log_backtrace;
2536 reentrant => 0, 3491
2537 data => WF_AUTOCANCEL, 3492sub _log_backtrace {
2538 after => 1, 3493 my ($msg, @addr) = @_;
2539 interval => 10, 3494
2540 prio => 6, # keep it lowest so it acts like a watchdog 3495 $msg =~ s/\n//;
2541 cb => Coro::unblock_sub { 3496
2542 write_runtime 3497 # limit the # of concurrent backtraces
2543 or warn "ERROR: unable to write runtime file: $!"; 3498 if ($_log_backtrace < 2) {
3499 ++$_log_backtrace;
3500 async {
3501 my @bt = fork_call {
3502 @addr = map { sprintf "%x", $_ } @addr;
3503 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3504 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3505 or die "addr2line: $!";
3506
3507 my @funcs;
3508 my @res = <$fh>;
3509 chomp for @res;
3510 while (@res) {
3511 my ($func, $line) = splice @res, 0, 2, ();
3512 push @funcs, "[$func] $line";
3513 }
3514
3515 @funcs
3516 };
3517
3518 LOG llevInfo, "[ABT] $msg\n";
3519 LOG llevInfo, "[ABT] $_\n" for @bt;
3520 --$_log_backtrace;
3521 };
3522 } else {
3523 LOG llevInfo, "[ABT] $msg\n";
3524 LOG llevInfo, "[ABT] [suppressed]\n";
2544 }, 3525 }
2545); 3526}
3527
3528# load additional modules
3529use cf::pod;
2546 3530
2547END { cf::emergency_save } 3531END { cf::emergency_save }
2548 3532
25491 35331
2550 3534

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines