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.125 by root, Tue Jan 2 23:06:39 2007 UTC vs.
Revision 1.281 by root, Sat Jun 16 23:22:59 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 BDB ();
26use Data::Dumper;
20use Digest::MD5; 27use Digest::MD5;
21use Fcntl; 28use Fcntl;
22use IO::AIO 2.31 ();
23use YAML::Syck (); 29use YAML::Syck ();
30use IO::AIO 2.32 ();
24use Time::HiRes; 31use Time::HiRes;
32use Compress::LZF;
25 33
34# configure various modules to our taste
35#
36$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39
26use Event; $Event::Eval = 1; # no idea why this is required, but it is 40$Event::Eval = 1; # no idea why this is required, but it is
27 41
28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
29$YAML::Syck::ImplicitUnicode = 1; 43$YAML::Syck::ImplicitUnicode = 1;
30 44
31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority 45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
32 46
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 48
35our %COMMAND = (); 49our %COMMAND = ();
36our %COMMAND_TIME = (); 50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
37our %EXTCMD = (); 53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
38 56
57our $RELOAD; # number of reloads so far
39our @EVENT; 58our @EVENT;
40our $LIBDIR = datadir . "/ext";
41 59
42our $TICK = MAX_TIME * 1e-6; 60our $CONFDIR = confdir;
61our $DATADIR = datadir;
62our $LIBDIR = "$DATADIR/ext";
63our $PODDIR = "$DATADIR/pod";
64our $MAPDIR = "$DATADIR/" . mapdir;
65our $LOCALDIR = localdir;
66our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db";
71
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
43our $TICK_WATCHER; 73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
44our $NEXT_TICK; 76our $NEXT_TICK;
45our $NOW; 77our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off
79
80our $BDB_POLL_WATCHER;
81our $DB_ENV;
46 82
47our %CFG; 83our %CFG;
48 84
49our $UPTIME; $UPTIME ||= time; 85our $UPTIME; $UPTIME ||= time;
50our $RUNTIME; 86our $RUNTIME;
51 87
88our %PLAYER; # all users
52our %MAP; # all maps 89our %MAP; # all maps
53our $LINK_MAP; # the special {link} map 90our $LINK_MAP; # the special {link} map, which is always available
54our $FREEZE; 91
55our $RANDOM_MAPS = cf::localdir . "/random"; 92# used to convert map paths into valid unix filenames by replacing / by ∕
56our %EXT_CORO; 93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94
95our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96our $LOADAVG; # same thing, but with alpha-smoothing
97our $tick_start; # for load detecting purposes
57 98
58binmode STDOUT; 99binmode STDOUT;
59binmode STDERR; 100binmode STDERR;
60 101
61# read virtual server time, if available 102# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") { 103unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
63 open my $fh, "<", cf::localdir . "/runtime" 104 open my $fh, "<", "$LOCALDIR/runtime"
64 or die "unable to read runtime file: $!"; 105 or die "unable to read runtime file: $!";
65 $RUNTIME = <$fh> + 0.; 106 $RUNTIME = <$fh> + 0.;
66} 107}
67 108
68mkdir cf::localdir; 109mkdir $_
69mkdir cf::localdir . "/" . cf::playerdir; 110 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73 111
74# a special map that is always available 112our $EMERGENCY_POSITION;
75our $LINK_MAP;
76 113
77our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 114sub cf::map::normalise;
78 115
79############################################################################# 116#############################################################################
80 117
81=head2 GLOBAL VARIABLES 118=head2 GLOBAL VARIABLES
82 119
89=item $cf::RUNTIME 126=item $cf::RUNTIME
90 127
91The time this server has run, starts at 0 and is increased by $cf::TICK on 128The time this server has run, starts at 0 and is increased by $cf::TICK on
92every server tick. 129every server tick.
93 130
94=item $cf::LIBDIR 131=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
132$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
133$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
95 134
96The perl library directory, where extensions and cf-specific modules can 135Various directories - "/etc", read-only install directory, perl-library
97be found. It will be added to C<@INC> automatically. 136directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
137unique-items directory, player file directory, random maps directory and
138database environment.
98 139
99=item $cf::NOW 140=item $cf::NOW
100 141
101The time of the last (current) server tick. 142The time of the last (current) server tick.
102 143
103=item $cf::TICK 144=item $cf::TICK
104 145
105The interval between server ticks, in seconds. 146The interval between server ticks, in seconds.
147
148=item $cf::LOADAVG
149
150The current CPU load on the server (alpha-smoothed), as a value between 0
151(none) and 1 (overloaded), indicating how much time is spent on processing
152objects per tick. Healthy values are < 0.5.
153
154=item $cf::LOAD
155
156The raw value load value from the last tick.
106 157
107=item %cf::CFG 158=item %cf::CFG
108 159
109Configuration for the server, loaded from C</etc/crossfire/config>, or 160Configuration for the server, loaded from C</etc/crossfire/config>, or
110from wherever your confdir points to. 161from wherever your confdir points to.
162
163=item cf::wait_for_tick, cf::wait_for_tick_begin
164
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
111 168
112=back 169=back
113 170
114=cut 171=cut
115 172
116BEGIN { 173BEGIN {
117 *CORE::GLOBAL::warn = sub { 174 *CORE::GLOBAL::warn = sub {
118 my $msg = join "", @_; 175 my $msg = join "", @_;
119 utf8::encode $msg;
120 176
121 $msg .= "\n" 177 $msg .= "\n"
122 unless $msg =~ /\n$/; 178 unless $msg =~ /\n$/;
123 179
180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181
182 utf8::encode $msg;
124 LOG llevError, "cfperl: $msg"; 183 LOG llevError, $msg;
125 }; 184 };
126} 185}
127 186
128@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
192@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
133@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 193@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
134 194
135# we bless all objects into (empty) derived classes to force a method lookup 195# we bless all objects into (empty) derived classes to force a method lookup
136# within the Safe compartment. 196# within the Safe compartment.
137for my $pkg (qw( 197for my $pkg (qw(
138 cf::global cf::attachable 198 cf::global cf::attachable
147 207
148$Event::DIED = sub { 208$Event::DIED = sub {
149 warn "error in event callback: @_"; 209 warn "error in event callback: @_";
150}; 210};
151 211
152my %ext_pkg; 212#############################################################################
153my @exts;
154my @hook;
155 213
156=head2 UTILITY FUNCTIONS 214=head2 UTILITY FUNCTIONS
157 215
158=over 4 216=over 4
159 217
160=cut 218=item dumpval $ref
161 219
220=cut
221
222sub dumpval {
223 eval {
224 local $SIG{__DIE__};
225 my $d;
226 if (1) {
227 $d = new Data::Dumper([$_[0]], ["*var"]);
228 $d->Terse(1);
229 $d->Indent(2);
230 $d->Quotekeys(0);
231 $d->Useqq(1);
232 #$d->Bless(...);
233 $d->Seen($_[1]) if @_ > 1;
234 $d = $d->Dump();
235 }
236 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
237 $d
238 } || "[unable to dump $_[0]: '$@']";
239}
240
162use JSON::Syck (); # TODO# replace by JSON::PC once working 241use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
163 242
164=item $ref = cf::from_json $json 243=item $ref = cf::from_json $json
165 244
166Converts a JSON string into the corresponding perl data structure. 245Converts a JSON string into the corresponding perl data structure.
167 246
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 247=item $json = cf::to_json $ref
176 248
177Converts a perl data structure into its JSON representation. 249Converts a perl data structure into its JSON representation.
178 250
179=cut
180
181sub to_json($) {
182 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
183 JSON::Syck::Dump $_[0]
184}
185
186=item my $guard = cf::guard { BLOCK }
187
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
208=item cf::lock_wait $string 251=item cf::lock_wait $string
209 252
210Wait until the given lock is available. See cf::lock_acquire. 253Wait until the given lock is available. See cf::lock_acquire.
211 254
212=item my $lock = cf::lock_acquire $string 255=item my $lock = cf::lock_acquire $string
213 256
214Wait until the given lock is available and then acquires it and returns 257Wait 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, 258a Coro::guard object. If the guard object gets destroyed (goes out of scope,
216for example when the coroutine gets canceled), the lock is automatically 259for example when the coroutine gets canceled), the lock is automatically
217returned. 260returned.
218 261
219Lock names should begin with a unique identifier (for example, find_map 262Lock names should begin with a unique identifier (for example, cf::map::find
220uses map_find and load_map uses map_load). 263uses map_find and cf::map::load uses map_load).
264
265=item $locked = cf::lock_active $string
266
267Return true if the lock is currently active, i.e. somebody has locked it.
221 268
222=cut 269=cut
223 270
224our %LOCK; 271our %LOCK;
225 272
239 # wait, to be sure we are not locked 286 # wait, to be sure we are not locked
240 lock_wait $key; 287 lock_wait $key;
241 288
242 $LOCK{$key} = []; 289 $LOCK{$key} = [];
243 290
244 cf::guard { 291 Coro::guard {
245 # wake up all waiters, to be on the safe side 292 # wake up all waiters, to be on the safe side
246 $_->ready for @{ delete $LOCK{$key} }; 293 $_->ready for @{ delete $LOCK{$key} };
247 } 294 }
248} 295}
249 296
297sub lock_active($) {
298 my ($key) = @_;
299
300 ! ! $LOCK{$key}
301}
302
303sub freeze_mainloop {
304 return unless $TICK_WATCHER->is_active;
305
306 my $guard = Coro::guard {
307 $TICK_WATCHER->start;
308 };
309 $TICK_WATCHER->stop;
310 $guard
311}
312
313=item cf::async { BLOCK }
314
315Currently the same as Coro::async_pool, meaning you cannot use
316C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
317thing you are allowed to do is call C<prio> on it.
318
319=cut
320
321BEGIN { *async = \&Coro::async_pool }
322
250=item cf::sync_job { BLOCK } 323=item cf::sync_job { BLOCK }
251 324
252The design of crossfire+ requires that the main coro ($Coro::main) is 325The design of Crossfire TRT requires that the main coroutine ($Coro::main)
253always able to handle events or runnable, as crossfire+ is only partly 326is 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. 327partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
328acceptable.
255 329
256If it must be done, put the blocking parts into C<sync_job>. This will run 330If 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 331the given BLOCK in another coroutine while waiting for the result. The
258server will be frozen during this time, so the block should either finish 332server will be frozen during this time, so the block should either finish
259fast or be very important. 333fast or be very important.
262 336
263sub sync_job(&) { 337sub sync_job(&) {
264 my ($job) = @_; 338 my ($job) = @_;
265 339
266 if ($Coro::current == $Coro::main) { 340 if ($Coro::current == $Coro::main) {
341 my $time = Event::time;
342
267 # this is the main coro, too bad, we have to block 343 # this is the main coro, too bad, we have to block
268 # till the operation succeeds, freezing the server :/ 344 # till the operation succeeds, freezing the server :/
269 345
270 # TODO: use suspend/resume instead 346 # TODO: use suspend/resume instead
271 # (but this is cancel-safe) 347 # (but this is cancel-safe)
272 local $FREEZE = 1; 348 my $freeze_guard = freeze_mainloop;
273 349
274 my $busy = 1; 350 my $busy = 1;
275 my @res; 351 my @res;
276 352
277 (Coro::async { 353 (async {
278 @res = eval { $job->() }; 354 @res = eval { $job->() };
279 warn $@ if $@; 355 warn $@ if $@;
280 undef $busy; 356 undef $busy;
281 })->prio (Coro::PRIO_MAX); 357 })->prio (Coro::PRIO_MAX);
282 358
283 while ($busy) { 359 while ($busy) {
284 Coro::cede_notself; 360 Coro::cede or Event::one_event;
285 Event::one_event unless Coro::nready;
286 } 361 }
362
363 $time = Event::time - $time;
364
365 LOG llevError | logBacktrace, Carp::longmess "long sync job"
366 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
367
368 $tick_start += $time; # do not account sync jobs to server load
287 369
288 wantarray ? @res : $res[0] 370 wantarray ? @res : $res[0]
289 } else { 371 } else {
290 # we are in another coroutine, how wonderful, everything just works 372 # we are in another coroutine, how wonderful, everything just works
291 373
292 $job->() 374 $job->()
293 } 375 }
294} 376}
295 377
296=item $coro = cf::coro { BLOCK } 378=item $coro = cf::async_ext { BLOCK }
297 379
298Creates and returns a new coro. This coro is automcatially being canceled 380Like async, but this coro is automatically being canceled when the
299when the extension calling this is being unloaded. 381extension calling this is being unloaded.
300 382
301=cut 383=cut
302 384
303sub coro(&) { 385sub async_ext(&) {
304 my $cb = shift; 386 my $cb = shift;
305 387
306 my $coro; $coro = async { 388 my $coro = &Coro::async ($cb);
307 eval {
308 $cb->();
309 };
310 warn $@ if $@;
311 };
312 389
313 $coro->on_destroy (sub { 390 $coro->on_destroy (sub {
314 delete $EXT_CORO{$coro+0}; 391 delete $EXT_CORO{$coro+0};
315 }); 392 });
316 $EXT_CORO{$coro+0} = $coro; 393 $EXT_CORO{$coro+0} = $coro;
317 394
318 $coro 395 $coro
319} 396}
320 397
321sub write_runtime { 398=item fork_call { }, $args
322 my $runtime = cf::localdir . "/runtime";
323 399
324 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 400Executes the given code block with the given arguments in a seperate
325 or return; 401process, returning the results. Everything must be serialisable with
402Coro::Storable. May, of course, block. Note that the executed sub may
403never block itself or use any form of Event handling.
326 404
327 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 405=cut
328 (aio_write $fh, 0, (length $value), $value, 0) <= 0
329 and return;
330 406
331 aio_fsync $fh 407sub fork_call(&@) {
332 and return; 408 my ($cb, @args) = @_;
333 409
410# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
411# or die "socketpair: $!";
412 pipe my $fh1, my $fh2
413 or die "pipe: $!";
414
415 if (my $pid = fork) {
334 close $fh 416 close $fh2;
335 or return;
336 417
337 aio_rename "$runtime~", $runtime 418 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
338 and return; 419 $res = Coro::Storable::thaw $res;
339 420
421 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
422
423 die $$res unless "ARRAY" eq ref $res;
424
425 return wantarray ? @$res : $res->[-1];
426 } else {
427 reset_signals;
428 local $SIG{__WARN__};
429 local $SIG{__DIE__};
430 eval {
431 close $fh1;
432
433 my @res = eval { $cb->(@args) };
434 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
435 };
436
437 warn $@ if $@;
438 _exit 0;
340 1 439 }
440}
441
442=item $value = cf::db_get $family => $key
443
444Returns a single value from the environment database.
445
446=item cf::db_put $family => $key => $value
447
448Stores the given C<$value> in the family. It can currently store binary
449data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
450
451=cut
452
453our $DB;
454
455sub db_init {
456 unless ($DB) {
457 $DB = BDB::db_create $DB_ENV;
458
459 cf::sync_job {
460 eval {
461 $DB->set_flags (BDB::CHKSUM);
462
463 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
464 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
465 cf::cleanup "db_open(db): $!" if $!;
466 };
467 cf::cleanup "db_open(db): $@" if $@;
468 };
469 }
470}
471
472sub db_get($$) {
473 my $key = "$_[0]/$_[1]";
474
475 cf::sync_job {
476 BDB::db_get $DB, undef, $key, my $data;
477
478 $! ? ()
479 : $data
480 }
481}
482
483sub db_put($$$) {
484 BDB::dbreq_pri 4;
485 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
486}
487
488=item cf::cache $id => [$paths...], $processversion => $process
489
490Generic caching function that returns the value of the resource $id,
491caching and regenerating as required.
492
493This function can block.
494
495=cut
496
497sub cache {
498 my ($id, $src, $processversion, $process) = @_;
499
500 my $meta =
501 join "\x00",
502 $processversion,
503 map {
504 aio_stat $_
505 and Carp::croak "$_: $!";
506
507 ($_, (stat _)[7,9])
508 } @$src;
509
510 my $dbmeta = db_get cache => "$id/meta";
511 if ($dbmeta ne $meta) {
512 # changed, we may need to process
513
514 my @data;
515 my $md5;
516
517 for (0 .. $#$src) {
518 0 <= aio_load $src->[$_], $data[$_]
519 or Carp::croak "$src->[$_]: $!";
520 }
521
522 # if processing is expensive, check
523 # checksum first
524 if (1) {
525 $md5 =
526 join "\x00",
527 $processversion,
528 map {
529 Coro::cede;
530 ($src->[$_], Digest::MD5::md5_hex $data[$_])
531 } 0.. $#$src;
532
533
534 my $dbmd5 = db_get cache => "$id/md5";
535 if ($dbmd5 eq $md5) {
536 db_put cache => "$id/meta", $meta;
537
538 return db_get cache => "$id/data";
539 }
540 }
541
542 my $t1 = Time::HiRes::time;
543 my $data = $process->(\@data);
544 my $t2 = Time::HiRes::time;
545
546 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
547
548 db_put cache => "$id/data", $data;
549 db_put cache => "$id/md5" , $md5;
550 db_put cache => "$id/meta", $meta;
551
552 return $data;
553 }
554
555 db_get cache => "$id/data"
556}
557
558=item cf::datalog type => key => value, ...
559
560Log a datalog packet of the given type with the given key-value pairs.
561
562=cut
563
564sub datalog($@) {
565 my ($type, %kv) = @_;
566 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
341} 567}
342 568
343=back 569=back
344 570
345=cut 571=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 572
467############################################################################# 573#############################################################################
468 574
469=head2 ATTACHABLE OBJECTS 575=head2 ATTACHABLE OBJECTS
470 576
472attach callbacks/event handlers (a collection of which is called an "attachment") 578attach callbacks/event handlers (a collection of which is called an "attachment")
473to it. All such attachable objects support the following methods. 579to it. All such attachable objects support the following methods.
474 580
475In the following description, CLASS can be any of C<global>, C<object> 581In 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 582C<player>, C<client> or C<map> (i.e. the attachable objects in
477crossfire+). 583Crossfire TRT).
478 584
479=over 4 585=over 4
480 586
481=item $attachable->attach ($attachment, key => $value...) 587=item $attachable->attach ($attachment, key => $value...)
482 588
596our @CB_TYPE = (); # registry for type (cf-object class) based events 702our @CB_TYPE = (); # registry for type (cf-object class) based events
597our @CB_MAP = (); 703our @CB_MAP = ();
598 704
599my %attachment; 705my %attachment;
600 706
707sub cf::attachable::thawer_merge {
708 # simply override everything except _meta
709 local $_[0]{_meta};
710 %{$_[0]} = %{$_[1]};
711}
712
601sub _attach_cb($$$$) { 713sub _attach_cb($$$$) {
602 my ($registry, $event, $prio, $cb) = @_; 714 my ($registry, $event, $prio, $cb) = @_;
603 715
604 use sort 'stable'; 716 use sort 'stable';
605 717
639 $registry = $CB_TYPE[$object_type] ||= []; 751 $registry = $CB_TYPE[$object_type] ||= [];
640 752
641 } elsif ($type eq "subtype") { 753 } elsif ($type eq "subtype") {
642 defined $object_type or Carp::croak "subtype specified without type"; 754 defined $object_type or Carp::croak "subtype specified without type";
643 my $object_subtype = shift @arg; 755 my $object_subtype = shift @arg;
644 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 756 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
645 757
646 } elsif ($type eq "package") { 758 } elsif ($type eq "package") {
647 my $pkg = shift @arg; 759 my $pkg = shift @arg;
648 760
649 while (my ($name, $id) = each %cb_id) { 761 while (my ($name, $id) = each %cb_id) {
678 _attach $registry, $klass, @attach; 790 _attach $registry, $klass, @attach;
679 } 791 }
680 792
681 $obj->{$name} = \%arg; 793 $obj->{$name} = \%arg;
682 } else { 794 } else {
683 warn "object uses attachment '$name' that is not available, postponing.\n"; 795 warn "object uses attachment '$name' which is not available, postponing.\n";
684 } 796 }
685 797
686 $obj->{_attachment}{$name} = undef; 798 $obj->{_attachment}{$name} = undef;
687} 799}
688 800
690 if (ref $_[0]) { 802 if (ref $_[0]) {
691 _object_attach @_; 803 _object_attach @_;
692 } else { 804 } else {
693 _attach shift->_attach_registry, @_; 805 _attach shift->_attach_registry, @_;
694 } 806 }
807 _recalc_want;
695}; 808};
696 809
697# all those should be optimised 810# all those should be optimised
698sub cf::attachable::detach { 811sub cf::attachable::detach {
699 my ($obj, $name) = @_; 812 my ($obj, $name) = @_;
702 delete $obj->{_attachment}{$name}; 815 delete $obj->{_attachment}{$name};
703 reattach ($obj); 816 reattach ($obj);
704 } else { 817 } else {
705 Carp::croak "cannot, currently, detach class attachments"; 818 Carp::croak "cannot, currently, detach class attachments";
706 } 819 }
820 _recalc_want;
707}; 821};
708 822
709sub cf::attachable::attached { 823sub cf::attachable::attached {
710 my ($obj, $name) = @_; 824 my ($obj, $name) = @_;
711 825
776# object support 890# object support
777 891
778sub reattach { 892sub reattach {
779 # basically do the same as instantiate, without calling instantiate 893 # basically do the same as instantiate, without calling instantiate
780 my ($obj) = @_; 894 my ($obj) = @_;
895
896 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
781 897
782 my $registry = $obj->registry; 898 my $registry = $obj->registry;
783 899
784 @$registry = (); 900 @$registry = ();
785 901
832 $filename, length $$rdata, scalar @$objs; 948 $filename, length $$rdata, scalar @$objs;
833 949
834 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 950 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
835 chmod SAVE_MODE, $fh; 951 chmod SAVE_MODE, $fh;
836 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 952 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
837 aio_fsync $fh; 953 aio_fsync $fh if $cf::USE_FSYNC;
838 close $fh; 954 close $fh;
839 955
840 if (@$objs) { 956 if (@$objs) {
841 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 957 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
842 chmod SAVE_MODE, $fh; 958 chmod SAVE_MODE, $fh;
843 my $data = Storable::nfreeze { version => 1, objs => $objs }; 959 my $data = Storable::nfreeze { version => 1, objs => $objs };
844 aio_write $fh, 0, (length $data), $data, 0; 960 aio_write $fh, 0, (length $data), $data, 0;
845 aio_fsync $fh; 961 aio_fsync $fh if $cf::USE_FSYNC;
846 close $fh; 962 close $fh;
847 aio_rename "$filename.pst~", "$filename.pst"; 963 aio_rename "$filename.pst~", "$filename.pst";
848 } 964 }
849 } else { 965 } else {
850 aio_unlink "$filename.pst"; 966 aio_unlink "$filename.pst";
882 or return; 998 or return;
883 $av = eval { (Storable::thaw $av)->{objs} }; 999 $av = eval { (Storable::thaw $av)->{objs} };
884 } 1000 }
885 1001
886 warn sprintf "loading %s (%d)\n", 1002 warn sprintf "loading %s (%d)\n",
887 $filename, length $data, scalar @{$av || []};#d# 1003 $filename, length $data, scalar @{$av || []};
888 return ($data, $av); 1004 return ($data, $av);
889} 1005}
1006
1007=head2 COMMAND CALLBACKS
1008
1009=over 4
1010
1011=cut
890 1012
891############################################################################# 1013#############################################################################
892# command handling &c 1014# command handling &c
893 1015
894=item cf::register_command $name => \&callback($ob,$args); 1016=item cf::register_command $name => \&callback($ob,$args);
907 push @{ $COMMAND{$name} }, [$caller, $cb]; 1029 push @{ $COMMAND{$name} }, [$caller, $cb];
908} 1030}
909 1031
910=item cf::register_extcmd $name => \&callback($pl,$packet); 1032=item cf::register_extcmd $name => \&callback($pl,$packet);
911 1033
912Register a callbackf ro execution when the client sends an extcmd packet. 1034Register a callback fro execution when the client sends an extcmd packet.
913 1035
914If the callback returns something, it is sent back as if reply was being 1036If the callback returns something, it is sent back as if reply was being
915called. 1037called.
916 1038
917=cut 1039=cut
918 1040
919sub register_extcmd { 1041sub register_extcmd {
920 my ($name, $cb) = @_; 1042 my ($name, $cb) = @_;
921 1043
922 my $caller = caller;
923 #warn "registering extcmd '$name' to '$caller'";
924
925 $EXTCMD{$name} = [$cb, $caller]; 1044 $EXTCMD{$name} = $cb;
926} 1045}
927 1046
928cf::player->attach ( 1047cf::player->attach (
929 on_command => sub { 1048 on_command => sub {
930 my ($pl, $name, $params) = @_; 1049 my ($pl, $name, $params) = @_;
943 1062
944 my $msg = eval { from_json $buf }; 1063 my $msg = eval { from_json $buf };
945 1064
946 if (ref $msg) { 1065 if (ref $msg) {
947 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1066 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
948 if (my %reply = $cb->[0]->($pl, $msg)) { 1067 if (my %reply = $cb->($pl, $msg)) {
949 $pl->ext_reply ($msg->{msgid}, %reply); 1068 $pl->ext_reply ($msg->{msgid}, %reply);
950 } 1069 }
951 } 1070 }
952 } else { 1071 } else {
953 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1072 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
955 1074
956 cf::override; 1075 cf::override;
957 }, 1076 },
958); 1077);
959 1078
960sub register {
961 my ($base, $pkg) = @_;
962
963 #TODO
964}
965
966sub load_extension { 1079sub load_extensions {
1080 cf::sync_job {
1081 my %todo;
1082
1083 for my $path (<$LIBDIR/*.ext>) {
1084 next unless -r $path;
1085
1086 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1087 my $base = $1;
1088 my $pkg = $1;
1089 $pkg =~ s/[^[:word:]]/_/g;
1090 $pkg = "ext::$pkg";
1091
1092 open my $fh, "<:utf8", $path
1093 or die "$path: $!";
1094
1095 my $source = do { local $/; <$fh> };
1096
1097 my %ext = (
1098 path => $path,
1099 base => $base,
1100 pkg => $pkg,
1101 );
1102
1103 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1104 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1105
1106 $ext{source} =
1107 "package $pkg; use strict; use utf8;\n"
1108 . "#line 1 \"$path\"\n{\n"
1109 . $source
1110 . "\n};\n1";
1111
1112 $todo{$base} = \%ext;
1113 }
1114
1115 my %done;
1116 while (%todo) {
1117 my $progress;
1118
1119 while (my ($k, $v) = each %todo) {
1120 for (split /,\s*/, $v->{meta}{depends}) {
1121 goto skip
1122 unless exists $done{$_};
1123 }
1124
1125 warn "... loading '$k' into '$v->{pkg}'\n";
1126
1127 unless (eval $v->{source}) {
1128 my $msg = $@ ? "$v->{path}: $@\n"
1129 : "$v->{base}: extension inactive.\n";
1130
1131 if (exists $v->{meta}{mandatory}) {
1132 warn $msg;
1133 warn "mandatory extension failed to load, exiting.\n";
1134 exit 1;
1135 }
1136
1137 warn $msg;
1138 }
1139
1140 $done{$k} = delete $todo{$k};
1141 push @EXTS, $v->{pkg};
1142 $progress = 1;
1143 }
1144
1145 skip:
1146 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1147 unless $progress;
1148 }
1149 };
1150}
1151
1152#############################################################################
1153
1154=back
1155
1156=head2 CORE EXTENSIONS
1157
1158Functions and methods that extend core crossfire objects.
1159
1160=cut
1161
1162package cf::player;
1163
1164use Coro::AIO;
1165
1166=head3 cf::player
1167
1168=over 4
1169
1170=item cf::player::find $login
1171
1172Returns the given player object, loading it if necessary (might block).
1173
1174=cut
1175
1176sub playerdir($) {
1177 "$PLAYERDIR/"
1178 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1179}
1180
1181sub path($) {
1182 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1183
1184 (playerdir $login) . "/playerdata"
1185}
1186
1187sub find_active($) {
1188 $cf::PLAYER{$_[0]}
1189 and $cf::PLAYER{$_[0]}->active
1190 and $cf::PLAYER{$_[0]}
1191}
1192
1193sub exists($) {
1194 my ($login) = @_;
1195
1196 $cf::PLAYER{$login}
1197 or cf::sync_job { !aio_stat path $login }
1198}
1199
1200sub find($) {
1201 return $cf::PLAYER{$_[0]} || do {
1202 my $login = $_[0];
1203
1204 my $guard = cf::lock_acquire "user_find:$login";
1205
1206 $cf::PLAYER{$_[0]} || do {
1207 # rename old playerfiles to new ones
1208 #TODO: remove when no longer required
1209 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1210 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1211 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1212 aio_unlink +(playerdir $login) . "/$login.pl";
1213
1214 my $pl = load_pl path $login
1215 or return;
1216 $cf::PLAYER{$login} = $pl
1217 }
1218 }
1219}
1220
1221sub save($) {
1222 my ($pl) = @_;
1223
1224 return if $pl->{deny_save};
1225
1226 my $path = path $pl;
1227 my $guard = cf::lock_acquire "user_save:$path";
1228
1229 return if $pl->{deny_save};
1230
1231 aio_mkdir playerdir $pl, 0770;
1232 $pl->{last_save} = $cf::RUNTIME;
1233
1234 $pl->save_pl ($path);
1235 Coro::cede;
1236}
1237
1238sub new($) {
1239 my ($login) = @_;
1240
1241 my $self = create;
1242
1243 $self->ob->name ($login);
1244 $self->{deny_save} = 1;
1245
1246 $cf::PLAYER{$login} = $self;
1247
1248 $self
1249}
1250
1251=item $pl->quit_character
1252
1253Nukes the player without looking back. If logged in, the connection will
1254be destroyed. May block for a long time.
1255
1256=cut
1257
1258sub quit_character {
1259 my ($pl) = @_;
1260
1261 my $name = $pl->ob->name;
1262
1263 $pl->{deny_save} = 1;
1264 $pl->password ("*"); # this should lock out the player until we nuked the dir
1265
1266 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1267 $pl->deactivate;
1268 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1269 $pl->ns->destroy if $pl->ns;
1270
1271 my $path = playerdir $pl;
1272 my $temp = "$path~$cf::RUNTIME~deleting~";
1273 aio_rename $path, $temp;
1274 delete $cf::PLAYER{$pl->ob->name};
1275 $pl->destroy;
1276
1277 my $prefix = qr<^~\Q$name\E/>;
1278
1279 # nuke player maps
1280 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1281
1282 IO::AIO::aio_rmtree $temp;
1283}
1284
1285=item $pl->kick
1286
1287Kicks a player out of the game. This destroys the connection.
1288
1289=cut
1290
1291sub kick {
1292 my ($pl, $kicker) = @_;
1293
1294 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1295 $pl->killer ("kicked");
1296 $pl->ns->destroy;
1297}
1298
1299=item cf::player::list_logins
1300
1301Returns am arrayref of all valid playernames in the system, can take a
1302while and may block, so not sync_job-capable, ever.
1303
1304=cut
1305
1306sub list_logins {
1307 my $dirs = aio_readdir $PLAYERDIR
1308 or return [];
1309
1310 my @logins;
1311
1312 for my $login (@$dirs) {
1313 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1314 aio_read $fh, 0, 512, my $buf, 0 or next;
1315 $buf !~ /^password -------------$/m or next; # official not-valid tag
1316
1317 utf8::decode $login;
1318 push @logins, $login;
1319 }
1320
1321 \@logins
1322}
1323
1324=item $player->maps
1325
1326Returns an arrayref of map paths that are private for this
1327player. May block.
1328
1329=cut
1330
1331sub maps($) {
1332 my ($pl) = @_;
1333
1334 $pl = ref $pl ? $pl->ob->name : $pl;
1335
1336 my $files = aio_readdir playerdir $pl
1337 or return;
1338
1339 my @paths;
1340
1341 for (@$files) {
1342 utf8::decode $_;
1343 next if /\.(?:pl|pst)$/;
1344 next unless /^$PATH_SEP/o;
1345
1346 push @paths, cf::map::normalise "~$pl/$_";
1347 }
1348
1349 \@paths
1350}
1351
1352=item $player->ext_reply ($msgid, %msg)
1353
1354Sends an ext reply to the player.
1355
1356=cut
1357
1358sub ext_reply($$%) {
1359 my ($self, $id, %msg) = @_;
1360
1361 $msg{msgid} = $id;
1362
1363 $self->send ("ext " . cf::to_json \%msg);
1364}
1365
1366=item $player->ext_event ($type, %msg)
1367
1368Sends an ext event to the client.
1369
1370=cut
1371
1372sub ext_event($$%) {
1373 my ($self, $type, %msg) = @_;
1374
1375 $self->ns->ext_event ($type, %msg);
1376}
1377
1378=head3 cf::region
1379
1380=over 4
1381
1382=cut
1383
1384package cf::region;
1385
1386=item cf::region::find_by_path $path
1387
1388Tries to decuce the likely region for a map knowing only its path.
1389
1390=cut
1391
1392sub find_by_path($) {
967 my ($path) = @_; 1393 my ($path) = @_;
968 1394
969 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1395 my ($match, $specificity);
970 my $base = $1;
971 my $pkg = $1;
972 $pkg =~ s/[^[:word:]]/_/g;
973 $pkg = "ext::$pkg";
974 1396
975 warn "loading '$path' into '$pkg'\n"; 1397 for my $region (list) {
976 1398 if ($region->match && $path =~ $region->match) {
977 open my $fh, "<:utf8", $path 1399 ($match, $specificity) = ($region, $region->specificity)
978 or die "$path: $!"; 1400 if $region->specificity > $specificity;
979 1401 }
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# } 1402 }
1009 1403
1010 # remove commands 1404 $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} 1405}
1116 1406
1117=back 1407=back
1118
1119 1408
1120=head3 cf::map 1409=head3 cf::map
1121 1410
1122=over 4 1411=over 4
1123 1412
1126package cf::map; 1415package cf::map;
1127 1416
1128use Fcntl; 1417use Fcntl;
1129use Coro::AIO; 1418use Coro::AIO;
1130 1419
1420use overload
1421 '""' => \&as_string,
1422 fallback => 1;
1423
1131our $MAX_RESET = 7200; 1424our $MAX_RESET = 3600;
1132our $DEFAULT_RESET = 3600; 1425our $DEFAULT_RESET = 3000;
1133 1426
1134sub generate_random_map { 1427sub generate_random_map {
1135 my ($path, $rmp) = @_; 1428 my ($self, $rmp) = @_;
1136
1137 # mit "rum" bekleckern, nicht 1429 # mit "rum" bekleckern, nicht
1138 cf::map::_create_random_map 1430 $self->_create_random_map (
1139 $path,
1140 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1431 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1141 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1432 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1142 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1433 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1143 $rmp->{exit_on_final_map}, 1434 $rmp->{exit_on_final_map},
1144 $rmp->{xsize}, $rmp->{ysize}, 1435 $rmp->{xsize}, $rmp->{ysize},
1145 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1436 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1146 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1437 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1147 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1438 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1148 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, 1439 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1149 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1440 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1150 (cf::region::find $rmp->{region}) 1441 (cf::region::find $rmp->{region}), $rmp->{custom}
1442 )
1443}
1444
1445=item cf::map->register ($regex, $prio)
1446
1447Register a handler for the map path matching the given regex at the
1448givne priority (higher is better, built-in handlers have priority 0, the
1449default).
1450
1451=cut
1452
1453sub register {
1454 my (undef, $regex, $prio) = @_;
1455 my $pkg = caller;
1456
1457 no strict;
1458 push @{"$pkg\::ISA"}, __PACKAGE__;
1459
1460 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1461}
1462
1463# also paths starting with '/'
1464$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1465
1466sub thawer_merge {
1467 my ($self, $merge) = @_;
1468
1469 # we have to keep some variables in memory intact
1470 local $self->{path};
1471 local $self->{load_path};
1472
1473 $self->SUPER::thawer_merge ($merge);
1474}
1475
1476sub normalise {
1477 my ($path, $base) = @_;
1478
1479 $path = "$path"; # make sure its a string
1480
1481 $path =~ s/\.map$//;
1482
1483 # map plan:
1484 #
1485 # /! non-realised random map exit (special hack!)
1486 # {... are special paths that are not being touched
1487 # ?xxx/... are special absolute paths
1488 # ?random/... random maps
1489 # /... normal maps
1490 # ~user/... per-player map of a specific user
1491
1492 $path =~ s/$PATH_SEP/\//go;
1493
1494 # treat it as relative path if it starts with
1495 # something that looks reasonable
1496 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1497 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1498
1499 $base =~ s{[^/]+/?$}{};
1500 $path = "$base/$path";
1501 }
1502
1503 for ($path) {
1504 redo if s{//}{/};
1505 redo if s{/\.?/}{/};
1506 redo if s{/[^/]+/\.\./}{/};
1507 }
1508
1509 $path
1510}
1511
1512sub new_from_path {
1513 my (undef, $path, $base) = @_;
1514
1515 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1516
1517 $path = normalise $path, $base;
1518
1519 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1520 if ($path =~ $EXT_MAP{$pkg}[1]) {
1521 my $self = bless cf::map::new, $pkg;
1522 $self->{path} = $path; $self->path ($path);
1523 $self->init; # pass $1 etc.
1524 return $self;
1525 }
1526 }
1527
1528 Carp::carp "unable to resolve path '$path' (base '$base').";
1529 ()
1530}
1531
1532sub init {
1533 my ($self) = @_;
1534
1535 $self
1536}
1537
1538sub as_string {
1539 my ($self) = @_;
1540
1541 "$self->{path}"
1542}
1543
1544# the displayed name, this is a one way mapping
1545sub visible_name {
1546 &as_string
1547}
1548
1549# the original (read-only) location
1550sub load_path {
1551 my ($self) = @_;
1552
1553 "$MAPDIR/$self->{path}.map"
1554}
1555
1556# the temporary/swap location
1557sub save_path {
1558 my ($self) = @_;
1559
1560 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1561 "$TMPDIR/$path.map"
1562}
1563
1564# the unique path, undef == no special unique path
1565sub uniq_path {
1566 my ($self) = @_;
1567
1568 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1569 "$UNIQUEDIR/$path"
1151} 1570}
1152 1571
1153# and all this just because we cannot iterate over 1572# and all this just because we cannot iterate over
1154# all maps in C++... 1573# all maps in C++...
1155sub change_all_map_light { 1574sub change_all_map_light {
1157 1576
1158 $_->change_map_light ($change) 1577 $_->change_map_light ($change)
1159 for grep $_->outdoor, values %cf::MAP; 1578 for grep $_->outdoor, values %cf::MAP;
1160} 1579}
1161 1580
1581sub decay_objects {
1582 my ($self) = @_;
1583
1584 return if $self->{deny_reset};
1585
1586 $self->do_decay_objects;
1587}
1588
1589sub unlink_save {
1590 my ($self) = @_;
1591
1592 utf8::encode (my $save = $self->save_path);
1593 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1594 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1595}
1596
1162sub try_load_header($) { 1597sub load_header_from($) {
1163 my ($path) = @_; 1598 my ($self, $path) = @_;
1164 1599
1165 utf8::encode $path; 1600 utf8::encode $path;
1166 aio_open $path, O_RDONLY, 0 1601 #aio_open $path, O_RDONLY, 0
1602 # or return;
1603
1604 $self->_load_header ($path)
1167 or return; 1605 or return;
1168 1606
1169 my $map = cf::map::new 1607 $self->{load_path} = $path;
1608
1609 1
1610}
1611
1612sub load_header_orig {
1613 my ($self) = @_;
1614
1615 $self->load_header_from ($self->load_path)
1616}
1617
1618sub load_header_temp {
1619 my ($self) = @_;
1620
1621 $self->load_header_from ($self->save_path)
1622}
1623
1624sub prepare_temp {
1625 my ($self) = @_;
1626
1627 $self->last_access ((delete $self->{last_access})
1628 || $cf::RUNTIME); #d#
1629 # safety
1630 $self->{instantiate_time} = $cf::RUNTIME
1631 if $self->{instantiate_time} > $cf::RUNTIME;
1632}
1633
1634sub prepare_orig {
1635 my ($self) = @_;
1636
1637 $self->{load_original} = 1;
1638 $self->{instantiate_time} = $cf::RUNTIME;
1639 $self->last_access ($cf::RUNTIME);
1640 $self->instantiate;
1641}
1642
1643sub load_header {
1644 my ($self) = @_;
1645
1646 if ($self->load_header_temp) {
1647 $self->prepare_temp;
1648 } else {
1649 $self->load_header_orig
1170 or return; 1650 or return;
1651 $self->prepare_orig;
1652 }
1171 1653
1172 $map->load_header ($path) 1654 $self->{deny_reset} = 1
1173 or return; 1655 if $self->no_reset;
1174 1656
1175 $map->{load_path} = $path; 1657 $self->default_region (cf::region::find_by_path $self->{path})
1658 unless $self->default_region;
1176 1659
1177 $map 1660 1
1178} 1661}
1179 1662
1663sub find;
1180sub find_map { 1664sub find {
1181 my ($path, $origin) = @_; 1665 my ($path, $origin) = @_;
1182 1666
1183 #warn "find_map<$path,$origin>\n";#d#
1184
1185 $path = new cf::path $path, $origin && $origin->path; 1667 $path = normalise $path, $origin && $origin->path;
1186 my $key = $path->as_string;
1187 1668
1188 cf::lock_wait "map_find:$key"; 1669 cf::lock_wait "map_find:$path";
1189 1670
1190 $cf::MAP{$key} || do { 1671 $cf::MAP{$path} || do {
1191 my $guard = cf::lock_acquire "map_find:$key"; 1672 my $guard = cf::lock_acquire "map_find:$path";
1192 1673 my $map = new_from_path cf::map $path
1193 # do it the slow way
1194 my $map = try_load_header $path->save_path;
1195
1196 if ($map) {
1197 # safety
1198 $map->{instantiate_time} = $cf::RUNTIME
1199 if $map->{instantiate_time} > $cf::RUNTIME;
1200 } else {
1201 if (my $rmp = $path->random_map_params) {
1202 $map = generate_random_map $key, $rmp;
1203 } else {
1204 $map = try_load_header $path->load_path;
1205 }
1206
1207 $map or return; 1674 or return;
1208 1675
1209 $map->{load_original} = 1;
1210 $map->{instantiate_time} = $cf::RUNTIME;
1211 $map->instantiate;
1212
1213 # per-player maps become, after loading, normal maps
1214 $map->per_player (0) if $path->{user_rel};
1215 }
1216
1217 $map->path ($key);
1218 $map->{path} = $path;
1219 $map->{last_save} = $cf::RUNTIME; 1676 $map->{last_save} = $cf::RUNTIME;
1220 $map->last_access ($cf::RUNTIME);
1221 1677
1222 if ($map->should_reset) { 1678 $map->load_header
1679 or return;
1680
1681 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1682 # doing this can freeze the server in a sync job, obviously
1683 #$cf::WAIT_FOR_TICK->wait;
1223 $map->reset; 1684 $map->reset;
1224 undef $guard; 1685 undef $guard;
1225 $map = cf::map::find_map ($path) 1686 return find $path;
1226 or return;
1227 } 1687 }
1228 1688
1229 $cf::MAP{$key} = $map 1689 $cf::MAP{$path} = $map
1230 } 1690 }
1231} 1691}
1692
1693sub pre_load { }
1694sub post_load { }
1232 1695
1233sub load { 1696sub load {
1234 my ($self) = @_; 1697 my ($self) = @_;
1235 1698
1699 local $self->{deny_reset} = 1; # loading can take a long time
1700
1236 my $path = $self->{path}; 1701 my $path = $self->{path};
1702
1703 {
1237 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1704 my $guard = cf::lock_acquire "map_load:$path";
1238 1705
1239 return if $self->in_memory != cf::MAP_SWAPPED; 1706 return if $self->in_memory != cf::MAP_SWAPPED;
1240 1707
1241 $self->in_memory (cf::MAP_LOADING); 1708 $self->in_memory (cf::MAP_LOADING);
1242 1709
1243 $self->alloc; 1710 $self->alloc;
1711
1712 $self->pre_load;
1713 Coro::cede;
1714
1244 $self->load_objects ($self->{load_path}, 1) 1715 $self->_load_objects ($self->{load_path}, 1)
1245 or return; 1716 or return;
1246 1717
1247 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1718 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1248 if delete $self->{load_original}; 1719 if delete $self->{load_original};
1249 1720
1250 if (my $uniq = $path->uniq_path) { 1721 if (my $uniq = $self->uniq_path) {
1251 utf8::encode $uniq; 1722 utf8::encode $uniq;
1252 if (aio_open $uniq, O_RDONLY, 0) { 1723 if (aio_open $uniq, O_RDONLY, 0) {
1253 $self->clear_unique_items; 1724 $self->clear_unique_items;
1254 $self->load_objects ($uniq, 0); 1725 $self->_load_objects ($uniq, 0);
1255 } 1726 }
1256 } 1727 }
1257 1728
1729 Coro::cede;
1258 # now do the right thing for maps 1730 # now do the right thing for maps
1259 $self->link_multipart_objects; 1731 $self->link_multipart_objects;
1260
1261 if ($self->{path}->is_style_map) {
1262 $self->{deny_save} = 1;
1263 $self->{deny_reset} = 1;
1264 } else {
1265 $self->fix_auto_apply;
1266 $self->decay_objects;
1267 $self->update_buttons;
1268 $self->set_darkness_map;
1269 $self->difficulty ($self->estimate_difficulty) 1732 $self->difficulty ($self->estimate_difficulty)
1270 unless $self->difficulty; 1733 unless $self->difficulty;
1734 Coro::cede;
1735
1736 unless ($self->{deny_activate}) {
1737 $self->decay_objects;
1738 $self->fix_auto_apply;
1739 $self->update_buttons;
1740 Coro::cede;
1741 $self->set_darkness_map;
1742 Coro::cede;
1271 $self->activate; 1743 $self->activate;
1272 } 1744 }
1273 1745
1274 $self->in_memory (cf::MAP_IN_MEMORY); 1746 $self->in_memory (cf::MAP_IN_MEMORY);
1275} 1747 }
1276 1748
1277sub load_map_sync { 1749 $self->post_load;
1750}
1751
1752sub customise_for {
1753 my ($self, $ob) = @_;
1754
1755 return find "~" . $ob->name . "/" . $self->{path}
1756 if $self->per_player;
1757
1758# return find "?party/" . $ob->name . "/" . $self->{path}
1759# if $self->per_party;
1760
1761 $self
1762}
1763
1764# find and load all maps in the 3x3 area around a map
1765sub load_diag {
1766 my ($map) = @_;
1767
1768 my @diag; # diagonal neighbours
1769
1770 for (0 .. 3) {
1771 my $neigh = $map->tile_path ($_)
1772 or next;
1773 $neigh = find $neigh, $map
1774 or next;
1775 $neigh->load;
1776
1777 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1778 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1779 }
1780
1781 for (@diag) {
1782 my $neigh = find @$_
1783 or next;
1784 $neigh->load;
1785 }
1786}
1787
1788sub find_sync {
1278 my ($path, $origin) = @_; 1789 my ($path, $origin) = @_;
1279 1790
1280 #warn "load_map_sync<$path, $origin>\n";#d# 1791 cf::sync_job { find $path, $origin }
1792}
1281 1793
1282 cf::sync_job { 1794sub do_load_sync {
1283 my $map = cf::map::find_map $path, $origin 1795 my ($map) = @_;
1284 or return; 1796
1797 cf::sync_job { $map->load };
1798}
1799
1800our %MAP_PREFETCH;
1801our $MAP_PREFETCHER = undef;
1802
1803sub find_async {
1804 my ($path, $origin) = @_;
1805
1806 $path = normalise $path, $origin && $origin->{path};
1807
1808 if (my $map = $cf::MAP{$path}) {
1809 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1810 }
1811
1812 undef $MAP_PREFETCH{$path};
1813 $MAP_PREFETCHER ||= cf::async {
1814 while (%MAP_PREFETCH) {
1815 for my $path (keys %MAP_PREFETCH) {
1816 my $map = find $path
1817 or next;
1285 $map->load; 1818 $map->load;
1286 $map 1819
1820 delete $MAP_PREFETCH{$path};
1821 }
1822 }
1823 undef $MAP_PREFETCHER;
1287 } 1824 };
1825 $MAP_PREFETCHER->prio (6);
1826
1827 ()
1288} 1828}
1289 1829
1290sub save { 1830sub save {
1291 my ($self) = @_; 1831 my ($self) = @_;
1292 1832
1833 my $lock = cf::lock_acquire "map_data:" . $self->path;
1834
1293 $self->{last_save} = $cf::RUNTIME; 1835 $self->{last_save} = $cf::RUNTIME;
1294 1836
1295 return unless $self->dirty; 1837 return unless $self->dirty;
1296 1838
1297 my $save = $self->{path}->save_path; utf8::encode $save; 1839 my $save = $self->save_path; utf8::encode $save;
1298 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1840 my $uniq = $self->uniq_path; utf8::encode $uniq;
1299 1841
1300 $self->{load_path} = $save; 1842 $self->{load_path} = $save;
1301 1843
1302 return if $self->{deny_save}; 1844 return if $self->{deny_save};
1303 1845
1846 local $self->{last_access} = $self->last_access;#d#
1847
1848 cf::async {
1849 $_->contr->save for $self->players;
1850 };
1851
1304 if ($uniq) { 1852 if ($uniq) {
1305 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1853 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1306 $self->save_objects ($uniq, cf::IO_UNIQUES); 1854 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1307 } else { 1855 } else {
1308 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 1856 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1309 } 1857 }
1310} 1858}
1311 1859
1312sub swap_out { 1860sub swap_out {
1313 my ($self) = @_; 1861 my ($self) = @_;
1862
1863 # save first because save cedes
1864 $self->save;
1865
1866 my $lock = cf::lock_acquire "map_data:" . $self->path;
1314 1867
1315 return if $self->players; 1868 return if $self->players;
1316 return if $self->in_memory != cf::MAP_IN_MEMORY; 1869 return if $self->in_memory != cf::MAP_IN_MEMORY;
1317 return if $self->{deny_save}; 1870 return if $self->{deny_save};
1318 1871
1319 $self->save;
1320 $self->clear; 1872 $self->clear;
1321 $self->in_memory (cf::MAP_SWAPPED); 1873 $self->in_memory (cf::MAP_SWAPPED);
1322} 1874}
1323 1875
1324sub reset_at { 1876sub reset_at {
1325 my ($self) = @_; 1877 my ($self) = @_;
1326 1878
1327 # TODO: safety, remove and allow resettable per-player maps 1879 # TODO: safety, remove and allow resettable per-player maps
1328 return 1e99 if $self->{path}{user_rel};
1329 return 1e99 if $self->{deny_reset}; 1880 return 1e99 if $self->{deny_reset};
1330 1881
1331 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1882 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1332 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1883 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1333 1884
1338 my ($self) = @_; 1889 my ($self) = @_;
1339 1890
1340 $self->reset_at <= $cf::RUNTIME 1891 $self->reset_at <= $cf::RUNTIME
1341} 1892}
1342 1893
1343sub unlink_save {
1344 my ($self) = @_;
1345
1346 utf8::encode (my $save = $self->{path}->save_path);
1347 aioreq_pri 3; IO::AIO::aio_unlink $save;
1348 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1349}
1350
1351sub rename {
1352 my ($self, $new_path) = @_;
1353
1354 $self->unlink_save;
1355
1356 delete $cf::MAP{$self->path};
1357 $self->{path} = new cf::path $new_path;
1358 $self->path ($self->{path}->as_string);
1359 $cf::MAP{$self->path} = $self;
1360
1361 $self->save;
1362}
1363
1364sub reset { 1894sub reset {
1365 my ($self) = @_; 1895 my ($self) = @_;
1366 1896
1897 my $lock = cf::lock_acquire "map_data:$self->{path}";
1898
1367 return if $self->players; 1899 return if $self->players;
1368 return if $self->{path}{user_rel};#d#
1369 1900
1370 warn "resetting map ", $self->path;#d# 1901 warn "resetting map ", $self->path;
1902
1903 $self->in_memory (cf::MAP_SWAPPED);
1904
1905 # need to save uniques path
1906 unless ($self->{deny_save}) {
1907 my $uniq = $self->uniq_path; utf8::encode $uniq;
1908
1909 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1910 if $uniq;
1911 }
1371 1912
1372 delete $cf::MAP{$self->path}; 1913 delete $cf::MAP{$self->path};
1914
1915 $self->clear;
1373 1916
1374 $_->clear_links_to ($self) for values %cf::MAP; 1917 $_->clear_links_to ($self) for values %cf::MAP;
1375 1918
1376 $self->unlink_save; 1919 $self->unlink_save;
1377 $self->destroy; 1920 $self->destroy;
1380my $nuke_counter = "aaaa"; 1923my $nuke_counter = "aaaa";
1381 1924
1382sub nuke { 1925sub nuke {
1383 my ($self) = @_; 1926 my ($self) = @_;
1384 1927
1928 delete $cf::MAP{$self->path};
1929
1930 $self->unlink_save;
1931
1932 bless $self, "cf::map";
1933 delete $self->{deny_reset};
1385 $self->{deny_save} = 1; 1934 $self->{deny_save} = 1;
1386 $self->reset_timeout (1); 1935 $self->reset_timeout (1);
1387 $self->rename ("{nuke}/" . ($nuke_counter++)); 1936 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1937
1938 $cf::MAP{$self->path} = $self;
1939
1388 $self->reset; # polite request, might not happen 1940 $self->reset; # polite request, might not happen
1389} 1941}
1390 1942
1391sub customise_for { 1943=item $maps = cf::map::tmp_maps
1392 my ($map, $ob) = @_;
1393 1944
1394 if ($map->per_player) { 1945Returns an arrayref with all map paths of currently instantiated and saved
1395 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 1946maps. May block.
1947
1948=cut
1949
1950sub tmp_maps() {
1396 } 1951 [
1397 1952 map {
1398 $map 1953 utf8::decode $_;
1954 /\.map$/
1955 ? normalise $_
1956 : ()
1957 } @{ aio_readdir $TMPDIR or [] }
1958 ]
1399} 1959}
1400 1960
1401sub emergency_save { 1961=item $maps = cf::map::random_maps
1402 local $cf::FREEZE = 1;
1403 1962
1404 warn "enter emergency map save\n"; 1963Returns an arrayref with all map paths of currently instantiated and saved
1964random maps. May block.
1405 1965
1406 cf::sync_job { 1966=cut
1407 warn "begin emergency map save\n";
1408 $_->save for values %cf::MAP;
1409 };
1410 1967
1411 warn "end emergency map save\n"; 1968sub random_maps() {
1969 [
1970 map {
1971 utf8::decode $_;
1972 /\.map$/
1973 ? normalise "?random/$_"
1974 : ()
1975 } @{ aio_readdir $RANDOMDIR or [] }
1976 ]
1977}
1978
1979=item cf::map::unique_maps
1980
1981Returns an arrayref of paths of all shared maps that have
1982instantiated unique items. May block.
1983
1984=cut
1985
1986sub unique_maps() {
1987 [
1988 map {
1989 utf8::decode $_;
1990 /\.map$/
1991 ? normalise $_
1992 : ()
1993 } @{ aio_readdir $UNIQUEDIR or [] }
1994 ]
1412} 1995}
1413 1996
1414package cf; 1997package cf;
1415 1998
1416=back 1999=back
1417 2000
2001=head3 cf::object
2002
2003=cut
2004
2005package cf::object;
2006
2007=over 4
2008
2009=item $ob->inv_recursive
2010
2011Returns the inventory of the object _and_ their inventories, recursively.
2012
2013=cut
2014
2015sub inv_recursive_;
2016sub inv_recursive_ {
2017 map { $_, inv_recursive_ $_->inv } @_
2018}
2019
2020sub inv_recursive {
2021 inv_recursive_ inv $_[0]
2022}
2023
2024package cf;
2025
2026=back
1418 2027
1419=head3 cf::object::player 2028=head3 cf::object::player
1420 2029
1421=over 4 2030=over 4
1422 2031
1462 2071
1463=item $player_object->enter_link 2072=item $player_object->enter_link
1464 2073
1465Freezes the player and moves him/her to a special map (C<{link}>). 2074Freezes the player and moves him/her to a special map (C<{link}>).
1466 2075
1467The player should be reaosnably safe there for short amounts of time. You 2076The player should be reasonably safe there for short amounts of time. You
1468I<MUST> call C<leave_link> as soon as possible, though. 2077I<MUST> call C<leave_link> as soon as possible, though.
1469 2078
2079Will never block.
2080
1470=item $player_object->leave_link ($map, $x, $y) 2081=item $player_object->leave_link ($map, $x, $y)
1471 2082
1472Moves the player out of the specila link map onto the given map. If the 2083Moves the player out of the special C<{link}> map onto the specified
1473map is not valid (or omitted), the player will be moved back to the 2084map. If the map is not valid (or omitted), the player will be moved back
1474location he/she was before the call to C<enter_link>, or, if that fails, 2085to the location he/she was before the call to C<enter_link>, or, if that
1475to the emergency map position. 2086fails, to the emergency map position.
1476 2087
1477Might block. 2088Might block.
1478 2089
1479=cut 2090=cut
2091
2092sub link_map {
2093 unless ($LINK_MAP) {
2094 $LINK_MAP = cf::map::find "{link}"
2095 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2096 $LINK_MAP->load;
2097 }
2098
2099 $LINK_MAP
2100}
1480 2101
1481sub cf::object::player::enter_link { 2102sub cf::object::player::enter_link {
1482 my ($self) = @_; 2103 my ($self) = @_;
1483 2104
1484 $self->deactivate_recursive; 2105 $self->deactivate_recursive;
1485 2106
1486 return if $self->map == $LINK_MAP; 2107 return if UNIVERSAL::isa $self->map, "ext::map_link";
1487 2108
1488 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2109 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1489 if $self->map; 2110 if $self->map && $self->map->{path} ne "{link}";
1490 2111
1491 $self->enter_map ($LINK_MAP, 20, 20); 2112 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1492} 2113}
1493 2114
1494sub cf::object::player::leave_link { 2115sub cf::object::player::leave_link {
1495 my ($self, $map, $x, $y) = @_; 2116 my ($self, $map, $x, $y) = @_;
2117
2118 return unless $self->contr->active;
1496 2119
1497 my $link_pos = delete $self->{_link_pos}; 2120 my $link_pos = delete $self->{_link_pos};
1498 2121
1499 unless ($map) { 2122 unless ($map) {
1500 # restore original map position 2123 # restore original map position
1501 ($map, $x, $y) = @{ $link_pos || [] }; 2124 ($map, $x, $y) = @{ $link_pos || [] };
1502 $map = cf::map::find_map $map; 2125 $map = cf::map::find $map;
1503 2126
1504 unless ($map) { 2127 unless ($map) {
1505 ($map, $x, $y) = @$EMERGENCY_POSITION; 2128 ($map, $x, $y) = @$EMERGENCY_POSITION;
1506 $map = cf::map::find_map $map 2129 $map = cf::map::find $map
1507 or die "FATAL: cannot load emergency map\n"; 2130 or die "FATAL: cannot load emergency map\n";
1508 } 2131 }
1509 } 2132 }
1510 2133
1511 ($x, $y) = (-1, -1) 2134 ($x, $y) = (-1, -1)
1514 # use -1 or undef as default coordinates, not 0, 0 2137 # use -1 or undef as default coordinates, not 0, 0
1515 ($x, $y) = ($map->enter_x, $map->enter_y) 2138 ($x, $y) = ($map->enter_x, $map->enter_y)
1516 if $x <=0 && $y <= 0; 2139 if $x <=0 && $y <= 0;
1517 2140
1518 $map->load; 2141 $map->load;
2142 $map->load_diag;
1519 2143
2144 return unless $self->contr->active;
1520 $self->activate_recursive; 2145 $self->activate_recursive;
2146
2147 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1521 $self->enter_map ($map, $x, $y); 2148 $self->enter_map ($map, $x, $y);
1522} 2149}
1523 2150
1524cf::player->attach (
1525 on_logout => sub {
1526 my ($pl) = @_;
1527
1528 # abort map switching before logout
1529 if ($pl->ob->{_link_pos}) {
1530 cf::sync_job {
1531 $pl->ob->leave_link
1532 };
1533 }
1534 },
1535 on_login => sub {
1536 my ($pl) = @_;
1537
1538 # try to abort aborted map switching on player login :)
1539 # should happen only on crashes
1540 if ($pl->ob->{_link_pos}) {
1541 $pl->ob->enter_link;
1542 Coro::async {
1543 # we need this sleep as the login has a concurrent enter_exit running
1544 # and this sleep increases chances of the player not ending up in scorn
1545 Coro::Timer::sleep 1;
1546 $pl->ob->leave_link;
1547 };
1548 }
1549 },
1550);
1551
1552=item $player_object->goto_map ($path, $x, $y) 2151=item $player_object->goto ($path, $x, $y[, $check->($map)])
1553 2152
1554=cut 2153Moves the player to the given map-path and coordinates by first freezing
2154her, loading and preparing them map, calling the provided $check callback
2155that has to return the map if sucecssful, and then unfreezes the player on
2156the new (success) or old (failed) map position.
1555 2157
2158=cut
2159
2160our $GOTOGEN;
2161
1556sub cf::object::player::goto_map { 2162sub cf::object::player::goto {
1557 my ($self, $path, $x, $y) = @_; 2163 my ($self, $path, $x, $y, $check) = @_;
2164
2165 # do generation counting so two concurrent goto's will be executed in-order
2166 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1558 2167
1559 $self->enter_link; 2168 $self->enter_link;
1560 2169
1561 (Coro::async { 2170 (async {
1562 $path = new cf::path $path; 2171 my $map = eval {
1563
1564 my $map = cf::map::find_map $path->as_string; 2172 my $map = cf::map::find $path;
2173
2174 if ($map) {
1565 $map = $map->customise_for ($self) if $map; 2175 $map = $map->customise_for ($self);
1566 2176 $map = $check->($map) if $check && $map;
1567# warn "entering ", $map->path, " at ($x, $y)\n" 2177 } else {
1568# if $map;
1569
1570 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2178 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2179 }
1571 2180
2181 $map
2182 };
2183
2184 if ($@) {
2185 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2186 LOG llevError | logBacktrace, Carp::longmess $@;
2187 }
2188
2189 if ($gen == $self->{_goto_generation}) {
2190 delete $self->{_goto_generation};
1572 $self->leave_link ($map, $x, $y); 2191 $self->leave_link ($map, $x, $y);
2192 }
1573 })->prio (1); 2193 })->prio (1);
1574} 2194}
1575 2195
1576=item $player_object->enter_exit ($exit_object) 2196=item $player_object->enter_exit ($exit_object)
1577 2197
1579 2199
1580sub parse_random_map_params { 2200sub parse_random_map_params {
1581 my ($spec) = @_; 2201 my ($spec) = @_;
1582 2202
1583 my $rmp = { # defaults 2203 my $rmp = { # defaults
1584 xsize => 10, 2204 xsize => (cf::rndm 15, 40),
1585 ysize => 10, 2205 ysize => (cf::rndm 15, 40),
2206 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2207 #layout => string,
1586 }; 2208 };
1587 2209
1588 for (split /\n/, $spec) { 2210 for (split /\n/, $spec) {
1589 my ($k, $v) = split /\s+/, $_, 2; 2211 my ($k, $v) = split /\s+/, $_, 2;
1590 2212
1594 $rmp 2216 $rmp
1595} 2217}
1596 2218
1597sub prepare_random_map { 2219sub prepare_random_map {
1598 my ($exit) = @_; 2220 my ($exit) = @_;
2221
2222 my $guard = cf::lock_acquire "exit_prepare:$exit";
1599 2223
1600 # all this does is basically replace the /! path by 2224 # all this does is basically replace the /! path by
1601 # a new random map path (?random/...) with a seed 2225 # a new random map path (?random/...) with a seed
1602 # that depends on the exit object 2226 # that depends on the exit object
1603 2227
1604 my $rmp = parse_random_map_params $exit->msg; 2228 my $rmp = parse_random_map_params $exit->msg;
1605 2229
1606 if ($exit->map) { 2230 if ($exit->map) {
1607 $rmp->{region} = $exit->map->region_name; 2231 $rmp->{region} = $exit->region->name;
1608 $rmp->{origin_map} = $exit->map->path; 2232 $rmp->{origin_map} = $exit->map->path;
1609 $rmp->{origin_x} = $exit->x; 2233 $rmp->{origin_x} = $exit->x;
1610 $rmp->{origin_y} = $exit->y; 2234 $rmp->{origin_y} = $exit->y;
1611 } 2235 }
1612 2236
1613 $rmp->{random_seed} ||= $exit->random_seed; 2237 $rmp->{random_seed} ||= $exit->random_seed;
1614 2238
1615 my $data = cf::to_json $rmp; 2239 my $data = cf::to_json $rmp;
1616 my $md5 = Digest::MD5::md5_hex $data; 2240 my $md5 = Digest::MD5::md5_hex $data;
2241 my $meta = "$RANDOMDIR/$md5.meta";
1617 2242
1618 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2243 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1619 aio_write $fh, 0, (length $data), $data, 0; 2244 aio_write $fh, 0, (length $data), $data, 0;
2245 undef $fh;
2246 aio_rename "$meta~", $meta;
1620 2247
1621 $exit->slaying ("?random/$md5"); 2248 $exit->slaying ("?random/$md5");
1622 $exit->msg (undef); 2249 $exit->msg (undef);
1623 } 2250 }
1624} 2251}
1626sub cf::object::player::enter_exit { 2253sub cf::object::player::enter_exit {
1627 my ($self, $exit) = @_; 2254 my ($self, $exit) = @_;
1628 2255
1629 return unless $self->type == cf::PLAYER; 2256 return unless $self->type == cf::PLAYER;
1630 2257
2258 if ($exit->slaying eq "/!") {
2259 #TODO: this should de-fi-ni-te-ly not be a sync-job
2260 # the problem is that $exit might not survive long enough
2261 # so it needs to be done right now, right here
2262 cf::sync_job { prepare_random_map $exit };
2263 }
2264
2265 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2266 my $hp = $exit->stats->hp;
2267 my $sp = $exit->stats->sp;
2268
1631 $self->enter_link; 2269 $self->enter_link;
1632 2270
1633 (Coro::async { 2271 (async {
2272 $self->deactivate_recursive; # just to be sure
1634 unless (eval { 2273 unless (eval {
1635 2274 $self->goto ($slaying, $hp, $sp);
1636 prepare_random_map $exit
1637 if $exit->slaying eq "/!";
1638
1639 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1640 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1641 2275
1642 1; 2276 1;
1643 }) { 2277 }) {
1644 $self->message ("Something went wrong deep within the crossfire server. " 2278 $self->message ("Something went wrong deep within the crossfire server. "
1645 . "I'll try to bring you back to the map you were before. " 2279 . "I'll try to bring you back to the map you were before. "
1646 . "Please report this to the dungeon master", 2280 . "Please report this to the dungeon master!",
1647 cf::NDI_UNIQUE | cf::NDI_RED); 2281 cf::NDI_UNIQUE | cf::NDI_RED);
1648 2282
1649 warn "ERROR in enter_exit: $@"; 2283 warn "ERROR in enter_exit: $@";
1650 $self->leave_link; 2284 $self->leave_link;
1651 } 2285 }
1652 })->prio (1); 2286 })->prio (1);
1665 2299
1666sub cf::client::send_drawinfo { 2300sub cf::client::send_drawinfo {
1667 my ($self, $text, $flags) = @_; 2301 my ($self, $text, $flags) = @_;
1668 2302
1669 utf8::encode $text; 2303 utf8::encode $text;
1670 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2304 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1671} 2305}
1672 2306
2307=item $client->ext_event ($type, %msg)
2308
2309Sends an exti event to the client.
2310
2311=cut
2312
2313sub cf::client::ext_event($$%) {
2314 my ($self, $type, %msg) = @_;
2315
2316 $msg{msgtype} = "event_$type";
2317 $self->send_packet ("ext " . cf::to_json \%msg);
2318}
1673 2319
1674=item $success = $client->query ($flags, "text", \&cb) 2320=item $success = $client->query ($flags, "text", \&cb)
1675 2321
1676Queues a query to the client, calling the given callback with 2322Queues a query to the client, calling the given callback with
1677the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2323the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1702 on_reply => sub { 2348 on_reply => sub {
1703 my ($ns, $msg) = @_; 2349 my ($ns, $msg) = @_;
1704 2350
1705 # this weird shuffling is so that direct followup queries 2351 # this weird shuffling is so that direct followup queries
1706 # get handled first 2352 # get handled first
1707 my $queue = delete $ns->{query_queue}; 2353 my $queue = delete $ns->{query_queue}
2354 or return; # be conservative, not sure how that can happen, but we saw a crash here
1708 2355
1709 (shift @$queue)->[1]->($msg); 2356 (shift @$queue)->[1]->($msg);
2357 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1710 2358
1711 push @{ $ns->{query_queue} }, @$queue; 2359 push @{ $ns->{query_queue} }, @$queue;
1712 2360
1713 if (@{ $ns->{query_queue} } == @$queue) { 2361 if (@{ $ns->{query_queue} } == @$queue) {
1714 if (@$queue) { 2362 if (@$queue) {
1718 } 2366 }
1719 } 2367 }
1720 }, 2368 },
1721); 2369);
1722 2370
1723=item $client->coro (\&cb) 2371=item $client->async (\&cb)
1724 2372
1725Create a new coroutine, running the specified callback. The coroutine will 2373Create a new coroutine, running the specified callback. The coroutine will
1726be automatically cancelled when the client gets destroyed (e.g. on logout, 2374be automatically cancelled when the client gets destroyed (e.g. on logout,
1727or loss of connection). 2375or loss of connection).
1728 2376
1729=cut 2377=cut
1730 2378
1731sub cf::client::coro { 2379sub cf::client::async {
1732 my ($self, $cb) = @_; 2380 my ($self, $cb) = @_;
1733 2381
1734 my $coro; $coro = async { 2382 my $coro = &Coro::async ($cb);
1735 eval {
1736 $cb->();
1737 };
1738 warn $@ if $@;
1739 };
1740 2383
1741 $coro->on_destroy (sub { 2384 $coro->on_destroy (sub {
1742 delete $self->{_coro}{$coro+0}; 2385 delete $self->{_coro}{$coro+0};
1743 }); 2386 });
1744 2387
1777 2420
1778# here we export the classes and methods available to script code 2421# here we export the classes and methods available to script code
1779 2422
1780=pod 2423=pod
1781 2424
1782The following fucntions and emthods are available within a safe environment: 2425The following functions and methods are available within a safe environment:
1783 2426
1784 cf::object contr pay_amount pay_player map 2427 cf::object contr pay_amount pay_player map
1785 cf::object::player player 2428 cf::object::player player
1786 cf::player peaceful 2429 cf::player peaceful
1787 cf::map trigger 2430 cf::map trigger
1868=back 2511=back
1869 2512
1870=cut 2513=cut
1871 2514
1872############################################################################# 2515#############################################################################
2516# the server's init and main functions
1873 2517
1874=head2 EXTENSION DATABASE SUPPORT 2518sub load_facedata($) {
2519 my ($path) = @_;
1875 2520
1876Crossfire maintains a very simple database for extension use. It can 2521 warn "loading facedata from $path\n";
1877currently store anything that can be serialised using Storable, which
1878excludes objects.
1879 2522
1880The parameter C<$family> should best start with the name of the extension 2523 my $facedata;
1881using it, it should be unique. 2524 0 < aio_load $path, $facedata
2525 or die "$path: $!";
1882 2526
1883=over 4 2527 $facedata = Coro::Storable::thaw $facedata;
1884 2528
1885=item $hashref = cf::db_get $family 2529 $facedata->{version} == 2
2530 or cf::cleanup "$path: version mismatch, cannot proceed.";
1886 2531
1887Return a hashref for use by the extension C<$family>, which can be
1888modified. After modifications, you have to call C<cf::db_dirty> or
1889C<cf::db_sync>.
1890
1891=item $value = cf::db_get $family => $key
1892
1893Returns a single value from the database
1894
1895=item cf::db_put $family => $hashref
1896
1897Stores the given family hashref into the database. Updates are delayed, if
1898you want the data to be synced to disk immediately, use C<cf::db_sync>.
1899
1900=item cf::db_put $family => $key => $value
1901
1902Stores the given C<$value> in the family hash. Updates are delayed, if you
1903want the data to be synced to disk immediately, use C<cf::db_sync>.
1904
1905=item cf::db_dirty
1906
1907Marks the database as dirty, to be updated at a later time.
1908
1909=item cf::db_sync
1910
1911Immediately write the database to disk I<if it is dirty>.
1912
1913=cut
1914
1915our $DB;
1916
1917{
1918 my $path = cf::localdir . "/database.pst";
1919
1920 sub db_load() {
1921 $DB = stat $path ? Storable::retrieve $path : { };
1922 } 2532 {
2533 my $faces = $facedata->{faceinfo};
1923 2534
1924 my $pid; 2535 while (my ($face, $info) = each %$faces) {
1925 2536 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1926 sub db_save() { 2537 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
1927 waitpid $pid, 0 if $pid; 2538 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
1928 if (0 == ($pid = fork)) { 2539 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1929 $DB->{_meta}{version} = 1; 2540 Coro::cede;
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 }, 2541 }
1972 );
1973}
1974 2542
1975############################################################################# 2543 while (my ($face, $info) = each %$faces) {
1976# the server's main() 2544 next unless $info->{smooth};
2545 my $idx = cf::face::find $face
2546 or next;
2547 if (my $smooth = cf::face::find $info->{smooth}) {
2548 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2549 } else {
2550 warn "smooth face '$info->{smooth}' not found for face '$face'";
2551 }
2552 Coro::cede;
2553 }
2554 }
2555
2556 {
2557 my $anims = $facedata->{animinfo};
2558
2559 while (my ($anim, $info) = each %$anims) {
2560 cf::anim::set $anim, $info->{frames}, $info->{facings};
2561 Coro::cede;
2562 }
2563
2564 cf::anim::invalidate_all; # d'oh
2565 }
2566
2567 1
2568}
2569
2570sub reload_regions {
2571 load_resource_file "$MAPDIR/regions"
2572 or die "unable to load regions file\n";
2573}
2574
2575sub reload_facedata {
2576 load_facedata "$DATADIR/facedata"
2577 or die "unable to load facedata\n";
2578}
2579
2580sub reload_archetypes {
2581 load_resource_file "$DATADIR/archetypes"
2582 or die "unable to load archetypes\n";
2583}
2584
2585sub reload_treasures {
2586 load_resource_file "$DATADIR/treasures"
2587 or die "unable to load treasurelists\n";
2588}
2589
2590sub reload_resources {
2591 warn "reloading resource files...\n";
2592
2593 reload_regions;
2594 reload_facedata;
2595 #reload_archetypes;#d#
2596 reload_archetypes;
2597 reload_treasures;
2598
2599 warn "finished reloading resource files\n";
2600}
2601
2602sub init {
2603 reload_resources;
2604}
1977 2605
1978sub cfg_load { 2606sub cfg_load {
1979 open my $fh, "<:utf8", cf::confdir . "/config" 2607 open my $fh, "<:utf8", "$CONFDIR/config"
1980 or return; 2608 or return;
1981 2609
1982 local $/; 2610 local $/;
1983 *CFG = YAML::Syck::Load <$fh>; 2611 *CFG = YAML::Syck::Load <$fh>;
2612
2613 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2614
2615 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2616 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2617
2618 if (exists $CFG{mlockall}) {
2619 eval {
2620 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2621 and die "WARNING: m(un)lockall failed: $!\n";
2622 };
2623 warn $@ if $@;
2624 }
1984} 2625}
1985 2626
1986sub main { 2627sub main {
1987 # we must not ever block the main coroutine 2628 # we must not ever block the main coroutine
1988 local $Coro::idle = sub { 2629 local $Coro::idle = sub {
1989 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2630 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1990 (Coro::unblock_sub { 2631 (async {
1991 Event::one_event; 2632 Event::one_event;
1992 })->(); 2633 })->prio (Coro::PRIO_MAX);
1993 }; 2634 };
1994 2635
1995 cfg_load; 2636 cfg_load;
1996 db_load; 2637 db_init;
1997 load_extensions; 2638 load_extensions;
2639
2640 $TICK_WATCHER->start;
1998 Event::loop; 2641 Event::loop;
1999} 2642}
2000 2643
2001############################################################################# 2644#############################################################################
2002# initialisation 2645# initialisation and cleanup
2003 2646
2647# install some emergency cleanup handlers
2648BEGIN {
2649 for my $signal (qw(INT HUP TERM)) {
2650 Event->signal (
2651 reentrant => 0,
2652 data => WF_AUTOCANCEL,
2653 signal => $signal,
2654 prio => 0,
2655 cb => sub {
2656 cf::cleanup "SIG$signal";
2657 },
2658 );
2659 }
2660}
2661
2662sub write_runtime {
2663 my $runtime = "$LOCALDIR/runtime";
2664
2665 # first touch the runtime file to show we are still running:
2666 # the fsync below can take a very very long time.
2667
2668 IO::AIO::aio_utime $runtime, undef, undef;
2669
2670 my $guard = cf::lock_acquire "write_runtime";
2671
2672 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2673 or return;
2674
2675 my $value = $cf::RUNTIME + 90 + 10;
2676 # 10 is the runtime save interval, for a monotonic clock
2677 # 60 allows for the watchdog to kill the server.
2678
2679 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2680 and return;
2681
2682 # always fsync - this file is important
2683 aio_fsync $fh
2684 and return;
2685
2686 # touch it again to show we are up-to-date
2687 aio_utime $fh, undef, undef;
2688
2689 close $fh
2690 or return;
2691
2692 aio_rename "$runtime~", $runtime
2693 and return;
2694
2695 warn "runtime file written.\n";
2696
2697 1
2698}
2699
2700sub emergency_save() {
2701 my $freeze_guard = cf::freeze_mainloop;
2702
2703 warn "enter emergency perl save\n";
2704
2705 cf::sync_job {
2706 # use a peculiar iteration method to avoid tripping on perl
2707 # refcount bugs in for. also avoids problems with players
2708 # and maps saved/destroyed asynchronously.
2709 warn "begin emergency player save\n";
2710 for my $login (keys %cf::PLAYER) {
2711 my $pl = $cf::PLAYER{$login} or next;
2712 $pl->valid or next;
2713 $pl->save;
2714 }
2715 warn "end emergency player save\n";
2716
2717 warn "begin emergency map save\n";
2718 for my $path (keys %cf::MAP) {
2719 my $map = $cf::MAP{$path} or next;
2720 $map->valid or next;
2721 $map->save;
2722 }
2723 warn "end emergency map save\n";
2724
2725 warn "begin emergency database checkpoint\n";
2726 BDB::db_env_txn_checkpoint $DB_ENV;
2727 warn "end emergency database checkpoint\n";
2728 };
2729
2730 warn "leave emergency perl save\n";
2731}
2732
2733sub post_cleanup {
2734 my ($make_core) = @_;
2735
2736 warn Carp::longmess "post_cleanup backtrace"
2737 if $make_core;
2738}
2739
2004sub reload() { 2740sub do_reload_perl() {
2005 # can/must only be called in main 2741 # can/must only be called in main
2006 if ($Coro::current != $Coro::main) { 2742 if ($Coro::current != $Coro::main) {
2007 warn "can only reload from main coroutine\n"; 2743 warn "can only reload from main coroutine";
2008 return; 2744 return;
2009 } 2745 }
2010 2746
2011 warn "reloading..."; 2747 warn "reloading...";
2012 2748
2013 local $FREEZE = 1; 2749 warn "entering sync_job";
2750
2751 cf::sync_job {
2752 cf::write_runtime; # external watchdog should not bark
2014 cf::emergency_save; 2753 cf::emergency_save;
2754 cf::write_runtime; # external watchdog should not bark
2015 2755
2016 eval { 2756 warn "syncing database to disk";
2757 BDB::db_env_txn_checkpoint $DB_ENV;
2758
2017 # if anything goes wrong in here, we should simply crash as we already saved 2759 # if anything goes wrong in here, we should simply crash as we already saved
2018 2760
2019 # cancel all watchers 2761 warn "cancelling all WF_AUTOCANCEL watchers";
2020 for (Event::all_watchers) { 2762 for (Event::all_watchers) {
2021 $_->cancel if $_->data & WF_AUTOCANCEL; 2763 $_->cancel if $_->data & WF_AUTOCANCEL;
2022 } 2764 }
2023 2765
2766 warn "flushing outstanding aio requests";
2767 for (;;) {
2768 BDB::flush;
2769 IO::AIO::flush;
2770 Coro::cede;
2771 last unless IO::AIO::nreqs || BDB::nreqs;
2772 warn "iterate...";
2773 }
2774
2775 ++$RELOAD;
2776
2024 # cancel all extension coros 2777 warn "cancelling all extension coros";
2025 $_->cancel for values %EXT_CORO; 2778 $_->cancel for values %EXT_CORO;
2026 %EXT_CORO = (); 2779 %EXT_CORO = ();
2027 2780
2028 # unload all extensions 2781 warn "removing commands";
2029 for (@exts) { 2782 %COMMAND = ();
2783
2784 warn "removing ext commands";
2785 %EXTCMD = ();
2786
2787 warn "unloading/nuking all extensions";
2788 for my $pkg (@EXTS) {
2030 warn "unloading <$_>"; 2789 warn "... unloading $pkg";
2031 unload_extension $_; 2790
2791 if (my $cb = $pkg->can ("unload")) {
2792 eval {
2793 $cb->($pkg);
2794 1
2795 } or warn "$pkg unloaded, but with errors: $@";
2032 } 2796 }
2033 2797
2798 warn "... nuking $pkg";
2799 Symbol::delete_package $pkg;
2800 }
2801
2034 # unload all modules loaded from $LIBDIR 2802 warn "unloading all perl modules loaded from $LIBDIR";
2035 while (my ($k, $v) = each %INC) { 2803 while (my ($k, $v) = each %INC) {
2036 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2804 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2037 2805
2038 warn "removing <$k>"; 2806 warn "... unloading $k";
2039 delete $INC{$k}; 2807 delete $INC{$k};
2040 2808
2041 $k =~ s/\.pm$//; 2809 $k =~ s/\.pm$//;
2042 $k =~ s/\//::/g; 2810 $k =~ s/\//::/g;
2043 2811
2046 } 2814 }
2047 2815
2048 Symbol::delete_package $k; 2816 Symbol::delete_package $k;
2049 } 2817 }
2050 2818
2051 # sync database to disk
2052 cf::db_sync;
2053 IO::AIO::flush;
2054
2055 # get rid of safe::, as good as possible 2819 warn "getting rid of safe::, as good as possible";
2056 Symbol::delete_package "safe::$_" 2820 Symbol::delete_package "safe::$_"
2057 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2821 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2058 2822
2059 # remove register_script_function callbacks
2060 # TODO
2061
2062 # unload cf.pm "a bit" 2823 warn "unloading cf.pm \"a bit\"";
2063 delete $INC{"cf.pm"}; 2824 delete $INC{"cf.pm"};
2825 delete $INC{"cf/pod.pm"};
2064 2826
2065 # don't, removes xs symbols, too, 2827 # don't, removes xs symbols, too,
2066 # and global variables created in xs 2828 # and global variables created in xs
2067 #Symbol::delete_package __PACKAGE__; 2829 #Symbol::delete_package __PACKAGE__;
2068 2830
2069 # reload cf.pm 2831 warn "unload completed, starting to reload now";
2832
2070 warn "reloading cf.pm"; 2833 warn "reloading cf.pm";
2071 require cf; 2834 require cf;
2072 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2835 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2073 2836
2074 # load config and database again 2837 warn "loading config and database again";
2075 cf::cfg_load; 2838 cf::cfg_load;
2076 cf::db_load;
2077 2839
2078 # load extensions
2079 warn "load extensions"; 2840 warn "loading extensions";
2080 cf::load_extensions; 2841 cf::load_extensions;
2081 2842
2082 # reattach attachments to objects 2843 warn "reattaching attachments to objects/players";
2083 warn "reattach"; 2844 _global_reattach; # objects, sockets
2084 _global_reattach; 2845 warn "reattaching attachments to maps";
2085 }; 2846 reattach $_ for values %MAP;
2847 warn "reattaching attachments to players";
2848 reattach $_ for values %PLAYER;
2086 2849
2087 if ($@) { 2850 warn "leaving sync_job";
2851
2852 1
2853 } or do {
2088 warn $@; 2854 warn $@;
2089 warn "error while reloading, exiting."; 2855 warn "error while reloading, exiting.";
2090 exit 1; 2856 exit 1;
2091 } 2857 };
2092 2858
2093 warn "reloaded successfully"; 2859 warn "reloaded";
2094}; 2860};
2095 2861
2096############################################################################# 2862our $RELOAD_WATCHER; # used only during reload
2097 2863
2098unless ($LINK_MAP) { 2864sub reload_perl() {
2099 $LINK_MAP = cf::map::new; 2865 # doing reload synchronously and two reloads happen back-to-back,
2866 # coro crashes during coro_state_free->destroy here.
2100 2867
2101 $LINK_MAP->width (41); 2868 $RELOAD_WATCHER ||= Event->timer (
2102 $LINK_MAP->height (41); 2869 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, 2870 after => 0,
2871 data => WF_AUTOCANCEL,
2111 cb => sub { 2872 cb => sub {
2112 $_[0]->w->cancel; 2873 do_reload_perl;
2113 2874 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 }); 2875 },
2132 2876 );
2133 $LINK_MAP->{deny_save} = 1;
2134 $LINK_MAP->{deny_reset} = 1;
2135
2136 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2137} 2877}
2138
2139register "<global>", __PACKAGE__;
2140 2878
2141register_command "reload" => sub { 2879register_command "reload" => sub {
2142 my ($who, $arg) = @_; 2880 my ($who, $arg) = @_;
2143 2881
2144 if ($who->flag (FLAG_WIZ)) { 2882 if ($who->flag (FLAG_WIZ)) {
2145 $who->message ("start of reload.");
2146 reload;
2147 $who->message ("end of reload."); 2883 $who->message ("reloading server.");
2884 async { reload_perl };
2148 } 2885 }
2149}; 2886};
2150 2887
2151unshift @INC, $LIBDIR; 2888unshift @INC, $LIBDIR;
2152 2889
2890my $bug_warning = 0;
2891
2892our @WAIT_FOR_TICK;
2893our @WAIT_FOR_TICK_BEGIN;
2894
2895sub wait_for_tick {
2896 return unless $TICK_WATCHER->is_active;
2897 return if $Coro::current == $Coro::main;
2898
2899 my $signal = new Coro::Signal;
2900 push @WAIT_FOR_TICK, $signal;
2901 $signal->wait;
2902}
2903
2904sub wait_for_tick_begin {
2905 return unless $TICK_WATCHER->is_active;
2906 return if $Coro::current == $Coro::main;
2907
2908 my $signal = new Coro::Signal;
2909 push @WAIT_FOR_TICK_BEGIN, $signal;
2910 $signal->wait;
2911}
2912
2913 my $min = 1e6;#d#
2914 my $avg = 10;
2153$TICK_WATCHER = Event->timer ( 2915$TICK_WATCHER = Event->timer (
2154 reentrant => 0, 2916 reentrant => 0,
2917 parked => 1,
2155 prio => 0, 2918 prio => 0,
2156 at => $NEXT_TICK || $TICK, 2919 at => $NEXT_TICK || $TICK,
2157 data => WF_AUTOCANCEL, 2920 data => WF_AUTOCANCEL,
2158 cb => sub { 2921 cb => sub {
2159 unless ($FREEZE) { 2922 if ($Coro::current != $Coro::main) {
2923 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2924 unless ++$bug_warning > 10;
2925 return;
2926 }
2927
2928 $NOW = $tick_start = Event::time;
2929
2160 cf::server_tick; # one server iteration 2930 cf::server_tick; # one server iteration
2161 $RUNTIME += $TICK; 2931
2932 0 && sync_job {#d#
2933 for(1..10) {
2934 my $t = Event::time;
2935 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2936 or die;
2937
2938 $map->width (50);
2939 $map->height (50);
2940 $map->alloc;
2941 $map->_load_objects ("/tmp/x.map", 1);
2942 my $t = Event::time - $t;
2943
2944 #next unless $t < 0.0013;#d#
2945 if ($t < $min) {
2946 $min = $t;
2947 }
2948 $avg = $avg * 0.99 + $t * 0.01;
2949 }
2950 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2951 exit 0;
2952 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2162 } 2953 };
2163 2954
2955 $RUNTIME += $TICK;
2164 $NEXT_TICK += $TICK; 2956 $NEXT_TICK += $TICK;
2165 2957
2958 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2959 $NEXT_RUNTIME_WRITE = $NOW + 10;
2960 Coro::async_pool {
2961 write_runtime
2962 or warn "ERROR: unable to write runtime file: $!";
2963 };
2964 }
2965
2966# my $AFTER = Event::time;
2967# warn $AFTER - $NOW;#d#
2968
2969 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2970 $sig->send;
2971 }
2972 while (my $sig = shift @WAIT_FOR_TICK) {
2973 $sig->send;
2974 }
2975
2976 $NOW = Event::time;
2977
2166 # if we are delayed by four ticks or more, skip them all 2978 # if we are delayed by four ticks or more, skip them all
2167 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2979 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2168 2980
2169 $TICK_WATCHER->at ($NEXT_TICK); 2981 $TICK_WATCHER->at ($NEXT_TICK);
2170 $TICK_WATCHER->start; 2982 $TICK_WATCHER->start;
2983
2984 $LOAD = ($NOW - $tick_start) / $TICK;
2985 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2986
2987 _post_tick;
2988
2989
2171 }, 2990 },
2172); 2991);
2173 2992
2993{
2174IO::AIO::max_poll_time $TICK * 0.2; 2994 BDB::max_poll_time $TICK * 0.1;
2175 2995 $BDB_POLL_WATCHER = Event->io (
2176Event->io ( 2996 reentrant => 0,
2177 fd => IO::AIO::poll_fileno, 2997 fd => BDB::poll_fileno,
2178 poll => 'r', 2998 poll => 'r',
2179 prio => 5, 2999 prio => 0,
2180 data => WF_AUTOCANCEL,
2181 cb => \&IO::AIO::poll_cb,
2182);
2183
2184Event->timer (
2185 data => WF_AUTOCANCEL, 3000 data => WF_AUTOCANCEL,
2186 after => 0, 3001 cb => \&BDB::poll_cb,
2187 interval => 10, 3002 );
2188 cb => sub { 3003 BDB::min_parallel 8;
2189 (Coro::unblock_sub { 3004
2190 write_runtime 3005 BDB::set_sync_prepare {
2191 or warn "ERROR: unable to write runtime file: $!"; 3006 my $status;
3007 my $current = $Coro::current;
3008 (
3009 sub {
3010 $status = $!;
3011 $current->ready; undef $current;
3012 },
3013 sub {
3014 Coro::schedule while defined $current;
3015 $! = $status;
3016 },
3017 )
3018 };
3019
3020 unless ($DB_ENV) {
3021 $DB_ENV = BDB::db_env_create;
3022
3023 cf::sync_job {
3024 eval {
3025 BDB::db_env_open
3026 $DB_ENV,
3027 $BDBDIR,
3028 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3029 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3030 0666;
3031
3032 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3033
3034 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3035 $DB_ENV->set_lk_detect;
3036 };
3037
3038 cf::cleanup "db_env_open(db): $@" if $@;
2192 })->(); 3039 };
2193 }, 3040 }
2194); 3041}
3042
3043{
3044 IO::AIO::min_parallel 8;
3045
3046 undef $Coro::AIO::WATCHER;
3047 IO::AIO::max_poll_time $TICK * 0.1;
3048 $AIO_POLL_WATCHER = Event->io (
3049 reentrant => 0,
3050 data => WF_AUTOCANCEL,
3051 fd => IO::AIO::poll_fileno,
3052 poll => 'r',
3053 prio => 6,
3054 cb => \&IO::AIO::poll_cb,
3055 );
3056}
3057
3058my $_log_backtrace;
3059
3060sub _log_backtrace {
3061 my ($msg, @addr) = @_;
3062
3063 $msg =~ s/\n//;
3064
3065 # limit the # of concurrent backtraces
3066 if ($_log_backtrace < 2) {
3067 ++$_log_backtrace;
3068 async {
3069 my @bt = fork_call {
3070 @addr = map { sprintf "%x", $_ } @addr;
3071 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3072 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3073 or die "addr2line: $!";
3074
3075 my @funcs;
3076 my @res = <$fh>;
3077 chomp for @res;
3078 while (@res) {
3079 my ($func, $line) = splice @res, 0, 2, ();
3080 push @funcs, "[$func] $line";
3081 }
3082
3083 @funcs
3084 };
3085
3086 LOG llevInfo, "[ABT] $msg\n";
3087 LOG llevInfo, "[ABT] $_\n" for @bt;
3088 --$_log_backtrace;
3089 };
3090 } else {
3091 LOG llevInfo, "[ABT] $msg\n";
3092 LOG llevInfo, "[ABT] [suppressed]\n";
3093 }
3094}
3095
3096# load additional modules
3097use cf::pod;
2195 3098
2196END { cf::emergency_save } 3099END { cf::emergency_save }
2197 3100
21981 31011
2199 3102

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines