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.120 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.331 by root, Mon Aug 13 13:10:01 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
383=item cf::async { BLOCK }
384
385Currently the same as Coro::async_pool, meaning you cannot use
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.
388
389=cut
390
391BEGIN { *async = \&Coro::async_pool }
392
250=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
251 394
252The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
253always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
254reentrant. 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.
255 399
256If 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
257the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
258server 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
259fast or be very important. 403fast or be very important.
262 406
263sub sync_job(&) { 407sub sync_job(&) {
264 my ($job) = @_; 408 my ($job) = @_;
265 409
266 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
267 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
268 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
269 415
270 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
271 # (but this is cancel-safe) 417 # (but this is cancel-safe)
272 local $FREEZE = 1; 418 my $freeze_guard = freeze_mainloop;
273 419
274 my $busy = 1; 420 my $busy = 1;
275 my @res; 421 my @res;
276 422
277 (Coro::async { 423 (async {
278 @res = eval { $job->() }; 424 @res = eval { $job->() };
279 warn $@ if $@; 425 warn $@ if $@;
280 undef $busy; 426 undef $busy;
281 })->prio (Coro::PRIO_MAX); 427 })->prio (Coro::PRIO_MAX);
282 428
283 while ($busy) { 429 while ($busy) {
284 Coro::cede_notself; 430 Coro::cede or Event::one_event;
285 Event::one_event unless Coro::nready;
286 } 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
287 439
288 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
289 } else { 441 } else {
290 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
291 443
292 $job->() 444 $job->()
293 } 445 }
294} 446}
295 447
296=item $coro = cf::coro { BLOCK } 448=item $coro = cf::async_ext { BLOCK }
297 449
298Creates and returns a new coro. This coro is automcatially being canceled 450Like async, but this coro is automatically being canceled when the
299when the extension calling this is being unloaded. 451extension calling this is being unloaded.
300 452
301=cut 453=cut
302 454
303sub coro(&) { 455sub async_ext(&) {
304 my $cb = shift; 456 my $cb = shift;
305 457
306 my $coro; $coro = async { 458 my $coro = &Coro::async ($cb);
307 eval {
308 $cb->();
309 };
310 warn $@ if $@;
311 };
312 459
313 $coro->on_destroy (sub { 460 $coro->on_destroy (sub {
314 delete $EXT_CORO{$coro+0}; 461 delete $EXT_CORO{$coro+0};
315 }); 462 });
316 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
317 464
318 $coro 465 $coro
319} 466}
320 467
321sub write_runtime { 468=item fork_call { }, $args
322 my $runtime = cf::localdir . "/runtime";
323 469
324 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 470Executes the given code block with the given arguments in a seperate
325 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.
326 474
327 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 475=cut
328 (aio_write $fh, 0, (length $value), $value, 0) <= 0
329 and return;
330 476
331 aio_fsync $fh 477sub _store_scalar {
332 and return; 478 open my $fh, ">", \my $buf
333 479 or die "fork_call: cannot open fh-to-buf in child : $!";
480 Storable::store_fd $_[0], $fh;
334 close $fh 481 close $fh;
335 or return;
336 482
337 aio_rename "$runtime~", $runtime 483 $buf
338 and return; 484}
339 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;
340 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 });
341} 655}
342 656
343=back 657=back
344 658
345=cut 659=cut
346
347#############################################################################
348
349package cf::path;
350
351sub new {
352 my ($class, $path, $base) = @_;
353
354 $path = $path->as_string if ref $path;
355
356 my $self = bless { }, $class;
357
358 # {... are special paths that are not touched
359 # ?xxx/... are special absolute paths
360 # ?random/... random maps
361 # /! non-realised random map exit
362 # /... normal maps
363 # ~/... per-player maps without a specific player (DO NOT USE)
364 # ~user/... per-player map of a specific user
365
366 if ($path =~ /^{/) {
367 # fine as it is
368 } elsif ($path =~ s{^\?random/}{}) {
369 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
370 $self->{random} = cf::from_json $data;
371 } else {
372 if ($path =~ s{^~([^/]+)?}{}) {
373 $self->{user_rel} = 1;
374
375 if (defined $1) {
376 $self->{user} = $1;
377 } elsif ($base =~ m{^~([^/]+)/}) {
378 $self->{user} = $1;
379 } else {
380 warn "cannot resolve user-relative path without user <$path,$base>\n";
381 }
382 } elsif ($path =~ /^\//) {
383 # already absolute
384 } else {
385 $base =~ s{[^/]+/?$}{};
386 return $class->new ("$base/$path");
387 }
388
389 for ($path) {
390 redo if s{/\.?/}{/};
391 redo if s{/[^/]+/\.\./}{/};
392 }
393 }
394
395 $self->{path} = $path;
396
397 $self
398}
399
400# the name / primary key / in-game path
401sub as_string {
402 my ($self) = @_;
403
404 $self->{user_rel} ? "~$self->{user}$self->{path}"
405 : $self->{random} ? "?random/$self->{path}"
406 : $self->{path}
407}
408
409# the displayed name, this is a one way mapping
410sub visible_name {
411 my ($self) = @_;
412
413# if (my $rmp = $self->{random}) {
414# # todo: be more intelligent about this
415# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
416# } else {
417 $self->as_string
418# }
419}
420
421# escape the /'s in the path
422sub _escaped_path {
423 # ∕ is U+2215
424 (my $path = $_[0]{path}) =~ s/\//∕/g;
425 $path
426}
427
428# the original (read-only) location
429sub load_path {
430 my ($self) = @_;
431
432 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
433}
434
435# the temporary/swap location
436sub save_path {
437 my ($self) = @_;
438
439 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
440 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
441 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
442}
443
444# the unique path, might be eq to save_path
445sub uniq_path {
446 my ($self) = @_;
447
448 $self->{user_rel} || $self->{random}
449 ? undef
450 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
451}
452
453# return random map parameters, or undef
454sub random_map_params {
455 my ($self) = @_;
456
457 $self->{random}
458}
459
460# this is somewhat ugly, but style maps do need special treatment
461sub is_style_map {
462 $_[0]{path} =~ m{^/styles/}
463}
464
465package cf;
466 660
467############################################################################# 661#############################################################################
468 662
469=head2 ATTACHABLE OBJECTS 663=head2 ATTACHABLE OBJECTS
470 664
472attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
473to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
474 668
475In 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>
476C<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
477crossfire+). 671Crossfire TRT).
478 672
479=over 4 673=over 4
480 674
481=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
482 676
596our @CB_TYPE = (); # registry for type (cf-object class) based events 790our @CB_TYPE = (); # registry for type (cf-object class) based events
597our @CB_MAP = (); 791our @CB_MAP = ();
598 792
599my %attachment; 793my %attachment;
600 794
795sub cf::attachable::thawer_merge {
796 # simply override everything except _meta
797 local $_[0]{_meta};
798 %{$_[0]} = %{$_[1]};
799}
800
601sub _attach_cb($$$$) { 801sub _attach_cb($$$$) {
602 my ($registry, $event, $prio, $cb) = @_; 802 my ($registry, $event, $prio, $cb) = @_;
603 803
604 use sort 'stable'; 804 use sort 'stable';
605 805
639 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
640 840
641 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
642 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
643 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
644 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
645 845
646 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
647 my $pkg = shift @arg; 847 my $pkg = shift @arg;
648 848
649 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
678 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
679 } 879 }
680 880
681 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
682 } else { 882 } else {
683 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
684 } 884 }
685 885
686 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
687} 887}
688 888
690 if (ref $_[0]) { 890 if (ref $_[0]) {
691 _object_attach @_; 891 _object_attach @_;
692 } else { 892 } else {
693 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
694 } 894 }
895 _recalc_want;
695}; 896};
696 897
697# all those should be optimised 898# all those should be optimised
698sub cf::attachable::detach { 899sub cf::attachable::detach {
699 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
702 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
703 reattach ($obj); 904 reattach ($obj);
704 } else { 905 } else {
705 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
706 } 907 }
908 _recalc_want;
707}; 909};
708 910
709sub cf::attachable::attached { 911sub cf::attachable::attached {
710 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
711 913
726 "; 928 ";
727 die if $@; 929 die if $@;
728} 930}
729 931
730our $override; 932our $override;
731our @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?
732 934
733sub override { 935sub override {
734 $override = 1; 936 $override = 1;
735 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
736} 938}
737 939
738sub do_invoke { 940sub do_invoke {
739 my $event = shift; 941 my $event = shift;
740 my $callbacks = shift; 942 my $callbacks = shift;
741 943
742 @invoke_results = (); 944 @INVOKE_RESULTS = ();
743 945
744 local $override; 946 local $override;
745 947
746 for (@$callbacks) { 948 for (@$callbacks) {
747 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
764 966
765Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
766 968
767This 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
768removed 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
769results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
770 972
771=back 973=back
772 974
773=cut 975=cut
774 976
775############################################################################# 977#############################################################################
776# 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}
777 990
778sub reattach { 991sub reattach {
779 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
780 my ($obj) = @_; 993 my ($obj) = @_;
994
995 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
781 996
782 my $registry = $obj->registry; 997 my $registry = $obj->registry;
783 998
784 @$registry = (); 999 @$registry = ();
785 1000
832 $filename, length $$rdata, scalar @$objs; 1047 $filename, length $$rdata, scalar @$objs;
833 1048
834 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1049 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
835 chmod SAVE_MODE, $fh; 1050 chmod SAVE_MODE, $fh;
836 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1051 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
837 aio_fsync $fh; 1052 aio_fsync $fh if $cf::USE_FSYNC;
838 close $fh; 1053 close $fh;
839 1054
840 if (@$objs) { 1055 if (@$objs) {
841 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) {
842 chmod SAVE_MODE, $fh; 1057 chmod SAVE_MODE, $fh;
843 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1058 my $data = Storable::nfreeze { version => 1, objs => $objs };
844 aio_write $fh, 0, (length $data), $data, 0; 1059 aio_write $fh, 0, (length $data), $data, 0;
845 aio_fsync $fh; 1060 aio_fsync $fh if $cf::USE_FSYNC;
846 close $fh; 1061 close $fh;
847 aio_rename "$filename.pst~", "$filename.pst"; 1062 aio_rename "$filename.pst~", "$filename.pst";
848 } 1063 }
849 } else { 1064 } else {
850 aio_unlink "$filename.pst"; 1065 aio_unlink "$filename.pst";
882 or return; 1097 or return;
883 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
884 } 1099 }
885 1100
886 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
887 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
888 return ($data, $av); 1103 return ($data, $av);
889} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
890 1111
891############################################################################# 1112#############################################################################
892# command handling &c 1113# command handling &c
893 1114
894=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
907 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
908} 1129}
909 1130
910=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
911 1132
912Register 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.
913 1138
914If 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
915called. 1140called.
916 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
917=cut 1153=cut
918 1154
919sub register_extcmd { 1155sub register_extcmd {
920 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
921 1157
922 my $caller = caller;
923 #warn "registering extcmd '$name' to '$caller'";
924
925 $EXTCMD{$name} = [$cb, $caller]; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
926} 1165}
927 1166
928cf::player->attach ( 1167cf::player->attach (
929 on_command => sub { 1168 on_command => sub {
930 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
939 cf::override; 1178 cf::override;
940 }, 1179 },
941 on_extcmd => sub { 1180 on_extcmd => sub {
942 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
943 1182
944 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
945 1184
946 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
947 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
948 if (my %reply = $cb->[0]->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
949 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
950 } 1195 if $reply;
951 } 1196 }
952 } else { 1197 } else {
953 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
954 } 1199 }
955 1200
956 cf::override; 1201 cf::override;
957 }, 1202 },
958); 1203);
959 1204
960sub register {
961 my ($base, $pkg) = @_;
962
963 #TODO
964}
965
966sub 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($) {
967 my ($path) = @_; 1583 my ($path) = @_;
968 1584
969 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1585 my ($match, $specificity);
970 my $base = $1;
971 my $pkg = $1;
972 $pkg =~ s/[^[:word:]]/_/g;
973 $pkg = "ext::$pkg";
974 1586
975 warn "loading '$path' into '$pkg'\n"; 1587 for my $region (list) {
976 1588 if ($region->{match} && $path =~ $region->{match}) {
977 open my $fh, "<:utf8", $path 1589 ($match, $specificity) = ($region, $region->specificity)
978 or die "$path: $!"; 1590 if $region->specificity > $specificity;
979 1591 }
980 my $source =
981 "package $pkg; use strict; use utf8;\n"
982 . "#line 1 \"$path\"\n{\n"
983 . (do { local $/; <$fh> })
984 . "\n};\n1";
985
986 eval $source
987 or die $@ ? "$path: $@\n"
988 : "extension disabled.\n";
989
990 push @exts, $pkg;
991 $ext_pkg{$base} = $pkg;
992
993# no strict 'refs';
994# @{"$pkg\::ISA"} = ext::;
995
996 register $base, $pkg;
997}
998
999sub unload_extension {
1000 my ($pkg) = @_;
1001
1002 warn "removing extension $pkg\n";
1003
1004 # remove hooks
1005 #TODO
1006# for my $idx (0 .. $#PLUGIN_EVENT) {
1007# delete $hook[$idx]{$pkg};
1008# } 1592 }
1009 1593
1010 # remove commands 1594 $match
1011 for my $name (keys %COMMAND) {
1012 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1013
1014 if (@cb) {
1015 $COMMAND{$name} = \@cb;
1016 } else {
1017 delete $COMMAND{$name};
1018 }
1019 }
1020
1021 # remove extcmds
1022 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1023 delete $EXTCMD{$name};
1024 }
1025
1026 if (my $cb = $pkg->can ("unload")) {
1027 eval {
1028 $cb->($pkg);
1029 1
1030 } or warn "$pkg unloaded, but with errors: $@";
1031 }
1032
1033 Symbol::delete_package $pkg;
1034}
1035
1036sub load_extensions {
1037 for my $ext (<$LIBDIR/*.ext>) {
1038 next unless -r $ext;
1039 eval {
1040 load_extension $ext;
1041 1
1042 } or warn "$ext not loaded: $@";
1043 }
1044}
1045
1046#############################################################################
1047# load/save/clean perl data associated with a map
1048
1049*cf::mapsupport::on_clean = sub {
1050 my ($map) = @_;
1051
1052 my $path = $map->tmpname;
1053 defined $path or return;
1054
1055 unlink "$path.pst";
1056};
1057
1058cf::map->attach (prio => -10000, package => cf::mapsupport::);
1059
1060#############################################################################
1061# load/save perl data associated with player->ob objects
1062
1063sub all_objects(@) {
1064 @_, map all_objects ($_->inv), @_
1065}
1066
1067# TODO: compatibility cruft, remove when no longer needed
1068cf::player->attach (
1069 on_load => sub {
1070 my ($pl, $path) = @_;
1071
1072 for my $o (all_objects $pl->ob) {
1073 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1074 $o->set_ob_key_value ("_perl_data");
1075
1076 %$o = %{ Storable::thaw pack "H*", $value };
1077 }
1078 }
1079 },
1080);
1081
1082#############################################################################
1083
1084=head2 CORE EXTENSIONS
1085
1086Functions and methods that extend core crossfire objects.
1087
1088=head3 cf::player
1089
1090=over 4
1091
1092=item cf::player::exists $login
1093
1094Returns true when the given account exists.
1095
1096=cut
1097
1098sub cf::player::exists($) {
1099 cf::player::find $_[0]
1100 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1101}
1102
1103=item $player->ext_reply ($msgid, $msgtype, %msg)
1104
1105Sends an ext reply to the player.
1106
1107=cut
1108
1109sub cf::player::ext_reply($$$%) {
1110 my ($self, $id, %msg) = @_;
1111
1112 $msg{msgid} = $id;
1113
1114 $self->send ("ext " . to_json \%msg);
1115} 1595}
1116 1596
1117=back 1597=back
1118
1119 1598
1120=head3 cf::map 1599=head3 cf::map
1121 1600
1122=over 4 1601=over 4
1123 1602
1126package cf::map; 1605package cf::map;
1127 1606
1128use Fcntl; 1607use Fcntl;
1129use Coro::AIO; 1608use Coro::AIO;
1130 1609
1610use overload
1611 '""' => \&as_string,
1612 fallback => 1;
1613
1131our $MAX_RESET = 7200; 1614our $MAX_RESET = 3600;
1132our $DEFAULT_RESET = 3600; 1615our $DEFAULT_RESET = 3000;
1133 1616
1134sub generate_random_map { 1617sub generate_random_map {
1135 my ($path, $rmp) = @_; 1618 my ($self, $rmp) = @_;
1136
1137 # mit "rum" bekleckern, nicht 1619 # mit "rum" bekleckern, nicht
1138 cf::map::_create_random_map 1620 $self->_create_random_map (
1139 $path,
1140 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1621 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1141 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1622 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1142 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1623 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1143 $rmp->{exit_on_final_map}, 1624 $rmp->{exit_on_final_map},
1144 $rmp->{xsize}, $rmp->{ysize}, 1625 $rmp->{xsize}, $rmp->{ysize},
1145 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1626 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1146 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1627 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1147 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1628 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1148 $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},
1149 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1630 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1150 (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"
1151} 1760}
1152 1761
1153# and all this just because we cannot iterate over 1762# and all this just because we cannot iterate over
1154# all maps in C++... 1763# all maps in C++...
1155sub change_all_map_light { 1764sub change_all_map_light {
1156 my ($change) = @_; 1765 my ($change) = @_;
1157 1766
1158 $_->change_map_light ($change) for values %cf::MAP; 1767 $_->change_map_light ($change)
1768 for grep $_->outdoor, values %cf::MAP;
1159} 1769}
1160 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
1161sub try_load_header($) { 1787sub load_header_from($) {
1162 my ($path) = @_; 1788 my ($self, $path) = @_;
1163 1789
1164 utf8::encode $path; 1790 utf8::encode $path;
1165 aio_open $path, O_RDONLY, 0 1791 #aio_open $path, O_RDONLY, 0
1792 # or return;
1793
1794 $self->_load_header ($path)
1166 or return; 1795 or return;
1167 1796
1168 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
1169 or return; 1840 or return;
1841 $self->prepare_orig;
1842 }
1170 1843
1171 $map->load_header ($path) 1844 $self->{deny_reset} = 1
1172 or return; 1845 if $self->no_reset;
1173 1846
1174 $map->{load_path} = $path; 1847 $self->default_region (cf::region::find_by_path $self->{path})
1848 unless $self->default_region;
1175 1849
1176 $map 1850 1
1177} 1851}
1178 1852
1853sub find;
1179sub find_map { 1854sub find {
1180 my ($path, $origin) = @_; 1855 my ($path, $origin) = @_;
1181 1856
1182 #warn "find_map<$path,$origin>\n";#d#
1183
1184 $path = new cf::path $path, $origin && $origin->path; 1857 $path = normalise $path, $origin && $origin->path;
1185 my $key = $path->as_string;
1186 1858
1187 cf::lock_wait "map_find:$key"; 1859 cf::lock_wait "map_find:$path";
1188 1860
1189 $cf::MAP{$key} || do { 1861 $cf::MAP{$path} || do {
1190 my $guard = cf::lock_acquire "map_find:$key"; 1862 my $guard = cf::lock_acquire "map_find:$path";
1191 1863 my $map = new_from_path cf::map $path
1192 # do it the slow way
1193 my $map = try_load_header $path->save_path;
1194
1195 if ($map) {
1196 # safety
1197 $map->{instantiate_time} = $cf::RUNTIME
1198 if $map->{instantiate_time} > $cf::RUNTIME;
1199 } else {
1200 if (my $rmp = $path->random_map_params) {
1201 $map = generate_random_map $key, $rmp;
1202 } else {
1203 $map = try_load_header $path->load_path;
1204 }
1205
1206 $map or return; 1864 or return;
1207 1865
1208 $map->{load_original} = 1;
1209 $map->{instantiate_time} = $cf::RUNTIME;
1210 $map->instantiate;
1211
1212 # per-player maps become, after loading, normal maps
1213 $map->per_player (0) if $path->{user_rel};
1214 }
1215 #Coro::Timer::sleep 1;#d#
1216
1217 $map->path ($key);
1218 $map->{path} = $path;
1219 $map->{last_save} = $cf::RUNTIME; 1866 $map->{last_save} = $cf::RUNTIME;
1220 $map->last_access ($cf::RUNTIME);
1221 1867
1222 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;
1223 $map->reset; 1874 $map->reset;
1224 $map = find_map $path; 1875 undef $guard;
1876 return find $path;
1225 } 1877 }
1226 1878
1227 $cf::MAP{$key} = $map 1879 $cf::MAP{$path} = $map
1228 } 1880 }
1229} 1881}
1882
1883sub pre_load { }
1884sub post_load { }
1230 1885
1231sub load { 1886sub load {
1232 my ($self) = @_; 1887 my ($self) = @_;
1233 1888
1889 local $self->{deny_reset} = 1; # loading can take a long time
1890
1234 my $path = $self->{path}; 1891 my $path = $self->{path};
1892
1893 {
1235 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1894 my $guard = cf::lock_acquire "map_load:$path";
1236 1895
1237 return if $self->in_memory != cf::MAP_SWAPPED; 1896 return if $self->in_memory != cf::MAP_SWAPPED;
1238 1897
1239 $self->in_memory (cf::MAP_LOADING); 1898 $self->in_memory (cf::MAP_LOADING);
1240 1899
1241 $self->alloc; 1900 $self->alloc;
1901
1902 $self->pre_load;
1903 Coro::cede;
1904
1242 $self->load_objects ($self->{load_path}, 1) 1905 $self->_load_objects ($self->{load_path}, 1)
1243 or return; 1906 or return;
1244 1907
1245 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1908 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1246 if delete $self->{load_original}; 1909 if delete $self->{load_original};
1247 1910
1248 if (my $uniq = $path->uniq_path) { 1911 if (my $uniq = $self->uniq_path) {
1249 utf8::encode $uniq; 1912 utf8::encode $uniq;
1250 if (aio_open $uniq, O_RDONLY, 0) { 1913 if (aio_open $uniq, O_RDONLY, 0) {
1251 $self->clear_unique_items; 1914 $self->clear_unique_items;
1252 $self->load_objects ($uniq, 0); 1915 $self->_load_objects ($uniq, 0);
1253 } 1916 }
1254 } 1917 }
1255 1918
1919 Coro::cede;
1256 # now do the right thing for maps 1920 # now do the right thing for maps
1257 $self->link_multipart_objects; 1921 $self->link_multipart_objects;
1258
1259 if ($self->{path}->is_style_map) {
1260 $self->{deny_save} = 1;
1261 $self->{deny_reset} = 1;
1262 } else {
1263 $self->fix_auto_apply;
1264 $self->decay_objects;
1265 $self->update_buttons;
1266 $self->set_darkness_map;
1267 $self->difficulty ($self->estimate_difficulty) 1922 $self->difficulty ($self->estimate_difficulty)
1268 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;
1269 $self->activate; 1933 $self->activate;
1270 } 1934 }
1271 1935
1936 $self->{last_save} = $cf::RUNTIME;
1937 $self->last_access ($cf::RUNTIME);
1938
1272 $self->in_memory (cf::MAP_IN_MEMORY); 1939 $self->in_memory (cf::MAP_IN_MEMORY);
1273} 1940 }
1274 1941
1275sub 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 {
1276 my ($path, $origin) = @_; 1982 my ($path, $origin) = @_;
1277 1983
1278 #warn "load_map_sync<$path, $origin>\n";#d# 1984 cf::sync_job { find $path, $origin }
1985}
1279 1986
1280 cf::sync_job { 1987sub do_load_sync {
1281 my $map = cf::map::find_map $path, $origin 1988 my ($map) = @_;
1282 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) {
1283 $map->load; 2010 $map->load;
1284 $map 2011 }
2012
2013 delete $MAP_PREFETCH{$path};
2014 }
2015 }
2016 undef $MAP_PREFETCHER;
1285 } 2017 };
2018 $MAP_PREFETCHER->prio (6);
2019
2020 ()
1286} 2021}
1287 2022
1288sub save { 2023sub save {
1289 my ($self) = @_; 2024 my ($self) = @_;
1290 2025
2026 my $lock = cf::lock_acquire "map_data:" . $self->path;
2027
1291 $self->{last_save} = $cf::RUNTIME; 2028 $self->{last_save} = $cf::RUNTIME;
1292 2029
1293 return unless $self->dirty; 2030 return unless $self->dirty;
1294 2031
1295 my $save = $self->{path}->save_path; utf8::encode $save; 2032 my $save = $self->save_path; utf8::encode $save;
1296 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2033 my $uniq = $self->uniq_path; utf8::encode $uniq;
1297 2034
1298 $self->{load_path} = $save; 2035 $self->{load_path} = $save;
1299 2036
1300 return if $self->{deny_save}; 2037 return if $self->{deny_save};
1301 2038
2039 local $self->{last_access} = $self->last_access;#d#
2040
2041 cf::async {
2042 $_->contr->save for $self->players;
2043 };
2044
1302 if ($uniq) { 2045 if ($uniq) {
1303 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2046 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1304 $self->save_objects ($uniq, cf::IO_UNIQUES); 2047 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1305 } else { 2048 } else {
1306 $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);
1307 } 2050 }
1308} 2051}
1309 2052
1310sub swap_out { 2053sub swap_out {
1311 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;
1312 2060
1313 return if $self->players; 2061 return if $self->players;
1314 return if $self->in_memory != cf::MAP_IN_MEMORY; 2062 return if $self->in_memory != cf::MAP_IN_MEMORY;
1315 return if $self->{deny_save}; 2063 return if $self->{deny_save};
1316 2064
1317 $self->save;
1318 $self->clear; 2065 $self->clear;
1319 $self->in_memory (cf::MAP_SWAPPED); 2066 $self->in_memory (cf::MAP_SWAPPED);
1320} 2067}
1321 2068
1322sub reset_at { 2069sub reset_at {
1323 my ($self) = @_; 2070 my ($self) = @_;
1324 2071
1325 # TODO: safety, remove and allow resettable per-player maps 2072 # TODO: safety, remove and allow resettable per-player maps
1326 return 1e99 if $self->{path}{user_rel};
1327 return 1e99 if $self->{deny_reset}; 2073 return 1e99 if $self->{deny_reset};
1328 2074
1329 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2075 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1330 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;
1331 2077
1336 my ($self) = @_; 2082 my ($self) = @_;
1337 2083
1338 $self->reset_at <= $cf::RUNTIME 2084 $self->reset_at <= $cf::RUNTIME
1339} 2085}
1340 2086
1341sub unlink_save {
1342 my ($self) = @_;
1343
1344 utf8::encode (my $save = $self->{path}->save_path);
1345 aioreq_pri 3; IO::AIO::aio_unlink $save;
1346 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1347}
1348
1349sub rename {
1350 my ($self, $new_path) = @_;
1351
1352 $self->unlink_save;
1353
1354 delete $cf::MAP{$self->path};
1355 $self->{path} = new cf::path $new_path;
1356 $self->path ($self->{path}->as_string);
1357 $cf::MAP{$self->path} = $self;
1358
1359 $self->save;
1360}
1361
1362sub reset { 2087sub reset {
1363 my ($self) = @_; 2088 my ($self) = @_;
1364 2089
2090 my $lock = cf::lock_acquire "map_data:$self->{path}";
2091
1365 return if $self->players; 2092 return if $self->players;
1366 return if $self->{path}{user_rel};#d#
1367 2093
1368 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 }
1369 2105
1370 delete $cf::MAP{$self->path}; 2106 delete $cf::MAP{$self->path};
2107
2108 $self->clear;
1371 2109
1372 $_->clear_links_to ($self) for values %cf::MAP; 2110 $_->clear_links_to ($self) for values %cf::MAP;
1373 2111
1374 $self->unlink_save; 2112 $self->unlink_save;
1375 $self->destroy; 2113 $self->destroy;
1378my $nuke_counter = "aaaa"; 2116my $nuke_counter = "aaaa";
1379 2117
1380sub nuke { 2118sub nuke {
1381 my ($self) = @_; 2119 my ($self) = @_;
1382 2120
2121 delete $cf::MAP{$self->path};
2122
2123 $self->unlink_save;
2124
2125 bless $self, "cf::map";
2126 delete $self->{deny_reset};
1383 $self->{deny_save} = 1; 2127 $self->{deny_save} = 1;
1384 $self->reset_timeout (1); 2128 $self->reset_timeout (1);
1385 $self->rename ("{nuke}/" . ($nuke_counter++)); 2129 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2130
2131 $cf::MAP{$self->path} = $self;
2132
1386 $self->reset; # polite request, might not happen 2133 $self->reset; # polite request, might not happen
1387} 2134}
1388 2135
1389sub customise_for { 2136=item $maps = cf::map::tmp_maps
1390 my ($map, $ob) = @_;
1391 2137
1392 if ($map->per_player) { 2138Returns an arrayref with all map paths of currently instantiated and saved
1393 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 2139maps. May block.
2140
2141=cut
2142
2143sub tmp_maps() {
1394 } 2144 [
1395 2145 map {
1396 $map 2146 utf8::decode $_;
2147 /\.map$/
2148 ? normalise $_
2149 : ()
2150 } @{ aio_readdir $TMPDIR or [] }
2151 ]
1397} 2152}
1398 2153
1399sub emergency_save { 2154=item $maps = cf::map::random_maps
1400 local $cf::FREEZE = 1;
1401 2155
1402 warn "enter emergency map save\n"; 2156Returns an arrayref with all map paths of currently instantiated and saved
2157random maps. May block.
1403 2158
1404 cf::sync_job { 2159=cut
1405 warn "begin emergency map save\n";
1406 $_->save for values %cf::MAP;
1407 };
1408 2160
1409 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 ]
1410} 2188}
1411 2189
1412package cf; 2190package cf;
1413 2191
1414=back 2192=back
1415 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
1416 2220
1417=head3 cf::object::player 2221=head3 cf::object::player
1418 2222
1419=over 4 2223=over 4
1420 2224
1434 2238
1435 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2239 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1436 2240
1437 if ($self->{record_replies}) { 2241 if ($self->{record_replies}) {
1438 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2242 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2243
1439 } 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 {
1440 $msg = $npc->name . " says: $msg" if $npc; 2252 $msg = $npc->name . " says: $msg" if $npc;
1441 $self->message ($msg, $flags); 2253 $self->message ($msg, $flags);
2254 }
1442 } 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 (@_);
1443} 2266}
1444 2267
1445=item $player_object->may ("access") 2268=item $player_object->may ("access")
1446 2269
1447Returns wether the given player is authorized to access resource "access" 2270Returns wether the given player is authorized to access resource "access"
1460 2283
1461=item $player_object->enter_link 2284=item $player_object->enter_link
1462 2285
1463Freezes 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}>).
1464 2287
1465The 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
1466I<MUST> call C<leave_link> as soon as possible, though. 2289I<MUST> call C<leave_link> as soon as possible, though.
1467 2290
2291Will never block.
2292
1468=item $player_object->leave_link ($map, $x, $y) 2293=item $player_object->leave_link ($map, $x, $y)
1469 2294
1470Moves 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
1471map 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
1472location 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
1473to the emergency map position. 2298fails, to the emergency map position.
1474 2299
1475Might block. 2300Might block.
1476 2301
1477=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}
1478 2313
1479sub cf::object::player::enter_link { 2314sub cf::object::player::enter_link {
1480 my ($self) = @_; 2315 my ($self) = @_;
1481 2316
1482 $self->deactivate_recursive; 2317 $self->deactivate_recursive;
1483 2318
1484 return if $self->map == $LINK_MAP; 2319 return if UNIVERSAL::isa $self->map, "ext::map_link";
1485 2320
1486 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2321 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1487 if $self->map; 2322 if $self->map && $self->map->{path} ne "{link}";
1488 2323
1489 $self->enter_map ($LINK_MAP, 20, 20); 2324 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1490} 2325}
1491 2326
1492sub cf::object::player::leave_link { 2327sub cf::object::player::leave_link {
1493 my ($self, $map, $x, $y) = @_; 2328 my ($self, $map, $x, $y) = @_;
2329
2330 return unless $self->contr->active;
1494 2331
1495 my $link_pos = delete $self->{_link_pos}; 2332 my $link_pos = delete $self->{_link_pos};
1496 2333
1497 unless ($map) { 2334 unless ($map) {
1498 # restore original map position 2335 # restore original map position
1499 ($map, $x, $y) = @{ $link_pos || [] }; 2336 ($map, $x, $y) = @{ $link_pos || [] };
1500 $map = cf::map::find_map $map; 2337 $map = cf::map::find $map;
1501 2338
1502 unless ($map) { 2339 unless ($map) {
1503 ($map, $x, $y) = @$EMERGENCY_POSITION; 2340 ($map, $x, $y) = @$EMERGENCY_POSITION;
1504 $map = cf::map::find_map $map 2341 $map = cf::map::find $map
1505 or die "FATAL: cannot load emergency map\n"; 2342 or die "FATAL: cannot load emergency map\n";
1506 } 2343 }
1507 } 2344 }
1508 2345
1509 ($x, $y) = (-1, -1) 2346 ($x, $y) = (-1, -1)
1512 # use -1 or undef as default coordinates, not 0, 0 2349 # use -1 or undef as default coordinates, not 0, 0
1513 ($x, $y) = ($map->enter_x, $map->enter_y) 2350 ($x, $y) = ($map->enter_x, $map->enter_y)
1514 if $x <=0 && $y <= 0; 2351 if $x <=0 && $y <= 0;
1515 2352
1516 $map->load; 2353 $map->load;
2354 $map->load_diag;
1517 2355
2356 return unless $self->contr->active;
1518 $self->activate_recursive; 2357 $self->activate_recursive;
2358
2359 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1519 $self->enter_map ($map, $x, $y); 2360 $self->enter_map ($map, $x, $y);
1520} 2361}
1521 2362
1522cf::player->attach ( 2363=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1523 on_logout => sub {
1524 my ($pl) = @_;
1525 2364
1526 # abort map switching before logout 2365Moves the player to the given map-path and coordinates by first freezing
1527 if ($pl->ob->{_link_pos}) { 2366her, loading and preparing them map, calling the provided $check callback
1528 cf::sync_job { 2367that has to return the map if sucecssful, and then unfreezes the player on
1529 $pl->ob->leave_link 2368the new (success) or old (failed) map position. In either case, $done will
1530 }; 2369be called at the end of this process.
1531 }
1532 },
1533 on_login => sub {
1534 my ($pl) = @_;
1535 2370
1536 # try to abort aborted map switching on player login :)
1537 # should happen only on crashes
1538 if ($pl->ob->{_link_pos}) {
1539 $pl->ob->enter_link;
1540 Coro::async {
1541 # we need this sleep as the login has a concurrent enter_exit running
1542 # and this sleep increases chances of the player not ending up in scorn
1543 Coro::Timer::sleep 1;
1544 $pl->ob->leave_link;
1545 };
1546 }
1547 },
1548);
1549
1550=item $player_object->goto_map ($path, $x, $y)
1551
1552=cut 2371=cut
1553 2372
2373our $GOTOGEN;
2374
1554sub cf::object::player::goto_map { 2375sub cf::object::player::goto {
1555 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;
1556 2380
1557 $self->enter_link; 2381 $self->enter_link;
1558 2382
1559 (Coro::async { 2383 (async {
1560 $path = new cf::path $path; 2384 my $map = eval {
1561
1562 my $map = cf::map::find_map $path->as_string; 2385 my $map = cf::map::find $path;
2386
2387 if ($map) {
1563 $map = $map->customise_for ($self) if $map; 2388 $map = $map->customise_for ($self);
1564 2389 $map = $check->($map) if $check && $map;
1565# warn "entering ", $map->path, " at ($x, $y)\n" 2390 } else {
1566# if $map;
1567
1568 $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 }
1569 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};
1570 $self->leave_link ($map, $x, $y); 2404 $self->leave_link ($map, $x, $y);
2405 }
2406
2407 $done->() if $done;
1571 })->prio (1); 2408 })->prio (1);
1572} 2409}
1573 2410
1574=item $player_object->enter_exit ($exit_object) 2411=item $player_object->enter_exit ($exit_object)
1575 2412
1577 2414
1578sub parse_random_map_params { 2415sub parse_random_map_params {
1579 my ($spec) = @_; 2416 my ($spec) = @_;
1580 2417
1581 my $rmp = { # defaults 2418 my $rmp = { # defaults
1582 xsize => 10, 2419 xsize => (cf::rndm 15, 40),
1583 ysize => 10, 2420 ysize => (cf::rndm 15, 40),
2421 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2422 #layout => string,
1584 }; 2423 };
1585 2424
1586 for (split /\n/, $spec) { 2425 for (split /\n/, $spec) {
1587 my ($k, $v) = split /\s+/, $_, 2; 2426 my ($k, $v) = split /\s+/, $_, 2;
1588 2427
1592 $rmp 2431 $rmp
1593} 2432}
1594 2433
1595sub prepare_random_map { 2434sub prepare_random_map {
1596 my ($exit) = @_; 2435 my ($exit) = @_;
2436
2437 my $guard = cf::lock_acquire "exit_prepare:$exit";
1597 2438
1598 # all this does is basically replace the /! path by 2439 # all this does is basically replace the /! path by
1599 # a new random map path (?random/...) with a seed 2440 # a new random map path (?random/...) with a seed
1600 # that depends on the exit object 2441 # that depends on the exit object
1601 2442
1602 my $rmp = parse_random_map_params $exit->msg; 2443 my $rmp = parse_random_map_params $exit->msg;
1603 2444
1604 if ($exit->map) { 2445 if ($exit->map) {
1605 $rmp->{region} = $exit->map->region_name; 2446 $rmp->{region} = $exit->region->name;
1606 $rmp->{origin_map} = $exit->map->path; 2447 $rmp->{origin_map} = $exit->map->path;
1607 $rmp->{origin_x} = $exit->x; 2448 $rmp->{origin_x} = $exit->x;
1608 $rmp->{origin_y} = $exit->y; 2449 $rmp->{origin_y} = $exit->y;
1609 } 2450 }
1610 2451
1611 $rmp->{random_seed} ||= $exit->random_seed; 2452 $rmp->{random_seed} ||= $exit->random_seed;
1612 2453
1613 my $data = cf::to_json $rmp; 2454 my $data = cf::to_json $rmp;
1614 my $md5 = Digest::MD5::md5_hex $data; 2455 my $md5 = Digest::MD5::md5_hex $data;
2456 my $meta = "$RANDOMDIR/$md5.meta";
1615 2457
1616 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) {
1617 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;
1618 2462
1619 $exit->slaying ("?random/$md5"); 2463 $exit->slaying ("?random/$md5");
1620 $exit->msg (undef); 2464 $exit->msg (undef);
1621 } 2465 }
1622} 2466}
1624sub cf::object::player::enter_exit { 2468sub cf::object::player::enter_exit {
1625 my ($self, $exit) = @_; 2469 my ($self, $exit) = @_;
1626 2470
1627 return unless $self->type == cf::PLAYER; 2471 return unless $self->type == cf::PLAYER;
1628 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
1629 $self->enter_link; 2484 $self->enter_link;
1630 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
1631 (Coro::async { 2490 (async {
2491 $self->deactivate_recursive; # just to be sure
1632 unless (eval { 2492 unless (eval {
1633 2493 $self->goto ($slaying, $hp, $sp);
1634 prepare_random_map $exit
1635 if $exit->slaying eq "/!";
1636
1637 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1638 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1639 2494
1640 1; 2495 1;
1641 }) { 2496 }) {
1642 $self->message ("Something went wrong deep within the crossfire server. " 2497 $self->message ("Something went wrong deep within the crossfire server. "
1643 . "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. "
1644 . "Please report this to the dungeon master", 2499 . "Please report this to the dungeon master!",
1645 cf::NDI_UNIQUE | cf::NDI_RED); 2500 cf::NDI_UNIQUE | cf::NDI_RED);
1646 2501
1647 warn "ERROR in enter_exit: $@"; 2502 warn "ERROR in enter_exit: $@";
1648 $self->leave_link; 2503 $self->leave_link;
1649 } 2504 }
1650 })->prio (1); 2505 })->prio (1);
1663 2518
1664sub cf::client::send_drawinfo { 2519sub cf::client::send_drawinfo {
1665 my ($self, $text, $flags) = @_; 2520 my ($self, $text, $flags) = @_;
1666 2521
1667 utf8::encode $text; 2522 utf8::encode $text;
1668 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2523 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1669} 2524}
1670 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 # COMMAND/INFO
2579 $self->send_packet ("drawextinfo $color 10 8 $msg")
2580 } else {
2581 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2582 $self->send_packet ("drawinfo $color $msg")
2583 }
2584 }
2585 }
2586}
2587
2588=item $client->ext_msg ($type, @msg)
2589
2590Sends an ext event to the client.
2591
2592=cut
2593
2594sub cf::client::ext_msg($$@) {
2595 my ($self, $type, @msg) = @_;
2596
2597 my $extcmd = $self->extcmd;
2598
2599 if ($extcmd == 2) {
2600 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2601 } elsif ($extcmd == 1) { # TODO: remove
2602 push @msg, msgtype => "event_$type";
2603 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2604 }
2605}
1671 2606
1672=item $success = $client->query ($flags, "text", \&cb) 2607=item $success = $client->query ($flags, "text", \&cb)
1673 2608
1674Queues a query to the client, calling the given callback with 2609Queues a query to the client, calling the given callback with
1675the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2610the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1676C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2611C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1677 2612
1678Queries can fail, so check the return code. Or don't, as queries will become 2613Queries can fail, so check the return code. Or don't, as queries will
1679reliable at some point in the future. 2614become reliable at some point in the future.
1680 2615
1681=cut 2616=cut
1682 2617
1683sub cf::client::query { 2618sub cf::client::query {
1684 my ($self, $flags, $text, $cb) = @_; 2619 my ($self, $flags, $text, $cb) = @_;
1692 utf8::encode $text; 2627 utf8::encode $text;
1693 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2628 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1694 2629
1695 $self->send_packet ($self->{query_queue}[0][0]) 2630 $self->send_packet ($self->{query_queue}[0][0])
1696 if @{ $self->{query_queue} } == 1; 2631 if @{ $self->{query_queue} } == 1;
2632
2633 1
1697} 2634}
1698 2635
1699cf::client->attach ( 2636cf::client->attach (
2637 on_connect => sub {
2638 my ($ns) = @_;
2639
2640 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2641 },
1700 on_reply => sub { 2642 on_reply => sub {
1701 my ($ns, $msg) = @_; 2643 my ($ns, $msg) = @_;
1702 2644
1703 # this weird shuffling is so that direct followup queries 2645 # this weird shuffling is so that direct followup queries
1704 # get handled first 2646 # get handled first
1705 my $queue = delete $ns->{query_queue}; 2647 my $queue = delete $ns->{query_queue}
2648 or return; # be conservative, not sure how that can happen, but we saw a crash here
1706 2649
1707 (shift @$queue)->[1]->($msg); 2650 (shift @$queue)->[1]->($msg);
2651 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1708 2652
1709 push @{ $ns->{query_queue} }, @$queue; 2653 push @{ $ns->{query_queue} }, @$queue;
1710 2654
1711 if (@{ $ns->{query_queue} } == @$queue) { 2655 if (@{ $ns->{query_queue} } == @$queue) {
1712 if (@$queue) { 2656 if (@$queue) {
1714 } else { 2658 } else {
1715 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2659 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1716 } 2660 }
1717 } 2661 }
1718 }, 2662 },
2663 on_exticmd => sub {
2664 my ($ns, $buf) = @_;
2665
2666 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2667
2668 if (ref $msg) {
2669 my ($type, $reply, @payload) =
2670 "ARRAY" eq ref $msg
2671 ? @$msg
2672 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2673
2674 if (my $cb = $EXTICMD{$type}) {
2675 my @reply = $cb->($ns, @payload);
2676
2677 $ns->ext_reply ($reply, @reply)
2678 if $reply;
2679 }
2680 } else {
2681 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2682 }
2683
2684 cf::override;
2685 },
1719); 2686);
1720 2687
1721=item $client->coro (\&cb) 2688=item $client->async (\&cb)
1722 2689
1723Create a new coroutine, running the specified callback. The coroutine will 2690Create a new coroutine, running the specified callback. The coroutine will
1724be automatically cancelled when the client gets destroyed (e.g. on logout, 2691be automatically cancelled when the client gets destroyed (e.g. on logout,
1725or loss of connection). 2692or loss of connection).
1726 2693
1727=cut 2694=cut
1728 2695
1729sub cf::client::coro { 2696sub cf::client::async {
1730 my ($self, $cb) = @_; 2697 my ($self, $cb) = @_;
1731 2698
1732 my $coro; $coro = async { 2699 my $coro = &Coro::async ($cb);
1733 eval {
1734 $cb->();
1735 };
1736 warn $@ if $@;
1737 };
1738 2700
1739 $coro->on_destroy (sub { 2701 $coro->on_destroy (sub {
1740 delete $self->{_coro}{$coro+0}; 2702 delete $self->{_coro}{$coro+0};
1741 }); 2703 });
1742 2704
1769our $safe = new Safe "safe"; 2731our $safe = new Safe "safe";
1770our $safe_hole = new Safe::Hole; 2732our $safe_hole = new Safe::Hole;
1771 2733
1772$SIG{FPE} = 'IGNORE'; 2734$SIG{FPE} = 'IGNORE';
1773 2735
1774$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2736$safe->permit_only (Opcode::opset qw(
2737 :base_core :base_mem :base_orig :base_math
2738 grepstart grepwhile mapstart mapwhile
2739 sort time
2740));
1775 2741
1776# here we export the classes and methods available to script code 2742# here we export the classes and methods available to script code
1777 2743
1778=pod 2744=pod
1779 2745
1780The following fucntions and emthods are available within a safe environment: 2746The following functions and methods are available within a safe environment:
1781 2747
1782 cf::object contr pay_amount pay_player map 2748 cf::object
2749 contr pay_amount pay_player map x y force_find force_add
2750 insert remove name archname title slaying race
2751
1783 cf::object::player player 2752 cf::object::player
1784 cf::player peaceful 2753 player
1785 cf::map trigger 2754
2755 cf::player
2756 peaceful
2757
2758 cf::map
2759 trigger
1786 2760
1787=cut 2761=cut
1788 2762
1789for ( 2763for (
1790 ["cf::object" => qw(contr pay_amount pay_player map)], 2764 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2765 insert remove inv name archname title slaying race)],
1791 ["cf::object::player" => qw(player)], 2766 ["cf::object::player" => qw(player)],
1792 ["cf::player" => qw(peaceful)], 2767 ["cf::player" => qw(peaceful)],
1793 ["cf::map" => qw(trigger)], 2768 ["cf::map" => qw(trigger)],
1794) { 2769) {
1795 no strict 'refs'; 2770 no strict 'refs';
1866=back 2841=back
1867 2842
1868=cut 2843=cut
1869 2844
1870############################################################################# 2845#############################################################################
2846# the server's init and main functions
1871 2847
1872=head2 EXTENSION DATABASE SUPPORT 2848sub load_facedata($) {
2849 my ($path) = @_;
1873 2850
1874Crossfire maintains a very simple database for extension use. It can 2851 warn "loading facedata from $path\n";
1875currently store anything that can be serialised using Storable, which
1876excludes objects.
1877 2852
1878The parameter C<$family> should best start with the name of the extension 2853 my $facedata;
1879using it, it should be unique. 2854 0 < aio_load $path, $facedata
2855 or die "$path: $!";
1880 2856
1881=over 4 2857 $facedata = Coro::Storable::thaw $facedata;
1882 2858
1883=item $hashref = cf::db_get $family 2859 $facedata->{version} == 2
2860 or cf::cleanup "$path: version mismatch, cannot proceed.";
1884 2861
1885Return a hashref for use by the extension C<$family>, which can be
1886modified. After modifications, you have to call C<cf::db_dirty> or
1887C<cf::db_sync>.
1888
1889=item $value = cf::db_get $family => $key
1890
1891Returns a single value from the database
1892
1893=item cf::db_put $family => $hashref
1894
1895Stores the given family hashref into the database. Updates are delayed, if
1896you want the data to be synced to disk immediately, use C<cf::db_sync>.
1897
1898=item cf::db_put $family => $key => $value
1899
1900Stores the given C<$value> in the family hash. Updates are delayed, if you
1901want the data to be synced to disk immediately, use C<cf::db_sync>.
1902
1903=item cf::db_dirty
1904
1905Marks the database as dirty, to be updated at a later time.
1906
1907=item cf::db_sync
1908
1909Immediately write the database to disk I<if it is dirty>.
1910
1911=cut
1912
1913our $DB;
1914
1915{
1916 my $path = cf::localdir . "/database.pst";
1917
1918 sub db_load() {
1919 warn "loading database $path\n";#d# remove later
1920 $DB = stat $path ? Storable::retrieve $path : { };
1921 } 2862 {
2863 my $faces = $facedata->{faceinfo};
1922 2864
1923 my $pid; 2865 while (my ($face, $info) = each %$faces) {
2866 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2867 cf::face::set_visibility $idx, $info->{visibility};
2868 cf::face::set_magicmap $idx, $info->{magicmap};
2869 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2870 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1924 2871
1925 sub db_save() { 2872 cf::cede_to_tick;
1926 warn "saving database $path\n";#d# remove later
1927 waitpid $pid, 0 if $pid;
1928 if (0 == ($pid = fork)) {
1929 $DB->{_meta}{version} = 1;
1930 Storable::nstore $DB, "$path~";
1931 rename "$path~", $path;
1932 cf::_exit 0 if defined $pid;
1933 }
1934 }
1935
1936 my $dirty;
1937
1938 sub db_sync() {
1939 db_save if $dirty;
1940 undef $dirty;
1941 }
1942
1943 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1944 db_sync;
1945 });
1946
1947 sub db_dirty() {
1948 $dirty = 1;
1949 $idle->start;
1950 }
1951
1952 sub db_get($;$) {
1953 @_ >= 2
1954 ? $DB->{$_[0]}{$_[1]}
1955 : ($DB->{$_[0]} ||= { })
1956 }
1957
1958 sub db_put($$;$) {
1959 if (@_ >= 3) {
1960 $DB->{$_[0]}{$_[1]} = $_[2];
1961 } else {
1962 $DB->{$_[0]} = $_[1];
1963 }
1964 db_dirty;
1965 }
1966
1967 cf::global->attach (
1968 prio => 10000,
1969 on_cleanup => sub {
1970 db_sync;
1971 }, 2873 }
1972 );
1973}
1974 2874
1975############################################################################# 2875 while (my ($face, $info) = each %$faces) {
1976# the server's main() 2876 next unless $info->{smooth};
2877 my $idx = cf::face::find $face
2878 or next;
2879 if (my $smooth = cf::face::find $info->{smooth}) {
2880 cf::face::set_smooth $idx, $smooth;
2881 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2882 } else {
2883 warn "smooth face '$info->{smooth}' not found for face '$face'";
2884 }
2885
2886 cf::cede_to_tick;
2887 }
2888 }
2889
2890 {
2891 my $anims = $facedata->{animinfo};
2892
2893 while (my ($anim, $info) = each %$anims) {
2894 cf::anim::set $anim, $info->{frames}, $info->{facings};
2895 cf::cede_to_tick;
2896 }
2897
2898 cf::anim::invalidate_all; # d'oh
2899 }
2900
2901 {
2902 # TODO: for gcfclient pleasure, we should give resources
2903 # that gcfclient doesn't grok a >10000 face index.
2904 my $res = $facedata->{resource};
2905 my $enc = JSON::XS->new->utf8->canonical;
2906
2907 my $soundconf = delete $res->{"res/sound.conf"};
2908
2909 while (my ($name, $info) = each %$res) {
2910 my $meta = $enc->encode ({
2911 name => $name,
2912 %{ $info->{meta} || {} },
2913 });
2914
2915 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2916
2917 if ($info->{type} & 1) {
2918 # prepend meta info
2919
2920 my $data = pack "(w/a*)*", $meta, $info->{data};
2921 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2922
2923 cf::face::set_data $idx, 0, $data, $chk;
2924 } else {
2925 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2926 }
2927
2928 cf::face::set_type $idx, $info->{type};
2929
2930 cf::cede_to_tick;
2931 }
2932
2933 if ($soundconf) {
2934 $soundconf = $enc->decode (delete $soundconf->{data});
2935
2936 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2937 my $sound = $soundconf->{compat}[$_]
2938 or next;
2939
2940 my $face = cf::face::find "sound/$sound->[1]";
2941 cf::sound::set $sound->[0] => $face;
2942 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2943 }
2944
2945 while (my ($k, $v) = each %{$soundconf->{event}}) {
2946 my $face = cf::face::find "sound/$v";
2947 cf::sound::set $k => $face;
2948 }
2949 }
2950 }
2951
2952 1
2953}
2954
2955register_exticmd fx_want => sub {
2956 my ($ns, $want) = @_;
2957
2958 while (my ($k, $v) = each %$want) {
2959 $ns->fx_want ($k, $v);
2960 }
2961};
2962
2963sub reload_regions {
2964 load_resource_file "$MAPDIR/regions"
2965 or die "unable to load regions file\n";
2966
2967 for (cf::region::list) {
2968 $_->{match} = qr/$_->{match}/
2969 if exists $_->{match};
2970 }
2971}
2972
2973sub reload_facedata {
2974 load_facedata "$DATADIR/facedata"
2975 or die "unable to load facedata\n";
2976}
2977
2978sub reload_archetypes {
2979 load_resource_file "$DATADIR/archetypes"
2980 or die "unable to load archetypes\n";
2981 #d# NEED to laod twice to resolve forward references
2982 # this really needs to be done in an extra post-pass
2983 # (which needs to be synchronous, so solve it differently)
2984 load_resource_file "$DATADIR/archetypes"
2985 or die "unable to load archetypes\n";
2986}
2987
2988sub reload_treasures {
2989 load_resource_file "$DATADIR/treasures"
2990 or die "unable to load treasurelists\n";
2991}
2992
2993sub reload_resources {
2994 warn "reloading resource files...\n";
2995
2996 reload_regions;
2997 reload_facedata;
2998 #reload_archetypes;#d#
2999 reload_archetypes;
3000 reload_treasures;
3001
3002 warn "finished reloading resource files\n";
3003}
3004
3005sub init {
3006 reload_resources;
3007}
1977 3008
1978sub cfg_load { 3009sub cfg_load {
1979 open my $fh, "<:utf8", cf::confdir . "/config" 3010 open my $fh, "<:utf8", "$CONFDIR/config"
1980 or return; 3011 or return;
1981 3012
1982 local $/; 3013 local $/;
1983 *CFG = YAML::Syck::Load <$fh>; 3014 *CFG = YAML::Syck::Load <$fh>;
3015
3016 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3017
3018 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3019 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3020
3021 if (exists $CFG{mlockall}) {
3022 eval {
3023 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3024 and die "WARNING: m(un)lockall failed: $!\n";
3025 };
3026 warn $@ if $@;
3027 }
1984} 3028}
1985 3029
1986sub main { 3030sub main {
1987 # we must not ever block the main coroutine 3031 # we must not ever block the main coroutine
1988 local $Coro::idle = sub { 3032 local $Coro::idle = sub {
1989 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3033 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1990 (Coro::unblock_sub { 3034 (async {
1991 Event::one_event; 3035 Event::one_event;
1992 })->(); 3036 })->prio (Coro::PRIO_MAX);
1993 }; 3037 };
1994 3038
1995 cfg_load; 3039 cfg_load;
1996 db_load; 3040 db_init;
1997 load_extensions; 3041 load_extensions;
3042
3043 $TICK_WATCHER->start;
1998 Event::loop; 3044 Event::loop;
1999} 3045}
2000 3046
2001############################################################################# 3047#############################################################################
2002# initialisation 3048# initialisation and cleanup
2003 3049
3050# install some emergency cleanup handlers
3051BEGIN {
3052 for my $signal (qw(INT HUP TERM)) {
3053 Event->signal (
3054 reentrant => 0,
3055 data => WF_AUTOCANCEL,
3056 signal => $signal,
3057 prio => 0,
3058 cb => sub {
3059 cf::cleanup "SIG$signal";
3060 },
3061 );
3062 }
3063}
3064
3065sub write_runtime {
3066 my $runtime = "$LOCALDIR/runtime";
3067
3068 # first touch the runtime file to show we are still running:
3069 # the fsync below can take a very very long time.
3070
3071 IO::AIO::aio_utime $runtime, undef, undef;
3072
3073 my $guard = cf::lock_acquire "write_runtime";
3074
3075 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3076 or return;
3077
3078 my $value = $cf::RUNTIME + 90 + 10;
3079 # 10 is the runtime save interval, for a monotonic clock
3080 # 60 allows for the watchdog to kill the server.
3081
3082 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3083 and return;
3084
3085 # always fsync - this file is important
3086 aio_fsync $fh
3087 and return;
3088
3089 # touch it again to show we are up-to-date
3090 aio_utime $fh, undef, undef;
3091
3092 close $fh
3093 or return;
3094
3095 aio_rename "$runtime~", $runtime
3096 and return;
3097
3098 warn "runtime file written.\n";
3099
3100 1
3101}
3102
3103sub emergency_save() {
3104 my $freeze_guard = cf::freeze_mainloop;
3105
3106 warn "enter emergency perl save\n";
3107
3108 cf::sync_job {
3109 # use a peculiar iteration method to avoid tripping on perl
3110 # refcount bugs in for. also avoids problems with players
3111 # and maps saved/destroyed asynchronously.
3112 warn "begin emergency player save\n";
3113 for my $login (keys %cf::PLAYER) {
3114 my $pl = $cf::PLAYER{$login} or next;
3115 $pl->valid or next;
3116 $pl->save;
3117 }
3118 warn "end emergency player save\n";
3119
3120 warn "begin emergency map save\n";
3121 for my $path (keys %cf::MAP) {
3122 my $map = $cf::MAP{$path} or next;
3123 $map->valid or next;
3124 $map->save;
3125 }
3126 warn "end emergency map save\n";
3127
3128 warn "begin emergency database checkpoint\n";
3129 BDB::db_env_txn_checkpoint $DB_ENV;
3130 warn "end emergency database checkpoint\n";
3131 };
3132
3133 warn "leave emergency perl save\n";
3134}
3135
3136sub post_cleanup {
3137 my ($make_core) = @_;
3138
3139 warn Carp::longmess "post_cleanup backtrace"
3140 if $make_core;
3141}
3142
2004sub reload() { 3143sub do_reload_perl() {
2005 # can/must only be called in main 3144 # can/must only be called in main
2006 if ($Coro::current != $Coro::main) { 3145 if ($Coro::current != $Coro::main) {
2007 warn "can only reload from main coroutine\n"; 3146 warn "can only reload from main coroutine";
2008 return; 3147 return;
2009 } 3148 }
2010 3149
2011 warn "reloading..."; 3150 warn "reloading...";
2012 3151
2013 local $FREEZE = 1; 3152 warn "entering sync_job";
3153
3154 cf::sync_job {
3155 cf::write_runtime; # external watchdog should not bark
2014 cf::emergency_save; 3156 cf::emergency_save;
3157 cf::write_runtime; # external watchdog should not bark
2015 3158
2016 eval { 3159 warn "syncing database to disk";
3160 BDB::db_env_txn_checkpoint $DB_ENV;
3161
2017 # if anything goes wrong in here, we should simply crash as we already saved 3162 # if anything goes wrong in here, we should simply crash as we already saved
2018 3163
2019 # cancel all watchers 3164 warn "cancelling all WF_AUTOCANCEL watchers";
2020 for (Event::all_watchers) { 3165 for (Event::all_watchers) {
2021 $_->cancel if $_->data & WF_AUTOCANCEL; 3166 $_->cancel if $_->data & WF_AUTOCANCEL;
2022 } 3167 }
2023 3168
3169 warn "flushing outstanding aio requests";
3170 for (;;) {
3171 BDB::flush;
3172 IO::AIO::flush;
3173 Coro::cede;
3174 last unless IO::AIO::nreqs || BDB::nreqs;
3175 warn "iterate...";
3176 }
3177
3178 ++$RELOAD;
3179
2024 # cancel all extension coros 3180 warn "cancelling all extension coros";
2025 $_->cancel for values %EXT_CORO; 3181 $_->cancel for values %EXT_CORO;
2026 %EXT_CORO = (); 3182 %EXT_CORO = ();
2027 3183
2028 # unload all extensions 3184 warn "removing commands";
2029 for (@exts) { 3185 %COMMAND = ();
3186
3187 warn "removing ext/exti commands";
3188 %EXTCMD = ();
3189 %EXTICMD = ();
3190
3191 warn "unloading/nuking all extensions";
3192 for my $pkg (@EXTS) {
2030 warn "unloading <$_>"; 3193 warn "... unloading $pkg";
2031 unload_extension $_; 3194
3195 if (my $cb = $pkg->can ("unload")) {
3196 eval {
3197 $cb->($pkg);
3198 1
3199 } or warn "$pkg unloaded, but with errors: $@";
2032 } 3200 }
2033 3201
3202 warn "... nuking $pkg";
3203 Symbol::delete_package $pkg;
3204 }
3205
2034 # unload all modules loaded from $LIBDIR 3206 warn "unloading all perl modules loaded from $LIBDIR";
2035 while (my ($k, $v) = each %INC) { 3207 while (my ($k, $v) = each %INC) {
2036 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3208 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2037 3209
2038 warn "removing <$k>"; 3210 warn "... unloading $k";
2039 delete $INC{$k}; 3211 delete $INC{$k};
2040 3212
2041 $k =~ s/\.pm$//; 3213 $k =~ s/\.pm$//;
2042 $k =~ s/\//::/g; 3214 $k =~ s/\//::/g;
2043 3215
2046 } 3218 }
2047 3219
2048 Symbol::delete_package $k; 3220 Symbol::delete_package $k;
2049 } 3221 }
2050 3222
2051 # sync database to disk
2052 cf::db_sync;
2053 IO::AIO::flush;
2054
2055 # get rid of safe::, as good as possible 3223 warn "getting rid of safe::, as good as possible";
2056 Symbol::delete_package "safe::$_" 3224 Symbol::delete_package "safe::$_"
2057 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3225 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2058 3226
2059 # remove register_script_function callbacks
2060 # TODO
2061
2062 # unload cf.pm "a bit" 3227 warn "unloading cf.pm \"a bit\"";
2063 delete $INC{"cf.pm"}; 3228 delete $INC{"cf.pm"};
3229 delete $INC{"cf/pod.pm"};
2064 3230
2065 # don't, removes xs symbols, too, 3231 # don't, removes xs symbols, too,
2066 # and global variables created in xs 3232 # and global variables created in xs
2067 #Symbol::delete_package __PACKAGE__; 3233 #Symbol::delete_package __PACKAGE__;
2068 3234
2069 # reload cf.pm 3235 warn "unload completed, starting to reload now";
3236
2070 warn "reloading cf.pm"; 3237 warn "reloading cf.pm";
2071 require cf; 3238 require cf;
2072 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3239 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2073 3240
2074 # load config and database again 3241 warn "loading config and database again";
2075 cf::cfg_load; 3242 cf::cfg_load;
2076 cf::db_load;
2077 3243
2078 # load extensions
2079 warn "load extensions"; 3244 warn "loading extensions";
2080 cf::load_extensions; 3245 cf::load_extensions;
2081 3246
2082 # reattach attachments to objects 3247 warn "reattaching attachments to objects/players";
2083 warn "reattach"; 3248 _global_reattach; # objects, sockets
2084 _global_reattach; 3249 warn "reattaching attachments to maps";
2085 }; 3250 reattach $_ for values %MAP;
3251 warn "reattaching attachments to players";
3252 reattach $_ for values %PLAYER;
2086 3253
2087 if ($@) { 3254 warn "leaving sync_job";
3255
3256 1
3257 } or do {
2088 warn $@; 3258 warn $@;
2089 warn "error while reloading, exiting."; 3259 warn "error while reloading, exiting.";
2090 exit 1; 3260 exit 1;
2091 } 3261 };
2092 3262
2093 warn "reloaded successfully"; 3263 warn "reloaded";
2094}; 3264};
2095 3265
2096############################################################################# 3266our $RELOAD_WATCHER; # used only during reload
2097 3267
2098unless ($LINK_MAP) { 3268sub reload_perl() {
2099 $LINK_MAP = cf::map::new; 3269 # doing reload synchronously and two reloads happen back-to-back,
3270 # coro crashes during coro_state_free->destroy here.
2100 3271
2101 $LINK_MAP->width (41); 3272 $RELOAD_WATCHER ||= Event->timer (
2102 $LINK_MAP->height (41); 3273 reentrant => 0,
2103 $LINK_MAP->alloc;
2104 $LINK_MAP->path ("{link}");
2105 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2106 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2107
2108 # dirty hack because... archetypes are not yet loaded
2109 Event->timer (
2110 after => 2, 3274 after => 0,
3275 data => WF_AUTOCANCEL,
2111 cb => sub { 3276 cb => sub {
2112 $_[0]->w->cancel; 3277 do_reload_perl;
2113 3278 undef $RELOAD_WATCHER;
2114 # provide some exits "home"
2115 my $exit = cf::object::new "exit";
2116
2117 $exit->slaying ($EMERGENCY_POSITION->[0]);
2118 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2119 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2120
2121 $LINK_MAP->insert ($exit->clone, 19, 19);
2122 $LINK_MAP->insert ($exit->clone, 19, 20);
2123 $LINK_MAP->insert ($exit->clone, 19, 21);
2124 $LINK_MAP->insert ($exit->clone, 20, 19);
2125 $LINK_MAP->insert ($exit->clone, 20, 21);
2126 $LINK_MAP->insert ($exit->clone, 21, 19);
2127 $LINK_MAP->insert ($exit->clone, 21, 20);
2128 $LINK_MAP->insert ($exit->clone, 21, 21);
2129
2130 $exit->destroy;
2131 }); 3279 },
2132 3280 );
2133 $LINK_MAP->{deny_save} = 1;
2134 $LINK_MAP->{deny_reset} = 1;
2135
2136 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2137} 3281}
2138
2139register "<global>", __PACKAGE__;
2140 3282
2141register_command "reload" => sub { 3283register_command "reload" => sub {
2142 my ($who, $arg) = @_; 3284 my ($who, $arg) = @_;
2143 3285
2144 if ($who->flag (FLAG_WIZ)) { 3286 if ($who->flag (FLAG_WIZ)) {
2145 $who->message ("start of reload.");
2146 reload;
2147 $who->message ("end of reload."); 3287 $who->message ("reloading server.");
3288 async { reload_perl };
2148 } 3289 }
2149}; 3290};
2150 3291
2151unshift @INC, $LIBDIR; 3292unshift @INC, $LIBDIR;
2152 3293
3294my $bug_warning = 0;
3295
3296our @WAIT_FOR_TICK;
3297our @WAIT_FOR_TICK_BEGIN;
3298
3299sub wait_for_tick {
3300 return unless $TICK_WATCHER->is_active;
3301 return if $Coro::current == $Coro::main;
3302
3303 my $signal = new Coro::Signal;
3304 push @WAIT_FOR_TICK, $signal;
3305 $signal->wait;
3306}
3307
3308sub wait_for_tick_begin {
3309 return unless $TICK_WATCHER->is_active;
3310 return if $Coro::current == $Coro::main;
3311
3312 my $signal = new Coro::Signal;
3313 push @WAIT_FOR_TICK_BEGIN, $signal;
3314 $signal->wait;
3315}
3316
3317 my $min = 1e6;#d#
3318 my $avg = 10;
2153$TICK_WATCHER = Event->timer ( 3319$TICK_WATCHER = Event->timer (
2154 reentrant => 0, 3320 reentrant => 0,
3321 parked => 1,
2155 prio => 0, 3322 prio => 0,
2156 at => $NEXT_TICK || $TICK, 3323 at => $NEXT_TICK || $TICK,
2157 data => WF_AUTOCANCEL, 3324 data => WF_AUTOCANCEL,
2158 cb => sub { 3325 cb => sub {
2159 unless ($FREEZE) { 3326 if ($Coro::current != $Coro::main) {
3327 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3328 unless ++$bug_warning > 10;
3329 return;
3330 }
3331
3332 $NOW = $tick_start = Event::time;
3333
2160 cf::server_tick; # one server iteration 3334 cf::server_tick; # one server iteration
2161 $RUNTIME += $TICK; 3335
3336 0 && sync_job {#d#
3337 for(1..10) {
3338 my $t = Event::time;
3339 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3340 or die;
3341
3342 $map->width (50);
3343 $map->height (50);
3344 $map->alloc;
3345 $map->_load_objects ("/tmp/x.map", 1);
3346 my $t = Event::time - $t;
3347
3348 #next unless $t < 0.0013;#d#
3349 if ($t < $min) {
3350 $min = $t;
3351 }
3352 $avg = $avg * 0.99 + $t * 0.01;
3353 }
3354 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3355 exit 0;
3356 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2162 } 3357 };
2163 3358
3359 $RUNTIME += $TICK;
2164 $NEXT_TICK += $TICK; 3360 $NEXT_TICK += $TICK;
2165 3361
3362 if ($NOW >= $NEXT_RUNTIME_WRITE) {
3363 $NEXT_RUNTIME_WRITE = $NOW + 10;
3364 Coro::async_pool {
3365 write_runtime
3366 or warn "ERROR: unable to write runtime file: $!";
3367 };
3368 }
3369
3370# my $AFTER = Event::time;
3371# warn $AFTER - $NOW;#d#
3372
3373 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3374 $sig->send;
3375 }
3376 while (my $sig = shift @WAIT_FOR_TICK) {
3377 $sig->send;
3378 }
3379
3380 $NOW = Event::time;
3381
2166 # if we are delayed by four ticks or more, skip them all 3382 # if we are delayed by four ticks or more, skip them all
2167 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3383 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2168 3384
2169 $TICK_WATCHER->at ($NEXT_TICK); 3385 $TICK_WATCHER->at ($NEXT_TICK);
2170 $TICK_WATCHER->start; 3386 $TICK_WATCHER->start;
3387
3388 $LOAD = ($NOW - $tick_start) / $TICK;
3389 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3390
3391 _post_tick;
3392
3393
2171 }, 3394 },
2172); 3395);
2173 3396
3397{
2174IO::AIO::max_poll_time $TICK * 0.2; 3398 BDB::max_poll_time $TICK * 0.1;
2175 3399 $BDB_POLL_WATCHER = Event->io (
2176Event->io ( 3400 reentrant => 0,
2177 fd => IO::AIO::poll_fileno, 3401 fd => BDB::poll_fileno,
2178 poll => 'r', 3402 poll => 'r',
2179 prio => 5, 3403 prio => 0,
2180 data => WF_AUTOCANCEL,
2181 cb => \&IO::AIO::poll_cb,
2182);
2183
2184Event->timer (
2185 data => WF_AUTOCANCEL, 3404 data => WF_AUTOCANCEL,
2186 after => 0, 3405 cb => \&BDB::poll_cb,
2187 interval => 10, 3406 );
2188 cb => sub { 3407 BDB::min_parallel 8;
2189 (Coro::unblock_sub { 3408
2190 write_runtime 3409 BDB::set_sync_prepare {
2191 or warn "ERROR: unable to write runtime file: $!"; 3410 my $status;
3411 my $current = $Coro::current;
3412 (
3413 sub {
3414 $status = $!;
3415 $current->ready; undef $current;
3416 },
3417 sub {
3418 Coro::schedule while defined $current;
3419 $! = $status;
3420 },
3421 )
3422 };
3423
3424 unless ($DB_ENV) {
3425 $DB_ENV = BDB::db_env_create;
3426
3427 cf::sync_job {
3428 eval {
3429 BDB::db_env_open
3430 $DB_ENV,
3431 $BDBDIR,
3432 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3433 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3434 0666;
3435
3436 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3437
3438 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3439 $DB_ENV->set_lk_detect;
3440 };
3441
3442 cf::cleanup "db_env_open(db): $@" if $@;
2192 })->(); 3443 };
2193 }, 3444 }
2194); 3445}
3446
3447{
3448 IO::AIO::min_parallel 8;
3449
3450 undef $Coro::AIO::WATCHER;
3451 IO::AIO::max_poll_time $TICK * 0.1;
3452 $AIO_POLL_WATCHER = Event->io (
3453 reentrant => 0,
3454 data => WF_AUTOCANCEL,
3455 fd => IO::AIO::poll_fileno,
3456 poll => 'r',
3457 prio => 6,
3458 cb => \&IO::AIO::poll_cb,
3459 );
3460}
3461
3462my $_log_backtrace;
3463
3464sub _log_backtrace {
3465 my ($msg, @addr) = @_;
3466
3467 $msg =~ s/\n//;
3468
3469 # limit the # of concurrent backtraces
3470 if ($_log_backtrace < 2) {
3471 ++$_log_backtrace;
3472 async {
3473 my @bt = fork_call {
3474 @addr = map { sprintf "%x", $_ } @addr;
3475 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3476 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3477 or die "addr2line: $!";
3478
3479 my @funcs;
3480 my @res = <$fh>;
3481 chomp for @res;
3482 while (@res) {
3483 my ($func, $line) = splice @res, 0, 2, ();
3484 push @funcs, "[$func] $line";
3485 }
3486
3487 @funcs
3488 };
3489
3490 LOG llevInfo, "[ABT] $msg\n";
3491 LOG llevInfo, "[ABT] $_\n" for @bt;
3492 --$_log_backtrace;
3493 };
3494 } else {
3495 LOG llevInfo, "[ABT] $msg\n";
3496 LOG llevInfo, "[ABT] [suppressed]\n";
3497 }
3498}
3499
3500# load additional modules
3501use cf::pod;
3502
3503END { cf::emergency_save }
2195 3504
21961 35051
2197 3506

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines