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.179 by root, Thu Jan 18 20:39:00 2007 UTC vs.
Revision 1.334 by root, Mon Aug 20 22:09:04 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
957 1281
958sub exists($) { 1282sub exists($) {
959 my ($login) = @_; 1283 my ($login) = @_;
960 1284
961 $cf::PLAYER{$login} 1285 $cf::PLAYER{$login}
962 or cf::sync_job { !aio_stat $login } 1286 or cf::sync_job { !aio_stat path $login }
963} 1287}
964 1288
965sub find($) { 1289sub find($) {
966 return $cf::PLAYER{$_[0]} || do { 1290 return $cf::PLAYER{$_[0]} || do {
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 if ($self->ns->extcmd == 2) {
1097 1511 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1098 $self->send ("ext " . cf::to_json \%msg); 1512 } elsif ($self->ns->extcmd == 1) {
1513 #TODO: version 1, remove
1514 unshift @msg, msgtype => "reply", msgid => $id;
1515 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1516 }
1099} 1517}
1100 1518
1101package cf; 1519=item $player->ext_msg ($type, @msg)
1520
1521Sends an ext event to the client.
1522
1523=cut
1524
1525sub ext_msg($$@) {
1526 my ($self, $type, @msg) = @_;
1527
1528 $self->ns->ext_msg ($type, @msg);
1529}
1530
1531=head3 cf::region
1532
1533=over 4
1534
1535=cut
1536
1537package cf::region;
1538
1539=item cf::region::find_by_path $path
1540
1541Tries to decuce the likely region for a map knowing only its path.
1542
1543=cut
1544
1545sub find_by_path($) {
1546 my ($path) = @_;
1547
1548 my ($match, $specificity);
1549
1550 for my $region (list) {
1551 if ($region->{match} && $path =~ $region->{match}) {
1552 ($match, $specificity) = ($region, $region->specificity)
1553 if $region->specificity > $specificity;
1554 }
1555 }
1556
1557 $match
1558}
1102 1559
1103=back 1560=back
1104
1105 1561
1106=head3 cf::map 1562=head3 cf::map
1107 1563
1108=over 4 1564=over 4
1109 1565
1137 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1593 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138 (cf::region::find $rmp->{region}), $rmp->{custom} 1594 (cf::region::find $rmp->{region}), $rmp->{custom}
1139 ) 1595 )
1140} 1596}
1141 1597
1598=item cf::map->register ($regex, $prio)
1599
1600Register a handler for the map path matching the given regex at the
1601givne priority (higher is better, built-in handlers have priority 0, the
1602default).
1603
1604=cut
1605
1142sub register { 1606sub register {
1143 my (undef, $regex) = @_; 1607 my (undef, $regex, $prio) = @_;
1144 my $pkg = caller; 1608 my $pkg = caller;
1145 1609
1146 no strict; 1610 no strict;
1147 push @{"$pkg\::ISA"}, __PACKAGE__; 1611 push @{"$pkg\::ISA"}, __PACKAGE__;
1148 1612
1149 $EXT_MAP{$pkg} = qr<$regex>; 1613 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1150} 1614}
1151 1615
1152# also paths starting with '/' 1616# also paths starting with '/'
1153$EXT_MAP{"cf::map"} = qr{^(?=/)}; 1617$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1154 1618
1155sub thawer_merge { 1619sub thawer_merge {
1156 my ($self, $merge) = @_; 1620 my ($self, $merge) = @_;
1157 1621
1158 # we have to keep some variables in memory intact 1622 # we have to keep some variables in memory intact
1159 local $self->{path}; 1623 local $self->{path};
1160 local $self->{load_path}; 1624 local $self->{load_path};
1161 local $self->{deny_save};
1162 local $self->{deny_reset};
1163 1625
1164 $self->SUPER::thawer_merge ($merge); 1626 $self->SUPER::thawer_merge ($merge);
1165} 1627}
1166 1628
1167sub normalise { 1629sub normalise {
1168 my ($path, $base) = @_; 1630 my ($path, $base) = @_;
1631
1632 $path = "$path"; # make sure its a string
1633
1634 $path =~ s/\.map$//;
1169 1635
1170 # map plan: 1636 # map plan:
1171 # 1637 #
1172 # /! non-realised random map exit (special hack!) 1638 # /! non-realised random map exit (special hack!)
1173 # {... are special paths that are not being touched 1639 # {... are special paths that are not being touched
1201 1667
1202 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object 1668 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1203 1669
1204 $path = normalise $path, $base; 1670 $path = normalise $path, $base;
1205 1671
1206 for my $pkg (keys %EXT_MAP) { 1672 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1207 if ($path =~ $EXT_MAP{$pkg}) { 1673 if ($path =~ $EXT_MAP{$pkg}[1]) {
1208 my $self = bless cf::map::new, $pkg; 1674 my $self = bless cf::map::new, $pkg;
1209 $self->{path} = $path; $self->path ($path); 1675 $self->{path} = $path; $self->path ($path);
1210 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1211 return $self; 1677 return $self;
1212 } 1678 }
1213 } 1679 }
1214 1680
1215 Carp::carp "unable to resolve path '$path'."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1216 () 1682 ()
1217} 1683}
1218 1684
1219sub init { 1685sub init {
1220 my ($self) = @_; 1686 my ($self) = @_;
1235 1701
1236# the original (read-only) location 1702# the original (read-only) location
1237sub load_path { 1703sub load_path {
1238 my ($self) = @_; 1704 my ($self) = @_;
1239 1705
1240 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1706 "$MAPDIR/$self->{path}.map"
1241} 1707}
1242 1708
1243# the temporary/swap location 1709# the temporary/swap location
1244sub save_path { 1710sub save_path {
1245 my ($self) = @_; 1711 my ($self) = @_;
1246 1712
1247 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1713 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1248 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1714 "$TMPDIR/$path.map"
1249} 1715}
1250 1716
1251# the unique path, undef == no special unique path 1717# the unique path, undef == no special unique path
1252sub uniq_path { 1718sub uniq_path {
1253 my ($self) = @_; 1719 my ($self) = @_;
1254 1720
1255 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1721 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1256 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1722 "$UNIQUEDIR/$path"
1257} 1723}
1258 1724
1259# and all this just because we cannot iterate over 1725# and all this just because we cannot iterate over
1260# all maps in C++... 1726# all maps in C++...
1261sub change_all_map_light { 1727sub change_all_map_light {
1263 1729
1264 $_->change_map_light ($change) 1730 $_->change_map_light ($change)
1265 for grep $_->outdoor, values %cf::MAP; 1731 for grep $_->outdoor, values %cf::MAP;
1266} 1732}
1267 1733
1734sub decay_objects {
1735 my ($self) = @_;
1736
1737 return if $self->{deny_reset};
1738
1739 $self->do_decay_objects;
1740}
1741
1268sub unlink_save { 1742sub unlink_save {
1269 my ($self) = @_; 1743 my ($self) = @_;
1270 1744
1271 utf8::encode (my $save = $self->save_path); 1745 utf8::encode (my $save = $self->save_path);
1272 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1746 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1275 1749
1276sub load_header_from($) { 1750sub load_header_from($) {
1277 my ($self, $path) = @_; 1751 my ($self, $path) = @_;
1278 1752
1279 utf8::encode $path; 1753 utf8::encode $path;
1280 aio_open $path, O_RDONLY, 0 1754 #aio_open $path, O_RDONLY, 0
1281 or return; 1755 # or return;
1282 1756
1283 $self->_load_header ($path) 1757 $self->_load_header ($path)
1284 or return; 1758 or return;
1285 1759
1286 $self->{load_path} = $path; 1760 $self->{load_path} = $path;
1287 1761
1288 1 1762 1
1289} 1763}
1290 1764
1291sub load_orig { 1765sub load_header_orig {
1292 my ($self) = @_; 1766 my ($self) = @_;
1293 1767
1294 $self->load_header_from ($self->load_path) 1768 $self->load_header_from ($self->load_path)
1295} 1769}
1296 1770
1297sub load_temp { 1771sub load_header_temp {
1298 my ($self) = @_; 1772 my ($self) = @_;
1299 1773
1300 $self->load_header_from ($self->save_path) 1774 $self->load_header_from ($self->save_path)
1775}
1776
1777sub prepare_temp {
1778 my ($self) = @_;
1779
1780 $self->last_access ((delete $self->{last_access})
1781 || $cf::RUNTIME); #d#
1782 # safety
1783 $self->{instantiate_time} = $cf::RUNTIME
1784 if $self->{instantiate_time} > $cf::RUNTIME;
1785}
1786
1787sub prepare_orig {
1788 my ($self) = @_;
1789
1790 $self->{load_original} = 1;
1791 $self->{instantiate_time} = $cf::RUNTIME;
1792 $self->last_access ($cf::RUNTIME);
1793 $self->instantiate;
1301} 1794}
1302 1795
1303sub load_header { 1796sub load_header {
1304 my ($self) = @_; 1797 my ($self) = @_;
1305 1798
1306 if ($self->load_temp) { 1799 if ($self->load_header_temp) {
1307 $self->last_access ((delete $self->{last_access}) 1800 $self->prepare_temp;
1308 || $cf::RUNTIME); #d#
1309 # safety
1310 $self->{instantiate_time} = $cf::RUNTIME
1311 if $self->{instantiate_time} > $cf::RUNTIME;
1312 } else { 1801 } else {
1313 $self->load_orig 1802 $self->load_header_orig
1314 or return; 1803 or return;
1315 1804 $self->prepare_orig;
1316 $self->{load_original} = 1;
1317 $self->{instantiate_time} = $cf::RUNTIME;
1318 $self->last_access ($cf::RUNTIME);
1319 $self->instantiate;
1320 } 1805 }
1806
1807 $self->{deny_reset} = 1
1808 if $self->no_reset;
1809
1810 $self->default_region (cf::region::find_by_path $self->{path})
1811 unless $self->default_region;
1321 1812
1322 1 1813 1
1323} 1814}
1324 1815
1325sub find; 1816sub find;
1338 $map->{last_save} = $cf::RUNTIME; 1829 $map->{last_save} = $cf::RUNTIME;
1339 1830
1340 $map->load_header 1831 $map->load_header
1341 or return; 1832 or return;
1342 1833
1343 if ($map->should_reset) { 1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1835 # doing this can freeze the server in a sync job, obviously
1344 $cf::WAIT_FOR_TICK->wait; 1836 #$cf::WAIT_FOR_TICK->wait;
1345 $map->reset; 1837 $map->reset;
1346 undef $guard; 1838 undef $guard;
1347 $map = find $path 1839 return find $path;
1348 or return;
1349 } 1840 }
1350 1841
1351 $cf::MAP{$path} = $map 1842 $cf::MAP{$path} = $map
1352 } 1843 }
1353} 1844}
1845
1846sub pre_load { }
1847sub post_load { }
1354 1848
1355sub load { 1849sub load {
1356 my ($self) = @_; 1850 my ($self) = @_;
1357 1851
1852 local $self->{deny_reset} = 1; # loading can take a long time
1853
1358 my $path = $self->{path}; 1854 my $path = $self->{path};
1855
1856 {
1359 my $guard = cf::lock_acquire "map_load:$path"; 1857 my $guard = cf::lock_acquire "map_load:$path";
1360 1858
1361 return if $self->in_memory != cf::MAP_SWAPPED; 1859 return if $self->in_memory != cf::MAP_SWAPPED;
1362 1860
1363 $self->in_memory (cf::MAP_LOADING); 1861 $self->in_memory (cf::MAP_LOADING);
1364 1862
1365 $self->alloc; 1863 $self->alloc;
1366 $self->_load_objects ($self->{load_path}, 1)
1367 or return;
1368 1864
1369 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1865 $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; 1866 Coro::cede;
1390 $self->set_darkness_map; 1867
1868 $self->_load_objects ($self->{load_path}, 1)
1869 or return;
1870
1871 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1872 if delete $self->{load_original};
1873
1874 if (my $uniq = $self->uniq_path) {
1875 utf8::encode $uniq;
1876 if (aio_open $uniq, O_RDONLY, 0) {
1877 $self->clear_unique_items;
1878 $self->_load_objects ($uniq, 0);
1879 }
1880 }
1881
1882 Coro::cede;
1883 # now do the right thing for maps
1884 $self->link_multipart_objects;
1391 $self->difficulty ($self->estimate_difficulty) 1885 $self->difficulty ($self->estimate_difficulty)
1392 unless $self->difficulty; 1886 unless $self->difficulty;
1393 Coro::cede; 1887 Coro::cede;
1888
1889 unless ($self->{deny_activate}) {
1890 $self->decay_objects;
1891 $self->fix_auto_apply;
1892 $self->update_buttons;
1893 Coro::cede;
1894 $self->set_darkness_map;
1895 Coro::cede;
1394 $self->activate; 1896 $self->activate;
1395 } 1897 }
1396 1898
1899 $self->{last_save} = $cf::RUNTIME;
1900 $self->last_access ($cf::RUNTIME);
1901
1397 $self->in_memory (cf::MAP_IN_MEMORY); 1902 $self->in_memory (cf::MAP_IN_MEMORY);
1903 }
1904
1905 $self->post_load;
1398} 1906}
1399 1907
1400sub customise_for { 1908sub customise_for {
1401 my ($self, $ob) = @_; 1909 my ($self, $ob) = @_;
1402 1910
1403 return find "~" . $ob->name . "/" . $self->{path} 1911 return find "~" . $ob->name . "/" . $self->{path}
1404 if $self->per_player; 1912 if $self->per_player;
1405 1913
1914# return find "?party/" . $ob->name . "/" . $self->{path}
1915# if $self->per_party;
1916
1406 $self 1917 $self
1407} 1918}
1408 1919
1409# find and load all maps in the 3x3 area around a map 1920# find and load all maps in the 3x3 area around a map
1410sub load_diag { 1921sub load_neighbours {
1411 my ($map) = @_; 1922 my ($map) = @_;
1412 1923
1413 my @diag; # diagonal neighbours 1924 my @neigh; # diagonal neighbours
1414 1925
1415 for (0 .. 3) { 1926 for (0 .. 3) {
1416 my $neigh = $map->tile_path ($_) 1927 my $neigh = $map->tile_path ($_)
1417 or next; 1928 or next;
1418 $neigh = find $neigh, $map 1929 $neigh = find $neigh, $map
1419 or next; 1930 or next;
1420 $neigh->load; 1931 $neigh->load;
1421 1932
1933 push @neigh,
1422 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1934 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1423 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1935 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1424 } 1936 }
1425 1937
1426 for (@diag) { 1938 for (grep defined $_->[0], @neigh) {
1939 my ($path, $origin) = @$_;
1427 my $neigh = find @$_ 1940 my $neigh = find $path, $origin
1428 or next; 1941 or next;
1429 $neigh->load; 1942 $neigh->load;
1430 } 1943 }
1431} 1944}
1432 1945
1441 1954
1442 cf::sync_job { $map->load }; 1955 cf::sync_job { $map->load };
1443} 1956}
1444 1957
1445our %MAP_PREFETCH; 1958our %MAP_PREFETCH;
1446our $MAP_PREFETCHER = Coro::async { 1959our $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 1960
1459sub find_async { 1961sub find_async {
1460 my ($path, $origin) = @_; 1962 my ($path, $origin) = @_;
1461 1963
1462 $path = normalise $path, $origin && $origin->{path}; 1964 $path = normalise $path, $origin && $origin->{path};
1463 1965
1464 if (my $map = $cf::MAP{$path}) { 1966 if (my $map = $cf::MAP{$path}) {
1465 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1967 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1466 } 1968 }
1467 1969
1468 $MAP_PREFETCH{$path} = 0; 1970 undef $MAP_PREFETCH{$path};
1971 $MAP_PREFETCHER ||= cf::async {
1972 while (%MAP_PREFETCH) {
1973 for my $path (keys %MAP_PREFETCH) {
1974 if (my $map = find $path) {
1975 $map->load;
1976 }
1977
1978 delete $MAP_PREFETCH{$path};
1979 }
1980 }
1981 undef $MAP_PREFETCHER;
1982 };
1469 $MAP_PREFETCHER->ready; 1983 $MAP_PREFETCHER->prio (6);
1470 1984
1471 () 1985 ()
1472} 1986}
1473 1987
1474sub save { 1988sub save {
1519 2033
1520sub reset_at { 2034sub reset_at {
1521 my ($self) = @_; 2035 my ($self) = @_;
1522 2036
1523 # TODO: safety, remove and allow resettable per-player maps 2037 # 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}; 2038 return 1e99 if $self->{deny_reset};
1526 2039
1527 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2040 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1528 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2041 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1529 2042
1540 my ($self) = @_; 2053 my ($self) = @_;
1541 2054
1542 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2055 my $lock = cf::lock_acquire "map_data:$self->{path}";
1543 2056
1544 return if $self->players; 2057 return if $self->players;
1545 return if $self->isa ("ext::map_per_player");#d#
1546 2058
1547 warn "resetting map ", $self->path;#d# 2059 warn "resetting map ", $self->path;
2060
2061 $self->in_memory (cf::MAP_SWAPPED);
2062
2063 # need to save uniques path
2064 unless ($self->{deny_save}) {
2065 my $uniq = $self->uniq_path; utf8::encode $uniq;
2066
2067 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2068 if $uniq;
2069 }
1548 2070
1549 delete $cf::MAP{$self->path}; 2071 delete $cf::MAP{$self->path};
1550 2072
1551 $self->in_memory (cf::MAP_SWAPPED);
1552 $self->clear; 2073 $self->clear;
1553 2074
1554 $_->clear_links_to ($self) for values %cf::MAP; 2075 $_->clear_links_to ($self) for values %cf::MAP;
1555 2076
1556 $self->unlink_save; 2077 $self->unlink_save;
1575 $cf::MAP{$self->path} = $self; 2096 $cf::MAP{$self->path} = $self;
1576 2097
1577 $self->reset; # polite request, might not happen 2098 $self->reset; # polite request, might not happen
1578} 2099}
1579 2100
2101=item $maps = cf::map::tmp_maps
2102
2103Returns an arrayref with all map paths of currently instantiated and saved
2104maps. May block.
2105
2106=cut
2107
2108sub tmp_maps() {
2109 [
2110 map {
2111 utf8::decode $_;
2112 /\.map$/
2113 ? normalise $_
2114 : ()
2115 } @{ aio_readdir $TMPDIR or [] }
2116 ]
2117}
2118
2119=item $maps = cf::map::random_maps
2120
2121Returns an arrayref with all map paths of currently instantiated and saved
2122random maps. May block.
2123
2124=cut
2125
2126sub random_maps() {
2127 [
2128 map {
2129 utf8::decode $_;
2130 /\.map$/
2131 ? normalise "?random/$_"
2132 : ()
2133 } @{ aio_readdir $RANDOMDIR or [] }
2134 ]
2135}
2136
1580=item cf::map::unique_maps 2137=item cf::map::unique_maps
1581 2138
1582Returns an arrayref of paths of all shared maps that have 2139Returns an arrayref of paths of all shared maps that have
1583instantiated unique items. May block. 2140instantiated unique items. May block.
1584 2141
1585=cut 2142=cut
1586 2143
1587sub unique_maps() { 2144sub unique_maps() {
1588 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2145 [
1589 or return; 2146 map {
1590
1591 my @paths;
1592
1593 for (@$files) {
1594 utf8::decode $_; 2147 utf8::decode $_;
1595 next if /\.pst$/;
1596 next unless /^$PATH_SEP/o;
1597
1598 s/\.map$//; 2148 /\.map$/
1599 push @paths, $_; 2149 ? normalise $_
2150 : ()
2151 } @{ aio_readdir $UNIQUEDIR or [] }
1600 } 2152 ]
1601
1602 \@paths
1603} 2153}
1604 2154
1605package cf; 2155package cf;
1606 2156
1607=back 2157=back
1653 2203
1654 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2204 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1655 2205
1656 if ($self->{record_replies}) { 2206 if ($self->{record_replies}) {
1657 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2207 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2208
1658 } else { 2209 } else {
2210 my $pl = $self->contr;
2211
2212 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2213 my $dialog = $pl->{npc_dialog};
2214 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2215
2216 } else {
1659 $msg = $npc->name . " says: $msg" if $npc; 2217 $msg = $npc->name . " says: $msg" if $npc;
1660 $self->message ($msg, $flags); 2218 $self->message ($msg, $flags);
2219 }
1661 } 2220 }
2221}
2222
2223=item $object->send_msg ($channel, $msg, $color, [extra...])
2224
2225=cut
2226
2227sub cf::object::send_msg {
2228 my $pl = shift->contr
2229 or return;
2230 $pl->send_msg (@_);
1662} 2231}
1663 2232
1664=item $player_object->may ("access") 2233=item $player_object->may ("access")
1665 2234
1666Returns wether the given player is authorized to access resource "access" 2235Returns wether the given player is authorized to access resource "access"
1698=cut 2267=cut
1699 2268
1700sub link_map { 2269sub link_map {
1701 unless ($LINK_MAP) { 2270 unless ($LINK_MAP) {
1702 $LINK_MAP = cf::map::find "{link}" 2271 $LINK_MAP = cf::map::find "{link}"
1703 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2272 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1704 $LINK_MAP->load; 2273 $LINK_MAP->load;
1705 } 2274 }
1706 2275
1707 $LINK_MAP 2276 $LINK_MAP
1708} 2277}
1713 $self->deactivate_recursive; 2282 $self->deactivate_recursive;
1714 2283
1715 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2284 return if UNIVERSAL::isa $self->map, "ext::map_link";
1716 2285
1717 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2286 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1718 if $self->map; 2287 if $self->map && $self->map->{path} ne "{link}";
1719 2288
1720 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2289 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1721} 2290}
1722 2291
1723sub cf::object::player::leave_link { 2292sub cf::object::player::leave_link {
1724 my ($self, $map, $x, $y) = @_; 2293 my ($self, $map, $x, $y) = @_;
2294
2295 return unless $self->contr->active;
1725 2296
1726 my $link_pos = delete $self->{_link_pos}; 2297 my $link_pos = delete $self->{_link_pos};
1727 2298
1728 unless ($map) { 2299 unless ($map) {
1729 # restore original map position 2300 # restore original map position
1743 # use -1 or undef as default coordinates, not 0, 0 2314 # use -1 or undef as default coordinates, not 0, 0
1744 ($x, $y) = ($map->enter_x, $map->enter_y) 2315 ($x, $y) = ($map->enter_x, $map->enter_y)
1745 if $x <=0 && $y <= 0; 2316 if $x <=0 && $y <= 0;
1746 2317
1747 $map->load; 2318 $map->load;
1748 $map->load_diag; 2319 $map->load_neighbours;
1749 2320
1750 return unless $self->contr->active; 2321 return unless $self->contr->active;
1751 $self->activate_recursive; 2322 $self->activate_recursive;
2323
2324 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1752 $self->enter_map ($map, $x, $y); 2325 $self->enter_map ($map, $x, $y);
1753} 2326}
1754 2327
1755cf::player->attach ( 2328=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1756 on_logout => sub {
1757 my ($pl) = @_;
1758 2329
1759 # abort map switching before logout 2330Moves the player to the given map-path and coordinates by first freezing
1760 if ($pl->ob->{_link_pos}) { 2331her, loading and preparing them map, calling the provided $check callback
1761 cf::sync_job { 2332that has to return the map if sucecssful, and then unfreezes the player on
1762 $pl->ob->leave_link 2333the new (success) or old (failed) map position. In either case, $done will
1763 }; 2334be called at the end of this process.
1764 }
1765 },
1766 on_login => sub {
1767 my ($pl) = @_;
1768 2335
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 2336=cut
2337
2338our $GOTOGEN;
1790 2339
1791sub cf::object::player::goto { 2340sub cf::object::player::goto {
1792 my ($self, $path, $x, $y) = @_; 2341 my ($self, $path, $x, $y, $check, $done) = @_;
2342
2343 # do generation counting so two concurrent goto's will be executed in-order
2344 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1793 2345
1794 $self->enter_link; 2346 $self->enter_link;
1795 2347
1796 (async { 2348 (async {
2349 my $map = eval {
1797 my $map = cf::map::find $path; 2350 my $map = cf::map::find $path;
2351
2352 if ($map) {
1798 $map = $map->customise_for ($self) if $map; 2353 $map = $map->customise_for ($self);
1799 2354 $map = $check->($map) if $check && $map;
1800# warn "entering ", $map->path, " at ($x, $y)\n" 2355 } else {
1801# if $map;
1802
1803 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2356 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2357 }
1804 2358
2359 $map
2360 };
2361
2362 if ($@) {
2363 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2364 LOG llevError | logBacktrace, Carp::longmess $@;
2365 }
2366
2367 if ($gen == $self->{_goto_generation}) {
2368 delete $self->{_goto_generation};
1805 $self->leave_link ($map, $x, $y); 2369 $self->leave_link ($map, $x, $y);
2370 }
2371
2372 $done->() if $done;
1806 })->prio (1); 2373 })->prio (1);
1807} 2374}
1808 2375
1809=item $player_object->enter_exit ($exit_object) 2376=item $player_object->enter_exit ($exit_object)
1810 2377
1812 2379
1813sub parse_random_map_params { 2380sub parse_random_map_params {
1814 my ($spec) = @_; 2381 my ($spec) = @_;
1815 2382
1816 my $rmp = { # defaults 2383 my $rmp = { # defaults
1817 xsize => -1, 2384 xsize => (cf::rndm 15, 40),
1818 ysize => -1, 2385 ysize => (cf::rndm 15, 40),
2386 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2387 #layout => string,
1819 }; 2388 };
1820 2389
1821 for (split /\n/, $spec) { 2390 for (split /\n/, $spec) {
1822 my ($k, $v) = split /\s+/, $_, 2; 2391 my ($k, $v) = split /\s+/, $_, 2;
1823 2392
1837 # that depends on the exit object 2406 # that depends on the exit object
1838 2407
1839 my $rmp = parse_random_map_params $exit->msg; 2408 my $rmp = parse_random_map_params $exit->msg;
1840 2409
1841 if ($exit->map) { 2410 if ($exit->map) {
1842 $rmp->{region} = $exit->map->region_name; 2411 $rmp->{region} = $exit->region->name;
1843 $rmp->{origin_map} = $exit->map->path; 2412 $rmp->{origin_map} = $exit->map->path;
1844 $rmp->{origin_x} = $exit->x; 2413 $rmp->{origin_x} = $exit->x;
1845 $rmp->{origin_y} = $exit->y; 2414 $rmp->{origin_y} = $exit->y;
1846 } 2415 }
1847 2416
1848 $rmp->{random_seed} ||= $exit->random_seed; 2417 $rmp->{random_seed} ||= $exit->random_seed;
1849 2418
1850 my $data = cf::to_json $rmp; 2419 my $data = cf::to_json $rmp;
1851 my $md5 = Digest::MD5::md5_hex $data; 2420 my $md5 = Digest::MD5::md5_hex $data;
1852 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2421 my $meta = "$RANDOMDIR/$md5.meta";
1853 2422
1854 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2423 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1855 aio_write $fh, 0, (length $data), $data, 0; 2424 aio_write $fh, 0, (length $data), $data, 0;
1856 undef $fh; 2425 undef $fh;
1857 aio_rename "$meta~", $meta; 2426 aio_rename "$meta~", $meta;
1864sub cf::object::player::enter_exit { 2433sub cf::object::player::enter_exit {
1865 my ($self, $exit) = @_; 2434 my ($self, $exit) = @_;
1866 2435
1867 return unless $self->type == cf::PLAYER; 2436 return unless $self->type == cf::PLAYER;
1868 2437
2438 if ($exit->slaying eq "/!") {
2439 #TODO: this should de-fi-ni-te-ly not be a sync-job
2440 # the problem is that $exit might not survive long enough
2441 # so it needs to be done right now, right here
2442 cf::sync_job { prepare_random_map $exit };
2443 }
2444
2445 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2446 my $hp = $exit->stats->hp;
2447 my $sp = $exit->stats->sp;
2448
1869 $self->enter_link; 2449 $self->enter_link;
2450
2451 # if exit is damned, update players death & WoR home-position
2452 $self->contr->savebed ($slaying, $hp, $sp)
2453 if $exit->flag (FLAG_DAMNED);
1870 2454
1871 (async { 2455 (async {
1872 $self->deactivate_recursive; # just to be sure 2456 $self->deactivate_recursive; # just to be sure
1873 unless (eval { 2457 unless (eval {
1874 prepare_random_map $exit 2458 $self->goto ($slaying, $hp, $sp);
1875 if $exit->slaying eq "/!";
1876
1877 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1878 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1879 2459
1880 1; 2460 1;
1881 }) { 2461 }) {
1882 $self->message ("Something went wrong deep within the crossfire server. " 2462 $self->message ("Something went wrong deep within the crossfire server. "
1883 . "I'll try to bring you back to the map you were before. " 2463 . "I'll try to bring you back to the map you were before. "
1884 . "Please report this to the dungeon master!", 2464 . "Please report this to the dungeon master!",
1885 cf::NDI_UNIQUE | cf::NDI_RED); 2465 cf::NDI_UNIQUE | cf::NDI_RED);
1886 2466
1887 warn "ERROR in enter_exit: $@"; 2467 warn "ERROR in enter_exit: $@";
1888 $self->leave_link; 2468 $self->leave_link;
1889 } 2469 }
1890 })->prio (1); 2470 })->prio (1);
1903 2483
1904sub cf::client::send_drawinfo { 2484sub cf::client::send_drawinfo {
1905 my ($self, $text, $flags) = @_; 2485 my ($self, $text, $flags) = @_;
1906 2486
1907 utf8::encode $text; 2487 utf8::encode $text;
1908 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2488 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1909} 2489}
1910 2490
2491=item $client->send_msg ($channel, $msg, $color, [extra...])
2492
2493Send a drawinfo or msg packet to the client, formatting the msg for the
2494client if neccessary. C<$type> should be a string identifying the type of
2495the message, with C<log> being the default. If C<$color> is negative, suppress
2496the message unless the client supports the msg packet.
2497
2498=cut
2499
2500sub cf::client::send_msg {
2501 my ($self, $channel, $msg, $color, @extra) = @_;
2502
2503 $msg = $self->pl->expand_cfpod ($msg);
2504
2505 $color &= cf::NDI_CLIENT_MASK; # just in case...
2506
2507 if (ref $channel) {
2508 # send meta info to client, if not yet sent
2509 unless (exists $self->{channel}{$channel->{id}}) {
2510 $self->{channel}{$channel->{id}} = $channel;
2511 $self->ext_msg (channel_info => $channel);
2512 }
2513
2514 $channel = $channel->{id};
2515 }
2516
2517 return unless @extra || length $msg;
2518
2519 if ($self->can_msg) {
2520 # default colour, mask it out
2521 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2522 if $color & cf::NDI_DEF;
2523
2524 $self->send_packet ("msg " . $self->{json_coder}->encode (
2525 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2526 } else {
2527 if ($color >= 0) {
2528 # replace some tags by gcfclient-compatible ones
2529 for ($msg) {
2530 1 while
2531 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2532 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2533 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2534 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2535 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2536 }
2537
2538 $color &= cf::NDI_COLOR_MASK;
2539
2540 utf8::encode $msg;
2541
2542 if (0 && $msg =~ /\[/) {
2543 # COMMAND/INFO
2544 $self->send_packet ("drawextinfo $color 10 8 $msg")
2545 } else {
2546 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2547 $self->send_packet ("drawinfo $color $msg")
2548 }
2549 }
2550 }
2551}
2552
2553=item $client->ext_msg ($type, @msg)
2554
2555Sends an ext event to the client.
2556
2557=cut
2558
2559sub cf::client::ext_msg($$@) {
2560 my ($self, $type, @msg) = @_;
2561
2562 my $extcmd = $self->extcmd;
2563
2564 if ($extcmd == 2) {
2565 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2566 } elsif ($extcmd == 1) { # TODO: remove
2567 push @msg, msgtype => "event_$type";
2568 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2569 }
2570}
1911 2571
1912=item $success = $client->query ($flags, "text", \&cb) 2572=item $success = $client->query ($flags, "text", \&cb)
1913 2573
1914Queues a query to the client, calling the given callback with 2574Queues a query to the client, calling the given callback with
1915the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2575the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1916C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2576C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1917 2577
1918Queries can fail, so check the return code. Or don't, as queries will become 2578Queries can fail, so check the return code. Or don't, as queries will
1919reliable at some point in the future. 2579become reliable at some point in the future.
1920 2580
1921=cut 2581=cut
1922 2582
1923sub cf::client::query { 2583sub cf::client::query {
1924 my ($self, $flags, $text, $cb) = @_; 2584 my ($self, $flags, $text, $cb) = @_;
1932 utf8::encode $text; 2592 utf8::encode $text;
1933 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2593 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1934 2594
1935 $self->send_packet ($self->{query_queue}[0][0]) 2595 $self->send_packet ($self->{query_queue}[0][0])
1936 if @{ $self->{query_queue} } == 1; 2596 if @{ $self->{query_queue} } == 1;
2597
2598 1
1937} 2599}
1938 2600
1939cf::client->attach ( 2601cf::client->attach (
2602 on_connect => sub {
2603 my ($ns) = @_;
2604
2605 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2606 },
1940 on_reply => sub { 2607 on_reply => sub {
1941 my ($ns, $msg) = @_; 2608 my ($ns, $msg) = @_;
1942 2609
1943 # this weird shuffling is so that direct followup queries 2610 # this weird shuffling is so that direct followup queries
1944 # get handled first 2611 # get handled first
1945 my $queue = delete $ns->{query_queue} 2612 my $queue = delete $ns->{query_queue}
1946 or return; # be conservative, not sure how that can happen, but we saw a crash here 2613 or return; # be conservative, not sure how that can happen, but we saw a crash here
1947 2614
1948 (shift @$queue)->[1]->($msg); 2615 (shift @$queue)->[1]->($msg);
2616 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1949 2617
1950 push @{ $ns->{query_queue} }, @$queue; 2618 push @{ $ns->{query_queue} }, @$queue;
1951 2619
1952 if (@{ $ns->{query_queue} } == @$queue) { 2620 if (@{ $ns->{query_queue} } == @$queue) {
1953 if (@$queue) { 2621 if (@$queue) {
1955 } else { 2623 } else {
1956 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2624 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1957 } 2625 }
1958 } 2626 }
1959 }, 2627 },
2628 on_exticmd => sub {
2629 my ($ns, $buf) = @_;
2630
2631 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2632
2633 if (ref $msg) {
2634 my ($type, $reply, @payload) =
2635 "ARRAY" eq ref $msg
2636 ? @$msg
2637 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2638
2639 if (my $cb = $EXTICMD{$type}) {
2640 my @reply = $cb->($ns, @payload);
2641
2642 $ns->ext_reply ($reply, @reply)
2643 if $reply;
2644 }
2645 } else {
2646 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2647 }
2648
2649 cf::override;
2650 },
1960); 2651);
1961 2652
1962=item $client->async (\&cb) 2653=item $client->async (\&cb)
1963 2654
1964Create a new coroutine, running the specified callback. The coroutine will 2655Create a new coroutine, running the specified callback. The coroutine will
2005our $safe = new Safe "safe"; 2696our $safe = new Safe "safe";
2006our $safe_hole = new Safe::Hole; 2697our $safe_hole = new Safe::Hole;
2007 2698
2008$SIG{FPE} = 'IGNORE'; 2699$SIG{FPE} = 'IGNORE';
2009 2700
2010$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2701$safe->permit_only (Opcode::opset qw(
2702 :base_core :base_mem :base_orig :base_math
2703 grepstart grepwhile mapstart mapwhile
2704 sort time
2705));
2011 2706
2012# here we export the classes and methods available to script code 2707# here we export the classes and methods available to script code
2013 2708
2014=pod 2709=pod
2015 2710
2016The following fucntions and emthods are available within a safe environment: 2711The following functions and methods are available within a safe environment:
2017 2712
2018 cf::object contr pay_amount pay_player map 2713 cf::object
2714 contr pay_amount pay_player map x y force_find force_add
2715 insert remove name archname title slaying race
2716
2019 cf::object::player player 2717 cf::object::player
2020 cf::player peaceful 2718 player
2021 cf::map trigger 2719
2720 cf::player
2721 peaceful
2722
2723 cf::map
2724 trigger
2022 2725
2023=cut 2726=cut
2024 2727
2025for ( 2728for (
2026 ["cf::object" => qw(contr pay_amount pay_player map)], 2729 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2730 insert remove inv name archname title slaying race)],
2027 ["cf::object::player" => qw(player)], 2731 ["cf::object::player" => qw(player)],
2028 ["cf::player" => qw(peaceful)], 2732 ["cf::player" => qw(peaceful)],
2029 ["cf::map" => qw(trigger)], 2733 ["cf::map" => qw(trigger)],
2030) { 2734) {
2031 no strict 'refs'; 2735 no strict 'refs';
2102=back 2806=back
2103 2807
2104=cut 2808=cut
2105 2809
2106############################################################################# 2810#############################################################################
2811# the server's init and main functions
2107 2812
2108=head2 EXTENSION DATABASE SUPPORT 2813sub load_facedata($) {
2814 my ($path) = @_;
2109 2815
2110Crossfire maintains a very simple database for extension use. It can 2816 my $enc = JSON::XS->new->utf8->canonical;
2111currently store anything that can be serialised using Storable, which
2112excludes objects.
2113 2817
2114The parameter C<$family> should best start with the name of the extension 2818 warn "loading facedata from $path\n";
2115using it, it should be unique.
2116 2819
2117=over 4 2820 my $facedata;
2821 0 < aio_load $path, $facedata
2822 or die "$path: $!";
2118 2823
2119=item $hashref = cf::db_get $family 2824 $facedata = Coro::Storable::thaw $facedata;
2120 2825
2121Return a hashref for use by the extension C<$family>, which can be 2826 $facedata->{version} == 2
2122modified. After modifications, you have to call C<cf::db_dirty> or 2827 or cf::cleanup "$path: version mismatch, cannot proceed.";
2123C<cf::db_sync>.
2124 2828
2125=item $value = cf::db_get $family => $key 2829 # patch in the exptable
2126 2830 cf::cede_to_tick;
2127Returns a single value from the database 2831 $facedata->{resource}{"res/exp_table"} = {
2128 2832 type => FT_RSRC,
2129=item cf::db_put $family => $hashref 2833 data => $enc->encode ([map cf::level_to_min_exp $_, 0 .. cf::settings->max_level]),
2130
2131Stores the given family hashref into the database. Updates are delayed, if
2132you want the data to be synced to disk immediately, use C<cf::db_sync>.
2133
2134=item cf::db_put $family => $key => $value
2135
2136Stores the given C<$value> in the family hash. Updates are delayed, if you
2137want the data to be synced to disk immediately, use C<cf::db_sync>.
2138
2139=item cf::db_dirty
2140
2141Marks the database as dirty, to be updated at a later time.
2142
2143=item cf::db_sync
2144
2145Immediately write the database to disk I<if it is dirty>.
2146
2147=cut
2148
2149our $DB;
2150
2151{
2152 my $path = cf::localdir . "/database.pst";
2153
2154 sub db_load() {
2155 $DB = stat $path ? Storable::retrieve $path : { };
2156 }
2157
2158 my $pid;
2159
2160 sub db_save() {
2161 waitpid $pid, 0 if $pid;
2162 if (0 == ($pid = fork)) {
2163 $DB->{_meta}{version} = 1;
2164 Storable::nstore $DB, "$path~";
2165 rename "$path~", $path;
2166 cf::_exit 0 if defined $pid;
2167 }
2168 }
2169
2170 my $dirty;
2171
2172 sub db_sync() {
2173 db_save if $dirty;
2174 undef $dirty;
2175 }
2176
2177 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2178 db_sync;
2179 }); 2834 };
2835 cf::cede_to_tick;
2180 2836
2181 sub db_dirty() {
2182 $dirty = 1;
2183 $idle->start;
2184 } 2837 {
2838 my $faces = $facedata->{faceinfo};
2185 2839
2186 sub db_get($;$) { 2840 while (my ($face, $info) = each %$faces) {
2187 @_ >= 2 2841 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2188 ? $DB->{$_[0]}{$_[1]} 2842 cf::face::set_visibility $idx, $info->{visibility};
2189 : ($DB->{$_[0]} ||= { }) 2843 cf::face::set_magicmap $idx, $info->{magicmap};
2190 } 2844 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2845 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2191 2846
2192 sub db_put($$;$) { 2847 cf::cede_to_tick;
2193 if (@_ >= 3) {
2194 $DB->{$_[0]}{$_[1]} = $_[2];
2195 } else {
2196 $DB->{$_[0]} = $_[1];
2197 }
2198 db_dirty;
2199 }
2200
2201 cf::global->attach (
2202 prio => 10000,
2203 on_cleanup => sub {
2204 db_sync;
2205 }, 2848 }
2206 );
2207}
2208 2849
2209############################################################################# 2850 while (my ($face, $info) = each %$faces) {
2210# the server's main() 2851 next unless $info->{smooth};
2852 my $idx = cf::face::find $face
2853 or next;
2854 if (my $smooth = cf::face::find $info->{smooth}) {
2855 cf::face::set_smooth $idx, $smooth;
2856 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2857 } else {
2858 warn "smooth face '$info->{smooth}' not found for face '$face'";
2859 }
2860
2861 cf::cede_to_tick;
2862 }
2863 }
2864
2865 {
2866 my $anims = $facedata->{animinfo};
2867
2868 while (my ($anim, $info) = each %$anims) {
2869 cf::anim::set $anim, $info->{frames}, $info->{facings};
2870 cf::cede_to_tick;
2871 }
2872
2873 cf::anim::invalidate_all; # d'oh
2874 }
2875
2876 {
2877 # TODO: for gcfclient pleasure, we should give resources
2878 # that gcfclient doesn't grok a >10000 face index.
2879 my $res = $facedata->{resource};
2880
2881 my $soundconf = delete $res->{"res/sound.conf"};
2882
2883 while (my ($name, $info) = each %$res) {
2884 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2885 my $data;
2886
2887 if ($info->{type} & 1) {
2888 # prepend meta info
2889
2890 my $meta = $enc->encode ({
2891 name => $name,
2892 %{ $info->{meta} || {} },
2893 });
2894
2895 $data = pack "(w/a*)*", $meta, $info->{data};
2896 }
2897
2898 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2899 cf::face::set_type $idx, $info->{type};
2900
2901 cf::cede_to_tick;
2902 }
2903
2904 if ($soundconf) {
2905 $soundconf = $enc->decode (delete $soundconf->{data});
2906
2907 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2908 my $sound = $soundconf->{compat}[$_]
2909 or next;
2910
2911 my $face = cf::face::find "sound/$sound->[1]";
2912 cf::sound::set $sound->[0] => $face;
2913 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2914 }
2915
2916 while (my ($k, $v) = each %{$soundconf->{event}}) {
2917 my $face = cf::face::find "sound/$v";
2918 cf::sound::set $k => $face;
2919 }
2920 }
2921 }
2922
2923 1
2924}
2925
2926register_exticmd fx_want => sub {
2927 my ($ns, $want) = @_;
2928
2929 while (my ($k, $v) = each %$want) {
2930 $ns->fx_want ($k, $v);
2931 }
2932};
2933
2934sub reload_regions {
2935 load_resource_file "$MAPDIR/regions"
2936 or die "unable to load regions file\n";
2937
2938 for (cf::region::list) {
2939 $_->{match} = qr/$_->{match}/
2940 if exists $_->{match};
2941 }
2942}
2943
2944sub reload_facedata {
2945 load_facedata "$DATADIR/facedata"
2946 or die "unable to load facedata\n";
2947}
2948
2949sub reload_archetypes {
2950 load_resource_file "$DATADIR/archetypes"
2951 or die "unable to load archetypes\n";
2952 #d# NEED to laod twice to resolve forward references
2953 # this really needs to be done in an extra post-pass
2954 # (which needs to be synchronous, so solve it differently)
2955 load_resource_file "$DATADIR/archetypes"
2956 or die "unable to load archetypes\n";
2957}
2958
2959sub reload_treasures {
2960 load_resource_file "$DATADIR/treasures"
2961 or die "unable to load treasurelists\n";
2962}
2963
2964sub reload_resources {
2965 warn "reloading resource files...\n";
2966
2967 reload_regions;
2968 reload_facedata;
2969 #reload_archetypes;#d#
2970 reload_archetypes;
2971 reload_treasures;
2972
2973 warn "finished reloading resource files\n";
2974}
2975
2976sub init {
2977 reload_resources;
2978}
2211 2979
2212sub cfg_load { 2980sub cfg_load {
2213 open my $fh, "<:utf8", cf::confdir . "/config" 2981 open my $fh, "<:utf8", "$CONFDIR/config"
2214 or return; 2982 or return;
2215 2983
2216 local $/; 2984 local $/;
2217 *CFG = YAML::Syck::Load <$fh>; 2985 *CFG = YAML::Syck::Load <$fh>;
2218 2986
2238 Event::one_event; 3006 Event::one_event;
2239 })->prio (Coro::PRIO_MAX); 3007 })->prio (Coro::PRIO_MAX);
2240 }; 3008 };
2241 3009
2242 cfg_load; 3010 cfg_load;
2243 db_load; 3011 db_init;
2244 load_extensions; 3012 load_extensions;
3013
3014 $TICK_WATCHER->start;
2245 Event::loop; 3015 Event::loop;
2246} 3016}
2247 3017
2248############################################################################# 3018#############################################################################
2249# initialisation and cleanup 3019# initialisation and cleanup
2250 3020
2251# install some emergency cleanup handlers 3021# install some emergency cleanup handlers
2252BEGIN { 3022BEGIN {
2253 for my $signal (qw(INT HUP TERM)) { 3023 for my $signal (qw(INT HUP TERM)) {
2254 Event->signal ( 3024 Event->signal (
3025 reentrant => 0,
2255 data => WF_AUTOCANCEL, 3026 data => WF_AUTOCANCEL,
2256 signal => $signal, 3027 signal => $signal,
3028 prio => 0,
2257 cb => sub { 3029 cb => sub {
2258 cf::cleanup "SIG$signal"; 3030 cf::cleanup "SIG$signal";
2259 }, 3031 },
2260 ); 3032 );
2261 } 3033 }
3034}
3035
3036sub write_runtime {
3037 my $runtime = "$LOCALDIR/runtime";
3038
3039 # first touch the runtime file to show we are still running:
3040 # the fsync below can take a very very long time.
3041
3042 IO::AIO::aio_utime $runtime, undef, undef;
3043
3044 my $guard = cf::lock_acquire "write_runtime";
3045
3046 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3047 or return;
3048
3049 my $value = $cf::RUNTIME + 90 + 10;
3050 # 10 is the runtime save interval, for a monotonic clock
3051 # 60 allows for the watchdog to kill the server.
3052
3053 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3054 and return;
3055
3056 # always fsync - this file is important
3057 aio_fsync $fh
3058 and return;
3059
3060 # touch it again to show we are up-to-date
3061 aio_utime $fh, undef, undef;
3062
3063 close $fh
3064 or return;
3065
3066 aio_rename "$runtime~", $runtime
3067 and return;
3068
3069 warn "runtime file written.\n";
3070
3071 1
2262} 3072}
2263 3073
2264sub emergency_save() { 3074sub emergency_save() {
2265 my $freeze_guard = cf::freeze_mainloop; 3075 my $freeze_guard = cf::freeze_mainloop;
2266 3076
2283 my $map = $cf::MAP{$path} or next; 3093 my $map = $cf::MAP{$path} or next;
2284 $map->valid or next; 3094 $map->valid or next;
2285 $map->save; 3095 $map->save;
2286 } 3096 }
2287 warn "end emergency map save\n"; 3097 warn "end emergency map save\n";
3098
3099 warn "begin emergency database checkpoint\n";
3100 BDB::db_env_txn_checkpoint $DB_ENV;
3101 warn "end emergency database checkpoint\n";
2288 }; 3102 };
2289 3103
2290 warn "leave emergency perl save\n"; 3104 warn "leave emergency perl save\n";
2291} 3105}
2292 3106
3107sub post_cleanup {
3108 my ($make_core) = @_;
3109
3110 warn Carp::longmess "post_cleanup backtrace"
3111 if $make_core;
3112}
3113
2293sub reload() { 3114sub do_reload_perl() {
2294 # can/must only be called in main 3115 # can/must only be called in main
2295 if ($Coro::current != $Coro::main) { 3116 if ($Coro::current != $Coro::main) {
2296 warn "can only reload from main coroutine\n"; 3117 warn "can only reload from main coroutine";
2297 return; 3118 return;
2298 } 3119 }
2299 3120
2300 warn "reloading..."; 3121 warn "reloading...";
2301 3122
2302 warn "freezing server"; 3123 warn "entering sync_job";
2303 my $guard = freeze_mainloop; 3124
3125 cf::sync_job {
3126 cf::write_runtime; # external watchdog should not bark
2304 cf::emergency_save; 3127 cf::emergency_save;
3128 cf::write_runtime; # external watchdog should not bark
2305 3129
2306 warn "sync database to disk"; 3130 warn "syncing database to disk";
2307 cf::db_sync; 3131 BDB::db_env_txn_checkpoint $DB_ENV;
2308 IO::AIO::flush;
2309 3132
2310 eval {
2311 # if anything goes wrong in here, we should simply crash as we already saved 3133 # if anything goes wrong in here, we should simply crash as we already saved
2312 3134
2313 warn "cancel all watchers"; 3135 warn "cancelling all WF_AUTOCANCEL watchers";
2314 for (Event::all_watchers) { 3136 for (Event::all_watchers) {
2315 $_->cancel if $_->data & WF_AUTOCANCEL; 3137 $_->cancel if $_->data & WF_AUTOCANCEL;
2316 } 3138 }
2317 3139
3140 warn "flushing outstanding aio requests";
3141 for (;;) {
3142 BDB::flush;
3143 IO::AIO::flush;
3144 Coro::cede;
3145 last unless IO::AIO::nreqs || BDB::nreqs;
3146 warn "iterate...";
3147 }
3148
3149 ++$RELOAD;
3150
2318 warn "cancel all extension coros"; 3151 warn "cancelling all extension coros";
2319 $_->cancel for values %EXT_CORO; 3152 $_->cancel for values %EXT_CORO;
2320 %EXT_CORO = (); 3153 %EXT_CORO = ();
2321 3154
2322 warn "remove commands"; 3155 warn "removing commands";
2323 %COMMAND = (); 3156 %COMMAND = ();
2324 3157
2325 warn "remove ext commands"; 3158 warn "removing ext/exti commands";
2326 %EXTCMD = (); 3159 %EXTCMD = ();
3160 %EXTICMD = ();
2327 3161
2328 warn "unload/nuke all extensions"; 3162 warn "unloading/nuking all extensions";
2329 for my $pkg (@EXTS) { 3163 for my $pkg (@EXTS) {
2330 warn "... unloading $pkg"; 3164 warn "... unloading $pkg";
2331 3165
2332 if (my $cb = $pkg->can ("unload")) { 3166 if (my $cb = $pkg->can ("unload")) {
2333 eval { 3167 eval {
2338 3172
2339 warn "... nuking $pkg"; 3173 warn "... nuking $pkg";
2340 Symbol::delete_package $pkg; 3174 Symbol::delete_package $pkg;
2341 } 3175 }
2342 3176
2343 warn "unload all perl modules loaded from $LIBDIR"; 3177 warn "unloading all perl modules loaded from $LIBDIR";
2344 while (my ($k, $v) = each %INC) { 3178 while (my ($k, $v) = each %INC) {
2345 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3179 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2346 3180
2347 warn "removing <$k>"; 3181 warn "... unloading $k";
2348 delete $INC{$k}; 3182 delete $INC{$k};
2349 3183
2350 $k =~ s/\.pm$//; 3184 $k =~ s/\.pm$//;
2351 $k =~ s/\//::/g; 3185 $k =~ s/\//::/g;
2352 3186
2355 } 3189 }
2356 3190
2357 Symbol::delete_package $k; 3191 Symbol::delete_package $k;
2358 } 3192 }
2359 3193
2360 warn "get rid of safe::, as good as possible"; 3194 warn "getting rid of safe::, as good as possible";
2361 Symbol::delete_package "safe::$_" 3195 Symbol::delete_package "safe::$_"
2362 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3196 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2363 3197
2364 warn "unload cf.pm \"a bit\""; 3198 warn "unloading cf.pm \"a bit\"";
2365 delete $INC{"cf.pm"}; 3199 delete $INC{"cf.pm"};
3200 delete $INC{"cf/pod.pm"};
2366 3201
2367 # don't, removes xs symbols, too, 3202 # don't, removes xs symbols, too,
2368 # and global variables created in xs 3203 # and global variables created in xs
2369 #Symbol::delete_package __PACKAGE__; 3204 #Symbol::delete_package __PACKAGE__;
2370 3205
3206 warn "unload completed, starting to reload now";
3207
2371 warn "reloading cf.pm"; 3208 warn "reloading cf.pm";
2372 require cf; 3209 require cf;
2373 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3210 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2374 3211
2375 warn "load config and database again"; 3212 warn "loading config and database again";
2376 cf::cfg_load; 3213 cf::cfg_load;
2377 cf::db_load;
2378 3214
2379 warn "load extensions"; 3215 warn "loading extensions";
2380 cf::load_extensions; 3216 cf::load_extensions;
2381 3217
2382 warn "reattach attachments to objects/players"; 3218 warn "reattaching attachments to objects/players";
2383 _global_reattach; 3219 _global_reattach; # objects, sockets
2384 warn "reattach attachments to maps"; 3220 warn "reattaching attachments to maps";
2385 reattach $_ for values %MAP; 3221 reattach $_ for values %MAP;
2386 }; 3222 warn "reattaching attachments to players";
3223 reattach $_ for values %PLAYER;
2387 3224
2388 if ($@) { 3225 warn "leaving sync_job";
3226
3227 1
3228 } or do {
2389 warn $@; 3229 warn $@;
2390 warn "error while reloading, exiting."; 3230 warn "error while reloading, exiting.";
2391 exit 1; 3231 exit 1;
2392 } 3232 };
2393 3233
2394 warn "reloaded"; 3234 warn "reloaded";
2395}; 3235};
2396 3236
2397our $RELOAD_WATCHER; # used only during reload 3237our $RELOAD_WATCHER; # used only during reload
2398 3238
3239sub reload_perl() {
3240 # doing reload synchronously and two reloads happen back-to-back,
3241 # coro crashes during coro_state_free->destroy here.
3242
3243 $RELOAD_WATCHER ||= Event->timer (
3244 reentrant => 0,
3245 after => 0,
3246 data => WF_AUTOCANCEL,
3247 cb => sub {
3248 do_reload_perl;
3249 undef $RELOAD_WATCHER;
3250 },
3251 );
3252}
3253
2399register_command "reload" => sub { 3254register_command "reload" => sub {
2400 my ($who, $arg) = @_; 3255 my ($who, $arg) = @_;
2401 3256
2402 if ($who->flag (FLAG_WIZ)) { 3257 if ($who->flag (FLAG_WIZ)) {
2403 $who->message ("reloading server."); 3258 $who->message ("reloading server.");
2404 3259 async { reload_perl };
2405 # doing reload synchronously and two reloads happen back-to-back,
2406 # coro crashes during coro_state_free->destroy here.
2407
2408 $RELOAD_WATCHER ||= Event->timer (after => 0, data => WF_AUTOCANCEL, cb => sub {
2409 reload;
2410 undef $RELOAD_WATCHER;
2411 });
2412 } 3260 }
2413}; 3261};
2414 3262
2415unshift @INC, $LIBDIR; 3263unshift @INC, $LIBDIR;
2416 3264
3265my $bug_warning = 0;
3266
3267our @WAIT_FOR_TICK;
3268our @WAIT_FOR_TICK_BEGIN;
3269
3270sub wait_for_tick {
3271 return unless $TICK_WATCHER->is_active;
3272 return if $Coro::current == $Coro::main;
3273
3274 my $signal = new Coro::Signal;
3275 push @WAIT_FOR_TICK, $signal;
3276 $signal->wait;
3277}
3278
3279sub wait_for_tick_begin {
3280 return unless $TICK_WATCHER->is_active;
3281 return if $Coro::current == $Coro::main;
3282
3283 my $signal = new Coro::Signal;
3284 push @WAIT_FOR_TICK_BEGIN, $signal;
3285 $signal->wait;
3286}
3287
3288 my $min = 1e6;#d#
3289 my $avg = 10;
2417$TICK_WATCHER = Event->timer ( 3290$TICK_WATCHER = Event->timer (
2418 reentrant => 0, 3291 reentrant => 0,
3292 parked => 1,
2419 prio => 0, 3293 prio => 0,
2420 at => $NEXT_TICK || $TICK, 3294 at => $NEXT_TICK || $TICK,
2421 data => WF_AUTOCANCEL, 3295 data => WF_AUTOCANCEL,
2422 cb => sub { 3296 cb => sub {
3297 if ($Coro::current != $Coro::main) {
3298 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3299 unless ++$bug_warning > 10;
3300 return;
3301 }
3302
2423 $NOW = Event::time; 3303 $NOW = $tick_start = Event::time;
2424 3304
2425 cf::server_tick; # one server iteration 3305 cf::server_tick; # one server iteration
3306
3307 0 && sync_job {#d#
3308 for(1..10) {
3309 my $t = Event::time;
3310 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3311 or die;
3312
3313 $map->width (50);
3314 $map->height (50);
3315 $map->alloc;
3316 $map->_load_objects ("/tmp/x.map", 1);
3317 my $t = Event::time - $t;
3318
3319 #next unless $t < 0.0013;#d#
3320 if ($t < $min) {
3321 $min = $t;
3322 }
3323 $avg = $avg * 0.99 + $t * 0.01;
3324 }
3325 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3326 exit 0;
3327 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3328 };
3329
2426 $RUNTIME += $TICK; 3330 $RUNTIME += $TICK;
2427 $NEXT_TICK += $TICK; 3331 $NEXT_TICK += $TICK;
2428 3332
2429 $WAIT_FOR_TICK->broadcast; 3333 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2430 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3334 $NEXT_RUNTIME_WRITE = $NOW + 10;
3335 Coro::async_pool {
3336 write_runtime
3337 or warn "ERROR: unable to write runtime file: $!";
3338 };
3339 }
3340
3341# my $AFTER = Event::time;
3342# warn $AFTER - $NOW;#d#
3343
3344 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3345 $sig->send;
3346 }
3347 while (my $sig = shift @WAIT_FOR_TICK) {
3348 $sig->send;
3349 }
3350
3351 $NOW = Event::time;
2431 3352
2432 # if we are delayed by four ticks or more, skip them all 3353 # if we are delayed by four ticks or more, skip them all
2433 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3354 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2434 3355
2435 $TICK_WATCHER->at ($NEXT_TICK); 3356 $TICK_WATCHER->at ($NEXT_TICK);
2436 $TICK_WATCHER->start; 3357 $TICK_WATCHER->start;
3358
3359 $LOAD = ($NOW - $tick_start) / $TICK;
3360 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3361
3362 _post_tick;
3363
3364
2437 }, 3365 },
2438); 3366);
2439 3367
3368{
3369 BDB::max_poll_time $TICK * 0.1;
3370 $BDB_POLL_WATCHER = Event->io (
3371 reentrant => 0,
3372 fd => BDB::poll_fileno,
3373 poll => 'r',
3374 prio => 0,
3375 data => WF_AUTOCANCEL,
3376 cb => \&BDB::poll_cb,
3377 );
3378 BDB::min_parallel 8;
3379
3380 BDB::set_sync_prepare {
3381 my $status;
3382 my $current = $Coro::current;
3383 (
3384 sub {
3385 $status = $!;
3386 $current->ready; undef $current;
3387 },
3388 sub {
3389 Coro::schedule while defined $current;
3390 $! = $status;
3391 },
3392 )
3393 };
3394
3395 unless ($DB_ENV) {
3396 $DB_ENV = BDB::db_env_create;
3397
3398 cf::sync_job {
3399 eval {
3400 BDB::db_env_open
3401 $DB_ENV,
3402 $BDBDIR,
3403 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3404 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3405 0666;
3406
3407 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3408
3409 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3410 $DB_ENV->set_lk_detect;
3411 };
3412
3413 cf::cleanup "db_env_open(db): $@" if $@;
3414 };
3415 }
3416}
3417
3418{
3419 IO::AIO::min_parallel 8;
3420
3421 undef $Coro::AIO::WATCHER;
2440IO::AIO::max_poll_time $TICK * 0.2; 3422 IO::AIO::max_poll_time $TICK * 0.1;
2441
2442$AIO_POLL_WATCHER = Event->io ( 3423 $AIO_POLL_WATCHER = Event->io (
2443 fd => IO::AIO::poll_fileno, 3424 reentrant => 0,
2444 poll => 'r',
2445 prio => 5,
2446 data => WF_AUTOCANCEL,
2447 cb => \&IO::AIO::poll_cb,
2448);
2449
2450$WRITE_RUNTIME_WATCHER = Event->timer (
2451 data => WF_AUTOCANCEL, 3425 data => WF_AUTOCANCEL,
2452 after => 0, 3426 fd => IO::AIO::poll_fileno,
2453 interval => 10, 3427 poll => 'r',
2454 cb => sub { 3428 prio => 6,
2455 (Coro::unblock_sub { 3429 cb => \&IO::AIO::poll_cb,
2456 write_runtime 3430 );
2457 or warn "ERROR: unable to write runtime file: $!"; 3431}
3432
3433my $_log_backtrace;
3434
3435sub _log_backtrace {
3436 my ($msg, @addr) = @_;
3437
3438 $msg =~ s/\n//;
3439
3440 # limit the # of concurrent backtraces
3441 if ($_log_backtrace < 2) {
3442 ++$_log_backtrace;
3443 async {
3444 my @bt = fork_call {
3445 @addr = map { sprintf "%x", $_ } @addr;
3446 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3447 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3448 or die "addr2line: $!";
3449
3450 my @funcs;
3451 my @res = <$fh>;
3452 chomp for @res;
3453 while (@res) {
3454 my ($func, $line) = splice @res, 0, 2, ();
3455 push @funcs, "[$func] $line";
3456 }
3457
3458 @funcs
3459 };
3460
3461 LOG llevInfo, "[ABT] $msg\n";
3462 LOG llevInfo, "[ABT] $_\n" for @bt;
3463 --$_log_backtrace;
2458 })->(); 3464 };
3465 } else {
3466 LOG llevInfo, "[ABT] $msg\n";
3467 LOG llevInfo, "[ABT] [suppressed]\n";
2459 }, 3468 }
2460); 3469}
3470
3471# load additional modules
3472use cf::pod;
2461 3473
2462END { cf::emergency_save } 3474END { cf::emergency_save }
2463 3475
24641 34761
2465 3477

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines