ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.199 by root, Mon Jan 29 14:46:01 2007 UTC vs.
Revision 1.353 by root, Sun Sep 2 08:43:46 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines