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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines