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.206 by root, Sun Feb 11 22:27:05 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 ();
20use BDB (); 27use BDB ();
21use Data::Dumper; 28use Data::Dumper;
22use Digest::MD5; 29use Digest::MD5;
23use Fcntl; 30use Fcntl;
31use YAML::Syck ();
24use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
25use YAML::Syck ();
26use Time::HiRes; 33use Time::HiRes;
34use Compress::LZF;
35use Digest::MD5 ();
27 36
37# configure various modules to our taste
38#
39$Storable::canonical = 1; # reduce rsync transfers
40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
41Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
42
28use Event; $Event::Eval = 1; # no idea why this is required, but it is 43$Event::Eval = 1; # no idea why this is required, but it is
29
30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31 44
32# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 45# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
33$YAML::Syck::ImplicitUnicode = 1; 46$YAML::Syck::ImplicitUnicode = 1;
34 47
35$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 48$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
36 49
50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
51
37our %COMMAND = (); 52our %COMMAND = ();
38our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
39 54
40our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
41our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
42our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
43our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
44 60
61our $RELOAD; # number of reloads so far
45our @EVENT; 62our @EVENT;
46our $LIBDIR = datadir . "/ext";
47 63
48our $TICK = MAX_TIME * 1e-6; 64our $CONFDIR = confdir;
65our $DATADIR = datadir;
66our $LIBDIR = "$DATADIR/ext";
67our $PODDIR = "$DATADIR/pod";
68our $MAPDIR = "$DATADIR/" . mapdir;
69our $LOCALDIR = localdir;
70our $TMPDIR = "$LOCALDIR/" . tmpdir;
71our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
72our $PLAYERDIR = "$LOCALDIR/" . playerdir;
73our $RANDOMDIR = "$LOCALDIR/random";
74our $BDBDIR = "$LOCALDIR/db";
75
76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
49our $TICK_WATCHER; 77our $TICK_WATCHER;
50our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
51our $WRITE_RUNTIME_WATCHER; 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
52our $NEXT_TICK; 80our $NEXT_TICK;
53our $NOW; 81our $NOW;
54our $USE_FSYNC = 1; # use fsync to write maps - default off 82our $USE_FSYNC = 1; # use fsync to write maps - default off
55 83
56our $BDB_POLL_WATCHER; 84our $BDB_POLL_WATCHER;
62our $RUNTIME; 90our $RUNTIME;
63 91
64our %PLAYER; # all users 92our %PLAYER; # all users
65our %MAP; # all maps 93our %MAP; # all maps
66our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
67our $RANDOM_MAPS = cf::localdir . "/random";
68our $BDB_ENV_DIR = cf::localdir . "/db";
69
70our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
71our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
72 95
73# used to convert map paths into valid unix filenames by replacing / by ∕ 96# used to convert map paths into valid unix filenames by replacing / by ∕
74our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
75 98
99our $LOAD; # a number between 0 (idle) and 1 (too many objects)
100our $LOADAVG; # same thing, but with alpha-smoothing
101our $tick_start; # for load detecting purposes
102
76binmode STDOUT; 103binmode STDOUT;
77binmode STDERR; 104binmode STDERR;
78 105
79# read virtual server time, if available 106# read virtual server time, if available
80unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
81 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
82 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
83 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
84} 111}
85 112
86mkdir cf::localdir; 113mkdir $_
87mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
88mkdir cf::localdir . "/" . cf::tmpdir;
89mkdir cf::localdir . "/" . cf::uniquedir;
90mkdir $RANDOM_MAPS;
91mkdir $BDB_ENV_DIR;
92 115
93our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
94 117
95sub cf::map::normalise; 118sub cf::map::normalise;
96 119
107=item $cf::RUNTIME 130=item $cf::RUNTIME
108 131
109The time this server has run, starts at 0 and is increased by $cf::TICK on 132The time this server has run, starts at 0 and is increased by $cf::TICK on
110every server tick. 133every server tick.
111 134
112=item $cf::LIBDIR 135=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
136$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
137$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
113 138
114The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
115be found. It will be added to C<@INC> automatically. 140directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
141unique-items directory, player file directory, random maps directory and
142database environment.
116 143
117=item $cf::NOW 144=item $cf::NOW
118 145
119The time of the last (current) server tick. 146The time of the last (current) server tick.
120 147
121=item $cf::TICK 148=item $cf::TICK
122 149
123The interval between server ticks, in seconds. 150The interval between server ticks, in seconds.
151
152=item $cf::LOADAVG
153
154The current CPU load on the server (alpha-smoothed), as a value between 0
155(none) and 1 (overloaded), indicating how much time is spent on processing
156objects per tick. Healthy values are < 0.5.
157
158=item $cf::LOAD
159
160The raw value load value from the last tick.
124 161
125=item %cf::CFG 162=item %cf::CFG
126 163
127Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
128from wherever your confdir points to. 165from wherever your confdir points to.
129 166
130=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 167=item cf::wait_for_tick, cf::wait_for_tick_begin
131 168
132These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
133or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 170returns directly I<after> the tick processing (and consequently, can only wake one process
134processing has been done. Call C<< ->wait >> on them to maximise the 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
135window of cpu time available, or simply to synchronise to the server tick. 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
136 178
137=back 179=back
138 180
139=cut 181=cut
140 182
141BEGIN { 183BEGIN {
142 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
143 my $msg = join "", @_; 185 my $msg = join "", @_;
144 utf8::encode $msg;
145 186
146 $msg .= "\n" 187 $msg .= "\n"
147 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
148 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
149 LOG llevError, $msg; 193 LOG llevError, $msg;
150 }; 194 };
151} 195}
152 196
153@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
154@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
155@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
156@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
157@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 201@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
202@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
158@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 203@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
159 204
160# we bless all objects into (empty) derived classes to force a method lookup 205# we bless all objects into (empty) derived classes to force a method lookup
161# within the Safe compartment. 206# within the Safe compartment.
162for my $pkg (qw( 207for my $pkg (qw(
163 cf::global cf::attachable 208 cf::global cf::attachable
171} 216}
172 217
173$Event::DIED = sub { 218$Event::DIED = sub {
174 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
175}; 220};
221
222#############################################################################
176 223
177=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
178 225
179=over 4 226=over 4
180 227
199 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
200 $d 247 $d
201 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
202} 249}
203 250
204use JSON::Syck (); # TODO# replace by JSON::PC once working
205
206=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
207 252
208Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
209 254
210=cut
211
212sub from_json($) {
213 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
214 JSON::Syck::Load $_[0]
215}
216
217=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
218 256
219Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
220 258
221=cut 259=cut
222 260
223sub to_json($) { 261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
224 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 262
225 JSON::Syck::Dump $_[0] 263sub to_json ($) { $json_coder->encode ($_[0]) }
226} 264sub from_json ($) { $json_coder->decode ($_[0]) }
227 265
228=item cf::lock_wait $string 266=item cf::lock_wait $string
229 267
230Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
231 269
234Wait until the given lock is available and then acquires it and returns 272Wait until the given lock is available and then acquires it and returns
235a Coro::guard object. If the guard object gets destroyed (goes out of scope, 273a Coro::guard object. If the guard object gets destroyed (goes out of scope,
236for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
237returned. 275returned.
238 276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
279
239Lock names should begin with a unique identifier (for example, cf::map::find 280Lock names should begin with a unique identifier (for example, cf::map::find
240uses map_find and cf::map::load uses map_load). 281uses map_find and cf::map::load uses map_load).
282
283=item $locked = cf::lock_active $string
284
285Return true if the lock is currently active, i.e. somebody has locked it.
241 286
242=cut 287=cut
243 288
244our %LOCK; 289our %LOCK;
245 290
265 # wake up all waiters, to be on the safe side 310 # wake up all waiters, to be on the safe side
266 $_->ready for @{ delete $LOCK{$key} }; 311 $_->ready for @{ delete $LOCK{$key} };
267 } 312 }
268} 313}
269 314
315sub lock_active($) {
316 my ($key) = @_;
317
318 ! ! $LOCK{$key}
319}
320
270sub freeze_mainloop { 321sub freeze_mainloop {
271 return unless $TICK_WATCHER->is_active; 322 return unless $TICK_WATCHER->is_active;
272 323
273 my $guard = Coro::guard { 324 my $guard = Coro::guard {
274 $TICK_WATCHER->start; 325 $TICK_WATCHER->start;
275 $WRITE_RUNTIME_WATCHER->start;
276 }; 326 };
277 $WRITE_RUNTIME_WATCHER->stop;
278 $TICK_WATCHER->stop; 327 $TICK_WATCHER->stop;
279 $guard 328 $guard
329}
330
331=item cf::get_slot $time[, $priority[, $name]]
332
333Allocate $time seconds of blocking CPU time at priority C<$priority>:
334This call blocks and returns only when you have at least C<$time> seconds
335of cpu time till the next tick. The slot is only valid till the next cede.
336
337The optional C<$name> can be used to identify the job to run. It might be
338used for statistical purposes and should identify the same time-class.
339
340Useful for short background jobs.
341
342=cut
343
344our @SLOT_QUEUE;
345our $SLOT_QUEUE;
346
347$SLOT_QUEUE->cancel if $SLOT_QUEUE;
348$SLOT_QUEUE = Coro::async {
349 my $signal = new Coro::Signal;
350
351 while () {
352 next_job:
353 my $avail = cf::till_tick;
354 if ($avail > 0.01) {
355 for (0 .. $#SLOT_QUEUE) {
356 if ($SLOT_QUEUE[$_][0] < $avail) {
357 my $job = splice @SLOT_QUEUE, $_, 1, ();
358 $job->[2]->send;
359 Coro::cede;
360 goto next_job;
361 }
362 }
363 }
364
365 if (@SLOT_QUEUE) {
366 # we do not use wait_For_tick() as it returns immediately when tick is inactive
367 push @cf::WAIT_FOR_TICK, $signal;
368 $signal->wait;
369 } else {
370 Coro::schedule;
371 }
372 }
373};
374
375sub get_slot($;$$) {
376 my ($time, $pri, $name) = @_;
377
378 $time = $TICK * .6 if $time > $TICK * .6;
379 my $sig = new Coro::Signal;
380
381 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
382 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
383 $SLOT_QUEUE->ready;
384 $sig->wait;
280} 385}
281 386
282=item cf::async { BLOCK } 387=item cf::async { BLOCK }
283 388
284Currently the same as Coro::async_pool, meaning you cannot use 389Currently the same as Coro::async_pool, meaning you cannot use
289 394
290BEGIN { *async = \&Coro::async_pool } 395BEGIN { *async = \&Coro::async_pool }
291 396
292=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
293 398
294The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
295always able to handle events or runnable, as crossfire+ is only partly 400is always able to handle events or runnable, as Crossfire TRT is only
296reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 401partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
402acceptable.
297 403
298If it must be done, put the blocking parts into C<sync_job>. This will run 404If it must be done, put the blocking parts into C<sync_job>. This will run
299the given BLOCK in another coroutine while waiting for the result. The 405the given BLOCK in another coroutine while waiting for the result. The
300server will be frozen during this time, so the block should either finish 406server will be frozen during this time, so the block should either finish
301fast or be very important. 407fast or be very important.
304 410
305sub sync_job(&) { 411sub sync_job(&) {
306 my ($job) = @_; 412 my ($job) = @_;
307 413
308 if ($Coro::current == $Coro::main) { 414 if ($Coro::current == $Coro::main) {
415 my $time = Event::time;
416
309 # this is the main coro, too bad, we have to block 417 # this is the main coro, too bad, we have to block
310 # till the operation succeeds, freezing the server :/ 418 # till the operation succeeds, freezing the server :/
311 419
312 # TODO: use suspend/resume instead 420 # TODO: use suspend/resume instead
313 # (but this is cancel-safe) 421 # (but this is cancel-safe)
324 432
325 while ($busy) { 433 while ($busy) {
326 Coro::cede or Event::one_event; 434 Coro::cede or Event::one_event;
327 } 435 }
328 436
437 $time = Event::time - $time;
438
439 LOG llevError | logBacktrace, Carp::longmess "long sync job"
440 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
441
442 $tick_start += $time; # do not account sync jobs to server load
443
329 wantarray ? @res : $res[0] 444 wantarray ? @res : $res[0]
330 } else { 445 } else {
331 # we are in another coroutine, how wonderful, everything just works 446 # we are in another coroutine, how wonderful, everything just works
332 447
333 $job->() 448 $job->()
352 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
353 468
354 $coro 469 $coro
355} 470}
356 471
357sub write_runtime { 472=item fork_call { }, $args
358 my $runtime = cf::localdir . "/runtime";
359 473
360 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 474Executes the given code block with the given arguments in a seperate
361 or return; 475process, returning the results. Everything must be serialisable with
476Coro::Storable. May, of course, block. Note that the executed sub may
477never block itself or use any form of Event handling.
362 478
363 my $value = $cf::RUNTIME + 90 + 10; 479=cut
364 # 10 is the runtime save interval, for a monotonic clock
365 # 60 allows for the watchdog to kill the server.
366 480
367 (aio_write $fh, 0, (length $value), $value, 0) <= 0 481sub fork_call(&@) {
368 and return; 482 my ($cb, @args) = @_;
369 483
370 # always fsync - this file is important 484 # we seemingly have to make a local copy of the whole thing,
371 aio_fsync $fh 485 # otherwise perl prematurely frees the stuff :/
372 and return; 486 # TODO: investigate and fix (liekly this will be rather laborious)
373 487
374 close $fh 488 my @res = Coro::Util::fork_eval {
375 or return; 489 reset_signals;
490 &$cb
491 }, @args;
376 492
377 aio_rename "$runtime~", $runtime 493 wantarray ? @res : $res[-1]
378 and return; 494}
379 495
496=item $value = cf::db_get $family => $key
497
498Returns a single value from the environment database.
499
500=item cf::db_put $family => $key => $value
501
502Stores the given C<$value> in the family. It can currently store binary
503data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
504
505=cut
506
507our $DB;
508
509sub db_init {
510 unless ($DB) {
511 $DB = BDB::db_create $DB_ENV;
512
513 cf::sync_job {
514 eval {
515 $DB->set_flags (BDB::CHKSUM);
516
517 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
518 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
519 cf::cleanup "db_open(db): $!" if $!;
520 };
521 cf::cleanup "db_open(db): $@" if $@;
522 };
380 1 523 }
524}
525
526sub db_get($$) {
527 my $key = "$_[0]/$_[1]";
528
529 cf::sync_job {
530 BDB::db_get $DB, undef, $key, my $data;
531
532 $! ? ()
533 : $data
534 }
535}
536
537sub db_put($$$) {
538 BDB::dbreq_pri 4;
539 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
540}
541
542=item cf::cache $id => [$paths...], $processversion => $process
543
544Generic caching function that returns the value of the resource $id,
545caching and regenerating as required.
546
547This function can block.
548
549=cut
550
551sub cache {
552 my ($id, $src, $processversion, $process) = @_;
553
554 my $meta =
555 join "\x00",
556 $processversion,
557 map {
558 aio_stat $_
559 and Carp::croak "$_: $!";
560
561 ($_, (stat _)[7,9])
562 } @$src;
563
564 my $dbmeta = db_get cache => "$id/meta";
565 if ($dbmeta ne $meta) {
566 # changed, we may need to process
567
568 my @data;
569 my $md5;
570
571 for (0 .. $#$src) {
572 0 <= aio_load $src->[$_], $data[$_]
573 or Carp::croak "$src->[$_]: $!";
574 }
575
576 # if processing is expensive, check
577 # checksum first
578 if (1) {
579 $md5 =
580 join "\x00",
581 $processversion,
582 map {
583 cf::cede_to_tick;
584 ($src->[$_], Digest::MD5::md5_hex $data[$_])
585 } 0.. $#$src;
586
587
588 my $dbmd5 = db_get cache => "$id/md5";
589 if ($dbmd5 eq $md5) {
590 db_put cache => "$id/meta", $meta;
591
592 return db_get cache => "$id/data";
593 }
594 }
595
596 my $t1 = Time::HiRes::time;
597 my $data = $process->(\@data);
598 my $t2 = Time::HiRes::time;
599
600 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
601
602 db_put cache => "$id/data", $data;
603 db_put cache => "$id/md5" , $md5;
604 db_put cache => "$id/meta", $meta;
605
606 return $data;
607 }
608
609 db_get cache => "$id/data"
610}
611
612=item cf::datalog type => key => value, ...
613
614Log a datalog packet of the given type with the given key-value pairs.
615
616=cut
617
618sub datalog($@) {
619 my ($type, %kv) = @_;
620 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
381} 621}
382 622
383=back 623=back
384 624
385=cut 625=cut
392attach callbacks/event handlers (a collection of which is called an "attachment") 632attach callbacks/event handlers (a collection of which is called an "attachment")
393to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
394 634
395In the following description, CLASS can be any of C<global>, C<object> 635In the following description, CLASS can be any of C<global>, C<object>
396C<player>, C<client> or C<map> (i.e. the attachable objects in 636C<player>, C<client> or C<map> (i.e. the attachable objects in
397crossfire+). 637Crossfire TRT).
398 638
399=over 4 639=over 4
400 640
401=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
402 642
565 $registry = $CB_TYPE[$object_type] ||= []; 805 $registry = $CB_TYPE[$object_type] ||= [];
566 806
567 } elsif ($type eq "subtype") { 807 } elsif ($type eq "subtype") {
568 defined $object_type or Carp::croak "subtype specified without type"; 808 defined $object_type or Carp::croak "subtype specified without type";
569 my $object_subtype = shift @arg; 809 my $object_subtype = shift @arg;
570 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 810 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571 811
572 } elsif ($type eq "package") { 812 } elsif ($type eq "package") {
573 my $pkg = shift @arg; 813 my $pkg = shift @arg;
574 814
575 while (my ($name, $id) = each %cb_id) { 815 while (my ($name, $id) = each %cb_id) {
604 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
605 } 845 }
606 846
607 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
608 } else { 848 } else {
609 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
610 } 850 }
611 851
612 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
613} 853}
614 854
616 if (ref $_[0]) { 856 if (ref $_[0]) {
617 _object_attach @_; 857 _object_attach @_;
618 } else { 858 } else {
619 _attach shift->_attach_registry, @_; 859 _attach shift->_attach_registry, @_;
620 } 860 }
861 _recalc_want;
621}; 862};
622 863
623# all those should be optimised 864# all those should be optimised
624sub cf::attachable::detach { 865sub cf::attachable::detach {
625 my ($obj, $name) = @_; 866 my ($obj, $name) = @_;
628 delete $obj->{_attachment}{$name}; 869 delete $obj->{_attachment}{$name};
629 reattach ($obj); 870 reattach ($obj);
630 } else { 871 } else {
631 Carp::croak "cannot, currently, detach class attachments"; 872 Carp::croak "cannot, currently, detach class attachments";
632 } 873 }
874 _recalc_want;
633}; 875};
634 876
635sub cf::attachable::attached { 877sub cf::attachable::attached {
636 my ($obj, $name) = @_; 878 my ($obj, $name) = @_;
637 879
652 "; 894 ";
653 die if $@; 895 die if $@;
654} 896}
655 897
656our $override; 898our $override;
657our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 899our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
658 900
659sub override { 901sub override {
660 $override = 1; 902 $override = 1;
661 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
662} 904}
663 905
664sub do_invoke { 906sub do_invoke {
665 my $event = shift; 907 my $event = shift;
666 my $callbacks = shift; 908 my $callbacks = shift;
667 909
668 @invoke_results = (); 910 @INVOKE_RESULTS = ();
669 911
670 local $override; 912 local $override;
671 913
672 for (@$callbacks) { 914 for (@$callbacks) {
673 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
690 932
691Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
692 934
693This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 935This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
694removed in future versions), and there is no public API to access override 936removed in future versions), and there is no public API to access override
695results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696 938
697=back 939=back
698 940
699=cut 941=cut
700 942
701############################################################################# 943#############################################################################
702# object support 944# object support
945#
946
947sub _can_merge {
948 my ($ob1, $ob2) = @_;
949
950 local $Storable::canonical = 1;
951 my $fob1 = Storable::freeze $ob1;
952 my $fob2 = Storable::freeze $ob2;
953
954 $fob1 eq $fob2
955}
703 956
704sub reattach { 957sub reattach {
705 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
706 my ($obj) = @_; 959 my ($obj) = @_;
707 960
784 } 1037 }
785 } else { 1038 } else {
786 aio_unlink $filename; 1039 aio_unlink $filename;
787 aio_unlink "$filename.pst"; 1040 aio_unlink "$filename.pst";
788 } 1041 }
789
790 #d##TODO# nuke non .map-files if exist
791 if ($filename =~ s/\.map$//) {
792 aio_unlink $filename;
793 aio_unlink "$filename.pst";
794 }
795 } 1042 }
796} 1043}
797 1044
798sub object_freezer_as_string { 1045sub object_freezer_as_string {
799 my ($rdata, $objs) = @_; 1046 my ($rdata, $objs) = @_;
805 1052
806sub object_thawer_load { 1053sub object_thawer_load {
807 my ($filename) = @_; 1054 my ($filename) = @_;
808 1055
809 my ($data, $av); 1056 my ($data, $av);
810
811 #d#TODO remove .map if file does not exist
812 aio_stat $filename and $filename =~ s/\.map$//;
813 1057
814 (aio_load $filename, $data) >= 0 1058 (aio_load $filename, $data) >= 0
815 or return; 1059 or return;
816 1060
817 unless (aio_stat "$filename.pst") { 1061 unless (aio_stat "$filename.pst") {
819 or return; 1063 or return;
820 $av = eval { (Storable::thaw $av)->{objs} }; 1064 $av = eval { (Storable::thaw $av)->{objs} };
821 } 1065 }
822 1066
823 warn sprintf "loading %s (%d)\n", 1067 warn sprintf "loading %s (%d)\n",
824 $filename, length $data, scalar @{$av || []};#d# 1068 $filename, length $data, scalar @{$av || []};
825 return ($data, $av); 1069 return ($data, $av);
826} 1070}
1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
827 1077
828############################################################################# 1078#############################################################################
829# command handling &c 1079# command handling &c
830 1080
831=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
844 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
845} 1095}
846 1096
847=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
848 1098
849Register a callbackf ro execution when the client sends an extcmd packet. 1099Register a callback for execution when the client sends an (synchronous)
1100extcmd packet. Ext commands will be processed in the order they are
1101received by the server, like other user commands. The first argument is
1102the logged-in player. Ext commands can only be processed after a player
1103has logged in successfully.
850 1104
851If the callback returns something, it is sent back as if reply was being 1105If the callback returns something, it is sent back as if reply was being
852called. 1106called.
853 1107
1108=item cf::register_exticmd $name => \&callback($ns,$packet);
1109
1110Register a callback for execution when the client sends an (asynchronous)
1111exticmd packet. Exti commands are processed by the server as soon as they
1112are received, i.e. out of order w.r.t. other commands. The first argument
1113is a client socket. Exti commands can be received anytime, even before
1114log-in.
1115
1116If the callback returns something, it is sent back as if reply was being
1117called.
1118
854=cut 1119=cut
855 1120
856sub register_extcmd { 1121sub register_extcmd {
857 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
858 1123
859 $EXTCMD{$name} = $cb; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
860} 1131}
861 1132
862cf::player->attach ( 1133cf::player->attach (
863 on_command => sub { 1134 on_command => sub {
864 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
873 cf::override; 1144 cf::override;
874 }, 1145 },
875 on_extcmd => sub { 1146 on_extcmd => sub {
876 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
877 1148
878 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
879 1150
880 if (ref $msg) { 1151 if (ref $msg) {
1152 my ($type, $reply, @payload) =
1153 "ARRAY" eq ref $msg
1154 ? @$msg
1155 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1156
1157 my @reply;
1158
881 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
882 if (my %reply = $cb->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
883 $pl->ext_reply ($msg->{msgid}, %reply);
884 }
885 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
886 } else { 1166 } else {
887 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
888 } 1168 }
889 1169
890 cf::override; 1170 cf::override;
891 }, 1171 },
892); 1172);
893 1173
894sub load_extension {
895 my ($path) = @_;
896
897 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
898 my $base = $1;
899 my $pkg = $1;
900 $pkg =~ s/[^[:word:]]/_/g;
901 $pkg = "ext::$pkg";
902
903 warn "... loading '$path' into '$pkg'\n";
904
905 open my $fh, "<:utf8", $path
906 or die "$path: $!";
907
908 my $source =
909 "package $pkg; use strict; use utf8;\n"
910 . "#line 1 \"$path\"\n{\n"
911 . (do { local $/; <$fh> })
912 . "\n};\n1";
913
914 unless (eval $source) {
915 my $msg = $@ ? "$path: $@\n"
916 : "extension disabled.\n";
917 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
918 warn $@;
919 warn "mandatory extension failed to load, exiting.\n";
920 exit 1;
921 }
922 die $@;
923 }
924
925 push @EXTS, $pkg;
926}
927
928sub load_extensions { 1174sub load_extensions {
1175 cf::sync_job {
1176 my %todo;
1177
929 for my $ext (<$LIBDIR/*.ext>) { 1178 for my $path (<$LIBDIR/*.ext>) {
930 next unless -r $ext; 1179 next unless -r $path;
931 eval { 1180
932 load_extension $ext; 1181 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1182 my $base = $1;
1183 my $pkg = $1;
1184 $pkg =~ s/[^[:word:]]/_/g;
1185 $pkg = "ext::$pkg";
1186
1187 open my $fh, "<:utf8", $path
1188 or die "$path: $!";
1189
1190 my $source = do { local $/; <$fh> };
1191
1192 my %ext = (
1193 path => $path,
1194 base => $base,
1195 pkg => $pkg,
1196 );
1197
1198 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1199 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1200
1201 $ext{source} =
1202 "package $pkg; use strict; use utf8;\n"
1203 . "#line 1 \"$path\"\n{\n"
1204 . $source
1205 . "\n};\n1";
1206
1207 $todo{$base} = \%ext;
1208 }
1209
1210 my %done;
1211 while (%todo) {
1212 my $progress;
1213
1214 while (my ($k, $v) = each %todo) {
1215 for (split /,\s*/, $v->{meta}{depends}) {
1216 goto skip
1217 unless exists $done{$_};
1218 }
1219
1220 warn "... loading '$k' into '$v->{pkg}'\n";
1221
1222 unless (eval $v->{source}) {
1223 my $msg = $@ ? "$v->{path}: $@\n"
1224 : "$v->{base}: extension inactive.\n";
1225
1226 if (exists $v->{meta}{mandatory}) {
1227 warn $msg;
1228 warn "mandatory extension failed to load, exiting.\n";
1229 exit 1;
1230 }
1231
1232 warn $msg;
1233 }
1234
1235 $done{$k} = delete $todo{$k};
1236 push @EXTS, $v->{pkg};
1237 $progress = 1;
933 1 1238 }
934 } or warn "$ext not loaded: $@"; 1239
1240 skip:
1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1242 unless $progress;
1243 }
935 } 1244 };
936} 1245}
937 1246
938############################################################################# 1247#############################################################################
939 1248
1249=back
1250
940=head2 CORE EXTENSIONS 1251=head2 CORE EXTENSIONS
941 1252
942Functions and methods that extend core crossfire objects. 1253Functions and methods that extend core crossfire objects.
943 1254
944=cut 1255=cut
956Returns the given player object, loading it if necessary (might block). 1267Returns the given player object, loading it if necessary (might block).
957 1268
958=cut 1269=cut
959 1270
960sub playerdir($) { 1271sub playerdir($) {
961 cf::localdir 1272 "$PLAYERDIR/"
962 . "/"
963 . cf::playerdir
964 . "/"
965 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1273 . (ref $_[0] ? $_[0]->ob->name : $_[0])
966} 1274}
967 1275
968sub path($) { 1276sub path($) {
969 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1277 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
970 1278
971 (playerdir $login) . "/$login.pl" 1279 (playerdir $login) . "/playerdata"
972} 1280}
973 1281
974sub find_active($) { 1282sub find_active($) {
975 $cf::PLAYER{$_[0]} 1283 $cf::PLAYER{$_[0]}
976 and $cf::PLAYER{$_[0]}->active 1284 and $cf::PLAYER{$_[0]}->active
989 my $login = $_[0]; 1297 my $login = $_[0];
990 1298
991 my $guard = cf::lock_acquire "user_find:$login"; 1299 my $guard = cf::lock_acquire "user_find:$login";
992 1300
993 $cf::PLAYER{$_[0]} || do { 1301 $cf::PLAYER{$_[0]} || do {
1302 # rename old playerfiles to new ones
1303 #TODO: remove when no longer required
1304 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1305 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1306 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1307 aio_unlink +(playerdir $login) . "/$login.pl";
1308
994 my $pl = load_pl path $login 1309 my $pl = load_pl path $login
995 or return; 1310 or return;
996 $cf::PLAYER{$login} = $pl 1311 $cf::PLAYER{$login} = $pl
997 } 1312 }
998 } 1313 }
1010 1325
1011 aio_mkdir playerdir $pl, 0770; 1326 aio_mkdir playerdir $pl, 0770;
1012 $pl->{last_save} = $cf::RUNTIME; 1327 $pl->{last_save} = $cf::RUNTIME;
1013 1328
1014 $pl->save_pl ($path); 1329 $pl->save_pl ($path);
1015 Coro::cede; 1330 cf::cede_to_tick;
1016} 1331}
1017 1332
1018sub new($) { 1333sub new($) {
1019 my ($login) = @_; 1334 my ($login) = @_;
1020 1335
1026 $cf::PLAYER{$login} = $self; 1341 $cf::PLAYER{$login} = $self;
1027 1342
1028 $self 1343 $self
1029} 1344}
1030 1345
1346=item $player->send_msg ($channel, $msg, $color, [extra...])
1347
1348=cut
1349
1350sub send_msg {
1351 my $ns = shift->ns
1352 or return;
1353 $ns->send_msg (@_);
1354}
1355
1031=item $pl->quit_character 1356=item $pl->quit_character
1032 1357
1033Nukes the player without looking back. If logged in, the connection will 1358Nukes the player without looking back. If logged in, the connection will
1034be destroyed. May block for a long time. 1359be destroyed. May block for a long time.
1035 1360
1036=cut 1361=cut
1037 1362
1038sub quit_character { 1363sub quit_character {
1039 my ($pl) = @_; 1364 my ($pl) = @_;
1365
1366 my $name = $pl->ob->name;
1040 1367
1041 $pl->{deny_save} = 1; 1368 $pl->{deny_save} = 1;
1042 $pl->password ("*"); # this should lock out the player until we nuked the dir 1369 $pl->password ("*"); # this should lock out the player until we nuked the dir
1043 1370
1044 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1371 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1049 my $path = playerdir $pl; 1376 my $path = playerdir $pl;
1050 my $temp = "$path~$cf::RUNTIME~deleting~"; 1377 my $temp = "$path~$cf::RUNTIME~deleting~";
1051 aio_rename $path, $temp; 1378 aio_rename $path, $temp;
1052 delete $cf::PLAYER{$pl->ob->name}; 1379 delete $cf::PLAYER{$pl->ob->name};
1053 $pl->destroy; 1380 $pl->destroy;
1381
1382 my $prefix = qr<^~\Q$name\E/>;
1383
1384 # nuke player maps
1385 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1386
1054 IO::AIO::aio_rmtree $temp; 1387 IO::AIO::aio_rmtree $temp;
1388}
1389
1390=item $pl->kick
1391
1392Kicks a player out of the game. This destroys the connection.
1393
1394=cut
1395
1396sub kick {
1397 my ($pl, $kicker) = @_;
1398
1399 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1400 $pl->killer ("kicked");
1401 $pl->ns->destroy;
1055} 1402}
1056 1403
1057=item cf::player::list_logins 1404=item cf::player::list_logins
1058 1405
1059Returns am arrayref of all valid playernames in the system, can take a 1406Returns am arrayref of all valid playernames in the system, can take a
1060while and may block, so not sync_job-capable, ever. 1407while and may block, so not sync_job-capable, ever.
1061 1408
1062=cut 1409=cut
1063 1410
1064sub list_logins { 1411sub list_logins {
1065 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1412 my $dirs = aio_readdir $PLAYERDIR
1066 or return []; 1413 or return [];
1067 1414
1068 my @logins; 1415 my @logins;
1069 1416
1070 for my $login (@$dirs) { 1417 for my $login (@$dirs) {
1418 my $path = path $login;
1419
1420 # a .pst is a dead give-away for a valid player
1421 unless (-e "$path.pst") {
1071 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1422 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1072 aio_read $fh, 0, 512, my $buf, 0 or next; 1423 aio_read $fh, 0, 512, my $buf, 0 or next;
1073 $buf !~ /^password -------------$/m or next; # official not-valid tag 1424 $buf !~ /^password -------------$/m or next; # official not-valid tag
1425 }
1074 1426
1075 utf8::decode $login; 1427 utf8::decode $login;
1076 push @logins, $login; 1428 push @logins, $login;
1077 } 1429 }
1078 1430
1105 } 1457 }
1106 1458
1107 \@paths 1459 \@paths
1108} 1460}
1109 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
1110=item $player->ext_reply ($msgid, $msgtype, %msg) 1513=item $player->ext_reply ($msgid, @msg)
1111 1514
1112Sends an ext reply to the player. 1515Sends an ext reply to the player.
1113 1516
1114=cut 1517=cut
1115 1518
1116sub ext_reply($$$%) { 1519sub ext_reply($$@) {
1117 my ($self, $id, %msg) = @_; 1520 my ($self, $id, @msg) = @_;
1118 1521
1119 $msg{msgid} = $id; 1522 $self->ns->ext_reply ($id, @msg)
1120
1121 $self->send ("ext " . cf::to_json \%msg);
1122} 1523}
1123 1524
1124package 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}
1125 1565
1126=back 1566=back
1127
1128 1567
1129=head3 cf::map 1568=head3 cf::map
1130 1569
1131=over 4 1570=over 4
1132 1571
1187 my ($self, $merge) = @_; 1626 my ($self, $merge) = @_;
1188 1627
1189 # we have to keep some variables in memory intact 1628 # we have to keep some variables in memory intact
1190 local $self->{path}; 1629 local $self->{path};
1191 local $self->{load_path}; 1630 local $self->{load_path};
1192 local $self->{deny_save};
1193 local $self->{deny_reset};
1194 1631
1195 $self->SUPER::thawer_merge ($merge); 1632 $self->SUPER::thawer_merge ($merge);
1196} 1633}
1197 1634
1198sub normalise { 1635sub normalise {
1245 $self->init; # pass $1 etc. 1682 $self->init; # pass $1 etc.
1246 return $self; 1683 return $self;
1247 } 1684 }
1248 } 1685 }
1249 1686
1250 Carp::carp "unable to resolve path '$path' (base '$base')."; 1687 Carp::cluck "unable to resolve path '$path' (base '$base').";
1251 () 1688 ()
1252} 1689}
1253 1690
1254sub init { 1691sub init {
1255 my ($self) = @_; 1692 my ($self) = @_;
1270 1707
1271# the original (read-only) location 1708# the original (read-only) location
1272sub load_path { 1709sub load_path {
1273 my ($self) = @_; 1710 my ($self) = @_;
1274 1711
1275 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1712 "$MAPDIR/$self->{path}.map"
1276} 1713}
1277 1714
1278# the temporary/swap location 1715# the temporary/swap location
1279sub save_path { 1716sub save_path {
1280 my ($self) = @_; 1717 my ($self) = @_;
1281 1718
1282 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1719 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1283 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1720 "$TMPDIR/$path.map"
1284} 1721}
1285 1722
1286# the unique path, undef == no special unique path 1723# the unique path, undef == no special unique path
1287sub uniq_path { 1724sub uniq_path {
1288 my ($self) = @_; 1725 my ($self) = @_;
1289 1726
1290 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1727 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1291 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1728 "$UNIQUEDIR/$path"
1292} 1729}
1293 1730
1294# and all this just because we cannot iterate over 1731# and all this just because we cannot iterate over
1295# all maps in C++... 1732# all maps in C++...
1296sub change_all_map_light { 1733sub change_all_map_light {
1298 1735
1299 $_->change_map_light ($change) 1736 $_->change_map_light ($change)
1300 for grep $_->outdoor, values %cf::MAP; 1737 for grep $_->outdoor, values %cf::MAP;
1301} 1738}
1302 1739
1740sub decay_objects {
1741 my ($self) = @_;
1742
1743 return if $self->{deny_reset};
1744
1745 $self->do_decay_objects;
1746}
1747
1303sub unlink_save { 1748sub unlink_save {
1304 my ($self) = @_; 1749 my ($self) = @_;
1305 1750
1306 utf8::encode (my $save = $self->save_path); 1751 utf8::encode (my $save = $self->save_path);
1307 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1752 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1308 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1753 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1309
1310 #d#TODO remove .map and also nuke
1311 $save =~ s/\.map// or return;#d#
1312 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1313 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1314} 1754}
1315 1755
1316sub load_header_from($) { 1756sub load_header_from($) {
1317 my ($self, $path) = @_; 1757 my ($self, $path) = @_;
1318 1758
1368 $self->load_header_orig 1808 $self->load_header_orig
1369 or return; 1809 or return;
1370 $self->prepare_orig; 1810 $self->prepare_orig;
1371 } 1811 }
1372 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
1373 1 1819 1
1374} 1820}
1375 1821
1376sub find; 1822sub find;
1377sub find { 1823sub find {
1389 $map->{last_save} = $cf::RUNTIME; 1835 $map->{last_save} = $cf::RUNTIME;
1390 1836
1391 $map->load_header 1837 $map->load_header
1392 or return; 1838 or return;
1393 1839
1394 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1840 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1395 # doing this can freeze the server in a sync job, obviously 1841 # doing this can freeze the server in a sync job, obviously
1396 #$cf::WAIT_FOR_TICK->wait; 1842 #$cf::WAIT_FOR_TICK->wait;
1397 $map->reset; 1843 $map->reset;
1398 undef $guard; 1844 undef $guard;
1399 return find $path; 1845 return find $path;
1410 my ($self) = @_; 1856 my ($self) = @_;
1411 1857
1412 local $self->{deny_reset} = 1; # loading can take a long time 1858 local $self->{deny_reset} = 1; # loading can take a long time
1413 1859
1414 my $path = $self->{path}; 1860 my $path = $self->{path};
1861
1862 {
1863 my $guard1 = cf::lock_acquire "map_data:$path";
1415 my $guard = cf::lock_acquire "map_load:$path"; 1864 my $guard2 = cf::lock_acquire "map_load:$path";
1416 1865
1417 return if $self->in_memory != cf::MAP_SWAPPED; 1866 return if $self->in_memory != cf::MAP_SWAPPED;
1418 1867
1419 $self->in_memory (cf::MAP_LOADING); 1868 $self->in_memory (cf::MAP_LOADING);
1420 1869
1421 $self->alloc; 1870 $self->alloc;
1422 1871
1423 $self->pre_load; 1872 $self->pre_load;
1873 cf::cede_to_tick;
1424 1874
1425 $self->_load_objects ($self->{load_path}, 1) 1875 $self->_load_objects ($self->{load_path}, 1)
1426 or return; 1876 or return;
1427 1877
1428 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1878 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1429 if delete $self->{load_original}; 1879 if delete $self->{load_original};
1430 1880
1431 if (my $uniq = $self->uniq_path) { 1881 if (my $uniq = $self->uniq_path) {
1432 utf8::encode $uniq; 1882 utf8::encode $uniq;
1433 if (aio_open $uniq, O_RDONLY, 0) { 1883 if (aio_open $uniq, O_RDONLY, 0) {
1434 $self->clear_unique_items; 1884 $self->clear_unique_items;
1435 $self->_load_objects ($uniq, 0); 1885 $self->_load_objects ($uniq, 0);
1436 } 1886 }
1437 } 1887 }
1438 1888
1439 Coro::cede; 1889 cf::cede_to_tick;
1440
1441 # now do the right thing for maps 1890 # now do the right thing for maps
1442 $self->link_multipart_objects; 1891 $self->link_multipart_objects;
1443
1444 unless ($self->{deny_activate}) {
1445 $self->decay_objects;
1446 $self->fix_auto_apply;
1447 $self->update_buttons;
1448 Coro::cede;
1449 $self->set_darkness_map;
1450 $self->difficulty ($self->estimate_difficulty) 1892 $self->difficulty ($self->estimate_difficulty)
1451 unless $self->difficulty; 1893 unless $self->difficulty;
1452 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;
1453 $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);
1454 } 1910 }
1455 1911
1456 $self->post_load; 1912 $self->post_load;
1457
1458 $self->in_memory (cf::MAP_IN_MEMORY);
1459} 1913}
1460 1914
1461sub customise_for { 1915sub customise_for {
1462 my ($self, $ob) = @_; 1916 my ($self, $ob) = @_;
1463 1917
1464 return find "~" . $ob->name . "/" . $self->{path} 1918 return find "~" . $ob->name . "/" . $self->{path}
1465 if $self->per_player; 1919 if $self->per_player;
1466 1920
1921# return find "?party/" . $ob->name . "/" . $self->{path}
1922# if $self->per_party;
1923
1467 $self 1924 $self
1468} 1925}
1469 1926
1470# 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
1471sub load_diag { 1928sub load_neighbours {
1472 my ($map) = @_; 1929 my ($map) = @_;
1473 1930
1474 my @diag; # diagonal neighbours 1931 my @neigh; # diagonal neighbours
1475 1932
1476 for (0 .. 3) { 1933 for (0 .. 3) {
1477 my $neigh = $map->tile_path ($_) 1934 my $neigh = $map->tile_path ($_)
1478 or next; 1935 or next;
1479 $neigh = find $neigh, $map 1936 $neigh = find $neigh, $map
1480 or next; 1937 or next;
1481 $neigh->load; 1938 $neigh->load;
1482 1939
1940 push @neigh,
1483 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1941 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1484 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1942 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1485 } 1943 }
1486 1944
1487 for (@diag) { 1945 for (grep defined $_->[0], @neigh) {
1946 my ($path, $origin) = @$_;
1488 my $neigh = find @$_ 1947 my $neigh = find $path, $origin
1489 or next; 1948 or next;
1490 $neigh->load; 1949 $neigh->load;
1491 } 1950 }
1492} 1951}
1493 1952
1498} 1957}
1499 1958
1500sub do_load_sync { 1959sub do_load_sync {
1501 my ($map) = @_; 1960 my ($map) = @_;
1502 1961
1962 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1963 if $Coro::current == $Coro::main;
1964
1503 cf::sync_job { $map->load }; 1965 cf::sync_job { $map->load };
1504} 1966}
1505 1967
1506our %MAP_PREFETCH; 1968our %MAP_PREFETCH;
1507our $MAP_PREFETCHER = undef; 1969our $MAP_PREFETCHER = undef;
1508 1970
1509sub find_async { 1971sub find_async {
1510 my ($path, $origin) = @_; 1972 my ($path, $origin, $load) = @_;
1511 1973
1512 $path = normalise $path, $origin && $origin->{path}; 1974 $path = normalise $path, $origin && $origin->{path};
1513 1975
1514 if (my $map = $cf::MAP{$path}) { 1976 if (my $map = $cf::MAP{$path}) {
1515 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1977 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1516 } 1978 }
1517 1979
1518 undef $MAP_PREFETCH{$path}; 1980 $MAP_PREFETCH{$path} |= $load;
1981
1519 $MAP_PREFETCHER ||= cf::async { 1982 $MAP_PREFETCHER ||= cf::async {
1520 while (%MAP_PREFETCH) { 1983 while (%MAP_PREFETCH) {
1521 for my $path (keys %MAP_PREFETCH) { 1984 while (my ($k, $v) = each %MAP_PREFETCH) {
1522 my $map = find $path 1985 if (my $map = find $k) {
1523 or next;
1524 $map->load; 1986 $map->load if $v;
1987 }
1525 1988
1526 delete $MAP_PREFETCH{$path}; 1989 delete $MAP_PREFETCH{$k};
1527 } 1990 }
1528 } 1991 }
1529 undef $MAP_PREFETCHER; 1992 undef $MAP_PREFETCHER;
1530 }; 1993 };
1531 $MAP_PREFETCHER->prio (6); 1994 $MAP_PREFETCHER->prio (6);
1534} 1997}
1535 1998
1536sub save { 1999sub save {
1537 my ($self) = @_; 2000 my ($self) = @_;
1538 2001
1539 my $lock = cf::lock_acquire "map_data:" . $self->path; 2002 my $lock = cf::lock_acquire "map_data:$self->{path}";
1540 2003
1541 $self->{last_save} = $cf::RUNTIME; 2004 $self->{last_save} = $cf::RUNTIME;
1542 2005
1543 return unless $self->dirty; 2006 return unless $self->dirty;
1544 2007
1567 my ($self) = @_; 2030 my ($self) = @_;
1568 2031
1569 # save first because save cedes 2032 # save first because save cedes
1570 $self->save; 2033 $self->save;
1571 2034
1572 my $lock = cf::lock_acquire "map_data:" . $self->path; 2035 my $lock = cf::lock_acquire "map_data:$self->{path}";
1573 2036
1574 return if $self->players; 2037 return if $self->players;
1575 return if $self->in_memory != cf::MAP_IN_MEMORY; 2038 return if $self->in_memory != cf::MAP_IN_MEMORY;
1576 return if $self->{deny_save}; 2039 return if $self->{deny_save};
1577 2040
1581 2044
1582sub reset_at { 2045sub reset_at {
1583 my ($self) = @_; 2046 my ($self) = @_;
1584 2047
1585 # TODO: safety, remove and allow resettable per-player maps 2048 # TODO: safety, remove and allow resettable per-player maps
1586 return 1e99 if $self->isa ("ext::map_per_player");#d#
1587 return 1e99 if $self->{deny_reset}; 2049 return 1e99 if $self->{deny_reset};
1588 2050
1589 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2051 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1590 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;
1591 2053
1602 my ($self) = @_; 2064 my ($self) = @_;
1603 2065
1604 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2066 my $lock = cf::lock_acquire "map_data:$self->{path}";
1605 2067
1606 return if $self->players; 2068 return if $self->players;
1607 return if $self->isa ("ext::map_per_player");#d#
1608 2069
1609 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 }
1610 2081
1611 delete $cf::MAP{$self->path}; 2082 delete $cf::MAP{$self->path};
1612 2083
1613 $self->in_memory (cf::MAP_SWAPPED);
1614 $self->clear; 2084 $self->clear;
1615 2085
1616 $_->clear_links_to ($self) for values %cf::MAP; 2086 $_->clear_links_to ($self) for values %cf::MAP;
1617 2087
1618 $self->unlink_save; 2088 $self->unlink_save;
1622my $nuke_counter = "aaaa"; 2092my $nuke_counter = "aaaa";
1623 2093
1624sub nuke { 2094sub nuke {
1625 my ($self) = @_; 2095 my ($self) = @_;
1626 2096
2097 {
2098 my $lock = cf::lock_acquire "map_data:$self->{path}";
2099
1627 delete $cf::MAP{$self->path}; 2100 delete $cf::MAP{$self->path};
1628 2101
1629 $self->unlink_save; 2102 $self->unlink_save;
1630 2103
1631 bless $self, "cf::map"; 2104 bless $self, "cf::map";
1632 delete $self->{deny_reset}; 2105 delete $self->{deny_reset};
1633 $self->{deny_save} = 1; 2106 $self->{deny_save} = 1;
1634 $self->reset_timeout (1); 2107 $self->reset_timeout (1);
1635 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2108 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1636 2109
1637 $cf::MAP{$self->path} = $self; 2110 $cf::MAP{$self->path} = $self;
2111 }
1638 2112
1639 $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 ]
1640} 2150}
1641 2151
1642=item cf::map::unique_maps 2152=item cf::map::unique_maps
1643 2153
1644Returns an arrayref of paths of all shared maps that have 2154Returns an arrayref of paths of all shared maps that have
1645instantiated unique items. May block. 2155instantiated unique items. May block.
1646 2156
1647=cut 2157=cut
1648 2158
1649sub unique_maps() { 2159sub unique_maps() {
1650 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2160 [
1651 or return; 2161 map {
1652
1653 my @paths;
1654
1655 for (@$files) {
1656 utf8::decode $_; 2162 utf8::decode $_;
1657 next if /\.pst$/; 2163 /\.map$/
1658 next unless /^$PATH_SEP/o; 2164 ? normalise $_
1659 2165 : ()
1660 push @paths, cf::map::normalise $_; 2166 } @{ aio_readdir $UNIQUEDIR or [] }
1661 } 2167 ]
1662
1663 \@paths
1664} 2168}
1665 2169
1666package cf; 2170package cf;
1667 2171
1668=back 2172=back
1714 2218
1715 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2219 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1716 2220
1717 if ($self->{record_replies}) { 2221 if ($self->{record_replies}) {
1718 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2222 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2223
1719 } 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 {
1720 $msg = $npc->name . " says: $msg" if $npc; 2232 $msg = $npc->name . " says: $msg" if $npc;
1721 $self->message ($msg, $flags); 2233 $self->message ($msg, $flags);
2234 }
1722 } 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 (@_);
1723} 2246}
1724 2247
1725=item $player_object->may ("access") 2248=item $player_object->may ("access")
1726 2249
1727Returns wether the given player is authorized to access resource "access" 2250Returns wether the given player is authorized to access resource "access"
1774 $self->deactivate_recursive; 2297 $self->deactivate_recursive;
1775 2298
1776 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2299 return if UNIVERSAL::isa $self->map, "ext::map_link";
1777 2300
1778 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2301 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1779 if $self->map; 2302 if $self->map && $self->map->{path} ne "{link}";
1780 2303
1781 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2304 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1782} 2305}
1783 2306
1784sub cf::object::player::leave_link { 2307sub cf::object::player::leave_link {
1785 my ($self, $map, $x, $y) = @_; 2308 my ($self, $map, $x, $y) = @_;
2309
2310 return unless $self->contr->active;
1786 2311
1787 my $link_pos = delete $self->{_link_pos}; 2312 my $link_pos = delete $self->{_link_pos};
1788 2313
1789 unless ($map) { 2314 unless ($map) {
1790 # restore original map position 2315 # restore original map position
1804 # use -1 or undef as default coordinates, not 0, 0 2329 # use -1 or undef as default coordinates, not 0, 0
1805 ($x, $y) = ($map->enter_x, $map->enter_y) 2330 ($x, $y) = ($map->enter_x, $map->enter_y)
1806 if $x <=0 && $y <= 0; 2331 if $x <=0 && $y <= 0;
1807 2332
1808 $map->load; 2333 $map->load;
1809 $map->load_diag; 2334 $map->load_neighbours;
1810 2335
1811 return unless $self->contr->active; 2336 return unless $self->contr->active;
1812 $self->activate_recursive; 2337 $self->activate_recursive;
2338
2339 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1813 $self->enter_map ($map, $x, $y); 2340 $self->enter_map ($map, $x, $y);
1814} 2341}
1815 2342
1816cf::player->attach ( 2343=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1817 on_logout => sub {
1818 my ($pl) = @_;
1819 2344
1820 # abort map switching before logout 2345Moves the player to the given map-path and coordinates by first freezing
1821 if ($pl->ob->{_link_pos}) { 2346her, loading and preparing them map, calling the provided $check callback
1822 cf::sync_job { 2347that has to return the map if sucecssful, and then unfreezes the player on
1823 $pl->ob->leave_link 2348the new (success) or old (failed) map position. In either case, $done will
1824 }; 2349be called at the end of this process.
1825 }
1826 },
1827 on_login => sub {
1828 my ($pl) = @_;
1829 2350
1830 # try to abort aborted map switching on player login :)
1831 # should happen only on crashes
1832 if ($pl->ob->{_link_pos}) {
1833 $pl->ob->enter_link;
1834 (async {
1835 # we need this sleep as the login has a concurrent enter_exit running
1836 # and this sleep increases chances of the player not ending up in scorn
1837 $pl->ob->reply (undef,
1838 "There was an internal problem at your last logout, "
1839 . "the server will try to bring you to your intended destination in a second.",
1840 cf::NDI_RED);
1841 Coro::Timer::sleep 1;
1842 $pl->ob->leave_link;
1843 })->prio (2);
1844 }
1845 },
1846);
1847
1848=item $player_object->goto ($path, $x, $y)
1849
1850=cut 2351=cut
2352
2353our $GOTOGEN;
1851 2354
1852sub cf::object::player::goto { 2355sub cf::object::player::goto {
1853 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;
1854 2360
1855 $self->enter_link; 2361 $self->enter_link;
1856 2362
1857 (async { 2363 (async {
1858 my $map = eval { 2364 my $map = eval {
1859 my $map = cf::map::find $path; 2365 my $map = cf::map::find $path;
2366
2367 if ($map) {
1860 $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
1861 $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 $@;
1862 } or 2380 }
1863 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864 2381
2382 if ($gen == $self->{_goto_generation}) {
2383 delete $self->{_goto_generation};
1865 $self->leave_link ($map, $x, $y); 2384 $self->leave_link ($map, $x, $y);
2385 }
2386
2387 $done->() if $done;
1866 })->prio (1); 2388 })->prio (1);
1867} 2389}
1868 2390
1869=item $player_object->enter_exit ($exit_object) 2391=item $player_object->enter_exit ($exit_object)
1870 2392
1909 2431
1910 $rmp->{random_seed} ||= $exit->random_seed; 2432 $rmp->{random_seed} ||= $exit->random_seed;
1911 2433
1912 my $data = cf::to_json $rmp; 2434 my $data = cf::to_json $rmp;
1913 my $md5 = Digest::MD5::md5_hex $data; 2435 my $md5 = Digest::MD5::md5_hex $data;
1914 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2436 my $meta = "$RANDOMDIR/$md5.meta";
1915 2437
1916 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2438 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917 aio_write $fh, 0, (length $data), $data, 0; 2439 aio_write $fh, 0, (length $data), $data, 0;
1918 undef $fh; 2440 undef $fh;
1919 aio_rename "$meta~", $meta; 2441 aio_rename "$meta~", $meta;
1928 2450
1929 return unless $self->type == cf::PLAYER; 2451 return unless $self->type == cf::PLAYER;
1930 2452
1931 if ($exit->slaying eq "/!") { 2453 if ($exit->slaying eq "/!") {
1932 #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
1933 cf::sync_job { prepare_random_map $exit }; 2457 cf::sync_job { prepare_random_map $exit };
1934 } 2458 }
1935 2459
1936 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;
1937 my $hp = $exit->stats->hp; 2461 my $hp = $exit->stats->hp;
1938 my $sp = $exit->stats->sp; 2462 my $sp = $exit->stats->sp;
1939 2463
1940 $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);
1941 2469
1942 (async { 2470 (async {
1943 $self->deactivate_recursive; # just to be sure 2471 $self->deactivate_recursive; # just to be sure
1944 unless (eval { 2472 unless (eval {
1945 $self->goto ($slaying, $hp, $sp); 2473 $self->goto ($slaying, $hp, $sp);
1946 2474
1947 1; 2475 1;
1948 }) { 2476 }) {
1949 $self->message ("Something went wrong deep within the crossfire server. " 2477 $self->message ("Something went wrong deep within the crossfire server. "
1950 . "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. "
1951 . "Please report this to the dungeon master!", 2479 . "Please report this to the dungeon master!",
1952 cf::NDI_UNIQUE | cf::NDI_RED); 2480 cf::NDI_UNIQUE | cf::NDI_RED);
1953 2481
1954 warn "ERROR in enter_exit: $@"; 2482 warn "ERROR in enter_exit: $@";
1955 $self->leave_link; 2483 $self->leave_link;
1956 } 2484 }
1957 })->prio (1); 2485 })->prio (1);
1970 2498
1971sub cf::client::send_drawinfo { 2499sub cf::client::send_drawinfo {
1972 my ($self, $text, $flags) = @_; 2500 my ($self, $text, $flags) = @_;
1973 2501
1974 utf8::encode $text; 2502 utf8::encode $text;
1975 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2503 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976} 2504}
1977 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}
1978 2621
1979=item $success = $client->query ($flags, "text", \&cb) 2622=item $success = $client->query ($flags, "text", \&cb)
1980 2623
1981Queues a query to the client, calling the given callback with 2624Queues a query to the client, calling the given callback with
1982the 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>,
1983C<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>.
1984 2627
1985Queries 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
1986reliable at some point in the future. 2629become reliable at some point in the future.
1987 2630
1988=cut 2631=cut
1989 2632
1990sub cf::client::query { 2633sub cf::client::query {
1991 my ($self, $flags, $text, $cb) = @_; 2634 my ($self, $flags, $text, $cb) = @_;
1999 utf8::encode $text; 2642 utf8::encode $text;
2000 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2643 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001 2644
2002 $self->send_packet ($self->{query_queue}[0][0]) 2645 $self->send_packet ($self->{query_queue}[0][0])
2003 if @{ $self->{query_queue} } == 1; 2646 if @{ $self->{query_queue} } == 1;
2647
2648 1
2004} 2649}
2005 2650
2006cf::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 },
2007 on_reply => sub { 2657 on_reply => sub {
2008 my ($ns, $msg) = @_; 2658 my ($ns, $msg) = @_;
2009 2659
2010 # this weird shuffling is so that direct followup queries 2660 # this weird shuffling is so that direct followup queries
2011 # get handled first 2661 # get handled first
2023 } else { 2673 } else {
2024 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2674 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025 } 2675 }
2026 } 2676 }
2027 }, 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 },
2028); 2704);
2029 2705
2030=item $client->async (\&cb) 2706=item $client->async (\&cb)
2031 2707
2032Create a new coroutine, running the specified callback. The coroutine will 2708Create a new coroutine, running the specified callback. The coroutine will
2073our $safe = new Safe "safe"; 2749our $safe = new Safe "safe";
2074our $safe_hole = new Safe::Hole; 2750our $safe_hole = new Safe::Hole;
2075 2751
2076$SIG{FPE} = 'IGNORE'; 2752$SIG{FPE} = 'IGNORE';
2077 2753
2078$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));
2079 2759
2080# here we export the classes and methods available to script code 2760# here we export the classes and methods available to script code
2081 2761
2082=pod 2762=pod
2083 2763
2084The following fucntions and emthods are available within a safe environment: 2764The following functions and methods are available within a safe environment:
2085 2765
2086 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
2087 cf::object::player player 2770 cf::object::player
2088 cf::player peaceful 2771 player
2089 cf::map trigger 2772
2773 cf::player
2774 peaceful
2775
2776 cf::map
2777 trigger
2090 2778
2091=cut 2779=cut
2092 2780
2093for ( 2781for (
2094 ["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)],
2095 ["cf::object::player" => qw(player)], 2785 ["cf::object::player" => qw(player)],
2096 ["cf::player" => qw(peaceful)], 2786 ["cf::player" => qw(peaceful)],
2097 ["cf::map" => qw(trigger)], 2787 ["cf::map" => qw(trigger)],
2098) { 2788) {
2099 no strict 'refs'; 2789 no strict 'refs';
2170=back 2860=back
2171 2861
2172=cut 2862=cut
2173 2863
2174############################################################################# 2864#############################################################################
2175
2176=head2 EXTENSION DATABASE SUPPORT
2177
2178Crossfire maintains a very simple database for extension use. It can
2179currently store anything that can be serialised using Storable, which
2180excludes objects.
2181
2182The parameter C<$family> should best start with the name of the extension
2183using it, it should be unique.
2184
2185=over 4
2186
2187=item $hashref = cf::db_get $family
2188
2189Return a hashref for use by the extension C<$family>, which can be
2190modified. After modifications, you have to call C<cf::db_dirty> or
2191C<cf::db_sync>.
2192
2193=item $value = cf::db_get $family => $key
2194
2195Returns a single value from the database
2196
2197=item cf::db_put $family => $hashref
2198
2199Stores the given family hashref into the database. Updates are delayed, if
2200you want the data to be synced to disk immediately, use C<cf::db_sync>.
2201
2202=item cf::db_put $family => $key => $value
2203
2204Stores the given C<$value> in the family hash. Updates are delayed, if you
2205want the data to be synced to disk immediately, use C<cf::db_sync>.
2206
2207=item cf::db_dirty
2208
2209Marks the database as dirty, to be updated at a later time.
2210
2211=item cf::db_sync
2212
2213Immediately write the database to disk I<if it is dirty>.
2214
2215=cut
2216
2217our $DB;
2218
2219{
2220 my $path = cf::localdir . "/database.pst";
2221
2222 sub db_load() {
2223 $DB = stat $path ? Storable::retrieve $path : { };
2224 }
2225
2226 my $pid;
2227
2228 sub db_save() {
2229 waitpid $pid, 0 if $pid;
2230 if (0 == ($pid = fork)) {
2231 $DB->{_meta}{version} = 1;
2232 Storable::nstore $DB, "$path~";
2233 rename "$path~", $path;
2234 cf::_exit 0 if defined $pid;
2235 }
2236 }
2237
2238 my $dirty;
2239
2240 sub db_sync() {
2241 db_save if $dirty;
2242 undef $dirty;
2243 }
2244
2245 my $idle = Event->idle (
2246 reentrant => 0,
2247 min => 10,
2248 max => 20,
2249 repeat => 0,
2250 data => WF_AUTOCANCEL,
2251 cb => \&db_sync,
2252 );
2253
2254 sub db_dirty() {
2255 $dirty = 1;
2256 $idle->start;
2257 }
2258
2259 sub db_get($;$) {
2260 @_ >= 2
2261 ? $DB->{$_[0]}{$_[1]}
2262 : ($DB->{$_[0]} ||= { })
2263 }
2264
2265 sub db_put($$;$) {
2266 if (@_ >= 3) {
2267 $DB->{$_[0]}{$_[1]} = $_[2];
2268 } else {
2269 $DB->{$_[0]} = $_[1];
2270 }
2271 db_dirty;
2272 }
2273
2274 cf::global->attach (
2275 prio => 10000,
2276 on_cleanup => sub {
2277 db_sync;
2278 },
2279 );
2280}
2281
2282#############################################################################
2283# the server's init and main functions 2865# the server's init and main functions
2284 2866
2285sub load_resources { 2867sub load_facedata($) {
2286 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2868 my ($path) = @_;
2869
2870 # HACK to clear player env face cache, we need some signal framework
2871 # for this (global event?)
2872 %ext::player_env::MUSIC_FACE_CACHE = ();
2873
2874 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2875
2876 warn "loading facedata from $path\n";
2877
2878 my $facedata;
2879 0 < aio_load $path, $facedata
2880 or die "$path: $!";
2881
2882 $facedata = Coro::Storable::thaw $facedata;
2883
2884 $facedata->{version} == 2
2885 or cf::cleanup "$path: version mismatch, cannot proceed.";
2886
2887 # patch in the exptable
2888 $facedata->{resource}{"res/exp_table"} = {
2889 type => FT_RSRC,
2890 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2891 };
2892 cf::cede_to_tick;
2893
2894 {
2895 my $faces = $facedata->{faceinfo};
2896
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};
2903
2904 cf::cede_to_tick;
2905 }
2906
2907 while (my ($face, $info) = each %$faces) {
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 }
2917
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"
2287 or die "unable to load regions file\n";#d# 2999 or die "unable to load regions file\n";
2288}
2289 3000
2290sub cfg_load { 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 {
2291 open my $fh, "<:utf8", cf::confdir . "/config" 3044 open my $fh, "<:utf8", "$CONFDIR/config"
2292 or return; 3045 or return;
2293 3046
2294 local $/; 3047 local $/;
2295 *CFG = YAML::Syck::Load <$fh>; 3048 *CFG = YAML::Syck::Load <$fh>;
2296 3049
2304 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3057 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2305 and die "WARNING: m(un)lockall failed: $!\n"; 3058 and die "WARNING: m(un)lockall failed: $!\n";
2306 }; 3059 };
2307 warn $@ if $@; 3060 warn $@ if $@;
2308 } 3061 }
2309}
2310
2311sub init {
2312 load_resources;
2313} 3062}
2314 3063
2315sub main { 3064sub main {
2316 # we must not ever block the main coroutine 3065 # we must not ever block the main coroutine
2317 local $Coro::idle = sub { 3066 local $Coro::idle = sub {
2319 (async { 3068 (async {
2320 Event::one_event; 3069 Event::one_event;
2321 })->prio (Coro::PRIO_MAX); 3070 })->prio (Coro::PRIO_MAX);
2322 }; 3071 };
2323 3072
2324 cfg_load; 3073 reload_config;
2325 db_load; 3074 db_init;
2326 load_extensions; 3075 load_extensions;
2327 3076
2328 $TICK_WATCHER->start; 3077 $TICK_WATCHER->start;
2329 Event::loop; 3078 Event::loop;
2330} 3079}
2345 }, 3094 },
2346 ); 3095 );
2347 } 3096 }
2348} 3097}
2349 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
2350sub emergency_save() { 3137sub emergency_save() {
2351 my $freeze_guard = cf::freeze_mainloop; 3138 my $freeze_guard = cf::freeze_mainloop;
2352 3139
2353 warn "enter emergency perl save\n"; 3140 warn "enter emergency perl save\n";
2354 3141
2369 my $map = $cf::MAP{$path} or next; 3156 my $map = $cf::MAP{$path} or next;
2370 $map->valid or next; 3157 $map->valid or next;
2371 $map->save; 3158 $map->save;
2372 } 3159 }
2373 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";
2374 }; 3165 };
2375 3166
2376 warn "leave emergency perl save\n"; 3167 warn "leave emergency perl save\n";
2377} 3168}
2378 3169
3170sub post_cleanup {
3171 my ($make_core) = @_;
3172
3173 warn Carp::longmess "post_cleanup backtrace"
3174 if $make_core;
3175}
3176
2379sub reload() { 3177sub do_reload_perl() {
2380 # can/must only be called in main 3178 # can/must only be called in main
2381 if ($Coro::current != $Coro::main) { 3179 if ($Coro::current != $Coro::main) {
2382 warn "can only reload from main coroutine"; 3180 warn "can only reload from main coroutine";
2383 return; 3181 return;
2384 } 3182 }
2385 3183
2386 warn "reloading..."; 3184 warn "reloading...";
2387 3185
2388 warn "cancelling server ticker"; 3186 warn "entering sync_job";
2389 $TICK_WATCHER->cancel;
2390 3187
3188 cf::sync_job {
3189 cf::write_runtime; # external watchdog should not bark
2391 cf::emergency_save; 3190 cf::emergency_save;
3191 cf::write_runtime; # external watchdog should not bark
2392 3192
2393 eval { 3193 warn "syncing database to disk";
3194 BDB::db_env_txn_checkpoint $DB_ENV;
3195
2394 # 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
2395
2396 warn "syncing database to disk";
2397 cf::db_sync;
2398 3197
2399 warn "cancelling all WF_AUTOCANCEL watchers"; 3198 warn "cancelling all WF_AUTOCANCEL watchers";
2400 for (Event::all_watchers) { 3199 for (Event::all_watchers) {
2401 $_->cancel if $_->data & WF_AUTOCANCEL; 3200 $_->cancel if $_->data & WF_AUTOCANCEL;
2402 } 3201 }
2403 3202
2404 warn "flushing outstanding aio requests"; 3203 warn "flushing outstanding aio requests";
2405 for (;;) { 3204 for (;;) {
3205 BDB::flush;
2406 IO::AIO::flush; 3206 IO::AIO::flush;
2407 Coro::cede; 3207 Coro::cede;
2408 last unless IO::AIO::nreqs; 3208 last unless IO::AIO::nreqs || BDB::nreqs;
2409 warn "iterate..."; 3209 warn "iterate...";
2410 } 3210 }
3211
3212 ++$RELOAD;
2411 3213
2412 warn "cancelling all extension coros"; 3214 warn "cancelling all extension coros";
2413 $_->cancel for values %EXT_CORO; 3215 $_->cancel for values %EXT_CORO;
2414 %EXT_CORO = (); 3216 %EXT_CORO = ();
2415 3217
2416 warn "removing commands"; 3218 warn "removing commands";
2417 %COMMAND = (); 3219 %COMMAND = ();
2418 3220
2419 warn "removing ext commands"; 3221 warn "removing ext/exti commands";
2420 %EXTCMD = (); 3222 %EXTCMD = ();
3223 %EXTICMD = ();
2421 3224
2422 warn "unloading/nuking all extensions"; 3225 warn "unloading/nuking all extensions";
2423 for my $pkg (@EXTS) { 3226 for my $pkg (@EXTS) {
2424 warn "... unloading $pkg"; 3227 warn "... unloading $pkg";
2425 3228
2455 Symbol::delete_package "safe::$_" 3258 Symbol::delete_package "safe::$_"
2456 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);
2457 3260
2458 warn "unloading cf.pm \"a bit\""; 3261 warn "unloading cf.pm \"a bit\"";
2459 delete $INC{"cf.pm"}; 3262 delete $INC{"cf.pm"};
3263 delete $INC{"cf/pod.pm"};
2460 3264
2461 # don't, removes xs symbols, too, 3265 # don't, removes xs symbols, too,
2462 # and global variables created in xs 3266 # and global variables created in xs
2463 #Symbol::delete_package __PACKAGE__; 3267 #Symbol::delete_package __PACKAGE__;
2464 3268
2467 warn "reloading cf.pm"; 3271 warn "reloading cf.pm";
2468 require cf; 3272 require cf;
2469 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3273 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2470 3274
2471 warn "loading config and database again"; 3275 warn "loading config and database again";
2472 cf::cfg_load; 3276 cf::reload_config;
2473 cf::db_load;
2474 3277
2475 warn "loading extensions"; 3278 warn "loading extensions";
2476 cf::load_extensions; 3279 cf::load_extensions;
2477 3280
2478 warn "reattaching attachments to objects/players"; 3281 warn "reattaching attachments to objects/players";
2479 _global_reattach; 3282 _global_reattach; # objects, sockets
2480 warn "reattaching attachments to maps"; 3283 warn "reattaching attachments to maps";
2481 reattach $_ for values %MAP; 3284 reattach $_ for values %MAP;
3285 warn "reattaching attachments to players";
3286 reattach $_ for values %PLAYER;
2482 3287
2483 warn "loading reloadable resources"; 3288 warn "leaving sync_job";
2484 load_resources;
2485 3289
2486 warn "restarting server ticker"; 3290 1
2487 3291 } or do {
2488 $TICK_WATCHER->start;
2489 };
2490
2491 if ($@) {
2492 warn $@; 3292 warn $@;
2493 warn "error while reloading, exiting."; 3293 warn "error while reloading, exiting.";
2494 exit 1; 3294 exit 1;
2495 } 3295 };
2496 3296
2497 warn "reloaded"; 3297 warn "reloaded";
2498}; 3298};
2499 3299
2500our $RELOAD_WATCHER; # used only during reload 3300our $RELOAD_WATCHER; # used only during reload
2501 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
2502register_command "reload" => sub { 3317register_command "reload" => sub {
2503 my ($who, $arg) = @_; 3318 my ($who, $arg) = @_;
2504 3319
2505 if ($who->flag (FLAG_WIZ)) { 3320 if ($who->flag (FLAG_WIZ)) {
2506 $who->message ("reloading server."); 3321 $who->message ("reloading server.");
2507 3322 async { reload_perl };
2508 # doing reload synchronously and two reloads happen back-to-back,
2509 # coro crashes during coro_state_free->destroy here.
2510
2511 $RELOAD_WATCHER ||= Event->timer (
2512 reentrant => 0,
2513 after => 0,
2514 data => WF_AUTOCANCEL,
2515 cb => sub {
2516 reload;
2517 undef $RELOAD_WATCHER;
2518 },
2519 );
2520 } 3323 }
2521}; 3324};
2522 3325
2523unshift @INC, $LIBDIR; 3326unshift @INC, $LIBDIR;
2524 3327
2525my $bug_warning = 0; 3328my $bug_warning = 0;
2526 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;
2527$TICK_WATCHER = Event->timer ( 3353$TICK_WATCHER = Event->timer (
2528 reentrant => 0, 3354 reentrant => 0,
2529 parked => 1, 3355 parked => 1,
2530 prio => 0, 3356 prio => 0,
2531 at => $NEXT_TICK || $TICK, 3357 at => $NEXT_TICK || $TICK,
2535 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"
2536 unless ++$bug_warning > 10; 3362 unless ++$bug_warning > 10;
2537 return; 3363 return;
2538 } 3364 }
2539 3365
2540 $NOW = Event::time; 3366 $NOW = $tick_start = Event::time;
2541 3367
2542 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
2543 $RUNTIME += $TICK; 3393 $RUNTIME += $TICK;
2544 $NEXT_TICK += $TICK; 3394 $NEXT_TICK += $TICK;
2545 3395
2546 $WAIT_FOR_TICK->broadcast; 3396 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2547 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3397 $NEXT_RUNTIME_WRITE = $NOW + 10;
2548 3398 Coro::async_pool {
2549 Event::sweep; 3399 write_runtime
2550 Coro::cede_notself; 3400 or warn "ERROR: unable to write runtime file: $!";
3401 };
2551 3402 }
3403
2552# my $AFTER = Event::time; 3404# my $AFTER = Event::time;
2553# warn $AFTER - $NOW;#d# 3405# warn $AFTER - $NOW;#d#
2554 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
2555 # 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
2556 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3417 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2557 3418
2558 $TICK_WATCHER->at ($NEXT_TICK); 3419 $TICK_WATCHER->at ($NEXT_TICK);
2559 $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
2560 }, 3428 },
2561); 3429);
2562 3430
2563{ 3431{
2564 BDB::max_poll_time $TICK * 0.1; 3432 BDB::max_poll_time $TICK * 0.1;
2589 3457
2590 unless ($DB_ENV) { 3458 unless ($DB_ENV) {
2591 $DB_ENV = BDB::db_env_create; 3459 $DB_ENV = BDB::db_env_create;
2592 3460
2593 cf::sync_job { 3461 cf::sync_job {
3462 eval {
2594 BDB::db_env_open 3463 BDB::db_env_open
2595 $DB_ENV, 3464 $DB_ENV,
2596 $BDB_ENV_DIR, 3465 $BDBDIR,
2597 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3466 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2598 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3467 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2599 0666; 3468 0666;
2600 3469
2601 cf::cleanup "$!" if $!; 3470 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2602 3471
2603 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 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 $@;
2604 }; 3477 };
2605 } 3478 }
2606} 3479}
2607 3480
2608{ 3481{
2610 3483
2611 undef $Coro::AIO::WATCHER; 3484 undef $Coro::AIO::WATCHER;
2612 IO::AIO::max_poll_time $TICK * 0.1; 3485 IO::AIO::max_poll_time $TICK * 0.1;
2613 $AIO_POLL_WATCHER = Event->io ( 3486 $AIO_POLL_WATCHER = Event->io (
2614 reentrant => 0, 3487 reentrant => 0,
3488 data => WF_AUTOCANCEL,
2615 fd => IO::AIO::poll_fileno, 3489 fd => IO::AIO::poll_fileno,
2616 poll => 'r', 3490 poll => 'r',
2617 prio => 6, 3491 prio => 6,
2618 data => WF_AUTOCANCEL,
2619 cb => \&IO::AIO::poll_cb, 3492 cb => \&IO::AIO::poll_cb,
2620 ); 3493 );
2621} 3494}
2622 3495
2623$WRITE_RUNTIME_WATCHER = Event->timer ( 3496my $_log_backtrace;
2624 reentrant => 0, 3497
2625 data => WF_AUTOCANCEL, 3498sub _log_backtrace {
2626 after => 1, 3499 my ($msg, @addr) = @_;
2627 interval => 10, 3500
2628 prio => 6, # keep it lowest so it acts like a watchdog 3501 $msg =~ s/\n//;
2629 cb => Coro::unblock_sub { 3502
2630 write_runtime 3503 # limit the # of concurrent backtraces
2631 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";
2632 }, 3531 }
2633); 3532}
3533
3534# load additional modules
3535use cf::pod;
2634 3536
2635END { cf::emergency_save } 3537END { cf::emergency_save }
2636 3538
26371 35391
2638 3540

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines