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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines