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.169 by root, Sun Jan 14 01:09:46 2007 UTC vs.
Revision 1.310 by elmex, Mon Jul 16 15:43:49 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 ();
20use Data::Dumper; 27use Data::Dumper;
21use Digest::MD5; 28use Digest::MD5;
22use Fcntl; 29use Fcntl;
30use YAML::Syck ();
23use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
24use YAML::Syck ();
25use Time::HiRes; 32use Time::HiRes;
33use Compress::LZF;
34use Digest::MD5 ();
26 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
27use 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
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30 43
31# 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?
32$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
33 46
34$Coro::main->prio (Coro::PRIO_MAX); # 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
35 48
49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
50
36our %COMMAND = (); 51our %COMMAND = ();
37our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
38 53
39our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
40our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
43 59
60our $RELOAD; # number of reloads so far
44our @EVENT; 61our @EVENT;
45our $LIBDIR = datadir . "/ext";
46 62
47our $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(!)
48our $TICK_WATCHER; 76our $TICK_WATCHER;
49our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER; 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51our $NEXT_TICK; 79our $NEXT_TICK;
52our $NOW; 80our $NOW;
81our $USE_FSYNC = 1; # use fsync to write maps - default off
82
83our $BDB_POLL_WATCHER;
84our $DB_ENV;
53 85
54our %CFG; 86our %CFG;
55 87
56our $UPTIME; $UPTIME ||= time; 88our $UPTIME; $UPTIME ||= time;
57our $RUNTIME; 89our $RUNTIME;
58 90
59our %PLAYER; # all users 91our %PLAYER; # all users
60our %MAP; # all maps 92our %MAP; # all maps
61our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
62our $RANDOM_MAPS = cf::localdir . "/random";
63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66 94
67# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69 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
101
70binmode STDOUT; 102binmode STDOUT;
71binmode STDERR; 103binmode STDERR;
72 104
73# read virtual server time, if available 105# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
76 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
77 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
78} 110}
79 111
80mkdir cf::localdir; 112mkdir $_
81mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82mkdir cf::localdir . "/" . cf::tmpdir;
83mkdir cf::localdir . "/" . cf::uniquedir;
84mkdir $RANDOM_MAPS;
85 114
86our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
116
117sub cf::map::normalise;
87 118
88############################################################################# 119#############################################################################
89 120
90=head2 GLOBAL VARIABLES 121=head2 GLOBAL VARIABLES
91 122
98=item $cf::RUNTIME 129=item $cf::RUNTIME
99 130
100The 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
101every server tick. 132every server tick.
102 133
103=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
104 137
105The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
106be 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.
107 142
108=item $cf::NOW 143=item $cf::NOW
109 144
110The time of the last (current) server tick. 145The time of the last (current) server tick.
111 146
112=item $cf::TICK 147=item $cf::TICK
113 148
114The 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.
115 160
116=item %cf::CFG 161=item %cf::CFG
117 162
118Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
119from wherever your confdir points to. 164from wherever your confdir points to.
120 165
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
122 167
123These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
125processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126window of cpu time available, or simply to synchronise to the server tick. 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.
127 177
128=back 178=back
129 179
130=cut 180=cut
131 181
132BEGIN { 182BEGIN {
133 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
134 my $msg = join "", @_; 184 my $msg = join "", @_;
135 utf8::encode $msg;
136 185
137 $msg .= "\n" 186 $msg .= "\n"
138 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
139 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
140 LOG llevError, $msg; 192 LOG llevError, $msg;
141 }; 193 };
142} 194}
143 195
144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148@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';
149@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)
150 203
151# 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
152# within the Safe compartment. 205# within the Safe compartment.
153for my $pkg (qw( 206for my $pkg (qw(
154 cf::global cf::attachable 207 cf::global cf::attachable
162} 215}
163 216
164$Event::DIED = sub { 217$Event::DIED = sub {
165 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
166}; 219};
220
221#############################################################################
167 222
168=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
169 224
170=over 4 225=over 4
171 226
190 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191 $d 246 $d
192 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
193} 248}
194 249
195use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
198 251
199Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
200 253
201=cut
202
203sub from_json($) {
204 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205 JSON::Syck::Load $_[0]
206}
207
208=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
209 255
210Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
211 257
212=cut 258=cut
213 259
214sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 261
216 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
217} 263sub from_json ($) { $json_coder->decode ($_[0]) }
218 264
219=item cf::lock_wait $string 265=item cf::lock_wait $string
220 266
221Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
222 268
228returned. 274returned.
229 275
230Lock 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
231uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
232 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
233=cut 283=cut
234 284
235our %LOCK; 285our %LOCK;
236 286
237sub lock_wait($) { 287sub lock_wait($) {
256 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
258 } 308 }
259} 309}
260 310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
315}
316
261sub freeze_mainloop { 317sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
263 319
264 my $guard = Coro::guard { 320 my $guard = Coro::guard {
265 $TICK_WATCHER->start; 321 $TICK_WATCHER->start;
266 $WRITE_RUNTIME_WATCHER->start;
267 }; 322 };
268 $WRITE_RUNTIME_WATCHER->stop;
269 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
270 $guard 324 $guard
271} 325}
272 326
273=item cf::async { BLOCK } 327=item cf::async { BLOCK }
280 334
281BEGIN { *async = \&Coro::async_pool } 335BEGIN { *async = \&Coro::async_pool }
282 336
283=item cf::sync_job { BLOCK } 337=item cf::sync_job { BLOCK }
284 338
285The design of crossfire+ requires that the main coro ($Coro::main) is 339The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 340is always able to handle events or runnable, as Crossfire TRT is only
287reentrant. 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.
288 343
289If 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
290the given BLOCK in another coroutine while waiting for the result. The 345the given BLOCK in another coroutine while waiting for the result. The
291server 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
292fast or be very important. 347fast or be very important.
295 350
296sub sync_job(&) { 351sub sync_job(&) {
297 my ($job) = @_; 352 my ($job) = @_;
298 353
299 if ($Coro::current == $Coro::main) { 354 if ($Coro::current == $Coro::main) {
355 my $time = Event::time;
356
300 # this is the main coro, too bad, we have to block 357 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 358 # till the operation succeeds, freezing the server :/
302 359
303 # TODO: use suspend/resume instead 360 # TODO: use suspend/resume instead
304 # (but this is cancel-safe) 361 # (but this is cancel-safe)
315 372
316 while ($busy) { 373 while ($busy) {
317 Coro::cede or Event::one_event; 374 Coro::cede or Event::one_event;
318 } 375 }
319 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
383
320 wantarray ? @res : $res[0] 384 wantarray ? @res : $res[0]
321 } else { 385 } else {
322 # we are in another coroutine, how wonderful, everything just works 386 # we are in another coroutine, how wonderful, everything just works
323 387
324 $job->() 388 $job->()
343 $EXT_CORO{$coro+0} = $coro; 407 $EXT_CORO{$coro+0} = $coro;
344 408
345 $coro 409 $coro
346} 410}
347 411
348sub write_runtime { 412=item fork_call { }, $args
349 my $runtime = cf::localdir . "/runtime";
350 413
351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 414Executes the given code block with the given arguments in a seperate
352 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.
353 418
354 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 419=cut
355 (aio_write $fh, 0, (length $value), $value, 0) <= 0
356 and return;
357 420
358 aio_fsync $fh 421sub _store_scalar {
359 and return; 422 open my $fh, ">", \my $buf
360 423 or die "fork_call: cannot open fh-to-buf in child : $!";
424 Storable::store_fd $_[0], $fh;
361 close $fh 425 close $fh;
362 or return;
363 426
364 aio_rename "$runtime~", $runtime 427 $buf
365 and return; 428}
366 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;
367 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 });
368} 599}
369 600
370=back 601=back
371 602
372=cut 603=cut
379attach callbacks/event handlers (a collection of which is called an "attachment") 610attach callbacks/event handlers (a collection of which is called an "attachment")
380to it. All such attachable objects support the following methods. 611to it. All such attachable objects support the following methods.
381 612
382In 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>
383C<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
384crossfire+). 615Crossfire TRT).
385 616
386=over 4 617=over 4
387 618
388=item $attachable->attach ($attachment, key => $value...) 619=item $attachable->attach ($attachment, key => $value...)
389 620
503our @CB_TYPE = (); # registry for type (cf-object class) based events 734our @CB_TYPE = (); # registry for type (cf-object class) based events
504our @CB_MAP = (); 735our @CB_MAP = ();
505 736
506my %attachment; 737my %attachment;
507 738
739sub cf::attachable::thawer_merge {
740 # simply override everything except _meta
741 local $_[0]{_meta};
742 %{$_[0]} = %{$_[1]};
743}
744
508sub _attach_cb($$$$) { 745sub _attach_cb($$$$) {
509 my ($registry, $event, $prio, $cb) = @_; 746 my ($registry, $event, $prio, $cb) = @_;
510 747
511 use sort 'stable'; 748 use sort 'stable';
512 749
546 $registry = $CB_TYPE[$object_type] ||= []; 783 $registry = $CB_TYPE[$object_type] ||= [];
547 784
548 } elsif ($type eq "subtype") { 785 } elsif ($type eq "subtype") {
549 defined $object_type or Carp::croak "subtype specified without type"; 786 defined $object_type or Carp::croak "subtype specified without type";
550 my $object_subtype = shift @arg; 787 my $object_subtype = shift @arg;
551 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 788 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
552 789
553 } elsif ($type eq "package") { 790 } elsif ($type eq "package") {
554 my $pkg = shift @arg; 791 my $pkg = shift @arg;
555 792
556 while (my ($name, $id) = each %cb_id) { 793 while (my ($name, $id) = each %cb_id) {
585 _attach $registry, $klass, @attach; 822 _attach $registry, $klass, @attach;
586 } 823 }
587 824
588 $obj->{$name} = \%arg; 825 $obj->{$name} = \%arg;
589 } else { 826 } else {
590 warn "object uses attachment '$name' that is not available, postponing.\n"; 827 warn "object uses attachment '$name' which is not available, postponing.\n";
591 } 828 }
592 829
593 $obj->{_attachment}{$name} = undef; 830 $obj->{_attachment}{$name} = undef;
594} 831}
595 832
597 if (ref $_[0]) { 834 if (ref $_[0]) {
598 _object_attach @_; 835 _object_attach @_;
599 } else { 836 } else {
600 _attach shift->_attach_registry, @_; 837 _attach shift->_attach_registry, @_;
601 } 838 }
839 _recalc_want;
602}; 840};
603 841
604# all those should be optimised 842# all those should be optimised
605sub cf::attachable::detach { 843sub cf::attachable::detach {
606 my ($obj, $name) = @_; 844 my ($obj, $name) = @_;
609 delete $obj->{_attachment}{$name}; 847 delete $obj->{_attachment}{$name};
610 reattach ($obj); 848 reattach ($obj);
611 } else { 849 } else {
612 Carp::croak "cannot, currently, detach class attachments"; 850 Carp::croak "cannot, currently, detach class attachments";
613 } 851 }
852 _recalc_want;
614}; 853};
615 854
616sub cf::attachable::attached { 855sub cf::attachable::attached {
617 my ($obj, $name) = @_; 856 my ($obj, $name) = @_;
618 857
633 "; 872 ";
634 die if $@; 873 die if $@;
635} 874}
636 875
637our $override; 876our $override;
638our @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?
639 878
640sub override { 879sub override {
641 $override = 1; 880 $override = 1;
642 @invoke_results = (); 881 @INVOKE_RESULTS = (@_);
643} 882}
644 883
645sub do_invoke { 884sub do_invoke {
646 my $event = shift; 885 my $event = shift;
647 my $callbacks = shift; 886 my $callbacks = shift;
648 887
649 @invoke_results = (); 888 @INVOKE_RESULTS = ();
650 889
651 local $override; 890 local $override;
652 891
653 for (@$callbacks) { 892 for (@$callbacks) {
654 eval { &{$_->[1]} }; 893 eval { &{$_->[1]} };
671 910
672Generate an object-specific event with the given arguments. 911Generate an object-specific event with the given arguments.
673 912
674This 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
675removed 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
676results (if you must, access C<@cf::invoke_results> directly). 915results (if you must, access C<@cf::INVOKE_RESULTS> directly).
677 916
678=back 917=back
679 918
680=cut 919=cut
681 920
741 $filename, length $$rdata, scalar @$objs; 980 $filename, length $$rdata, scalar @$objs;
742 981
743 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 982 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
744 chmod SAVE_MODE, $fh; 983 chmod SAVE_MODE, $fh;
745 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 984 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
746 aio_fsync $fh; 985 aio_fsync $fh if $cf::USE_FSYNC;
747 close $fh; 986 close $fh;
748 987
749 if (@$objs) { 988 if (@$objs) {
750 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 989 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
751 chmod SAVE_MODE, $fh; 990 chmod SAVE_MODE, $fh;
752 my $data = Storable::nfreeze { version => 1, objs => $objs }; 991 my $data = Storable::nfreeze { version => 1, objs => $objs };
753 aio_write $fh, 0, (length $data), $data, 0; 992 aio_write $fh, 0, (length $data), $data, 0;
754 aio_fsync $fh; 993 aio_fsync $fh if $cf::USE_FSYNC;
755 close $fh; 994 close $fh;
756 aio_rename "$filename.pst~", "$filename.pst"; 995 aio_rename "$filename.pst~", "$filename.pst";
757 } 996 }
758 } else { 997 } else {
759 aio_unlink "$filename.pst"; 998 aio_unlink "$filename.pst";
791 or return; 1030 or return;
792 $av = eval { (Storable::thaw $av)->{objs} }; 1031 $av = eval { (Storable::thaw $av)->{objs} };
793 } 1032 }
794 1033
795 warn sprintf "loading %s (%d)\n", 1034 warn sprintf "loading %s (%d)\n",
796 $filename, length $data, scalar @{$av || []};#d# 1035 $filename, length $data, scalar @{$av || []};
797 return ($data, $av); 1036 return ($data, $av);
798} 1037}
1038
1039=head2 COMMAND CALLBACKS
1040
1041=over 4
1042
1043=cut
799 1044
800############################################################################# 1045#############################################################################
801# command handling &c 1046# command handling &c
802 1047
803=item cf::register_command $name => \&callback($ob,$args); 1048=item cf::register_command $name => \&callback($ob,$args);
816 push @{ $COMMAND{$name} }, [$caller, $cb]; 1061 push @{ $COMMAND{$name} }, [$caller, $cb];
817} 1062}
818 1063
819=item cf::register_extcmd $name => \&callback($pl,$packet); 1064=item cf::register_extcmd $name => \&callback($pl,$packet);
820 1065
821Register a callbackf ro execution when the client sends an extcmd packet. 1066Register a callback for execution when the client sends an (synchronous)
1067extcmd packet. Ext commands will be processed in the order they are
1068received by the server, like other user commands. The first argument is
1069the logged-in player. Ext commands can only be processed after a player
1070has logged in successfully.
822 1071
823If the callback returns something, it is sent back as if reply was being 1072If the callback returns something, it is sent back as if reply was being
824called. 1073called.
825 1074
1075=item cf::register_exticmd $name => \&callback($ns,$packet);
1076
1077Register a callback for execution when the client sends an (asynchronous)
1078exticmd packet. Exti commands are processed by the server as soon as they
1079are received, i.e. out of order w.r.t. other commands. The first argument
1080is a client socket. Exti commands can be received anytime, even before
1081log-in.
1082
1083If the callback returns something, it is sent back as if reply was being
1084called.
1085
826=cut 1086=cut
827 1087
828sub register_extcmd { 1088sub register_extcmd {
829 my ($name, $cb) = @_; 1089 my ($name, $cb) = @_;
830 1090
831 $EXTCMD{$name} = $cb; 1091 $EXTCMD{$name} = $cb;
1092}
1093
1094sub register_exticmd {
1095 my ($name, $cb) = @_;
1096
1097 $EXTICMD{$name} = $cb;
832} 1098}
833 1099
834cf::player->attach ( 1100cf::player->attach (
835 on_command => sub { 1101 on_command => sub {
836 my ($pl, $name, $params) = @_; 1102 my ($pl, $name, $params) = @_;
845 cf::override; 1111 cf::override;
846 }, 1112 },
847 on_extcmd => sub { 1113 on_extcmd => sub {
848 my ($pl, $buf) = @_; 1114 my ($pl, $buf) = @_;
849 1115
850 my $msg = eval { from_json $buf }; 1116 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
851 1117
852 if (ref $msg) { 1118 if (ref $msg) {
853 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1119 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
854 if (my %reply = $cb->($pl, $msg)) { 1120 if (my %reply = $cb->($pl, $msg)) {
855 $pl->ext_reply ($msg->{msgid}, %reply); 1121 $pl->ext_reply ($msg->{msgid}, %reply);
861 1127
862 cf::override; 1128 cf::override;
863 }, 1129 },
864); 1130);
865 1131
866sub load_extension {
867 my ($path) = @_;
868
869 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
870 my $base = $1;
871 my $pkg = $1;
872 $pkg =~ s/[^[:word:]]/_/g;
873 $pkg = "ext::$pkg";
874
875 warn "... loading '$path' into '$pkg'\n";
876
877 open my $fh, "<:utf8", $path
878 or die "$path: $!";
879
880 my $source =
881 "package $pkg; use strict; use utf8;\n"
882 . "#line 1 \"$path\"\n{\n"
883 . (do { local $/; <$fh> })
884 . "\n};\n1";
885
886 unless (eval $source) {
887 my $msg = $@ ? "$path: $@\n"
888 : "extension disabled.\n";
889 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
890 warn $@;
891 warn "mandatory extension failed to load, exiting.\n";
892 exit 1;
893 }
894 die $@;
895 }
896
897 push @EXTS, $pkg;
898}
899
900sub load_extensions { 1132sub load_extensions {
1133 cf::sync_job {
1134 my %todo;
1135
901 for my $ext (<$LIBDIR/*.ext>) { 1136 for my $path (<$LIBDIR/*.ext>) {
902 next unless -r $ext; 1137 next unless -r $path;
903 eval { 1138
904 load_extension $ext; 1139 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1140 my $base = $1;
1141 my $pkg = $1;
1142 $pkg =~ s/[^[:word:]]/_/g;
1143 $pkg = "ext::$pkg";
1144
1145 open my $fh, "<:utf8", $path
1146 or die "$path: $!";
1147
1148 my $source = do { local $/; <$fh> };
1149
1150 my %ext = (
1151 path => $path,
1152 base => $base,
1153 pkg => $pkg,
1154 );
1155
1156 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1157 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1158
1159 $ext{source} =
1160 "package $pkg; use strict; use utf8;\n"
1161 . "#line 1 \"$path\"\n{\n"
1162 . $source
1163 . "\n};\n1";
1164
1165 $todo{$base} = \%ext;
1166 }
1167
1168 my %done;
1169 while (%todo) {
1170 my $progress;
1171
1172 while (my ($k, $v) = each %todo) {
1173 for (split /,\s*/, $v->{meta}{depends}) {
1174 goto skip
1175 unless exists $done{$_};
1176 }
1177
1178 warn "... loading '$k' into '$v->{pkg}'\n";
1179
1180 unless (eval $v->{source}) {
1181 my $msg = $@ ? "$v->{path}: $@\n"
1182 : "$v->{base}: extension inactive.\n";
1183
1184 if (exists $v->{meta}{mandatory}) {
1185 warn $msg;
1186 warn "mandatory extension failed to load, exiting.\n";
1187 exit 1;
1188 }
1189
1190 warn $msg;
1191 }
1192
1193 $done{$k} = delete $todo{$k};
1194 push @EXTS, $v->{pkg};
1195 $progress = 1;
905 1 1196 }
906 } or warn "$ext not loaded: $@"; 1197
1198 skip:
1199 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1200 unless $progress;
1201 }
907 } 1202 };
908} 1203}
909 1204
910############################################################################# 1205#############################################################################
911 1206
1207=back
1208
912=head2 CORE EXTENSIONS 1209=head2 CORE EXTENSIONS
913 1210
914Functions and methods that extend core crossfire objects. 1211Functions and methods that extend core crossfire objects.
915 1212
916=cut 1213=cut
928Returns the given player object, loading it if necessary (might block). 1225Returns the given player object, loading it if necessary (might block).
929 1226
930=cut 1227=cut
931 1228
932sub playerdir($) { 1229sub playerdir($) {
933 cf::localdir 1230 "$PLAYERDIR/"
934 . "/"
935 . cf::playerdir
936 . "/"
937 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1231 . (ref $_[0] ? $_[0]->ob->name : $_[0])
938} 1232}
939 1233
940sub path($) { 1234sub path($) {
941 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1235 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
942 1236
943 (playerdir $login) . "/$login.pl" 1237 (playerdir $login) . "/playerdata"
944} 1238}
945 1239
946sub find_active($) { 1240sub find_active($) {
947 $cf::PLAYER{$_[0]} 1241 $cf::PLAYER{$_[0]}
948 and $cf::PLAYER{$_[0]}->active 1242 and $cf::PLAYER{$_[0]}->active
951 1245
952sub exists($) { 1246sub exists($) {
953 my ($login) = @_; 1247 my ($login) = @_;
954 1248
955 $cf::PLAYER{$login} 1249 $cf::PLAYER{$login}
956 or cf::sync_job { !aio_stat $login } 1250 or cf::sync_job { !aio_stat path $login }
957} 1251}
958 1252
959sub find($) { 1253sub find($) {
960 return $cf::PLAYER{$_[0]} || do { 1254 return $cf::PLAYER{$_[0]} || do {
961 my $login = $_[0]; 1255 my $login = $_[0];
962 1256
963 my $guard = cf::lock_acquire "user_find:$login"; 1257 my $guard = cf::lock_acquire "user_find:$login";
964 1258
965 $cf::PLAYER{$_[0]} || do { 1259 $cf::PLAYER{$_[0]} || do {
1260 # rename old playerfiles to new ones
1261 #TODO: remove when no longer required
1262 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1263 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1264 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1265 aio_unlink +(playerdir $login) . "/$login.pl";
1266
966 my $pl = load_pl path $login 1267 my $pl = load_pl path $login
967 or return; 1268 or return;
968 $cf::PLAYER{$login} = $pl 1269 $cf::PLAYER{$login} = $pl
969 } 1270 }
970 } 1271 }
1007 1308
1008=cut 1309=cut
1009 1310
1010sub quit_character { 1311sub quit_character {
1011 my ($pl) = @_; 1312 my ($pl) = @_;
1313
1314 my $name = $pl->ob->name;
1012 1315
1013 $pl->{deny_save} = 1; 1316 $pl->{deny_save} = 1;
1014 $pl->password ("*"); # this should lock out the player until we nuked the dir 1317 $pl->password ("*"); # this should lock out the player until we nuked the dir
1015 1318
1016 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1319 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1021 my $path = playerdir $pl; 1324 my $path = playerdir $pl;
1022 my $temp = "$path~$cf::RUNTIME~deleting~"; 1325 my $temp = "$path~$cf::RUNTIME~deleting~";
1023 aio_rename $path, $temp; 1326 aio_rename $path, $temp;
1024 delete $cf::PLAYER{$pl->ob->name}; 1327 delete $cf::PLAYER{$pl->ob->name};
1025 $pl->destroy; 1328 $pl->destroy;
1329
1330 my $prefix = qr<^~\Q$name\E/>;
1331
1332 # nuke player maps
1333 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1334
1026 IO::AIO::aio_rmtree $temp; 1335 IO::AIO::aio_rmtree $temp;
1336}
1337
1338=item $pl->kick
1339
1340Kicks a player out of the game. This destroys the connection.
1341
1342=cut
1343
1344sub kick {
1345 my ($pl, $kicker) = @_;
1346
1347 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1348 $pl->killer ("kicked");
1349 $pl->ns->destroy;
1027} 1350}
1028 1351
1029=item cf::player::list_logins 1352=item cf::player::list_logins
1030 1353
1031Returns am arrayref of all valid playernames in the system, can take a 1354Returns am arrayref of all valid playernames in the system, can take a
1032while and may block, so not sync_job-capable, ever. 1355while and may block, so not sync_job-capable, ever.
1033 1356
1034=cut 1357=cut
1035 1358
1036sub list_logins { 1359sub list_logins {
1037 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1360 my $dirs = aio_readdir $PLAYERDIR
1038 or return []; 1361 or return [];
1039 1362
1040 my @logins; 1363 my @logins;
1041 1364
1042 for my $login (@$dirs) { 1365 for my $login (@$dirs) {
1059=cut 1382=cut
1060 1383
1061sub maps($) { 1384sub maps($) {
1062 my ($pl) = @_; 1385 my ($pl) = @_;
1063 1386
1387 $pl = ref $pl ? $pl->ob->name : $pl;
1388
1064 my $files = aio_readdir playerdir $pl 1389 my $files = aio_readdir playerdir $pl
1065 or return; 1390 or return;
1066 1391
1067 my @paths; 1392 my @paths;
1068 1393
1069 for (@$files) { 1394 for (@$files) {
1070 utf8::decode $_; 1395 utf8::decode $_;
1071 next if /\.(?:pl|pst)$/; 1396 next if /\.(?:pl|pst)$/;
1072 next unless /^$PATH_SEP/o; 1397 next unless /^$PATH_SEP/o;
1073 1398
1074 s/\.map$//; 1399 push @paths, cf::map::normalise "~$pl/$_";
1075 push @paths, "~" . $pl->ob->name . "/" . $_;
1076 } 1400 }
1077 1401
1078 \@paths 1402 \@paths
1079} 1403}
1080 1404
1405=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1406
1407Expand crossfire pod fragments into protocol xml.
1408
1409=cut
1410
1411sub expand_cfpod {
1412 ((my $self), (local $_)) = @_;
1413
1414 # escape & and <
1415 s/&/&amp;/g;
1416 s/(?<![BIUGH])</&lt;/g;
1417
1418 # this is buggy, it needs to properly take care of nested <'s
1419
1420 1 while
1421 # replace B<>, I<>, U<> etc.
1422 s/B<([^\>]*)>/<b>$1<\/b>/
1423 || s/I<([^\>]*)>/<i>$1<\/i>/
1424 || s/U<([^\>]*)>/<u>$1<\/u>/
1425 # replace G<male|female> tags
1426 || s{G<([^>|]*)\|([^>]*)>}{
1427 $self->gender ? $2 : $1
1428 }ge
1429 # replace H<hint text>
1430 || s{H<([^\>]*)>}
1431 {
1432 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1433 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1434 "")
1435 [$self->{hintmode}]
1436 }ge;
1437
1438 # create single paragraphs (very hackish)
1439 s/(?<=\S)\n(?=\w)/ /g;
1440
1441 # compress some whitespace
1442 s/\s+\n/\n/g; # ws line-ends
1443 s/\n\n+/\n/g; # double lines
1444 s/^\n+//; # beginning lines
1445 s/\n+$//; # ending lines
1446
1447 $_
1448}
1449
1450sub hintmode {
1451 $_[0]{hintmode} = $_[1] if @_ > 1;
1452 $_[0]{hintmode}
1453}
1454
1081=item $player->ext_reply ($msgid, $msgtype, %msg) 1455=item $player->ext_reply ($msgid, %msg)
1082 1456
1083Sends an ext reply to the player. 1457Sends an ext reply to the player.
1084 1458
1085=cut 1459=cut
1086 1460
1087sub ext_reply($$$%) { 1461sub ext_reply($$%) {
1088 my ($self, $id, %msg) = @_; 1462 my ($self, $id, %msg) = @_;
1089 1463
1090 $msg{msgid} = $id; 1464 $msg{msgid} = $id;
1091 1465 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1092 $self->send ("ext " . cf::to_json \%msg);
1093} 1466}
1094 1467
1095package cf; 1468=item $player->ext_event ($type, %msg)
1469
1470Sends an ext event to the client.
1471
1472=cut
1473
1474sub ext_event($$%) {
1475 my ($self, $type, %msg) = @_;
1476
1477 $self->ns->ext_event ($type, %msg);
1478}
1479
1480=head3 cf::region
1481
1482=over 4
1483
1484=cut
1485
1486package cf::region;
1487
1488=item cf::region::find_by_path $path
1489
1490Tries to decuce the likely region for a map knowing only its path.
1491
1492=cut
1493
1494sub find_by_path($) {
1495 my ($path) = @_;
1496
1497 my ($match, $specificity);
1498
1499 for my $region (list) {
1500 if ($region->{match} && $path =~ $region->{match}) {
1501 ($match, $specificity) = ($region, $region->specificity)
1502 if $region->specificity > $specificity;
1503 }
1504 }
1505
1506 $match
1507}
1096 1508
1097=back 1509=back
1098
1099 1510
1100=head3 cf::map 1511=head3 cf::map
1101 1512
1102=over 4 1513=over 4
1103 1514
1107 1518
1108use Fcntl; 1519use Fcntl;
1109use Coro::AIO; 1520use Coro::AIO;
1110 1521
1111use overload 1522use overload
1112 '""' => \&as_string; 1523 '""' => \&as_string,
1524 fallback => 1;
1113 1525
1114our $MAX_RESET = 3600; 1526our $MAX_RESET = 3600;
1115our $DEFAULT_RESET = 3000; 1527our $DEFAULT_RESET = 3000;
1116 1528
1117sub generate_random_map { 1529sub generate_random_map {
1118 my ($self, $rmp) = @_; 1530 my ($self, $rmp) = @_;
1119
1120 # mit "rum" bekleckern, nicht 1531 # mit "rum" bekleckern, nicht
1121 $self->_create_random_map ( 1532 $self->_create_random_map (
1122 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1533 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1123 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1534 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1124 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1535 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1131 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1542 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1132 (cf::region::find $rmp->{region}), $rmp->{custom} 1543 (cf::region::find $rmp->{region}), $rmp->{custom}
1133 ) 1544 )
1134} 1545}
1135 1546
1547=item cf::map->register ($regex, $prio)
1548
1549Register a handler for the map path matching the given regex at the
1550givne priority (higher is better, built-in handlers have priority 0, the
1551default).
1552
1553=cut
1554
1136sub register { 1555sub register {
1137 my (undef, $regex) = @_; 1556 my (undef, $regex, $prio) = @_;
1138 my $pkg = caller; 1557 my $pkg = caller;
1139 1558
1140 no strict; 1559 no strict;
1141 push @{"$pkg\::ISA"}, __PACKAGE__; 1560 push @{"$pkg\::ISA"}, __PACKAGE__;
1142 1561
1143 $EXT_MAP{$pkg} = qr<$regex>; 1562 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1144} 1563}
1145 1564
1146# also paths starting with '/' 1565# also paths starting with '/'
1147$EXT_MAP{"cf::map"} = qr{^(?=/)}; 1566$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1567
1568sub thawer_merge {
1569 my ($self, $merge) = @_;
1570
1571 # we have to keep some variables in memory intact
1572 local $self->{path};
1573 local $self->{load_path};
1574
1575 $self->SUPER::thawer_merge ($merge);
1576}
1148 1577
1149sub normalise { 1578sub normalise {
1150 my ($path, $base) = @_; 1579 my ($path, $base) = @_;
1580
1581 $path = "$path"; # make sure its a string
1582
1583 $path =~ s/\.map$//;
1151 1584
1152 # map plan: 1585 # map plan:
1153 # 1586 #
1154 # /! non-realised random map exit (special hack!) 1587 # /! non-realised random map exit (special hack!)
1155 # {... are special paths that are not being touched 1588 # {... are special paths that are not being touched
1183 1616
1184 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object 1617 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1185 1618
1186 $path = normalise $path, $base; 1619 $path = normalise $path, $base;
1187 1620
1188 for my $pkg (keys %EXT_MAP) { 1621 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1189 if ($path =~ $EXT_MAP{$pkg}) { 1622 if ($path =~ $EXT_MAP{$pkg}[1]) {
1190 my $self = bless cf::map::new, $pkg; 1623 my $self = bless cf::map::new, $pkg;
1191 $self->{path} = $path; $self->path ($path); 1624 $self->{path} = $path; $self->path ($path);
1192 $self->init; # pass $1 etc. 1625 $self->init; # pass $1 etc.
1193 return $self; 1626 return $self;
1194 } 1627 }
1195 } 1628 }
1196 1629
1197 Carp::carp "unable to resolve path '$path'."; 1630 Carp::cluck "unable to resolve path '$path' (base '$base').";
1198 () 1631 ()
1199} 1632}
1200 1633
1201sub init { 1634sub init {
1202 my ($self) = @_; 1635 my ($self) = @_;
1217 1650
1218# the original (read-only) location 1651# the original (read-only) location
1219sub load_path { 1652sub load_path {
1220 my ($self) = @_; 1653 my ($self) = @_;
1221 1654
1222 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1655 "$MAPDIR/$self->{path}.map"
1223} 1656}
1224 1657
1225# the temporary/swap location 1658# the temporary/swap location
1226sub save_path { 1659sub save_path {
1227 my ($self) = @_; 1660 my ($self) = @_;
1228 1661
1229 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1662 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1230 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1663 "$TMPDIR/$path.map"
1231} 1664}
1232 1665
1233# the unique path, undef == no special unique path 1666# the unique path, undef == no special unique path
1234sub uniq_path { 1667sub uniq_path {
1235 my ($self) = @_; 1668 my ($self) = @_;
1236 1669
1237 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1670 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1238 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1671 "$UNIQUEDIR/$path"
1239} 1672}
1240 1673
1241# and all this just because we cannot iterate over 1674# and all this just because we cannot iterate over
1242# all maps in C++... 1675# all maps in C++...
1243sub change_all_map_light { 1676sub change_all_map_light {
1245 1678
1246 $_->change_map_light ($change) 1679 $_->change_map_light ($change)
1247 for grep $_->outdoor, values %cf::MAP; 1680 for grep $_->outdoor, values %cf::MAP;
1248} 1681}
1249 1682
1683sub decay_objects {
1684 my ($self) = @_;
1685
1686 return if $self->{deny_reset};
1687
1688 $self->do_decay_objects;
1689}
1690
1250sub unlink_save { 1691sub unlink_save {
1251 my ($self) = @_; 1692 my ($self) = @_;
1252 1693
1253 utf8::encode (my $save = $self->save_path); 1694 utf8::encode (my $save = $self->save_path);
1254 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save; 1695 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1255 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst"; 1696 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1256} 1697}
1257 1698
1258sub load_header_from($) { 1699sub load_header_from($) {
1259 my ($self, $path) = @_; 1700 my ($self, $path) = @_;
1260 1701
1261 utf8::encode $path; 1702 utf8::encode $path;
1262 aio_open $path, O_RDONLY, 0 1703 #aio_open $path, O_RDONLY, 0
1263 or return; 1704 # or return;
1264 1705
1265 $self->_load_header ($path) 1706 $self->_load_header ($path)
1266 or return; 1707 or return;
1267 1708
1268 $self->{load_path} = $path; 1709 $self->{load_path} = $path;
1269 1710
1270 1 1711 1
1271} 1712}
1272 1713
1273sub load_orig { 1714sub load_header_orig {
1274 my ($self) = @_; 1715 my ($self) = @_;
1275 1716
1276 $self->load_header_from ($self->load_path) 1717 $self->load_header_from ($self->load_path)
1277} 1718}
1278 1719
1279sub load_temp { 1720sub load_header_temp {
1280 my ($self) = @_; 1721 my ($self) = @_;
1281 1722
1282 $self->load_header_from ($self->save_path) 1723 $self->load_header_from ($self->save_path)
1724}
1725
1726sub prepare_temp {
1727 my ($self) = @_;
1728
1729 $self->last_access ((delete $self->{last_access})
1730 || $cf::RUNTIME); #d#
1731 # safety
1732 $self->{instantiate_time} = $cf::RUNTIME
1733 if $self->{instantiate_time} > $cf::RUNTIME;
1734}
1735
1736sub prepare_orig {
1737 my ($self) = @_;
1738
1739 $self->{load_original} = 1;
1740 $self->{instantiate_time} = $cf::RUNTIME;
1741 $self->last_access ($cf::RUNTIME);
1742 $self->instantiate;
1283} 1743}
1284 1744
1285sub load_header { 1745sub load_header {
1286 my ($self) = @_; 1746 my ($self) = @_;
1287 1747
1288 if ($self->load_temp) { 1748 if ($self->load_header_temp) {
1289 $self->last_access ((delete $self->{last_access}) 1749 $self->prepare_temp;
1290 || $cf::RUNTIME); #d#
1291 # safety
1292 $self->{instantiate_time} = $cf::RUNTIME
1293 if $self->{instantiate_time} > $cf::RUNTIME;
1294 } else { 1750 } else {
1295 $self->load_orig 1751 $self->load_header_orig
1296 or return; 1752 or return;
1297 1753 $self->prepare_orig;
1298 $self->{load_original} = 1;
1299 $self->{instantiate_time} = $cf::RUNTIME;
1300 $self->last_access ($cf::RUNTIME);
1301 $self->instantiate;
1302 } 1754 }
1755
1756 $self->{deny_reset} = 1
1757 if $self->no_reset;
1758
1759 $self->default_region (cf::region::find_by_path $self->{path})
1760 unless $self->default_region;
1303 1761
1304 1 1762 1
1305} 1763}
1306 1764
1307sub find; 1765sub find;
1320 $map->{last_save} = $cf::RUNTIME; 1778 $map->{last_save} = $cf::RUNTIME;
1321 1779
1322 $map->load_header 1780 $map->load_header
1323 or return; 1781 or return;
1324 1782
1325 if ($map->should_reset) { 1783 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1784 # doing this can freeze the server in a sync job, obviously
1785 #$cf::WAIT_FOR_TICK->wait;
1326 $map->reset; 1786 $map->reset;
1327 undef $guard; 1787 undef $guard;
1328 $map = find $path 1788 return find $path;
1329 or return;
1330 } 1789 }
1331 1790
1332 $cf::MAP{$path} = $map 1791 $cf::MAP{$path} = $map
1333 } 1792 }
1334} 1793}
1794
1795sub pre_load { }
1796sub post_load { }
1335 1797
1336sub load { 1798sub load {
1337 my ($self) = @_; 1799 my ($self) = @_;
1338 1800
1801 local $self->{deny_reset} = 1; # loading can take a long time
1802
1339 my $path = $self->{path}; 1803 my $path = $self->{path};
1804
1805 {
1340 my $guard = cf::lock_acquire "map_load:$path"; 1806 my $guard = cf::lock_acquire "map_load:$path";
1341 1807
1342 return if $self->in_memory != cf::MAP_SWAPPED; 1808 return if $self->in_memory != cf::MAP_SWAPPED;
1343 1809
1344 $self->in_memory (cf::MAP_LOADING); 1810 $self->in_memory (cf::MAP_LOADING);
1345 1811
1346 $self->alloc; 1812 $self->alloc;
1347 $self->_load_objects ($self->{load_path}, 1)
1348 or return;
1349 1813
1350 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1814 $self->pre_load;
1351 if delete $self->{load_original};
1352
1353 if (my $uniq = $self->uniq_path) {
1354 utf8::encode $uniq;
1355 if (aio_open $uniq, O_RDONLY, 0) {
1356 $self->clear_unique_items;
1357 $self->_load_objects ($uniq, 0);
1358 }
1359 }
1360
1361 Coro::cede;
1362
1363 # now do the right thing for maps
1364 $self->link_multipart_objects;
1365
1366 unless ($self->{deny_activate}) {
1367 $self->decay_objects;
1368 $self->fix_auto_apply;
1369 $self->update_buttons;
1370 Coro::cede; 1815 Coro::cede;
1371 $self->set_darkness_map; 1816
1817 $self->_load_objects ($self->{load_path}, 1)
1818 or return;
1819
1820 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1821 if delete $self->{load_original};
1822
1823 if (my $uniq = $self->uniq_path) {
1824 utf8::encode $uniq;
1825 if (aio_open $uniq, O_RDONLY, 0) {
1826 $self->clear_unique_items;
1827 $self->_load_objects ($uniq, 0);
1828 }
1829 }
1830
1831 Coro::cede;
1832 # now do the right thing for maps
1833 $self->link_multipart_objects;
1372 $self->difficulty ($self->estimate_difficulty) 1834 $self->difficulty ($self->estimate_difficulty)
1373 unless $self->difficulty; 1835 unless $self->difficulty;
1374 Coro::cede; 1836 Coro::cede;
1837
1838 unless ($self->{deny_activate}) {
1839 $self->decay_objects;
1840 $self->fix_auto_apply;
1841 $self->update_buttons;
1842 Coro::cede;
1843 $self->set_darkness_map;
1844 Coro::cede;
1375 $self->activate; 1845 $self->activate;
1376 } 1846 }
1377 1847
1378 $self->in_memory (cf::MAP_IN_MEMORY); 1848 $self->in_memory (cf::MAP_IN_MEMORY);
1849 }
1850
1851 $self->post_load;
1379} 1852}
1380 1853
1381sub customise_for { 1854sub customise_for {
1382 my ($self, $ob) = @_; 1855 my ($self, $ob) = @_;
1383 1856
1384 return find "~" . $ob->name . "/" . $self->{path} 1857 return find "~" . $ob->name . "/" . $self->{path}
1385 if $self->per_player; 1858 if $self->per_player;
1859
1860# return find "?party/" . $ob->name . "/" . $self->{path}
1861# if $self->per_party;
1386 1862
1387 $self 1863 $self
1388} 1864}
1389 1865
1390# find and load all maps in the 3x3 area around a map 1866# find and load all maps in the 3x3 area around a map
1422 1898
1423 cf::sync_job { $map->load }; 1899 cf::sync_job { $map->load };
1424} 1900}
1425 1901
1426our %MAP_PREFETCH; 1902our %MAP_PREFETCH;
1427our $MAP_PREFETCHER = Coro::async { 1903our $MAP_PREFETCHER = undef;
1428 while () {
1429 for my $path (keys %MAP_PREFETCH) {
1430 my $map = find $path
1431 or next;
1432 $map->load;
1433
1434 delete $MAP_PREFETCH{$path};
1435 }
1436 Coro::schedule;
1437 }
1438};
1439 1904
1440sub find_async { 1905sub find_async {
1441 my ($path, $origin) = @_; 1906 my ($path, $origin) = @_;
1442 1907
1443 $path = normalise $path, $origin && $origin->{path}; 1908 $path = normalise $path, $origin && $origin->{path};
1444 1909
1445 if (my $map = $cf::MAP{$path}) { 1910 if (my $map = $cf::MAP{$path}) {
1446 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1911 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1447 } 1912 }
1448 1913
1449 $MAP_PREFETCH{$path} = 0; 1914 undef $MAP_PREFETCH{$path};
1915 $MAP_PREFETCHER ||= cf::async {
1916 while (%MAP_PREFETCH) {
1917 for my $path (keys %MAP_PREFETCH) {
1918 if (my $map = find $path) {
1919 $map->load;
1920 }
1921
1922 delete $MAP_PREFETCH{$path};
1923 }
1924 }
1925 undef $MAP_PREFETCHER;
1926 };
1450 $MAP_PREFETCHER->ready; 1927 $MAP_PREFETCHER->prio (6);
1451 1928
1452 () 1929 ()
1453} 1930}
1454 1931
1455sub save { 1932sub save {
1500 1977
1501sub reset_at { 1978sub reset_at {
1502 my ($self) = @_; 1979 my ($self) = @_;
1503 1980
1504 # TODO: safety, remove and allow resettable per-player maps 1981 # TODO: safety, remove and allow resettable per-player maps
1505 return 1e99 if $self->isa ("ext::map_per_player");#d#
1506 return 1e99 if $self->{deny_reset}; 1982 return 1e99 if $self->{deny_reset};
1507 1983
1508 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1984 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1509 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 1985 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1510 1986
1515 my ($self) = @_; 1991 my ($self) = @_;
1516 1992
1517 $self->reset_at <= $cf::RUNTIME 1993 $self->reset_at <= $cf::RUNTIME
1518} 1994}
1519 1995
1520sub rename {
1521 my ($self, $new_path) = @_;
1522
1523 normalise $new_path;
1524
1525 $self->unlink_save;
1526
1527 delete $cf::MAP{$self->path};
1528 $self->{path} = $new_path; $self->path ($self->{path});
1529 $cf::MAP{$self->path} = $self;
1530
1531 $self->save;
1532}
1533
1534sub reset { 1996sub reset {
1535 my ($self) = @_; 1997 my ($self) = @_;
1536 1998
1537 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1999 my $lock = cf::lock_acquire "map_data:$self->{path}";
1538 2000
1539 return if $self->players; 2001 return if $self->players;
1540 return if $self->isa ("ext::map_per_player");#d#
1541 2002
1542 warn "resetting map ", $self->path;#d# 2003 warn "resetting map ", $self->path;
2004
2005 $self->in_memory (cf::MAP_SWAPPED);
2006
2007 # need to save uniques path
2008 unless ($self->{deny_save}) {
2009 my $uniq = $self->uniq_path; utf8::encode $uniq;
2010
2011 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2012 if $uniq;
2013 }
1543 2014
1544 delete $cf::MAP{$self->path}; 2015 delete $cf::MAP{$self->path};
1545 2016
1546 $self->in_memory (cf::MAP_SWAPPED);
1547 $self->clear; 2017 $self->clear;
1548 2018
1549 $_->clear_links_to ($self) for values %cf::MAP; 2019 $_->clear_links_to ($self) for values %cf::MAP;
1550 2020
1551 $self->unlink_save; 2021 $self->unlink_save;
1555my $nuke_counter = "aaaa"; 2025my $nuke_counter = "aaaa";
1556 2026
1557sub nuke { 2027sub nuke {
1558 my ($self) = @_; 2028 my ($self) = @_;
1559 2029
2030 delete $cf::MAP{$self->path};
2031
2032 $self->unlink_save;
2033
2034 bless $self, "cf::map";
2035 delete $self->{deny_reset};
1560 $self->{deny_save} = 1; 2036 $self->{deny_save} = 1;
1561 $self->reset_timeout (1); 2037 $self->reset_timeout (1);
1562 $self->rename ("{nuke}/" . ($nuke_counter++)); 2038 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2039
2040 $cf::MAP{$self->path} = $self;
2041
1563 $self->reset; # polite request, might not happen 2042 $self->reset; # polite request, might not happen
2043}
2044
2045=item $maps = cf::map::tmp_maps
2046
2047Returns an arrayref with all map paths of currently instantiated and saved
2048maps. May block.
2049
2050=cut
2051
2052sub tmp_maps() {
2053 [
2054 map {
2055 utf8::decode $_;
2056 /\.map$/
2057 ? normalise $_
2058 : ()
2059 } @{ aio_readdir $TMPDIR or [] }
2060 ]
2061}
2062
2063=item $maps = cf::map::random_maps
2064
2065Returns an arrayref with all map paths of currently instantiated and saved
2066random maps. May block.
2067
2068=cut
2069
2070sub random_maps() {
2071 [
2072 map {
2073 utf8::decode $_;
2074 /\.map$/
2075 ? normalise "?random/$_"
2076 : ()
2077 } @{ aio_readdir $RANDOMDIR or [] }
2078 ]
1564} 2079}
1565 2080
1566=item cf::map::unique_maps 2081=item cf::map::unique_maps
1567 2082
1568Returns an arrayref of paths of all shared maps that have 2083Returns an arrayref of paths of all shared maps that have
1569instantiated unique items. May block. 2084instantiated unique items. May block.
1570 2085
1571=cut 2086=cut
1572 2087
1573sub unique_maps() { 2088sub unique_maps() {
1574 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2089 [
1575 or return; 2090 map {
1576
1577 my @paths;
1578
1579 for (@$files) {
1580 utf8::decode $_; 2091 utf8::decode $_;
1581 next if /\.pst$/;
1582 next unless /^$PATH_SEP/o;
1583
1584 s/\.map$//; 2092 /\.map$/
1585 push @paths, $_; 2093 ? normalise $_
2094 : ()
2095 } @{ aio_readdir $UNIQUEDIR or [] }
1586 } 2096 ]
1587
1588 \@paths
1589} 2097}
1590 2098
1591package cf; 2099package cf;
1592 2100
1593=back 2101=back
1639 2147
1640 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2148 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1641 2149
1642 if ($self->{record_replies}) { 2150 if ($self->{record_replies}) {
1643 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2151 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2152
1644 } else { 2153 } else {
2154 my $pl = $self->contr;
2155
2156 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2157 my $diag = $pl->{npc_dialog};
2158 $diag->{pl}->ext_reply (
2159 $diag->{id},
2160 msgtype => "reply",
2161 msg => $diag->{pl}->expand_cfpod ($msg),
2162 add_topics => []
2163 );
2164
2165 } else {
1645 $msg = $npc->name . " says: $msg" if $npc; 2166 $msg = $npc->name . " says: $msg" if $npc;
1646 $self->message ($msg, $flags); 2167 $self->message ($msg, $flags);
2168 }
1647 } 2169 }
1648} 2170}
1649 2171
1650=item $player_object->may ("access") 2172=item $player_object->may ("access")
1651 2173
1684=cut 2206=cut
1685 2207
1686sub link_map { 2208sub link_map {
1687 unless ($LINK_MAP) { 2209 unless ($LINK_MAP) {
1688 $LINK_MAP = cf::map::find "{link}" 2210 $LINK_MAP = cf::map::find "{link}"
1689 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2211 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1690 $LINK_MAP->load; 2212 $LINK_MAP->load;
1691 } 2213 }
1692 2214
1693 $LINK_MAP 2215 $LINK_MAP
1694} 2216}
1699 $self->deactivate_recursive; 2221 $self->deactivate_recursive;
1700 2222
1701 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2223 return if UNIVERSAL::isa $self->map, "ext::map_link";
1702 2224
1703 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2225 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1704 if $self->map; 2226 if $self->map && $self->map->{path} ne "{link}";
1705 2227
1706 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2228 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1707} 2229}
1708 2230
1709sub cf::object::player::leave_link { 2231sub cf::object::player::leave_link {
1710 my ($self, $map, $x, $y) = @_; 2232 my ($self, $map, $x, $y) = @_;
2233
2234 return unless $self->contr->active;
1711 2235
1712 my $link_pos = delete $self->{_link_pos}; 2236 my $link_pos = delete $self->{_link_pos};
1713 2237
1714 unless ($map) { 2238 unless ($map) {
1715 # restore original map position 2239 # restore original map position
1733 $map->load; 2257 $map->load;
1734 $map->load_diag; 2258 $map->load_diag;
1735 2259
1736 return unless $self->contr->active; 2260 return unless $self->contr->active;
1737 $self->activate_recursive; 2261 $self->activate_recursive;
2262
2263 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1738 $self->enter_map ($map, $x, $y); 2264 $self->enter_map ($map, $x, $y);
1739} 2265}
1740 2266
1741cf::player->attach ( 2267=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1742 on_logout => sub {
1743 my ($pl) = @_;
1744 2268
1745 # abort map switching before logout 2269Moves the player to the given map-path and coordinates by first freezing
1746 if ($pl->ob->{_link_pos}) { 2270her, loading and preparing them map, calling the provided $check callback
1747 cf::sync_job { 2271that has to return the map if sucecssful, and then unfreezes the player on
1748 $pl->ob->leave_link 2272the new (success) or old (failed) map position. In either case, $done will
1749 }; 2273be called at the end of this process.
1750 }
1751 },
1752 on_login => sub {
1753 my ($pl) = @_;
1754 2274
1755 # try to abort aborted map switching on player login :)
1756 # should happen only on crashes
1757 if ($pl->ob->{_link_pos}) {
1758 $pl->ob->enter_link;
1759 (async {
1760 # we need this sleep as the login has a concurrent enter_exit running
1761 # and this sleep increases chances of the player not ending up in scorn
1762 $pl->ob->reply (undef,
1763 "There was an internal problem at your last logout, "
1764 . "the server will try to bring you to your intended destination in a second.",
1765 cf::NDI_RED);
1766 Coro::Timer::sleep 1;
1767 $pl->ob->leave_link;
1768 })->prio (2);
1769 }
1770 },
1771);
1772
1773=item $player_object->goto ($path, $x, $y)
1774
1775=cut 2275=cut
2276
2277our $GOTOGEN;
1776 2278
1777sub cf::object::player::goto { 2279sub cf::object::player::goto {
1778 my ($self, $path, $x, $y) = @_; 2280 my ($self, $path, $x, $y, $check, $done) = @_;
2281
2282 # do generation counting so two concurrent goto's will be executed in-order
2283 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1779 2284
1780 $self->enter_link; 2285 $self->enter_link;
1781 2286
1782 (async { 2287 (async {
2288 my $map = eval {
1783 my $map = cf::map::find $path; 2289 my $map = cf::map::find $path;
2290
2291 if ($map) {
1784 $map = $map->customise_for ($self) if $map; 2292 $map = $map->customise_for ($self);
1785 2293 $map = $check->($map) if $check && $map;
1786# warn "entering ", $map->path, " at ($x, $y)\n" 2294 } else {
1787# if $map;
1788
1789 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2295 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2296 }
1790 2297
2298 $map
2299 };
2300
2301 if ($@) {
2302 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2303 LOG llevError | logBacktrace, Carp::longmess $@;
2304 }
2305
2306 if ($gen == $self->{_goto_generation}) {
2307 delete $self->{_goto_generation};
1791 $self->leave_link ($map, $x, $y); 2308 $self->leave_link ($map, $x, $y);
2309 }
2310
2311 $done->() if $done;
1792 })->prio (1); 2312 })->prio (1);
1793} 2313}
1794 2314
1795=item $player_object->enter_exit ($exit_object) 2315=item $player_object->enter_exit ($exit_object)
1796 2316
1798 2318
1799sub parse_random_map_params { 2319sub parse_random_map_params {
1800 my ($spec) = @_; 2320 my ($spec) = @_;
1801 2321
1802 my $rmp = { # defaults 2322 my $rmp = { # defaults
1803 xsize => 10, 2323 xsize => (cf::rndm 15, 40),
1804 ysize => 10, 2324 ysize => (cf::rndm 15, 40),
2325 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2326 #layout => string,
1805 }; 2327 };
1806 2328
1807 for (split /\n/, $spec) { 2329 for (split /\n/, $spec) {
1808 my ($k, $v) = split /\s+/, $_, 2; 2330 my ($k, $v) = split /\s+/, $_, 2;
1809 2331
1813 $rmp 2335 $rmp
1814} 2336}
1815 2337
1816sub prepare_random_map { 2338sub prepare_random_map {
1817 my ($exit) = @_; 2339 my ($exit) = @_;
2340
2341 my $guard = cf::lock_acquire "exit_prepare:$exit";
1818 2342
1819 # all this does is basically replace the /! path by 2343 # all this does is basically replace the /! path by
1820 # a new random map path (?random/...) with a seed 2344 # a new random map path (?random/...) with a seed
1821 # that depends on the exit object 2345 # that depends on the exit object
1822 2346
1823 my $rmp = parse_random_map_params $exit->msg; 2347 my $rmp = parse_random_map_params $exit->msg;
1824 2348
1825 if ($exit->map) { 2349 if ($exit->map) {
1826 $rmp->{region} = $exit->map->region_name; 2350 $rmp->{region} = $exit->region->name;
1827 $rmp->{origin_map} = $exit->map->path; 2351 $rmp->{origin_map} = $exit->map->path;
1828 $rmp->{origin_x} = $exit->x; 2352 $rmp->{origin_x} = $exit->x;
1829 $rmp->{origin_y} = $exit->y; 2353 $rmp->{origin_y} = $exit->y;
1830 } 2354 }
1831 2355
1832 $rmp->{random_seed} ||= $exit->random_seed; 2356 $rmp->{random_seed} ||= $exit->random_seed;
1833 2357
1834 my $data = cf::to_json $rmp; 2358 my $data = cf::to_json $rmp;
1835 my $md5 = Digest::MD5::md5_hex $data; 2359 my $md5 = Digest::MD5::md5_hex $data;
2360 my $meta = "$RANDOMDIR/$md5.meta";
1836 2361
1837 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2362 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1838 aio_write $fh, 0, (length $data), $data, 0; 2363 aio_write $fh, 0, (length $data), $data, 0;
2364 undef $fh;
2365 aio_rename "$meta~", $meta;
1839 2366
1840 $exit->slaying ("?random/$md5"); 2367 $exit->slaying ("?random/$md5");
1841 $exit->msg (undef); 2368 $exit->msg (undef);
1842 } 2369 }
1843} 2370}
1845sub cf::object::player::enter_exit { 2372sub cf::object::player::enter_exit {
1846 my ($self, $exit) = @_; 2373 my ($self, $exit) = @_;
1847 2374
1848 return unless $self->type == cf::PLAYER; 2375 return unless $self->type == cf::PLAYER;
1849 2376
2377 if ($exit->slaying eq "/!") {
2378 #TODO: this should de-fi-ni-te-ly not be a sync-job
2379 # the problem is that $exit might not survive long enough
2380 # so it needs to be done right now, right here
2381 cf::sync_job { prepare_random_map $exit };
2382 }
2383
2384 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2385 my $hp = $exit->stats->hp;
2386 my $sp = $exit->stats->sp;
2387
1850 $self->enter_link; 2388 $self->enter_link;
2389
2390 # if exit is damned, update players death & WoR home-position
2391 $self->contr->savebed ($slaying, $hp, $sp)
2392 if $exit->flag (FLAG_DAMNED);
1851 2393
1852 (async { 2394 (async {
1853 $self->deactivate_recursive; # just to be sure 2395 $self->deactivate_recursive; # just to be sure
1854 unless (eval { 2396 unless (eval {
1855 prepare_random_map $exit 2397 $self->goto ($slaying, $hp, $sp);
1856 if $exit->slaying eq "/!";
1857
1858 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1859 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1860 2398
1861 1; 2399 1;
1862 }) { 2400 }) {
1863 $self->message ("Something went wrong deep within the crossfire server. " 2401 $self->message ("Something went wrong deep within the crossfire server. "
1864 . "I'll try to bring you back to the map you were before. " 2402 . "I'll try to bring you back to the map you were before. "
1865 . "Please report this to the dungeon master!", 2403 . "Please report this to the dungeon master!",
1866 cf::NDI_UNIQUE | cf::NDI_RED); 2404 cf::NDI_UNIQUE | cf::NDI_RED);
1867 2405
1868 warn "ERROR in enter_exit: $@"; 2406 warn "ERROR in enter_exit: $@";
1869 $self->leave_link; 2407 $self->leave_link;
1870 } 2408 }
1871 })->prio (1); 2409 })->prio (1);
1884 2422
1885sub cf::client::send_drawinfo { 2423sub cf::client::send_drawinfo {
1886 my ($self, $text, $flags) = @_; 2424 my ($self, $text, $flags) = @_;
1887 2425
1888 utf8::encode $text; 2426 utf8::encode $text;
1889 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2427 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1890} 2428}
1891 2429
2430=item $client->send_msg ($color, $type, $msg, [extra...])
2431
2432Send a drawinfo or msg packet to the client, formatting the msg for the
2433client if neccessary. C<$type> should be a string identifying the type of
2434the message, with C<log> being the default. If C<$color> is negative, suppress
2435the message unless the client supports the msg packet.
2436
2437=cut
2438
2439sub cf::client::send_msg {
2440 my ($self, $color, $type, $msg, @extra) = @_;
2441
2442 $msg = $self->pl->expand_cfpod ($msg);
2443
2444 return unless @extra || length $msg;
2445
2446 if ($self->can_msg) {
2447 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $type, $msg, @extra]));
2448 } else {
2449 # replace some tags by gcfclient-compatible ones
2450 for ($msg) {
2451 1 while
2452 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2453 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2454 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2455 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2456 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2457 }
2458
2459 if ($color >= 0) {
2460 if (0 && $msg =~ /\[/) {
2461 $self->send_packet ("drawextinfo $color 4 0 $msg")
2462 } else {
2463 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2464 $self->send_packet ("drawinfo $color $msg")
2465 }
2466 }
2467 }
2468}
2469
2470=item $client->ext_event ($type, %msg)
2471
2472Sends an ext event to the client.
2473
2474=cut
2475
2476sub cf::client::ext_event($$%) {
2477 my ($self, $type, %msg) = @_;
2478
2479 return unless $self->extcmd;
2480
2481 $msg{msgtype} = "event_$type";
2482 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2483}
1892 2484
1893=item $success = $client->query ($flags, "text", \&cb) 2485=item $success = $client->query ($flags, "text", \&cb)
1894 2486
1895Queues a query to the client, calling the given callback with 2487Queues a query to the client, calling the given callback with
1896the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2488the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1897C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2489C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1898 2490
1899Queries can fail, so check the return code. Or don't, as queries will become 2491Queries can fail, so check the return code. Or don't, as queries will
1900reliable at some point in the future. 2492become reliable at some point in the future.
1901 2493
1902=cut 2494=cut
1903 2495
1904sub cf::client::query { 2496sub cf::client::query {
1905 my ($self, $flags, $text, $cb) = @_; 2497 my ($self, $flags, $text, $cb) = @_;
1913 utf8::encode $text; 2505 utf8::encode $text;
1914 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2506 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1915 2507
1916 $self->send_packet ($self->{query_queue}[0][0]) 2508 $self->send_packet ($self->{query_queue}[0][0])
1917 if @{ $self->{query_queue} } == 1; 2509 if @{ $self->{query_queue} } == 1;
2510
2511 1
1918} 2512}
1919 2513
1920cf::client->attach ( 2514cf::client->attach (
2515 on_connect => sub {
2516 my ($ns) = @_;
2517
2518 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2519 },
1921 on_reply => sub { 2520 on_reply => sub {
1922 my ($ns, $msg) = @_; 2521 my ($ns, $msg) = @_;
1923 2522
1924 # this weird shuffling is so that direct followup queries 2523 # this weird shuffling is so that direct followup queries
1925 # get handled first 2524 # get handled first
1926 my $queue = delete $ns->{query_queue} 2525 my $queue = delete $ns->{query_queue}
1927 or return; # be conservative, not sure how that can happen, but we saw a crash here 2526 or return; # be conservative, not sure how that can happen, but we saw a crash here
1928 2527
1929 (shift @$queue)->[1]->($msg); 2528 (shift @$queue)->[1]->($msg);
2529 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1930 2530
1931 push @{ $ns->{query_queue} }, @$queue; 2531 push @{ $ns->{query_queue} }, @$queue;
1932 2532
1933 if (@{ $ns->{query_queue} } == @$queue) { 2533 if (@{ $ns->{query_queue} } == @$queue) {
1934 if (@$queue) { 2534 if (@$queue) {
1936 } else { 2536 } else {
1937 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2537 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1938 } 2538 }
1939 } 2539 }
1940 }, 2540 },
2541 on_exticmd => sub {
2542 my ($ns, $buf) = @_;
2543
2544 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2545
2546 if (ref $msg) {
2547 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2548 if (my %reply = $cb->($ns, $msg)) {
2549 $reply{msgid} = $msg->{msgid};
2550 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2551 }
2552 }
2553 } else {
2554 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2555 }
2556
2557 cf::override;
2558 },
1941); 2559);
1942 2560
1943=item $client->async (\&cb) 2561=item $client->async (\&cb)
1944 2562
1945Create a new coroutine, running the specified callback. The coroutine will 2563Create a new coroutine, running the specified callback. The coroutine will
1992 2610
1993# here we export the classes and methods available to script code 2611# here we export the classes and methods available to script code
1994 2612
1995=pod 2613=pod
1996 2614
1997The following fucntions and emthods are available within a safe environment: 2615The following functions and methods are available within a safe environment:
1998 2616
1999 cf::object contr pay_amount pay_player map 2617 cf::object
2618 contr pay_amount pay_player map x y force_find force_add
2619 insert remove
2620
2000 cf::object::player player 2621 cf::object::player
2001 cf::player peaceful 2622 player
2002 cf::map trigger 2623
2624 cf::player
2625 peaceful
2626
2627 cf::map
2628 trigger
2003 2629
2004=cut 2630=cut
2005 2631
2006for ( 2632for (
2007 ["cf::object" => qw(contr pay_amount pay_player map)], 2633 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2634 insert remove)],
2008 ["cf::object::player" => qw(player)], 2635 ["cf::object::player" => qw(player)],
2009 ["cf::player" => qw(peaceful)], 2636 ["cf::player" => qw(peaceful)],
2010 ["cf::map" => qw(trigger)], 2637 ["cf::map" => qw(trigger)],
2011) { 2638) {
2012 no strict 'refs'; 2639 no strict 'refs';
2083=back 2710=back
2084 2711
2085=cut 2712=cut
2086 2713
2087############################################################################# 2714#############################################################################
2715# the server's init and main functions
2088 2716
2089=head2 EXTENSION DATABASE SUPPORT 2717sub load_facedata($) {
2718 my ($path) = @_;
2090 2719
2091Crossfire maintains a very simple database for extension use. It can 2720 warn "loading facedata from $path\n";
2092currently store anything that can be serialised using Storable, which
2093excludes objects.
2094 2721
2095The parameter C<$family> should best start with the name of the extension 2722 my $facedata;
2096using it, it should be unique. 2723 0 < aio_load $path, $facedata
2724 or die "$path: $!";
2097 2725
2098=over 4 2726 $facedata = Coro::Storable::thaw $facedata;
2099 2727
2100=item $hashref = cf::db_get $family 2728 $facedata->{version} == 2
2729 or cf::cleanup "$path: version mismatch, cannot proceed.";
2101 2730
2102Return a hashref for use by the extension C<$family>, which can be
2103modified. After modifications, you have to call C<cf::db_dirty> or
2104C<cf::db_sync>.
2105
2106=item $value = cf::db_get $family => $key
2107
2108Returns a single value from the database
2109
2110=item cf::db_put $family => $hashref
2111
2112Stores the given family hashref into the database. Updates are delayed, if
2113you want the data to be synced to disk immediately, use C<cf::db_sync>.
2114
2115=item cf::db_put $family => $key => $value
2116
2117Stores the given C<$value> in the family hash. Updates are delayed, if you
2118want the data to be synced to disk immediately, use C<cf::db_sync>.
2119
2120=item cf::db_dirty
2121
2122Marks the database as dirty, to be updated at a later time.
2123
2124=item cf::db_sync
2125
2126Immediately write the database to disk I<if it is dirty>.
2127
2128=cut
2129
2130our $DB;
2131
2132{
2133 my $path = cf::localdir . "/database.pst";
2134
2135 sub db_load() {
2136 $DB = stat $path ? Storable::retrieve $path : { };
2137 } 2731 {
2732 my $faces = $facedata->{faceinfo};
2138 2733
2139 my $pid; 2734 while (my ($face, $info) = each %$faces) {
2735 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2736 cf::face::set_visibility $idx, $info->{visibility};
2737 cf::face::set_magicmap $idx, $info->{magicmap};
2738 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2739 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2140 2740
2141 sub db_save() { 2741 cf::cede_to_tick;
2142 waitpid $pid, 0 if $pid;
2143 if (0 == ($pid = fork)) {
2144 $DB->{_meta}{version} = 1;
2145 Storable::nstore $DB, "$path~";
2146 rename "$path~", $path;
2147 cf::_exit 0 if defined $pid;
2148 }
2149 }
2150
2151 my $dirty;
2152
2153 sub db_sync() {
2154 db_save if $dirty;
2155 undef $dirty;
2156 }
2157
2158 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2159 db_sync;
2160 });
2161
2162 sub db_dirty() {
2163 $dirty = 1;
2164 $idle->start;
2165 }
2166
2167 sub db_get($;$) {
2168 @_ >= 2
2169 ? $DB->{$_[0]}{$_[1]}
2170 : ($DB->{$_[0]} ||= { })
2171 }
2172
2173 sub db_put($$;$) {
2174 if (@_ >= 3) {
2175 $DB->{$_[0]}{$_[1]} = $_[2];
2176 } else {
2177 $DB->{$_[0]} = $_[1];
2178 }
2179 db_dirty;
2180 }
2181
2182 cf::global->attach (
2183 prio => 10000,
2184 on_cleanup => sub {
2185 db_sync;
2186 }, 2742 }
2187 );
2188}
2189 2743
2190############################################################################# 2744 while (my ($face, $info) = each %$faces) {
2191# the server's main() 2745 next unless $info->{smooth};
2746 my $idx = cf::face::find $face
2747 or next;
2748 if (my $smooth = cf::face::find $info->{smooth}) {
2749 cf::face::set_smooth $idx, $smooth;
2750 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2751 } else {
2752 warn "smooth face '$info->{smooth}' not found for face '$face'";
2753 }
2754
2755 cf::cede_to_tick;
2756 }
2757 }
2758
2759 {
2760 my $anims = $facedata->{animinfo};
2761
2762 while (my ($anim, $info) = each %$anims) {
2763 cf::anim::set $anim, $info->{frames}, $info->{facings};
2764 cf::cede_to_tick;
2765 }
2766
2767 cf::anim::invalidate_all; # d'oh
2768 }
2769
2770 {
2771 # TODO: for gcfclient pleasure, we should give resources
2772 # that gcfclient doesn't grok a >10000 face index.
2773 my $res = $facedata->{resource};
2774 my $enc = JSON::XS->new->utf8->canonical;
2775
2776 while (my ($name, $info) = each %$res) {
2777 my $meta = $enc->encode ({
2778 name => $name,
2779 type => $info->{type},
2780 copyright => $info->{copyright}, #TODO#
2781 });
2782
2783 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2784
2785 if ($name =~ /\.jpg$/) {
2786 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2787 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2788 } else {
2789 my $data = pack "(w/a*)*", $meta, $info->{data};
2790 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2791
2792 cf::face::set_type $idx, 1;
2793 cf::face::set_data $idx, 0, $data, $chk;
2794 }
2795
2796 cf::cede_to_tick;
2797 }
2798 }
2799
2800 1
2801}
2802
2803sub reload_regions {
2804 load_resource_file "$MAPDIR/regions"
2805 or die "unable to load regions file\n";
2806
2807 for (cf::region::list) {
2808 $_->{match} = qr/$_->{match}/
2809 if exists $_->{match};
2810 }
2811}
2812
2813sub reload_facedata {
2814 load_facedata "$DATADIR/facedata"
2815 or die "unable to load facedata\n";
2816}
2817
2818sub reload_archetypes {
2819 load_resource_file "$DATADIR/archetypes"
2820 or die "unable to load archetypes\n";
2821 #d# NEED to laod twice to resolve forward references
2822 # this really needs to be done in an extra post-pass
2823 # (which needs to be synchronous, so solve it differently)
2824 load_resource_file "$DATADIR/archetypes"
2825 or die "unable to load archetypes\n";
2826}
2827
2828sub reload_treasures {
2829 load_resource_file "$DATADIR/treasures"
2830 or die "unable to load treasurelists\n";
2831}
2832
2833sub reload_resources {
2834 warn "reloading resource files...\n";
2835
2836 reload_regions;
2837 reload_facedata;
2838 #reload_archetypes;#d#
2839 reload_archetypes;
2840 reload_treasures;
2841
2842 warn "finished reloading resource files\n";
2843}
2844
2845sub init {
2846 reload_resources;
2847}
2192 2848
2193sub cfg_load { 2849sub cfg_load {
2194 open my $fh, "<:utf8", cf::confdir . "/config" 2850 open my $fh, "<:utf8", "$CONFDIR/config"
2195 or return; 2851 or return;
2196 2852
2197 local $/; 2853 local $/;
2198 *CFG = YAML::Syck::Load <$fh>; 2854 *CFG = YAML::Syck::Load <$fh>;
2199 2855
2213 2869
2214sub main { 2870sub main {
2215 # we must not ever block the main coroutine 2871 # we must not ever block the main coroutine
2216 local $Coro::idle = sub { 2872 local $Coro::idle = sub {
2217 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2873 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2874 (async {
2218 async { Event::one_event }; 2875 Event::one_event;
2876 })->prio (Coro::PRIO_MAX);
2219 }; 2877 };
2220 2878
2221 cfg_load; 2879 cfg_load;
2222 db_load; 2880 db_init;
2223 load_extensions; 2881 load_extensions;
2882
2883 $TICK_WATCHER->start;
2224 Event::loop; 2884 Event::loop;
2225} 2885}
2226 2886
2227############################################################################# 2887#############################################################################
2228# initialisation and cleanup 2888# initialisation and cleanup
2229 2889
2230# install some emergency cleanup handlers 2890# install some emergency cleanup handlers
2231BEGIN { 2891BEGIN {
2232 for my $signal (qw(INT HUP TERM)) { 2892 for my $signal (qw(INT HUP TERM)) {
2233 Event->signal ( 2893 Event->signal (
2894 reentrant => 0,
2234 data => WF_AUTOCANCEL, 2895 data => WF_AUTOCANCEL,
2235 signal => $signal, 2896 signal => $signal,
2897 prio => 0,
2236 cb => sub { 2898 cb => sub {
2237 cf::cleanup "SIG$signal"; 2899 cf::cleanup "SIG$signal";
2238 }, 2900 },
2239 ); 2901 );
2240 } 2902 }
2903}
2904
2905sub write_runtime {
2906 my $runtime = "$LOCALDIR/runtime";
2907
2908 # first touch the runtime file to show we are still running:
2909 # the fsync below can take a very very long time.
2910
2911 IO::AIO::aio_utime $runtime, undef, undef;
2912
2913 my $guard = cf::lock_acquire "write_runtime";
2914
2915 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2916 or return;
2917
2918 my $value = $cf::RUNTIME + 90 + 10;
2919 # 10 is the runtime save interval, for a monotonic clock
2920 # 60 allows for the watchdog to kill the server.
2921
2922 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2923 and return;
2924
2925 # always fsync - this file is important
2926 aio_fsync $fh
2927 and return;
2928
2929 # touch it again to show we are up-to-date
2930 aio_utime $fh, undef, undef;
2931
2932 close $fh
2933 or return;
2934
2935 aio_rename "$runtime~", $runtime
2936 and return;
2937
2938 warn "runtime file written.\n";
2939
2940 1
2241} 2941}
2242 2942
2243sub emergency_save() { 2943sub emergency_save() {
2244 my $freeze_guard = cf::freeze_mainloop; 2944 my $freeze_guard = cf::freeze_mainloop;
2245 2945
2262 my $map = $cf::MAP{$path} or next; 2962 my $map = $cf::MAP{$path} or next;
2263 $map->valid or next; 2963 $map->valid or next;
2264 $map->save; 2964 $map->save;
2265 } 2965 }
2266 warn "end emergency map save\n"; 2966 warn "end emergency map save\n";
2967
2968 warn "begin emergency database checkpoint\n";
2969 BDB::db_env_txn_checkpoint $DB_ENV;
2970 warn "end emergency database checkpoint\n";
2267 }; 2971 };
2268 2972
2269 warn "leave emergency perl save\n"; 2973 warn "leave emergency perl save\n";
2270} 2974}
2271 2975
2976sub post_cleanup {
2977 my ($make_core) = @_;
2978
2979 warn Carp::longmess "post_cleanup backtrace"
2980 if $make_core;
2981}
2982
2272sub reload() { 2983sub do_reload_perl() {
2273 # can/must only be called in main 2984 # can/must only be called in main
2274 if ($Coro::current != $Coro::main) { 2985 if ($Coro::current != $Coro::main) {
2275 warn "can only reload from main coroutine\n"; 2986 warn "can only reload from main coroutine";
2276 return; 2987 return;
2277 } 2988 }
2278 2989
2279 warn "reloading..."; 2990 warn "reloading...";
2280 2991
2281 warn "freezing server"; 2992 warn "entering sync_job";
2282 my $guard = freeze_mainloop; 2993
2994 cf::sync_job {
2995 cf::write_runtime; # external watchdog should not bark
2283 cf::emergency_save; 2996 cf::emergency_save;
2997 cf::write_runtime; # external watchdog should not bark
2284 2998
2285 warn "sync database to disk"; 2999 warn "syncing database to disk";
2286 cf::db_sync; 3000 BDB::db_env_txn_checkpoint $DB_ENV;
2287 IO::AIO::flush;
2288 3001
2289 eval {
2290 # if anything goes wrong in here, we should simply crash as we already saved 3002 # if anything goes wrong in here, we should simply crash as we already saved
2291 3003
2292 warn "cancel all watchers"; 3004 warn "cancelling all WF_AUTOCANCEL watchers";
2293 for (Event::all_watchers) { 3005 for (Event::all_watchers) {
2294 $_->cancel if $_->data & WF_AUTOCANCEL; 3006 $_->cancel if $_->data & WF_AUTOCANCEL;
2295 } 3007 }
2296 3008
3009 warn "flushing outstanding aio requests";
3010 for (;;) {
3011 BDB::flush;
3012 IO::AIO::flush;
3013 Coro::cede;
3014 last unless IO::AIO::nreqs || BDB::nreqs;
3015 warn "iterate...";
3016 }
3017
3018 ++$RELOAD;
3019
2297 warn "cancel all extension coros"; 3020 warn "cancelling all extension coros";
2298 $_->cancel for values %EXT_CORO; 3021 $_->cancel for values %EXT_CORO;
2299 %EXT_CORO = (); 3022 %EXT_CORO = ();
2300 3023
2301 warn "remove commands"; 3024 warn "removing commands";
2302 %COMMAND = (); 3025 %COMMAND = ();
2303 3026
2304 warn "remove ext commands"; 3027 warn "removing ext/exti commands";
2305 %EXTCMD = (); 3028 %EXTCMD = ();
3029 %EXTICMD = ();
2306 3030
2307 warn "unload/nuke all extensions"; 3031 warn "unloading/nuking all extensions";
2308 for my $pkg (@EXTS) { 3032 for my $pkg (@EXTS) {
2309 warn "... unloading $pkg"; 3033 warn "... unloading $pkg";
2310 3034
2311 if (my $cb = $pkg->can ("unload")) { 3035 if (my $cb = $pkg->can ("unload")) {
2312 eval { 3036 eval {
2317 3041
2318 warn "... nuking $pkg"; 3042 warn "... nuking $pkg";
2319 Symbol::delete_package $pkg; 3043 Symbol::delete_package $pkg;
2320 } 3044 }
2321 3045
2322 warn "unload all perl modules loaded from $LIBDIR"; 3046 warn "unloading all perl modules loaded from $LIBDIR";
2323 while (my ($k, $v) = each %INC) { 3047 while (my ($k, $v) = each %INC) {
2324 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3048 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2325 3049
2326 warn "removing <$k>"; 3050 warn "... unloading $k";
2327 delete $INC{$k}; 3051 delete $INC{$k};
2328 3052
2329 $k =~ s/\.pm$//; 3053 $k =~ s/\.pm$//;
2330 $k =~ s/\//::/g; 3054 $k =~ s/\//::/g;
2331 3055
2334 } 3058 }
2335 3059
2336 Symbol::delete_package $k; 3060 Symbol::delete_package $k;
2337 } 3061 }
2338 3062
2339 warn "get rid of safe::, as good as possible"; 3063 warn "getting rid of safe::, as good as possible";
2340 Symbol::delete_package "safe::$_" 3064 Symbol::delete_package "safe::$_"
2341 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3065 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2342 3066
2343 warn "unload cf.pm \"a bit\""; 3067 warn "unloading cf.pm \"a bit\"";
2344 delete $INC{"cf.pm"}; 3068 delete $INC{"cf.pm"};
3069 delete $INC{"cf/pod.pm"};
2345 3070
2346 # don't, removes xs symbols, too, 3071 # don't, removes xs symbols, too,
2347 # and global variables created in xs 3072 # and global variables created in xs
2348 #Symbol::delete_package __PACKAGE__; 3073 #Symbol::delete_package __PACKAGE__;
2349 3074
3075 warn "unload completed, starting to reload now";
3076
2350 warn "reloading cf.pm"; 3077 warn "reloading cf.pm";
2351 require cf; 3078 require cf;
2352 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3079 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2353 3080
2354 warn "load config and database again"; 3081 warn "loading config and database again";
2355 cf::cfg_load; 3082 cf::cfg_load;
2356 cf::db_load;
2357 3083
2358 warn "load extensions"; 3084 warn "loading extensions";
2359 cf::load_extensions; 3085 cf::load_extensions;
2360 3086
2361 warn "reattach attachments to objects/players"; 3087 warn "reattaching attachments to objects/players";
2362 _global_reattach; 3088 _global_reattach; # objects, sockets
2363 warn "reattach attachments to maps"; 3089 warn "reattaching attachments to maps";
2364 reattach $_ for values %MAP; 3090 reattach $_ for values %MAP;
2365 }; 3091 warn "reattaching attachments to players";
3092 reattach $_ for values %PLAYER;
2366 3093
2367 if ($@) { 3094 warn "leaving sync_job";
3095
3096 1
3097 } or do {
2368 warn $@; 3098 warn $@;
2369 warn "error while reloading, exiting."; 3099 warn "error while reloading, exiting.";
2370 exit 1; 3100 exit 1;
2371 } 3101 };
2372 3102
2373 warn "reloaded"; 3103 warn "reloaded";
2374}; 3104};
2375 3105
3106our $RELOAD_WATCHER; # used only during reload
3107
3108sub reload_perl() {
3109 # doing reload synchronously and two reloads happen back-to-back,
3110 # coro crashes during coro_state_free->destroy here.
3111
3112 $RELOAD_WATCHER ||= Event->timer (
3113 reentrant => 0,
3114 after => 0,
3115 data => WF_AUTOCANCEL,
3116 cb => sub {
3117 do_reload_perl;
3118 undef $RELOAD_WATCHER;
3119 },
3120 );
3121}
3122
2376register_command "reload" => sub { 3123register_command "reload" => sub {
2377 my ($who, $arg) = @_; 3124 my ($who, $arg) = @_;
2378 3125
2379 if ($who->flag (FLAG_WIZ)) { 3126 if ($who->flag (FLAG_WIZ)) {
2380 $who->message ("start of reload.");
2381 reload;
2382 $who->message ("end of reload."); 3127 $who->message ("reloading server.");
3128 async { reload_perl };
2383 } 3129 }
2384}; 3130};
2385 3131
2386unshift @INC, $LIBDIR; 3132unshift @INC, $LIBDIR;
2387 3133
3134my $bug_warning = 0;
3135
3136our @WAIT_FOR_TICK;
3137our @WAIT_FOR_TICK_BEGIN;
3138
3139sub wait_for_tick {
3140 return unless $TICK_WATCHER->is_active;
3141 return if $Coro::current == $Coro::main;
3142
3143 my $signal = new Coro::Signal;
3144 push @WAIT_FOR_TICK, $signal;
3145 $signal->wait;
3146}
3147
3148sub wait_for_tick_begin {
3149 return unless $TICK_WATCHER->is_active;
3150 return if $Coro::current == $Coro::main;
3151
3152 my $signal = new Coro::Signal;
3153 push @WAIT_FOR_TICK_BEGIN, $signal;
3154 $signal->wait;
3155}
3156
3157 my $min = 1e6;#d#
3158 my $avg = 10;
2388$TICK_WATCHER = Event->timer ( 3159$TICK_WATCHER = Event->timer (
2389 reentrant => 0, 3160 reentrant => 0,
3161 parked => 1,
2390 prio => 0, 3162 prio => 0,
2391 at => $NEXT_TICK || $TICK, 3163 at => $NEXT_TICK || $TICK,
2392 data => WF_AUTOCANCEL, 3164 data => WF_AUTOCANCEL,
2393 cb => sub { 3165 cb => sub {
3166 if ($Coro::current != $Coro::main) {
3167 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3168 unless ++$bug_warning > 10;
3169 return;
3170 }
3171
2394 $NOW = Event::time; 3172 $NOW = $tick_start = Event::time;
2395 3173
2396 cf::server_tick; # one server iteration 3174 cf::server_tick; # one server iteration
3175
3176 0 && sync_job {#d#
3177 for(1..10) {
3178 my $t = Event::time;
3179 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3180 or die;
3181
3182 $map->width (50);
3183 $map->height (50);
3184 $map->alloc;
3185 $map->_load_objects ("/tmp/x.map", 1);
3186 my $t = Event::time - $t;
3187
3188 #next unless $t < 0.0013;#d#
3189 if ($t < $min) {
3190 $min = $t;
3191 }
3192 $avg = $avg * 0.99 + $t * 0.01;
3193 }
3194 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3195 exit 0;
3196 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3197 };
3198
2397 $RUNTIME += $TICK; 3199 $RUNTIME += $TICK;
2398 $NEXT_TICK += $TICK; 3200 $NEXT_TICK += $TICK;
2399 3201
2400 $WAIT_FOR_TICK->broadcast; 3202 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2401 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3203 $NEXT_RUNTIME_WRITE = $NOW + 10;
3204 Coro::async_pool {
3205 write_runtime
3206 or warn "ERROR: unable to write runtime file: $!";
3207 };
3208 }
3209
3210# my $AFTER = Event::time;
3211# warn $AFTER - $NOW;#d#
3212
3213 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3214 $sig->send;
3215 }
3216 while (my $sig = shift @WAIT_FOR_TICK) {
3217 $sig->send;
3218 }
3219
3220 $NOW = Event::time;
2402 3221
2403 # if we are delayed by four ticks or more, skip them all 3222 # if we are delayed by four ticks or more, skip them all
2404 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3223 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2405 3224
2406 $TICK_WATCHER->at ($NEXT_TICK); 3225 $TICK_WATCHER->at ($NEXT_TICK);
2407 $TICK_WATCHER->start; 3226 $TICK_WATCHER->start;
3227
3228 $LOAD = ($NOW - $tick_start) / $TICK;
3229 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3230
3231 _post_tick;
3232
3233
2408 }, 3234 },
2409); 3235);
2410 3236
3237{
3238 BDB::max_poll_time $TICK * 0.1;
3239 $BDB_POLL_WATCHER = Event->io (
3240 reentrant => 0,
3241 fd => BDB::poll_fileno,
3242 poll => 'r',
3243 prio => 0,
3244 data => WF_AUTOCANCEL,
3245 cb => \&BDB::poll_cb,
3246 );
3247 BDB::min_parallel 8;
3248
3249 BDB::set_sync_prepare {
3250 my $status;
3251 my $current = $Coro::current;
3252 (
3253 sub {
3254 $status = $!;
3255 $current->ready; undef $current;
3256 },
3257 sub {
3258 Coro::schedule while defined $current;
3259 $! = $status;
3260 },
3261 )
3262 };
3263
3264 unless ($DB_ENV) {
3265 $DB_ENV = BDB::db_env_create;
3266
3267 cf::sync_job {
3268 eval {
3269 BDB::db_env_open
3270 $DB_ENV,
3271 $BDBDIR,
3272 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3273 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3274 0666;
3275
3276 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3277
3278 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3279 $DB_ENV->set_lk_detect;
3280 };
3281
3282 cf::cleanup "db_env_open(db): $@" if $@;
3283 };
3284 }
3285}
3286
3287{
3288 IO::AIO::min_parallel 8;
3289
3290 undef $Coro::AIO::WATCHER;
2411IO::AIO::max_poll_time $TICK * 0.2; 3291 IO::AIO::max_poll_time $TICK * 0.1;
2412
2413$AIO_POLL_WATCHER = Event->io ( 3292 $AIO_POLL_WATCHER = Event->io (
2414 fd => IO::AIO::poll_fileno, 3293 reentrant => 0,
2415 poll => 'r',
2416 prio => 5,
2417 data => WF_AUTOCANCEL,
2418 cb => \&IO::AIO::poll_cb,
2419);
2420
2421$WRITE_RUNTIME_WATCHER = Event->timer (
2422 data => WF_AUTOCANCEL, 3294 data => WF_AUTOCANCEL,
2423 after => 0, 3295 fd => IO::AIO::poll_fileno,
2424 interval => 10, 3296 poll => 'r',
2425 cb => sub { 3297 prio => 6,
2426 (Coro::unblock_sub { 3298 cb => \&IO::AIO::poll_cb,
2427 write_runtime 3299 );
2428 or warn "ERROR: unable to write runtime file: $!"; 3300}
3301
3302my $_log_backtrace;
3303
3304sub _log_backtrace {
3305 my ($msg, @addr) = @_;
3306
3307 $msg =~ s/\n//;
3308
3309 # limit the # of concurrent backtraces
3310 if ($_log_backtrace < 2) {
3311 ++$_log_backtrace;
3312 async {
3313 my @bt = fork_call {
3314 @addr = map { sprintf "%x", $_ } @addr;
3315 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3316 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3317 or die "addr2line: $!";
3318
3319 my @funcs;
3320 my @res = <$fh>;
3321 chomp for @res;
3322 while (@res) {
3323 my ($func, $line) = splice @res, 0, 2, ();
3324 push @funcs, "[$func] $line";
3325 }
3326
3327 @funcs
3328 };
3329
3330 LOG llevInfo, "[ABT] $msg\n";
3331 LOG llevInfo, "[ABT] $_\n" for @bt;
3332 --$_log_backtrace;
2429 })->(); 3333 };
3334 } else {
3335 LOG llevInfo, "[ABT] $msg\n";
3336 LOG llevInfo, "[ABT] [suppressed]\n";
2430 }, 3337 }
2431); 3338}
3339
3340# load additional modules
3341use cf::pod;
2432 3342
2433END { cf::emergency_save } 3343END { cf::emergency_save }
2434 3344
24351 33451
2436 3346

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines