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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines