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.131 by root, Thu Jan 4 00:53:54 2007 UTC vs.
Revision 1.347 by root, Thu Aug 30 05:16:09 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.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 (2); # 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 $FREEZE; 95
55our $RANDOM_MAPS = cf::localdir . "/random"; 96# used to convert map paths into valid unix filenames by replacing / by ∕
56our %EXT_CORO; 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
57 102
58binmode STDOUT; 103binmode STDOUT;
59binmode STDERR; 104binmode STDERR;
60 105
61# read virtual server time, if available 106# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
64 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
65 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
66} 111}
67 112
68mkdir cf::localdir; 113mkdir $_
69mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73 115
74# a special map that is always available
75our $LINK_MAP;
76our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
117
118sub cf::map::normalise;
77 119
78############################################################################# 120#############################################################################
79 121
80=head2 GLOBAL VARIABLES 122=head2 GLOBAL VARIABLES
81 123
88=item $cf::RUNTIME 130=item $cf::RUNTIME
89 131
90The 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
91every server tick. 133every server tick.
92 134
93=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
94 138
95The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
96be 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.
97 143
98=item $cf::NOW 144=item $cf::NOW
99 145
100The time of the last (current) server tick. 146The time of the last (current) server tick.
101 147
102=item $cf::TICK 148=item $cf::TICK
103 149
104The 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.
105 161
106=item %cf::CFG 162=item %cf::CFG
107 163
108Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
109from 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.
110 178
111=back 179=back
112 180
113=cut 181=cut
114 182
115BEGIN { 183BEGIN {
116 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
117 my $msg = join "", @_; 185 my $msg = join "", @_;
118 utf8::encode $msg;
119 186
120 $msg .= "\n" 187 $msg .= "\n"
121 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
122 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
123 LOG llevError, "cfperl: $msg"; 193 LOG llevError, $msg;
124 }; 194 };
125} 195}
126 196
127@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
128@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
129@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
130@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
131@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';
132@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)
133 204
134# 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
135# within the Safe compartment. 206# within the Safe compartment.
136for my $pkg (qw( 207for my $pkg (qw(
137 cf::global cf::attachable 208 cf::global cf::attachable
146 217
147$Event::DIED = sub { 218$Event::DIED = sub {
148 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
149}; 220};
150 221
151my %ext_pkg; 222#############################################################################
152my @exts;
153my @hook;
154 223
155=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
156 225
157=over 4 226=over 4
158 227
159=cut 228=item dumpval $ref
160 229
161use 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}
162 250
163=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
164 252
165Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
166 254
167=cut
168
169sub from_json($) {
170 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
171 JSON::Syck::Load $_[0]
172}
173
174=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
175 256
176Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
177 258
178=cut 259=cut
179 260
180sub to_json($) { 261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
181 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
182 JSON::Syck::Dump $_[0]
183}
184 262
185=item my $guard = cf::guard { BLOCK } 263sub to_json ($) { $json_coder->encode ($_[0]) }
186 264sub from_json ($) { $json_coder->decode ($_[0]) }
187Run the given callback when the guard object gets destroyed (useful for
188coroutine cancellations).
189
190You can call C<< ->cancel >> on the guard object to stop the block from
191being executed.
192
193=cut
194
195sub guard(&) {
196 bless \(my $cb = $_[0]), cf::guard::;
197}
198
199sub cf::guard::cancel {
200 ${$_[0]} = sub { };
201}
202
203sub cf::guard::DESTROY {
204 ${$_[0]}->();
205}
206 265
207=item cf::lock_wait $string 266=item cf::lock_wait $string
208 267
209Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
210 269
211=item my $lock = cf::lock_acquire $string 270=item my $lock = cf::lock_acquire $string
212 271
213Wait 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
214a 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,
215for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
216returned. 275returned.
217 276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
279
218Lock names should begin with a unique identifier (for example, find_map 280Lock names should begin with a unique identifier (for example, cf::map::find
219uses map_find and load_map 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.
220 286
221=cut 287=cut
222 288
223our %LOCK; 289our %LOCK;
224 290
238 # wait, to be sure we are not locked 304 # wait, to be sure we are not locked
239 lock_wait $key; 305 lock_wait $key;
240 306
241 $LOCK{$key} = []; 307 $LOCK{$key} = [];
242 308
243 cf::guard { 309 Coro::guard {
244 # wake up all waiters, to be on the safe side 310 # wake up all waiters, to be on the safe side
245 $_->ready for @{ delete $LOCK{$key} }; 311 $_->ready for @{ delete $LOCK{$key} };
246 } 312 }
247} 313}
248 314
315sub lock_active($) {
316 my ($key) = @_;
317
318 ! ! $LOCK{$key}
319}
320
321sub freeze_mainloop {
322 return unless $TICK_WATCHER->is_active;
323
324 my $guard = Coro::guard {
325 $TICK_WATCHER->start;
326 };
327 $TICK_WATCHER->stop;
328 $guard
329}
330
331=item cf::get_slot $time[, $priority[, $name]]
332
333Allocate $time seconds of blocking CPU time at priority C<$priority>:
334This call blocks and returns only when you have at least C<$time> seconds
335of cpu time till the next tick. The slot is only valid till the next cede.
336
337The optional C<$name> can be used to identify the job to run. It might be
338used for statistical purposes and should identify the same time-class.
339
340Useful for short background jobs.
341
342=cut
343
344our @SLOT_QUEUE;
345our $SLOT_QUEUE;
346
347$SLOT_QUEUE->cancel if $SLOT_QUEUE;
348$SLOT_QUEUE = Coro::async {
349 my $signal = new Coro::Signal;
350
351 while () {
352 next_job:
353 my $avail = cf::till_tick;
354 if ($avail > 0.01) {
355 for (0 .. $#SLOT_QUEUE) {
356 if ($SLOT_QUEUE[$_][0] < $avail) {
357 my $job = splice @SLOT_QUEUE, $_, 1, ();
358 $job->[2]->send;
359 Coro::cede;
360 goto next_job;
361 }
362 }
363 }
364
365 if (@SLOT_QUEUE) {
366 # we do not use wait_For_tick() as it returns immediately when tick is inactive
367 push @cf::WAIT_FOR_TICK, $signal;
368 $signal->wait;
369 } else {
370 Coro::schedule;
371 }
372 }
373};
374
375sub get_slot($;$$) {
376 my ($time, $pri, $name) = @_;
377
378 $time = $TICK * .6 if $time > $TICK * .6;
379 my $sig = new Coro::Signal;
380
381 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
382 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
383 $SLOT_QUEUE->ready;
384 $sig->wait;
385}
386
249=item cf::async { BLOCK } 387=item cf::async { BLOCK }
250 388
251Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the 389Currently the same as Coro::async_pool, meaning you cannot use
252error instead of exiting the server in case of a problem. 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.
253 392
254=cut 393=cut
255 394
256sub async(&) { 395BEGIN { *async = \&Coro::async_pool }
257 my ($cb) = @_;
258
259 Coro::async {
260 eval { $cb->() };
261 warn $@ if $@;
262 }
263}
264 396
265=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
266 398
267The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
268always able to handle events or runnable, as crossfire+ is only partly 400is always able to handle events or runnable, as Crossfire TRT is only
269reentrant. 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.
270 403
271If 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
272the given BLOCK in another coroutine while waiting for the result. The 405the given BLOCK in another coroutine while waiting for the result. The
273server 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
274fast or be very important. 407fast or be very important.
277 410
278sub sync_job(&) { 411sub sync_job(&) {
279 my ($job) = @_; 412 my ($job) = @_;
280 413
281 if ($Coro::current == $Coro::main) { 414 if ($Coro::current == $Coro::main) {
415 my $time = Event::time;
416
282 # this is the main coro, too bad, we have to block 417 # this is the main coro, too bad, we have to block
283 # till the operation succeeds, freezing the server :/ 418 # till the operation succeeds, freezing the server :/
284 419
285 # TODO: use suspend/resume instead 420 # TODO: use suspend/resume instead
286 # (but this is cancel-safe) 421 # (but this is cancel-safe)
287 local $FREEZE = 1; 422 my $freeze_guard = freeze_mainloop;
288 423
289 my $busy = 1; 424 my $busy = 1;
290 my @res; 425 my @res;
291 426
292 (Coro::async { 427 (async {
293 @res = eval { $job->() }; 428 @res = eval { $job->() };
294 warn $@ if $@; 429 warn $@ if $@;
295 undef $busy; 430 undef $busy;
296 })->prio (Coro::PRIO_MAX); 431 })->prio (Coro::PRIO_MAX);
297 432
298 while ($busy) { 433 while ($busy) {
299 Coro::cede_notself; 434 Coro::cede or Event::one_event;
300 Event::one_event unless Coro::nready;
301 } 435 }
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
302 443
303 wantarray ? @res : $res[0] 444 wantarray ? @res : $res[0]
304 } else { 445 } else {
305 # we are in another coroutine, how wonderful, everything just works 446 # we are in another coroutine, how wonderful, everything just works
306 447
307 $job->() 448 $job->()
308 } 449 }
309} 450}
310 451
311=item $coro = cf::coro { BLOCK } 452=item $coro = cf::async_ext { BLOCK }
312 453
313Creates and returns a new coro. This coro is automcatially being canceled 454Like async, but this coro is automatically being canceled when the
314when the extension calling this is being unloaded. 455extension calling this is being unloaded.
315 456
316=cut 457=cut
317 458
318sub coro(&) { 459sub async_ext(&) {
319 my $cb = shift; 460 my $cb = shift;
320 461
321 my $coro = &cf::async ($cb); 462 my $coro = &Coro::async ($cb);
322 463
323 $coro->on_destroy (sub { 464 $coro->on_destroy (sub {
324 delete $EXT_CORO{$coro+0}; 465 delete $EXT_CORO{$coro+0};
325 }); 466 });
326 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
327 468
328 $coro 469 $coro
329} 470}
330 471
331sub write_runtime { 472=item fork_call { }, $args
332 my $runtime = cf::localdir . "/runtime";
333 473
334 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 474Executes the given code block with the given arguments in a seperate
335 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.
336 478
337 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 479=cut
338 (aio_write $fh, 0, (length $value), $value, 0) <= 0
339 and return;
340 480
341 aio_fsync $fh 481sub fork_call(&@) {
342 and return; 482 my ($cb, @args) = @_;
343 483
344 close $fh 484 # we seemingly have to make a local copy of the whole thing,
345 or return; 485 # otherwise perl prematurely frees the stuff :/
486 # TODO: investigate and fix (liekly this will be rather laborious)
346 487
347 aio_rename "$runtime~", $runtime 488 my @res = Coro::Util::fork_eval {
348 and return; 489 reset_signals;
490 &$cb
491 }, @args;
349 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 };
350 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 });
351} 621}
352 622
353=back 623=back
354 624
355=cut 625=cut
356
357#############################################################################
358
359package cf::path;
360
361sub new {
362 my ($class, $path, $base) = @_;
363
364 $path = $path->as_string if ref $path;
365
366 my $self = bless { }, $class;
367
368 # {... are special paths that are not touched
369 # ?xxx/... are special absolute paths
370 # ?random/... random maps
371 # /! non-realised random map exit
372 # /... normal maps
373 # ~/... per-player maps without a specific player (DO NOT USE)
374 # ~user/... per-player map of a specific user
375
376 if ($path =~ /^{/) {
377 # fine as it is
378 } elsif ($path =~ s{^\?random/}{}) {
379 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
380 $self->{random} = cf::from_json $data;
381 } else {
382 if ($path =~ s{^~([^/]+)?}{}) {
383 $self->{user_rel} = 1;
384
385 if (defined $1) {
386 $self->{user} = $1;
387 } elsif ($base =~ m{^~([^/]+)/}) {
388 $self->{user} = $1;
389 } else {
390 warn "cannot resolve user-relative path without user <$path,$base>\n";
391 }
392 } elsif ($path =~ /^\//) {
393 # already absolute
394 } else {
395 $base =~ s{[^/]+/?$}{};
396 return $class->new ("$base/$path");
397 }
398
399 for ($path) {
400 redo if s{/\.?/}{/};
401 redo if s{/[^/]+/\.\./}{/};
402 }
403 }
404
405 $self->{path} = $path;
406
407 $self
408}
409
410# the name / primary key / in-game path
411sub as_string {
412 my ($self) = @_;
413
414 $self->{user_rel} ? "~$self->{user}$self->{path}"
415 : $self->{random} ? "?random/$self->{path}"
416 : $self->{path}
417}
418
419# the displayed name, this is a one way mapping
420sub visible_name {
421 my ($self) = @_;
422
423# if (my $rmp = $self->{random}) {
424# # todo: be more intelligent about this
425# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
426# } else {
427 $self->as_string
428# }
429}
430
431# escape the /'s in the path
432sub _escaped_path {
433 # ∕ is U+2215
434 (my $path = $_[0]{path}) =~ s/\//∕/g;
435 $path
436}
437
438# the original (read-only) location
439sub load_path {
440 my ($self) = @_;
441
442 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
443}
444
445# the temporary/swap location
446sub save_path {
447 my ($self) = @_;
448
449 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
450 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
451 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
452}
453
454# the unique path, might be eq to save_path
455sub uniq_path {
456 my ($self) = @_;
457
458 $self->{user_rel} || $self->{random}
459 ? undef
460 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
461}
462
463# return random map parameters, or undef
464sub random_map_params {
465 my ($self) = @_;
466
467 $self->{random}
468}
469
470# this is somewhat ugly, but style maps do need special treatment
471sub is_style_map {
472 $_[0]{path} =~ m{^/styles/}
473}
474
475package cf;
476 626
477############################################################################# 627#############################################################################
478 628
479=head2 ATTACHABLE OBJECTS 629=head2 ATTACHABLE OBJECTS
480 630
482attach callbacks/event handlers (a collection of which is called an "attachment") 632attach callbacks/event handlers (a collection of which is called an "attachment")
483to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
484 634
485In 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>
486C<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
487crossfire+). 637Crossfire TRT).
488 638
489=over 4 639=over 4
490 640
491=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
492 642
606our @CB_TYPE = (); # registry for type (cf-object class) based events 756our @CB_TYPE = (); # registry for type (cf-object class) based events
607our @CB_MAP = (); 757our @CB_MAP = ();
608 758
609my %attachment; 759my %attachment;
610 760
761sub cf::attachable::thawer_merge {
762 # simply override everything except _meta
763 local $_[0]{_meta};
764 %{$_[0]} = %{$_[1]};
765}
766
611sub _attach_cb($$$$) { 767sub _attach_cb($$$$) {
612 my ($registry, $event, $prio, $cb) = @_; 768 my ($registry, $event, $prio, $cb) = @_;
613 769
614 use sort 'stable'; 770 use sort 'stable';
615 771
649 $registry = $CB_TYPE[$object_type] ||= []; 805 $registry = $CB_TYPE[$object_type] ||= [];
650 806
651 } elsif ($type eq "subtype") { 807 } elsif ($type eq "subtype") {
652 defined $object_type or Carp::croak "subtype specified without type"; 808 defined $object_type or Carp::croak "subtype specified without type";
653 my $object_subtype = shift @arg; 809 my $object_subtype = shift @arg;
654 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 810 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
655 811
656 } elsif ($type eq "package") { 812 } elsif ($type eq "package") {
657 my $pkg = shift @arg; 813 my $pkg = shift @arg;
658 814
659 while (my ($name, $id) = each %cb_id) { 815 while (my ($name, $id) = each %cb_id) {
688 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
689 } 845 }
690 846
691 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
692 } else { 848 } else {
693 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
694 } 850 }
695 851
696 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
697} 853}
698 854
700 if (ref $_[0]) { 856 if (ref $_[0]) {
701 _object_attach @_; 857 _object_attach @_;
702 } else { 858 } else {
703 _attach shift->_attach_registry, @_; 859 _attach shift->_attach_registry, @_;
704 } 860 }
861 _recalc_want;
705}; 862};
706 863
707# all those should be optimised 864# all those should be optimised
708sub cf::attachable::detach { 865sub cf::attachable::detach {
709 my ($obj, $name) = @_; 866 my ($obj, $name) = @_;
712 delete $obj->{_attachment}{$name}; 869 delete $obj->{_attachment}{$name};
713 reattach ($obj); 870 reattach ($obj);
714 } else { 871 } else {
715 Carp::croak "cannot, currently, detach class attachments"; 872 Carp::croak "cannot, currently, detach class attachments";
716 } 873 }
874 _recalc_want;
717}; 875};
718 876
719sub cf::attachable::attached { 877sub cf::attachable::attached {
720 my ($obj, $name) = @_; 878 my ($obj, $name) = @_;
721 879
736 "; 894 ";
737 die if $@; 895 die if $@;
738} 896}
739 897
740our $override; 898our $override;
741our @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?
742 900
743sub override { 901sub override {
744 $override = 1; 902 $override = 1;
745 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
746} 904}
747 905
748sub do_invoke { 906sub do_invoke {
749 my $event = shift; 907 my $event = shift;
750 my $callbacks = shift; 908 my $callbacks = shift;
751 909
752 @invoke_results = (); 910 @INVOKE_RESULTS = ();
753 911
754 local $override; 912 local $override;
755 913
756 for (@$callbacks) { 914 for (@$callbacks) {
757 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
774 932
775Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
776 934
777This 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
778removed 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
779results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
780 938
781=back 939=back
782 940
783=cut 941=cut
784 942
785############################################################################# 943#############################################################################
786# 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}
787 956
788sub reattach { 957sub reattach {
789 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
790 my ($obj) = @_; 959 my ($obj) = @_;
960
961 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
791 962
792 my $registry = $obj->registry; 963 my $registry = $obj->registry;
793 964
794 @$registry = (); 965 @$registry = ();
795 966
842 $filename, length $$rdata, scalar @$objs; 1013 $filename, length $$rdata, scalar @$objs;
843 1014
844 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1015 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
845 chmod SAVE_MODE, $fh; 1016 chmod SAVE_MODE, $fh;
846 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1017 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
847 aio_fsync $fh; 1018 aio_fsync $fh if $cf::USE_FSYNC;
848 close $fh; 1019 close $fh;
849 1020
850 if (@$objs) { 1021 if (@$objs) {
851 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) {
852 chmod SAVE_MODE, $fh; 1023 chmod SAVE_MODE, $fh;
853 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1024 my $data = Storable::nfreeze { version => 1, objs => $objs };
854 aio_write $fh, 0, (length $data), $data, 0; 1025 aio_write $fh, 0, (length $data), $data, 0;
855 aio_fsync $fh; 1026 aio_fsync $fh if $cf::USE_FSYNC;
856 close $fh; 1027 close $fh;
857 aio_rename "$filename.pst~", "$filename.pst"; 1028 aio_rename "$filename.pst~", "$filename.pst";
858 } 1029 }
859 } else { 1030 } else {
860 aio_unlink "$filename.pst"; 1031 aio_unlink "$filename.pst";
892 or return; 1063 or return;
893 $av = eval { (Storable::thaw $av)->{objs} }; 1064 $av = eval { (Storable::thaw $av)->{objs} };
894 } 1065 }
895 1066
896 warn sprintf "loading %s (%d)\n", 1067 warn sprintf "loading %s (%d)\n",
897 $filename, length $data, scalar @{$av || []};#d# 1068 $filename, length $data, scalar @{$av || []};
898 return ($data, $av); 1069 return ($data, $av);
899} 1070}
1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
900 1077
901############################################################################# 1078#############################################################################
902# command handling &c 1079# command handling &c
903 1080
904=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
917 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
918} 1095}
919 1096
920=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
921 1098
922Register 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.
923 1104
924If 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
925called. 1106called.
926 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
927=cut 1119=cut
928 1120
929sub register_extcmd { 1121sub register_extcmd {
930 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
931 1123
932 my $caller = caller;
933 #warn "registering extcmd '$name' to '$caller'";
934
935 $EXTCMD{$name} = [$cb, $caller]; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
936} 1131}
937 1132
938cf::player->attach ( 1133cf::player->attach (
939 on_command => sub { 1134 on_command => sub {
940 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
949 cf::override; 1144 cf::override;
950 }, 1145 },
951 on_extcmd => sub { 1146 on_extcmd => sub {
952 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
953 1148
954 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
955 1150
956 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
957 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
958 if (my %reply = $cb->[0]->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
959 $pl->ext_reply ($msg->{msgid}, %reply);
960 }
961 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
962 } else { 1166 } else {
963 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
964 } 1168 }
965 1169
966 cf::override; 1170 cf::override;
967 }, 1171 },
968); 1172);
969 1173
970sub register {
971 my ($base, $pkg) = @_;
972
973 #TODO
974}
975
976sub 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/(?<![BIUGH])</&lt;/g;
1469
1470 # this is buggy, it needs to properly take care of nested <'s
1471
1472 1 while
1473 # replace B<>, I<>, U<> etc.
1474 s/B<([^\>]*)>/<b>$1<\/b>/
1475 || s/I<([^\>]*)>/<i>$1<\/i>/
1476 || s/U<([^\>]*)>/<u>$1<\/u>/
1477 # replace G<male|female> tags
1478 || s{G<([^>|]*)\|([^>]*)>}{
1479 $self->gender ? $2 : $1
1480 }ge
1481 # replace H<hint text>
1482 || s{H<([^\>]*)>}
1483 {
1484 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1485 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1486 "")
1487 [$self->{hintmode}]
1488 }ge;
1489
1490 # create single paragraphs (very hackish)
1491 s/(?<=\S)\n(?=\w)/ /g;
1492
1493 # compress some whitespace
1494 s/\s+\n/\n/g; # ws line-ends
1495 s/\n\n+/\n/g; # double lines
1496 s/^\n+//; # beginning lines
1497 s/\n+$//; # ending lines
1498
1499 $_
1500}
1501
1502sub hintmode {
1503 $_[0]{hintmode} = $_[1] if @_ > 1;
1504 $_[0]{hintmode}
1505}
1506
1507=item $player->ext_reply ($msgid, @msg)
1508
1509Sends an ext reply to the player.
1510
1511=cut
1512
1513sub ext_reply($$@) {
1514 my ($self, $id, @msg) = @_;
1515
1516 $self->ns->ext_reply ($id, @msg)
1517}
1518
1519=item $player->ext_msg ($type, @msg)
1520
1521Sends an ext event to the client.
1522
1523=cut
1524
1525sub ext_msg($$@) {
1526 my ($self, $type, @msg) = @_;
1527
1528 $self->ns->ext_msg ($type, @msg);
1529}
1530
1531=head3 cf::region
1532
1533=over 4
1534
1535=cut
1536
1537package cf::region;
1538
1539=item cf::region::find_by_path $path
1540
1541Tries to decuce the likely region for a map knowing only its path.
1542
1543=cut
1544
1545sub find_by_path($) {
977 my ($path) = @_; 1546 my ($path) = @_;
978 1547
979 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1548 my ($match, $specificity);
980 my $base = $1;
981 my $pkg = $1;
982 $pkg =~ s/[^[:word:]]/_/g;
983 $pkg = "ext::$pkg";
984 1549
985 warn "loading '$path' into '$pkg'\n"; 1550 for my $region (list) {
986 1551 if ($region->{match} && $path =~ $region->{match}) {
987 open my $fh, "<:utf8", $path 1552 ($match, $specificity) = ($region, $region->specificity)
988 or die "$path: $!"; 1553 if $region->specificity > $specificity;
989 1554 }
990 my $source =
991 "package $pkg; use strict; use utf8;\n"
992 . "#line 1 \"$path\"\n{\n"
993 . (do { local $/; <$fh> })
994 . "\n};\n1";
995
996 eval $source
997 or die $@ ? "$path: $@\n"
998 : "extension disabled.\n";
999
1000 push @exts, $pkg;
1001 $ext_pkg{$base} = $pkg;
1002
1003# no strict 'refs';
1004# @{"$pkg\::ISA"} = ext::;
1005
1006 register $base, $pkg;
1007}
1008
1009sub unload_extension {
1010 my ($pkg) = @_;
1011
1012 warn "removing extension $pkg\n";
1013
1014 # remove hooks
1015 #TODO
1016# for my $idx (0 .. $#PLUGIN_EVENT) {
1017# delete $hook[$idx]{$pkg};
1018# } 1555 }
1019 1556
1020 # remove commands 1557 $match
1021 for my $name (keys %COMMAND) {
1022 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1023
1024 if (@cb) {
1025 $COMMAND{$name} = \@cb;
1026 } else {
1027 delete $COMMAND{$name};
1028 }
1029 }
1030
1031 # remove extcmds
1032 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1033 delete $EXTCMD{$name};
1034 }
1035
1036 if (my $cb = $pkg->can ("unload")) {
1037 eval {
1038 $cb->($pkg);
1039 1
1040 } or warn "$pkg unloaded, but with errors: $@";
1041 }
1042
1043 Symbol::delete_package $pkg;
1044}
1045
1046sub load_extensions {
1047 for my $ext (<$LIBDIR/*.ext>) {
1048 next unless -r $ext;
1049 eval {
1050 load_extension $ext;
1051 1
1052 } or warn "$ext not loaded: $@";
1053 }
1054}
1055
1056#############################################################################
1057# load/save/clean perl data associated with a map
1058
1059*cf::mapsupport::on_clean = sub {
1060 my ($map) = @_;
1061
1062 my $path = $map->tmpname;
1063 defined $path or return;
1064
1065 unlink "$path.pst";
1066};
1067
1068cf::map->attach (prio => -10000, package => cf::mapsupport::);
1069
1070#############################################################################
1071# load/save perl data associated with player->ob objects
1072
1073sub all_objects(@) {
1074 @_, map all_objects ($_->inv), @_
1075}
1076
1077# TODO: compatibility cruft, remove when no longer needed
1078cf::player->attach (
1079 on_load => sub {
1080 my ($pl, $path) = @_;
1081
1082 for my $o (all_objects $pl->ob) {
1083 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1084 $o->set_ob_key_value ("_perl_data");
1085
1086 %$o = %{ Storable::thaw pack "H*", $value };
1087 }
1088 }
1089 },
1090);
1091
1092#############################################################################
1093
1094=head2 CORE EXTENSIONS
1095
1096Functions and methods that extend core crossfire objects.
1097
1098=head3 cf::player
1099
1100=over 4
1101
1102=item cf::player::exists $login
1103
1104Returns true when the given account exists.
1105
1106=cut
1107
1108sub cf::player::exists($) {
1109 cf::player::find $_[0]
1110 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1111}
1112
1113=item $player->ext_reply ($msgid, $msgtype, %msg)
1114
1115Sends an ext reply to the player.
1116
1117=cut
1118
1119sub cf::player::ext_reply($$$%) {
1120 my ($self, $id, %msg) = @_;
1121
1122 $msg{msgid} = $id;
1123
1124 $self->send ("ext " . to_json \%msg);
1125} 1558}
1126 1559
1127=back 1560=back
1128
1129 1561
1130=head3 cf::map 1562=head3 cf::map
1131 1563
1132=over 4 1564=over 4
1133 1565
1136package cf::map; 1568package cf::map;
1137 1569
1138use Fcntl; 1570use Fcntl;
1139use Coro::AIO; 1571use Coro::AIO;
1140 1572
1573use overload
1574 '""' => \&as_string,
1575 fallback => 1;
1576
1141our $MAX_RESET = 7200; 1577our $MAX_RESET = 3600;
1142our $DEFAULT_RESET = 3600; 1578our $DEFAULT_RESET = 3000;
1143 1579
1144sub generate_random_map { 1580sub generate_random_map {
1145 my ($path, $rmp) = @_; 1581 my ($self, $rmp) = @_;
1146
1147 # mit "rum" bekleckern, nicht 1582 # mit "rum" bekleckern, nicht
1148 cf::map::_create_random_map 1583 $self->_create_random_map (
1149 $path,
1150 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1584 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1151 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1585 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1152 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1586 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1153 $rmp->{exit_on_final_map}, 1587 $rmp->{exit_on_final_map},
1154 $rmp->{xsize}, $rmp->{ysize}, 1588 $rmp->{xsize}, $rmp->{ysize},
1155 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1589 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1156 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1590 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1157 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1591 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1158 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1592 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1159 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1593 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1160 (cf::region::find $rmp->{region}) 1594 (cf::region::find $rmp->{region}), $rmp->{custom}
1595 )
1596}
1597
1598=item cf::map->register ($regex, $prio)
1599
1600Register a handler for the map path matching the given regex at the
1601givne priority (higher is better, built-in handlers have priority 0, the
1602default).
1603
1604=cut
1605
1606sub register {
1607 my (undef, $regex, $prio) = @_;
1608 my $pkg = caller;
1609
1610 no strict;
1611 push @{"$pkg\::ISA"}, __PACKAGE__;
1612
1613 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1614}
1615
1616# also paths starting with '/'
1617$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1618
1619sub thawer_merge {
1620 my ($self, $merge) = @_;
1621
1622 # we have to keep some variables in memory intact
1623 local $self->{path};
1624 local $self->{load_path};
1625
1626 $self->SUPER::thawer_merge ($merge);
1627}
1628
1629sub normalise {
1630 my ($path, $base) = @_;
1631
1632 $path = "$path"; # make sure its a string
1633
1634 $path =~ s/\.map$//;
1635
1636 # map plan:
1637 #
1638 # /! non-realised random map exit (special hack!)
1639 # {... are special paths that are not being touched
1640 # ?xxx/... are special absolute paths
1641 # ?random/... random maps
1642 # /... normal maps
1643 # ~user/... per-player map of a specific user
1644
1645 $path =~ s/$PATH_SEP/\//go;
1646
1647 # treat it as relative path if it starts with
1648 # something that looks reasonable
1649 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1650 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1651
1652 $base =~ s{[^/]+/?$}{};
1653 $path = "$base/$path";
1654 }
1655
1656 for ($path) {
1657 redo if s{//}{/};
1658 redo if s{/\.?/}{/};
1659 redo if s{/[^/]+/\.\./}{/};
1660 }
1661
1662 $path
1663}
1664
1665sub new_from_path {
1666 my (undef, $path, $base) = @_;
1667
1668 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1669
1670 $path = normalise $path, $base;
1671
1672 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1673 if ($path =~ $EXT_MAP{$pkg}[1]) {
1674 my $self = bless cf::map::new, $pkg;
1675 $self->{path} = $path; $self->path ($path);
1676 $self->init; # pass $1 etc.
1677 return $self;
1678 }
1679 }
1680
1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1682 ()
1683}
1684
1685sub init {
1686 my ($self) = @_;
1687
1688 $self
1689}
1690
1691sub as_string {
1692 my ($self) = @_;
1693
1694 "$self->{path}"
1695}
1696
1697# the displayed name, this is a one way mapping
1698sub visible_name {
1699 &as_string
1700}
1701
1702# the original (read-only) location
1703sub load_path {
1704 my ($self) = @_;
1705
1706 "$MAPDIR/$self->{path}.map"
1707}
1708
1709# the temporary/swap location
1710sub save_path {
1711 my ($self) = @_;
1712
1713 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1714 "$TMPDIR/$path.map"
1715}
1716
1717# the unique path, undef == no special unique path
1718sub uniq_path {
1719 my ($self) = @_;
1720
1721 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1722 "$UNIQUEDIR/$path"
1161} 1723}
1162 1724
1163# and all this just because we cannot iterate over 1725# and all this just because we cannot iterate over
1164# all maps in C++... 1726# all maps in C++...
1165sub change_all_map_light { 1727sub change_all_map_light {
1167 1729
1168 $_->change_map_light ($change) 1730 $_->change_map_light ($change)
1169 for grep $_->outdoor, values %cf::MAP; 1731 for grep $_->outdoor, values %cf::MAP;
1170} 1732}
1171 1733
1734sub decay_objects {
1735 my ($self) = @_;
1736
1737 return if $self->{deny_reset};
1738
1739 $self->do_decay_objects;
1740}
1741
1742sub unlink_save {
1743 my ($self) = @_;
1744
1745 utf8::encode (my $save = $self->save_path);
1746 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1747 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1748}
1749
1172sub try_load_header($) { 1750sub load_header_from($) {
1173 my ($path) = @_; 1751 my ($self, $path) = @_;
1174 1752
1175 utf8::encode $path; 1753 utf8::encode $path;
1176 aio_open $path, O_RDONLY, 0 1754 #aio_open $path, O_RDONLY, 0
1755 # or return;
1756
1757 $self->_load_header ($path)
1177 or return; 1758 or return;
1178 1759
1179 my $map = cf::map::new 1760 $self->{load_path} = $path;
1761
1762 1
1763}
1764
1765sub load_header_orig {
1766 my ($self) = @_;
1767
1768 $self->load_header_from ($self->load_path)
1769}
1770
1771sub load_header_temp {
1772 my ($self) = @_;
1773
1774 $self->load_header_from ($self->save_path)
1775}
1776
1777sub prepare_temp {
1778 my ($self) = @_;
1779
1780 $self->last_access ((delete $self->{last_access})
1781 || $cf::RUNTIME); #d#
1782 # safety
1783 $self->{instantiate_time} = $cf::RUNTIME
1784 if $self->{instantiate_time} > $cf::RUNTIME;
1785}
1786
1787sub prepare_orig {
1788 my ($self) = @_;
1789
1790 $self->{load_original} = 1;
1791 $self->{instantiate_time} = $cf::RUNTIME;
1792 $self->last_access ($cf::RUNTIME);
1793 $self->instantiate;
1794}
1795
1796sub load_header {
1797 my ($self) = @_;
1798
1799 if ($self->load_header_temp) {
1800 $self->prepare_temp;
1801 } else {
1802 $self->load_header_orig
1180 or return; 1803 or return;
1804 $self->prepare_orig;
1805 }
1181 1806
1182 $map->load_header ($path) 1807 $self->{deny_reset} = 1
1183 or return; 1808 if $self->no_reset;
1184 1809
1185 $map->{load_path} = $path; 1810 $self->default_region (cf::region::find_by_path $self->{path})
1811 unless $self->default_region;
1186 1812
1187 $map 1813 1
1188} 1814}
1189 1815
1190sub find_map; 1816sub find;
1191sub find_map { 1817sub find {
1192 my ($path, $origin) = @_; 1818 my ($path, $origin) = @_;
1193 1819
1194 #warn "find_map<$path,$origin>\n";#d#
1195
1196 $path = new cf::path $path, $origin && $origin->path; 1820 $path = normalise $path, $origin && $origin->path;
1197 my $key = $path->as_string;
1198 1821
1199 cf::lock_wait "map_find:$key"; 1822 cf::lock_wait "map_find:$path";
1200 1823
1201 $cf::MAP{$key} || do { 1824 $cf::MAP{$path} || do {
1202 my $guard = cf::lock_acquire "map_find:$key"; 1825 my $guard = cf::lock_acquire "map_find:$path";
1203 1826 my $map = new_from_path cf::map $path
1204 # do it the slow way
1205 my $map = try_load_header $path->save_path;
1206
1207 if ($map) {
1208 # safety
1209 $map->{instantiate_time} = $cf::RUNTIME
1210 if $map->{instantiate_time} > $cf::RUNTIME;
1211 } else {
1212 if (my $rmp = $path->random_map_params) {
1213 $map = generate_random_map $key, $rmp;
1214 } else {
1215 $map = try_load_header $path->load_path;
1216 }
1217
1218 $map or return; 1827 or return;
1219 1828
1220 $map->{load_original} = 1;
1221 $map->{instantiate_time} = $cf::RUNTIME;
1222 $map->instantiate;
1223
1224 # per-player maps become, after loading, normal maps
1225 $map->per_player (0) if $path->{user_rel};
1226 }
1227
1228 $map->path ($key);
1229 $map->{path} = $path;
1230 $map->{last_save} = $cf::RUNTIME; 1829 $map->{last_save} = $cf::RUNTIME;
1231 $map->last_access ($cf::RUNTIME);
1232 1830
1233 if ($map->should_reset) { 1831 $map->load_header
1832 or return;
1833
1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1835 # doing this can freeze the server in a sync job, obviously
1836 #$cf::WAIT_FOR_TICK->wait;
1234 $map->reset; 1837 $map->reset;
1235 undef $guard; 1838 undef $guard;
1236 $map = find_map $path 1839 return find $path;
1237 or return;
1238 } 1840 }
1239 1841
1240 $cf::MAP{$key} = $map 1842 $cf::MAP{$path} = $map
1241 } 1843 }
1242} 1844}
1845
1846sub pre_load { }
1847sub post_load { }
1243 1848
1244sub load { 1849sub load {
1245 my ($self) = @_; 1850 my ($self) = @_;
1246 1851
1852 local $self->{deny_reset} = 1; # loading can take a long time
1853
1247 my $path = $self->{path}; 1854 my $path = $self->{path};
1855
1856 {
1857 my $guard1 = cf::lock_acquire "map_data:$path";
1248 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1858 my $guard2 = cf::lock_acquire "map_load:$path";
1249 1859
1250 return if $self->in_memory != cf::MAP_SWAPPED; 1860 return if $self->in_memory != cf::MAP_SWAPPED;
1251 1861
1252 $self->in_memory (cf::MAP_LOADING); 1862 $self->in_memory (cf::MAP_LOADING);
1253 1863
1254 $self->alloc; 1864 $self->alloc;
1865
1866 $self->pre_load;
1867 cf::cede_to_tick;
1868
1255 $self->load_objects ($self->{load_path}, 1) 1869 $self->_load_objects ($self->{load_path}, 1)
1256 or return; 1870 or return;
1257 1871
1258 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1872 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1259 if delete $self->{load_original}; 1873 if delete $self->{load_original};
1260 1874
1261 if (my $uniq = $path->uniq_path) { 1875 if (my $uniq = $self->uniq_path) {
1262 utf8::encode $uniq; 1876 utf8::encode $uniq;
1263 if (aio_open $uniq, O_RDONLY, 0) { 1877 if (aio_open $uniq, O_RDONLY, 0) {
1264 $self->clear_unique_items; 1878 $self->clear_unique_items;
1265 $self->load_objects ($uniq, 0); 1879 $self->_load_objects ($uniq, 0);
1266 } 1880 }
1267 } 1881 }
1268 1882
1883 cf::cede_to_tick;
1269 # now do the right thing for maps 1884 # now do the right thing for maps
1270 $self->link_multipart_objects; 1885 $self->link_multipart_objects;
1271
1272 if ($self->{path}->is_style_map) {
1273 $self->{deny_save} = 1;
1274 $self->{deny_reset} = 1;
1275 } else {
1276 $self->fix_auto_apply;
1277 $self->decay_objects;
1278 $self->update_buttons;
1279 $self->set_darkness_map;
1280 $self->difficulty ($self->estimate_difficulty) 1886 $self->difficulty ($self->estimate_difficulty)
1281 unless $self->difficulty; 1887 unless $self->difficulty;
1888 cf::cede_to_tick;
1889
1890 unless ($self->{deny_activate}) {
1891 $self->decay_objects;
1892 $self->fix_auto_apply;
1893 $self->update_buttons;
1894 cf::cede_to_tick;
1895 $self->set_darkness_map;
1896 cf::cede_to_tick;
1282 $self->activate; 1897 $self->activate;
1283 } 1898 }
1284 1899
1900 $self->{last_save} = $cf::RUNTIME;
1901 $self->last_access ($cf::RUNTIME);
1902
1285 $self->in_memory (cf::MAP_IN_MEMORY); 1903 $self->in_memory (cf::MAP_IN_MEMORY);
1286} 1904 }
1287 1905
1288sub load_map_sync { 1906 $self->post_load;
1907}
1908
1909sub customise_for {
1910 my ($self, $ob) = @_;
1911
1912 return find "~" . $ob->name . "/" . $self->{path}
1913 if $self->per_player;
1914
1915# return find "?party/" . $ob->name . "/" . $self->{path}
1916# if $self->per_party;
1917
1918 $self
1919}
1920
1921# find and load all maps in the 3x3 area around a map
1922sub load_neighbours {
1923 my ($map) = @_;
1924
1925 my @neigh; # diagonal neighbours
1926
1927 for (0 .. 3) {
1928 my $neigh = $map->tile_path ($_)
1929 or next;
1930 $neigh = find $neigh, $map
1931 or next;
1932 $neigh->load;
1933
1934 push @neigh,
1935 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1936 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1937 }
1938
1939 for (grep defined $_->[0], @neigh) {
1940 my ($path, $origin) = @$_;
1941 my $neigh = find $path, $origin
1942 or next;
1943 $neigh->load;
1944 }
1945}
1946
1947sub find_sync {
1289 my ($path, $origin) = @_; 1948 my ($path, $origin) = @_;
1290 1949
1291 #warn "load_map_sync<$path, $origin>\n";#d# 1950 cf::sync_job { find $path, $origin }
1951}
1292 1952
1293 cf::sync_job { 1953sub do_load_sync {
1294 my $map = cf::map::find_map $path, $origin 1954 my ($map) = @_;
1295 or return; 1955
1296 $map->load; 1956 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1297 $map 1957 if $Coro::current == $Coro::main;
1958
1959 cf::sync_job { $map->load };
1960}
1961
1962our %MAP_PREFETCH;
1963our $MAP_PREFETCHER = undef;
1964
1965sub find_async {
1966 my ($path, $origin, $load) = @_;
1967
1968 $path = normalise $path, $origin && $origin->{path};
1969
1970 if (my $map = $cf::MAP{$path}) {
1971 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1972 }
1973
1974 $MAP_PREFETCH{$path} |= $load;
1975
1976 $MAP_PREFETCHER ||= cf::async {
1977 while (%MAP_PREFETCH) {
1978 while (my ($k, $v) = each %MAP_PREFETCH) {
1979 if (my $map = find $k) {
1980 $map->load if $v;
1981 }
1982
1983 delete $MAP_PREFETCH{$k};
1984 }
1985 }
1986 undef $MAP_PREFETCHER;
1298 } 1987 };
1988 $MAP_PREFETCHER->prio (6);
1989
1990 ()
1299} 1991}
1300 1992
1301sub save { 1993sub save {
1302 my ($self) = @_; 1994 my ($self) = @_;
1303 1995
1996 my $lock = cf::lock_acquire "map_data:$self->{path}";
1997
1304 $self->{last_save} = $cf::RUNTIME; 1998 $self->{last_save} = $cf::RUNTIME;
1305 1999
1306 return unless $self->dirty; 2000 return unless $self->dirty;
1307 2001
1308 my $save = $self->{path}->save_path; utf8::encode $save; 2002 my $save = $self->save_path; utf8::encode $save;
1309 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2003 my $uniq = $self->uniq_path; utf8::encode $uniq;
1310 2004
1311 $self->{load_path} = $save; 2005 $self->{load_path} = $save;
1312 2006
1313 return if $self->{deny_save}; 2007 return if $self->{deny_save};
1314 2008
2009 local $self->{last_access} = $self->last_access;#d#
2010
2011 cf::async {
2012 $_->contr->save for $self->players;
2013 };
2014
1315 if ($uniq) { 2015 if ($uniq) {
1316 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2016 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1317 $self->save_objects ($uniq, cf::IO_UNIQUES); 2017 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1318 } else { 2018 } else {
1319 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2019 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1320 } 2020 }
1321} 2021}
1322 2022
1323sub swap_out { 2023sub swap_out {
1324 my ($self) = @_; 2024 my ($self) = @_;
1325 2025
1326 # save first because save cedes 2026 # save first because save cedes
1327 $self->save; 2027 $self->save;
2028
2029 my $lock = cf::lock_acquire "map_data:$self->{path}";
1328 2030
1329 return if $self->players; 2031 return if $self->players;
1330 return if $self->in_memory != cf::MAP_IN_MEMORY; 2032 return if $self->in_memory != cf::MAP_IN_MEMORY;
1331 return if $self->{deny_save}; 2033 return if $self->{deny_save};
1332 2034
1336 2038
1337sub reset_at { 2039sub reset_at {
1338 my ($self) = @_; 2040 my ($self) = @_;
1339 2041
1340 # TODO: safety, remove and allow resettable per-player maps 2042 # TODO: safety, remove and allow resettable per-player maps
1341 return 1e99 if $self->{path}{user_rel};
1342 return 1e99 if $self->{deny_reset}; 2043 return 1e99 if $self->{deny_reset};
1343 2044
1344 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2045 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1345 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2046 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1346 2047
1351 my ($self) = @_; 2052 my ($self) = @_;
1352 2053
1353 $self->reset_at <= $cf::RUNTIME 2054 $self->reset_at <= $cf::RUNTIME
1354} 2055}
1355 2056
1356sub unlink_save {
1357 my ($self) = @_;
1358
1359 utf8::encode (my $save = $self->{path}->save_path);
1360 aioreq_pri 3; IO::AIO::aio_unlink $save;
1361 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1362}
1363
1364sub rename {
1365 my ($self, $new_path) = @_;
1366
1367 $self->unlink_save;
1368
1369 delete $cf::MAP{$self->path};
1370 $self->{path} = new cf::path $new_path;
1371 $self->path ($self->{path}->as_string);
1372 $cf::MAP{$self->path} = $self;
1373
1374 $self->save;
1375}
1376
1377sub reset { 2057sub reset {
1378 my ($self) = @_; 2058 my ($self) = @_;
1379 2059
2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
2061
1380 return if $self->players; 2062 return if $self->players;
1381 return if $self->{path}{user_rel};#d#
1382 2063
1383 warn "resetting map ", $self->path;#d# 2064 warn "resetting map ", $self->path;
2065
2066 $self->in_memory (cf::MAP_SWAPPED);
2067
2068 # need to save uniques path
2069 unless ($self->{deny_save}) {
2070 my $uniq = $self->uniq_path; utf8::encode $uniq;
2071
2072 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2073 if $uniq;
2074 }
1384 2075
1385 delete $cf::MAP{$self->path}; 2076 delete $cf::MAP{$self->path};
2077
2078 $self->clear;
1386 2079
1387 $_->clear_links_to ($self) for values %cf::MAP; 2080 $_->clear_links_to ($self) for values %cf::MAP;
1388 2081
1389 $self->unlink_save; 2082 $self->unlink_save;
1390 $self->destroy; 2083 $self->destroy;
1393my $nuke_counter = "aaaa"; 2086my $nuke_counter = "aaaa";
1394 2087
1395sub nuke { 2088sub nuke {
1396 my ($self) = @_; 2089 my ($self) = @_;
1397 2090
2091 delete $cf::MAP{$self->path};
2092
2093 $self->unlink_save;
2094
2095 bless $self, "cf::map";
2096 delete $self->{deny_reset};
1398 $self->{deny_save} = 1; 2097 $self->{deny_save} = 1;
1399 $self->reset_timeout (1); 2098 $self->reset_timeout (1);
1400 $self->rename ("{nuke}/" . ($nuke_counter++)); 2099 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2100
2101 $cf::MAP{$self->path} = $self;
2102
1401 $self->reset; # polite request, might not happen 2103 $self->reset; # polite request, might not happen
1402} 2104}
1403 2105
1404sub customise_for { 2106=item $maps = cf::map::tmp_maps
1405 my ($map, $ob) = @_;
1406 2107
1407 if ($map->per_player) { 2108Returns an arrayref with all map paths of currently instantiated and saved
1408 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 2109maps. May block.
2110
2111=cut
2112
2113sub tmp_maps() {
1409 } 2114 [
1410 2115 map {
1411 $map 2116 utf8::decode $_;
2117 /\.map$/
2118 ? normalise $_
2119 : ()
2120 } @{ aio_readdir $TMPDIR or [] }
2121 ]
1412} 2122}
1413 2123
1414sub emergency_save { 2124=item $maps = cf::map::random_maps
1415 local $cf::FREEZE = 1;
1416 2125
1417 warn "enter emergency map save\n"; 2126Returns an arrayref with all map paths of currently instantiated and saved
2127random maps. May block.
1418 2128
1419 cf::sync_job { 2129=cut
1420 warn "begin emergency map save\n";
1421 $_->save for values %cf::MAP;
1422 };
1423 2130
1424 warn "end emergency map save\n"; 2131sub random_maps() {
2132 [
2133 map {
2134 utf8::decode $_;
2135 /\.map$/
2136 ? normalise "?random/$_"
2137 : ()
2138 } @{ aio_readdir $RANDOMDIR or [] }
2139 ]
2140}
2141
2142=item cf::map::unique_maps
2143
2144Returns an arrayref of paths of all shared maps that have
2145instantiated unique items. May block.
2146
2147=cut
2148
2149sub unique_maps() {
2150 [
2151 map {
2152 utf8::decode $_;
2153 /\.map$/
2154 ? normalise $_
2155 : ()
2156 } @{ aio_readdir $UNIQUEDIR or [] }
2157 ]
1425} 2158}
1426 2159
1427package cf; 2160package cf;
1428 2161
1429=back 2162=back
1430 2163
2164=head3 cf::object
2165
2166=cut
2167
2168package cf::object;
2169
2170=over 4
2171
2172=item $ob->inv_recursive
2173
2174Returns the inventory of the object _and_ their inventories, recursively.
2175
2176=cut
2177
2178sub inv_recursive_;
2179sub inv_recursive_ {
2180 map { $_, inv_recursive_ $_->inv } @_
2181}
2182
2183sub inv_recursive {
2184 inv_recursive_ inv $_[0]
2185}
2186
2187package cf;
2188
2189=back
1431 2190
1432=head3 cf::object::player 2191=head3 cf::object::player
1433 2192
1434=over 4 2193=over 4
1435 2194
1449 2208
1450 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2209 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1451 2210
1452 if ($self->{record_replies}) { 2211 if ($self->{record_replies}) {
1453 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2212 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2213
1454 } else { 2214 } else {
2215 my $pl = $self->contr;
2216
2217 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2218 my $dialog = $pl->{npc_dialog};
2219 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2220
2221 } else {
1455 $msg = $npc->name . " says: $msg" if $npc; 2222 $msg = $npc->name . " says: $msg" if $npc;
1456 $self->message ($msg, $flags); 2223 $self->message ($msg, $flags);
2224 }
1457 } 2225 }
2226}
2227
2228=item $object->send_msg ($channel, $msg, $color, [extra...])
2229
2230=cut
2231
2232sub cf::object::send_msg {
2233 my $pl = shift->contr
2234 or return;
2235 $pl->send_msg (@_);
1458} 2236}
1459 2237
1460=item $player_object->may ("access") 2238=item $player_object->may ("access")
1461 2239
1462Returns wether the given player is authorized to access resource "access" 2240Returns wether the given player is authorized to access resource "access"
1475 2253
1476=item $player_object->enter_link 2254=item $player_object->enter_link
1477 2255
1478Freezes the player and moves him/her to a special map (C<{link}>). 2256Freezes the player and moves him/her to a special map (C<{link}>).
1479 2257
1480The player should be reaosnably safe there for short amounts of time. You 2258The player should be reasonably safe there for short amounts of time. You
1481I<MUST> call C<leave_link> as soon as possible, though. 2259I<MUST> call C<leave_link> as soon as possible, though.
1482 2260
2261Will never block.
2262
1483=item $player_object->leave_link ($map, $x, $y) 2263=item $player_object->leave_link ($map, $x, $y)
1484 2264
1485Moves the player out of the specila link map onto the given map. If the 2265Moves the player out of the special C<{link}> map onto the specified
1486map is not valid (or omitted), the player will be moved back to the 2266map. If the map is not valid (or omitted), the player will be moved back
1487location he/she was before the call to C<enter_link>, or, if that fails, 2267to the location he/she was before the call to C<enter_link>, or, if that
1488to the emergency map position. 2268fails, to the emergency map position.
1489 2269
1490Might block. 2270Might block.
1491 2271
1492=cut 2272=cut
2273
2274sub link_map {
2275 unless ($LINK_MAP) {
2276 $LINK_MAP = cf::map::find "{link}"
2277 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2278 $LINK_MAP->load;
2279 }
2280
2281 $LINK_MAP
2282}
1493 2283
1494sub cf::object::player::enter_link { 2284sub cf::object::player::enter_link {
1495 my ($self) = @_; 2285 my ($self) = @_;
1496 2286
1497 $self->deactivate_recursive; 2287 $self->deactivate_recursive;
1498 2288
1499 return if $self->map == $LINK_MAP; 2289 return if UNIVERSAL::isa $self->map, "ext::map_link";
1500 2290
1501 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2291 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1502 if $self->map; 2292 if $self->map && $self->map->{path} ne "{link}";
1503 2293
1504 $self->enter_map ($LINK_MAP, 20, 20); 2294 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1505} 2295}
1506 2296
1507sub cf::object::player::leave_link { 2297sub cf::object::player::leave_link {
1508 my ($self, $map, $x, $y) = @_; 2298 my ($self, $map, $x, $y) = @_;
2299
2300 return unless $self->contr->active;
1509 2301
1510 my $link_pos = delete $self->{_link_pos}; 2302 my $link_pos = delete $self->{_link_pos};
1511 2303
1512 unless ($map) { 2304 unless ($map) {
1513 # restore original map position 2305 # restore original map position
1514 ($map, $x, $y) = @{ $link_pos || [] }; 2306 ($map, $x, $y) = @{ $link_pos || [] };
1515 $map = cf::map::find_map $map; 2307 $map = cf::map::find $map;
1516 2308
1517 unless ($map) { 2309 unless ($map) {
1518 ($map, $x, $y) = @$EMERGENCY_POSITION; 2310 ($map, $x, $y) = @$EMERGENCY_POSITION;
1519 $map = cf::map::find_map $map 2311 $map = cf::map::find $map
1520 or die "FATAL: cannot load emergency map\n"; 2312 or die "FATAL: cannot load emergency map\n";
1521 } 2313 }
1522 } 2314 }
1523 2315
1524 ($x, $y) = (-1, -1) 2316 ($x, $y) = (-1, -1)
1527 # use -1 or undef as default coordinates, not 0, 0 2319 # use -1 or undef as default coordinates, not 0, 0
1528 ($x, $y) = ($map->enter_x, $map->enter_y) 2320 ($x, $y) = ($map->enter_x, $map->enter_y)
1529 if $x <=0 && $y <= 0; 2321 if $x <=0 && $y <= 0;
1530 2322
1531 $map->load; 2323 $map->load;
2324 $map->load_neighbours;
1532 2325
2326 return unless $self->contr->active;
1533 $self->activate_recursive; 2327 $self->activate_recursive;
2328
2329 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1534 $self->enter_map ($map, $x, $y); 2330 $self->enter_map ($map, $x, $y);
1535} 2331}
1536 2332
1537cf::player->attach ( 2333=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1538 on_logout => sub {
1539 my ($pl) = @_;
1540 2334
1541 # abort map switching before logout 2335Moves the player to the given map-path and coordinates by first freezing
1542 if ($pl->ob->{_link_pos}) { 2336her, loading and preparing them map, calling the provided $check callback
1543 cf::sync_job { 2337that has to return the map if sucecssful, and then unfreezes the player on
1544 $pl->ob->leave_link 2338the new (success) or old (failed) map position. In either case, $done will
1545 }; 2339be called at the end of this process.
1546 }
1547 },
1548 on_login => sub {
1549 my ($pl) = @_;
1550 2340
1551 # try to abort aborted map switching on player login :)
1552 # should happen only on crashes
1553 if ($pl->ob->{_link_pos}) {
1554 $pl->ob->enter_link;
1555 cf::async {
1556 # we need this sleep as the login has a concurrent enter_exit running
1557 # and this sleep increases chances of the player not ending up in scorn
1558 Coro::Timer::sleep 1;
1559 $pl->ob->leave_link;
1560 };
1561 }
1562 },
1563);
1564
1565=item $player_object->goto_map ($path, $x, $y)
1566
1567=cut 2341=cut
1568 2342
2343our $GOTOGEN;
2344
1569sub cf::object::player::goto_map { 2345sub cf::object::player::goto {
1570 my ($self, $path, $x, $y) = @_; 2346 my ($self, $path, $x, $y, $check, $done) = @_;
2347
2348 # do generation counting so two concurrent goto's will be executed in-order
2349 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1571 2350
1572 $self->enter_link; 2351 $self->enter_link;
1573 2352
1574 (cf::async { 2353 (async {
1575 $path = new cf::path $path; 2354 my $map = eval {
1576
1577 my $map = cf::map::find_map $path->as_string; 2355 my $map = cf::map::find $path;
2356
2357 if ($map) {
1578 $map = $map->customise_for ($self) if $map; 2358 $map = $map->customise_for ($self);
1579 2359 $map = $check->($map) if $check && $map;
1580# warn "entering ", $map->path, " at ($x, $y)\n" 2360 } else {
1581# if $map;
1582
1583 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2361 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2362 }
1584 2363
2364 $map
2365 };
2366
2367 if ($@) {
2368 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2369 LOG llevError | logBacktrace, Carp::longmess $@;
2370 }
2371
2372 if ($gen == $self->{_goto_generation}) {
2373 delete $self->{_goto_generation};
1585 $self->leave_link ($map, $x, $y); 2374 $self->leave_link ($map, $x, $y);
2375 }
2376
2377 $done->() if $done;
1586 })->prio (1); 2378 })->prio (1);
1587} 2379}
1588 2380
1589=item $player_object->enter_exit ($exit_object) 2381=item $player_object->enter_exit ($exit_object)
1590 2382
1592 2384
1593sub parse_random_map_params { 2385sub parse_random_map_params {
1594 my ($spec) = @_; 2386 my ($spec) = @_;
1595 2387
1596 my $rmp = { # defaults 2388 my $rmp = { # defaults
1597 xsize => 10, 2389 xsize => (cf::rndm 15, 40),
1598 ysize => 10, 2390 ysize => (cf::rndm 15, 40),
2391 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2392 #layout => string,
1599 }; 2393 };
1600 2394
1601 for (split /\n/, $spec) { 2395 for (split /\n/, $spec) {
1602 my ($k, $v) = split /\s+/, $_, 2; 2396 my ($k, $v) = split /\s+/, $_, 2;
1603 2397
1607 $rmp 2401 $rmp
1608} 2402}
1609 2403
1610sub prepare_random_map { 2404sub prepare_random_map {
1611 my ($exit) = @_; 2405 my ($exit) = @_;
2406
2407 my $guard = cf::lock_acquire "exit_prepare:$exit";
1612 2408
1613 # all this does is basically replace the /! path by 2409 # all this does is basically replace the /! path by
1614 # a new random map path (?random/...) with a seed 2410 # a new random map path (?random/...) with a seed
1615 # that depends on the exit object 2411 # that depends on the exit object
1616 2412
1617 my $rmp = parse_random_map_params $exit->msg; 2413 my $rmp = parse_random_map_params $exit->msg;
1618 2414
1619 if ($exit->map) { 2415 if ($exit->map) {
1620 $rmp->{region} = $exit->map->region_name; 2416 $rmp->{region} = $exit->region->name;
1621 $rmp->{origin_map} = $exit->map->path; 2417 $rmp->{origin_map} = $exit->map->path;
1622 $rmp->{origin_x} = $exit->x; 2418 $rmp->{origin_x} = $exit->x;
1623 $rmp->{origin_y} = $exit->y; 2419 $rmp->{origin_y} = $exit->y;
1624 } 2420 }
1625 2421
1626 $rmp->{random_seed} ||= $exit->random_seed; 2422 $rmp->{random_seed} ||= $exit->random_seed;
1627 2423
1628 my $data = cf::to_json $rmp; 2424 my $data = cf::to_json $rmp;
1629 my $md5 = Digest::MD5::md5_hex $data; 2425 my $md5 = Digest::MD5::md5_hex $data;
2426 my $meta = "$RANDOMDIR/$md5.meta";
1630 2427
1631 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2428 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1632 aio_write $fh, 0, (length $data), $data, 0; 2429 aio_write $fh, 0, (length $data), $data, 0;
2430 undef $fh;
2431 aio_rename "$meta~", $meta;
1633 2432
1634 $exit->slaying ("?random/$md5"); 2433 $exit->slaying ("?random/$md5");
1635 $exit->msg (undef); 2434 $exit->msg (undef);
1636 } 2435 }
1637} 2436}
1639sub cf::object::player::enter_exit { 2438sub cf::object::player::enter_exit {
1640 my ($self, $exit) = @_; 2439 my ($self, $exit) = @_;
1641 2440
1642 return unless $self->type == cf::PLAYER; 2441 return unless $self->type == cf::PLAYER;
1643 2442
2443 if ($exit->slaying eq "/!") {
2444 #TODO: this should de-fi-ni-te-ly not be a sync-job
2445 # the problem is that $exit might not survive long enough
2446 # so it needs to be done right now, right here
2447 cf::sync_job { prepare_random_map $exit };
2448 }
2449
2450 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2451 my $hp = $exit->stats->hp;
2452 my $sp = $exit->stats->sp;
2453
1644 $self->enter_link; 2454 $self->enter_link;
1645 2455
2456 # if exit is damned, update players death & WoR home-position
2457 $self->contr->savebed ($slaying, $hp, $sp)
2458 if $exit->flag (FLAG_DAMNED);
2459
1646 (cf::async { 2460 (async {
2461 $self->deactivate_recursive; # just to be sure
1647 unless (eval { 2462 unless (eval {
1648 prepare_random_map $exit 2463 $self->goto ($slaying, $hp, $sp);
1649 if $exit->slaying eq "/!";
1650
1651 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1652 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1653 2464
1654 1; 2465 1;
1655 }) { 2466 }) {
1656 $self->message ("Something went wrong deep within the crossfire server. " 2467 $self->message ("Something went wrong deep within the crossfire server. "
1657 . "I'll try to bring you back to the map you were before. " 2468 . "I'll try to bring you back to the map you were before. "
1658 . "Please report this to the dungeon master", 2469 . "Please report this to the dungeon master!",
1659 cf::NDI_UNIQUE | cf::NDI_RED); 2470 cf::NDI_UNIQUE | cf::NDI_RED);
1660 2471
1661 warn "ERROR in enter_exit: $@"; 2472 warn "ERROR in enter_exit: $@";
1662 $self->leave_link; 2473 $self->leave_link;
1663 } 2474 }
1664 })->prio (1); 2475 })->prio (1);
1677 2488
1678sub cf::client::send_drawinfo { 2489sub cf::client::send_drawinfo {
1679 my ($self, $text, $flags) = @_; 2490 my ($self, $text, $flags) = @_;
1680 2491
1681 utf8::encode $text; 2492 utf8::encode $text;
1682 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2493 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1683} 2494}
1684 2495
2496=item $client->send_msg ($channel, $msg, $color, [extra...])
2497
2498Send a drawinfo or msg packet to the client, formatting the msg for the
2499client if neccessary. C<$type> should be a string identifying the type of
2500the message, with C<log> being the default. If C<$color> is negative, suppress
2501the message unless the client supports the msg packet.
2502
2503=cut
2504
2505sub cf::client::send_msg {
2506 my ($self, $channel, $msg, $color, @extra) = @_;
2507
2508 $msg = $self->pl->expand_cfpod ($msg);
2509
2510 $color &= cf::NDI_CLIENT_MASK; # just in case...
2511
2512 if (ref $channel) {
2513 # send meta info to client, if not yet sent
2514 unless (exists $self->{channel}{$channel->{id}}) {
2515 $self->{channel}{$channel->{id}} = $channel;
2516 $self->ext_msg (channel_info => $channel);
2517 }
2518
2519 $channel = $channel->{id};
2520 }
2521
2522 return unless @extra || length $msg;
2523
2524 if ($self->can_msg) {
2525 # default colour, mask it out
2526 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2527 if $color & cf::NDI_DEF;
2528
2529 $self->send_packet ("msg " . $self->{json_coder}->encode (
2530 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2531 } else {
2532 if ($color >= 0) {
2533 # replace some tags by gcfclient-compatible ones
2534 for ($msg) {
2535 1 while
2536 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2537 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2538 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2539 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2540 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2541 }
2542
2543 $color &= cf::NDI_COLOR_MASK;
2544
2545 utf8::encode $msg;
2546
2547 if (0 && $msg =~ /\[/) {
2548 # COMMAND/INFO
2549 $self->send_packet ("drawextinfo $color 10 8 $msg")
2550 } else {
2551 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2552 $self->send_packet ("drawinfo $color $msg")
2553 }
2554 }
2555 }
2556}
2557
2558=item $client->ext_msg ($type, @msg)
2559
2560Sends an ext event to the client.
2561
2562=cut
2563
2564sub cf::client::ext_msg($$@) {
2565 my ($self, $type, @msg) = @_;
2566
2567 if ($self->extcmd == 2) {
2568 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2569 } elsif ($self->extcmd == 1) { # TODO: remove
2570 push @msg, msgtype => "event_$type";
2571 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2572 }
2573}
2574
2575=item $client->ext_reply ($msgid, @msg)
2576
2577Sends an ext reply to the client.
2578
2579=cut
2580
2581sub cf::client::ext_reply($$@) {
2582 my ($self, $id, @msg) = @_;
2583
2584 if ($self->extcmd == 2) {
2585 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2586 } elsif ($self->extcmd == 1) {
2587 #TODO: version 1, remove
2588 unshift @msg, msgtype => "reply", msgid => $id;
2589 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2590 }
2591}
1685 2592
1686=item $success = $client->query ($flags, "text", \&cb) 2593=item $success = $client->query ($flags, "text", \&cb)
1687 2594
1688Queues a query to the client, calling the given callback with 2595Queues a query to the client, calling the given callback with
1689the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2596the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1690C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2597C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1691 2598
1692Queries can fail, so check the return code. Or don't, as queries will become 2599Queries can fail, so check the return code. Or don't, as queries will
1693reliable at some point in the future. 2600become reliable at some point in the future.
1694 2601
1695=cut 2602=cut
1696 2603
1697sub cf::client::query { 2604sub cf::client::query {
1698 my ($self, $flags, $text, $cb) = @_; 2605 my ($self, $flags, $text, $cb) = @_;
1706 utf8::encode $text; 2613 utf8::encode $text;
1707 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2614 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1708 2615
1709 $self->send_packet ($self->{query_queue}[0][0]) 2616 $self->send_packet ($self->{query_queue}[0][0])
1710 if @{ $self->{query_queue} } == 1; 2617 if @{ $self->{query_queue} } == 1;
2618
2619 1
1711} 2620}
1712 2621
1713cf::client->attach ( 2622cf::client->attach (
2623 on_connect => sub {
2624 my ($ns) = @_;
2625
2626 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2627 },
1714 on_reply => sub { 2628 on_reply => sub {
1715 my ($ns, $msg) = @_; 2629 my ($ns, $msg) = @_;
1716 2630
1717 # this weird shuffling is so that direct followup queries 2631 # this weird shuffling is so that direct followup queries
1718 # get handled first 2632 # get handled first
1719 my $queue = delete $ns->{query_queue} 2633 my $queue = delete $ns->{query_queue}
1720 or return; # be conservative, not sure how that can happen, but we saw a crash here 2634 or return; # be conservative, not sure how that can happen, but we saw a crash here
1721 2635
1722 (shift @$queue)->[1]->($msg); 2636 (shift @$queue)->[1]->($msg);
2637 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1723 2638
1724 push @{ $ns->{query_queue} }, @$queue; 2639 push @{ $ns->{query_queue} }, @$queue;
1725 2640
1726 if (@{ $ns->{query_queue} } == @$queue) { 2641 if (@{ $ns->{query_queue} } == @$queue) {
1727 if (@$queue) { 2642 if (@$queue) {
1729 } else { 2644 } else {
1730 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2645 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1731 } 2646 }
1732 } 2647 }
1733 }, 2648 },
2649 on_exticmd => sub {
2650 my ($ns, $buf) = @_;
2651
2652 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2653
2654 if (ref $msg) {
2655 my ($type, $reply, @payload) =
2656 "ARRAY" eq ref $msg
2657 ? @$msg
2658 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2659
2660 my @reply;
2661
2662 if (my $cb = $EXTICMD{$type}) {
2663 @reply = $cb->($ns, @payload);
2664 }
2665
2666 $ns->ext_reply ($reply, @reply)
2667 if $reply;
2668
2669 } else {
2670 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2671 }
2672
2673 cf::override;
2674 },
1734); 2675);
1735 2676
1736=item $client->coro (\&cb) 2677=item $client->async (\&cb)
1737 2678
1738Create a new coroutine, running the specified callback. The coroutine will 2679Create a new coroutine, running the specified callback. The coroutine will
1739be automatically cancelled when the client gets destroyed (e.g. on logout, 2680be automatically cancelled when the client gets destroyed (e.g. on logout,
1740or loss of connection). 2681or loss of connection).
1741 2682
1742=cut 2683=cut
1743 2684
1744sub cf::client::coro { 2685sub cf::client::async {
1745 my ($self, $cb) = @_; 2686 my ($self, $cb) = @_;
1746 2687
1747 my $coro = &cf::async ($cb); 2688 my $coro = &Coro::async ($cb);
1748 2689
1749 $coro->on_destroy (sub { 2690 $coro->on_destroy (sub {
1750 delete $self->{_coro}{$coro+0}; 2691 delete $self->{_coro}{$coro+0};
1751 }); 2692 });
1752 2693
1779our $safe = new Safe "safe"; 2720our $safe = new Safe "safe";
1780our $safe_hole = new Safe::Hole; 2721our $safe_hole = new Safe::Hole;
1781 2722
1782$SIG{FPE} = 'IGNORE'; 2723$SIG{FPE} = 'IGNORE';
1783 2724
1784$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2725$safe->permit_only (Opcode::opset qw(
2726 :base_core :base_mem :base_orig :base_math
2727 grepstart grepwhile mapstart mapwhile
2728 sort time
2729));
1785 2730
1786# here we export the classes and methods available to script code 2731# here we export the classes and methods available to script code
1787 2732
1788=pod 2733=pod
1789 2734
1790The following fucntions and emthods are available within a safe environment: 2735The following functions and methods are available within a safe environment:
1791 2736
1792 cf::object contr pay_amount pay_player map 2737 cf::object
2738 contr pay_amount pay_player map x y force_find force_add
2739 insert remove name archname title slaying race decrease_ob_nr
2740
1793 cf::object::player player 2741 cf::object::player
1794 cf::player peaceful 2742 player
1795 cf::map trigger 2743
2744 cf::player
2745 peaceful
2746
2747 cf::map
2748 trigger
1796 2749
1797=cut 2750=cut
1798 2751
1799for ( 2752for (
1800 ["cf::object" => qw(contr pay_amount pay_player map)], 2753 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2754 insert remove inv name archname title slaying race
2755 decrease_ob_nr)],
1801 ["cf::object::player" => qw(player)], 2756 ["cf::object::player" => qw(player)],
1802 ["cf::player" => qw(peaceful)], 2757 ["cf::player" => qw(peaceful)],
1803 ["cf::map" => qw(trigger)], 2758 ["cf::map" => qw(trigger)],
1804) { 2759) {
1805 no strict 'refs'; 2760 no strict 'refs';
1876=back 2831=back
1877 2832
1878=cut 2833=cut
1879 2834
1880############################################################################# 2835#############################################################################
2836# the server's init and main functions
1881 2837
1882=head2 EXTENSION DATABASE SUPPORT 2838sub load_facedata($) {
2839 my ($path) = @_;
1883 2840
1884Crossfire maintains a very simple database for extension use. It can 2841 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1885currently store anything that can be serialised using Storable, which
1886excludes objects.
1887 2842
1888The parameter C<$family> should best start with the name of the extension 2843 warn "loading facedata from $path\n";
1889using it, it should be unique.
1890 2844
1891=over 4 2845 my $facedata;
2846 0 < aio_load $path, $facedata
2847 or die "$path: $!";
1892 2848
1893=item $hashref = cf::db_get $family 2849 $facedata = Coro::Storable::thaw $facedata;
1894 2850
1895Return a hashref for use by the extension C<$family>, which can be 2851 $facedata->{version} == 2
1896modified. After modifications, you have to call C<cf::db_dirty> or 2852 or cf::cleanup "$path: version mismatch, cannot proceed.";
1897C<cf::db_sync>.
1898 2853
1899=item $value = cf::db_get $family => $key 2854 # patch in the exptable
1900 2855 $facedata->{resource}{"res/exp_table"} = {
1901Returns a single value from the database 2856 type => FT_RSRC,
1902 2857 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1903=item cf::db_put $family => $hashref
1904
1905Stores the given family hashref into the database. Updates are delayed, if
1906you want the data to be synced to disk immediately, use C<cf::db_sync>.
1907
1908=item cf::db_put $family => $key => $value
1909
1910Stores the given C<$value> in the family hash. Updates are delayed, if you
1911want the data to be synced to disk immediately, use C<cf::db_sync>.
1912
1913=item cf::db_dirty
1914
1915Marks the database as dirty, to be updated at a later time.
1916
1917=item cf::db_sync
1918
1919Immediately write the database to disk I<if it is dirty>.
1920
1921=cut
1922
1923our $DB;
1924
1925{
1926 my $path = cf::localdir . "/database.pst";
1927
1928 sub db_load() {
1929 $DB = stat $path ? Storable::retrieve $path : { };
1930 }
1931
1932 my $pid;
1933
1934 sub db_save() {
1935 waitpid $pid, 0 if $pid;
1936 if (0 == ($pid = fork)) {
1937 $DB->{_meta}{version} = 1;
1938 Storable::nstore $DB, "$path~";
1939 rename "$path~", $path;
1940 cf::_exit 0 if defined $pid;
1941 }
1942 }
1943
1944 my $dirty;
1945
1946 sub db_sync() {
1947 db_save if $dirty;
1948 undef $dirty;
1949 }
1950
1951 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1952 db_sync;
1953 }); 2858 };
2859 cf::cede_to_tick;
1954 2860
1955 sub db_dirty() {
1956 $dirty = 1;
1957 $idle->start;
1958 } 2861 {
2862 my $faces = $facedata->{faceinfo};
1959 2863
1960 sub db_get($;$) { 2864 while (my ($face, $info) = each %$faces) {
1961 @_ >= 2 2865 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1962 ? $DB->{$_[0]}{$_[1]} 2866 cf::face::set_visibility $idx, $info->{visibility};
1963 : ($DB->{$_[0]} ||= { }) 2867 cf::face::set_magicmap $idx, $info->{magicmap};
1964 } 2868 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2869 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1965 2870
1966 sub db_put($$;$) { 2871 cf::cede_to_tick;
1967 if (@_ >= 3) {
1968 $DB->{$_[0]}{$_[1]} = $_[2];
1969 } else {
1970 $DB->{$_[0]} = $_[1];
1971 }
1972 db_dirty;
1973 }
1974
1975 cf::global->attach (
1976 prio => 10000,
1977 on_cleanup => sub {
1978 db_sync;
1979 }, 2872 }
1980 );
1981}
1982 2873
1983############################################################################# 2874 while (my ($face, $info) = each %$faces) {
1984# the server's main() 2875 next unless $info->{smooth};
2876 my $idx = cf::face::find $face
2877 or next;
2878 if (my $smooth = cf::face::find $info->{smooth}) {
2879 cf::face::set_smooth $idx, $smooth;
2880 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2881 } else {
2882 warn "smooth face '$info->{smooth}' not found for face '$face'";
2883 }
1985 2884
1986sub cfg_load { 2885 cf::cede_to_tick;
2886 }
2887 }
2888
2889 {
2890 my $anims = $facedata->{animinfo};
2891
2892 while (my ($anim, $info) = each %$anims) {
2893 cf::anim::set $anim, $info->{frames}, $info->{facings};
2894 cf::cede_to_tick;
2895 }
2896
2897 cf::anim::invalidate_all; # d'oh
2898 }
2899
2900 {
2901 # TODO: for gcfclient pleasure, we should give resources
2902 # that gcfclient doesn't grok a >10000 face index.
2903 my $res = $facedata->{resource};
2904
2905 my $soundconf = delete $res->{"res/sound.conf"};
2906
2907 while (my ($name, $info) = each %$res) {
2908 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2909 my $data;
2910
2911 if ($info->{type} & 1) {
2912 # prepend meta info
2913
2914 my $meta = $enc->encode ({
2915 name => $name,
2916 %{ $info->{meta} || {} },
2917 });
2918
2919 $data = pack "(w/a*)*", $meta, $info->{data};
2920 } else {
2921 $data = $info->{data};
2922 }
2923
2924 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2925 cf::face::set_type $idx, $info->{type};
2926
2927 cf::cede_to_tick;
2928 }
2929
2930 if ($soundconf) {
2931 $soundconf = $enc->decode (delete $soundconf->{data});
2932
2933 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2934 my $sound = $soundconf->{compat}[$_]
2935 or next;
2936
2937 my $face = cf::face::find "sound/$sound->[1]";
2938 cf::sound::set $sound->[0] => $face;
2939 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2940 }
2941
2942 while (my ($k, $v) = each %{$soundconf->{event}}) {
2943 my $face = cf::face::find "sound/$v";
2944 cf::sound::set $k => $face;
2945 }
2946 }
2947 }
2948
2949 1
2950}
2951
2952register_exticmd fx_want => sub {
2953 my ($ns, $want) = @_;
2954
2955 while (my ($k, $v) = each %$want) {
2956 $ns->fx_want ($k, $v);
2957 }
2958};
2959
2960sub reload_regions {
2961 load_resource_file "$MAPDIR/regions"
2962 or die "unable to load regions file\n";
2963
2964 for (cf::region::list) {
2965 $_->{match} = qr/$_->{match}/
2966 if exists $_->{match};
2967 }
2968}
2969
2970sub reload_facedata {
2971 load_facedata "$DATADIR/facedata"
2972 or die "unable to load facedata\n";
2973}
2974
2975sub reload_archetypes {
2976 load_resource_file "$DATADIR/archetypes"
2977 or die "unable to load archetypes\n";
2978 #d# NEED to laod twice to resolve forward references
2979 # this really needs to be done in an extra post-pass
2980 # (which needs to be synchronous, so solve it differently)
2981 load_resource_file "$DATADIR/archetypes"
2982 or die "unable to load archetypes\n";
2983}
2984
2985sub reload_treasures {
2986 load_resource_file "$DATADIR/treasures"
2987 or die "unable to load treasurelists\n";
2988}
2989
2990sub reload_resources {
2991 warn "reloading resource files...\n";
2992
2993 reload_regions;
2994 reload_facedata;
2995 #reload_archetypes;#d#
2996 reload_archetypes;
2997 reload_treasures;
2998
2999 warn "finished reloading resource files\n";
3000}
3001
3002sub init {
3003 reload_resources;
3004}
3005
3006sub reload_config {
1987 open my $fh, "<:utf8", cf::confdir . "/config" 3007 open my $fh, "<:utf8", "$CONFDIR/config"
1988 or return; 3008 or return;
1989 3009
1990 local $/; 3010 local $/;
1991 *CFG = YAML::Syck::Load <$fh>; 3011 *CFG = YAML::Syck::Load <$fh>;
1992 3012
1993 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3013 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
1994 3014
3015 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3016 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3017
1995 if (exists $CFG{mlockall}) { 3018 if (exists $CFG{mlockall}) {
1996 eval { 3019 eval {
1997 $CFG{mlockall} ? &mlockall : &munlockall 3020 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
1998 and die "WARNING: m(un)lockall failed: $!\n"; 3021 and die "WARNING: m(un)lockall failed: $!\n";
1999 }; 3022 };
2000 warn $@ if $@; 3023 warn $@ if $@;
2001 } 3024 }
2002} 3025}
2003 3026
2004sub main { 3027sub main {
2005 # we must not ever block the main coroutine 3028 # we must not ever block the main coroutine
2006 local $Coro::idle = sub { 3029 local $Coro::idle = sub {
2007 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3030 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2008 (Coro::unblock_sub { 3031 (async {
2009 Event::one_event; 3032 Event::one_event;
2010 })->(); 3033 })->prio (Coro::PRIO_MAX);
2011 }; 3034 };
2012 3035
2013 cfg_load; 3036 reload_config;
2014 db_load; 3037 db_init;
2015 load_extensions; 3038 load_extensions;
3039
3040 $TICK_WATCHER->start;
2016 Event::loop; 3041 Event::loop;
2017} 3042}
2018 3043
2019############################################################################# 3044#############################################################################
2020# initialisation 3045# initialisation and cleanup
2021 3046
3047# install some emergency cleanup handlers
3048BEGIN {
3049 for my $signal (qw(INT HUP TERM)) {
3050 Event->signal (
3051 reentrant => 0,
3052 data => WF_AUTOCANCEL,
3053 signal => $signal,
3054 prio => 0,
3055 cb => sub {
3056 cf::cleanup "SIG$signal";
3057 },
3058 );
3059 }
3060}
3061
3062sub write_runtime {
3063 my $runtime = "$LOCALDIR/runtime";
3064
3065 # first touch the runtime file to show we are still running:
3066 # the fsync below can take a very very long time.
3067
3068 IO::AIO::aio_utime $runtime, undef, undef;
3069
3070 my $guard = cf::lock_acquire "write_runtime";
3071
3072 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3073 or return;
3074
3075 my $value = $cf::RUNTIME + 90 + 10;
3076 # 10 is the runtime save interval, for a monotonic clock
3077 # 60 allows for the watchdog to kill the server.
3078
3079 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3080 and return;
3081
3082 # always fsync - this file is important
3083 aio_fsync $fh
3084 and return;
3085
3086 # touch it again to show we are up-to-date
3087 aio_utime $fh, undef, undef;
3088
3089 close $fh
3090 or return;
3091
3092 aio_rename "$runtime~", $runtime
3093 and return;
3094
3095 warn "runtime file written.\n";
3096
3097 1
3098}
3099
3100sub emergency_save() {
3101 my $freeze_guard = cf::freeze_mainloop;
3102
3103 warn "enter emergency perl save\n";
3104
3105 cf::sync_job {
3106 # use a peculiar iteration method to avoid tripping on perl
3107 # refcount bugs in for. also avoids problems with players
3108 # and maps saved/destroyed asynchronously.
3109 warn "begin emergency player save\n";
3110 for my $login (keys %cf::PLAYER) {
3111 my $pl = $cf::PLAYER{$login} or next;
3112 $pl->valid or next;
3113 $pl->save;
3114 }
3115 warn "end emergency player save\n";
3116
3117 warn "begin emergency map save\n";
3118 for my $path (keys %cf::MAP) {
3119 my $map = $cf::MAP{$path} or next;
3120 $map->valid or next;
3121 $map->save;
3122 }
3123 warn "end emergency map save\n";
3124
3125 warn "begin emergency database checkpoint\n";
3126 BDB::db_env_txn_checkpoint $DB_ENV;
3127 warn "end emergency database checkpoint\n";
3128 };
3129
3130 warn "leave emergency perl save\n";
3131}
3132
3133sub post_cleanup {
3134 my ($make_core) = @_;
3135
3136 warn Carp::longmess "post_cleanup backtrace"
3137 if $make_core;
3138}
3139
2022sub reload() { 3140sub do_reload_perl() {
2023 # can/must only be called in main 3141 # can/must only be called in main
2024 if ($Coro::current != $Coro::main) { 3142 if ($Coro::current != $Coro::main) {
2025 warn "can only reload from main coroutine\n"; 3143 warn "can only reload from main coroutine";
2026 return; 3144 return;
2027 } 3145 }
2028 3146
2029 warn "reloading..."; 3147 warn "reloading...";
2030 3148
2031 local $FREEZE = 1; 3149 warn "entering sync_job";
3150
3151 cf::sync_job {
3152 cf::write_runtime; # external watchdog should not bark
2032 cf::emergency_save; 3153 cf::emergency_save;
3154 cf::write_runtime; # external watchdog should not bark
2033 3155
2034 eval { 3156 warn "syncing database to disk";
3157 BDB::db_env_txn_checkpoint $DB_ENV;
3158
2035 # if anything goes wrong in here, we should simply crash as we already saved 3159 # if anything goes wrong in here, we should simply crash as we already saved
2036 3160
2037 # cancel all watchers 3161 warn "cancelling all WF_AUTOCANCEL watchers";
2038 for (Event::all_watchers) { 3162 for (Event::all_watchers) {
2039 $_->cancel if $_->data & WF_AUTOCANCEL; 3163 $_->cancel if $_->data & WF_AUTOCANCEL;
2040 } 3164 }
2041 3165
3166 warn "flushing outstanding aio requests";
3167 for (;;) {
3168 BDB::flush;
3169 IO::AIO::flush;
3170 Coro::cede;
3171 last unless IO::AIO::nreqs || BDB::nreqs;
3172 warn "iterate...";
3173 }
3174
3175 ++$RELOAD;
3176
2042 # cancel all extension coros 3177 warn "cancelling all extension coros";
2043 $_->cancel for values %EXT_CORO; 3178 $_->cancel for values %EXT_CORO;
2044 %EXT_CORO = (); 3179 %EXT_CORO = ();
2045 3180
2046 # unload all extensions 3181 warn "removing commands";
2047 for (@exts) { 3182 %COMMAND = ();
3183
3184 warn "removing ext/exti commands";
3185 %EXTCMD = ();
3186 %EXTICMD = ();
3187
3188 warn "unloading/nuking all extensions";
3189 for my $pkg (@EXTS) {
2048 warn "unloading <$_>"; 3190 warn "... unloading $pkg";
2049 unload_extension $_; 3191
3192 if (my $cb = $pkg->can ("unload")) {
3193 eval {
3194 $cb->($pkg);
3195 1
3196 } or warn "$pkg unloaded, but with errors: $@";
2050 } 3197 }
2051 3198
3199 warn "... nuking $pkg";
3200 Symbol::delete_package $pkg;
3201 }
3202
2052 # unload all modules loaded from $LIBDIR 3203 warn "unloading all perl modules loaded from $LIBDIR";
2053 while (my ($k, $v) = each %INC) { 3204 while (my ($k, $v) = each %INC) {
2054 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3205 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2055 3206
2056 warn "removing <$k>"; 3207 warn "... unloading $k";
2057 delete $INC{$k}; 3208 delete $INC{$k};
2058 3209
2059 $k =~ s/\.pm$//; 3210 $k =~ s/\.pm$//;
2060 $k =~ s/\//::/g; 3211 $k =~ s/\//::/g;
2061 3212
2064 } 3215 }
2065 3216
2066 Symbol::delete_package $k; 3217 Symbol::delete_package $k;
2067 } 3218 }
2068 3219
2069 # sync database to disk
2070 cf::db_sync;
2071 IO::AIO::flush;
2072
2073 # get rid of safe::, as good as possible 3220 warn "getting rid of safe::, as good as possible";
2074 Symbol::delete_package "safe::$_" 3221 Symbol::delete_package "safe::$_"
2075 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3222 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2076 3223
2077 # remove register_script_function callbacks
2078 # TODO
2079
2080 # unload cf.pm "a bit" 3224 warn "unloading cf.pm \"a bit\"";
2081 delete $INC{"cf.pm"}; 3225 delete $INC{"cf.pm"};
3226 delete $INC{"cf/pod.pm"};
2082 3227
2083 # don't, removes xs symbols, too, 3228 # don't, removes xs symbols, too,
2084 # and global variables created in xs 3229 # and global variables created in xs
2085 #Symbol::delete_package __PACKAGE__; 3230 #Symbol::delete_package __PACKAGE__;
2086 3231
2087 # reload cf.pm 3232 warn "unload completed, starting to reload now";
3233
2088 warn "reloading cf.pm"; 3234 warn "reloading cf.pm";
2089 require cf; 3235 require cf;
2090 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3236 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2091 3237
2092 # load config and database again 3238 warn "loading config and database again";
2093 cf::cfg_load; 3239 cf::reload_config;
2094 cf::db_load;
2095 3240
2096 # load extensions
2097 warn "load extensions"; 3241 warn "loading extensions";
2098 cf::load_extensions; 3242 cf::load_extensions;
2099 3243
2100 # reattach attachments to objects 3244 warn "reattaching attachments to objects/players";
2101 warn "reattach"; 3245 _global_reattach; # objects, sockets
2102 _global_reattach; 3246 warn "reattaching attachments to maps";
2103 }; 3247 reattach $_ for values %MAP;
3248 warn "reattaching attachments to players";
3249 reattach $_ for values %PLAYER;
2104 3250
2105 if ($@) { 3251 warn "leaving sync_job";
3252
3253 1
3254 } or do {
2106 warn $@; 3255 warn $@;
2107 warn "error while reloading, exiting."; 3256 warn "error while reloading, exiting.";
2108 exit 1; 3257 exit 1;
2109 } 3258 };
2110 3259
2111 warn "reloaded successfully"; 3260 warn "reloaded";
2112}; 3261};
2113 3262
2114############################################################################# 3263our $RELOAD_WATCHER; # used only during reload
2115 3264
2116unless ($LINK_MAP) { 3265sub reload_perl() {
2117 $LINK_MAP = cf::map::new; 3266 # doing reload synchronously and two reloads happen back-to-back,
3267 # coro crashes during coro_state_free->destroy here.
2118 3268
2119 $LINK_MAP->width (41); 3269 $RELOAD_WATCHER ||= Event->timer (
2120 $LINK_MAP->height (41); 3270 reentrant => 0,
2121 $LINK_MAP->alloc;
2122 $LINK_MAP->path ("{link}");
2123 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2124 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2125
2126 # dirty hack because... archetypes are not yet loaded
2127 Event->timer (
2128 after => 2, 3271 after => 0,
3272 data => WF_AUTOCANCEL,
2129 cb => sub { 3273 cb => sub {
2130 $_[0]->w->cancel; 3274 do_reload_perl;
2131 3275 undef $RELOAD_WATCHER;
2132 # provide some exits "home"
2133 my $exit = cf::object::new "exit";
2134
2135 $exit->slaying ($EMERGENCY_POSITION->[0]);
2136 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2137 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2138
2139 $LINK_MAP->insert ($exit->clone, 19, 19);
2140 $LINK_MAP->insert ($exit->clone, 19, 20);
2141 $LINK_MAP->insert ($exit->clone, 19, 21);
2142 $LINK_MAP->insert ($exit->clone, 20, 19);
2143 $LINK_MAP->insert ($exit->clone, 20, 21);
2144 $LINK_MAP->insert ($exit->clone, 21, 19);
2145 $LINK_MAP->insert ($exit->clone, 21, 20);
2146 $LINK_MAP->insert ($exit->clone, 21, 21);
2147
2148 $exit->destroy;
2149 }); 3276 },
2150 3277 );
2151 $LINK_MAP->{deny_save} = 1;
2152 $LINK_MAP->{deny_reset} = 1;
2153
2154 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2155} 3278}
2156
2157register "<global>", __PACKAGE__;
2158 3279
2159register_command "reload" => sub { 3280register_command "reload" => sub {
2160 my ($who, $arg) = @_; 3281 my ($who, $arg) = @_;
2161 3282
2162 if ($who->flag (FLAG_WIZ)) { 3283 if ($who->flag (FLAG_WIZ)) {
2163 $who->message ("start of reload.");
2164 reload;
2165 $who->message ("end of reload."); 3284 $who->message ("reloading server.");
3285 async { reload_perl };
2166 } 3286 }
2167}; 3287};
2168 3288
2169unshift @INC, $LIBDIR; 3289unshift @INC, $LIBDIR;
2170 3290
3291my $bug_warning = 0;
3292
3293our @WAIT_FOR_TICK;
3294our @WAIT_FOR_TICK_BEGIN;
3295
3296sub wait_for_tick {
3297 return unless $TICK_WATCHER->is_active;
3298 return if $Coro::current == $Coro::main;
3299
3300 my $signal = new Coro::Signal;
3301 push @WAIT_FOR_TICK, $signal;
3302 $signal->wait;
3303}
3304
3305sub wait_for_tick_begin {
3306 return unless $TICK_WATCHER->is_active;
3307 return if $Coro::current == $Coro::main;
3308
3309 my $signal = new Coro::Signal;
3310 push @WAIT_FOR_TICK_BEGIN, $signal;
3311 $signal->wait;
3312}
3313
3314 my $min = 1e6;#d#
3315 my $avg = 10;
2171$TICK_WATCHER = Event->timer ( 3316$TICK_WATCHER = Event->timer (
2172 reentrant => 0, 3317 reentrant => 0,
3318 parked => 1,
2173 prio => 0, 3319 prio => 0,
2174 at => $NEXT_TICK || $TICK, 3320 at => $NEXT_TICK || $TICK,
2175 data => WF_AUTOCANCEL, 3321 data => WF_AUTOCANCEL,
2176 cb => sub { 3322 cb => sub {
2177 unless ($FREEZE) { 3323 if ($Coro::current != $Coro::main) {
3324 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3325 unless ++$bug_warning > 10;
3326 return;
3327 }
3328
3329 $NOW = $tick_start = Event::time;
3330
2178 cf::server_tick; # one server iteration 3331 cf::server_tick; # one server iteration
2179 $RUNTIME += $TICK; 3332
3333 0 && sync_job {#d#
3334 for(1..10) {
3335 my $t = Event::time;
3336 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3337 or die;
3338
3339 $map->width (50);
3340 $map->height (50);
3341 $map->alloc;
3342 $map->_load_objects ("/tmp/x.map", 1);
3343 my $t = Event::time - $t;
3344
3345 #next unless $t < 0.0013;#d#
3346 if ($t < $min) {
3347 $min = $t;
3348 }
3349 $avg = $avg * 0.99 + $t * 0.01;
3350 }
3351 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3352 exit 0;
3353 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2180 } 3354 };
2181 3355
3356 $RUNTIME += $TICK;
2182 $NEXT_TICK += $TICK; 3357 $NEXT_TICK += $TICK;
2183 3358
3359 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3360 $NEXT_RUNTIME_WRITE = $NOW + 10;
3361 Coro::async_pool {
3362 write_runtime
3363 or warn "ERROR: unable to write runtime file: $!";
3364 };
3365 }
3366
3367# my $AFTER = Event::time;
3368# warn $AFTER - $NOW;#d#
3369
3370 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3371 $sig->send;
3372 }
3373 while (my $sig = shift @WAIT_FOR_TICK) {
3374 $sig->send;
3375 }
3376
3377 $NOW = Event::time;
3378
2184 # if we are delayed by four ticks or more, skip them all 3379 # if we are delayed by four ticks or more, skip them all
2185 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3380 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2186 3381
2187 $TICK_WATCHER->at ($NEXT_TICK); 3382 $TICK_WATCHER->at ($NEXT_TICK);
2188 $TICK_WATCHER->start; 3383 $TICK_WATCHER->start;
3384
3385 $LOAD = ($NOW - $tick_start) / $TICK;
3386 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3387
3388 _post_tick;
3389
3390
2189 }, 3391 },
2190); 3392);
2191 3393
3394{
2192IO::AIO::max_poll_time $TICK * 0.2; 3395 BDB::max_poll_time $TICK * 0.1;
2193 3396 $BDB_POLL_WATCHER = Event->io (
2194Event->io ( 3397 reentrant => 0,
2195 fd => IO::AIO::poll_fileno, 3398 fd => BDB::poll_fileno,
2196 poll => 'r', 3399 poll => 'r',
2197 prio => 5, 3400 prio => 0,
2198 data => WF_AUTOCANCEL,
2199 cb => \&IO::AIO::poll_cb,
2200);
2201
2202Event->timer (
2203 data => WF_AUTOCANCEL, 3401 data => WF_AUTOCANCEL,
2204 after => 0, 3402 cb => \&BDB::poll_cb,
2205 interval => 10, 3403 );
2206 cb => sub { 3404 BDB::min_parallel 8;
2207 (Coro::unblock_sub { 3405
2208 write_runtime 3406 BDB::set_sync_prepare {
2209 or warn "ERROR: unable to write runtime file: $!"; 3407 my $status;
3408 my $current = $Coro::current;
3409 (
3410 sub {
3411 $status = $!;
3412 $current->ready; undef $current;
3413 },
3414 sub {
3415 Coro::schedule while defined $current;
3416 $! = $status;
3417 },
3418 )
3419 };
3420
3421 unless ($DB_ENV) {
3422 $DB_ENV = BDB::db_env_create;
3423
3424 cf::sync_job {
3425 eval {
3426 BDB::db_env_open
3427 $DB_ENV,
3428 $BDBDIR,
3429 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3430 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3431 0666;
3432
3433 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3434
3435 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3436 $DB_ENV->set_lk_detect;
3437 };
3438
3439 cf::cleanup "db_env_open(db): $@" if $@;
2210 })->(); 3440 };
2211 }, 3441 }
2212); 3442}
3443
3444{
3445 IO::AIO::min_parallel 8;
3446
3447 undef $Coro::AIO::WATCHER;
3448 IO::AIO::max_poll_time $TICK * 0.1;
3449 $AIO_POLL_WATCHER = Event->io (
3450 reentrant => 0,
3451 data => WF_AUTOCANCEL,
3452 fd => IO::AIO::poll_fileno,
3453 poll => 'r',
3454 prio => 6,
3455 cb => \&IO::AIO::poll_cb,
3456 );
3457}
3458
3459my $_log_backtrace;
3460
3461sub _log_backtrace {
3462 my ($msg, @addr) = @_;
3463
3464 $msg =~ s/\n//;
3465
3466 # limit the # of concurrent backtraces
3467 if ($_log_backtrace < 2) {
3468 ++$_log_backtrace;
3469 async {
3470 my @bt = fork_call {
3471 @addr = map { sprintf "%x", $_ } @addr;
3472 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3473 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3474 or die "addr2line: $!";
3475
3476 my @funcs;
3477 my @res = <$fh>;
3478 chomp for @res;
3479 while (@res) {
3480 my ($func, $line) = splice @res, 0, 2, ();
3481 push @funcs, "[$func] $line";
3482 }
3483
3484 @funcs
3485 };
3486
3487 LOG llevInfo, "[ABT] $msg\n";
3488 LOG llevInfo, "[ABT] $_\n" for @bt;
3489 --$_log_backtrace;
3490 };
3491 } else {
3492 LOG llevInfo, "[ABT] $msg\n";
3493 LOG llevInfo, "[ABT] [suppressed]\n";
3494 }
3495}
3496
3497# load additional modules
3498use cf::pod;
2213 3499
2214END { cf::emergency_save } 3500END { cf::emergency_save }
2215 3501
22161 35021
2217 3503

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines