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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines