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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines