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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines