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.159 by root, Wed Jan 10 22:50:12 2007 UTC vs.
Revision 1.346 by root, Tue Aug 28 19:38:40 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines