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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines