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.173 by root, Sun Jan 14 18:00:34 2007 UTC vs.
Revision 1.311 by root, Fri Jul 20 16:11:10 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
552 $registry = $CB_TYPE[$object_type] ||= []; 783 $registry = $CB_TYPE[$object_type] ||= [];
553 784
554 } elsif ($type eq "subtype") { 785 } elsif ($type eq "subtype") {
555 defined $object_type or Carp::croak "subtype specified without type"; 786 defined $object_type or Carp::croak "subtype specified without type";
556 my $object_subtype = shift @arg; 787 my $object_subtype = shift @arg;
557 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 788 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
558 789
559 } elsif ($type eq "package") { 790 } elsif ($type eq "package") {
560 my $pkg = shift @arg; 791 my $pkg = shift @arg;
561 792
562 while (my ($name, $id) = each %cb_id) { 793 while (my ($name, $id) = each %cb_id) {
591 _attach $registry, $klass, @attach; 822 _attach $registry, $klass, @attach;
592 } 823 }
593 824
594 $obj->{$name} = \%arg; 825 $obj->{$name} = \%arg;
595 } else { 826 } else {
596 warn "object uses attachment '$name' that is not available, postponing.\n"; 827 warn "object uses attachment '$name' which is not available, postponing.\n";
597 } 828 }
598 829
599 $obj->{_attachment}{$name} = undef; 830 $obj->{_attachment}{$name} = undef;
600} 831}
601 832
603 if (ref $_[0]) { 834 if (ref $_[0]) {
604 _object_attach @_; 835 _object_attach @_;
605 } else { 836 } else {
606 _attach shift->_attach_registry, @_; 837 _attach shift->_attach_registry, @_;
607 } 838 }
839 _recalc_want;
608}; 840};
609 841
610# all those should be optimised 842# all those should be optimised
611sub cf::attachable::detach { 843sub cf::attachable::detach {
612 my ($obj, $name) = @_; 844 my ($obj, $name) = @_;
615 delete $obj->{_attachment}{$name}; 847 delete $obj->{_attachment}{$name};
616 reattach ($obj); 848 reattach ($obj);
617 } else { 849 } else {
618 Carp::croak "cannot, currently, detach class attachments"; 850 Carp::croak "cannot, currently, detach class attachments";
619 } 851 }
852 _recalc_want;
620}; 853};
621 854
622sub cf::attachable::attached { 855sub cf::attachable::attached {
623 my ($obj, $name) = @_; 856 my ($obj, $name) = @_;
624 857
639 "; 872 ";
640 die if $@; 873 die if $@;
641} 874}
642 875
643our $override; 876our $override;
644our @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?
645 878
646sub override { 879sub override {
647 $override = 1; 880 $override = 1;
648 @invoke_results = (); 881 @INVOKE_RESULTS = (@_);
649} 882}
650 883
651sub do_invoke { 884sub do_invoke {
652 my $event = shift; 885 my $event = shift;
653 my $callbacks = shift; 886 my $callbacks = shift;
654 887
655 @invoke_results = (); 888 @INVOKE_RESULTS = ();
656 889
657 local $override; 890 local $override;
658 891
659 for (@$callbacks) { 892 for (@$callbacks) {
660 eval { &{$_->[1]} }; 893 eval { &{$_->[1]} };
677 910
678Generate an object-specific event with the given arguments. 911Generate an object-specific event with the given arguments.
679 912
680This 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
681removed 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
682results (if you must, access C<@cf::invoke_results> directly). 915results (if you must, access C<@cf::INVOKE_RESULTS> directly).
683 916
684=back 917=back
685 918
686=cut 919=cut
687 920
747 $filename, length $$rdata, scalar @$objs; 980 $filename, length $$rdata, scalar @$objs;
748 981
749 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 982 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
750 chmod SAVE_MODE, $fh; 983 chmod SAVE_MODE, $fh;
751 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 984 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
752 aio_fsync $fh; 985 aio_fsync $fh if $cf::USE_FSYNC;
753 close $fh; 986 close $fh;
754 987
755 if (@$objs) { 988 if (@$objs) {
756 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) {
757 chmod SAVE_MODE, $fh; 990 chmod SAVE_MODE, $fh;
758 my $data = Storable::nfreeze { version => 1, objs => $objs }; 991 my $data = Storable::nfreeze { version => 1, objs => $objs };
759 aio_write $fh, 0, (length $data), $data, 0; 992 aio_write $fh, 0, (length $data), $data, 0;
760 aio_fsync $fh; 993 aio_fsync $fh if $cf::USE_FSYNC;
761 close $fh; 994 close $fh;
762 aio_rename "$filename.pst~", "$filename.pst"; 995 aio_rename "$filename.pst~", "$filename.pst";
763 } 996 }
764 } else { 997 } else {
765 aio_unlink "$filename.pst"; 998 aio_unlink "$filename.pst";
797 or return; 1030 or return;
798 $av = eval { (Storable::thaw $av)->{objs} }; 1031 $av = eval { (Storable::thaw $av)->{objs} };
799 } 1032 }
800 1033
801 warn sprintf "loading %s (%d)\n", 1034 warn sprintf "loading %s (%d)\n",
802 $filename, length $data, scalar @{$av || []};#d# 1035 $filename, length $data, scalar @{$av || []};
803 return ($data, $av); 1036 return ($data, $av);
804} 1037}
1038
1039=head2 COMMAND CALLBACKS
1040
1041=over 4
1042
1043=cut
805 1044
806############################################################################# 1045#############################################################################
807# command handling &c 1046# command handling &c
808 1047
809=item cf::register_command $name => \&callback($ob,$args); 1048=item cf::register_command $name => \&callback($ob,$args);
822 push @{ $COMMAND{$name} }, [$caller, $cb]; 1061 push @{ $COMMAND{$name} }, [$caller, $cb];
823} 1062}
824 1063
825=item cf::register_extcmd $name => \&callback($pl,$packet); 1064=item cf::register_extcmd $name => \&callback($pl,$packet);
826 1065
827Register 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.
828 1071
829If 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
830called. 1073called.
831 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
832=cut 1086=cut
833 1087
834sub register_extcmd { 1088sub register_extcmd {
835 my ($name, $cb) = @_; 1089 my ($name, $cb) = @_;
836 1090
837 $EXTCMD{$name} = $cb; 1091 $EXTCMD{$name} = $cb;
1092}
1093
1094sub register_exticmd {
1095 my ($name, $cb) = @_;
1096
1097 $EXTICMD{$name} = $cb;
838} 1098}
839 1099
840cf::player->attach ( 1100cf::player->attach (
841 on_command => sub { 1101 on_command => sub {
842 my ($pl, $name, $params) = @_; 1102 my ($pl, $name, $params) = @_;
851 cf::override; 1111 cf::override;
852 }, 1112 },
853 on_extcmd => sub { 1113 on_extcmd => sub {
854 my ($pl, $buf) = @_; 1114 my ($pl, $buf) = @_;
855 1115
856 my $msg = eval { from_json $buf }; 1116 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
857 1117
858 if (ref $msg) { 1118 if (ref $msg) {
859 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1119 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
860 if (my %reply = $cb->($pl, $msg)) { 1120 if (my %reply = $cb->($pl, $msg)) {
861 $pl->ext_reply ($msg->{msgid}, %reply); 1121 $pl->ext_reply ($msg->{msgid}, %reply);
867 1127
868 cf::override; 1128 cf::override;
869 }, 1129 },
870); 1130);
871 1131
872sub load_extension {
873 my ($path) = @_;
874
875 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
876 my $base = $1;
877 my $pkg = $1;
878 $pkg =~ s/[^[:word:]]/_/g;
879 $pkg = "ext::$pkg";
880
881 warn "... loading '$path' into '$pkg'\n";
882
883 open my $fh, "<:utf8", $path
884 or die "$path: $!";
885
886 my $source =
887 "package $pkg; use strict; use utf8;\n"
888 . "#line 1 \"$path\"\n{\n"
889 . (do { local $/; <$fh> })
890 . "\n};\n1";
891
892 unless (eval $source) {
893 my $msg = $@ ? "$path: $@\n"
894 : "extension disabled.\n";
895 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
896 warn $@;
897 warn "mandatory extension failed to load, exiting.\n";
898 exit 1;
899 }
900 die $@;
901 }
902
903 push @EXTS, $pkg;
904}
905
906sub load_extensions { 1132sub load_extensions {
1133 cf::sync_job {
1134 my %todo;
1135
907 for my $ext (<$LIBDIR/*.ext>) { 1136 for my $path (<$LIBDIR/*.ext>) {
908 next unless -r $ext; 1137 next unless -r $path;
909 eval { 1138
910 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;
911 1 1196 }
912 } or warn "$ext not loaded: $@"; 1197
1198 skip:
1199 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1200 unless $progress;
1201 }
913 } 1202 };
914} 1203}
915 1204
916############################################################################# 1205#############################################################################
917 1206
1207=back
1208
918=head2 CORE EXTENSIONS 1209=head2 CORE EXTENSIONS
919 1210
920Functions and methods that extend core crossfire objects. 1211Functions and methods that extend core crossfire objects.
921 1212
922=cut 1213=cut
934Returns the given player object, loading it if necessary (might block). 1225Returns the given player object, loading it if necessary (might block).
935 1226
936=cut 1227=cut
937 1228
938sub playerdir($) { 1229sub playerdir($) {
939 cf::localdir 1230 "$PLAYERDIR/"
940 . "/"
941 . cf::playerdir
942 . "/"
943 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1231 . (ref $_[0] ? $_[0]->ob->name : $_[0])
944} 1232}
945 1233
946sub path($) { 1234sub path($) {
947 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1235 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
948 1236
949 (playerdir $login) . "/$login.pl" 1237 (playerdir $login) . "/playerdata"
950} 1238}
951 1239
952sub find_active($) { 1240sub find_active($) {
953 $cf::PLAYER{$_[0]} 1241 $cf::PLAYER{$_[0]}
954 and $cf::PLAYER{$_[0]}->active 1242 and $cf::PLAYER{$_[0]}->active
957 1245
958sub exists($) { 1246sub exists($) {
959 my ($login) = @_; 1247 my ($login) = @_;
960 1248
961 $cf::PLAYER{$login} 1249 $cf::PLAYER{$login}
962 or cf::sync_job { !aio_stat $login } 1250 or cf::sync_job { !aio_stat path $login }
963} 1251}
964 1252
965sub find($) { 1253sub find($) {
966 return $cf::PLAYER{$_[0]} || do { 1254 return $cf::PLAYER{$_[0]} || do {
967 my $login = $_[0]; 1255 my $login = $_[0];
968 1256
969 my $guard = cf::lock_acquire "user_find:$login"; 1257 my $guard = cf::lock_acquire "user_find:$login";
970 1258
971 $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
972 my $pl = load_pl path $login 1267 my $pl = load_pl path $login
973 or return; 1268 or return;
974 $cf::PLAYER{$login} = $pl 1269 $cf::PLAYER{$login} = $pl
975 } 1270 }
976 } 1271 }
1013 1308
1014=cut 1309=cut
1015 1310
1016sub quit_character { 1311sub quit_character {
1017 my ($pl) = @_; 1312 my ($pl) = @_;
1313
1314 my $name = $pl->ob->name;
1018 1315
1019 $pl->{deny_save} = 1; 1316 $pl->{deny_save} = 1;
1020 $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
1021 1318
1022 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1319 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1027 my $path = playerdir $pl; 1324 my $path = playerdir $pl;
1028 my $temp = "$path~$cf::RUNTIME~deleting~"; 1325 my $temp = "$path~$cf::RUNTIME~deleting~";
1029 aio_rename $path, $temp; 1326 aio_rename $path, $temp;
1030 delete $cf::PLAYER{$pl->ob->name}; 1327 delete $cf::PLAYER{$pl->ob->name};
1031 $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
1032 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;
1033} 1350}
1034 1351
1035=item cf::player::list_logins 1352=item cf::player::list_logins
1036 1353
1037Returns 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
1038while and may block, so not sync_job-capable, ever. 1355while and may block, so not sync_job-capable, ever.
1039 1356
1040=cut 1357=cut
1041 1358
1042sub list_logins { 1359sub list_logins {
1043 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1360 my $dirs = aio_readdir $PLAYERDIR
1044 or return []; 1361 or return [];
1045 1362
1046 my @logins; 1363 my @logins;
1047 1364
1048 for my $login (@$dirs) { 1365 for my $login (@$dirs) {
1065=cut 1382=cut
1066 1383
1067sub maps($) { 1384sub maps($) {
1068 my ($pl) = @_; 1385 my ($pl) = @_;
1069 1386
1387 $pl = ref $pl ? $pl->ob->name : $pl;
1388
1070 my $files = aio_readdir playerdir $pl 1389 my $files = aio_readdir playerdir $pl
1071 or return; 1390 or return;
1072 1391
1073 my @paths; 1392 my @paths;
1074 1393
1075 for (@$files) { 1394 for (@$files) {
1076 utf8::decode $_; 1395 utf8::decode $_;
1077 next if /\.(?:pl|pst)$/; 1396 next if /\.(?:pl|pst)$/;
1078 next unless /^$PATH_SEP/o; 1397 next unless /^$PATH_SEP/o;
1079 1398
1080 s/\.map$//; 1399 push @paths, cf::map::normalise "~$pl/$_";
1081 push @paths, "~" . $pl->ob->name . "/" . $_;
1082 } 1400 }
1083 1401
1084 \@paths 1402 \@paths
1085} 1403}
1086 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
1087=item $player->ext_reply ($msgid, $msgtype, %msg) 1455=item $player->ext_reply ($msgid, %msg)
1088 1456
1089Sends an ext reply to the player. 1457Sends an ext reply to the player.
1090 1458
1091=cut 1459=cut
1092 1460
1093sub ext_reply($$$%) { 1461sub ext_reply($$%) {
1094 my ($self, $id, %msg) = @_; 1462 my ($self, $id, %msg) = @_;
1095 1463
1096 $msg{msgid} = $id; 1464 $msg{msgid} = $id;
1097 1465 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1098 $self->send ("ext " . cf::to_json \%msg);
1099} 1466}
1100 1467
1101package 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}
1102 1508
1103=back 1509=back
1104
1105 1510
1106=head3 cf::map 1511=head3 cf::map
1107 1512
1108=over 4 1513=over 4
1109 1514
1121our $MAX_RESET = 3600; 1526our $MAX_RESET = 3600;
1122our $DEFAULT_RESET = 3000; 1527our $DEFAULT_RESET = 3000;
1123 1528
1124sub generate_random_map { 1529sub generate_random_map {
1125 my ($self, $rmp) = @_; 1530 my ($self, $rmp) = @_;
1126
1127 # mit "rum" bekleckern, nicht 1531 # mit "rum" bekleckern, nicht
1128 $self->_create_random_map ( 1532 $self->_create_random_map (
1129 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1533 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1130 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1534 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1131 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1535 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1138 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1542 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1139 (cf::region::find $rmp->{region}), $rmp->{custom} 1543 (cf::region::find $rmp->{region}), $rmp->{custom}
1140 ) 1544 )
1141} 1545}
1142 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
1143sub register { 1555sub register {
1144 my (undef, $regex) = @_; 1556 my (undef, $regex, $prio) = @_;
1145 my $pkg = caller; 1557 my $pkg = caller;
1146 1558
1147 no strict; 1559 no strict;
1148 push @{"$pkg\::ISA"}, __PACKAGE__; 1560 push @{"$pkg\::ISA"}, __PACKAGE__;
1149 1561
1150 $EXT_MAP{$pkg} = qr<$regex>; 1562 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1151} 1563}
1152 1564
1153# also paths starting with '/' 1565# also paths starting with '/'
1154$EXT_MAP{"cf::map"} = qr{^(?=/)}; 1566$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1155 1567
1156sub thawer_merge { 1568sub thawer_merge {
1157 my ($self, $merge) = @_; 1569 my ($self, $merge) = @_;
1158 1570
1159 # we have to keep some variables in memory intact 1571 # we have to keep some variables in memory intact
1160 local $self->{path}; 1572 local $self->{path};
1161 local $self->{load_path}; 1573 local $self->{load_path};
1162 local $self->{deny_save};
1163 local $self->{deny_reset};
1164 1574
1165 $self->SUPER::thawer_merge ($merge); 1575 $self->SUPER::thawer_merge ($merge);
1166} 1576}
1167 1577
1168sub normalise { 1578sub normalise {
1169 my ($path, $base) = @_; 1579 my ($path, $base) = @_;
1580
1581 $path = "$path"; # make sure its a string
1582
1583 $path =~ s/\.map$//;
1170 1584
1171 # map plan: 1585 # map plan:
1172 # 1586 #
1173 # /! non-realised random map exit (special hack!) 1587 # /! non-realised random map exit (special hack!)
1174 # {... are special paths that are not being touched 1588 # {... are special paths that are not being touched
1202 1616
1203 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
1204 1618
1205 $path = normalise $path, $base; 1619 $path = normalise $path, $base;
1206 1620
1207 for my $pkg (keys %EXT_MAP) { 1621 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1208 if ($path =~ $EXT_MAP{$pkg}) { 1622 if ($path =~ $EXT_MAP{$pkg}[1]) {
1209 my $self = bless cf::map::new, $pkg; 1623 my $self = bless cf::map::new, $pkg;
1210 $self->{path} = $path; $self->path ($path); 1624 $self->{path} = $path; $self->path ($path);
1211 $self->init; # pass $1 etc. 1625 $self->init; # pass $1 etc.
1212 return $self; 1626 return $self;
1213 } 1627 }
1214 } 1628 }
1215 1629
1216 Carp::carp "unable to resolve path '$path'."; 1630 Carp::cluck "unable to resolve path '$path' (base '$base').";
1217 () 1631 ()
1218} 1632}
1219 1633
1220sub init { 1634sub init {
1221 my ($self) = @_; 1635 my ($self) = @_;
1236 1650
1237# the original (read-only) location 1651# the original (read-only) location
1238sub load_path { 1652sub load_path {
1239 my ($self) = @_; 1653 my ($self) = @_;
1240 1654
1241 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1655 "$MAPDIR/$self->{path}.map"
1242} 1656}
1243 1657
1244# the temporary/swap location 1658# the temporary/swap location
1245sub save_path { 1659sub save_path {
1246 my ($self) = @_; 1660 my ($self) = @_;
1247 1661
1248 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1662 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1249 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1663 "$TMPDIR/$path.map"
1250} 1664}
1251 1665
1252# the unique path, undef == no special unique path 1666# the unique path, undef == no special unique path
1253sub uniq_path { 1667sub uniq_path {
1254 my ($self) = @_; 1668 my ($self) = @_;
1255 1669
1256 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1670 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1257 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1671 "$UNIQUEDIR/$path"
1258} 1672}
1259 1673
1260# and all this just because we cannot iterate over 1674# and all this just because we cannot iterate over
1261# all maps in C++... 1675# all maps in C++...
1262sub change_all_map_light { 1676sub change_all_map_light {
1264 1678
1265 $_->change_map_light ($change) 1679 $_->change_map_light ($change)
1266 for grep $_->outdoor, values %cf::MAP; 1680 for grep $_->outdoor, values %cf::MAP;
1267} 1681}
1268 1682
1683sub decay_objects {
1684 my ($self) = @_;
1685
1686 return if $self->{deny_reset};
1687
1688 $self->do_decay_objects;
1689}
1690
1269sub unlink_save { 1691sub unlink_save {
1270 my ($self) = @_; 1692 my ($self) = @_;
1271 1693
1272 utf8::encode (my $save = $self->save_path); 1694 utf8::encode (my $save = $self->save_path);
1273 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1695 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1276 1698
1277sub load_header_from($) { 1699sub load_header_from($) {
1278 my ($self, $path) = @_; 1700 my ($self, $path) = @_;
1279 1701
1280 utf8::encode $path; 1702 utf8::encode $path;
1281 aio_open $path, O_RDONLY, 0 1703 #aio_open $path, O_RDONLY, 0
1282 or return; 1704 # or return;
1283 1705
1284 $self->_load_header ($path) 1706 $self->_load_header ($path)
1285 or return; 1707 or return;
1286 1708
1287 $self->{load_path} = $path; 1709 $self->{load_path} = $path;
1288 1710
1289 1 1711 1
1290} 1712}
1291 1713
1292sub load_orig { 1714sub load_header_orig {
1293 my ($self) = @_; 1715 my ($self) = @_;
1294 1716
1295 $self->load_header_from ($self->load_path) 1717 $self->load_header_from ($self->load_path)
1296} 1718}
1297 1719
1298sub load_temp { 1720sub load_header_temp {
1299 my ($self) = @_; 1721 my ($self) = @_;
1300 1722
1301 $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;
1302} 1743}
1303 1744
1304sub load_header { 1745sub load_header {
1305 my ($self) = @_; 1746 my ($self) = @_;
1306 1747
1307 if ($self->load_temp) { 1748 if ($self->load_header_temp) {
1308 $self->last_access ((delete $self->{last_access}) 1749 $self->prepare_temp;
1309 || $cf::RUNTIME); #d#
1310 # safety
1311 $self->{instantiate_time} = $cf::RUNTIME
1312 if $self->{instantiate_time} > $cf::RUNTIME;
1313 } else { 1750 } else {
1314 $self->load_orig 1751 $self->load_header_orig
1315 or return; 1752 or return;
1316 1753 $self->prepare_orig;
1317 $self->{load_original} = 1;
1318 $self->{instantiate_time} = $cf::RUNTIME;
1319 $self->last_access ($cf::RUNTIME);
1320 $self->instantiate;
1321 } 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;
1322 1761
1323 1 1762 1
1324} 1763}
1325 1764
1326sub find; 1765sub find;
1339 $map->{last_save} = $cf::RUNTIME; 1778 $map->{last_save} = $cf::RUNTIME;
1340 1779
1341 $map->load_header 1780 $map->load_header
1342 or return; 1781 or return;
1343 1782
1344 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
1345 $cf::WAIT_FOR_TICK->wait; 1785 #$cf::WAIT_FOR_TICK->wait;
1346 $map->reset; 1786 $map->reset;
1347 undef $guard; 1787 undef $guard;
1348 $map = find $path 1788 return find $path;
1349 or return;
1350 } 1789 }
1351 1790
1352 $cf::MAP{$path} = $map 1791 $cf::MAP{$path} = $map
1353 } 1792 }
1354} 1793}
1794
1795sub pre_load { }
1796sub post_load { }
1355 1797
1356sub load { 1798sub load {
1357 my ($self) = @_; 1799 my ($self) = @_;
1358 1800
1801 local $self->{deny_reset} = 1; # loading can take a long time
1802
1359 my $path = $self->{path}; 1803 my $path = $self->{path};
1804
1805 {
1360 my $guard = cf::lock_acquire "map_load:$path"; 1806 my $guard = cf::lock_acquire "map_load:$path";
1361 1807
1362 return if $self->in_memory != cf::MAP_SWAPPED; 1808 return if $self->in_memory != cf::MAP_SWAPPED;
1363 1809
1364 $self->in_memory (cf::MAP_LOADING); 1810 $self->in_memory (cf::MAP_LOADING);
1365 1811
1366 $self->alloc; 1812 $self->alloc;
1367 $self->_load_objects ($self->{load_path}, 1)
1368 or return;
1369 1813
1370 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1814 $self->pre_load;
1371 if delete $self->{load_original};
1372
1373 if (my $uniq = $self->uniq_path) {
1374 utf8::encode $uniq;
1375 if (aio_open $uniq, O_RDONLY, 0) {
1376 $self->clear_unique_items;
1377 $self->_load_objects ($uniq, 0);
1378 }
1379 }
1380
1381 Coro::cede;
1382
1383 # now do the right thing for maps
1384 $self->link_multipart_objects;
1385
1386 unless ($self->{deny_activate}) {
1387 $self->decay_objects;
1388 $self->fix_auto_apply;
1389 $self->update_buttons;
1390 Coro::cede; 1815 Coro::cede;
1391 $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;
1392 $self->difficulty ($self->estimate_difficulty) 1834 $self->difficulty ($self->estimate_difficulty)
1393 unless $self->difficulty; 1835 unless $self->difficulty;
1394 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;
1395 $self->activate; 1845 $self->activate;
1396 } 1846 }
1397 1847
1398 $self->in_memory (cf::MAP_IN_MEMORY); 1848 $self->in_memory (cf::MAP_IN_MEMORY);
1849 }
1850
1851 $self->post_load;
1399} 1852}
1400 1853
1401sub customise_for { 1854sub customise_for {
1402 my ($self, $ob) = @_; 1855 my ($self, $ob) = @_;
1403 1856
1404 return find "~" . $ob->name . "/" . $self->{path} 1857 return find "~" . $ob->name . "/" . $self->{path}
1405 if $self->per_player; 1858 if $self->per_player;
1859
1860# return find "?party/" . $ob->name . "/" . $self->{path}
1861# if $self->per_party;
1406 1862
1407 $self 1863 $self
1408} 1864}
1409 1865
1410# 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
1442 1898
1443 cf::sync_job { $map->load }; 1899 cf::sync_job { $map->load };
1444} 1900}
1445 1901
1446our %MAP_PREFETCH; 1902our %MAP_PREFETCH;
1447our $MAP_PREFETCHER = Coro::async { 1903our $MAP_PREFETCHER = undef;
1448 while () {
1449 for my $path (keys %MAP_PREFETCH) {
1450 my $map = find $path
1451 or next;
1452 $map->load;
1453
1454 delete $MAP_PREFETCH{$path};
1455 }
1456 Coro::schedule;
1457 }
1458};
1459 1904
1460sub find_async { 1905sub find_async {
1461 my ($path, $origin) = @_; 1906 my ($path, $origin) = @_;
1462 1907
1463 $path = normalise $path, $origin && $origin->{path}; 1908 $path = normalise $path, $origin && $origin->{path};
1464 1909
1465 if (my $map = $cf::MAP{$path}) { 1910 if (my $map = $cf::MAP{$path}) {
1466 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1911 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1467 } 1912 }
1468 1913
1469 $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 };
1470 $MAP_PREFETCHER->ready; 1927 $MAP_PREFETCHER->prio (6);
1471 1928
1472 () 1929 ()
1473} 1930}
1474 1931
1475sub save { 1932sub save {
1520 1977
1521sub reset_at { 1978sub reset_at {
1522 my ($self) = @_; 1979 my ($self) = @_;
1523 1980
1524 # TODO: safety, remove and allow resettable per-player maps 1981 # TODO: safety, remove and allow resettable per-player maps
1525 return 1e99 if $self->isa ("ext::map_per_player");#d#
1526 return 1e99 if $self->{deny_reset}; 1982 return 1e99 if $self->{deny_reset};
1527 1983
1528 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 1984 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1529 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;
1530 1986
1535 my ($self) = @_; 1991 my ($self) = @_;
1536 1992
1537 $self->reset_at <= $cf::RUNTIME 1993 $self->reset_at <= $cf::RUNTIME
1538} 1994}
1539 1995
1540sub rename {
1541 my ($self, $new_path) = @_;
1542
1543 normalise $new_path;
1544
1545 $self->unlink_save;
1546
1547 delete $cf::MAP{$self->path};
1548 $self->{path} = $new_path; $self->path ($self->{path});
1549 $cf::MAP{$self->path} = $self;
1550
1551 $self->save;
1552}
1553
1554sub reset { 1996sub reset {
1555 my ($self) = @_; 1997 my ($self) = @_;
1556 1998
1557 my $lock = cf::lock_acquire "map_data:$self->{path}"; 1999 my $lock = cf::lock_acquire "map_data:$self->{path}";
1558 2000
1559 return if $self->players; 2001 return if $self->players;
1560 return if $self->isa ("ext::map_per_player");#d#
1561 2002
1562 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 }
1563 2014
1564 delete $cf::MAP{$self->path}; 2015 delete $cf::MAP{$self->path};
1565 2016
1566 $self->in_memory (cf::MAP_SWAPPED);
1567 $self->clear; 2017 $self->clear;
1568 2018
1569 $_->clear_links_to ($self) for values %cf::MAP; 2019 $_->clear_links_to ($self) for values %cf::MAP;
1570 2020
1571 $self->unlink_save; 2021 $self->unlink_save;
1575my $nuke_counter = "aaaa"; 2025my $nuke_counter = "aaaa";
1576 2026
1577sub nuke { 2027sub nuke {
1578 my ($self) = @_; 2028 my ($self) = @_;
1579 2029
2030 delete $cf::MAP{$self->path};
2031
2032 $self->unlink_save;
2033
2034 bless $self, "cf::map";
2035 delete $self->{deny_reset};
1580 $self->{deny_save} = 1; 2036 $self->{deny_save} = 1;
1581 $self->reset_timeout (1); 2037 $self->reset_timeout (1);
1582 $self->rename ("{nuke}/" . ($nuke_counter++)); 2038 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2039
2040 $cf::MAP{$self->path} = $self;
2041
1583 $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 ]
1584} 2079}
1585 2080
1586=item cf::map::unique_maps 2081=item cf::map::unique_maps
1587 2082
1588Returns an arrayref of paths of all shared maps that have 2083Returns an arrayref of paths of all shared maps that have
1589instantiated unique items. May block. 2084instantiated unique items. May block.
1590 2085
1591=cut 2086=cut
1592 2087
1593sub unique_maps() { 2088sub unique_maps() {
1594 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2089 [
1595 or return; 2090 map {
1596
1597 my @paths;
1598
1599 for (@$files) {
1600 utf8::decode $_; 2091 utf8::decode $_;
1601 next if /\.pst$/;
1602 next unless /^$PATH_SEP/o;
1603
1604 s/\.map$//; 2092 /\.map$/
1605 push @paths, $_; 2093 ? normalise $_
2094 : ()
2095 } @{ aio_readdir $UNIQUEDIR or [] }
1606 } 2096 ]
1607
1608 \@paths
1609} 2097}
1610 2098
1611package cf; 2099package cf;
1612 2100
1613=back 2101=back
1659 2147
1660 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2148 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1661 2149
1662 if ($self->{record_replies}) { 2150 if ($self->{record_replies}) {
1663 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2151 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2152
1664 } 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 {
1665 $msg = $npc->name . " says: $msg" if $npc; 2166 $msg = $npc->name . " says: $msg" if $npc;
1666 $self->message ($msg, $flags); 2167 $self->message ($msg, $flags);
2168 }
1667 } 2169 }
1668} 2170}
1669 2171
1670=item $player_object->may ("access") 2172=item $player_object->may ("access")
1671 2173
1704=cut 2206=cut
1705 2207
1706sub link_map { 2208sub link_map {
1707 unless ($LINK_MAP) { 2209 unless ($LINK_MAP) {
1708 $LINK_MAP = cf::map::find "{link}" 2210 $LINK_MAP = cf::map::find "{link}"
1709 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2211 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1710 $LINK_MAP->load; 2212 $LINK_MAP->load;
1711 } 2213 }
1712 2214
1713 $LINK_MAP 2215 $LINK_MAP
1714} 2216}
1719 $self->deactivate_recursive; 2221 $self->deactivate_recursive;
1720 2222
1721 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2223 return if UNIVERSAL::isa $self->map, "ext::map_link";
1722 2224
1723 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2225 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1724 if $self->map; 2226 if $self->map && $self->map->{path} ne "{link}";
1725 2227
1726 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2228 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1727} 2229}
1728 2230
1729sub cf::object::player::leave_link { 2231sub cf::object::player::leave_link {
1730 my ($self, $map, $x, $y) = @_; 2232 my ($self, $map, $x, $y) = @_;
2233
2234 return unless $self->contr->active;
1731 2235
1732 my $link_pos = delete $self->{_link_pos}; 2236 my $link_pos = delete $self->{_link_pos};
1733 2237
1734 unless ($map) { 2238 unless ($map) {
1735 # restore original map position 2239 # restore original map position
1753 $map->load; 2257 $map->load;
1754 $map->load_diag; 2258 $map->load_diag;
1755 2259
1756 return unless $self->contr->active; 2260 return unless $self->contr->active;
1757 $self->activate_recursive; 2261 $self->activate_recursive;
2262
2263 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1758 $self->enter_map ($map, $x, $y); 2264 $self->enter_map ($map, $x, $y);
1759} 2265}
1760 2266
1761cf::player->attach ( 2267=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1762 on_logout => sub {
1763 my ($pl) = @_;
1764 2268
1765 # abort map switching before logout 2269Moves the player to the given map-path and coordinates by first freezing
1766 if ($pl->ob->{_link_pos}) { 2270her, loading and preparing them map, calling the provided $check callback
1767 cf::sync_job { 2271that has to return the map if sucecssful, and then unfreezes the player on
1768 $pl->ob->leave_link 2272the new (success) or old (failed) map position. In either case, $done will
1769 }; 2273be called at the end of this process.
1770 }
1771 },
1772 on_login => sub {
1773 my ($pl) = @_;
1774 2274
1775 # try to abort aborted map switching on player login :)
1776 # should happen only on crashes
1777 if ($pl->ob->{_link_pos}) {
1778 $pl->ob->enter_link;
1779 (async {
1780 # we need this sleep as the login has a concurrent enter_exit running
1781 # and this sleep increases chances of the player not ending up in scorn
1782 $pl->ob->reply (undef,
1783 "There was an internal problem at your last logout, "
1784 . "the server will try to bring you to your intended destination in a second.",
1785 cf::NDI_RED);
1786 Coro::Timer::sleep 1;
1787 $pl->ob->leave_link;
1788 })->prio (2);
1789 }
1790 },
1791);
1792
1793=item $player_object->goto ($path, $x, $y)
1794
1795=cut 2275=cut
2276
2277our $GOTOGEN;
1796 2278
1797sub cf::object::player::goto { 2279sub cf::object::player::goto {
1798 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;
1799 2284
1800 $self->enter_link; 2285 $self->enter_link;
1801 2286
1802 (async { 2287 (async {
2288 my $map = eval {
1803 my $map = cf::map::find $path; 2289 my $map = cf::map::find $path;
2290
2291 if ($map) {
1804 $map = $map->customise_for ($self) if $map; 2292 $map = $map->customise_for ($self);
1805 2293 $map = $check->($map) if $check && $map;
1806# warn "entering ", $map->path, " at ($x, $y)\n" 2294 } else {
1807# if $map;
1808
1809 $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 }
1810 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};
1811 $self->leave_link ($map, $x, $y); 2308 $self->leave_link ($map, $x, $y);
2309 }
2310
2311 $done->() if $done;
1812 })->prio (1); 2312 })->prio (1);
1813} 2313}
1814 2314
1815=item $player_object->enter_exit ($exit_object) 2315=item $player_object->enter_exit ($exit_object)
1816 2316
1818 2318
1819sub parse_random_map_params { 2319sub parse_random_map_params {
1820 my ($spec) = @_; 2320 my ($spec) = @_;
1821 2321
1822 my $rmp = { # defaults 2322 my $rmp = { # defaults
1823 xsize => 10, 2323 xsize => (cf::rndm 15, 40),
1824 ysize => 10, 2324 ysize => (cf::rndm 15, 40),
2325 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2326 #layout => string,
1825 }; 2327 };
1826 2328
1827 for (split /\n/, $spec) { 2329 for (split /\n/, $spec) {
1828 my ($k, $v) = split /\s+/, $_, 2; 2330 my ($k, $v) = split /\s+/, $_, 2;
1829 2331
1833 $rmp 2335 $rmp
1834} 2336}
1835 2337
1836sub prepare_random_map { 2338sub prepare_random_map {
1837 my ($exit) = @_; 2339 my ($exit) = @_;
2340
2341 my $guard = cf::lock_acquire "exit_prepare:$exit";
1838 2342
1839 # all this does is basically replace the /! path by 2343 # all this does is basically replace the /! path by
1840 # a new random map path (?random/...) with a seed 2344 # a new random map path (?random/...) with a seed
1841 # that depends on the exit object 2345 # that depends on the exit object
1842 2346
1843 my $rmp = parse_random_map_params $exit->msg; 2347 my $rmp = parse_random_map_params $exit->msg;
1844 2348
1845 if ($exit->map) { 2349 if ($exit->map) {
1846 $rmp->{region} = $exit->map->region_name; 2350 $rmp->{region} = $exit->region->name;
1847 $rmp->{origin_map} = $exit->map->path; 2351 $rmp->{origin_map} = $exit->map->path;
1848 $rmp->{origin_x} = $exit->x; 2352 $rmp->{origin_x} = $exit->x;
1849 $rmp->{origin_y} = $exit->y; 2353 $rmp->{origin_y} = $exit->y;
1850 } 2354 }
1851 2355
1852 $rmp->{random_seed} ||= $exit->random_seed; 2356 $rmp->{random_seed} ||= $exit->random_seed;
1853 2357
1854 my $data = cf::to_json $rmp; 2358 my $data = cf::to_json $rmp;
1855 my $md5 = Digest::MD5::md5_hex $data; 2359 my $md5 = Digest::MD5::md5_hex $data;
2360 my $meta = "$RANDOMDIR/$md5.meta";
1856 2361
1857 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) {
1858 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;
1859 2366
1860 $exit->slaying ("?random/$md5"); 2367 $exit->slaying ("?random/$md5");
1861 $exit->msg (undef); 2368 $exit->msg (undef);
1862 } 2369 }
1863} 2370}
1865sub cf::object::player::enter_exit { 2372sub cf::object::player::enter_exit {
1866 my ($self, $exit) = @_; 2373 my ($self, $exit) = @_;
1867 2374
1868 return unless $self->type == cf::PLAYER; 2375 return unless $self->type == cf::PLAYER;
1869 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
1870 $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);
1871 2393
1872 (async { 2394 (async {
1873 $self->deactivate_recursive; # just to be sure 2395 $self->deactivate_recursive; # just to be sure
1874 unless (eval { 2396 unless (eval {
1875 prepare_random_map $exit 2397 $self->goto ($slaying, $hp, $sp);
1876 if $exit->slaying eq "/!";
1877
1878 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1879 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1880 2398
1881 1; 2399 1;
1882 }) { 2400 }) {
1883 $self->message ("Something went wrong deep within the crossfire server. " 2401 $self->message ("Something went wrong deep within the crossfire server. "
1884 . "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. "
1885 . "Please report this to the dungeon master!", 2403 . "Please report this to the dungeon master!",
1886 cf::NDI_UNIQUE | cf::NDI_RED); 2404 cf::NDI_UNIQUE | cf::NDI_RED);
1887 2405
1888 warn "ERROR in enter_exit: $@"; 2406 warn "ERROR in enter_exit: $@";
1889 $self->leave_link; 2407 $self->leave_link;
1890 } 2408 }
1891 })->prio (1); 2409 })->prio (1);
1904 2422
1905sub cf::client::send_drawinfo { 2423sub cf::client::send_drawinfo {
1906 my ($self, $text, $flags) = @_; 2424 my ($self, $text, $flags) = @_;
1907 2425
1908 utf8::encode $text; 2426 utf8::encode $text;
1909 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2427 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1910} 2428}
1911 2429
2430=item $client->send_msg ($channel, $msg, $color, [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, $channel, $msg, $color, @extra) = @_;
2441
2442 $msg = $self->pl->expand_cfpod ($msg);
2443
2444 return unless @extra || length $msg;
2445
2446 $color &= ~cf::NDI_UNIQUE; # just in case...
2447
2448 if (ref $channel) {
2449 # send meta info to client, if not yet sent
2450 unless (exists $self->{channel}{$channel->{id}}) {
2451 $self->{channel}{$channel->{id}} = $channel;
2452 $self->ext_event (channel_info => %$channel);
2453 }
2454
2455 $channel = $channel->{id};
2456 }
2457
2458 if ($self->can_msg) {
2459 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2460 } else {
2461 # replace some tags by gcfclient-compatible ones
2462 for ($msg) {
2463 1 while
2464 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2465 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2466 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2467 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2468 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2469 }
2470
2471 if ($color >= 0) {
2472 if (0 && $msg =~ /\[/) {
2473 $self->send_packet ("drawextinfo $color 4 0 $msg")
2474 } else {
2475 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2476 $self->send_packet ("drawinfo $color $msg")
2477 }
2478 }
2479 }
2480}
2481
2482=item $client->ext_event ($type, %msg)
2483
2484Sends an ext event to the client.
2485
2486=cut
2487
2488sub cf::client::ext_event($$%) {
2489 my ($self, $type, %msg) = @_;
2490
2491 return unless $self->extcmd;
2492
2493 $msg{msgtype} = "event_$type";
2494 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2495}
1912 2496
1913=item $success = $client->query ($flags, "text", \&cb) 2497=item $success = $client->query ($flags, "text", \&cb)
1914 2498
1915Queues a query to the client, calling the given callback with 2499Queues a query to the client, calling the given callback with
1916the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2500the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1917C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2501C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1918 2502
1919Queries can fail, so check the return code. Or don't, as queries will become 2503Queries can fail, so check the return code. Or don't, as queries will
1920reliable at some point in the future. 2504become reliable at some point in the future.
1921 2505
1922=cut 2506=cut
1923 2507
1924sub cf::client::query { 2508sub cf::client::query {
1925 my ($self, $flags, $text, $cb) = @_; 2509 my ($self, $flags, $text, $cb) = @_;
1933 utf8::encode $text; 2517 utf8::encode $text;
1934 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2518 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1935 2519
1936 $self->send_packet ($self->{query_queue}[0][0]) 2520 $self->send_packet ($self->{query_queue}[0][0])
1937 if @{ $self->{query_queue} } == 1; 2521 if @{ $self->{query_queue} } == 1;
2522
2523 1
1938} 2524}
1939 2525
1940cf::client->attach ( 2526cf::client->attach (
2527 on_connect => sub {
2528 my ($ns) = @_;
2529
2530 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2531 },
1941 on_reply => sub { 2532 on_reply => sub {
1942 my ($ns, $msg) = @_; 2533 my ($ns, $msg) = @_;
1943 2534
1944 # this weird shuffling is so that direct followup queries 2535 # this weird shuffling is so that direct followup queries
1945 # get handled first 2536 # get handled first
1946 my $queue = delete $ns->{query_queue} 2537 my $queue = delete $ns->{query_queue}
1947 or return; # be conservative, not sure how that can happen, but we saw a crash here 2538 or return; # be conservative, not sure how that can happen, but we saw a crash here
1948 2539
1949 (shift @$queue)->[1]->($msg); 2540 (shift @$queue)->[1]->($msg);
2541 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1950 2542
1951 push @{ $ns->{query_queue} }, @$queue; 2543 push @{ $ns->{query_queue} }, @$queue;
1952 2544
1953 if (@{ $ns->{query_queue} } == @$queue) { 2545 if (@{ $ns->{query_queue} } == @$queue) {
1954 if (@$queue) { 2546 if (@$queue) {
1956 } else { 2548 } else {
1957 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2549 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1958 } 2550 }
1959 } 2551 }
1960 }, 2552 },
2553 on_exticmd => sub {
2554 my ($ns, $buf) = @_;
2555
2556 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2557
2558 if (ref $msg) {
2559 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2560 if (my %reply = $cb->($ns, $msg)) {
2561 $reply{msgid} = $msg->{msgid};
2562 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2563 }
2564 }
2565 } else {
2566 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2567 }
2568
2569 cf::override;
2570 },
1961); 2571);
1962 2572
1963=item $client->async (\&cb) 2573=item $client->async (\&cb)
1964 2574
1965Create a new coroutine, running the specified callback. The coroutine will 2575Create a new coroutine, running the specified callback. The coroutine will
2012 2622
2013# here we export the classes and methods available to script code 2623# here we export the classes and methods available to script code
2014 2624
2015=pod 2625=pod
2016 2626
2017The following fucntions and emthods are available within a safe environment: 2627The following functions and methods are available within a safe environment:
2018 2628
2019 cf::object contr pay_amount pay_player map 2629 cf::object
2630 contr pay_amount pay_player map x y force_find force_add
2631 insert remove
2632
2020 cf::object::player player 2633 cf::object::player
2021 cf::player peaceful 2634 player
2022 cf::map trigger 2635
2636 cf::player
2637 peaceful
2638
2639 cf::map
2640 trigger
2023 2641
2024=cut 2642=cut
2025 2643
2026for ( 2644for (
2027 ["cf::object" => qw(contr pay_amount pay_player map)], 2645 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2646 insert remove)],
2028 ["cf::object::player" => qw(player)], 2647 ["cf::object::player" => qw(player)],
2029 ["cf::player" => qw(peaceful)], 2648 ["cf::player" => qw(peaceful)],
2030 ["cf::map" => qw(trigger)], 2649 ["cf::map" => qw(trigger)],
2031) { 2650) {
2032 no strict 'refs'; 2651 no strict 'refs';
2103=back 2722=back
2104 2723
2105=cut 2724=cut
2106 2725
2107############################################################################# 2726#############################################################################
2727# the server's init and main functions
2108 2728
2109=head2 EXTENSION DATABASE SUPPORT 2729sub load_facedata($) {
2730 my ($path) = @_;
2110 2731
2111Crossfire maintains a very simple database for extension use. It can 2732 warn "loading facedata from $path\n";
2112currently store anything that can be serialised using Storable, which
2113excludes objects.
2114 2733
2115The parameter C<$family> should best start with the name of the extension 2734 my $facedata;
2116using it, it should be unique. 2735 0 < aio_load $path, $facedata
2736 or die "$path: $!";
2117 2737
2118=over 4 2738 $facedata = Coro::Storable::thaw $facedata;
2119 2739
2120=item $hashref = cf::db_get $family 2740 $facedata->{version} == 2
2741 or cf::cleanup "$path: version mismatch, cannot proceed.";
2121 2742
2122Return a hashref for use by the extension C<$family>, which can be
2123modified. After modifications, you have to call C<cf::db_dirty> or
2124C<cf::db_sync>.
2125
2126=item $value = cf::db_get $family => $key
2127
2128Returns a single value from the database
2129
2130=item cf::db_put $family => $hashref
2131
2132Stores the given family hashref into the database. Updates are delayed, if
2133you want the data to be synced to disk immediately, use C<cf::db_sync>.
2134
2135=item cf::db_put $family => $key => $value
2136
2137Stores the given C<$value> in the family hash. Updates are delayed, if you
2138want the data to be synced to disk immediately, use C<cf::db_sync>.
2139
2140=item cf::db_dirty
2141
2142Marks the database as dirty, to be updated at a later time.
2143
2144=item cf::db_sync
2145
2146Immediately write the database to disk I<if it is dirty>.
2147
2148=cut
2149
2150our $DB;
2151
2152{
2153 my $path = cf::localdir . "/database.pst";
2154
2155 sub db_load() {
2156 $DB = stat $path ? Storable::retrieve $path : { };
2157 } 2743 {
2744 my $faces = $facedata->{faceinfo};
2158 2745
2159 my $pid; 2746 while (my ($face, $info) = each %$faces) {
2747 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2748 cf::face::set_visibility $idx, $info->{visibility};
2749 cf::face::set_magicmap $idx, $info->{magicmap};
2750 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2751 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2160 2752
2161 sub db_save() { 2753 cf::cede_to_tick;
2162 waitpid $pid, 0 if $pid;
2163 if (0 == ($pid = fork)) {
2164 $DB->{_meta}{version} = 1;
2165 Storable::nstore $DB, "$path~";
2166 rename "$path~", $path;
2167 cf::_exit 0 if defined $pid;
2168 }
2169 }
2170
2171 my $dirty;
2172
2173 sub db_sync() {
2174 db_save if $dirty;
2175 undef $dirty;
2176 }
2177
2178 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2179 db_sync;
2180 });
2181
2182 sub db_dirty() {
2183 $dirty = 1;
2184 $idle->start;
2185 }
2186
2187 sub db_get($;$) {
2188 @_ >= 2
2189 ? $DB->{$_[0]}{$_[1]}
2190 : ($DB->{$_[0]} ||= { })
2191 }
2192
2193 sub db_put($$;$) {
2194 if (@_ >= 3) {
2195 $DB->{$_[0]}{$_[1]} = $_[2];
2196 } else {
2197 $DB->{$_[0]} = $_[1];
2198 }
2199 db_dirty;
2200 }
2201
2202 cf::global->attach (
2203 prio => 10000,
2204 on_cleanup => sub {
2205 db_sync;
2206 }, 2754 }
2207 );
2208}
2209 2755
2210############################################################################# 2756 while (my ($face, $info) = each %$faces) {
2211# the server's main() 2757 next unless $info->{smooth};
2758 my $idx = cf::face::find $face
2759 or next;
2760 if (my $smooth = cf::face::find $info->{smooth}) {
2761 cf::face::set_smooth $idx, $smooth;
2762 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2763 } else {
2764 warn "smooth face '$info->{smooth}' not found for face '$face'";
2765 }
2766
2767 cf::cede_to_tick;
2768 }
2769 }
2770
2771 {
2772 my $anims = $facedata->{animinfo};
2773
2774 while (my ($anim, $info) = each %$anims) {
2775 cf::anim::set $anim, $info->{frames}, $info->{facings};
2776 cf::cede_to_tick;
2777 }
2778
2779 cf::anim::invalidate_all; # d'oh
2780 }
2781
2782 {
2783 # TODO: for gcfclient pleasure, we should give resources
2784 # that gcfclient doesn't grok a >10000 face index.
2785 my $res = $facedata->{resource};
2786 my $enc = JSON::XS->new->utf8->canonical;
2787
2788 while (my ($name, $info) = each %$res) {
2789 my $meta = $enc->encode ({
2790 name => $name,
2791 type => $info->{type},
2792 copyright => $info->{copyright}, #TODO#
2793 });
2794
2795 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2796
2797 if ($name =~ /\.jpg$/) {
2798 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2799 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2800 } else {
2801 my $data = pack "(w/a*)*", $meta, $info->{data};
2802 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2803
2804 cf::face::set_type $idx, 1;
2805 cf::face::set_data $idx, 0, $data, $chk;
2806 }
2807
2808 cf::cede_to_tick;
2809 }
2810 }
2811
2812 1
2813}
2814
2815sub reload_regions {
2816 load_resource_file "$MAPDIR/regions"
2817 or die "unable to load regions file\n";
2818
2819 for (cf::region::list) {
2820 $_->{match} = qr/$_->{match}/
2821 if exists $_->{match};
2822 }
2823}
2824
2825sub reload_facedata {
2826 load_facedata "$DATADIR/facedata"
2827 or die "unable to load facedata\n";
2828}
2829
2830sub reload_archetypes {
2831 load_resource_file "$DATADIR/archetypes"
2832 or die "unable to load archetypes\n";
2833 #d# NEED to laod twice to resolve forward references
2834 # this really needs to be done in an extra post-pass
2835 # (which needs to be synchronous, so solve it differently)
2836 load_resource_file "$DATADIR/archetypes"
2837 or die "unable to load archetypes\n";
2838}
2839
2840sub reload_treasures {
2841 load_resource_file "$DATADIR/treasures"
2842 or die "unable to load treasurelists\n";
2843}
2844
2845sub reload_resources {
2846 warn "reloading resource files...\n";
2847
2848 reload_regions;
2849 reload_facedata;
2850 #reload_archetypes;#d#
2851 reload_archetypes;
2852 reload_treasures;
2853
2854 warn "finished reloading resource files\n";
2855}
2856
2857sub init {
2858 reload_resources;
2859}
2212 2860
2213sub cfg_load { 2861sub cfg_load {
2214 open my $fh, "<:utf8", cf::confdir . "/config" 2862 open my $fh, "<:utf8", "$CONFDIR/config"
2215 or return; 2863 or return;
2216 2864
2217 local $/; 2865 local $/;
2218 *CFG = YAML::Syck::Load <$fh>; 2866 *CFG = YAML::Syck::Load <$fh>;
2219 2867
2233 2881
2234sub main { 2882sub main {
2235 # we must not ever block the main coroutine 2883 # we must not ever block the main coroutine
2236 local $Coro::idle = sub { 2884 local $Coro::idle = sub {
2237 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2885 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2886 (async {
2238 async { Event::one_event }; 2887 Event::one_event;
2888 })->prio (Coro::PRIO_MAX);
2239 }; 2889 };
2240 2890
2241 cfg_load; 2891 cfg_load;
2242 db_load; 2892 db_init;
2243 load_extensions; 2893 load_extensions;
2894
2895 $TICK_WATCHER->start;
2244 Event::loop; 2896 Event::loop;
2245} 2897}
2246 2898
2247############################################################################# 2899#############################################################################
2248# initialisation and cleanup 2900# initialisation and cleanup
2249 2901
2250# install some emergency cleanup handlers 2902# install some emergency cleanup handlers
2251BEGIN { 2903BEGIN {
2252 for my $signal (qw(INT HUP TERM)) { 2904 for my $signal (qw(INT HUP TERM)) {
2253 Event->signal ( 2905 Event->signal (
2906 reentrant => 0,
2254 data => WF_AUTOCANCEL, 2907 data => WF_AUTOCANCEL,
2255 signal => $signal, 2908 signal => $signal,
2909 prio => 0,
2256 cb => sub { 2910 cb => sub {
2257 cf::cleanup "SIG$signal"; 2911 cf::cleanup "SIG$signal";
2258 }, 2912 },
2259 ); 2913 );
2260 } 2914 }
2915}
2916
2917sub write_runtime {
2918 my $runtime = "$LOCALDIR/runtime";
2919
2920 # first touch the runtime file to show we are still running:
2921 # the fsync below can take a very very long time.
2922
2923 IO::AIO::aio_utime $runtime, undef, undef;
2924
2925 my $guard = cf::lock_acquire "write_runtime";
2926
2927 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2928 or return;
2929
2930 my $value = $cf::RUNTIME + 90 + 10;
2931 # 10 is the runtime save interval, for a monotonic clock
2932 # 60 allows for the watchdog to kill the server.
2933
2934 (aio_write $fh, 0, (length $value), $value, 0) <= 0
2935 and return;
2936
2937 # always fsync - this file is important
2938 aio_fsync $fh
2939 and return;
2940
2941 # touch it again to show we are up-to-date
2942 aio_utime $fh, undef, undef;
2943
2944 close $fh
2945 or return;
2946
2947 aio_rename "$runtime~", $runtime
2948 and return;
2949
2950 warn "runtime file written.\n";
2951
2952 1
2261} 2953}
2262 2954
2263sub emergency_save() { 2955sub emergency_save() {
2264 my $freeze_guard = cf::freeze_mainloop; 2956 my $freeze_guard = cf::freeze_mainloop;
2265 2957
2282 my $map = $cf::MAP{$path} or next; 2974 my $map = $cf::MAP{$path} or next;
2283 $map->valid or next; 2975 $map->valid or next;
2284 $map->save; 2976 $map->save;
2285 } 2977 }
2286 warn "end emergency map save\n"; 2978 warn "end emergency map save\n";
2979
2980 warn "begin emergency database checkpoint\n";
2981 BDB::db_env_txn_checkpoint $DB_ENV;
2982 warn "end emergency database checkpoint\n";
2287 }; 2983 };
2288 2984
2289 warn "leave emergency perl save\n"; 2985 warn "leave emergency perl save\n";
2290} 2986}
2291 2987
2988sub post_cleanup {
2989 my ($make_core) = @_;
2990
2991 warn Carp::longmess "post_cleanup backtrace"
2992 if $make_core;
2993}
2994
2292sub reload() { 2995sub do_reload_perl() {
2293 # can/must only be called in main 2996 # can/must only be called in main
2294 if ($Coro::current != $Coro::main) { 2997 if ($Coro::current != $Coro::main) {
2295 warn "can only reload from main coroutine\n"; 2998 warn "can only reload from main coroutine";
2296 return; 2999 return;
2297 } 3000 }
2298 3001
2299 warn "reloading..."; 3002 warn "reloading...";
2300 3003
2301 warn "freezing server"; 3004 warn "entering sync_job";
2302 my $guard = freeze_mainloop; 3005
3006 cf::sync_job {
3007 cf::write_runtime; # external watchdog should not bark
2303 cf::emergency_save; 3008 cf::emergency_save;
3009 cf::write_runtime; # external watchdog should not bark
2304 3010
2305 warn "sync database to disk"; 3011 warn "syncing database to disk";
2306 cf::db_sync; 3012 BDB::db_env_txn_checkpoint $DB_ENV;
2307 IO::AIO::flush;
2308 3013
2309 eval {
2310 # if anything goes wrong in here, we should simply crash as we already saved 3014 # if anything goes wrong in here, we should simply crash as we already saved
2311 3015
2312 warn "cancel all watchers"; 3016 warn "cancelling all WF_AUTOCANCEL watchers";
2313 for (Event::all_watchers) { 3017 for (Event::all_watchers) {
2314 $_->cancel if $_->data & WF_AUTOCANCEL; 3018 $_->cancel if $_->data & WF_AUTOCANCEL;
2315 } 3019 }
2316 3020
3021 warn "flushing outstanding aio requests";
3022 for (;;) {
3023 BDB::flush;
3024 IO::AIO::flush;
3025 Coro::cede;
3026 last unless IO::AIO::nreqs || BDB::nreqs;
3027 warn "iterate...";
3028 }
3029
3030 ++$RELOAD;
3031
2317 warn "cancel all extension coros"; 3032 warn "cancelling all extension coros";
2318 $_->cancel for values %EXT_CORO; 3033 $_->cancel for values %EXT_CORO;
2319 %EXT_CORO = (); 3034 %EXT_CORO = ();
2320 3035
2321 warn "remove commands"; 3036 warn "removing commands";
2322 %COMMAND = (); 3037 %COMMAND = ();
2323 3038
2324 warn "remove ext commands"; 3039 warn "removing ext/exti commands";
2325 %EXTCMD = (); 3040 %EXTCMD = ();
3041 %EXTICMD = ();
2326 3042
2327 warn "unload/nuke all extensions"; 3043 warn "unloading/nuking all extensions";
2328 for my $pkg (@EXTS) { 3044 for my $pkg (@EXTS) {
2329 warn "... unloading $pkg"; 3045 warn "... unloading $pkg";
2330 3046
2331 if (my $cb = $pkg->can ("unload")) { 3047 if (my $cb = $pkg->can ("unload")) {
2332 eval { 3048 eval {
2337 3053
2338 warn "... nuking $pkg"; 3054 warn "... nuking $pkg";
2339 Symbol::delete_package $pkg; 3055 Symbol::delete_package $pkg;
2340 } 3056 }
2341 3057
2342 warn "unload all perl modules loaded from $LIBDIR"; 3058 warn "unloading all perl modules loaded from $LIBDIR";
2343 while (my ($k, $v) = each %INC) { 3059 while (my ($k, $v) = each %INC) {
2344 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3060 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2345 3061
2346 warn "removing <$k>"; 3062 warn "... unloading $k";
2347 delete $INC{$k}; 3063 delete $INC{$k};
2348 3064
2349 $k =~ s/\.pm$//; 3065 $k =~ s/\.pm$//;
2350 $k =~ s/\//::/g; 3066 $k =~ s/\//::/g;
2351 3067
2354 } 3070 }
2355 3071
2356 Symbol::delete_package $k; 3072 Symbol::delete_package $k;
2357 } 3073 }
2358 3074
2359 warn "get rid of safe::, as good as possible"; 3075 warn "getting rid of safe::, as good as possible";
2360 Symbol::delete_package "safe::$_" 3076 Symbol::delete_package "safe::$_"
2361 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3077 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2362 3078
2363 warn "unload cf.pm \"a bit\""; 3079 warn "unloading cf.pm \"a bit\"";
2364 delete $INC{"cf.pm"}; 3080 delete $INC{"cf.pm"};
3081 delete $INC{"cf/pod.pm"};
2365 3082
2366 # don't, removes xs symbols, too, 3083 # don't, removes xs symbols, too,
2367 # and global variables created in xs 3084 # and global variables created in xs
2368 #Symbol::delete_package __PACKAGE__; 3085 #Symbol::delete_package __PACKAGE__;
2369 3086
3087 warn "unload completed, starting to reload now";
3088
2370 warn "reloading cf.pm"; 3089 warn "reloading cf.pm";
2371 require cf; 3090 require cf;
2372 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3091 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2373 3092
2374 warn "load config and database again"; 3093 warn "loading config and database again";
2375 cf::cfg_load; 3094 cf::cfg_load;
2376 cf::db_load;
2377 3095
2378 warn "load extensions"; 3096 warn "loading extensions";
2379 cf::load_extensions; 3097 cf::load_extensions;
2380 3098
2381 warn "reattach attachments to objects/players"; 3099 warn "reattaching attachments to objects/players";
2382 _global_reattach; 3100 _global_reattach; # objects, sockets
2383 warn "reattach attachments to maps"; 3101 warn "reattaching attachments to maps";
2384 reattach $_ for values %MAP; 3102 reattach $_ for values %MAP;
2385 }; 3103 warn "reattaching attachments to players";
3104 reattach $_ for values %PLAYER;
2386 3105
2387 if ($@) { 3106 warn "leaving sync_job";
3107
3108 1
3109 } or do {
2388 warn $@; 3110 warn $@;
2389 warn "error while reloading, exiting."; 3111 warn "error while reloading, exiting.";
2390 exit 1; 3112 exit 1;
2391 } 3113 };
2392 3114
2393 warn "reloaded"; 3115 warn "reloaded";
2394}; 3116};
2395 3117
3118our $RELOAD_WATCHER; # used only during reload
3119
3120sub reload_perl() {
3121 # doing reload synchronously and two reloads happen back-to-back,
3122 # coro crashes during coro_state_free->destroy here.
3123
3124 $RELOAD_WATCHER ||= Event->timer (
3125 reentrant => 0,
3126 after => 0,
3127 data => WF_AUTOCANCEL,
3128 cb => sub {
3129 do_reload_perl;
3130 undef $RELOAD_WATCHER;
3131 },
3132 );
3133}
3134
2396register_command "reload" => sub { 3135register_command "reload" => sub {
2397 my ($who, $arg) = @_; 3136 my ($who, $arg) = @_;
2398 3137
2399 if ($who->flag (FLAG_WIZ)) { 3138 if ($who->flag (FLAG_WIZ)) {
2400 $who->message ("start of reload.");
2401 reload;
2402 $who->message ("end of reload."); 3139 $who->message ("reloading server.");
3140 async { reload_perl };
2403 } 3141 }
2404}; 3142};
2405 3143
2406unshift @INC, $LIBDIR; 3144unshift @INC, $LIBDIR;
2407 3145
3146my $bug_warning = 0;
3147
3148our @WAIT_FOR_TICK;
3149our @WAIT_FOR_TICK_BEGIN;
3150
3151sub wait_for_tick {
3152 return unless $TICK_WATCHER->is_active;
3153 return if $Coro::current == $Coro::main;
3154
3155 my $signal = new Coro::Signal;
3156 push @WAIT_FOR_TICK, $signal;
3157 $signal->wait;
3158}
3159
3160sub wait_for_tick_begin {
3161 return unless $TICK_WATCHER->is_active;
3162 return if $Coro::current == $Coro::main;
3163
3164 my $signal = new Coro::Signal;
3165 push @WAIT_FOR_TICK_BEGIN, $signal;
3166 $signal->wait;
3167}
3168
3169 my $min = 1e6;#d#
3170 my $avg = 10;
2408$TICK_WATCHER = Event->timer ( 3171$TICK_WATCHER = Event->timer (
2409 reentrant => 0, 3172 reentrant => 0,
3173 parked => 1,
2410 prio => 0, 3174 prio => 0,
2411 at => $NEXT_TICK || $TICK, 3175 at => $NEXT_TICK || $TICK,
2412 data => WF_AUTOCANCEL, 3176 data => WF_AUTOCANCEL,
2413 cb => sub { 3177 cb => sub {
3178 if ($Coro::current != $Coro::main) {
3179 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3180 unless ++$bug_warning > 10;
3181 return;
3182 }
3183
2414 $NOW = Event::time; 3184 $NOW = $tick_start = Event::time;
2415 3185
2416 cf::server_tick; # one server iteration 3186 cf::server_tick; # one server iteration
3187
3188 0 && sync_job {#d#
3189 for(1..10) {
3190 my $t = Event::time;
3191 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3192 or die;
3193
3194 $map->width (50);
3195 $map->height (50);
3196 $map->alloc;
3197 $map->_load_objects ("/tmp/x.map", 1);
3198 my $t = Event::time - $t;
3199
3200 #next unless $t < 0.0013;#d#
3201 if ($t < $min) {
3202 $min = $t;
3203 }
3204 $avg = $avg * 0.99 + $t * 0.01;
3205 }
3206 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3207 exit 0;
3208 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3209 };
3210
2417 $RUNTIME += $TICK; 3211 $RUNTIME += $TICK;
2418 $NEXT_TICK += $TICK; 3212 $NEXT_TICK += $TICK;
2419 3213
2420 $WAIT_FOR_TICK->broadcast; 3214 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2421 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3215 $NEXT_RUNTIME_WRITE = $NOW + 10;
3216 Coro::async_pool {
3217 write_runtime
3218 or warn "ERROR: unable to write runtime file: $!";
3219 };
3220 }
3221
3222# my $AFTER = Event::time;
3223# warn $AFTER - $NOW;#d#
3224
3225 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3226 $sig->send;
3227 }
3228 while (my $sig = shift @WAIT_FOR_TICK) {
3229 $sig->send;
3230 }
3231
3232 $NOW = Event::time;
2422 3233
2423 # if we are delayed by four ticks or more, skip them all 3234 # if we are delayed by four ticks or more, skip them all
2424 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3235 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2425 3236
2426 $TICK_WATCHER->at ($NEXT_TICK); 3237 $TICK_WATCHER->at ($NEXT_TICK);
2427 $TICK_WATCHER->start; 3238 $TICK_WATCHER->start;
3239
3240 $LOAD = ($NOW - $tick_start) / $TICK;
3241 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3242
3243 _post_tick;
3244
3245
2428 }, 3246 },
2429); 3247);
2430 3248
3249{
3250 BDB::max_poll_time $TICK * 0.1;
3251 $BDB_POLL_WATCHER = Event->io (
3252 reentrant => 0,
3253 fd => BDB::poll_fileno,
3254 poll => 'r',
3255 prio => 0,
3256 data => WF_AUTOCANCEL,
3257 cb => \&BDB::poll_cb,
3258 );
3259 BDB::min_parallel 8;
3260
3261 BDB::set_sync_prepare {
3262 my $status;
3263 my $current = $Coro::current;
3264 (
3265 sub {
3266 $status = $!;
3267 $current->ready; undef $current;
3268 },
3269 sub {
3270 Coro::schedule while defined $current;
3271 $! = $status;
3272 },
3273 )
3274 };
3275
3276 unless ($DB_ENV) {
3277 $DB_ENV = BDB::db_env_create;
3278
3279 cf::sync_job {
3280 eval {
3281 BDB::db_env_open
3282 $DB_ENV,
3283 $BDBDIR,
3284 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3285 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3286 0666;
3287
3288 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3289
3290 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3291 $DB_ENV->set_lk_detect;
3292 };
3293
3294 cf::cleanup "db_env_open(db): $@" if $@;
3295 };
3296 }
3297}
3298
3299{
3300 IO::AIO::min_parallel 8;
3301
3302 undef $Coro::AIO::WATCHER;
2431IO::AIO::max_poll_time $TICK * 0.2; 3303 IO::AIO::max_poll_time $TICK * 0.1;
2432
2433$AIO_POLL_WATCHER = Event->io ( 3304 $AIO_POLL_WATCHER = Event->io (
2434 fd => IO::AIO::poll_fileno, 3305 reentrant => 0,
2435 poll => 'r',
2436 prio => 5,
2437 data => WF_AUTOCANCEL,
2438 cb => \&IO::AIO::poll_cb,
2439);
2440
2441$WRITE_RUNTIME_WATCHER = Event->timer (
2442 data => WF_AUTOCANCEL, 3306 data => WF_AUTOCANCEL,
2443 after => 0, 3307 fd => IO::AIO::poll_fileno,
2444 interval => 10, 3308 poll => 'r',
2445 cb => sub { 3309 prio => 6,
2446 (Coro::unblock_sub { 3310 cb => \&IO::AIO::poll_cb,
2447 write_runtime 3311 );
2448 or warn "ERROR: unable to write runtime file: $!"; 3312}
3313
3314my $_log_backtrace;
3315
3316sub _log_backtrace {
3317 my ($msg, @addr) = @_;
3318
3319 $msg =~ s/\n//;
3320
3321 # limit the # of concurrent backtraces
3322 if ($_log_backtrace < 2) {
3323 ++$_log_backtrace;
3324 async {
3325 my @bt = fork_call {
3326 @addr = map { sprintf "%x", $_ } @addr;
3327 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3328 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3329 or die "addr2line: $!";
3330
3331 my @funcs;
3332 my @res = <$fh>;
3333 chomp for @res;
3334 while (@res) {
3335 my ($func, $line) = splice @res, 0, 2, ();
3336 push @funcs, "[$func] $line";
3337 }
3338
3339 @funcs
3340 };
3341
3342 LOG llevInfo, "[ABT] $msg\n";
3343 LOG llevInfo, "[ABT] $_\n" for @bt;
3344 --$_log_backtrace;
2449 })->(); 3345 };
3346 } else {
3347 LOG llevInfo, "[ABT] $msg\n";
3348 LOG llevInfo, "[ABT] [suppressed]\n";
2450 }, 3349 }
2451); 3350}
3351
3352# load additional modules
3353use cf::pod;
2452 3354
2453END { cf::emergency_save } 3355END { cf::emergency_save }
2454 3356
24551 33571
2456 3358

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines