ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.120 by root, Tue Jan 2 11:08:36 2007 UTC vs.
Revision 1.282 by elmex, Tue Jun 19 18:15:34 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 {
1156 my ($change) = @_; 1575 my ($change) = @_;
1157 1576
1158 $_->change_map_light ($change) for values %cf::MAP; 1577 $_->change_map_light ($change)
1578 for grep $_->outdoor, values %cf::MAP;
1159} 1579}
1160 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
1161sub try_load_header($) { 1597sub load_header_from($) {
1162 my ($path) = @_; 1598 my ($self, $path) = @_;
1163 1599
1164 utf8::encode $path; 1600 utf8::encode $path;
1165 aio_open $path, O_RDONLY, 0 1601 #aio_open $path, O_RDONLY, 0
1602 # or return;
1603
1604 $self->_load_header ($path)
1166 or return; 1605 or return;
1167 1606
1168 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
1169 or return; 1650 or return;
1651 $self->prepare_orig;
1652 }
1170 1653
1171 $map->load_header ($path) 1654 $self->{deny_reset} = 1
1172 or return; 1655 if $self->no_reset;
1173 1656
1174 $map->{load_path} = $path; 1657 $self->default_region (cf::region::find_by_path $self->{path})
1658 unless $self->default_region;
1175 1659
1176 $map 1660 1
1177} 1661}
1178 1662
1663sub find;
1179sub find_map { 1664sub find {
1180 my ($path, $origin) = @_; 1665 my ($path, $origin) = @_;
1181 1666
1182 #warn "find_map<$path,$origin>\n";#d#
1183
1184 $path = new cf::path $path, $origin && $origin->path; 1667 $path = normalise $path, $origin && $origin->path;
1185 my $key = $path->as_string;
1186 1668
1187 cf::lock_wait "map_find:$key"; 1669 cf::lock_wait "map_find:$path";
1188 1670
1189 $cf::MAP{$key} || do { 1671 $cf::MAP{$path} || do {
1190 my $guard = cf::lock_acquire "map_find:$key"; 1672 my $guard = cf::lock_acquire "map_find:$path";
1191 1673 my $map = new_from_path cf::map $path
1192 # do it the slow way
1193 my $map = try_load_header $path->save_path;
1194
1195 if ($map) {
1196 # safety
1197 $map->{instantiate_time} = $cf::RUNTIME
1198 if $map->{instantiate_time} > $cf::RUNTIME;
1199 } else {
1200 if (my $rmp = $path->random_map_params) {
1201 $map = generate_random_map $key, $rmp;
1202 } else {
1203 $map = try_load_header $path->load_path;
1204 }
1205
1206 $map or return; 1674 or return;
1207 1675
1208 $map->{load_original} = 1;
1209 $map->{instantiate_time} = $cf::RUNTIME;
1210 $map->instantiate;
1211
1212 # per-player maps become, after loading, normal maps
1213 $map->per_player (0) if $path->{user_rel};
1214 }
1215 #Coro::Timer::sleep 1;#d#
1216
1217 $map->path ($key);
1218 $map->{path} = $path;
1219 $map->{last_save} = $cf::RUNTIME; 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 $map = find_map $path; 1685 undef $guard;
1686 return find $path;
1225 } 1687 }
1226 1688
1227 $cf::MAP{$key} = $map 1689 $cf::MAP{$path} = $map
1228 } 1690 }
1229} 1691}
1692
1693sub pre_load { }
1694sub post_load { }
1230 1695
1231sub load { 1696sub load {
1232 my ($self) = @_; 1697 my ($self) = @_;
1233 1698
1699 local $self->{deny_reset} = 1; # loading can take a long time
1700
1234 my $path = $self->{path}; 1701 my $path = $self->{path};
1702
1703 {
1235 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1704 my $guard = cf::lock_acquire "map_load:$path";
1236 1705
1237 return if $self->in_memory != cf::MAP_SWAPPED; 1706 return if $self->in_memory != cf::MAP_SWAPPED;
1238 1707
1239 $self->in_memory (cf::MAP_LOADING); 1708 $self->in_memory (cf::MAP_LOADING);
1240 1709
1241 $self->alloc; 1710 $self->alloc;
1711
1712 $self->pre_load;
1713 Coro::cede;
1714
1242 $self->load_objects ($self->{load_path}, 1) 1715 $self->_load_objects ($self->{load_path}, 1)
1243 or return; 1716 or return;
1244 1717
1245 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1718 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1246 if delete $self->{load_original}; 1719 if delete $self->{load_original};
1247 1720
1248 if (my $uniq = $path->uniq_path) { 1721 if (my $uniq = $self->uniq_path) {
1249 utf8::encode $uniq; 1722 utf8::encode $uniq;
1250 if (aio_open $uniq, O_RDONLY, 0) { 1723 if (aio_open $uniq, O_RDONLY, 0) {
1251 $self->clear_unique_items; 1724 $self->clear_unique_items;
1252 $self->load_objects ($uniq, 0); 1725 $self->_load_objects ($uniq, 0);
1253 } 1726 }
1254 } 1727 }
1255 1728
1729 Coro::cede;
1256 # now do the right thing for maps 1730 # now do the right thing for maps
1257 $self->link_multipart_objects; 1731 $self->link_multipart_objects;
1258
1259 if ($self->{path}->is_style_map) {
1260 $self->{deny_save} = 1;
1261 $self->{deny_reset} = 1;
1262 } else {
1263 $self->fix_auto_apply;
1264 $self->decay_objects;
1265 $self->update_buttons;
1266 $self->set_darkness_map;
1267 $self->difficulty ($self->estimate_difficulty) 1732 $self->difficulty ($self->estimate_difficulty)
1268 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;
1269 $self->activate; 1743 $self->activate;
1270 } 1744 }
1271 1745
1272 $self->in_memory (cf::MAP_IN_MEMORY); 1746 $self->in_memory (cf::MAP_IN_MEMORY);
1273} 1747 }
1274 1748
1275sub 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 {
1276 my ($path, $origin) = @_; 1789 my ($path, $origin) = @_;
1277 1790
1278 #warn "load_map_sync<$path, $origin>\n";#d# 1791 cf::sync_job { find $path, $origin }
1792}
1279 1793
1280 cf::sync_job { 1794sub do_load_sync {
1281 my $map = cf::map::find_map $path, $origin 1795 my ($map) = @_;
1282 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;
1283 $map->load; 1818 $map->load;
1284 $map 1819
1820 delete $MAP_PREFETCH{$path};
1821 }
1822 }
1823 undef $MAP_PREFETCHER;
1285 } 1824 };
1825 $MAP_PREFETCHER->prio (6);
1826
1827 ()
1286} 1828}
1287 1829
1288sub save { 1830sub save {
1289 my ($self) = @_; 1831 my ($self) = @_;
1290 1832
1833 my $lock = cf::lock_acquire "map_data:" . $self->path;
1834
1291 $self->{last_save} = $cf::RUNTIME; 1835 $self->{last_save} = $cf::RUNTIME;
1292 1836
1293 return unless $self->dirty; 1837 return unless $self->dirty;
1294 1838
1295 my $save = $self->{path}->save_path; utf8::encode $save; 1839 my $save = $self->save_path; utf8::encode $save;
1296 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 1840 my $uniq = $self->uniq_path; utf8::encode $uniq;
1297 1841
1298 $self->{load_path} = $save; 1842 $self->{load_path} = $save;
1299 1843
1300 return if $self->{deny_save}; 1844 return if $self->{deny_save};
1301 1845
1846 local $self->{last_access} = $self->last_access;#d#
1847
1848 cf::async {
1849 $_->contr->save for $self->players;
1850 };
1851
1302 if ($uniq) { 1852 if ($uniq) {
1303 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 1853 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1304 $self->save_objects ($uniq, cf::IO_UNIQUES); 1854 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1305 } else { 1855 } else {
1306 $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);
1307 } 1857 }
1308} 1858}
1309 1859
1310sub swap_out { 1860sub swap_out {
1311 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;
1312 1867
1313 return if $self->players; 1868 return if $self->players;
1314 return if $self->in_memory != cf::MAP_IN_MEMORY; 1869 return if $self->in_memory != cf::MAP_IN_MEMORY;
1315 return if $self->{deny_save}; 1870 return if $self->{deny_save};
1316 1871
1317 $self->save;
1318 $self->clear; 1872 $self->clear;
1319 $self->in_memory (cf::MAP_SWAPPED); 1873 $self->in_memory (cf::MAP_SWAPPED);
1320} 1874}
1321 1875
1322sub reset_at { 1876sub reset_at {
1323 my ($self) = @_; 1877 my ($self) = @_;
1324 1878
1325 # TODO: safety, remove and allow resettable per-player maps 1879 # TODO: safety, remove and allow resettable per-player maps
1326 return 1e99 if $self->{path}{user_rel};
1327 return 1e99 if $self->{deny_reset}; 1880 return 1e99 if $self->{deny_reset};
1328 1881
1329 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1882 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1330 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;
1331 1884
1336 my ($self) = @_; 1889 my ($self) = @_;
1337 1890
1338 $self->reset_at <= $cf::RUNTIME 1891 $self->reset_at <= $cf::RUNTIME
1339} 1892}
1340 1893
1341sub unlink_save {
1342 my ($self) = @_;
1343
1344 utf8::encode (my $save = $self->{path}->save_path);
1345 aioreq_pri 3; IO::AIO::aio_unlink $save;
1346 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1347}
1348
1349sub rename {
1350 my ($self, $new_path) = @_;
1351
1352 $self->unlink_save;
1353
1354 delete $cf::MAP{$self->path};
1355 $self->{path} = new cf::path $new_path;
1356 $self->path ($self->{path}->as_string);
1357 $cf::MAP{$self->path} = $self;
1358
1359 $self->save;
1360}
1361
1362sub reset { 1894sub reset {
1363 my ($self) = @_; 1895 my ($self) = @_;
1364 1896
1897 my $lock = cf::lock_acquire "map_data:$self->{path}";
1898
1365 return if $self->players; 1899 return if $self->players;
1366 return if $self->{path}{user_rel};#d#
1367 1900
1368 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 }
1369 1912
1370 delete $cf::MAP{$self->path}; 1913 delete $cf::MAP{$self->path};
1914
1915 $self->clear;
1371 1916
1372 $_->clear_links_to ($self) for values %cf::MAP; 1917 $_->clear_links_to ($self) for values %cf::MAP;
1373 1918
1374 $self->unlink_save; 1919 $self->unlink_save;
1375 $self->destroy; 1920 $self->destroy;
1378my $nuke_counter = "aaaa"; 1923my $nuke_counter = "aaaa";
1379 1924
1380sub nuke { 1925sub nuke {
1381 my ($self) = @_; 1926 my ($self) = @_;
1382 1927
1928 delete $cf::MAP{$self->path};
1929
1930 $self->unlink_save;
1931
1932 bless $self, "cf::map";
1933 delete $self->{deny_reset};
1383 $self->{deny_save} = 1; 1934 $self->{deny_save} = 1;
1384 $self->reset_timeout (1); 1935 $self->reset_timeout (1);
1385 $self->rename ("{nuke}/" . ($nuke_counter++)); 1936 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1937
1938 $cf::MAP{$self->path} = $self;
1939
1386 $self->reset; # polite request, might not happen 1940 $self->reset; # polite request, might not happen
1387} 1941}
1388 1942
1389sub customise_for { 1943=item $maps = cf::map::tmp_maps
1390 my ($map, $ob) = @_;
1391 1944
1392 if ($map->per_player) { 1945Returns an arrayref with all map paths of currently instantiated and saved
1393 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path}; 1946maps. May block.
1947
1948=cut
1949
1950sub tmp_maps() {
1394 } 1951 [
1395 1952 map {
1396 $map 1953 utf8::decode $_;
1954 /\.map$/
1955 ? normalise $_
1956 : ()
1957 } @{ aio_readdir $TMPDIR or [] }
1958 ]
1397} 1959}
1398 1960
1399sub emergency_save { 1961=item $maps = cf::map::random_maps
1400 local $cf::FREEZE = 1;
1401 1962
1402 warn "enter emergency map save\n"; 1963Returns an arrayref with all map paths of currently instantiated and saved
1964random maps. May block.
1403 1965
1404 cf::sync_job { 1966=cut
1405 warn "begin emergency map save\n";
1406 $_->save for values %cf::MAP;
1407 };
1408 1967
1409 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 ]
1410} 1995}
1411 1996
1412package cf; 1997package cf;
1413 1998
1414=back 1999=back
1415 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
1416 2027
1417=head3 cf::object::player 2028=head3 cf::object::player
1418 2029
1419=over 4 2030=over 4
1420 2031
1434 2045
1435 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2046 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1436 2047
1437 if ($self->{record_replies}) { 2048 if ($self->{record_replies}) {
1438 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2049 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2050
1439 } else { 2051 } else {
2052 my $pl = $self->contr;
2053
2054 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2055 my $diag = $pl->{npc_dialog};
2056 $diag->{pl}->ext_reply (
2057 $diag->{id}, msgtype => "reply", msg => $msg, add_topics => []
2058 );
2059
2060 } else {
1440 $msg = $npc->name . " says: $msg" if $npc; 2061 $msg = $npc->name . " says: $msg" if $npc;
1441 $self->message ($msg, $flags); 2062 $self->message ($msg, $flags);
2063 }
1442 } 2064 }
1443} 2065}
1444 2066
1445=item $player_object->may ("access") 2067=item $player_object->may ("access")
1446 2068
1460 2082
1461=item $player_object->enter_link 2083=item $player_object->enter_link
1462 2084
1463Freezes the player and moves him/her to a special map (C<{link}>). 2085Freezes the player and moves him/her to a special map (C<{link}>).
1464 2086
1465The player should be reaosnably safe there for short amounts of time. You 2087The player should be reasonably safe there for short amounts of time. You
1466I<MUST> call C<leave_link> as soon as possible, though. 2088I<MUST> call C<leave_link> as soon as possible, though.
1467 2089
2090Will never block.
2091
1468=item $player_object->leave_link ($map, $x, $y) 2092=item $player_object->leave_link ($map, $x, $y)
1469 2093
1470Moves the player out of the specila link map onto the given map. If the 2094Moves the player out of the special C<{link}> map onto the specified
1471map is not valid (or omitted), the player will be moved back to the 2095map. If the map is not valid (or omitted), the player will be moved back
1472location he/she was before the call to C<enter_link>, or, if that fails, 2096to the location he/she was before the call to C<enter_link>, or, if that
1473to the emergency map position. 2097fails, to the emergency map position.
1474 2098
1475Might block. 2099Might block.
1476 2100
1477=cut 2101=cut
2102
2103sub link_map {
2104 unless ($LINK_MAP) {
2105 $LINK_MAP = cf::map::find "{link}"
2106 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
2107 $LINK_MAP->load;
2108 }
2109
2110 $LINK_MAP
2111}
1478 2112
1479sub cf::object::player::enter_link { 2113sub cf::object::player::enter_link {
1480 my ($self) = @_; 2114 my ($self) = @_;
1481 2115
1482 $self->deactivate_recursive; 2116 $self->deactivate_recursive;
1483 2117
1484 return if $self->map == $LINK_MAP; 2118 return if UNIVERSAL::isa $self->map, "ext::map_link";
1485 2119
1486 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2120 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1487 if $self->map; 2121 if $self->map && $self->map->{path} ne "{link}";
1488 2122
1489 $self->enter_map ($LINK_MAP, 20, 20); 2123 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1490} 2124}
1491 2125
1492sub cf::object::player::leave_link { 2126sub cf::object::player::leave_link {
1493 my ($self, $map, $x, $y) = @_; 2127 my ($self, $map, $x, $y) = @_;
2128
2129 return unless $self->contr->active;
1494 2130
1495 my $link_pos = delete $self->{_link_pos}; 2131 my $link_pos = delete $self->{_link_pos};
1496 2132
1497 unless ($map) { 2133 unless ($map) {
1498 # restore original map position 2134 # restore original map position
1499 ($map, $x, $y) = @{ $link_pos || [] }; 2135 ($map, $x, $y) = @{ $link_pos || [] };
1500 $map = cf::map::find_map $map; 2136 $map = cf::map::find $map;
1501 2137
1502 unless ($map) { 2138 unless ($map) {
1503 ($map, $x, $y) = @$EMERGENCY_POSITION; 2139 ($map, $x, $y) = @$EMERGENCY_POSITION;
1504 $map = cf::map::find_map $map 2140 $map = cf::map::find $map
1505 or die "FATAL: cannot load emergency map\n"; 2141 or die "FATAL: cannot load emergency map\n";
1506 } 2142 }
1507 } 2143 }
1508 2144
1509 ($x, $y) = (-1, -1) 2145 ($x, $y) = (-1, -1)
1512 # use -1 or undef as default coordinates, not 0, 0 2148 # use -1 or undef as default coordinates, not 0, 0
1513 ($x, $y) = ($map->enter_x, $map->enter_y) 2149 ($x, $y) = ($map->enter_x, $map->enter_y)
1514 if $x <=0 && $y <= 0; 2150 if $x <=0 && $y <= 0;
1515 2151
1516 $map->load; 2152 $map->load;
2153 $map->load_diag;
1517 2154
2155 return unless $self->contr->active;
1518 $self->activate_recursive; 2156 $self->activate_recursive;
2157
2158 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1519 $self->enter_map ($map, $x, $y); 2159 $self->enter_map ($map, $x, $y);
1520} 2160}
1521 2161
1522cf::player->attach (
1523 on_logout => sub {
1524 my ($pl) = @_;
1525
1526 # abort map switching before logout
1527 if ($pl->ob->{_link_pos}) {
1528 cf::sync_job {
1529 $pl->ob->leave_link
1530 };
1531 }
1532 },
1533 on_login => sub {
1534 my ($pl) = @_;
1535
1536 # try to abort aborted map switching on player login :)
1537 # should happen only on crashes
1538 if ($pl->ob->{_link_pos}) {
1539 $pl->ob->enter_link;
1540 Coro::async {
1541 # we need this sleep as the login has a concurrent enter_exit running
1542 # and this sleep increases chances of the player not ending up in scorn
1543 Coro::Timer::sleep 1;
1544 $pl->ob->leave_link;
1545 };
1546 }
1547 },
1548);
1549
1550=item $player_object->goto_map ($path, $x, $y) 2162=item $player_object->goto ($path, $x, $y[, $check->($map)])
1551 2163
1552=cut 2164Moves the player to the given map-path and coordinates by first freezing
2165her, loading and preparing them map, calling the provided $check callback
2166that has to return the map if sucecssful, and then unfreezes the player on
2167the new (success) or old (failed) map position.
1553 2168
2169=cut
2170
2171our $GOTOGEN;
2172
1554sub cf::object::player::goto_map { 2173sub cf::object::player::goto {
1555 my ($self, $path, $x, $y) = @_; 2174 my ($self, $path, $x, $y, $check) = @_;
2175
2176 # do generation counting so two concurrent goto's will be executed in-order
2177 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1556 2178
1557 $self->enter_link; 2179 $self->enter_link;
1558 2180
1559 (Coro::async { 2181 (async {
1560 $path = new cf::path $path; 2182 my $map = eval {
1561
1562 my $map = cf::map::find_map $path->as_string; 2183 my $map = cf::map::find $path;
2184
2185 if ($map) {
1563 $map = $map->customise_for ($self) if $map; 2186 $map = $map->customise_for ($self);
1564 2187 $map = $check->($map) if $check && $map;
1565# warn "entering ", $map->path, " at ($x, $y)\n" 2188 } else {
1566# if $map;
1567
1568 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2189 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2190 }
1569 2191
2192 $map
2193 };
2194
2195 if ($@) {
2196 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2197 LOG llevError | logBacktrace, Carp::longmess $@;
2198 }
2199
2200 if ($gen == $self->{_goto_generation}) {
2201 delete $self->{_goto_generation};
1570 $self->leave_link ($map, $x, $y); 2202 $self->leave_link ($map, $x, $y);
2203 }
1571 })->prio (1); 2204 })->prio (1);
1572} 2205}
1573 2206
1574=item $player_object->enter_exit ($exit_object) 2207=item $player_object->enter_exit ($exit_object)
1575 2208
1577 2210
1578sub parse_random_map_params { 2211sub parse_random_map_params {
1579 my ($spec) = @_; 2212 my ($spec) = @_;
1580 2213
1581 my $rmp = { # defaults 2214 my $rmp = { # defaults
1582 xsize => 10, 2215 xsize => (cf::rndm 15, 40),
1583 ysize => 10, 2216 ysize => (cf::rndm 15, 40),
2217 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2218 #layout => string,
1584 }; 2219 };
1585 2220
1586 for (split /\n/, $spec) { 2221 for (split /\n/, $spec) {
1587 my ($k, $v) = split /\s+/, $_, 2; 2222 my ($k, $v) = split /\s+/, $_, 2;
1588 2223
1592 $rmp 2227 $rmp
1593} 2228}
1594 2229
1595sub prepare_random_map { 2230sub prepare_random_map {
1596 my ($exit) = @_; 2231 my ($exit) = @_;
2232
2233 my $guard = cf::lock_acquire "exit_prepare:$exit";
1597 2234
1598 # all this does is basically replace the /! path by 2235 # all this does is basically replace the /! path by
1599 # a new random map path (?random/...) with a seed 2236 # a new random map path (?random/...) with a seed
1600 # that depends on the exit object 2237 # that depends on the exit object
1601 2238
1602 my $rmp = parse_random_map_params $exit->msg; 2239 my $rmp = parse_random_map_params $exit->msg;
1603 2240
1604 if ($exit->map) { 2241 if ($exit->map) {
1605 $rmp->{region} = $exit->map->region_name; 2242 $rmp->{region} = $exit->region->name;
1606 $rmp->{origin_map} = $exit->map->path; 2243 $rmp->{origin_map} = $exit->map->path;
1607 $rmp->{origin_x} = $exit->x; 2244 $rmp->{origin_x} = $exit->x;
1608 $rmp->{origin_y} = $exit->y; 2245 $rmp->{origin_y} = $exit->y;
1609 } 2246 }
1610 2247
1611 $rmp->{random_seed} ||= $exit->random_seed; 2248 $rmp->{random_seed} ||= $exit->random_seed;
1612 2249
1613 my $data = cf::to_json $rmp; 2250 my $data = cf::to_json $rmp;
1614 my $md5 = Digest::MD5::md5_hex $data; 2251 my $md5 = Digest::MD5::md5_hex $data;
2252 my $meta = "$RANDOMDIR/$md5.meta";
1615 2253
1616 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2254 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1617 aio_write $fh, 0, (length $data), $data, 0; 2255 aio_write $fh, 0, (length $data), $data, 0;
2256 undef $fh;
2257 aio_rename "$meta~", $meta;
1618 2258
1619 $exit->slaying ("?random/$md5"); 2259 $exit->slaying ("?random/$md5");
1620 $exit->msg (undef); 2260 $exit->msg (undef);
1621 } 2261 }
1622} 2262}
1624sub cf::object::player::enter_exit { 2264sub cf::object::player::enter_exit {
1625 my ($self, $exit) = @_; 2265 my ($self, $exit) = @_;
1626 2266
1627 return unless $self->type == cf::PLAYER; 2267 return unless $self->type == cf::PLAYER;
1628 2268
2269 if ($exit->slaying eq "/!") {
2270 #TODO: this should de-fi-ni-te-ly not be a sync-job
2271 # the problem is that $exit might not survive long enough
2272 # so it needs to be done right now, right here
2273 cf::sync_job { prepare_random_map $exit };
2274 }
2275
2276 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2277 my $hp = $exit->stats->hp;
2278 my $sp = $exit->stats->sp;
2279
1629 $self->enter_link; 2280 $self->enter_link;
1630 2281
1631 (Coro::async { 2282 (async {
2283 $self->deactivate_recursive; # just to be sure
1632 unless (eval { 2284 unless (eval {
1633 2285 $self->goto ($slaying, $hp, $sp);
1634 prepare_random_map $exit
1635 if $exit->slaying eq "/!";
1636
1637 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1638 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1639 2286
1640 1; 2287 1;
1641 }) { 2288 }) {
1642 $self->message ("Something went wrong deep within the crossfire server. " 2289 $self->message ("Something went wrong deep within the crossfire server. "
1643 . "I'll try to bring you back to the map you were before. " 2290 . "I'll try to bring you back to the map you were before. "
1644 . "Please report this to the dungeon master", 2291 . "Please report this to the dungeon master!",
1645 cf::NDI_UNIQUE | cf::NDI_RED); 2292 cf::NDI_UNIQUE | cf::NDI_RED);
1646 2293
1647 warn "ERROR in enter_exit: $@"; 2294 warn "ERROR in enter_exit: $@";
1648 $self->leave_link; 2295 $self->leave_link;
1649 } 2296 }
1650 })->prio (1); 2297 })->prio (1);
1663 2310
1664sub cf::client::send_drawinfo { 2311sub cf::client::send_drawinfo {
1665 my ($self, $text, $flags) = @_; 2312 my ($self, $text, $flags) = @_;
1666 2313
1667 utf8::encode $text; 2314 utf8::encode $text;
1668 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2315 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1669} 2316}
1670 2317
2318=item $client->ext_event ($type, %msg)
2319
2320Sends an exti event to the client.
2321
2322=cut
2323
2324sub cf::client::ext_event($$%) {
2325 my ($self, $type, %msg) = @_;
2326
2327 $msg{msgtype} = "event_$type";
2328 $self->send_packet ("ext " . cf::to_json \%msg);
2329}
1671 2330
1672=item $success = $client->query ($flags, "text", \&cb) 2331=item $success = $client->query ($flags, "text", \&cb)
1673 2332
1674Queues a query to the client, calling the given callback with 2333Queues a query to the client, calling the given callback with
1675the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2334the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1700 on_reply => sub { 2359 on_reply => sub {
1701 my ($ns, $msg) = @_; 2360 my ($ns, $msg) = @_;
1702 2361
1703 # this weird shuffling is so that direct followup queries 2362 # this weird shuffling is so that direct followup queries
1704 # get handled first 2363 # get handled first
1705 my $queue = delete $ns->{query_queue}; 2364 my $queue = delete $ns->{query_queue}
2365 or return; # be conservative, not sure how that can happen, but we saw a crash here
1706 2366
1707 (shift @$queue)->[1]->($msg); 2367 (shift @$queue)->[1]->($msg);
2368 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1708 2369
1709 push @{ $ns->{query_queue} }, @$queue; 2370 push @{ $ns->{query_queue} }, @$queue;
1710 2371
1711 if (@{ $ns->{query_queue} } == @$queue) { 2372 if (@{ $ns->{query_queue} } == @$queue) {
1712 if (@$queue) { 2373 if (@$queue) {
1716 } 2377 }
1717 } 2378 }
1718 }, 2379 },
1719); 2380);
1720 2381
1721=item $client->coro (\&cb) 2382=item $client->async (\&cb)
1722 2383
1723Create a new coroutine, running the specified callback. The coroutine will 2384Create a new coroutine, running the specified callback. The coroutine will
1724be automatically cancelled when the client gets destroyed (e.g. on logout, 2385be automatically cancelled when the client gets destroyed (e.g. on logout,
1725or loss of connection). 2386or loss of connection).
1726 2387
1727=cut 2388=cut
1728 2389
1729sub cf::client::coro { 2390sub cf::client::async {
1730 my ($self, $cb) = @_; 2391 my ($self, $cb) = @_;
1731 2392
1732 my $coro; $coro = async { 2393 my $coro = &Coro::async ($cb);
1733 eval {
1734 $cb->();
1735 };
1736 warn $@ if $@;
1737 };
1738 2394
1739 $coro->on_destroy (sub { 2395 $coro->on_destroy (sub {
1740 delete $self->{_coro}{$coro+0}; 2396 delete $self->{_coro}{$coro+0};
1741 }); 2397 });
1742 2398
1775 2431
1776# here we export the classes and methods available to script code 2432# here we export the classes and methods available to script code
1777 2433
1778=pod 2434=pod
1779 2435
1780The following fucntions and emthods are available within a safe environment: 2436The following functions and methods are available within a safe environment:
1781 2437
1782 cf::object contr pay_amount pay_player map 2438 cf::object contr pay_amount pay_player map
1783 cf::object::player player 2439 cf::object::player player
1784 cf::player peaceful 2440 cf::player peaceful
1785 cf::map trigger 2441 cf::map trigger
1866=back 2522=back
1867 2523
1868=cut 2524=cut
1869 2525
1870############################################################################# 2526#############################################################################
2527# the server's init and main functions
1871 2528
1872=head2 EXTENSION DATABASE SUPPORT 2529sub load_facedata($) {
2530 my ($path) = @_;
1873 2531
1874Crossfire maintains a very simple database for extension use. It can 2532 warn "loading facedata from $path\n";
1875currently store anything that can be serialised using Storable, which
1876excludes objects.
1877 2533
1878The parameter C<$family> should best start with the name of the extension 2534 my $facedata;
1879using it, it should be unique. 2535 0 < aio_load $path, $facedata
2536 or die "$path: $!";
1880 2537
1881=over 4 2538 $facedata = Coro::Storable::thaw $facedata;
1882 2539
1883=item $hashref = cf::db_get $family 2540 $facedata->{version} == 2
2541 or cf::cleanup "$path: version mismatch, cannot proceed.";
1884 2542
1885Return a hashref for use by the extension C<$family>, which can be
1886modified. After modifications, you have to call C<cf::db_dirty> or
1887C<cf::db_sync>.
1888
1889=item $value = cf::db_get $family => $key
1890
1891Returns a single value from the database
1892
1893=item cf::db_put $family => $hashref
1894
1895Stores the given family hashref into the database. Updates are delayed, if
1896you want the data to be synced to disk immediately, use C<cf::db_sync>.
1897
1898=item cf::db_put $family => $key => $value
1899
1900Stores the given C<$value> in the family hash. Updates are delayed, if you
1901want the data to be synced to disk immediately, use C<cf::db_sync>.
1902
1903=item cf::db_dirty
1904
1905Marks the database as dirty, to be updated at a later time.
1906
1907=item cf::db_sync
1908
1909Immediately write the database to disk I<if it is dirty>.
1910
1911=cut
1912
1913our $DB;
1914
1915{
1916 my $path = cf::localdir . "/database.pst";
1917
1918 sub db_load() {
1919 warn "loading database $path\n";#d# remove later
1920 $DB = stat $path ? Storable::retrieve $path : { };
1921 } 2543 {
2544 my $faces = $facedata->{faceinfo};
1922 2545
1923 my $pid; 2546 while (my ($face, $info) = each %$faces) {
1924 2547 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1925 sub db_save() { 2548 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
1926 warn "saving database $path\n";#d# remove later 2549 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
1927 waitpid $pid, 0 if $pid; 2550 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
1928 if (0 == ($pid = fork)) { 2551 Coro::cede;
1929 $DB->{_meta}{version} = 1;
1930 Storable::nstore $DB, "$path~";
1931 rename "$path~", $path;
1932 cf::_exit 0 if defined $pid;
1933 }
1934 }
1935
1936 my $dirty;
1937
1938 sub db_sync() {
1939 db_save if $dirty;
1940 undef $dirty;
1941 }
1942
1943 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1944 db_sync;
1945 });
1946
1947 sub db_dirty() {
1948 $dirty = 1;
1949 $idle->start;
1950 }
1951
1952 sub db_get($;$) {
1953 @_ >= 2
1954 ? $DB->{$_[0]}{$_[1]}
1955 : ($DB->{$_[0]} ||= { })
1956 }
1957
1958 sub db_put($$;$) {
1959 if (@_ >= 3) {
1960 $DB->{$_[0]}{$_[1]} = $_[2];
1961 } else {
1962 $DB->{$_[0]} = $_[1];
1963 }
1964 db_dirty;
1965 }
1966
1967 cf::global->attach (
1968 prio => 10000,
1969 on_cleanup => sub {
1970 db_sync;
1971 }, 2552 }
1972 );
1973}
1974 2553
1975############################################################################# 2554 while (my ($face, $info) = each %$faces) {
1976# the server's main() 2555 next unless $info->{smooth};
2556 my $idx = cf::face::find $face
2557 or next;
2558 if (my $smooth = cf::face::find $info->{smooth}) {
2559 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2560 } else {
2561 warn "smooth face '$info->{smooth}' not found for face '$face'";
2562 }
2563 Coro::cede;
2564 }
2565 }
2566
2567 {
2568 my $anims = $facedata->{animinfo};
2569
2570 while (my ($anim, $info) = each %$anims) {
2571 cf::anim::set $anim, $info->{frames}, $info->{facings};
2572 Coro::cede;
2573 }
2574
2575 cf::anim::invalidate_all; # d'oh
2576 }
2577
2578 1
2579}
2580
2581sub reload_regions {
2582 load_resource_file "$MAPDIR/regions"
2583 or die "unable to load regions file\n";
2584}
2585
2586sub reload_facedata {
2587 load_facedata "$DATADIR/facedata"
2588 or die "unable to load facedata\n";
2589}
2590
2591sub reload_archetypes {
2592 load_resource_file "$DATADIR/archetypes"
2593 or die "unable to load archetypes\n";
2594}
2595
2596sub reload_treasures {
2597 load_resource_file "$DATADIR/treasures"
2598 or die "unable to load treasurelists\n";
2599}
2600
2601sub reload_resources {
2602 warn "reloading resource files...\n";
2603
2604 reload_regions;
2605 reload_facedata;
2606 #reload_archetypes;#d#
2607 reload_archetypes;
2608 reload_treasures;
2609
2610 warn "finished reloading resource files\n";
2611}
2612
2613sub init {
2614 reload_resources;
2615}
1977 2616
1978sub cfg_load { 2617sub cfg_load {
1979 open my $fh, "<:utf8", cf::confdir . "/config" 2618 open my $fh, "<:utf8", "$CONFDIR/config"
1980 or return; 2619 or return;
1981 2620
1982 local $/; 2621 local $/;
1983 *CFG = YAML::Syck::Load <$fh>; 2622 *CFG = YAML::Syck::Load <$fh>;
2623
2624 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2625
2626 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2627 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2628
2629 if (exists $CFG{mlockall}) {
2630 eval {
2631 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2632 and die "WARNING: m(un)lockall failed: $!\n";
2633 };
2634 warn $@ if $@;
2635 }
1984} 2636}
1985 2637
1986sub main { 2638sub main {
1987 # we must not ever block the main coroutine 2639 # we must not ever block the main coroutine
1988 local $Coro::idle = sub { 2640 local $Coro::idle = sub {
1989 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2641 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1990 (Coro::unblock_sub { 2642 (async {
1991 Event::one_event; 2643 Event::one_event;
1992 })->(); 2644 })->prio (Coro::PRIO_MAX);
1993 }; 2645 };
1994 2646
1995 cfg_load; 2647 cfg_load;
1996 db_load; 2648 db_init;
1997 load_extensions; 2649 load_extensions;
2650
2651 $TICK_WATCHER->start;
1998 Event::loop; 2652 Event::loop;
1999} 2653}
2000 2654
2001############################################################################# 2655#############################################################################
2002# initialisation 2656# initialisation and cleanup
2003 2657
2658# install some emergency cleanup handlers
2659BEGIN {
2660 for my $signal (qw(INT HUP TERM)) {
2661 Event->signal (
2662 reentrant => 0,
2663 data => WF_AUTOCANCEL,
2664 signal => $signal,
2665 prio => 0,
2666 cb => sub {
2667 cf::cleanup "SIG$signal";
2668 },
2669 );
2670 }
2671}
2672
2673sub write_runtime {
2674 my $runtime = "$LOCALDIR/runtime";
2675
2676 # first touch the runtime file to show we are still running:
2677 # the fsync below can take a very very long time.
2678
2679 IO::AIO::aio_utime $runtime, undef, undef;
2680
2681 my $guard = cf::lock_acquire "write_runtime";
2682
2683 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2684 or return;
2685
2686 my $value = $cf::RUNTIME + 90 + 10;
2687 # 10 is the runtime save interval, for a monotonic clock
2688 # 60 allows for the watchdog to kill the server.
2689
2690 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2691 and return;
2692
2693 # always fsync - this file is important
2694 aio_fsync $fh
2695 and return;
2696
2697 # touch it again to show we are up-to-date
2698 aio_utime $fh, undef, undef;
2699
2700 close $fh
2701 or return;
2702
2703 aio_rename "$runtime~", $runtime
2704 and return;
2705
2706 warn "runtime file written.\n";
2707
2708 1
2709}
2710
2711sub emergency_save() {
2712 my $freeze_guard = cf::freeze_mainloop;
2713
2714 warn "enter emergency perl save\n";
2715
2716 cf::sync_job {
2717 # use a peculiar iteration method to avoid tripping on perl
2718 # refcount bugs in for. also avoids problems with players
2719 # and maps saved/destroyed asynchronously.
2720 warn "begin emergency player save\n";
2721 for my $login (keys %cf::PLAYER) {
2722 my $pl = $cf::PLAYER{$login} or next;
2723 $pl->valid or next;
2724 $pl->save;
2725 }
2726 warn "end emergency player save\n";
2727
2728 warn "begin emergency map save\n";
2729 for my $path (keys %cf::MAP) {
2730 my $map = $cf::MAP{$path} or next;
2731 $map->valid or next;
2732 $map->save;
2733 }
2734 warn "end emergency map save\n";
2735
2736 warn "begin emergency database checkpoint\n";
2737 BDB::db_env_txn_checkpoint $DB_ENV;
2738 warn "end emergency database checkpoint\n";
2739 };
2740
2741 warn "leave emergency perl save\n";
2742}
2743
2744sub post_cleanup {
2745 my ($make_core) = @_;
2746
2747 warn Carp::longmess "post_cleanup backtrace"
2748 if $make_core;
2749}
2750
2004sub reload() { 2751sub do_reload_perl() {
2005 # can/must only be called in main 2752 # can/must only be called in main
2006 if ($Coro::current != $Coro::main) { 2753 if ($Coro::current != $Coro::main) {
2007 warn "can only reload from main coroutine\n"; 2754 warn "can only reload from main coroutine";
2008 return; 2755 return;
2009 } 2756 }
2010 2757
2011 warn "reloading..."; 2758 warn "reloading...";
2012 2759
2013 local $FREEZE = 1; 2760 warn "entering sync_job";
2761
2762 cf::sync_job {
2763 cf::write_runtime; # external watchdog should not bark
2014 cf::emergency_save; 2764 cf::emergency_save;
2765 cf::write_runtime; # external watchdog should not bark
2015 2766
2016 eval { 2767 warn "syncing database to disk";
2768 BDB::db_env_txn_checkpoint $DB_ENV;
2769
2017 # if anything goes wrong in here, we should simply crash as we already saved 2770 # if anything goes wrong in here, we should simply crash as we already saved
2018 2771
2019 # cancel all watchers 2772 warn "cancelling all WF_AUTOCANCEL watchers";
2020 for (Event::all_watchers) { 2773 for (Event::all_watchers) {
2021 $_->cancel if $_->data & WF_AUTOCANCEL; 2774 $_->cancel if $_->data & WF_AUTOCANCEL;
2022 } 2775 }
2023 2776
2777 warn "flushing outstanding aio requests";
2778 for (;;) {
2779 BDB::flush;
2780 IO::AIO::flush;
2781 Coro::cede;
2782 last unless IO::AIO::nreqs || BDB::nreqs;
2783 warn "iterate...";
2784 }
2785
2786 ++$RELOAD;
2787
2024 # cancel all extension coros 2788 warn "cancelling all extension coros";
2025 $_->cancel for values %EXT_CORO; 2789 $_->cancel for values %EXT_CORO;
2026 %EXT_CORO = (); 2790 %EXT_CORO = ();
2027 2791
2028 # unload all extensions 2792 warn "removing commands";
2029 for (@exts) { 2793 %COMMAND = ();
2794
2795 warn "removing ext commands";
2796 %EXTCMD = ();
2797
2798 warn "unloading/nuking all extensions";
2799 for my $pkg (@EXTS) {
2030 warn "unloading <$_>"; 2800 warn "... unloading $pkg";
2031 unload_extension $_; 2801
2802 if (my $cb = $pkg->can ("unload")) {
2803 eval {
2804 $cb->($pkg);
2805 1
2806 } or warn "$pkg unloaded, but with errors: $@";
2032 } 2807 }
2033 2808
2809 warn "... nuking $pkg";
2810 Symbol::delete_package $pkg;
2811 }
2812
2034 # unload all modules loaded from $LIBDIR 2813 warn "unloading all perl modules loaded from $LIBDIR";
2035 while (my ($k, $v) = each %INC) { 2814 while (my ($k, $v) = each %INC) {
2036 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2815 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2037 2816
2038 warn "removing <$k>"; 2817 warn "... unloading $k";
2039 delete $INC{$k}; 2818 delete $INC{$k};
2040 2819
2041 $k =~ s/\.pm$//; 2820 $k =~ s/\.pm$//;
2042 $k =~ s/\//::/g; 2821 $k =~ s/\//::/g;
2043 2822
2046 } 2825 }
2047 2826
2048 Symbol::delete_package $k; 2827 Symbol::delete_package $k;
2049 } 2828 }
2050 2829
2051 # sync database to disk
2052 cf::db_sync;
2053 IO::AIO::flush;
2054
2055 # get rid of safe::, as good as possible 2830 warn "getting rid of safe::, as good as possible";
2056 Symbol::delete_package "safe::$_" 2831 Symbol::delete_package "safe::$_"
2057 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 2832 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2058 2833
2059 # remove register_script_function callbacks
2060 # TODO
2061
2062 # unload cf.pm "a bit" 2834 warn "unloading cf.pm \"a bit\"";
2063 delete $INC{"cf.pm"}; 2835 delete $INC{"cf.pm"};
2836 delete $INC{"cf/pod.pm"};
2064 2837
2065 # don't, removes xs symbols, too, 2838 # don't, removes xs symbols, too,
2066 # and global variables created in xs 2839 # and global variables created in xs
2067 #Symbol::delete_package __PACKAGE__; 2840 #Symbol::delete_package __PACKAGE__;
2068 2841
2069 # reload cf.pm 2842 warn "unload completed, starting to reload now";
2843
2070 warn "reloading cf.pm"; 2844 warn "reloading cf.pm";
2071 require cf; 2845 require cf;
2072 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 2846 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2073 2847
2074 # load config and database again 2848 warn "loading config and database again";
2075 cf::cfg_load; 2849 cf::cfg_load;
2076 cf::db_load;
2077 2850
2078 # load extensions
2079 warn "load extensions"; 2851 warn "loading extensions";
2080 cf::load_extensions; 2852 cf::load_extensions;
2081 2853
2082 # reattach attachments to objects 2854 warn "reattaching attachments to objects/players";
2083 warn "reattach"; 2855 _global_reattach; # objects, sockets
2084 _global_reattach; 2856 warn "reattaching attachments to maps";
2085 }; 2857 reattach $_ for values %MAP;
2858 warn "reattaching attachments to players";
2859 reattach $_ for values %PLAYER;
2086 2860
2087 if ($@) { 2861 warn "leaving sync_job";
2862
2863 1
2864 } or do {
2088 warn $@; 2865 warn $@;
2089 warn "error while reloading, exiting."; 2866 warn "error while reloading, exiting.";
2090 exit 1; 2867 exit 1;
2091 } 2868 };
2092 2869
2093 warn "reloaded successfully"; 2870 warn "reloaded";
2094}; 2871};
2095 2872
2096############################################################################# 2873our $RELOAD_WATCHER; # used only during reload
2097 2874
2098unless ($LINK_MAP) { 2875sub reload_perl() {
2099 $LINK_MAP = cf::map::new; 2876 # doing reload synchronously and two reloads happen back-to-back,
2877 # coro crashes during coro_state_free->destroy here.
2100 2878
2101 $LINK_MAP->width (41); 2879 $RELOAD_WATCHER ||= Event->timer (
2102 $LINK_MAP->height (41); 2880 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, 2881 after => 0,
2882 data => WF_AUTOCANCEL,
2111 cb => sub { 2883 cb => sub {
2112 $_[0]->w->cancel; 2884 do_reload_perl;
2113 2885 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 }); 2886 },
2132 2887 );
2133 $LINK_MAP->{deny_save} = 1;
2134 $LINK_MAP->{deny_reset} = 1;
2135
2136 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2137} 2888}
2138
2139register "<global>", __PACKAGE__;
2140 2889
2141register_command "reload" => sub { 2890register_command "reload" => sub {
2142 my ($who, $arg) = @_; 2891 my ($who, $arg) = @_;
2143 2892
2144 if ($who->flag (FLAG_WIZ)) { 2893 if ($who->flag (FLAG_WIZ)) {
2145 $who->message ("start of reload.");
2146 reload;
2147 $who->message ("end of reload."); 2894 $who->message ("reloading server.");
2895 async { reload_perl };
2148 } 2896 }
2149}; 2897};
2150 2898
2151unshift @INC, $LIBDIR; 2899unshift @INC, $LIBDIR;
2152 2900
2901my $bug_warning = 0;
2902
2903our @WAIT_FOR_TICK;
2904our @WAIT_FOR_TICK_BEGIN;
2905
2906sub wait_for_tick {
2907 return unless $TICK_WATCHER->is_active;
2908 return if $Coro::current == $Coro::main;
2909
2910 my $signal = new Coro::Signal;
2911 push @WAIT_FOR_TICK, $signal;
2912 $signal->wait;
2913}
2914
2915sub wait_for_tick_begin {
2916 return unless $TICK_WATCHER->is_active;
2917 return if $Coro::current == $Coro::main;
2918
2919 my $signal = new Coro::Signal;
2920 push @WAIT_FOR_TICK_BEGIN, $signal;
2921 $signal->wait;
2922}
2923
2924 my $min = 1e6;#d#
2925 my $avg = 10;
2153$TICK_WATCHER = Event->timer ( 2926$TICK_WATCHER = Event->timer (
2154 reentrant => 0, 2927 reentrant => 0,
2928 parked => 1,
2155 prio => 0, 2929 prio => 0,
2156 at => $NEXT_TICK || $TICK, 2930 at => $NEXT_TICK || $TICK,
2157 data => WF_AUTOCANCEL, 2931 data => WF_AUTOCANCEL,
2158 cb => sub { 2932 cb => sub {
2159 unless ($FREEZE) { 2933 if ($Coro::current != $Coro::main) {
2934 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2935 unless ++$bug_warning > 10;
2936 return;
2937 }
2938
2939 $NOW = $tick_start = Event::time;
2940
2160 cf::server_tick; # one server iteration 2941 cf::server_tick; # one server iteration
2161 $RUNTIME += $TICK; 2942
2943 0 && sync_job {#d#
2944 for(1..10) {
2945 my $t = Event::time;
2946 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2947 or die;
2948
2949 $map->width (50);
2950 $map->height (50);
2951 $map->alloc;
2952 $map->_load_objects ("/tmp/x.map", 1);
2953 my $t = Event::time - $t;
2954
2955 #next unless $t < 0.0013;#d#
2956 if ($t < $min) {
2957 $min = $t;
2958 }
2959 $avg = $avg * 0.99 + $t * 0.01;
2960 }
2961 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2962 exit 0;
2963 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
2162 } 2964 };
2163 2965
2966 $RUNTIME += $TICK;
2164 $NEXT_TICK += $TICK; 2967 $NEXT_TICK += $TICK;
2165 2968
2969 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2970 $NEXT_RUNTIME_WRITE = $NOW + 10;
2971 Coro::async_pool {
2972 write_runtime
2973 or warn "ERROR: unable to write runtime file: $!";
2974 };
2975 }
2976
2977# my $AFTER = Event::time;
2978# warn $AFTER - $NOW;#d#
2979
2980 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2981 $sig->send;
2982 }
2983 while (my $sig = shift @WAIT_FOR_TICK) {
2984 $sig->send;
2985 }
2986
2987 $NOW = Event::time;
2988
2166 # if we are delayed by four ticks or more, skip them all 2989 # if we are delayed by four ticks or more, skip them all
2167 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 2990 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2168 2991
2169 $TICK_WATCHER->at ($NEXT_TICK); 2992 $TICK_WATCHER->at ($NEXT_TICK);
2170 $TICK_WATCHER->start; 2993 $TICK_WATCHER->start;
2994
2995 $LOAD = ($NOW - $tick_start) / $TICK;
2996 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2997
2998 _post_tick;
2999
3000
2171 }, 3001 },
2172); 3002);
2173 3003
3004{
2174IO::AIO::max_poll_time $TICK * 0.2; 3005 BDB::max_poll_time $TICK * 0.1;
2175 3006 $BDB_POLL_WATCHER = Event->io (
2176Event->io ( 3007 reentrant => 0,
2177 fd => IO::AIO::poll_fileno, 3008 fd => BDB::poll_fileno,
2178 poll => 'r', 3009 poll => 'r',
2179 prio => 5, 3010 prio => 0,
2180 data => WF_AUTOCANCEL,
2181 cb => \&IO::AIO::poll_cb,
2182);
2183
2184Event->timer (
2185 data => WF_AUTOCANCEL, 3011 data => WF_AUTOCANCEL,
2186 after => 0, 3012 cb => \&BDB::poll_cb,
2187 interval => 10, 3013 );
2188 cb => sub { 3014 BDB::min_parallel 8;
2189 (Coro::unblock_sub { 3015
2190 write_runtime 3016 BDB::set_sync_prepare {
2191 or warn "ERROR: unable to write runtime file: $!"; 3017 my $status;
3018 my $current = $Coro::current;
3019 (
3020 sub {
3021 $status = $!;
3022 $current->ready; undef $current;
3023 },
3024 sub {
3025 Coro::schedule while defined $current;
3026 $! = $status;
3027 },
3028 )
3029 };
3030
3031 unless ($DB_ENV) {
3032 $DB_ENV = BDB::db_env_create;
3033
3034 cf::sync_job {
3035 eval {
3036 BDB::db_env_open
3037 $DB_ENV,
3038 $BDBDIR,
3039 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3040 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3041 0666;
3042
3043 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3044
3045 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3046 $DB_ENV->set_lk_detect;
3047 };
3048
3049 cf::cleanup "db_env_open(db): $@" if $@;
2192 })->(); 3050 };
2193 }, 3051 }
2194); 3052}
3053
3054{
3055 IO::AIO::min_parallel 8;
3056
3057 undef $Coro::AIO::WATCHER;
3058 IO::AIO::max_poll_time $TICK * 0.1;
3059 $AIO_POLL_WATCHER = Event->io (
3060 reentrant => 0,
3061 data => WF_AUTOCANCEL,
3062 fd => IO::AIO::poll_fileno,
3063 poll => 'r',
3064 prio => 6,
3065 cb => \&IO::AIO::poll_cb,
3066 );
3067}
3068
3069my $_log_backtrace;
3070
3071sub _log_backtrace {
3072 my ($msg, @addr) = @_;
3073
3074 $msg =~ s/\n//;
3075
3076 # limit the # of concurrent backtraces
3077 if ($_log_backtrace < 2) {
3078 ++$_log_backtrace;
3079 async {
3080 my @bt = fork_call {
3081 @addr = map { sprintf "%x", $_ } @addr;
3082 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3083 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3084 or die "addr2line: $!";
3085
3086 my @funcs;
3087 my @res = <$fh>;
3088 chomp for @res;
3089 while (@res) {
3090 my ($func, $line) = splice @res, 0, 2, ();
3091 push @funcs, "[$func] $line";
3092 }
3093
3094 @funcs
3095 };
3096
3097 LOG llevInfo, "[ABT] $msg\n";
3098 LOG llevInfo, "[ABT] $_\n" for @bt;
3099 --$_log_backtrace;
3100 };
3101 } else {
3102 LOG llevInfo, "[ABT] $msg\n";
3103 LOG llevInfo, "[ABT] [suppressed]\n";
3104 }
3105}
3106
3107# load additional modules
3108use cf::pod;
3109
3110END { cf::emergency_save }
2195 3111
21961 31121
2197 3113

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines