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.194 by root, Wed Jan 24 22:42:49 2007 UTC vs.
Revision 1.350 by root, Sat Sep 1 08:03:45 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.5 (); 15use Coro 3.64 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
24use Coro::Util ();
19 25
26use JSON::XS ();
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/(?<![BIUGH])</&lt;/g;
1469
1470 # this is buggy, it needs to properly take care of nested <'s
1471
1472 1 while
1473 # replace B<>, I<>, U<> etc.
1474 s/B<([^\>]*)>/<b>$1<\/b>/
1475 || s/I<([^\>]*)>/<i>$1<\/i>/
1476 || s/U<([^\>]*)>/<u>$1<\/u>/
1477 # replace G<male|female> tags
1478 || s{G<([^>|]*)\|([^>]*)>}{
1479 $self->gender ? $2 : $1
1480 }ge
1481 # replace H<hint text>
1482 || s{H<([^\>]*)>}
1483 {
1484 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1485 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1486 "")
1487 [$self->{hintmode}]
1488 }ge;
1489
1490 # create single paragraphs (very hackish)
1491 s/(?<=\S)\n(?=\w)/ /g;
1492
1493 # compress some whitespace
1494 s/\s+\n/\n/g; # ws line-ends
1495 s/\n\n+/\n/g; # double lines
1496 s/^\n+//; # beginning lines
1497 s/\n+$//; # ending lines
1498
1499 $_
1500}
1501
1502sub hintmode {
1503 $_[0]{hintmode} = $_[1] if @_ > 1;
1504 $_[0]{hintmode}
1505}
1506
1090=item $player->ext_reply ($msgid, $msgtype, %msg) 1507=item $player->ext_reply ($msgid, @msg)
1091 1508
1092Sends an ext reply to the player. 1509Sends an ext reply to the player.
1093 1510
1094=cut 1511=cut
1095 1512
1096sub ext_reply($$$%) { 1513sub ext_reply($$@) {
1097 my ($self, $id, %msg) = @_; 1514 my ($self, $id, @msg) = @_;
1098 1515
1099 $msg{msgid} = $id; 1516 $self->ns->ext_reply ($id, @msg)
1100
1101 $self->send ("ext " . cf::to_json \%msg);
1102} 1517}
1103 1518
1104package cf; 1519=item $player->ext_msg ($type, @msg)
1520
1521Sends an ext event to the client.
1522
1523=cut
1524
1525sub ext_msg($$@) {
1526 my ($self, $type, @msg) = @_;
1527
1528 $self->ns->ext_msg ($type, @msg);
1529}
1530
1531=head3 cf::region
1532
1533=over 4
1534
1535=cut
1536
1537package cf::region;
1538
1539=item cf::region::find_by_path $path
1540
1541Tries to decuce the likely region for a map knowing only its path.
1542
1543=cut
1544
1545sub find_by_path($) {
1546 my ($path) = @_;
1547
1548 my ($match, $specificity);
1549
1550 for my $region (list) {
1551 if ($region->{match} && $path =~ $region->{match}) {
1552 ($match, $specificity) = ($region, $region->specificity)
1553 if $region->specificity > $specificity;
1554 }
1555 }
1556
1557 $match
1558}
1105 1559
1106=back 1560=back
1107
1108 1561
1109=head3 cf::map 1562=head3 cf::map
1110 1563
1111=over 4 1564=over 4
1112 1565
1167 my ($self, $merge) = @_; 1620 my ($self, $merge) = @_;
1168 1621
1169 # we have to keep some variables in memory intact 1622 # we have to keep some variables in memory intact
1170 local $self->{path}; 1623 local $self->{path};
1171 local $self->{load_path}; 1624 local $self->{load_path};
1172 local $self->{deny_save};
1173 local $self->{deny_reset};
1174 1625
1175 $self->SUPER::thawer_merge ($merge); 1626 $self->SUPER::thawer_merge ($merge);
1176} 1627}
1177 1628
1178sub normalise { 1629sub normalise {
1179 my ($path, $base) = @_; 1630 my ($path, $base) = @_;
1180 1631
1181 $path = "$path"; # make sure its a string 1632 $path = "$path"; # make sure its a string
1633
1634 $path =~ s/\.map$//;
1182 1635
1183 # map plan: 1636 # map plan:
1184 # 1637 #
1185 # /! non-realised random map exit (special hack!) 1638 # /! non-realised random map exit (special hack!)
1186 # {... are special paths that are not being touched 1639 # {... are special paths that are not being touched
1223 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1224 return $self; 1677 return $self;
1225 } 1678 }
1226 } 1679 }
1227 1680
1228 Carp::carp "unable to resolve path '$path' (base '$base')."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1229 () 1682 ()
1230} 1683}
1231 1684
1232sub init { 1685sub init {
1233 my ($self) = @_; 1686 my ($self) = @_;
1248 1701
1249# the original (read-only) location 1702# the original (read-only) location
1250sub load_path { 1703sub load_path {
1251 my ($self) = @_; 1704 my ($self) = @_;
1252 1705
1253 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1706 "$MAPDIR/$self->{path}.map"
1254} 1707}
1255 1708
1256# the temporary/swap location 1709# the temporary/swap location
1257sub save_path { 1710sub save_path {
1258 my ($self) = @_; 1711 my ($self) = @_;
1259 1712
1260 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1713 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1261 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1714 "$TMPDIR/$path.map"
1262} 1715}
1263 1716
1264# the unique path, undef == no special unique path 1717# the unique path, undef == no special unique path
1265sub uniq_path { 1718sub uniq_path {
1266 my ($self) = @_; 1719 my ($self) = @_;
1267 1720
1268 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1721 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1269 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1722 "$UNIQUEDIR/$path"
1270} 1723}
1271 1724
1272# and all this just because we cannot iterate over 1725# and all this just because we cannot iterate over
1273# all maps in C++... 1726# all maps in C++...
1274sub change_all_map_light { 1727sub change_all_map_light {
1276 1729
1277 $_->change_map_light ($change) 1730 $_->change_map_light ($change)
1278 for grep $_->outdoor, values %cf::MAP; 1731 for grep $_->outdoor, values %cf::MAP;
1279} 1732}
1280 1733
1734sub decay_objects {
1735 my ($self) = @_;
1736
1737 return if $self->{deny_reset};
1738
1739 $self->do_decay_objects;
1740}
1741
1281sub unlink_save { 1742sub unlink_save {
1282 my ($self) = @_; 1743 my ($self) = @_;
1283 1744
1284 utf8::encode (my $save = $self->save_path); 1745 utf8::encode (my $save = $self->save_path);
1285 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1746 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1288 1749
1289sub load_header_from($) { 1750sub load_header_from($) {
1290 my ($self, $path) = @_; 1751 my ($self, $path) = @_;
1291 1752
1292 utf8::encode $path; 1753 utf8::encode $path;
1293 aio_open $path, O_RDONLY, 0 1754 #aio_open $path, O_RDONLY, 0
1294 or return; 1755 # or return;
1295 1756
1296 $self->_load_header ($path) 1757 $self->_load_header ($path)
1297 or return; 1758 or return;
1298 1759
1299 $self->{load_path} = $path; 1760 $self->{load_path} = $path;
1341 $self->load_header_orig 1802 $self->load_header_orig
1342 or return; 1803 or return;
1343 $self->prepare_orig; 1804 $self->prepare_orig;
1344 } 1805 }
1345 1806
1807 $self->{deny_reset} = 1
1808 if $self->no_reset;
1809
1810 $self->default_region (cf::region::find_by_path $self->{path})
1811 unless $self->default_region;
1812
1346 1 1813 1
1347} 1814}
1348 1815
1349sub find; 1816sub find;
1350sub find { 1817sub find {
1362 $map->{last_save} = $cf::RUNTIME; 1829 $map->{last_save} = $cf::RUNTIME;
1363 1830
1364 $map->load_header 1831 $map->load_header
1365 or return; 1832 or return;
1366 1833
1367 if ($map->should_reset) { 1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1368 # doing this can freeze the server in a sync job, obviously 1835 # doing this can freeze the server in a sync job, obviously
1369 #$cf::WAIT_FOR_TICK->wait; 1836 #$cf::WAIT_FOR_TICK->wait;
1370 $map->reset; 1837 $map->reset;
1371 undef $guard; 1838 undef $guard;
1372 return find $path; 1839 return find $path;
1380sub post_load { } 1847sub post_load { }
1381 1848
1382sub load { 1849sub load {
1383 my ($self) = @_; 1850 my ($self) = @_;
1384 1851
1852 local $self->{deny_reset} = 1; # loading can take a long time
1853
1385 my $path = $self->{path}; 1854 my $path = $self->{path};
1855
1856 {
1857 my $guard1 = cf::lock_acquire "map_data:$path";
1386 my $guard = cf::lock_acquire "map_load:$path"; 1858 my $guard2 = cf::lock_acquire "map_load:$path";
1387 1859
1388 return if $self->in_memory != cf::MAP_SWAPPED; 1860 return if $self->in_memory != cf::MAP_SWAPPED;
1389 1861
1390 $self->in_memory (cf::MAP_LOADING); 1862 $self->in_memory (cf::MAP_LOADING);
1391 1863
1392 $self->alloc; 1864 $self->alloc;
1393 1865
1394 $self->pre_load; 1866 $self->pre_load;
1867 cf::cede_to_tick;
1395 1868
1396 $self->_load_objects ($self->{load_path}, 1) 1869 $self->_load_objects ($self->{load_path}, 1)
1397 or return; 1870 or return;
1398 1871
1399 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1872 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1400 if delete $self->{load_original}; 1873 if delete $self->{load_original};
1401 1874
1402 if (my $uniq = $self->uniq_path) { 1875 if (my $uniq = $self->uniq_path) {
1403 utf8::encode $uniq; 1876 utf8::encode $uniq;
1404 if (aio_open $uniq, O_RDONLY, 0) { 1877 if (aio_open $uniq, O_RDONLY, 0) {
1405 $self->clear_unique_items; 1878 $self->clear_unique_items;
1406 $self->_load_objects ($uniq, 0); 1879 $self->_load_objects ($uniq, 0);
1407 } 1880 }
1408 } 1881 }
1409 1882
1410 Coro::cede; 1883 cf::cede_to_tick;
1411
1412 # now do the right thing for maps 1884 # now do the right thing for maps
1413 $self->link_multipart_objects; 1885 $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) 1886 $self->difficulty ($self->estimate_difficulty)
1422 unless $self->difficulty; 1887 unless $self->difficulty;
1423 Coro::cede; 1888 cf::cede_to_tick;
1889
1890 unless ($self->{deny_activate}) {
1891 $self->decay_objects;
1892 $self->fix_auto_apply;
1893 $self->update_buttons;
1894 cf::cede_to_tick;
1895 $self->set_darkness_map;
1896 cf::cede_to_tick;
1424 $self->activate; 1897 $self->activate;
1898 }
1899
1900 $self->{last_save} = $cf::RUNTIME;
1901 $self->last_access ($cf::RUNTIME);
1902
1903 $self->in_memory (cf::MAP_IN_MEMORY);
1425 } 1904 }
1426 1905
1427 $self->post_load; 1906 $self->post_load;
1428
1429 $self->in_memory (cf::MAP_IN_MEMORY);
1430} 1907}
1431 1908
1432sub customise_for { 1909sub customise_for {
1433 my ($self, $ob) = @_; 1910 my ($self, $ob) = @_;
1434 1911
1435 return find "~" . $ob->name . "/" . $self->{path} 1912 return find "~" . $ob->name . "/" . $self->{path}
1436 if $self->per_player; 1913 if $self->per_player;
1437 1914
1915# return find "?party/" . $ob->name . "/" . $self->{path}
1916# if $self->per_party;
1917
1438 $self 1918 $self
1439} 1919}
1440 1920
1441# find and load all maps in the 3x3 area around a map 1921# find and load all maps in the 3x3 area around a map
1442sub load_diag { 1922sub load_neighbours {
1443 my ($map) = @_; 1923 my ($map) = @_;
1444 1924
1445 my @diag; # diagonal neighbours 1925 my @neigh; # diagonal neighbours
1446 1926
1447 for (0 .. 3) { 1927 for (0 .. 3) {
1448 my $neigh = $map->tile_path ($_) 1928 my $neigh = $map->tile_path ($_)
1449 or next; 1929 or next;
1450 $neigh = find $neigh, $map 1930 $neigh = find $neigh, $map
1451 or next; 1931 or next;
1452 $neigh->load; 1932 $neigh->load;
1453 1933
1934 push @neigh,
1454 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1935 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1455 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1936 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1456 } 1937 }
1457 1938
1458 for (@diag) { 1939 for (grep defined $_->[0], @neigh) {
1940 my ($path, $origin) = @$_;
1459 my $neigh = find @$_ 1941 my $neigh = find $path, $origin
1460 or next; 1942 or next;
1461 $neigh->load; 1943 $neigh->load;
1462 } 1944 }
1463} 1945}
1464 1946
1469} 1951}
1470 1952
1471sub do_load_sync { 1953sub do_load_sync {
1472 my ($map) = @_; 1954 my ($map) = @_;
1473 1955
1956 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1957 if $Coro::current == $Coro::main;
1958
1474 cf::sync_job { $map->load }; 1959 cf::sync_job { $map->load };
1475} 1960}
1476 1961
1477our %MAP_PREFETCH; 1962our %MAP_PREFETCH;
1478our $MAP_PREFETCHER = undef; 1963our $MAP_PREFETCHER = undef;
1479 1964
1480sub find_async { 1965sub find_async {
1481 my ($path, $origin) = @_; 1966 my ($path, $origin, $load) = @_;
1482 1967
1483 $path = normalise $path, $origin && $origin->{path}; 1968 $path = normalise $path, $origin && $origin->{path};
1484 1969
1485 if (my $map = $cf::MAP{$path}) { 1970 if (my $map = $cf::MAP{$path}) {
1486 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1971 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1487 } 1972 }
1488 1973
1489 undef $MAP_PREFETCH{$path}; 1974 $MAP_PREFETCH{$path} |= $load;
1975
1490 $MAP_PREFETCHER ||= cf::async { 1976 $MAP_PREFETCHER ||= cf::async {
1491 while (%MAP_PREFETCH) { 1977 while (%MAP_PREFETCH) {
1492 for my $path (keys %MAP_PREFETCH) { 1978 while (my ($k, $v) = each %MAP_PREFETCH) {
1493 my $map = find $path 1979 if (my $map = find $k) {
1494 or next;
1495 $map->load; 1980 $map->load if $v;
1981 }
1496 1982
1497 delete $MAP_PREFETCH{$path}; 1983 delete $MAP_PREFETCH{$k};
1498 } 1984 }
1499 } 1985 }
1500 undef $MAP_PREFETCHER; 1986 undef $MAP_PREFETCHER;
1501 }; 1987 };
1502 $MAP_PREFETCHER->prio (6); 1988 $MAP_PREFETCHER->prio (6);
1505} 1991}
1506 1992
1507sub save { 1993sub save {
1508 my ($self) = @_; 1994 my ($self) = @_;
1509 1995
1510 my $lock = cf::lock_acquire "map_data:" . $self->path; 1996 my $lock = cf::lock_acquire "map_data:$self->{path}";
1511 1997
1512 $self->{last_save} = $cf::RUNTIME; 1998 $self->{last_save} = $cf::RUNTIME;
1513 1999
1514 return unless $self->dirty; 2000 return unless $self->dirty;
1515 2001
1538 my ($self) = @_; 2024 my ($self) = @_;
1539 2025
1540 # save first because save cedes 2026 # save first because save cedes
1541 $self->save; 2027 $self->save;
1542 2028
1543 my $lock = cf::lock_acquire "map_data:" . $self->path; 2029 my $lock = cf::lock_acquire "map_data:$self->{path}";
1544 2030
1545 return if $self->players; 2031 return if $self->players;
1546 return if $self->in_memory != cf::MAP_IN_MEMORY; 2032 return if $self->in_memory != cf::MAP_IN_MEMORY;
1547 return if $self->{deny_save}; 2033 return if $self->{deny_save};
1548 2034
1552 2038
1553sub reset_at { 2039sub reset_at {
1554 my ($self) = @_; 2040 my ($self) = @_;
1555 2041
1556 # TODO: safety, remove and allow resettable per-player maps 2042 # 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}; 2043 return 1e99 if $self->{deny_reset};
1559 2044
1560 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2045 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1561 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2046 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1562 2047
1573 my ($self) = @_; 2058 my ($self) = @_;
1574 2059
1575 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
1576 2061
1577 return if $self->players; 2062 return if $self->players;
1578 return if $self->isa ("ext::map_per_player");#d#
1579 2063
1580 warn "resetting map ", $self->path;#d# 2064 warn "resetting map ", $self->path;
2065
2066 $self->in_memory (cf::MAP_SWAPPED);
2067
2068 # need to save uniques path
2069 unless ($self->{deny_save}) {
2070 my $uniq = $self->uniq_path; utf8::encode $uniq;
2071
2072 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2073 if $uniq;
2074 }
1581 2075
1582 delete $cf::MAP{$self->path}; 2076 delete $cf::MAP{$self->path};
1583 2077
1584 $self->in_memory (cf::MAP_SWAPPED);
1585 $self->clear; 2078 $self->clear;
1586 2079
1587 $_->clear_links_to ($self) for values %cf::MAP; 2080 $_->clear_links_to ($self) for values %cf::MAP;
1588 2081
1589 $self->unlink_save; 2082 $self->unlink_save;
1593my $nuke_counter = "aaaa"; 2086my $nuke_counter = "aaaa";
1594 2087
1595sub nuke { 2088sub nuke {
1596 my ($self) = @_; 2089 my ($self) = @_;
1597 2090
2091 {
2092 my $lock = cf::lock_acquire "map_data:$self->{path}";
2093
1598 delete $cf::MAP{$self->path}; 2094 delete $cf::MAP{$self->path};
1599 2095
1600 $self->unlink_save;
1601
1602 bless $self, "cf::map"; 2096 bless $self, "cf::map";
1603 delete $self->{deny_reset}; 2097 delete $self->{deny_reset};
1604 $self->{deny_save} = 1; 2098 $self->{deny_save} = 1;
1605 $self->reset_timeout (1); 2099 $self->reset_timeout (1);
1606 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2100 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1607 2101
2102 $self->unlink_save;
2103
1608 $cf::MAP{$self->path} = $self; 2104 $cf::MAP{$self->path} = $self;
2105 }
1609 2106
1610 $self->reset; # polite request, might not happen 2107 $self->reset; # polite request, might not happen
2108}
2109
2110=item $maps = cf::map::tmp_maps
2111
2112Returns an arrayref with all map paths of currently instantiated and saved
2113maps. May block.
2114
2115=cut
2116
2117sub tmp_maps() {
2118 [
2119 map {
2120 utf8::decode $_;
2121 /\.map$/
2122 ? normalise $_
2123 : ()
2124 } @{ aio_readdir $TMPDIR or [] }
2125 ]
2126}
2127
2128=item $maps = cf::map::random_maps
2129
2130Returns an arrayref with all map paths of currently instantiated and saved
2131random maps. May block.
2132
2133=cut
2134
2135sub random_maps() {
2136 [
2137 map {
2138 utf8::decode $_;
2139 /\.map$/
2140 ? normalise "?random/$_"
2141 : ()
2142 } @{ aio_readdir $RANDOMDIR or [] }
2143 ]
1611} 2144}
1612 2145
1613=item cf::map::unique_maps 2146=item cf::map::unique_maps
1614 2147
1615Returns an arrayref of paths of all shared maps that have 2148Returns an arrayref of paths of all shared maps that have
1616instantiated unique items. May block. 2149instantiated unique items. May block.
1617 2150
1618=cut 2151=cut
1619 2152
1620sub unique_maps() { 2153sub unique_maps() {
1621 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2154 [
1622 or return; 2155 map {
1623
1624 my @paths;
1625
1626 for (@$files) {
1627 utf8::decode $_; 2156 utf8::decode $_;
1628 next if /\.pst$/;
1629 next unless /^$PATH_SEP/o;
1630
1631 s/\.map$//; 2157 /\.map$/
1632 push @paths, $_; 2158 ? normalise $_
2159 : ()
2160 } @{ aio_readdir $UNIQUEDIR or [] }
1633 } 2161 ]
1634
1635 \@paths
1636} 2162}
1637 2163
1638package cf; 2164package cf;
1639 2165
1640=back 2166=back
1686 2212
1687 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2213 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1688 2214
1689 if ($self->{record_replies}) { 2215 if ($self->{record_replies}) {
1690 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2216 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2217
1691 } else { 2218 } else {
2219 my $pl = $self->contr;
2220
2221 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2222 my $dialog = $pl->{npc_dialog};
2223 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2224
2225 } else {
1692 $msg = $npc->name . " says: $msg" if $npc; 2226 $msg = $npc->name . " says: $msg" if $npc;
1693 $self->message ($msg, $flags); 2227 $self->message ($msg, $flags);
2228 }
1694 } 2229 }
2230}
2231
2232=item $object->send_msg ($channel, $msg, $color, [extra...])
2233
2234=cut
2235
2236sub cf::object::send_msg {
2237 my $pl = shift->contr
2238 or return;
2239 $pl->send_msg (@_);
1695} 2240}
1696 2241
1697=item $player_object->may ("access") 2242=item $player_object->may ("access")
1698 2243
1699Returns wether the given player is authorized to access resource "access" 2244Returns wether the given player is authorized to access resource "access"
1731=cut 2276=cut
1732 2277
1733sub link_map { 2278sub link_map {
1734 unless ($LINK_MAP) { 2279 unless ($LINK_MAP) {
1735 $LINK_MAP = cf::map::find "{link}" 2280 $LINK_MAP = cf::map::find "{link}"
1736 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2281 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1737 $LINK_MAP->load; 2282 $LINK_MAP->load;
1738 } 2283 }
1739 2284
1740 $LINK_MAP 2285 $LINK_MAP
1741} 2286}
1746 $self->deactivate_recursive; 2291 $self->deactivate_recursive;
1747 2292
1748 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2293 return if UNIVERSAL::isa $self->map, "ext::map_link";
1749 2294
1750 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2295 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1751 if $self->map; 2296 if $self->map && $self->map->{path} ne "{link}";
1752 2297
1753 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2298 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1754} 2299}
1755 2300
1756sub cf::object::player::leave_link { 2301sub cf::object::player::leave_link {
1757 my ($self, $map, $x, $y) = @_; 2302 my ($self, $map, $x, $y) = @_;
2303
2304 return unless $self->contr->active;
1758 2305
1759 my $link_pos = delete $self->{_link_pos}; 2306 my $link_pos = delete $self->{_link_pos};
1760 2307
1761 unless ($map) { 2308 unless ($map) {
1762 # restore original map position 2309 # restore original map position
1776 # use -1 or undef as default coordinates, not 0, 0 2323 # use -1 or undef as default coordinates, not 0, 0
1777 ($x, $y) = ($map->enter_x, $map->enter_y) 2324 ($x, $y) = ($map->enter_x, $map->enter_y)
1778 if $x <=0 && $y <= 0; 2325 if $x <=0 && $y <= 0;
1779 2326
1780 $map->load; 2327 $map->load;
1781 $map->load_diag; 2328 $map->load_neighbours;
1782 2329
1783 return unless $self->contr->active; 2330 return unless $self->contr->active;
1784 $self->activate_recursive; 2331 $self->activate_recursive;
2332
2333 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1785 $self->enter_map ($map, $x, $y); 2334 $self->enter_map ($map, $x, $y);
1786} 2335}
1787 2336
1788cf::player->attach ( 2337=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1789 on_logout => sub {
1790 my ($pl) = @_;
1791 2338
1792 # abort map switching before logout 2339Moves the player to the given map-path and coordinates by first freezing
1793 if ($pl->ob->{_link_pos}) { 2340her, loading and preparing them map, calling the provided $check callback
1794 cf::sync_job { 2341that has to return the map if sucecssful, and then unfreezes the player on
1795 $pl->ob->leave_link 2342the new (success) or old (failed) map position. In either case, $done will
1796 }; 2343be called at the end of this process.
1797 }
1798 },
1799 on_login => sub {
1800 my ($pl) = @_;
1801 2344
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 2345=cut
2346
2347our $GOTOGEN;
1823 2348
1824sub cf::object::player::goto { 2349sub cf::object::player::goto {
1825 my ($self, $path, $x, $y) = @_; 2350 my ($self, $path, $x, $y, $check, $done) = @_;
2351
2352 # do generation counting so two concurrent goto's will be executed in-order
2353 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1826 2354
1827 $self->enter_link; 2355 $self->enter_link;
1828 2356
1829 (async { 2357 (async {
2358 my $map = eval {
1830 my $map = cf::map::find $path; 2359 my $map = cf::map::find $path;
2360
2361 if ($map) {
1831 $map = $map->customise_for ($self) if $map; 2362 $map = $map->customise_for ($self);
1832 2363 $map = $check->($map) if $check && $map;
1833# warn "entering ", $map->path, " at ($x, $y)\n" 2364 } else {
1834# if $map;
1835
1836 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2365 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2366 }
1837 2367
2368 $map
2369 };
2370
2371 if ($@) {
2372 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2373 LOG llevError | logBacktrace, Carp::longmess $@;
2374 }
2375
2376 if ($gen == $self->{_goto_generation}) {
2377 delete $self->{_goto_generation};
1838 $self->leave_link ($map, $x, $y); 2378 $self->leave_link ($map, $x, $y);
2379 }
2380
2381 $done->() if $done;
1839 })->prio (1); 2382 })->prio (1);
1840} 2383}
1841 2384
1842=item $player_object->enter_exit ($exit_object) 2385=item $player_object->enter_exit ($exit_object)
1843 2386
1872 # that depends on the exit object 2415 # that depends on the exit object
1873 2416
1874 my $rmp = parse_random_map_params $exit->msg; 2417 my $rmp = parse_random_map_params $exit->msg;
1875 2418
1876 if ($exit->map) { 2419 if ($exit->map) {
1877 $rmp->{region} = $exit->map->region_name; 2420 $rmp->{region} = $exit->region->name;
1878 $rmp->{origin_map} = $exit->map->path; 2421 $rmp->{origin_map} = $exit->map->path;
1879 $rmp->{origin_x} = $exit->x; 2422 $rmp->{origin_x} = $exit->x;
1880 $rmp->{origin_y} = $exit->y; 2423 $rmp->{origin_y} = $exit->y;
1881 } 2424 }
1882 2425
1883 $rmp->{random_seed} ||= $exit->random_seed; 2426 $rmp->{random_seed} ||= $exit->random_seed;
1884 2427
1885 my $data = cf::to_json $rmp; 2428 my $data = cf::to_json $rmp;
1886 my $md5 = Digest::MD5::md5_hex $data; 2429 my $md5 = Digest::MD5::md5_hex $data;
1887 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2430 my $meta = "$RANDOMDIR/$md5.meta";
1888 2431
1889 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2432 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1890 aio_write $fh, 0, (length $data), $data, 0; 2433 aio_write $fh, 0, (length $data), $data, 0;
1891 undef $fh; 2434 undef $fh;
1892 aio_rename "$meta~", $meta; 2435 aio_rename "$meta~", $meta;
1899sub cf::object::player::enter_exit { 2442sub cf::object::player::enter_exit {
1900 my ($self, $exit) = @_; 2443 my ($self, $exit) = @_;
1901 2444
1902 return unless $self->type == cf::PLAYER; 2445 return unless $self->type == cf::PLAYER;
1903 2446
2447 if ($exit->slaying eq "/!") {
2448 #TODO: this should de-fi-ni-te-ly not be a sync-job
2449 # the problem is that $exit might not survive long enough
2450 # so it needs to be done right now, right here
2451 cf::sync_job { prepare_random_map $exit };
2452 }
2453
2454 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2455 my $hp = $exit->stats->hp;
2456 my $sp = $exit->stats->sp;
2457
1904 $self->enter_link; 2458 $self->enter_link;
2459
2460 # if exit is damned, update players death & WoR home-position
2461 $self->contr->savebed ($slaying, $hp, $sp)
2462 if $exit->flag (FLAG_DAMNED);
1905 2463
1906 (async { 2464 (async {
1907 $self->deactivate_recursive; # just to be sure 2465 $self->deactivate_recursive; # just to be sure
1908 unless (eval { 2466 unless (eval {
1909 prepare_random_map $exit 2467 $self->goto ($slaying, $hp, $sp);
1910 if $exit->slaying eq "/!";
1911
1912 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1913 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1914 2468
1915 1; 2469 1;
1916 }) { 2470 }) {
1917 $self->message ("Something went wrong deep within the crossfire server. " 2471 $self->message ("Something went wrong deep within the crossfire server. "
1918 . "I'll try to bring you back to the map you were before. " 2472 . "I'll try to bring you back to the map you were before. "
1919 . "Please report this to the dungeon master!", 2473 . "Please report this to the dungeon master!",
1920 cf::NDI_UNIQUE | cf::NDI_RED); 2474 cf::NDI_UNIQUE | cf::NDI_RED);
1921 2475
1922 warn "ERROR in enter_exit: $@"; 2476 warn "ERROR in enter_exit: $@";
1923 $self->leave_link; 2477 $self->leave_link;
1924 } 2478 }
1925 })->prio (1); 2479 })->prio (1);
1938 2492
1939sub cf::client::send_drawinfo { 2493sub cf::client::send_drawinfo {
1940 my ($self, $text, $flags) = @_; 2494 my ($self, $text, $flags) = @_;
1941 2495
1942 utf8::encode $text; 2496 utf8::encode $text;
1943 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2497 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1944} 2498}
1945 2499
2500=item $client->send_msg ($channel, $msg, $color, [extra...])
2501
2502Send a drawinfo or msg packet to the client, formatting the msg for the
2503client if neccessary. C<$type> should be a string identifying the type of
2504the message, with C<log> being the default. If C<$color> is negative, suppress
2505the message unless the client supports the msg packet.
2506
2507=cut
2508
2509our %CHANNEL = (
2510 "c/identify" => {
2511 id => "identify",
2512 title => "Identify",
2513 reply => undef,
2514 tooltip => "Items recently identified",
2515 },
2516);
2517
2518sub cf::client::send_msg {
2519 my ($self, $channel, $msg, $color, @extra) = @_;
2520
2521 $msg = $self->pl->expand_cfpod ($msg);
2522
2523 $color &= cf::NDI_CLIENT_MASK; # just in case...
2524
2525 # check predefined channels, for the benefit of C
2526 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2527
2528 if (ref $channel) {
2529 # send meta info to client, if not yet sent
2530 unless (exists $self->{channel}{$channel->{id}}) {
2531 $self->{channel}{$channel->{id}} = $channel;
2532 $self->ext_msg (channel_info => $channel);
2533 }
2534
2535 $channel = $channel->{id};
2536 }
2537
2538 return unless @extra || length $msg;
2539
2540 if ($self->can_msg) {
2541 # default colour, mask it out
2542 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2543 if $color & cf::NDI_DEF;
2544
2545 $self->send_packet ("msg " . $self->{json_coder}->encode (
2546 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2547 } else {
2548 if ($color >= 0) {
2549 # replace some tags by gcfclient-compatible ones
2550 for ($msg) {
2551 1 while
2552 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2553 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2554 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2555 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2556 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2557 }
2558
2559 $color &= cf::NDI_COLOR_MASK;
2560
2561 utf8::encode $msg;
2562
2563 if (0 && $msg =~ /\[/) {
2564 # COMMAND/INFO
2565 $self->send_packet ("drawextinfo $color 10 8 $msg")
2566 } else {
2567 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2568 $self->send_packet ("drawinfo $color $msg")
2569 }
2570 }
2571 }
2572}
2573
2574=item $client->ext_msg ($type, @msg)
2575
2576Sends an ext event to the client.
2577
2578=cut
2579
2580sub cf::client::ext_msg($$@) {
2581 my ($self, $type, @msg) = @_;
2582
2583 if ($self->extcmd == 2) {
2584 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2585 } elsif ($self->extcmd == 1) { # TODO: remove
2586 push @msg, msgtype => "event_$type";
2587 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2588 }
2589}
2590
2591=item $client->ext_reply ($msgid, @msg)
2592
2593Sends an ext reply to the client.
2594
2595=cut
2596
2597sub cf::client::ext_reply($$@) {
2598 my ($self, $id, @msg) = @_;
2599
2600 if ($self->extcmd == 2) {
2601 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2602 } elsif ($self->extcmd == 1) {
2603 #TODO: version 1, remove
2604 unshift @msg, msgtype => "reply", msgid => $id;
2605 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2606 }
2607}
1946 2608
1947=item $success = $client->query ($flags, "text", \&cb) 2609=item $success = $client->query ($flags, "text", \&cb)
1948 2610
1949Queues a query to the client, calling the given callback with 2611Queues a query to the client, calling the given callback with
1950the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2612the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1951C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2613C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1952 2614
1953Queries can fail, so check the return code. Or don't, as queries will become 2615Queries can fail, so check the return code. Or don't, as queries will
1954reliable at some point in the future. 2616become reliable at some point in the future.
1955 2617
1956=cut 2618=cut
1957 2619
1958sub cf::client::query { 2620sub cf::client::query {
1959 my ($self, $flags, $text, $cb) = @_; 2621 my ($self, $flags, $text, $cb) = @_;
1967 utf8::encode $text; 2629 utf8::encode $text;
1968 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2630 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1969 2631
1970 $self->send_packet ($self->{query_queue}[0][0]) 2632 $self->send_packet ($self->{query_queue}[0][0])
1971 if @{ $self->{query_queue} } == 1; 2633 if @{ $self->{query_queue} } == 1;
2634
2635 1
1972} 2636}
1973 2637
1974cf::client->attach ( 2638cf::client->attach (
2639 on_connect => sub {
2640 my ($ns) = @_;
2641
2642 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2643 },
1975 on_reply => sub { 2644 on_reply => sub {
1976 my ($ns, $msg) = @_; 2645 my ($ns, $msg) = @_;
1977 2646
1978 # this weird shuffling is so that direct followup queries 2647 # this weird shuffling is so that direct followup queries
1979 # get handled first 2648 # get handled first
1980 my $queue = delete $ns->{query_queue} 2649 my $queue = delete $ns->{query_queue}
1981 or return; # be conservative, not sure how that can happen, but we saw a crash here 2650 or return; # be conservative, not sure how that can happen, but we saw a crash here
1982 2651
1983 (shift @$queue)->[1]->($msg); 2652 (shift @$queue)->[1]->($msg);
2653 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1984 2654
1985 push @{ $ns->{query_queue} }, @$queue; 2655 push @{ $ns->{query_queue} }, @$queue;
1986 2656
1987 if (@{ $ns->{query_queue} } == @$queue) { 2657 if (@{ $ns->{query_queue} } == @$queue) {
1988 if (@$queue) { 2658 if (@$queue) {
1990 } else { 2660 } else {
1991 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2661 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1992 } 2662 }
1993 } 2663 }
1994 }, 2664 },
2665 on_exticmd => sub {
2666 my ($ns, $buf) = @_;
2667
2668 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2669
2670 if (ref $msg) {
2671 my ($type, $reply, @payload) =
2672 "ARRAY" eq ref $msg
2673 ? @$msg
2674 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2675
2676 my @reply;
2677
2678 if (my $cb = $EXTICMD{$type}) {
2679 @reply = $cb->($ns, @payload);
2680 }
2681
2682 $ns->ext_reply ($reply, @reply)
2683 if $reply;
2684
2685 } else {
2686 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2687 }
2688
2689 cf::override;
2690 },
1995); 2691);
1996 2692
1997=item $client->async (\&cb) 2693=item $client->async (\&cb)
1998 2694
1999Create a new coroutine, running the specified callback. The coroutine will 2695Create a new coroutine, running the specified callback. The coroutine will
2040our $safe = new Safe "safe"; 2736our $safe = new Safe "safe";
2041our $safe_hole = new Safe::Hole; 2737our $safe_hole = new Safe::Hole;
2042 2738
2043$SIG{FPE} = 'IGNORE'; 2739$SIG{FPE} = 'IGNORE';
2044 2740
2045$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2741$safe->permit_only (Opcode::opset qw(
2742 :base_core :base_mem :base_orig :base_math
2743 grepstart grepwhile mapstart mapwhile
2744 sort time
2745));
2046 2746
2047# here we export the classes and methods available to script code 2747# here we export the classes and methods available to script code
2048 2748
2049=pod 2749=pod
2050 2750
2051The following fucntions and emthods are available within a safe environment: 2751The following functions and methods are available within a safe environment:
2052 2752
2053 cf::object contr pay_amount pay_player map 2753 cf::object
2754 contr pay_amount pay_player map x y force_find force_add
2755 insert remove name archname title slaying race decrease_ob_nr
2756
2054 cf::object::player player 2757 cf::object::player
2055 cf::player peaceful 2758 player
2056 cf::map trigger 2759
2760 cf::player
2761 peaceful
2762
2763 cf::map
2764 trigger
2057 2765
2058=cut 2766=cut
2059 2767
2060for ( 2768for (
2061 ["cf::object" => qw(contr pay_amount pay_player map)], 2769 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2770 insert remove inv name archname title slaying race
2771 decrease_ob_nr)],
2062 ["cf::object::player" => qw(player)], 2772 ["cf::object::player" => qw(player)],
2063 ["cf::player" => qw(peaceful)], 2773 ["cf::player" => qw(peaceful)],
2064 ["cf::map" => qw(trigger)], 2774 ["cf::map" => qw(trigger)],
2065) { 2775) {
2066 no strict 'refs'; 2776 no strict 'refs';
2137=back 2847=back
2138 2848
2139=cut 2849=cut
2140 2850
2141############################################################################# 2851#############################################################################
2852# the server's init and main functions
2142 2853
2143=head2 EXTENSION DATABASE SUPPORT 2854sub load_facedata($) {
2855 my ($path) = @_;
2144 2856
2145Crossfire maintains a very simple database for extension use. It can 2857 # HACK to clear player env face cache, we need some signal framework
2146currently store anything that can be serialised using Storable, which 2858 # for this (global event?)
2147excludes objects. 2859 %ext::player_env::MUSIC_FACE_CACHE = ();
2148 2860
2149The parameter C<$family> should best start with the name of the extension 2861 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2150using it, it should be unique.
2151 2862
2152=over 4 2863 warn "loading facedata from $path\n";
2153 2864
2154=item $hashref = cf::db_get $family 2865 my $facedata;
2866 0 < aio_load $path, $facedata
2867 or die "$path: $!";
2155 2868
2156Return a hashref for use by the extension C<$family>, which can be 2869 $facedata = Coro::Storable::thaw $facedata;
2157modified. After modifications, you have to call C<cf::db_dirty> or
2158C<cf::db_sync>.
2159 2870
2160=item $value = cf::db_get $family => $key 2871 $facedata->{version} == 2
2872 or cf::cleanup "$path: version mismatch, cannot proceed.";
2161 2873
2162Returns a single value from the database 2874 # patch in the exptable
2163 2875 $facedata->{resource}{"res/exp_table"} = {
2164=item cf::db_put $family => $hashref 2876 type => FT_RSRC,
2165 2877 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2166Stores the given family hashref into the database. Updates are delayed, if
2167you want the data to be synced to disk immediately, use C<cf::db_sync>.
2168
2169=item cf::db_put $family => $key => $value
2170
2171Stores the given C<$value> in the family hash. Updates are delayed, if you
2172want the data to be synced to disk immediately, use C<cf::db_sync>.
2173
2174=item cf::db_dirty
2175
2176Marks the database as dirty, to be updated at a later time.
2177
2178=item cf::db_sync
2179
2180Immediately write the database to disk I<if it is dirty>.
2181
2182=cut
2183
2184our $DB;
2185
2186{
2187 my $path = cf::localdir . "/database.pst";
2188
2189 sub db_load() {
2190 $DB = stat $path ? Storable::retrieve $path : { };
2191 } 2878 };
2879 cf::cede_to_tick;
2192 2880
2193 my $pid;
2194
2195 sub db_save() {
2196 waitpid $pid, 0 if $pid;
2197 if (0 == ($pid = fork)) {
2198 $DB->{_meta}{version} = 1;
2199 Storable::nstore $DB, "$path~";
2200 rename "$path~", $path;
2201 cf::_exit 0 if defined $pid;
2202 }
2203 } 2881 {
2882 my $faces = $facedata->{faceinfo};
2204 2883
2205 my $dirty; 2884 while (my ($face, $info) = each %$faces) {
2885 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2886 cf::face::set_visibility $idx, $info->{visibility};
2887 cf::face::set_magicmap $idx, $info->{magicmap};
2888 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2889 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2206 2890
2207 sub db_sync() { 2891 cf::cede_to_tick;
2208 db_save if $dirty;
2209 undef $dirty;
2210 }
2211
2212 my $idle = Event->idle (
2213 reentrant => 0,
2214 min => 10,
2215 max => 20,
2216 repeat => 0,
2217 data => WF_AUTOCANCEL,
2218 cb => \&db_sync,
2219 );
2220
2221 sub db_dirty() {
2222 $dirty = 1;
2223 $idle->start;
2224 }
2225
2226 sub db_get($;$) {
2227 @_ >= 2
2228 ? $DB->{$_[0]}{$_[1]}
2229 : ($DB->{$_[0]} ||= { })
2230 }
2231
2232 sub db_put($$;$) {
2233 if (@_ >= 3) {
2234 $DB->{$_[0]}{$_[1]} = $_[2];
2235 } else {
2236 $DB->{$_[0]} = $_[1];
2237 }
2238 db_dirty;
2239 }
2240
2241 cf::global->attach (
2242 prio => 10000,
2243 on_cleanup => sub {
2244 db_sync;
2245 }, 2892 }
2246 );
2247}
2248 2893
2249############################################################################# 2894 while (my ($face, $info) = each %$faces) {
2250# the server's main() 2895 next unless $info->{smooth};
2896 my $idx = cf::face::find $face
2897 or next;
2898 if (my $smooth = cf::face::find $info->{smooth}) {
2899 cf::face::set_smooth $idx, $smooth;
2900 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2901 } else {
2902 warn "smooth face '$info->{smooth}' not found for face '$face'";
2903 }
2251 2904
2252sub cfg_load { 2905 cf::cede_to_tick;
2906 }
2907 }
2908
2909 {
2910 my $anims = $facedata->{animinfo};
2911
2912 while (my ($anim, $info) = each %$anims) {
2913 cf::anim::set $anim, $info->{frames}, $info->{facings};
2914 cf::cede_to_tick;
2915 }
2916
2917 cf::anim::invalidate_all; # d'oh
2918 }
2919
2920 {
2921 # TODO: for gcfclient pleasure, we should give resources
2922 # that gcfclient doesn't grok a >10000 face index.
2923 my $res = $facedata->{resource};
2924
2925 my $soundconf = delete $res->{"res/sound.conf"};
2926
2927 while (my ($name, $info) = each %$res) {
2928 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2929 my $data;
2930
2931 if ($info->{type} & 1) {
2932 # prepend meta info
2933
2934 my $meta = $enc->encode ({
2935 name => $name,
2936 %{ $info->{meta} || {} },
2937 });
2938
2939 $data = pack "(w/a*)*", $meta, $info->{data};
2940 } else {
2941 $data = $info->{data};
2942 }
2943
2944 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2945 cf::face::set_type $idx, $info->{type};
2946
2947 cf::cede_to_tick;
2948 }
2949
2950 if ($soundconf) {
2951 $soundconf = $enc->decode (delete $soundconf->{data});
2952
2953 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2954 my $sound = $soundconf->{compat}[$_]
2955 or next;
2956
2957 my $face = cf::face::find "sound/$sound->[1]";
2958 cf::sound::set $sound->[0] => $face;
2959 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2960 }
2961
2962 while (my ($k, $v) = each %{$soundconf->{event}}) {
2963 my $face = cf::face::find "sound/$v";
2964 cf::sound::set $k => $face;
2965 }
2966 }
2967 }
2968
2969 1
2970}
2971
2972register_exticmd fx_want => sub {
2973 my ($ns, $want) = @_;
2974
2975 while (my ($k, $v) = each %$want) {
2976 $ns->fx_want ($k, $v);
2977 }
2978};
2979
2980sub reload_regions {
2981 # HACK to clear player env face cache, we need some signal framework
2982 # for this (global event?)
2983 %ext::player_env::MUSIC_FACE_CACHE = ();
2984
2985 load_resource_file "$MAPDIR/regions"
2986 or die "unable to load regions file\n";
2987
2988 for (cf::region::list) {
2989 $_->{match} = qr/$_->{match}/
2990 if exists $_->{match};
2991 }
2992}
2993
2994sub reload_facedata {
2995 load_facedata "$DATADIR/facedata"
2996 or die "unable to load facedata\n";
2997}
2998
2999sub reload_archetypes {
3000 load_resource_file "$DATADIR/archetypes"
3001 or die "unable to load archetypes\n";
3002 #d# NEED to laod twice to resolve forward references
3003 # this really needs to be done in an extra post-pass
3004 # (which needs to be synchronous, so solve it differently)
3005 load_resource_file "$DATADIR/archetypes"
3006 or die "unable to load archetypes\n";
3007}
3008
3009sub reload_treasures {
3010 load_resource_file "$DATADIR/treasures"
3011 or die "unable to load treasurelists\n";
3012}
3013
3014sub reload_resources {
3015 warn "reloading resource files...\n";
3016
3017 reload_regions;
3018 reload_facedata;
3019 #reload_archetypes;#d#
3020 reload_archetypes;
3021 reload_treasures;
3022
3023 warn "finished reloading resource files\n";
3024}
3025
3026sub init {
3027 reload_resources;
3028}
3029
3030sub reload_config {
2253 open my $fh, "<:utf8", cf::confdir . "/config" 3031 open my $fh, "<:utf8", "$CONFDIR/config"
2254 or return; 3032 or return;
2255 3033
2256 local $/; 3034 local $/;
2257 *CFG = YAML::Syck::Load <$fh>; 3035 *CFG = YAML::Syck::Load <$fh>;
2258 3036
2277 (async { 3055 (async {
2278 Event::one_event; 3056 Event::one_event;
2279 })->prio (Coro::PRIO_MAX); 3057 })->prio (Coro::PRIO_MAX);
2280 }; 3058 };
2281 3059
2282 cfg_load; 3060 reload_config;
2283 db_load; 3061 db_init;
2284 load_extensions; 3062 load_extensions;
2285 3063
2286 $TICK_WATCHER->start; 3064 $TICK_WATCHER->start;
2287 Event::loop; 3065 Event::loop;
2288} 3066}
2303 }, 3081 },
2304 ); 3082 );
2305 } 3083 }
2306} 3084}
2307 3085
3086sub write_runtime {
3087 my $runtime = "$LOCALDIR/runtime";
3088
3089 # first touch the runtime file to show we are still running:
3090 # the fsync below can take a very very long time.
3091
3092 IO::AIO::aio_utime $runtime, undef, undef;
3093
3094 my $guard = cf::lock_acquire "write_runtime";
3095
3096 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3097 or return;
3098
3099 my $value = $cf::RUNTIME + 90 + 10;
3100 # 10 is the runtime save interval, for a monotonic clock
3101 # 60 allows for the watchdog to kill the server.
3102
3103 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3104 and return;
3105
3106 # always fsync - this file is important
3107 aio_fsync $fh
3108 and return;
3109
3110 # touch it again to show we are up-to-date
3111 aio_utime $fh, undef, undef;
3112
3113 close $fh
3114 or return;
3115
3116 aio_rename "$runtime~", $runtime
3117 and return;
3118
3119 warn "runtime file written.\n";
3120
3121 1
3122}
3123
2308sub emergency_save() { 3124sub emergency_save() {
2309 my $freeze_guard = cf::freeze_mainloop; 3125 my $freeze_guard = cf::freeze_mainloop;
2310 3126
2311 warn "enter emergency perl save\n"; 3127 warn "enter emergency perl save\n";
2312 3128
2327 my $map = $cf::MAP{$path} or next; 3143 my $map = $cf::MAP{$path} or next;
2328 $map->valid or next; 3144 $map->valid or next;
2329 $map->save; 3145 $map->save;
2330 } 3146 }
2331 warn "end emergency map save\n"; 3147 warn "end emergency map save\n";
3148
3149 warn "begin emergency database checkpoint\n";
3150 BDB::db_env_txn_checkpoint $DB_ENV;
3151 warn "end emergency database checkpoint\n";
2332 }; 3152 };
2333 3153
2334 warn "leave emergency perl save\n"; 3154 warn "leave emergency perl save\n";
2335} 3155}
2336 3156
3157sub post_cleanup {
3158 my ($make_core) = @_;
3159
3160 warn Carp::longmess "post_cleanup backtrace"
3161 if $make_core;
3162}
3163
2337sub reload() { 3164sub do_reload_perl() {
2338 # can/must only be called in main 3165 # can/must only be called in main
2339 if ($Coro::current != $Coro::main) { 3166 if ($Coro::current != $Coro::main) {
2340 warn "can only reload from main coroutine"; 3167 warn "can only reload from main coroutine";
2341 return; 3168 return;
2342 } 3169 }
2343 3170
2344 warn "reloading..."; 3171 warn "reloading...";
2345 3172
2346 warn "cancelling server ticker"; 3173 warn "entering sync_job";
2347 $TICK_WATCHER->cancel;
2348 3174
3175 cf::sync_job {
3176 cf::write_runtime; # external watchdog should not bark
2349 cf::emergency_save; 3177 cf::emergency_save;
3178 cf::write_runtime; # external watchdog should not bark
2350 3179
2351 eval { 3180 warn "syncing database to disk";
3181 BDB::db_env_txn_checkpoint $DB_ENV;
3182
2352 # if anything goes wrong in here, we should simply crash as we already saved 3183 # if anything goes wrong in here, we should simply crash as we already saved
2353
2354 warn "syncing database to disk";
2355 cf::db_sync;
2356 3184
2357 warn "cancelling all WF_AUTOCANCEL watchers"; 3185 warn "cancelling all WF_AUTOCANCEL watchers";
2358 for (Event::all_watchers) { 3186 for (Event::all_watchers) {
2359 $_->cancel if $_->data & WF_AUTOCANCEL; 3187 $_->cancel if $_->data & WF_AUTOCANCEL;
2360 } 3188 }
2361 3189
2362 warn "flushing outstanding aio requests"; 3190 warn "flushing outstanding aio requests";
2363 for (;;) { 3191 for (;;) {
3192 BDB::flush;
2364 IO::AIO::flush; 3193 IO::AIO::flush;
2365 Coro::cede; 3194 Coro::cede;
2366 last unless IO::AIO::nreqs; 3195 last unless IO::AIO::nreqs || BDB::nreqs;
2367 warn "iterate..."; 3196 warn "iterate...";
2368 } 3197 }
3198
3199 ++$RELOAD;
2369 3200
2370 warn "cancelling all extension coros"; 3201 warn "cancelling all extension coros";
2371 $_->cancel for values %EXT_CORO; 3202 $_->cancel for values %EXT_CORO;
2372 %EXT_CORO = (); 3203 %EXT_CORO = ();
2373 3204
2374 warn "removing commands"; 3205 warn "removing commands";
2375 %COMMAND = (); 3206 %COMMAND = ();
2376 3207
2377 warn "removing ext commands"; 3208 warn "removing ext/exti commands";
2378 %EXTCMD = (); 3209 %EXTCMD = ();
3210 %EXTICMD = ();
2379 3211
2380 warn "unloading/nuking all extensions"; 3212 warn "unloading/nuking all extensions";
2381 for my $pkg (@EXTS) { 3213 for my $pkg (@EXTS) {
2382 warn "... unloading $pkg"; 3214 warn "... unloading $pkg";
2383 3215
2413 Symbol::delete_package "safe::$_" 3245 Symbol::delete_package "safe::$_"
2414 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3246 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2415 3247
2416 warn "unloading cf.pm \"a bit\""; 3248 warn "unloading cf.pm \"a bit\"";
2417 delete $INC{"cf.pm"}; 3249 delete $INC{"cf.pm"};
3250 delete $INC{"cf/pod.pm"};
2418 3251
2419 # don't, removes xs symbols, too, 3252 # don't, removes xs symbols, too,
2420 # and global variables created in xs 3253 # and global variables created in xs
2421 #Symbol::delete_package __PACKAGE__; 3254 #Symbol::delete_package __PACKAGE__;
2422 3255
2425 warn "reloading cf.pm"; 3258 warn "reloading cf.pm";
2426 require cf; 3259 require cf;
2427 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3260 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2428 3261
2429 warn "loading config and database again"; 3262 warn "loading config and database again";
2430 cf::cfg_load; 3263 cf::reload_config;
2431 cf::db_load;
2432 3264
2433 warn "loading extensions"; 3265 warn "loading extensions";
2434 cf::load_extensions; 3266 cf::load_extensions;
2435 3267
2436 warn "reattaching attachments to objects/players"; 3268 warn "reattaching attachments to objects/players";
2437 _global_reattach; 3269 _global_reattach; # objects, sockets
2438 warn "reattaching attachments to maps"; 3270 warn "reattaching attachments to maps";
2439 reattach $_ for values %MAP; 3271 reattach $_ for values %MAP;
3272 warn "reattaching attachments to players";
3273 reattach $_ for values %PLAYER;
2440 3274
2441 warn "restarting server ticker"; 3275 warn "leaving sync_job";
2442 3276
2443 $TICK_WATCHER->start; 3277 1
2444 }; 3278 } or do {
2445
2446 if ($@) {
2447 warn $@; 3279 warn $@;
2448 warn "error while reloading, exiting."; 3280 warn "error while reloading, exiting.";
2449 exit 1; 3281 exit 1;
2450 } 3282 };
2451 3283
2452 warn "reloaded"; 3284 warn "reloaded";
2453}; 3285};
2454 3286
2455our $RELOAD_WATCHER; # used only during reload 3287our $RELOAD_WATCHER; # used only during reload
2456 3288
3289sub reload_perl() {
3290 # doing reload synchronously and two reloads happen back-to-back,
3291 # coro crashes during coro_state_free->destroy here.
3292
3293 $RELOAD_WATCHER ||= Event->timer (
3294 reentrant => 0,
3295 after => 0,
3296 data => WF_AUTOCANCEL,
3297 cb => sub {
3298 do_reload_perl;
3299 undef $RELOAD_WATCHER;
3300 },
3301 );
3302}
3303
2457register_command "reload" => sub { 3304register_command "reload" => sub {
2458 my ($who, $arg) = @_; 3305 my ($who, $arg) = @_;
2459 3306
2460 if ($who->flag (FLAG_WIZ)) { 3307 if ($who->flag (FLAG_WIZ)) {
2461 $who->message ("reloading server."); 3308 $who->message ("reloading server.");
2462 3309 async { reload_perl };
2463 # doing reload synchronously and two reloads happen back-to-back,
2464 # coro crashes during coro_state_free->destroy here.
2465
2466 $RELOAD_WATCHER ||= Event->timer (
2467 reentrant => 0,
2468 after => 0,
2469 data => WF_AUTOCANCEL,
2470 cb => sub {
2471 reload;
2472 undef $RELOAD_WATCHER;
2473 },
2474 );
2475 } 3310 }
2476}; 3311};
2477 3312
2478unshift @INC, $LIBDIR; 3313unshift @INC, $LIBDIR;
2479 3314
2480my $bug_warning = 0; 3315my $bug_warning = 0;
2481 3316
3317our @WAIT_FOR_TICK;
3318our @WAIT_FOR_TICK_BEGIN;
3319
3320sub wait_for_tick {
3321 return unless $TICK_WATCHER->is_active;
3322 return if $Coro::current == $Coro::main;
3323
3324 my $signal = new Coro::Signal;
3325 push @WAIT_FOR_TICK, $signal;
3326 $signal->wait;
3327}
3328
3329sub wait_for_tick_begin {
3330 return unless $TICK_WATCHER->is_active;
3331 return if $Coro::current == $Coro::main;
3332
3333 my $signal = new Coro::Signal;
3334 push @WAIT_FOR_TICK_BEGIN, $signal;
3335 $signal->wait;
3336}
3337
3338 my $min = 1e6;#d#
3339 my $avg = 10;
2482$TICK_WATCHER = Event->timer ( 3340$TICK_WATCHER = Event->timer (
2483 reentrant => 0, 3341 reentrant => 0,
2484 parked => 1, 3342 parked => 1,
2485 prio => 0, 3343 prio => 0,
2486 at => $NEXT_TICK || $TICK, 3344 at => $NEXT_TICK || $TICK,
2490 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3348 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2491 unless ++$bug_warning > 10; 3349 unless ++$bug_warning > 10;
2492 return; 3350 return;
2493 } 3351 }
2494 3352
2495 $NOW = Event::time; 3353 $NOW = $tick_start = Event::time;
2496 3354
2497 cf::server_tick; # one server iteration 3355 cf::server_tick; # one server iteration
3356
3357 0 && sync_job {#d#
3358 for(1..10) {
3359 my $t = Event::time;
3360 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3361 or die;
3362
3363 $map->width (50);
3364 $map->height (50);
3365 $map->alloc;
3366 $map->_load_objects ("/tmp/x.map", 1);
3367 my $t = Event::time - $t;
3368
3369 #next unless $t < 0.0013;#d#
3370 if ($t < $min) {
3371 $min = $t;
3372 }
3373 $avg = $avg * 0.99 + $t * 0.01;
3374 }
3375 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3376 exit 0;
3377 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3378 };
3379
2498 $RUNTIME += $TICK; 3380 $RUNTIME += $TICK;
2499 $NEXT_TICK += $TICK; 3381 $NEXT_TICK += $TICK;
2500 3382
2501 $WAIT_FOR_TICK->broadcast; 3383 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2502 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3384 $NEXT_RUNTIME_WRITE = $NOW + 10;
2503 3385 Coro::async_pool {
2504 Event::sweep; 3386 write_runtime
2505 Coro::cede_notself; 3387 or warn "ERROR: unable to write runtime file: $!";
3388 };
2506 3389 }
3390
2507# my $AFTER = Event::time; 3391# my $AFTER = Event::time;
2508# warn $AFTER - $NOW;#d# 3392# warn $AFTER - $NOW;#d#
2509 3393
3394 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3395 $sig->send;
3396 }
3397 while (my $sig = shift @WAIT_FOR_TICK) {
3398 $sig->send;
3399 }
3400
3401 $NOW = Event::time;
3402
2510 # if we are delayed by four ticks or more, skip them all 3403 # if we are delayed by four ticks or more, skip them all
2511 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3404 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2512 3405
2513 $TICK_WATCHER->at ($NEXT_TICK); 3406 $TICK_WATCHER->at ($NEXT_TICK);
2514 $TICK_WATCHER->start; 3407 $TICK_WATCHER->start;
3408
3409 $LOAD = ($NOW - $tick_start) / $TICK;
3410 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3411
3412 _post_tick;
3413
3414
2515 }, 3415 },
2516); 3416);
2517 3417
3418{
3419 BDB::max_poll_time $TICK * 0.1;
3420 $BDB_POLL_WATCHER = Event->io (
3421 reentrant => 0,
3422 fd => BDB::poll_fileno,
3423 poll => 'r',
3424 prio => 0,
3425 data => WF_AUTOCANCEL,
3426 cb => \&BDB::poll_cb,
3427 );
3428 BDB::min_parallel 8;
3429
3430 BDB::set_sync_prepare {
3431 my $status;
3432 my $current = $Coro::current;
3433 (
3434 sub {
3435 $status = $!;
3436 $current->ready; undef $current;
3437 },
3438 sub {
3439 Coro::schedule while defined $current;
3440 $! = $status;
3441 },
3442 )
3443 };
3444
3445 unless ($DB_ENV) {
3446 $DB_ENV = BDB::db_env_create;
3447
3448 cf::sync_job {
3449 eval {
3450 BDB::db_env_open
3451 $DB_ENV,
3452 $BDBDIR,
3453 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3454 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3455 0666;
3456
3457 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3458
3459 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3460 $DB_ENV->set_lk_detect;
3461 };
3462
3463 cf::cleanup "db_env_open(db): $@" if $@;
3464 };
3465 }
3466}
3467
3468{
3469 IO::AIO::min_parallel 8;
3470
3471 undef $Coro::AIO::WATCHER;
2518IO::AIO::max_poll_time $TICK * 0.1; 3472 IO::AIO::max_poll_time $TICK * 0.1;
2519
2520undef $Coro::AIO::WATCHER;
2521$AIO_POLL_WATCHER = Event->io ( 3473 $AIO_POLL_WATCHER = Event->io (
2522 reentrant => 0, 3474 reentrant => 0,
3475 data => WF_AUTOCANCEL,
2523 fd => IO::AIO::poll_fileno, 3476 fd => IO::AIO::poll_fileno,
2524 poll => 'r', 3477 poll => 'r',
2525 prio => 6, 3478 prio => 6,
2526 data => WF_AUTOCANCEL,
2527 cb => \&IO::AIO::poll_cb, 3479 cb => \&IO::AIO::poll_cb,
2528); 3480 );
3481}
2529 3482
2530$WRITE_RUNTIME_WATCHER = Event->timer ( 3483my $_log_backtrace;
2531 reentrant => 0, 3484
2532 data => WF_AUTOCANCEL, 3485sub _log_backtrace {
2533 after => 1, 3486 my ($msg, @addr) = @_;
2534 interval => 10, 3487
2535 prio => 6, # keep it lowest so it acts like a watchdog 3488 $msg =~ s/\n//;
2536 cb => Coro::unblock_sub { 3489
2537 write_runtime 3490 # limit the # of concurrent backtraces
2538 or warn "ERROR: unable to write runtime file: $!"; 3491 if ($_log_backtrace < 2) {
3492 ++$_log_backtrace;
3493 async {
3494 my @bt = fork_call {
3495 @addr = map { sprintf "%x", $_ } @addr;
3496 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3497 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3498 or die "addr2line: $!";
3499
3500 my @funcs;
3501 my @res = <$fh>;
3502 chomp for @res;
3503 while (@res) {
3504 my ($func, $line) = splice @res, 0, 2, ();
3505 push @funcs, "[$func] $line";
3506 }
3507
3508 @funcs
3509 };
3510
3511 LOG llevInfo, "[ABT] $msg\n";
3512 LOG llevInfo, "[ABT] $_\n" for @bt;
3513 --$_log_backtrace;
3514 };
3515 } else {
3516 LOG llevInfo, "[ABT] $msg\n";
3517 LOG llevInfo, "[ABT] [suppressed]\n";
2539 }, 3518 }
2540); 3519}
3520
3521# load additional modules
3522use cf::pod;
2541 3523
2542END { cf::emergency_save } 3524END { cf::emergency_save }
2543 3525
25441 35261
2545 3527

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines