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.139 by root, Fri Jan 5 19:12:03 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.3 (); 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 ();
28use Data::Dumper;
20use Digest::MD5; 29use Digest::MD5;
21use Fcntl; 30use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck (); 31use YAML::Syck ();
32use IO::AIO 2.32 ();
24use Time::HiRes; 33use Time::HiRes;
34use Compress::LZF;
35use Digest::MD5 ();
25 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
26use 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
27 44
28# 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?
29$YAML::Syck::ImplicitUnicode = 1; 46$YAML::Syck::ImplicitUnicode = 1;
30 47
31$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
32 49
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 51
35our %COMMAND = (); 52our %COMMAND = ();
36our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
54
55our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
58our %EXT_CORO = (); # coroutines bound to extensions
59our %EXT_MAP = (); # pluggable maps
38 60
61our $RELOAD; # number of reloads so far
39our @EVENT; 62our @EVENT;
40our $LIBDIR = datadir . "/ext";
41 63
42our $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(!)
43our $TICK_WATCHER; 77our $TICK_WATCHER;
78our $AIO_POLL_WATCHER;
79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 80our $NEXT_TICK;
45our $NOW; 81our $NOW;
82our $USE_FSYNC = 1; # use fsync to write maps - default off
83
84our $BDB_POLL_WATCHER;
85our $DB_ENV;
46 86
47our %CFG; 87our %CFG;
48 88
49our $UPTIME; $UPTIME ||= time; 89our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 90our $RUNTIME;
51 91
92our %PLAYER; # all users
52our %MAP; # all maps 93our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 94our $LINK_MAP; # the special {link} map, which is always available
54our $RANDOM_MAPS = cf::localdir . "/random"; 95
55our %EXT_CORO; 96# used to convert map paths into valid unix filenames by replacing / by ∕
97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
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
56 102
57binmode STDOUT; 103binmode STDOUT;
58binmode STDERR; 104binmode STDERR;
59 105
60# read virtual server time, if available 106# read virtual server time, if available
61unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
62 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
63 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
64 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
65} 111}
66 112
67mkdir cf::localdir; 113mkdir $_
68mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
69mkdir cf::localdir . "/" . cf::tmpdir;
70mkdir cf::localdir . "/" . cf::uniquedir;
71mkdir $RANDOM_MAPS;
72 115
73# a special map that is always available
74our $LINK_MAP;
75our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
117
118sub cf::map::normalise;
76 119
77############################################################################# 120#############################################################################
78 121
79=head2 GLOBAL VARIABLES 122=head2 GLOBAL VARIABLES
80 123
87=item $cf::RUNTIME 130=item $cf::RUNTIME
88 131
89The 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
90every server tick. 133every server tick.
91 134
92=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
93 138
94The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
95be 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.
96 143
97=item $cf::NOW 144=item $cf::NOW
98 145
99The time of the last (current) server tick. 146The time of the last (current) server tick.
100 147
101=item $cf::TICK 148=item $cf::TICK
102 149
103The 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.
104 161
105=item %cf::CFG 162=item %cf::CFG
106 163
107Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
108from wherever your confdir points to. 165from wherever your confdir points to.
166
167=item cf::wait_for_tick, cf::wait_for_tick_begin
168
169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
170returns directly I<after> the tick processing (and consequently, can only wake one process
171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
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.
109 178
110=back 179=back
111 180
112=cut 181=cut
113 182
114BEGIN { 183BEGIN {
115 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
116 my $msg = join "", @_; 185 my $msg = join "", @_;
117 utf8::encode $msg;
118 186
119 $msg .= "\n" 187 $msg .= "\n"
120 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
121 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
122 LOG llevError, "cfperl: $msg"; 193 LOG llevError, $msg;
123 }; 194 };
124} 195}
125 196
126@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
127@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
128@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
129@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
130@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';
131@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)
132 204
133# 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
134# within the Safe compartment. 206# within the Safe compartment.
135for my $pkg (qw( 207for my $pkg (qw(
136 cf::global cf::attachable 208 cf::global cf::attachable
145 217
146$Event::DIED = sub { 218$Event::DIED = sub {
147 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
148}; 220};
149 221
150my %ext_pkg; 222#############################################################################
151my @exts;
152my @hook;
153 223
154=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
155 225
156=over 4 226=over 4
157 227
158=cut 228=item dumpval $ref
159 229
160use JSON::Syck (); # TODO# replace by JSON::PC once working 230=cut
231
232sub dumpval {
233 eval {
234 local $SIG{__DIE__};
235 my $d;
236 if (1) {
237 $d = new Data::Dumper([$_[0]], ["*var"]);
238 $d->Terse(1);
239 $d->Indent(2);
240 $d->Quotekeys(0);
241 $d->Useqq(1);
242 #$d->Bless(...);
243 $d->Seen($_[1]) if @_ > 1;
244 $d = $d->Dump();
245 }
246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
247 $d
248 } || "[unable to dump $_[0]: '$@']";
249}
161 250
162=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
163 252
164Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
165 254
166=cut
167
168sub from_json($) {
169 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
170 JSON::Syck::Load $_[0]
171}
172
173=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
174 256
175Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
176 258
177=cut 259=cut
178 260
179sub to_json($) { 261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
180 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 262
181 JSON::Syck::Dump $_[0] 263sub to_json ($) { $json_coder->encode ($_[0]) }
182} 264sub from_json ($) { $json_coder->decode ($_[0]) }
183 265
184=item cf::lock_wait $string 266=item cf::lock_wait $string
185 267
186Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
187 269
190Wait 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
191a 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,
192for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
193returned. 275returned.
194 276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
279
195Lock 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
196uses 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.
197 286
198=cut 287=cut
199 288
200our %LOCK; 289our %LOCK;
201 290
221 # wake up all waiters, to be on the safe side 310 # wake up all waiters, to be on the safe side
222 $_->ready for @{ delete $LOCK{$key} }; 311 $_->ready for @{ delete $LOCK{$key} };
223 } 312 }
224} 313}
225 314
315sub lock_active($) {
316 my ($key) = @_;
317
318 ! ! $LOCK{$key}
319}
320
226sub freeze_mainloop { 321sub freeze_mainloop {
227 return unless $TICK_WATCHER->is_active; 322 return unless $TICK_WATCHER->is_active;
228 323
229 my $guard = Coro::guard { $TICK_WATCHER->start }; 324 my $guard = Coro::guard {
325 $TICK_WATCHER->start;
326 };
230 $TICK_WATCHER->stop; 327 $TICK_WATCHER->stop;
231 $guard 328 $guard
232} 329}
233 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;
385}
386
387=item cf::async { BLOCK }
388
389Currently the same as Coro::async_pool, meaning you cannot use
390C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
391thing you are allowed to do is call C<prio> on it.
392
393=cut
394
395BEGIN { *async = \&Coro::async_pool }
396
234=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
235 398
236The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
237always able to handle events or runnable, as crossfire+ is only partly 400is always able to handle events or runnable, as Crossfire TRT is only
238reentrant. 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.
239 403
240If 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
241the given BLOCK in another coroutine while waiting for the result. The 405the given BLOCK in another coroutine while waiting for the result. The
242server 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
243fast or be very important. 407fast or be very important.
246 410
247sub sync_job(&) { 411sub sync_job(&) {
248 my ($job) = @_; 412 my ($job) = @_;
249 413
250 if ($Coro::current == $Coro::main) { 414 if ($Coro::current == $Coro::main) {
415 my $time = Event::time;
416
251 # this is the main coro, too bad, we have to block 417 # this is the main coro, too bad, we have to block
252 # till the operation succeeds, freezing the server :/ 418 # till the operation succeeds, freezing the server :/
253 419
254 # TODO: use suspend/resume instead 420 # TODO: use suspend/resume instead
255 # (but this is cancel-safe) 421 # (but this is cancel-safe)
256 my $freeze_guard = freeze_mainloop; 422 my $freeze_guard = freeze_mainloop;
257 423
258 my $busy = 1; 424 my $busy = 1;
259 my @res; 425 my @res;
260 426
261 (Coro::async_pool { 427 (async {
262 @res = eval { $job->() }; 428 @res = eval { $job->() };
263 warn $@ if $@; 429 warn $@ if $@;
264 undef $busy; 430 undef $busy;
265 })->prio (Coro::PRIO_MAX); 431 })->prio (Coro::PRIO_MAX);
266 432
267 while ($busy) { 433 while ($busy) {
268 unless (Coro::cede) { 434 Coro::cede or Event::one_event;
269 Coro::nready ? Event::one_event 0 : Event::one_event;
270 Coro::cede_notself unless Coro::cede;
271 } 435 }
272 } 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
273 443
274 wantarray ? @res : $res[0] 444 wantarray ? @res : $res[0]
275 } else { 445 } else {
276 # we are in another coroutine, how wonderful, everything just works 446 # we are in another coroutine, how wonderful, everything just works
277 447
278 $job->() 448 $job->()
279 } 449 }
280} 450}
281 451
282=item $coro = cf::coro { BLOCK } 452=item $coro = cf::async_ext { BLOCK }
283 453
284Creates (and readies) and returns a new coro. This coro is automcatially 454Like async, but this coro is automatically being canceled when the
285being canceled when the extension calling this is being unloaded. 455extension calling this is being unloaded.
286 456
287=cut 457=cut
288 458
289sub coro(&) { 459sub async_ext(&) {
290 my $cb = shift; 460 my $cb = shift;
291 461
292 my $coro = &Coro::async_pool ($cb); 462 my $coro = &Coro::async ($cb);
293 463
294 $coro->on_destroy (sub { 464 $coro->on_destroy (sub {
295 delete $EXT_CORO{$coro+0}; 465 delete $EXT_CORO{$coro+0};
296 }); 466 });
297 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
298 468
299 $coro 469 $coro
300} 470}
301 471
302sub write_runtime { 472=item fork_call { }, $args
303 my $runtime = cf::localdir . "/runtime";
304 473
305 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 474Executes the given code block with the given arguments in a seperate
306 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.
307 478
308 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 479=cut
309 (aio_write $fh, 0, (length $value), $value, 0) <= 0
310 and return;
311 480
312 aio_fsync $fh 481sub fork_call(&@) {
313 and return; 482 my ($cb, @args) = @_;
314 483
315 close $fh 484 # we seemingly have to make a local copy of the whole thing,
316 or return; 485 # otherwise perl prematurely frees the stuff :/
486 # TODO: investigate and fix (liekly this will be rather laborious)
317 487
318 aio_rename "$runtime~", $runtime 488 my @res = Coro::Util::fork_eval {
319 and return; 489 reset_signals;
490 &$cb
491 }, @args;
320 492
493 wantarray ? @res : $res[-1]
494}
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 };
321 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 });
322} 621}
323 622
324=back 623=back
325 624
326=cut 625=cut
327
328#############################################################################
329
330package cf::path;
331
332sub new {
333 my ($class, $path, $base) = @_;
334
335 $path = $path->as_string if ref $path;
336
337 my $self = bless { }, $class;
338
339 # {... are special paths that are not touched
340 # ?xxx/... are special absolute paths
341 # ?random/... random maps
342 # /! non-realised random map exit
343 # /... normal maps
344 # ~/... per-player maps without a specific player (DO NOT USE)
345 # ~user/... per-player map of a specific user
346
347 if ($path =~ /^{/) {
348 # fine as it is
349 } elsif ($path =~ s{^\?random/}{}) {
350 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
351 $self->{random} = cf::from_json $data;
352 } else {
353 if ($path =~ s{^~([^/]+)?}{}) {
354 $self->{user_rel} = 1;
355
356 if (defined $1) {
357 $self->{user} = $1;
358 } elsif ($base =~ m{^~([^/]+)/}) {
359 $self->{user} = $1;
360 } else {
361 warn "cannot resolve user-relative path without user <$path,$base>\n";
362 }
363 } elsif ($path =~ /^\//) {
364 # already absolute
365 } else {
366 $base =~ s{[^/]+/?$}{};
367 return $class->new ("$base/$path");
368 }
369
370 for ($path) {
371 redo if s{/\.?/}{/};
372 redo if s{/[^/]+/\.\./}{/};
373 }
374 }
375
376 $self->{path} = $path;
377
378 $self
379}
380
381# the name / primary key / in-game path
382sub as_string {
383 my ($self) = @_;
384
385 $self->{user_rel} ? "~$self->{user}$self->{path}"
386 : $self->{random} ? "?random/$self->{path}"
387 : $self->{path}
388}
389
390# the displayed name, this is a one way mapping
391sub visible_name {
392 my ($self) = @_;
393
394# if (my $rmp = $self->{random}) {
395# # todo: be more intelligent about this
396# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
397# } else {
398 $self->as_string
399# }
400}
401
402# escape the /'s in the path
403sub _escaped_path {
404 # ∕ is U+2215
405 (my $path = $_[0]{path}) =~ s/\//∕/g;
406 $path
407}
408
409# the original (read-only) location
410sub load_path {
411 my ($self) = @_;
412
413 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
414}
415
416# the temporary/swap location
417sub save_path {
418 my ($self) = @_;
419
420 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
421 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
422 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
423}
424
425# the unique path, might be eq to save_path
426sub uniq_path {
427 my ($self) = @_;
428
429 $self->{user_rel} || $self->{random}
430 ? undef
431 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
432}
433
434# return random map parameters, or undef
435sub random_map_params {
436 my ($self) = @_;
437
438 $self->{random}
439}
440
441# this is somewhat ugly, but style maps do need special treatment
442sub is_style_map {
443 $_[0]{path} =~ m{^/styles/}
444}
445
446package cf;
447 626
448############################################################################# 627#############################################################################
449 628
450=head2 ATTACHABLE OBJECTS 629=head2 ATTACHABLE OBJECTS
451 630
453attach callbacks/event handlers (a collection of which is called an "attachment") 632attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
455 634
456In 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>
457C<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
458crossfire+). 637Crossfire TRT).
459 638
460=over 4 639=over 4
461 640
462=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
463 642
577our @CB_TYPE = (); # registry for type (cf-object class) based events 756our @CB_TYPE = (); # registry for type (cf-object class) based events
578our @CB_MAP = (); 757our @CB_MAP = ();
579 758
580my %attachment; 759my %attachment;
581 760
761sub cf::attachable::thawer_merge {
762 # simply override everything except _meta
763 local $_[0]{_meta};
764 %{$_[0]} = %{$_[1]};
765}
766
582sub _attach_cb($$$$) { 767sub _attach_cb($$$$) {
583 my ($registry, $event, $prio, $cb) = @_; 768 my ($registry, $event, $prio, $cb) = @_;
584 769
585 use sort 'stable'; 770 use sort 'stable';
586 771
620 $registry = $CB_TYPE[$object_type] ||= []; 805 $registry = $CB_TYPE[$object_type] ||= [];
621 806
622 } elsif ($type eq "subtype") { 807 } elsif ($type eq "subtype") {
623 defined $object_type or Carp::croak "subtype specified without type"; 808 defined $object_type or Carp::croak "subtype specified without type";
624 my $object_subtype = shift @arg; 809 my $object_subtype = shift @arg;
625 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 810 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
626 811
627 } elsif ($type eq "package") { 812 } elsif ($type eq "package") {
628 my $pkg = shift @arg; 813 my $pkg = shift @arg;
629 814
630 while (my ($name, $id) = each %cb_id) { 815 while (my ($name, $id) = each %cb_id) {
659 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
660 } 845 }
661 846
662 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
663 } else { 848 } else {
664 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
665 } 850 }
666 851
667 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
668} 853}
669 854
671 if (ref $_[0]) { 856 if (ref $_[0]) {
672 _object_attach @_; 857 _object_attach @_;
673 } else { 858 } else {
674 _attach shift->_attach_registry, @_; 859 _attach shift->_attach_registry, @_;
675 } 860 }
861 _recalc_want;
676}; 862};
677 863
678# all those should be optimised 864# all those should be optimised
679sub cf::attachable::detach { 865sub cf::attachable::detach {
680 my ($obj, $name) = @_; 866 my ($obj, $name) = @_;
683 delete $obj->{_attachment}{$name}; 869 delete $obj->{_attachment}{$name};
684 reattach ($obj); 870 reattach ($obj);
685 } else { 871 } else {
686 Carp::croak "cannot, currently, detach class attachments"; 872 Carp::croak "cannot, currently, detach class attachments";
687 } 873 }
874 _recalc_want;
688}; 875};
689 876
690sub cf::attachable::attached { 877sub cf::attachable::attached {
691 my ($obj, $name) = @_; 878 my ($obj, $name) = @_;
692 879
707 "; 894 ";
708 die if $@; 895 die if $@;
709} 896}
710 897
711our $override; 898our $override;
712our @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?
713 900
714sub override { 901sub override {
715 $override = 1; 902 $override = 1;
716 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
717} 904}
718 905
719sub do_invoke { 906sub do_invoke {
720 my $event = shift; 907 my $event = shift;
721 my $callbacks = shift; 908 my $callbacks = shift;
722 909
723 @invoke_results = (); 910 @INVOKE_RESULTS = ();
724 911
725 local $override; 912 local $override;
726 913
727 for (@$callbacks) { 914 for (@$callbacks) {
728 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
745 932
746Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
747 934
748This 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
749removed 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
750results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
751 938
752=back 939=back
753 940
754=cut 941=cut
755 942
756############################################################################# 943#############################################################################
757# 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}
758 956
759sub reattach { 957sub reattach {
760 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
761 my ($obj) = @_; 959 my ($obj) = @_;
960
961 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
762 962
763 my $registry = $obj->registry; 963 my $registry = $obj->registry;
764 964
765 @$registry = (); 965 @$registry = ();
766 966
813 $filename, length $$rdata, scalar @$objs; 1013 $filename, length $$rdata, scalar @$objs;
814 1014
815 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1015 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
816 chmod SAVE_MODE, $fh; 1016 chmod SAVE_MODE, $fh;
817 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1017 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
818 aio_fsync $fh; 1018 aio_fsync $fh if $cf::USE_FSYNC;
819 close $fh; 1019 close $fh;
820 1020
821 if (@$objs) { 1021 if (@$objs) {
822 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) {
823 chmod SAVE_MODE, $fh; 1023 chmod SAVE_MODE, $fh;
824 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1024 my $data = Storable::nfreeze { version => 1, objs => $objs };
825 aio_write $fh, 0, (length $data), $data, 0; 1025 aio_write $fh, 0, (length $data), $data, 0;
826 aio_fsync $fh; 1026 aio_fsync $fh if $cf::USE_FSYNC;
827 close $fh; 1027 close $fh;
828 aio_rename "$filename.pst~", "$filename.pst"; 1028 aio_rename "$filename.pst~", "$filename.pst";
829 } 1029 }
830 } else { 1030 } else {
831 aio_unlink "$filename.pst"; 1031 aio_unlink "$filename.pst";
863 or return; 1063 or return;
864 $av = eval { (Storable::thaw $av)->{objs} }; 1064 $av = eval { (Storable::thaw $av)->{objs} };
865 } 1065 }
866 1066
867 warn sprintf "loading %s (%d)\n", 1067 warn sprintf "loading %s (%d)\n",
868 $filename, length $data, scalar @{$av || []};#d# 1068 $filename, length $data, scalar @{$av || []};
869 return ($data, $av); 1069 return ($data, $av);
870} 1070}
1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
871 1077
872############################################################################# 1078#############################################################################
873# command handling &c 1079# command handling &c
874 1080
875=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
888 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
889} 1095}
890 1096
891=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
892 1098
893Register 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.
894 1104
895If 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
896called. 1106called.
897 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
898=cut 1119=cut
899 1120
900sub register_extcmd { 1121sub register_extcmd {
901 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
902 1123
903 my $caller = caller;
904 #warn "registering extcmd '$name' to '$caller'";
905
906 $EXTCMD{$name} = [$cb, $caller]; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
907} 1131}
908 1132
909cf::player->attach ( 1133cf::player->attach (
910 on_command => sub { 1134 on_command => sub {
911 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
920 cf::override; 1144 cf::override;
921 }, 1145 },
922 on_extcmd => sub { 1146 on_extcmd => sub {
923 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
924 1148
925 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
926 1150
927 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
928 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
929 if (my %reply = $cb->[0]->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
930 $pl->ext_reply ($msg->{msgid}, %reply);
931 }
932 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
933 } else { 1166 } else {
934 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
935 } 1168 }
936 1169
937 cf::override; 1170 cf::override;
938 }, 1171 },
939); 1172);
940 1173
941sub register {
942 my ($base, $pkg) = @_;
943
944 #TODO
945}
946
947sub load_extension { 1174sub load_extensions {
1175 cf::sync_job {
1176 my %todo;
1177
1178 for my $path (<$LIBDIR/*.ext>) {
1179 next unless -r $path;
1180
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;
1238 }
1239
1240 skip:
1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1242 unless $progress;
1243 }
1244 };
1245}
1246
1247#############################################################################
1248
1249=back
1250
1251=head2 CORE EXTENSIONS
1252
1253Functions and methods that extend core crossfire objects.
1254
1255=cut
1256
1257package cf::player;
1258
1259use Coro::AIO;
1260
1261=head3 cf::player
1262
1263=over 4
1264
1265=item cf::player::find $login
1266
1267Returns the given player object, loading it if necessary (might block).
1268
1269=cut
1270
1271sub playerdir($) {
1272 "$PLAYERDIR/"
1273 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1274}
1275
1276sub path($) {
1277 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1278
1279 (playerdir $login) . "/playerdata"
1280}
1281
1282sub find_active($) {
1283 $cf::PLAYER{$_[0]}
1284 and $cf::PLAYER{$_[0]}->active
1285 and $cf::PLAYER{$_[0]}
1286}
1287
1288sub exists($) {
1289 my ($login) = @_;
1290
1291 $cf::PLAYER{$login}
1292 or cf::sync_job { !aio_stat path $login }
1293}
1294
1295sub find($) {
1296 return $cf::PLAYER{$_[0]} || do {
1297 my $login = $_[0];
1298
1299 my $guard = cf::lock_acquire "user_find:$login";
1300
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
1309 my $pl = load_pl path $login
1310 or return;
1311 $cf::PLAYER{$login} = $pl
1312 }
1313 }
1314}
1315
1316sub save($) {
1317 my ($pl) = @_;
1318
1319 return if $pl->{deny_save};
1320
1321 my $path = path $pl;
1322 my $guard = cf::lock_acquire "user_save:$path";
1323
1324 return if $pl->{deny_save};
1325
1326 aio_mkdir playerdir $pl, 0770;
1327 $pl->{last_save} = $cf::RUNTIME;
1328
1329 $pl->save_pl ($path);
1330 cf::cede_to_tick;
1331}
1332
1333sub new($) {
1334 my ($login) = @_;
1335
1336 my $self = create;
1337
1338 $self->ob->name ($login);
1339 $self->{deny_save} = 1;
1340
1341 $cf::PLAYER{$login} = $self;
1342
1343 $self
1344}
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
1356=item $pl->quit_character
1357
1358Nukes the player without looking back. If logged in, the connection will
1359be destroyed. May block for a long time.
1360
1361=cut
1362
1363sub quit_character {
1364 my ($pl) = @_;
1365
1366 my $name = $pl->ob->name;
1367
1368 $pl->{deny_save} = 1;
1369 $pl->password ("*"); # this should lock out the player until we nuked the dir
1370
1371 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1372 $pl->deactivate;
1373 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1374 $pl->ns->destroy if $pl->ns;
1375
1376 my $path = playerdir $pl;
1377 my $temp = "$path~$cf::RUNTIME~deleting~";
1378 aio_rename $path, $temp;
1379 delete $cf::PLAYER{$pl->ob->name};
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
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;
1402}
1403
1404=item cf::player::list_logins
1405
1406Returns am arrayref of all valid playernames in the system, can take a
1407while and may block, so not sync_job-capable, ever.
1408
1409=cut
1410
1411sub list_logins {
1412 my $dirs = aio_readdir $PLAYERDIR
1413 or return [];
1414
1415 my @logins;
1416
1417 for my $login (@$dirs) {
1418 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1419 aio_read $fh, 0, 512, my $buf, 0 or next;
1420 $buf !~ /^password -------------$/m or next; # official not-valid tag
1421
1422 utf8::decode $login;
1423 push @logins, $login;
1424 }
1425
1426 \@logins
1427}
1428
1429=item $player->maps
1430
1431Returns an arrayref of map paths that are private for this
1432player. May block.
1433
1434=cut
1435
1436sub maps($) {
1437 my ($pl) = @_;
1438
1439 $pl = ref $pl ? $pl->ob->name : $pl;
1440
1441 my $files = aio_readdir playerdir $pl
1442 or return;
1443
1444 my @paths;
1445
1446 for (@$files) {
1447 utf8::decode $_;
1448 next if /\.(?:pl|pst)$/;
1449 next unless /^$PATH_SEP/o;
1450
1451 push @paths, cf::map::normalise "~$pl/$_";
1452 }
1453
1454 \@paths
1455}
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
1508=item $player->ext_reply ($msgid, @msg)
1509
1510Sends an ext reply to the player.
1511
1512=cut
1513
1514sub ext_reply($$@) {
1515 my ($self, $id, @msg) = @_;
1516
1517 $self->ns->ext_reply ($id, @msg)
1518}
1519
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($) {
948 my ($path) = @_; 1547 my ($path) = @_;
949 1548
950 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1549 my ($match, $specificity);
951 my $base = $1;
952 my $pkg = $1;
953 $pkg =~ s/[^[:word:]]/_/g;
954 $pkg = "ext::$pkg";
955 1550
956 warn "loading '$path' into '$pkg'\n"; 1551 for my $region (list) {
957 1552 if ($region->{match} && $path =~ $region->{match}) {
958 open my $fh, "<:utf8", $path 1553 ($match, $specificity) = ($region, $region->specificity)
959 or die "$path: $!"; 1554 if $region->specificity > $specificity;
960 1555 }
961 my $source =
962 "package $pkg; use strict; use utf8;\n"
963 . "#line 1 \"$path\"\n{\n"
964 . (do { local $/; <$fh> })
965 . "\n};\n1";
966
967 eval $source
968 or die $@ ? "$path: $@\n"
969 : "extension disabled.\n";
970
971 push @exts, $pkg;
972 $ext_pkg{$base} = $pkg;
973
974# no strict 'refs';
975# @{"$pkg\::ISA"} = ext::;
976
977 register $base, $pkg;
978}
979
980sub unload_extension {
981 my ($pkg) = @_;
982
983 warn "removing extension $pkg\n";
984
985 # remove hooks
986 #TODO
987# for my $idx (0 .. $#PLUGIN_EVENT) {
988# delete $hook[$idx]{$pkg};
989# } 1556 }
990 1557
991 # remove commands 1558 $match
992 for my $name (keys %COMMAND) {
993 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
994
995 if (@cb) {
996 $COMMAND{$name} = \@cb;
997 } else {
998 delete $COMMAND{$name};
999 }
1000 }
1001
1002 # remove extcmds
1003 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1004 delete $EXTCMD{$name};
1005 }
1006
1007 if (my $cb = $pkg->can ("unload")) {
1008 eval {
1009 $cb->($pkg);
1010 1
1011 } or warn "$pkg unloaded, but with errors: $@";
1012 }
1013
1014 Symbol::delete_package $pkg;
1015}
1016
1017sub load_extensions {
1018 for my $ext (<$LIBDIR/*.ext>) {
1019 next unless -r $ext;
1020 eval {
1021 load_extension $ext;
1022 1
1023 } or warn "$ext not loaded: $@";
1024 }
1025}
1026
1027#############################################################################
1028# load/save/clean perl data associated with a map
1029
1030*cf::mapsupport::on_clean = sub {
1031 my ($map) = @_;
1032
1033 my $path = $map->tmpname;
1034 defined $path or return;
1035
1036 unlink "$path.pst";
1037};
1038
1039cf::map->attach (prio => -10000, package => cf::mapsupport::);
1040
1041#############################################################################
1042# load/save perl data associated with player->ob objects
1043
1044sub all_objects(@) {
1045 @_, map all_objects ($_->inv), @_
1046}
1047
1048# TODO: compatibility cruft, remove when no longer needed
1049cf::player->attach (
1050 on_load => sub {
1051 my ($pl, $path) = @_;
1052
1053 for my $o (all_objects $pl->ob) {
1054 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1055 $o->set_ob_key_value ("_perl_data");
1056
1057 %$o = %{ Storable::thaw pack "H*", $value };
1058 }
1059 }
1060 },
1061);
1062
1063#############################################################################
1064
1065=head2 CORE EXTENSIONS
1066
1067Functions and methods that extend core crossfire objects.
1068
1069=head3 cf::player
1070
1071=over 4
1072
1073=item cf::player::exists $login
1074
1075Returns true when the given account exists.
1076
1077=cut
1078
1079sub cf::player::exists($) {
1080 cf::player::find $_[0]
1081 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1082}
1083
1084=item $player->ext_reply ($msgid, $msgtype, %msg)
1085
1086Sends an ext reply to the player.
1087
1088=cut
1089
1090sub cf::player::ext_reply($$$%) {
1091 my ($self, $id, %msg) = @_;
1092
1093 $msg{msgid} = $id;
1094
1095 $self->send ("ext " . to_json \%msg);
1096} 1559}
1097 1560
1098=back 1561=back
1099
1100 1562
1101=head3 cf::map 1563=head3 cf::map
1102 1564
1103=over 4 1565=over 4
1104 1566
1107package cf::map; 1569package cf::map;
1108 1570
1109use Fcntl; 1571use Fcntl;
1110use Coro::AIO; 1572use Coro::AIO;
1111 1573
1574use overload
1575 '""' => \&as_string,
1576 fallback => 1;
1577
1112our $MAX_RESET = 3600; 1578our $MAX_RESET = 3600;
1113our $DEFAULT_RESET = 3000; 1579our $DEFAULT_RESET = 3000;
1114 1580
1115sub generate_random_map { 1581sub generate_random_map {
1116 my ($path, $rmp) = @_; 1582 my ($self, $rmp) = @_;
1117
1118 # mit "rum" bekleckern, nicht 1583 # mit "rum" bekleckern, nicht
1119 cf::map::_create_random_map 1584 $self->_create_random_map (
1120 $path,
1121 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1585 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1122 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1586 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1123 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1587 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1124 $rmp->{exit_on_final_map}, 1588 $rmp->{exit_on_final_map},
1125 $rmp->{xsize}, $rmp->{ysize}, 1589 $rmp->{xsize}, $rmp->{ysize},
1126 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1590 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1127 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1591 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1128 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1592 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1129 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1593 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1130 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1594 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1131 (cf::region::find $rmp->{region}) 1595 (cf::region::find $rmp->{region}), $rmp->{custom}
1596 )
1597}
1598
1599=item cf::map->register ($regex, $prio)
1600
1601Register a handler for the map path matching the given regex at the
1602givne priority (higher is better, built-in handlers have priority 0, the
1603default).
1604
1605=cut
1606
1607sub register {
1608 my (undef, $regex, $prio) = @_;
1609 my $pkg = caller;
1610
1611 no strict;
1612 push @{"$pkg\::ISA"}, __PACKAGE__;
1613
1614 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1615}
1616
1617# also paths starting with '/'
1618$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1619
1620sub thawer_merge {
1621 my ($self, $merge) = @_;
1622
1623 # we have to keep some variables in memory intact
1624 local $self->{path};
1625 local $self->{load_path};
1626
1627 $self->SUPER::thawer_merge ($merge);
1628}
1629
1630sub normalise {
1631 my ($path, $base) = @_;
1632
1633 $path = "$path"; # make sure its a string
1634
1635 $path =~ s/\.map$//;
1636
1637 # map plan:
1638 #
1639 # /! non-realised random map exit (special hack!)
1640 # {... are special paths that are not being touched
1641 # ?xxx/... are special absolute paths
1642 # ?random/... random maps
1643 # /... normal maps
1644 # ~user/... per-player map of a specific user
1645
1646 $path =~ s/$PATH_SEP/\//go;
1647
1648 # treat it as relative path if it starts with
1649 # something that looks reasonable
1650 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1651 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1652
1653 $base =~ s{[^/]+/?$}{};
1654 $path = "$base/$path";
1655 }
1656
1657 for ($path) {
1658 redo if s{//}{/};
1659 redo if s{/\.?/}{/};
1660 redo if s{/[^/]+/\.\./}{/};
1661 }
1662
1663 $path
1664}
1665
1666sub new_from_path {
1667 my (undef, $path, $base) = @_;
1668
1669 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1670
1671 $path = normalise $path, $base;
1672
1673 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1674 if ($path =~ $EXT_MAP{$pkg}[1]) {
1675 my $self = bless cf::map::new, $pkg;
1676 $self->{path} = $path; $self->path ($path);
1677 $self->init; # pass $1 etc.
1678 return $self;
1679 }
1680 }
1681
1682 Carp::cluck "unable to resolve path '$path' (base '$base').";
1683 ()
1684}
1685
1686sub init {
1687 my ($self) = @_;
1688
1689 $self
1690}
1691
1692sub as_string {
1693 my ($self) = @_;
1694
1695 "$self->{path}"
1696}
1697
1698# the displayed name, this is a one way mapping
1699sub visible_name {
1700 &as_string
1701}
1702
1703# the original (read-only) location
1704sub load_path {
1705 my ($self) = @_;
1706
1707 "$MAPDIR/$self->{path}.map"
1708}
1709
1710# the temporary/swap location
1711sub save_path {
1712 my ($self) = @_;
1713
1714 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1715 "$TMPDIR/$path.map"
1716}
1717
1718# the unique path, undef == no special unique path
1719sub uniq_path {
1720 my ($self) = @_;
1721
1722 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1723 "$UNIQUEDIR/$path"
1132} 1724}
1133 1725
1134# and all this just because we cannot iterate over 1726# and all this just because we cannot iterate over
1135# all maps in C++... 1727# all maps in C++...
1136sub change_all_map_light { 1728sub change_all_map_light {
1138 1730
1139 $_->change_map_light ($change) 1731 $_->change_map_light ($change)
1140 for grep $_->outdoor, values %cf::MAP; 1732 for grep $_->outdoor, values %cf::MAP;
1141} 1733}
1142 1734
1735sub decay_objects {
1736 my ($self) = @_;
1737
1738 return if $self->{deny_reset};
1739
1740 $self->do_decay_objects;
1741}
1742
1743sub unlink_save {
1744 my ($self) = @_;
1745
1746 utf8::encode (my $save = $self->save_path);
1747 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1748 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1749}
1750
1143sub try_load_header($) { 1751sub load_header_from($) {
1144 my ($path) = @_; 1752 my ($self, $path) = @_;
1145 1753
1146 utf8::encode $path; 1754 utf8::encode $path;
1147 aio_open $path, O_RDONLY, 0 1755 #aio_open $path, O_RDONLY, 0
1756 # or return;
1757
1758 $self->_load_header ($path)
1148 or return; 1759 or return;
1149 1760
1150 my $map = cf::map::new 1761 $self->{load_path} = $path;
1762
1763 1
1764}
1765
1766sub load_header_orig {
1767 my ($self) = @_;
1768
1769 $self->load_header_from ($self->load_path)
1770}
1771
1772sub load_header_temp {
1773 my ($self) = @_;
1774
1775 $self->load_header_from ($self->save_path)
1776}
1777
1778sub prepare_temp {
1779 my ($self) = @_;
1780
1781 $self->last_access ((delete $self->{last_access})
1782 || $cf::RUNTIME); #d#
1783 # safety
1784 $self->{instantiate_time} = $cf::RUNTIME
1785 if $self->{instantiate_time} > $cf::RUNTIME;
1786}
1787
1788sub prepare_orig {
1789 my ($self) = @_;
1790
1791 $self->{load_original} = 1;
1792 $self->{instantiate_time} = $cf::RUNTIME;
1793 $self->last_access ($cf::RUNTIME);
1794 $self->instantiate;
1795}
1796
1797sub load_header {
1798 my ($self) = @_;
1799
1800 if ($self->load_header_temp) {
1801 $self->prepare_temp;
1802 } else {
1803 $self->load_header_orig
1151 or return; 1804 or return;
1805 $self->prepare_orig;
1806 }
1152 1807
1153 # for better error messages only, will be overwritten 1808 $self->{deny_reset} = 1
1154 $map->path ($path); 1809 if $self->no_reset;
1155 1810
1156 $map->load_header ($path) 1811 $self->default_region (cf::region::find_by_path $self->{path})
1157 or return; 1812 unless $self->default_region;
1158 1813
1159 $map->{load_path} = $path; 1814 1
1160
1161 $map
1162} 1815}
1163 1816
1164sub find; 1817sub find;
1165sub find { 1818sub find {
1166 my ($path, $origin) = @_; 1819 my ($path, $origin) = @_;
1167 1820
1168 #warn "find<$path,$origin>\n";#d#
1169
1170 $path = new cf::path $path, $origin && $origin->path; 1821 $path = normalise $path, $origin && $origin->path;
1171 my $key = $path->as_string;
1172 1822
1173 cf::lock_wait "map_find:$key"; 1823 cf::lock_wait "map_find:$path";
1174 1824
1175 $cf::MAP{$key} || do { 1825 $cf::MAP{$path} || do {
1176 my $guard = cf::lock_acquire "map_find:$key"; 1826 my $guard = cf::lock_acquire "map_find:$path";
1177 1827 my $map = new_from_path cf::map $path
1178 # do it the slow way
1179 my $map = try_load_header $path->save_path;
1180
1181 Coro::cede;
1182
1183 if ($map) {
1184 $map->last_access ((delete $map->{last_access})
1185 || $cf::RUNTIME); #d#
1186 # safety
1187 $map->{instantiate_time} = $cf::RUNTIME
1188 if $map->{instantiate_time} > $cf::RUNTIME;
1189 } else {
1190 if (my $rmp = $path->random_map_params) {
1191 $map = generate_random_map $key, $rmp;
1192 } else {
1193 $map = try_load_header $path->load_path;
1194 }
1195
1196 $map or return; 1828 or return;
1197 1829
1198 $map->{load_original} = 1;
1199 $map->{instantiate_time} = $cf::RUNTIME;
1200 $map->last_access ($cf::RUNTIME);
1201 $map->instantiate;
1202
1203 # per-player maps become, after loading, normal maps
1204 $map->per_player (0) if $path->{user_rel};
1205 }
1206
1207 $map->path ($key);
1208 $map->{path} = $path;
1209 $map->{last_save} = $cf::RUNTIME; 1830 $map->{last_save} = $cf::RUNTIME;
1210 1831
1211 Coro::cede; 1832 $map->load_header
1833 or return;
1212 1834
1213 if ($map->should_reset) { 1835 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1836 # doing this can freeze the server in a sync job, obviously
1837 #$cf::WAIT_FOR_TICK->wait;
1214 $map->reset; 1838 $map->reset;
1215 undef $guard; 1839 undef $guard;
1216 $map = find $path 1840 return find $path;
1217 or return;
1218 } 1841 }
1219 1842
1220 $cf::MAP{$key} = $map 1843 $cf::MAP{$path} = $map
1221 } 1844 }
1222} 1845}
1846
1847sub pre_load { }
1848sub post_load { }
1223 1849
1224sub load { 1850sub load {
1225 my ($self) = @_; 1851 my ($self) = @_;
1226 1852
1853 local $self->{deny_reset} = 1; # loading can take a long time
1854
1227 my $path = $self->{path}; 1855 my $path = $self->{path};
1856
1857 {
1858 my $guard1 = cf::lock_acquire "map_data:$path";
1228 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1859 my $guard2 = cf::lock_acquire "map_load:$path";
1229 1860
1230 return if $self->in_memory != cf::MAP_SWAPPED; 1861 return if $self->in_memory != cf::MAP_SWAPPED;
1231 1862
1232 $self->in_memory (cf::MAP_LOADING); 1863 $self->in_memory (cf::MAP_LOADING);
1233 1864
1234 $self->alloc; 1865 $self->alloc;
1866
1867 $self->pre_load;
1868 cf::cede_to_tick;
1869
1235 $self->load_objects ($self->{load_path}, 1) 1870 $self->_load_objects ($self->{load_path}, 1)
1236 or return; 1871 or return;
1237 1872
1238 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1873 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1239 if delete $self->{load_original}; 1874 if delete $self->{load_original};
1240 1875
1241 if (my $uniq = $path->uniq_path) { 1876 if (my $uniq = $self->uniq_path) {
1242 utf8::encode $uniq; 1877 utf8::encode $uniq;
1243 if (aio_open $uniq, O_RDONLY, 0) { 1878 if (aio_open $uniq, O_RDONLY, 0) {
1244 $self->clear_unique_items; 1879 $self->clear_unique_items;
1245 $self->load_objects ($uniq, 0); 1880 $self->_load_objects ($uniq, 0);
1246 } 1881 }
1247 } 1882 }
1248 1883
1249 Coro::cede; 1884 cf::cede_to_tick;
1250
1251 # now do the right thing for maps 1885 # now do the right thing for maps
1252 $self->link_multipart_objects; 1886 $self->link_multipart_objects;
1253
1254 if ($self->{path}->is_style_map) {
1255 $self->{deny_save} = 1;
1256 $self->{deny_reset} = 1;
1257 } else {
1258 $self->fix_auto_apply;
1259 $self->decay_objects;
1260 $self->update_buttons;
1261 $self->set_darkness_map;
1262 $self->difficulty ($self->estimate_difficulty) 1887 $self->difficulty ($self->estimate_difficulty)
1263 unless $self->difficulty; 1888 unless $self->difficulty;
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;
1264 $self->activate; 1898 $self->activate;
1265 } 1899 }
1266 1900
1267 Coro::cede; 1901 $self->{last_save} = $cf::RUNTIME;
1902 $self->last_access ($cf::RUNTIME);
1268 1903
1269 $self->in_memory (cf::MAP_IN_MEMORY); 1904 $self->in_memory (cf::MAP_IN_MEMORY);
1905 }
1906
1907 $self->post_load;
1908}
1909
1910sub customise_for {
1911 my ($self, $ob) = @_;
1912
1913 return find "~" . $ob->name . "/" . $self->{path}
1914 if $self->per_player;
1915
1916# return find "?party/" . $ob->name . "/" . $self->{path}
1917# if $self->per_party;
1918
1919 $self
1920}
1921
1922# find and load all maps in the 3x3 area around a map
1923sub load_neighbours {
1924 my ($map) = @_;
1925
1926 my @neigh; # diagonal neighbours
1927
1928 for (0 .. 3) {
1929 my $neigh = $map->tile_path ($_)
1930 or next;
1931 $neigh = find $neigh, $map
1932 or next;
1933 $neigh->load;
1934
1935 push @neigh,
1936 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1937 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1938 }
1939
1940 for (grep defined $_->[0], @neigh) {
1941 my ($path, $origin) = @$_;
1942 my $neigh = find $path, $origin
1943 or next;
1944 $neigh->load;
1945 }
1270} 1946}
1271 1947
1272sub find_sync { 1948sub find_sync {
1273 my ($path, $origin) = @_; 1949 my ($path, $origin) = @_;
1274 1950
1275 cf::sync_job { 1951 cf::sync_job { find $path, $origin }
1276 my $map = cf::map::find $path, $origin;
1277 $map
1278 }
1279} 1952}
1280 1953
1281sub do_load_sync { 1954sub do_load_sync {
1282 my ($map) = @_; 1955 my ($map) = @_;
1283 1956
1957 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1958 if $Coro::current == $Coro::main;
1959
1284 cf::sync_job { $map->load }; 1960 cf::sync_job { $map->load };
1961}
1962
1963our %MAP_PREFETCH;
1964our $MAP_PREFETCHER = undef;
1965
1966sub find_async {
1967 my ($path, $origin, $load) = @_;
1968
1969 $path = normalise $path, $origin && $origin->{path};
1970
1971 if (my $map = $cf::MAP{$path}) {
1972 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1973 }
1974
1975 $MAP_PREFETCH{$path} |= $load;
1976
1977 $MAP_PREFETCHER ||= cf::async {
1978 while (%MAP_PREFETCH) {
1979 while (my ($k, $v) = each %MAP_PREFETCH) {
1980 if (my $map = find $k) {
1981 $map->load if $v;
1982 }
1983
1984 delete $MAP_PREFETCH{$k};
1985 }
1986 }
1987 undef $MAP_PREFETCHER;
1988 };
1989 $MAP_PREFETCHER->prio (6);
1990
1991 ()
1285} 1992}
1286 1993
1287sub save { 1994sub save {
1288 my ($self) = @_; 1995 my ($self) = @_;
1289 1996
1290 my $lock = cf::lock_acquire "map_data:" . $self->path; 1997 my $lock = cf::lock_acquire "map_data:$self->{path}";
1291 1998
1292 $self->{last_save} = $cf::RUNTIME; 1999 $self->{last_save} = $cf::RUNTIME;
1293 2000
1294 return unless $self->dirty; 2001 return unless $self->dirty;
1295 2002
1296 my $save = $self->{path}->save_path; utf8::encode $save; 2003 my $save = $self->save_path; utf8::encode $save;
1297 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2004 my $uniq = $self->uniq_path; utf8::encode $uniq;
1298 2005
1299 $self->{load_path} = $save; 2006 $self->{load_path} = $save;
1300 2007
1301 return if $self->{deny_save}; 2008 return if $self->{deny_save};
1302 2009
1303 local $self->{last_access} = $self->last_access;#d# 2010 local $self->{last_access} = $self->last_access;#d#
1304 2011
2012 cf::async {
2013 $_->contr->save for $self->players;
2014 };
2015
1305 if ($uniq) { 2016 if ($uniq) {
1306 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2017 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1307 $self->save_objects ($uniq, cf::IO_UNIQUES); 2018 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1308 } else { 2019 } else {
1309 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2020 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1310 } 2021 }
1311} 2022}
1312 2023
1313sub swap_out { 2024sub swap_out {
1314 my ($self) = @_; 2025 my ($self) = @_;
1315 2026
1316 # save first because save cedes 2027 # save first because save cedes
1317 $self->save; 2028 $self->save;
1318 2029
1319 my $lock = cf::lock_acquire "map_data:" . $self->path; 2030 my $lock = cf::lock_acquire "map_data:$self->{path}";
1320 2031
1321 return if $self->players; 2032 return if $self->players;
1322 return if $self->in_memory != cf::MAP_IN_MEMORY; 2033 return if $self->in_memory != cf::MAP_IN_MEMORY;
1323 return if $self->{deny_save}; 2034 return if $self->{deny_save};
1324 2035
1328 2039
1329sub reset_at { 2040sub reset_at {
1330 my ($self) = @_; 2041 my ($self) = @_;
1331 2042
1332 # TODO: safety, remove and allow resettable per-player maps 2043 # TODO: safety, remove and allow resettable per-player maps
1333 return 1e99 if $self->{path}{user_rel};
1334 return 1e99 if $self->{deny_reset}; 2044 return 1e99 if $self->{deny_reset};
1335 2045
1336 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2046 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1337 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;
1338 2048
1343 my ($self) = @_; 2053 my ($self) = @_;
1344 2054
1345 $self->reset_at <= $cf::RUNTIME 2055 $self->reset_at <= $cf::RUNTIME
1346} 2056}
1347 2057
1348sub unlink_save {
1349 my ($self) = @_;
1350
1351 utf8::encode (my $save = $self->{path}->save_path);
1352 aioreq_pri 3; IO::AIO::aio_unlink $save;
1353 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1354}
1355
1356sub rename {
1357 my ($self, $new_path) = @_;
1358
1359 $self->unlink_save;
1360
1361 delete $cf::MAP{$self->path};
1362 $self->{path} = new cf::path $new_path;
1363 $self->path ($self->{path}->as_string);
1364 $cf::MAP{$self->path} = $self;
1365
1366 $self->save;
1367}
1368
1369sub reset { 2058sub reset {
1370 my ($self) = @_; 2059 my ($self) = @_;
1371 2060
1372 my $lock = cf::lock_acquire "map_data:" . $self->path; 2061 my $lock = cf::lock_acquire "map_data:$self->{path}";
1373 2062
1374 return if $self->players; 2063 return if $self->players;
1375 return if $self->{path}{user_rel};#d#
1376 2064
1377 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 }
1378 2076
1379 delete $cf::MAP{$self->path}; 2077 delete $cf::MAP{$self->path};
2078
2079 $self->clear;
1380 2080
1381 $_->clear_links_to ($self) for values %cf::MAP; 2081 $_->clear_links_to ($self) for values %cf::MAP;
1382 2082
1383 $self->unlink_save; 2083 $self->unlink_save;
1384 $self->destroy; 2084 $self->destroy;
1387my $nuke_counter = "aaaa"; 2087my $nuke_counter = "aaaa";
1388 2088
1389sub nuke { 2089sub nuke {
1390 my ($self) = @_; 2090 my ($self) = @_;
1391 2091
2092 {
2093 my $lock = cf::lock_acquire "map_data:$self->{path}";
2094
2095 delete $cf::MAP{$self->path};
2096
2097 $self->unlink_save;
2098
2099 bless $self, "cf::map";
2100 delete $self->{deny_reset};
1392 $self->{deny_save} = 1; 2101 $self->{deny_save} = 1;
1393 $self->reset_timeout (1); 2102 $self->reset_timeout (1);
1394 $self->rename ("{nuke}/" . ($nuke_counter++)); 2103 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2104
2105 $cf::MAP{$self->path} = $self;
2106 }
2107
1395 $self->reset; # polite request, might not happen 2108 $self->reset; # polite request, might not happen
1396} 2109}
1397 2110
1398sub customise_for { 2111=item $maps = cf::map::tmp_maps
1399 my ($map, $ob) = @_;
1400 2112
1401 if ($map->per_player) { 2113Returns an arrayref with all map paths of currently instantiated and saved
1402 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2114maps. May block.
2115
2116=cut
2117
2118sub tmp_maps() {
1403 } 2119 [
1404 2120 map {
1405 $map 2121 utf8::decode $_;
2122 /\.map$/
2123 ? normalise $_
2124 : ()
2125 } @{ aio_readdir $TMPDIR or [] }
2126 ]
1406} 2127}
1407 2128
1408sub emergency_save { 2129=item $maps = cf::map::random_maps
1409 my $freeze_guard = cf::freeze_mainloop;
1410 2130
1411 warn "enter emergency map save\n"; 2131Returns an arrayref with all map paths of currently instantiated and saved
2132random maps. May block.
1412 2133
1413 cf::sync_job { 2134=cut
1414 warn "begin emergency map save\n";
1415 $_->save for values %cf::MAP;
1416 };
1417 2135
1418 warn "end emergency map save\n"; 2136sub random_maps() {
2137 [
2138 map {
2139 utf8::decode $_;
2140 /\.map$/
2141 ? normalise "?random/$_"
2142 : ()
2143 } @{ aio_readdir $RANDOMDIR or [] }
2144 ]
2145}
2146
2147=item cf::map::unique_maps
2148
2149Returns an arrayref of paths of all shared maps that have
2150instantiated unique items. May block.
2151
2152=cut
2153
2154sub unique_maps() {
2155 [
2156 map {
2157 utf8::decode $_;
2158 /\.map$/
2159 ? normalise $_
2160 : ()
2161 } @{ aio_readdir $UNIQUEDIR or [] }
2162 ]
1419} 2163}
1420 2164
1421package cf; 2165package cf;
1422 2166
1423=back 2167=back
1424 2168
2169=head3 cf::object
2170
2171=cut
2172
2173package cf::object;
2174
2175=over 4
2176
2177=item $ob->inv_recursive
2178
2179Returns the inventory of the object _and_ their inventories, recursively.
2180
2181=cut
2182
2183sub inv_recursive_;
2184sub inv_recursive_ {
2185 map { $_, inv_recursive_ $_->inv } @_
2186}
2187
2188sub inv_recursive {
2189 inv_recursive_ inv $_[0]
2190}
2191
2192package cf;
2193
2194=back
1425 2195
1426=head3 cf::object::player 2196=head3 cf::object::player
1427 2197
1428=over 4 2198=over 4
1429 2199
1443 2213
1444 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2214 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1445 2215
1446 if ($self->{record_replies}) { 2216 if ($self->{record_replies}) {
1447 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2217 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2218
1448 } 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 {
1449 $msg = $npc->name . " says: $msg" if $npc; 2227 $msg = $npc->name . " says: $msg" if $npc;
1450 $self->message ($msg, $flags); 2228 $self->message ($msg, $flags);
2229 }
1451 } 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 (@_);
1452} 2241}
1453 2242
1454=item $player_object->may ("access") 2243=item $player_object->may ("access")
1455 2244
1456Returns wether the given player is authorized to access resource "access" 2245Returns wether the given player is authorized to access resource "access"
1469 2258
1470=item $player_object->enter_link 2259=item $player_object->enter_link
1471 2260
1472Freezes the player and moves him/her to a special map (C<{link}>). 2261Freezes the player and moves him/her to a special map (C<{link}>).
1473 2262
1474The player should be reaosnably safe there for short amounts of time. You 2263The player should be reasonably safe there for short amounts of time. You
1475I<MUST> call C<leave_link> as soon as possible, though. 2264I<MUST> call C<leave_link> as soon as possible, though.
1476 2265
2266Will never block.
2267
1477=item $player_object->leave_link ($map, $x, $y) 2268=item $player_object->leave_link ($map, $x, $y)
1478 2269
1479Moves the player out of the specila link map onto the given map. If the 2270Moves the player out of the special C<{link}> map onto the specified
1480map is not valid (or omitted), the player will be moved back to the 2271map. If the map is not valid (or omitted), the player will be moved back
1481location he/she was before the call to C<enter_link>, or, if that fails, 2272to the location he/she was before the call to C<enter_link>, or, if that
1482to the emergency map position. 2273fails, to the emergency map position.
1483 2274
1484Might block. 2275Might block.
1485 2276
1486=cut 2277=cut
2278
2279sub link_map {
2280 unless ($LINK_MAP) {
2281 $LINK_MAP = cf::map::find "{link}"
2282 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2283 $LINK_MAP->load;
2284 }
2285
2286 $LINK_MAP
2287}
1487 2288
1488sub cf::object::player::enter_link { 2289sub cf::object::player::enter_link {
1489 my ($self) = @_; 2290 my ($self) = @_;
1490 2291
1491 $self->deactivate_recursive; 2292 $self->deactivate_recursive;
1492 2293
1493 return if $self->map == $LINK_MAP; 2294 return if UNIVERSAL::isa $self->map, "ext::map_link";
1494 2295
1495 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2296 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1496 if $self->map; 2297 if $self->map && $self->map->{path} ne "{link}";
1497 2298
1498 $self->enter_map ($LINK_MAP, 20, 20); 2299 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1499} 2300}
1500 2301
1501sub cf::object::player::leave_link { 2302sub cf::object::player::leave_link {
1502 my ($self, $map, $x, $y) = @_; 2303 my ($self, $map, $x, $y) = @_;
2304
2305 return unless $self->contr->active;
1503 2306
1504 my $link_pos = delete $self->{_link_pos}; 2307 my $link_pos = delete $self->{_link_pos};
1505 2308
1506 unless ($map) { 2309 unless ($map) {
1507 # restore original map position 2310 # restore original map position
1521 # use -1 or undef as default coordinates, not 0, 0 2324 # use -1 or undef as default coordinates, not 0, 0
1522 ($x, $y) = ($map->enter_x, $map->enter_y) 2325 ($x, $y) = ($map->enter_x, $map->enter_y)
1523 if $x <=0 && $y <= 0; 2326 if $x <=0 && $y <= 0;
1524 2327
1525 $map->load; 2328 $map->load;
2329 $map->load_neighbours;
1526 2330
2331 return unless $self->contr->active;
1527 $self->activate_recursive; 2332 $self->activate_recursive;
2333
2334 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1528 $self->enter_map ($map, $x, $y); 2335 $self->enter_map ($map, $x, $y);
1529} 2336}
1530 2337
1531cf::player->attach ( 2338=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1532 on_logout => sub {
1533 my ($pl) = @_;
1534 2339
1535 # abort map switching before logout 2340Moves the player to the given map-path and coordinates by first freezing
1536 if ($pl->ob->{_link_pos}) { 2341her, loading and preparing them map, calling the provided $check callback
1537 cf::sync_job { 2342that has to return the map if sucecssful, and then unfreezes the player on
1538 $pl->ob->leave_link 2343the new (success) or old (failed) map position. In either case, $done will
1539 }; 2344be called at the end of this process.
1540 }
1541 },
1542 on_login => sub {
1543 my ($pl) = @_;
1544 2345
1545 # try to abort aborted map switching on player login :)
1546 # should happen only on crashes
1547 if ($pl->ob->{_link_pos}) {
1548
1549 $pl->ob->enter_link;
1550 (Coro::async_pool {
1551 # we need this sleep as the login has a concurrent enter_exit running
1552 # and this sleep increases chances of the player not ending up in scorn
1553 Coro::Timer::sleep 1;
1554 $pl->ob->leave_link;
1555 })->prio (2);
1556 }
1557 },
1558);
1559
1560=item $player_object->goto ($path, $x, $y)
1561
1562=cut 2346=cut
2347
2348our $GOTOGEN;
1563 2349
1564sub cf::object::player::goto { 2350sub cf::object::player::goto {
1565 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;
1566 2355
1567 $self->enter_link; 2356 $self->enter_link;
1568 2357
1569 (Coro::async_pool { 2358 (async {
1570 $path = new cf::path $path; 2359 my $map = eval {
1571
1572 my $map = cf::map::find $path->as_string; 2360 my $map = cf::map::find $path;
2361
2362 if ($map) {
1573 $map = $map->customise_for ($self) if $map; 2363 $map = $map->customise_for ($self);
1574 2364 $map = $check->($map) if $check && $map;
1575# warn "entering ", $map->path, " at ($x, $y)\n" 2365 } else {
1576# if $map;
1577
1578 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2366 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2367 }
1579 2368
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 $@;
2375 }
2376
2377 if ($gen == $self->{_goto_generation}) {
2378 delete $self->{_goto_generation};
1580 $self->leave_link ($map, $x, $y); 2379 $self->leave_link ($map, $x, $y);
2380 }
2381
2382 $done->() if $done;
1581 })->prio (1); 2383 })->prio (1);
1582} 2384}
1583 2385
1584=item $player_object->enter_exit ($exit_object) 2386=item $player_object->enter_exit ($exit_object)
1585 2387
1587 2389
1588sub parse_random_map_params { 2390sub parse_random_map_params {
1589 my ($spec) = @_; 2391 my ($spec) = @_;
1590 2392
1591 my $rmp = { # defaults 2393 my $rmp = { # defaults
1592 xsize => 10, 2394 xsize => (cf::rndm 15, 40),
1593 ysize => 10, 2395 ysize => (cf::rndm 15, 40),
2396 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2397 #layout => string,
1594 }; 2398 };
1595 2399
1596 for (split /\n/, $spec) { 2400 for (split /\n/, $spec) {
1597 my ($k, $v) = split /\s+/, $_, 2; 2401 my ($k, $v) = split /\s+/, $_, 2;
1598 2402
1602 $rmp 2406 $rmp
1603} 2407}
1604 2408
1605sub prepare_random_map { 2409sub prepare_random_map {
1606 my ($exit) = @_; 2410 my ($exit) = @_;
2411
2412 my $guard = cf::lock_acquire "exit_prepare:$exit";
1607 2413
1608 # all this does is basically replace the /! path by 2414 # all this does is basically replace the /! path by
1609 # a new random map path (?random/...) with a seed 2415 # a new random map path (?random/...) with a seed
1610 # that depends on the exit object 2416 # that depends on the exit object
1611 2417
1612 my $rmp = parse_random_map_params $exit->msg; 2418 my $rmp = parse_random_map_params $exit->msg;
1613 2419
1614 if ($exit->map) { 2420 if ($exit->map) {
1615 $rmp->{region} = $exit->map->region_name; 2421 $rmp->{region} = $exit->region->name;
1616 $rmp->{origin_map} = $exit->map->path; 2422 $rmp->{origin_map} = $exit->map->path;
1617 $rmp->{origin_x} = $exit->x; 2423 $rmp->{origin_x} = $exit->x;
1618 $rmp->{origin_y} = $exit->y; 2424 $rmp->{origin_y} = $exit->y;
1619 } 2425 }
1620 2426
1621 $rmp->{random_seed} ||= $exit->random_seed; 2427 $rmp->{random_seed} ||= $exit->random_seed;
1622 2428
1623 my $data = cf::to_json $rmp; 2429 my $data = cf::to_json $rmp;
1624 my $md5 = Digest::MD5::md5_hex $data; 2430 my $md5 = Digest::MD5::md5_hex $data;
2431 my $meta = "$RANDOMDIR/$md5.meta";
1625 2432
1626 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2433 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1627 aio_write $fh, 0, (length $data), $data, 0; 2434 aio_write $fh, 0, (length $data), $data, 0;
2435 undef $fh;
2436 aio_rename "$meta~", $meta;
1628 2437
1629 $exit->slaying ("?random/$md5"); 2438 $exit->slaying ("?random/$md5");
1630 $exit->msg (undef); 2439 $exit->msg (undef);
1631 } 2440 }
1632} 2441}
1634sub cf::object::player::enter_exit { 2443sub cf::object::player::enter_exit {
1635 my ($self, $exit) = @_; 2444 my ($self, $exit) = @_;
1636 2445
1637 return unless $self->type == cf::PLAYER; 2446 return unless $self->type == cf::PLAYER;
1638 2447
2448 if ($exit->slaying eq "/!") {
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
2452 cf::sync_job { prepare_random_map $exit };
2453 }
2454
2455 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2456 my $hp = $exit->stats->hp;
2457 my $sp = $exit->stats->sp;
2458
1639 $self->enter_link; 2459 $self->enter_link;
1640 2460
1641 (Coro::async_pool { 2461 # if exit is damned, update players death & WoR home-position
2462 $self->contr->savebed ($slaying, $hp, $sp)
2463 if $exit->flag (FLAG_DAMNED);
2464
2465 (async {
1642 $self->deactivate_recursive; # just to be sure 2466 $self->deactivate_recursive; # just to be sure
1643 unless (eval { 2467 unless (eval {
1644 prepare_random_map $exit 2468 $self->goto ($slaying, $hp, $sp);
1645 if $exit->slaying eq "/!";
1646
1647 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1648 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1649 2469
1650 1; 2470 1;
1651 }) { 2471 }) {
1652 $self->message ("Something went wrong deep within the crossfire server. " 2472 $self->message ("Something went wrong deep within the crossfire server. "
1653 . "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. "
1654 . "Please report this to the dungeon master", 2474 . "Please report this to the dungeon master!",
1655 cf::NDI_UNIQUE | cf::NDI_RED); 2475 cf::NDI_UNIQUE | cf::NDI_RED);
1656 2476
1657 warn "ERROR in enter_exit: $@"; 2477 warn "ERROR in enter_exit: $@";
1658 $self->leave_link; 2478 $self->leave_link;
1659 } 2479 }
1660 })->prio (1); 2480 })->prio (1);
1673 2493
1674sub cf::client::send_drawinfo { 2494sub cf::client::send_drawinfo {
1675 my ($self, $text, $flags) = @_; 2495 my ($self, $text, $flags) = @_;
1676 2496
1677 utf8::encode $text; 2497 utf8::encode $text;
1678 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2498 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1679} 2499}
1680 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}
1681 2616
1682=item $success = $client->query ($flags, "text", \&cb) 2617=item $success = $client->query ($flags, "text", \&cb)
1683 2618
1684Queues a query to the client, calling the given callback with 2619Queues a query to the client, calling the given callback with
1685the 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>,
1686C<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>.
1687 2622
1688Queries 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
1689reliable at some point in the future. 2624become reliable at some point in the future.
1690 2625
1691=cut 2626=cut
1692 2627
1693sub cf::client::query { 2628sub cf::client::query {
1694 my ($self, $flags, $text, $cb) = @_; 2629 my ($self, $flags, $text, $cb) = @_;
1702 utf8::encode $text; 2637 utf8::encode $text;
1703 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2638 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1704 2639
1705 $self->send_packet ($self->{query_queue}[0][0]) 2640 $self->send_packet ($self->{query_queue}[0][0])
1706 if @{ $self->{query_queue} } == 1; 2641 if @{ $self->{query_queue} } == 1;
2642
2643 1
1707} 2644}
1708 2645
1709cf::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 },
1710 on_reply => sub { 2652 on_reply => sub {
1711 my ($ns, $msg) = @_; 2653 my ($ns, $msg) = @_;
1712 2654
1713 # this weird shuffling is so that direct followup queries 2655 # this weird shuffling is so that direct followup queries
1714 # get handled first 2656 # get handled first
1715 my $queue = delete $ns->{query_queue} 2657 my $queue = delete $ns->{query_queue}
1716 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
1717 2659
1718 (shift @$queue)->[1]->($msg); 2660 (shift @$queue)->[1]->($msg);
2661 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1719 2662
1720 push @{ $ns->{query_queue} }, @$queue; 2663 push @{ $ns->{query_queue} }, @$queue;
1721 2664
1722 if (@{ $ns->{query_queue} } == @$queue) { 2665 if (@{ $ns->{query_queue} } == @$queue) {
1723 if (@$queue) { 2666 if (@$queue) {
1725 } else { 2668 } else {
1726 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2669 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1727 } 2670 }
1728 } 2671 }
1729 }, 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 },
1730); 2699);
1731 2700
1732=item $client->coro (\&cb) 2701=item $client->async (\&cb)
1733 2702
1734Create a new coroutine, running the specified callback. The coroutine will 2703Create a new coroutine, running the specified callback. The coroutine will
1735be automatically cancelled when the client gets destroyed (e.g. on logout, 2704be automatically cancelled when the client gets destroyed (e.g. on logout,
1736or loss of connection). 2705or loss of connection).
1737 2706
1738=cut 2707=cut
1739 2708
1740sub cf::client::coro { 2709sub cf::client::async {
1741 my ($self, $cb) = @_; 2710 my ($self, $cb) = @_;
1742 2711
1743 my $coro = &Coro::async_pool ($cb); 2712 my $coro = &Coro::async ($cb);
1744 2713
1745 $coro->on_destroy (sub { 2714 $coro->on_destroy (sub {
1746 delete $self->{_coro}{$coro+0}; 2715 delete $self->{_coro}{$coro+0};
1747 }); 2716 });
1748 2717
1775our $safe = new Safe "safe"; 2744our $safe = new Safe "safe";
1776our $safe_hole = new Safe::Hole; 2745our $safe_hole = new Safe::Hole;
1777 2746
1778$SIG{FPE} = 'IGNORE'; 2747$SIG{FPE} = 'IGNORE';
1779 2748
1780$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));
1781 2754
1782# here we export the classes and methods available to script code 2755# here we export the classes and methods available to script code
1783 2756
1784=pod 2757=pod
1785 2758
1786The following fucntions and emthods are available within a safe environment: 2759The following functions and methods are available within a safe environment:
1787 2760
1788 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
1789 cf::object::player player 2765 cf::object::player
1790 cf::player peaceful 2766 player
1791 cf::map trigger 2767
2768 cf::player
2769 peaceful
2770
2771 cf::map
2772 trigger
1792 2773
1793=cut 2774=cut
1794 2775
1795for ( 2776for (
1796 ["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)],
1797 ["cf::object::player" => qw(player)], 2780 ["cf::object::player" => qw(player)],
1798 ["cf::player" => qw(peaceful)], 2781 ["cf::player" => qw(peaceful)],
1799 ["cf::map" => qw(trigger)], 2782 ["cf::map" => qw(trigger)],
1800) { 2783) {
1801 no strict 'refs'; 2784 no strict 'refs';
1872=back 2855=back
1873 2856
1874=cut 2857=cut
1875 2858
1876############################################################################# 2859#############################################################################
2860# the server's init and main functions
1877 2861
1878=head2 EXTENSION DATABASE SUPPORT 2862sub load_facedata($) {
2863 my ($path) = @_;
1879 2864
1880Crossfire maintains a very simple database for extension use. It can 2865 # HACK to clear player env face cache, we need some signal framework
1881currently store anything that can be serialised using Storable, which 2866 # for this (global event?)
1882excludes objects. 2867 %ext::player_env::MUSIC_FACE_CACHE = ();
1883 2868
1884The parameter C<$family> should best start with the name of the extension 2869 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1885using it, it should be unique.
1886 2870
1887=over 4 2871 warn "loading facedata from $path\n";
1888 2872
1889=item $hashref = cf::db_get $family 2873 my $facedata;
2874 0 < aio_load $path, $facedata
2875 or die "$path: $!";
1890 2876
1891Return a hashref for use by the extension C<$family>, which can be 2877 $facedata = Coro::Storable::thaw $facedata;
1892modified. After modifications, you have to call C<cf::db_dirty> or
1893C<cf::db_sync>.
1894 2878
1895=item $value = cf::db_get $family => $key 2879 $facedata->{version} == 2
2880 or cf::cleanup "$path: version mismatch, cannot proceed.";
1896 2881
1897Returns a single value from the database 2882 # patch in the exptable
1898 2883 $facedata->{resource}{"res/exp_table"} = {
1899=item cf::db_put $family => $hashref 2884 type => FT_RSRC,
1900 2885 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1901Stores the given family hashref into the database. Updates are delayed, if
1902you want the data to be synced to disk immediately, use C<cf::db_sync>.
1903
1904=item cf::db_put $family => $key => $value
1905
1906Stores the given C<$value> in the family hash. Updates are delayed, if you
1907want the data to be synced to disk immediately, use C<cf::db_sync>.
1908
1909=item cf::db_dirty
1910
1911Marks the database as dirty, to be updated at a later time.
1912
1913=item cf::db_sync
1914
1915Immediately write the database to disk I<if it is dirty>.
1916
1917=cut
1918
1919our $DB;
1920
1921{
1922 my $path = cf::localdir . "/database.pst";
1923
1924 sub db_load() {
1925 $DB = stat $path ? Storable::retrieve $path : { };
1926 }
1927
1928 my $pid;
1929
1930 sub db_save() {
1931 waitpid $pid, 0 if $pid;
1932 if (0 == ($pid = fork)) {
1933 $DB->{_meta}{version} = 1;
1934 Storable::nstore $DB, "$path~";
1935 rename "$path~", $path;
1936 cf::_exit 0 if defined $pid;
1937 }
1938 }
1939
1940 my $dirty;
1941
1942 sub db_sync() {
1943 db_save if $dirty;
1944 undef $dirty;
1945 }
1946
1947 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1948 db_sync;
1949 }); 2886 };
2887 cf::cede_to_tick;
1950 2888
1951 sub db_dirty() {
1952 $dirty = 1;
1953 $idle->start;
1954 } 2889 {
2890 my $faces = $facedata->{faceinfo};
1955 2891
1956 sub db_get($;$) { 2892 while (my ($face, $info) = each %$faces) {
1957 @_ >= 2 2893 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1958 ? $DB->{$_[0]}{$_[1]} 2894 cf::face::set_visibility $idx, $info->{visibility};
1959 : ($DB->{$_[0]} ||= { }) 2895 cf::face::set_magicmap $idx, $info->{magicmap};
1960 } 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};
1961 2898
1962 sub db_put($$;$) { 2899 cf::cede_to_tick;
1963 if (@_ >= 3) {
1964 $DB->{$_[0]}{$_[1]} = $_[2];
1965 } else {
1966 $DB->{$_[0]} = $_[1];
1967 }
1968 db_dirty;
1969 }
1970
1971 cf::global->attach (
1972 prio => 10000,
1973 on_cleanup => sub {
1974 db_sync;
1975 }, 2900 }
1976 );
1977}
1978 2901
1979############################################################################# 2902 while (my ($face, $info) = each %$faces) {
1980# 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 }
1981 2912
1982sub 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 {
1983 open my $fh, "<:utf8", cf::confdir . "/config" 3039 open my $fh, "<:utf8", "$CONFDIR/config"
1984 or return; 3040 or return;
1985 3041
1986 local $/; 3042 local $/;
1987 *CFG = YAML::Syck::Load <$fh>; 3043 *CFG = YAML::Syck::Load <$fh>;
1988 3044
1991 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3047 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
1992 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3048 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
1993 3049
1994 if (exists $CFG{mlockall}) { 3050 if (exists $CFG{mlockall}) {
1995 eval { 3051 eval {
1996 $CFG{mlockall} ? &mlockall : &munlockall 3052 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1997 and die "WARNING: m(un)lockall failed: $!\n"; 3053 and die "WARNING: m(un)lockall failed: $!\n";
1998 }; 3054 };
1999 warn $@ if $@; 3055 warn $@ if $@;
2000 } 3056 }
2001} 3057}
2002 3058
2003sub main { 3059sub main {
2004 # we must not ever block the main coroutine 3060 # we must not ever block the main coroutine
2005 local $Coro::idle = sub { 3061 local $Coro::idle = sub {
2006 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3062 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2007 Coro::async_pool { Event::one_event }; 3063 (async {
3064 Event::one_event;
3065 })->prio (Coro::PRIO_MAX);
2008 }; 3066 };
2009 3067
2010 cfg_load; 3068 reload_config;
2011 db_load; 3069 db_init;
2012 load_extensions; 3070 load_extensions;
3071
3072 $TICK_WATCHER->start;
2013 Event::loop; 3073 Event::loop;
2014} 3074}
2015 3075
2016############################################################################# 3076#############################################################################
2017# initialisation 3077# initialisation and cleanup
2018 3078
3079# install some emergency cleanup handlers
3080BEGIN {
3081 for my $signal (qw(INT HUP TERM)) {
3082 Event->signal (
3083 reentrant => 0,
3084 data => WF_AUTOCANCEL,
3085 signal => $signal,
3086 prio => 0,
3087 cb => sub {
3088 cf::cleanup "SIG$signal";
3089 },
3090 );
3091 }
3092}
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
3132sub emergency_save() {
3133 my $freeze_guard = cf::freeze_mainloop;
3134
3135 warn "enter emergency perl save\n";
3136
3137 cf::sync_job {
3138 # use a peculiar iteration method to avoid tripping on perl
3139 # refcount bugs in for. also avoids problems with players
3140 # and maps saved/destroyed asynchronously.
3141 warn "begin emergency player save\n";
3142 for my $login (keys %cf::PLAYER) {
3143 my $pl = $cf::PLAYER{$login} or next;
3144 $pl->valid or next;
3145 $pl->save;
3146 }
3147 warn "end emergency player save\n";
3148
3149 warn "begin emergency map save\n";
3150 for my $path (keys %cf::MAP) {
3151 my $map = $cf::MAP{$path} or next;
3152 $map->valid or next;
3153 $map->save;
3154 }
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";
3160 };
3161
3162 warn "leave emergency perl save\n";
3163}
3164
3165sub post_cleanup {
3166 my ($make_core) = @_;
3167
3168 warn Carp::longmess "post_cleanup backtrace"
3169 if $make_core;
3170}
3171
2019sub reload() { 3172sub do_reload_perl() {
2020 # can/must only be called in main 3173 # can/must only be called in main
2021 if ($Coro::current != $Coro::main) { 3174 if ($Coro::current != $Coro::main) {
2022 warn "can only reload from main coroutine\n"; 3175 warn "can only reload from main coroutine";
2023 return; 3176 return;
2024 } 3177 }
2025 3178
2026 warn "reloading..."; 3179 warn "reloading...";
2027 3180
2028 my $guard = freeze_mainloop; 3181 warn "entering sync_job";
3182
3183 cf::sync_job {
3184 cf::write_runtime; # external watchdog should not bark
2029 cf::emergency_save; 3185 cf::emergency_save;
3186 cf::write_runtime; # external watchdog should not bark
2030 3187
2031 eval { 3188 warn "syncing database to disk";
3189 BDB::db_env_txn_checkpoint $DB_ENV;
3190
2032 # 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
2033 3192
2034 # cancel all watchers 3193 warn "cancelling all WF_AUTOCANCEL watchers";
2035 for (Event::all_watchers) { 3194 for (Event::all_watchers) {
2036 $_->cancel if $_->data & WF_AUTOCANCEL; 3195 $_->cancel if $_->data & WF_AUTOCANCEL;
2037 } 3196 }
2038 3197
3198 warn "flushing outstanding aio requests";
3199 for (;;) {
3200 BDB::flush;
3201 IO::AIO::flush;
3202 Coro::cede;
3203 last unless IO::AIO::nreqs || BDB::nreqs;
3204 warn "iterate...";
3205 }
3206
3207 ++$RELOAD;
3208
2039 # cancel all extension coros 3209 warn "cancelling all extension coros";
2040 $_->cancel for values %EXT_CORO; 3210 $_->cancel for values %EXT_CORO;
2041 %EXT_CORO = (); 3211 %EXT_CORO = ();
2042 3212
2043 # unload all extensions 3213 warn "removing commands";
2044 for (@exts) { 3214 %COMMAND = ();
3215
3216 warn "removing ext/exti commands";
3217 %EXTCMD = ();
3218 %EXTICMD = ();
3219
3220 warn "unloading/nuking all extensions";
3221 for my $pkg (@EXTS) {
2045 warn "unloading <$_>"; 3222 warn "... unloading $pkg";
2046 unload_extension $_; 3223
3224 if (my $cb = $pkg->can ("unload")) {
3225 eval {
3226 $cb->($pkg);
3227 1
3228 } or warn "$pkg unloaded, but with errors: $@";
2047 } 3229 }
2048 3230
3231 warn "... nuking $pkg";
3232 Symbol::delete_package $pkg;
3233 }
3234
2049 # unload all modules loaded from $LIBDIR 3235 warn "unloading all perl modules loaded from $LIBDIR";
2050 while (my ($k, $v) = each %INC) { 3236 while (my ($k, $v) = each %INC) {
2051 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3237 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2052 3238
2053 warn "removing <$k>"; 3239 warn "... unloading $k";
2054 delete $INC{$k}; 3240 delete $INC{$k};
2055 3241
2056 $k =~ s/\.pm$//; 3242 $k =~ s/\.pm$//;
2057 $k =~ s/\//::/g; 3243 $k =~ s/\//::/g;
2058 3244
2061 } 3247 }
2062 3248
2063 Symbol::delete_package $k; 3249 Symbol::delete_package $k;
2064 } 3250 }
2065 3251
2066 # sync database to disk
2067 cf::db_sync;
2068 IO::AIO::flush;
2069
2070 # get rid of safe::, as good as possible 3252 warn "getting rid of safe::, as good as possible";
2071 Symbol::delete_package "safe::$_" 3253 Symbol::delete_package "safe::$_"
2072 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);
2073 3255
2074 # remove register_script_function callbacks
2075 # TODO
2076
2077 # unload cf.pm "a bit" 3256 warn "unloading cf.pm \"a bit\"";
2078 delete $INC{"cf.pm"}; 3257 delete $INC{"cf.pm"};
3258 delete $INC{"cf/pod.pm"};
2079 3259
2080 # don't, removes xs symbols, too, 3260 # don't, removes xs symbols, too,
2081 # and global variables created in xs 3261 # and global variables created in xs
2082 #Symbol::delete_package __PACKAGE__; 3262 #Symbol::delete_package __PACKAGE__;
2083 3263
2084 # reload cf.pm 3264 warn "unload completed, starting to reload now";
3265
2085 warn "reloading cf.pm"; 3266 warn "reloading cf.pm";
2086 require cf; 3267 require cf;
2087 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3268 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2088 3269
2089 # load config and database again 3270 warn "loading config and database again";
2090 cf::cfg_load; 3271 cf::reload_config;
2091 cf::db_load;
2092 3272
2093 # load extensions
2094 warn "load extensions"; 3273 warn "loading extensions";
2095 cf::load_extensions; 3274 cf::load_extensions;
2096 3275
2097 # reattach attachments to objects 3276 warn "reattaching attachments to objects/players";
2098 warn "reattach"; 3277 _global_reattach; # objects, sockets
2099 _global_reattach; 3278 warn "reattaching attachments to maps";
2100 }; 3279 reattach $_ for values %MAP;
3280 warn "reattaching attachments to players";
3281 reattach $_ for values %PLAYER;
2101 3282
2102 if ($@) { 3283 warn "leaving sync_job";
3284
3285 1
3286 } or do {
2103 warn $@; 3287 warn $@;
2104 warn "error while reloading, exiting."; 3288 warn "error while reloading, exiting.";
2105 exit 1; 3289 exit 1;
2106 } 3290 };
2107 3291
2108 warn "reloaded successfully"; 3292 warn "reloaded";
2109}; 3293};
2110 3294
2111############################################################################# 3295our $RELOAD_WATCHER; # used only during reload
2112 3296
2113unless ($LINK_MAP) { 3297sub reload_perl() {
2114 $LINK_MAP = cf::map::new; 3298 # doing reload synchronously and two reloads happen back-to-back,
3299 # coro crashes during coro_state_free->destroy here.
2115 3300
2116 $LINK_MAP->width (41); 3301 $RELOAD_WATCHER ||= Event->timer (
2117 $LINK_MAP->height (41); 3302 reentrant => 0,
2118 $LINK_MAP->alloc;
2119 $LINK_MAP->path ("{link}");
2120 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2121 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2122
2123 # dirty hack because... archetypes are not yet loaded
2124 Event->timer (
2125 after => 2, 3303 after => 0,
3304 data => WF_AUTOCANCEL,
2126 cb => sub { 3305 cb => sub {
2127 $_[0]->w->cancel; 3306 do_reload_perl;
2128 3307 undef $RELOAD_WATCHER;
2129 # provide some exits "home"
2130 my $exit = cf::object::new "exit";
2131
2132 $exit->slaying ($EMERGENCY_POSITION->[0]);
2133 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2134 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2135
2136 $LINK_MAP->insert ($exit->clone, 19, 19);
2137 $LINK_MAP->insert ($exit->clone, 19, 20);
2138 $LINK_MAP->insert ($exit->clone, 19, 21);
2139 $LINK_MAP->insert ($exit->clone, 20, 19);
2140 $LINK_MAP->insert ($exit->clone, 20, 21);
2141 $LINK_MAP->insert ($exit->clone, 21, 19);
2142 $LINK_MAP->insert ($exit->clone, 21, 20);
2143 $LINK_MAP->insert ($exit->clone, 21, 21);
2144
2145 $exit->destroy;
2146 }); 3308 },
2147 3309 );
2148 $LINK_MAP->{deny_save} = 1;
2149 $LINK_MAP->{deny_reset} = 1;
2150
2151 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2152} 3310}
2153
2154register "<global>", __PACKAGE__;
2155 3311
2156register_command "reload" => sub { 3312register_command "reload" => sub {
2157 my ($who, $arg) = @_; 3313 my ($who, $arg) = @_;
2158 3314
2159 if ($who->flag (FLAG_WIZ)) { 3315 if ($who->flag (FLAG_WIZ)) {
2160 $who->message ("start of reload.");
2161 reload;
2162 $who->message ("end of reload."); 3316 $who->message ("reloading server.");
3317 async { reload_perl };
2163 } 3318 }
2164}; 3319};
2165 3320
2166unshift @INC, $LIBDIR; 3321unshift @INC, $LIBDIR;
2167 3322
3323my $bug_warning = 0;
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;
2168$TICK_WATCHER = Event->timer ( 3348$TICK_WATCHER = Event->timer (
2169 reentrant => 0, 3349 reentrant => 0,
3350 parked => 1,
2170 prio => 0, 3351 prio => 0,
2171 at => $NEXT_TICK || $TICK, 3352 at => $NEXT_TICK || $TICK,
2172 data => WF_AUTOCANCEL, 3353 data => WF_AUTOCANCEL,
2173 cb => sub { 3354 cb => sub {
3355 if ($Coro::current != $Coro::main) {
3356 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3357 unless ++$bug_warning > 10;
3358 return;
3359 }
3360
3361 $NOW = $tick_start = Event::time;
3362
2174 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
2175 $RUNTIME += $TICK; 3388 $RUNTIME += $TICK;
2176 $NEXT_TICK += $TICK; 3389 $NEXT_TICK += $TICK;
2177 3390
3391 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3392 $NEXT_RUNTIME_WRITE = $NOW + 10;
3393 Coro::async_pool {
3394 write_runtime
3395 or warn "ERROR: unable to write runtime file: $!";
3396 };
3397 }
3398
3399# my $AFTER = Event::time;
3400# warn $AFTER - $NOW;#d#
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
2178 # 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
2179 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3412 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2180 3413
2181 $TICK_WATCHER->at ($NEXT_TICK); 3414 $TICK_WATCHER->at ($NEXT_TICK);
2182 $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
2183 }, 3423 },
2184); 3424);
2185 3425
3426{
2186IO::AIO::max_poll_time $TICK * 0.2; 3427 BDB::max_poll_time $TICK * 0.1;
2187 3428 $BDB_POLL_WATCHER = Event->io (
2188Event->io ( 3429 reentrant => 0,
2189 fd => IO::AIO::poll_fileno, 3430 fd => BDB::poll_fileno,
2190 poll => 'r', 3431 poll => 'r',
2191 prio => 5, 3432 prio => 0,
2192 data => WF_AUTOCANCEL,
2193 cb => \&IO::AIO::poll_cb,
2194);
2195
2196Event->timer (
2197 data => WF_AUTOCANCEL, 3433 data => WF_AUTOCANCEL,
2198 after => 0, 3434 cb => \&BDB::poll_cb,
2199 interval => 10, 3435 );
2200 cb => sub { 3436 BDB::min_parallel 8;
2201 (Coro::unblock_sub { 3437
2202 write_runtime 3438 BDB::set_sync_prepare {
2203 or warn "ERROR: unable to write runtime file: $!"; 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 $@;
2204 })->(); 3472 };
2205 }, 3473 }
2206); 3474}
3475
3476{
3477 IO::AIO::min_parallel 8;
3478
3479 undef $Coro::AIO::WATCHER;
3480 IO::AIO::max_poll_time $TICK * 0.1;
3481 $AIO_POLL_WATCHER = Event->io (
3482 reentrant => 0,
3483 data => WF_AUTOCANCEL,
3484 fd => IO::AIO::poll_fileno,
3485 poll => 'r',
3486 prio => 6,
3487 cb => \&IO::AIO::poll_cb,
3488 );
3489}
3490
3491my $_log_backtrace;
3492
3493sub _log_backtrace {
3494 my ($msg, @addr) = @_;
3495
3496 $msg =~ s/\n//;
3497
3498 # limit the # of concurrent backtraces
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";
3526 }
3527}
3528
3529# load additional modules
3530use cf::pod;
2207 3531
2208END { cf::emergency_save } 3532END { cf::emergency_save }
2209 3533
22101 35341
2211 3535

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines