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.137 by root, Fri Jan 5 10:23:05 2007 UTC vs.
Revision 1.312 by root, Sat Jul 21 18:01:26 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines