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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines