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

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.167 by root, Sat Jan 13 23:32:43 2007 UTC vs.
Revision 1.310 by elmex, Mon Jul 16 15:43:49 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines