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.199 by root, Mon Jan 29 14:46:01 2007 UTC vs.
Revision 1.354 by root, Sun Sep 2 12:26:54 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines