ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cf.schmorp.de/server/lib/cf.pm
(Generate patch)

Comparing cf.schmorp.de/server/lib/cf.pm (file contents):
Revision 1.168 by root, Sun Jan 14 00:37:14 2007 UTC vs.
Revision 1.315 by root, Mon Jul 23 17:53:55 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.3 (); 15use Coro 3.61 ();
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;
19 24
25use JSON::XS 1.4 ();
26use BDB ();
20use Data::Dumper; 27use Data::Dumper;
21use Digest::MD5; 28use Digest::MD5;
22use Fcntl; 29use Fcntl;
30use YAML::Syck ();
23use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
24use YAML::Syck ();
25use Time::HiRes; 32use Time::HiRes;
33use Compress::LZF;
34use Digest::MD5 ();
26 35
36# configure various modules to our taste
37#
38$Storable::canonical = 1; # reduce rsync transfers
39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
41
27use Event; $Event::Eval = 1; # no idea why this is required, but it is 42$Event::Eval = 1; # no idea why this is required, but it is
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30 43
31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 44# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
33 46
34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 47$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35 48
49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
50
36our %COMMAND = (); 51our %COMMAND = ();
37our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
38 53
39our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
40our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
43 59
60our $RELOAD; # number of reloads so far
44our @EVENT; 61our @EVENT;
45our $LIBDIR = datadir . "/ext";
46 62
47our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
48our $TICK_WATCHER; 76our $TICK_WATCHER;
49our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER; 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51our $NEXT_TICK; 79our $NEXT_TICK;
52our $NOW; 80our $NOW;
81our $USE_FSYNC = 1; # use fsync to write maps - default off
82
83our $BDB_POLL_WATCHER;
84our $DB_ENV;
53 85
54our %CFG; 86our %CFG;
55 87
56our $UPTIME; $UPTIME ||= time; 88our $UPTIME; $UPTIME ||= time;
57our $RUNTIME; 89our $RUNTIME;
58 90
59our %PLAYER; # all users 91our %PLAYER; # all users
60our %MAP; # all maps 92our %MAP; # all maps
61our $LINK_MAP; # the special {link} map, which is always available 93our $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 94
67# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69 97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
101
70binmode STDOUT; 102binmode STDOUT;
71binmode STDERR; 103binmode STDERR;
72 104
73# read virtual server time, if available 105# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
76 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
77 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
78} 110}
79 111
80mkdir cf::localdir; 112mkdir $_
81mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82mkdir cf::localdir . "/" . cf::tmpdir;
83mkdir cf::localdir . "/" . cf::uniquedir;
84mkdir $RANDOM_MAPS;
85 114
86our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
116
117sub cf::map::normalise;
87 118
88############################################################################# 119#############################################################################
89 120
90=head2 GLOBAL VARIABLES 121=head2 GLOBAL VARIABLES
91 122
98=item $cf::RUNTIME 129=item $cf::RUNTIME
99 130
100The time this server has run, starts at 0 and is increased by $cf::TICK on 131The time this server has run, starts at 0 and is increased by $cf::TICK on
101every server tick. 132every server tick.
102 133
103=item $cf::LIBDIR 134=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
135$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
136$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
104 137
105The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
106be found. It will be added to C<@INC> automatically. 139directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
140unique-items directory, player file directory, random maps directory and
141database environment.
107 142
108=item $cf::NOW 143=item $cf::NOW
109 144
110The time of the last (current) server tick. 145The time of the last (current) server tick.
111 146
112=item $cf::TICK 147=item $cf::TICK
113 148
114The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
115 160
116=item %cf::CFG 161=item %cf::CFG
117 162
118Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
119from wherever your confdir points to. 164from wherever your confdir points to.
120 165
121=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
122 167
123These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
124or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
125processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
126window of cpu time available, or simply to synchronise to the server tick. 171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
127 177
128=back 178=back
129 179
130=cut 180=cut
131 181
132BEGIN { 182BEGIN {
133 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
134 my $msg = join "", @_; 184 my $msg = join "", @_;
135 utf8::encode $msg;
136 185
137 $msg .= "\n" 186 $msg .= "\n"
138 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
139 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
140 LOG llevError, $msg; 192 LOG llevError, $msg;
141 }; 193 };
142} 194}
143 195
144@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
145@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
146@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
147@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
148@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 200@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
201@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
149@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 202@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
150 203
151# we bless all objects into (empty) derived classes to force a method lookup 204# we bless all objects into (empty) derived classes to force a method lookup
152# within the Safe compartment. 205# within the Safe compartment.
153for my $pkg (qw( 206for my $pkg (qw(
154 cf::global cf::attachable 207 cf::global cf::attachable
162} 215}
163 216
164$Event::DIED = sub { 217$Event::DIED = sub {
165 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
166}; 219};
220
221#############################################################################
167 222
168=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
169 224
170=over 4 225=over 4
171 226
190 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
191 $d 246 $d
192 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
193} 248}
194 249
195use JSON::Syck (); # TODO# replace by JSON::PC once working
196
197=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
198 251
199Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
200 253
201=cut
202
203sub from_json($) {
204 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
205 JSON::Syck::Load $_[0]
206}
207
208=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
209 255
210Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
211 257
212=cut 258=cut
213 259
214sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
215 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 261
216 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
217} 263sub from_json ($) { $json_coder->decode ($_[0]) }
218 264
219=item cf::lock_wait $string 265=item cf::lock_wait $string
220 266
221Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
222 268
228returned. 274returned.
229 275
230Lock names should begin with a unique identifier (for example, cf::map::find 276Lock names should begin with a unique identifier (for example, cf::map::find
231uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
232 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
233=cut 283=cut
234 284
235our %LOCK; 285our %LOCK;
236 286
237sub lock_wait($) { 287sub lock_wait($) {
256 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
257 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
258 } 308 }
259} 309}
260 310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
315}
316
261sub freeze_mainloop { 317sub freeze_mainloop {
262 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
263 319
264 my $guard = Coro::guard { 320 my $guard = Coro::guard {
265 $TICK_WATCHER->start; 321 $TICK_WATCHER->start;
266 $WRITE_RUNTIME_WATCHER->start;
267 }; 322 };
268 $WRITE_RUNTIME_WATCHER->stop;
269 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
270 $guard 324 $guard
325}
326
327=item cf::get_slot $time[, $priority[, $name]]
328
329Allocate $time seconds of blocking CPU time at priority C<$priority>:
330This call blocks and returns only when you have at least C<$time> seconds
331of cpu time till the next tick. The slot is only valid till the next cede.
332
333The optional C<$name> can be used to identify the job to run. It might be
334used for statistical purposes and should identify the same time-class.
335
336Useful for short background jobs.
337
338=cut
339
340our @SLOT_QUEUE;
341our $SLOT_QUEUE;
342
343$SLOT_QUEUE->cancel if $SLOT_QUEUE;
344$SLOT_QUEUE = Coro::async {
345 my $signal = new Coro::Signal;
346
347 while () {
348 next_job:
349 my $avail = cf::till_tick;
350 if ($avail > 0.01) {
351 for (0 .. $#SLOT_QUEUE) {
352 if ($SLOT_QUEUE[$_][0] < $avail) {
353 my $job = splice @SLOT_QUEUE, $_, 1, ();
354 $job->[2]->send;
355 Coro::cede;
356 goto next_job;
357 }
358 }
359 }
360
361 if (@SLOT_QUEUE) {
362 # we do not use wait_For_tick() as it returns immediately when tick is inactive
363 push @cf::WAIT_FOR_TICK, $signal;
364 $signal->wait;
365 } else {
366 Coro::schedule;
367 }
368 }
369};
370
371sub get_slot($;$$) {
372 my ($time, $pri, $name) = @_;
373
374 $time = $TICK * .6 if $time > $TICK * .6;
375 my $sig = new Coro::Signal;
376
377 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
378 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
379 $SLOT_QUEUE->ready;
380 $sig->wait;
271} 381}
272 382
273=item cf::async { BLOCK } 383=item cf::async { BLOCK }
274 384
275Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
280 390
281BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
282 392
283=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
284 394
285The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
286always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
287reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
288 399
289If it must be done, put the blocking parts into C<sync_job>. This will run 400If it must be done, put the blocking parts into C<sync_job>. This will run
290the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
291server will be frozen during this time, so the block should either finish 402server will be frozen during this time, so the block should either finish
292fast or be very important. 403fast or be very important.
295 406
296sub sync_job(&) { 407sub sync_job(&) {
297 my ($job) = @_; 408 my ($job) = @_;
298 409
299 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
300 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
301 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
302 415
303 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
304 # (but this is cancel-safe) 417 # (but this is cancel-safe)
315 428
316 while ($busy) { 429 while ($busy) {
317 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
318 } 431 }
319 432
433 $time = Event::time - $time;
434
435 LOG llevError | logBacktrace, Carp::longmess "long sync job"
436 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
437
438 $tick_start += $time; # do not account sync jobs to server load
439
320 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
321 } else { 441 } else {
322 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
323 443
324 $job->() 444 $job->()
343 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
344 464
345 $coro 465 $coro
346} 466}
347 467
348sub write_runtime { 468=item fork_call { }, $args
349 my $runtime = cf::localdir . "/runtime";
350 469
351 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 470Executes the given code block with the given arguments in a seperate
352 or return; 471process, returning the results. Everything must be serialisable with
472Coro::Storable. May, of course, block. Note that the executed sub may
473never block itself or use any form of Event handling.
353 474
354 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 475=cut
355 (aio_write $fh, 0, (length $value), $value, 0) <= 0
356 and return;
357 476
358 aio_fsync $fh 477sub _store_scalar {
359 and return; 478 open my $fh, ">", \my $buf
360 479 or die "fork_call: cannot open fh-to-buf in child : $!";
480 Storable::store_fd $_[0], $fh;
361 close $fh 481 close $fh;
362 or return;
363 482
364 aio_rename "$runtime~", $runtime 483 $buf
365 and return; 484}
366 485
486sub fork_call(&@) {
487 my ($cb, @args) = @_;
488
489# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
490# or die "socketpair: $!";
491 pipe my $fh1, my $fh2
492 or die "pipe: $!";
493
494 if (my $pid = fork) {
495 close $fh2;
496
497 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
498 warn "pst<$res>" unless $res =~ /^pst/;
499 $res = Coro::Storable::thaw $res;
500
501 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
502
503 Carp::confess $$res unless "ARRAY" eq ref $res;
504
505 return wantarray ? @$res : $res->[-1];
506 } else {
507 reset_signals;
508 local $SIG{__WARN__};
509 local $SIG{__DIE__};
510 # just in case, this hack effectively disables event
511 # in the child. cleaner and slower would be canceling all watchers,
512 # but this works for the time being.
513 local $Coro::idle;
514 $Coro::current->prio (Coro::PRIO_MAX);
515
516 eval {
517 close $fh1;
518
519 my @res = eval { $cb->(@args) };
520
521 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
522 close $fh2;
523 };
524
525 warn $@ if $@;
526 _exit 0;
367 1 527 }
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=cut
540
541our $DB;
542
543sub db_init {
544 unless ($DB) {
545 $DB = BDB::db_create $DB_ENV;
546
547 cf::sync_job {
548 eval {
549 $DB->set_flags (BDB::CHKSUM);
550
551 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
552 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
553 cf::cleanup "db_open(db): $!" if $!;
554 };
555 cf::cleanup "db_open(db): $@" if $@;
556 };
557 }
558}
559
560sub db_get($$) {
561 my $key = "$_[0]/$_[1]";
562
563 cf::sync_job {
564 BDB::db_get $DB, undef, $key, my $data;
565
566 $! ? ()
567 : $data
568 }
569}
570
571sub db_put($$$) {
572 BDB::dbreq_pri 4;
573 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
574}
575
576=item cf::cache $id => [$paths...], $processversion => $process
577
578Generic caching function that returns the value of the resource $id,
579caching and regenerating as required.
580
581This function can block.
582
583=cut
584
585sub cache {
586 my ($id, $src, $processversion, $process) = @_;
587
588 my $meta =
589 join "\x00",
590 $processversion,
591 map {
592 aio_stat $_
593 and Carp::croak "$_: $!";
594
595 ($_, (stat _)[7,9])
596 } @$src;
597
598 my $dbmeta = db_get cache => "$id/meta";
599 if ($dbmeta ne $meta) {
600 # changed, we may need to process
601
602 my @data;
603 my $md5;
604
605 for (0 .. $#$src) {
606 0 <= aio_load $src->[$_], $data[$_]
607 or Carp::croak "$src->[$_]: $!";
608 }
609
610 # if processing is expensive, check
611 # checksum first
612 if (1) {
613 $md5 =
614 join "\x00",
615 $processversion,
616 map {
617 Coro::cede;
618 ($src->[$_], Digest::MD5::md5_hex $data[$_])
619 } 0.. $#$src;
620
621
622 my $dbmd5 = db_get cache => "$id/md5";
623 if ($dbmd5 eq $md5) {
624 db_put cache => "$id/meta", $meta;
625
626 return db_get cache => "$id/data";
627 }
628 }
629
630 my $t1 = Time::HiRes::time;
631 my $data = $process->(\@data);
632 my $t2 = Time::HiRes::time;
633
634 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
635
636 db_put cache => "$id/data", $data;
637 db_put cache => "$id/md5" , $md5;
638 db_put cache => "$id/meta", $meta;
639
640 return $data;
641 }
642
643 db_get cache => "$id/data"
644}
645
646=item cf::datalog type => key => value, ...
647
648Log a datalog packet of the given type with the given key-value pairs.
649
650=cut
651
652sub datalog($@) {
653 my ($type, %kv) = @_;
654 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
368} 655}
369 656
370=back 657=back
371 658
372=cut 659=cut
379attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
380to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
381 668
382In the following description, CLASS can be any of C<global>, C<object> 669In the following description, CLASS can be any of C<global>, C<object>
383C<player>, C<client> or C<map> (i.e. the attachable objects in 670C<player>, C<client> or C<map> (i.e. the attachable objects in
384crossfire+). 671Crossfire TRT).
385 672
386=over 4 673=over 4
387 674
388=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
389 676
503our @CB_TYPE = (); # registry for type (cf-object class) based events 790our @CB_TYPE = (); # registry for type (cf-object class) based events
504our @CB_MAP = (); 791our @CB_MAP = ();
505 792
506my %attachment; 793my %attachment;
507 794
795sub cf::attachable::thawer_merge {
796 # simply override everything except _meta
797 local $_[0]{_meta};
798 %{$_[0]} = %{$_[1]};
799}
800
508sub _attach_cb($$$$) { 801sub _attach_cb($$$$) {
509 my ($registry, $event, $prio, $cb) = @_; 802 my ($registry, $event, $prio, $cb) = @_;
510 803
511 use sort 'stable'; 804 use sort 'stable';
512 805
546 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
547 840
548 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
549 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
550 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
551 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
552 845
553 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
554 my $pkg = shift @arg; 847 my $pkg = shift @arg;
555 848
556 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
585 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
586 } 879 }
587 880
588 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
589 } else { 882 } else {
590 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
591 } 884 }
592 885
593 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
594} 887}
595 888
597 if (ref $_[0]) { 890 if (ref $_[0]) {
598 _object_attach @_; 891 _object_attach @_;
599 } else { 892 } else {
600 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
601 } 894 }
895 _recalc_want;
602}; 896};
603 897
604# all those should be optimised 898# all those should be optimised
605sub cf::attachable::detach { 899sub cf::attachable::detach {
606 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
609 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
610 reattach ($obj); 904 reattach ($obj);
611 } else { 905 } else {
612 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
613 } 907 }
908 _recalc_want;
614}; 909};
615 910
616sub cf::attachable::attached { 911sub cf::attachable::attached {
617 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
618 913
633 "; 928 ";
634 die if $@; 929 die if $@;
635} 930}
636 931
637our $override; 932our $override;
638our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 933our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
639 934
640sub override { 935sub override {
641 $override = 1; 936 $override = 1;
642 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
643} 938}
644 939
645sub do_invoke { 940sub do_invoke {
646 my $event = shift; 941 my $event = shift;
647 my $callbacks = shift; 942 my $callbacks = shift;
648 943
649 @invoke_results = (); 944 @INVOKE_RESULTS = ();
650 945
651 local $override; 946 local $override;
652 947
653 for (@$callbacks) { 948 for (@$callbacks) {
654 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
671 966
672Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
673 968
674This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 969This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
675removed in future versions), and there is no public API to access override 970removed in future versions), and there is no public API to access override
676results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
677 972
678=back 973=back
679 974
680=cut 975=cut
681 976
682############################################################################# 977#############################################################################
683# object support 978# object support
979#
980
981sub _can_merge {
982 my ($ob1, $ob2) = @_;
983
984 local $Storable::canonical = 1;
985 my $fob1 = Storable::freeze $ob1;
986 my $fob2 = Storable::freeze $ob2;
987
988 $fob1 eq $fob2
989}
684 990
685sub reattach { 991sub reattach {
686 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
687 my ($obj) = @_; 993 my ($obj) = @_;
994
995 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
688 996
689 my $registry = $obj->registry; 997 my $registry = $obj->registry;
690 998
691 @$registry = (); 999 @$registry = ();
692 1000
739 $filename, length $$rdata, scalar @$objs; 1047 $filename, length $$rdata, scalar @$objs;
740 1048
741 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1049 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
742 chmod SAVE_MODE, $fh; 1050 chmod SAVE_MODE, $fh;
743 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1051 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
744 aio_fsync $fh; 1052 aio_fsync $fh if $cf::USE_FSYNC;
745 close $fh; 1053 close $fh;
746 1054
747 if (@$objs) { 1055 if (@$objs) {
748 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1056 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
749 chmod SAVE_MODE, $fh; 1057 chmod SAVE_MODE, $fh;
750 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1058 my $data = Storable::nfreeze { version => 1, objs => $objs };
751 aio_write $fh, 0, (length $data), $data, 0; 1059 aio_write $fh, 0, (length $data), $data, 0;
752 aio_fsync $fh; 1060 aio_fsync $fh if $cf::USE_FSYNC;
753 close $fh; 1061 close $fh;
754 aio_rename "$filename.pst~", "$filename.pst"; 1062 aio_rename "$filename.pst~", "$filename.pst";
755 } 1063 }
756 } else { 1064 } else {
757 aio_unlink "$filename.pst"; 1065 aio_unlink "$filename.pst";
789 or return; 1097 or return;
790 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
791 } 1099 }
792 1100
793 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
794 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
795 return ($data, $av); 1103 return ($data, $av);
796} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
797 1111
798############################################################################# 1112#############################################################################
799# command handling &c 1113# command handling &c
800 1114
801=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
814 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
815} 1129}
816 1130
817=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
818 1132
819Register a callbackf ro execution when the client sends an extcmd packet. 1133Register a callback for execution when the client sends an (synchronous)
1134extcmd packet. Ext commands will be processed in the order they are
1135received by the server, like other user commands. The first argument is
1136the logged-in player. Ext commands can only be processed after a player
1137has logged in successfully.
820 1138
821If the callback returns something, it is sent back as if reply was being 1139If the callback returns something, it is sent back as if reply was being
822called. 1140called.
823 1141
1142=item cf::register_exticmd $name => \&callback($ns,$packet);
1143
1144Register a callback for execution when the client sends an (asynchronous)
1145exticmd packet. Exti commands are processed by the server as soon as they
1146are received, i.e. out of order w.r.t. other commands. The first argument
1147is a client socket. Exti commands can be received anytime, even before
1148log-in.
1149
1150If the callback returns something, it is sent back as if reply was being
1151called.
1152
824=cut 1153=cut
825 1154
826sub register_extcmd { 1155sub register_extcmd {
827 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
828 1157
829 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
830} 1165}
831 1166
832cf::player->attach ( 1167cf::player->attach (
833 on_command => sub { 1168 on_command => sub {
834 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
843 cf::override; 1178 cf::override;
844 }, 1179 },
845 on_extcmd => sub { 1180 on_extcmd => sub {
846 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
847 1182
848 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
849 1184
850 if (ref $msg) { 1185 if (ref $msg) {
851 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1186 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
852 if (my %reply = $cb->($pl, $msg)) { 1187 if (my %reply = $cb->($pl, $msg)) {
853 $pl->ext_reply ($msg->{msgid}, %reply); 1188 $pl->ext_reply ($msg->{msgid}, %reply);
859 1194
860 cf::override; 1195 cf::override;
861 }, 1196 },
862); 1197);
863 1198
864sub load_extension {
865 my ($path) = @_;
866
867 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
868 my $base = $1;
869 my $pkg = $1;
870 $pkg =~ s/[^[:word:]]/_/g;
871 $pkg = "ext::$pkg";
872
873 warn "... loading '$path' into '$pkg'\n";
874
875 open my $fh, "<:utf8", $path
876 or die "$path: $!";
877
878 my $source =
879 "package $pkg; use strict; use utf8;\n"
880 . "#line 1 \"$path\"\n{\n"
881 . (do { local $/; <$fh> })
882 . "\n};\n1";
883
884 unless (eval $source) {
885 my $msg = $@ ? "$path: $@\n"
886 : "extension disabled.\n";
887 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
888 warn $@;
889 warn "mandatory extension failed to load, exiting.\n";
890 exit 1;
891 }
892 die $@;
893 }
894
895 push @EXTS, $pkg;
896}
897
898sub load_extensions { 1199sub load_extensions {
1200 cf::sync_job {
1201 my %todo;
1202
899 for my $ext (<$LIBDIR/*.ext>) { 1203 for my $path (<$LIBDIR/*.ext>) {
900 next unless -r $ext; 1204 next unless -r $path;
901 eval { 1205
902 load_extension $ext; 1206 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1207 my $base = $1;
1208 my $pkg = $1;
1209 $pkg =~ s/[^[:word:]]/_/g;
1210 $pkg = "ext::$pkg";
1211
1212 open my $fh, "<:utf8", $path
1213 or die "$path: $!";
1214
1215 my $source = do { local $/; <$fh> };
1216
1217 my %ext = (
1218 path => $path,
1219 base => $base,
1220 pkg => $pkg,
1221 );
1222
1223 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1224 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1225
1226 $ext{source} =
1227 "package $pkg; use strict; use utf8;\n"
1228 . "#line 1 \"$path\"\n{\n"
1229 . $source
1230 . "\n};\n1";
1231
1232 $todo{$base} = \%ext;
1233 }
1234
1235 my %done;
1236 while (%todo) {
1237 my $progress;
1238
1239 while (my ($k, $v) = each %todo) {
1240 for (split /,\s*/, $v->{meta}{depends}) {
1241 goto skip
1242 unless exists $done{$_};
1243 }
1244
1245 warn "... loading '$k' into '$v->{pkg}'\n";
1246
1247 unless (eval $v->{source}) {
1248 my $msg = $@ ? "$v->{path}: $@\n"
1249 : "$v->{base}: extension inactive.\n";
1250
1251 if (exists $v->{meta}{mandatory}) {
1252 warn $msg;
1253 warn "mandatory extension failed to load, exiting.\n";
1254 exit 1;
1255 }
1256
1257 warn $msg;
1258 }
1259
1260 $done{$k} = delete $todo{$k};
1261 push @EXTS, $v->{pkg};
1262 $progress = 1;
903 1 1263 }
904 } or warn "$ext not loaded: $@"; 1264
1265 skip:
1266 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1267 unless $progress;
1268 }
905 } 1269 };
906} 1270}
907 1271
908############################################################################# 1272#############################################################################
909 1273
1274=back
1275
910=head2 CORE EXTENSIONS 1276=head2 CORE EXTENSIONS
911 1277
912Functions and methods that extend core crossfire objects. 1278Functions and methods that extend core crossfire objects.
913 1279
914=cut 1280=cut
926Returns the given player object, loading it if necessary (might block). 1292Returns the given player object, loading it if necessary (might block).
927 1293
928=cut 1294=cut
929 1295
930sub playerdir($) { 1296sub playerdir($) {
931 cf::localdir 1297 "$PLAYERDIR/"
932 . "/"
933 . cf::playerdir
934 . "/"
935 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1298 . (ref $_[0] ? $_[0]->ob->name : $_[0])
936} 1299}
937 1300
938sub path($) { 1301sub path($) {
939 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1302 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
940 1303
941 (playerdir $login) . "/$login.pl" 1304 (playerdir $login) . "/playerdata"
942} 1305}
943 1306
944sub find_active($) { 1307sub find_active($) {
945 $cf::PLAYER{$_[0]} 1308 $cf::PLAYER{$_[0]}
946 and $cf::PLAYER{$_[0]}->active 1309 and $cf::PLAYER{$_[0]}->active
949 1312
950sub exists($) { 1313sub exists($) {
951 my ($login) = @_; 1314 my ($login) = @_;
952 1315
953 $cf::PLAYER{$login} 1316 $cf::PLAYER{$login}
954 or cf::sync_job { !aio_stat $login } 1317 or cf::sync_job { !aio_stat path $login }
955} 1318}
956 1319
957sub find($) { 1320sub find($) {
958 return $cf::PLAYER{$_[0]} || do { 1321 return $cf::PLAYER{$_[0]} || do {
959 my $login = $_[0]; 1322 my $login = $_[0];
960 1323
961 my $guard = cf::lock_acquire "user_find:$login"; 1324 my $guard = cf::lock_acquire "user_find:$login";
962 1325
963 $cf::PLAYER{$_[0]} || do { 1326 $cf::PLAYER{$_[0]} || do {
1327 # rename old playerfiles to new ones
1328 #TODO: remove when no longer required
1329 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1330 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1331 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1332 aio_unlink +(playerdir $login) . "/$login.pl";
1333
964 my $pl = load_pl path $login 1334 my $pl = load_pl path $login
965 or return; 1335 or return;
966 $cf::PLAYER{$login} = $pl 1336 $cf::PLAYER{$login} = $pl
967 } 1337 }
968 } 1338 }
1005 1375
1006=cut 1376=cut
1007 1377
1008sub quit_character { 1378sub quit_character {
1009 my ($pl) = @_; 1379 my ($pl) = @_;
1380
1381 my $name = $pl->ob->name;
1010 1382
1011 $pl->{deny_save} = 1; 1383 $pl->{deny_save} = 1;
1012 $pl->password ("*"); # this should lock out the player until we nuked the dir 1384 $pl->password ("*"); # this should lock out the player until we nuked the dir
1013 1385
1014 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1386 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1019 my $path = playerdir $pl; 1391 my $path = playerdir $pl;
1020 my $temp = "$path~$cf::RUNTIME~deleting~"; 1392 my $temp = "$path~$cf::RUNTIME~deleting~";
1021 aio_rename $path, $temp; 1393 aio_rename $path, $temp;
1022 delete $cf::PLAYER{$pl->ob->name}; 1394 delete $cf::PLAYER{$pl->ob->name};
1023 $pl->destroy; 1395 $pl->destroy;
1396
1397 my $prefix = qr<^~\Q$name\E/>;
1398
1399 # nuke player maps
1400 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1401
1024 IO::AIO::aio_rmtree $temp; 1402 IO::AIO::aio_rmtree $temp;
1403}
1404
1405=item $pl->kick
1406
1407Kicks a player out of the game. This destroys the connection.
1408
1409=cut
1410
1411sub kick {
1412 my ($pl, $kicker) = @_;
1413
1414 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1415 $pl->killer ("kicked");
1416 $pl->ns->destroy;
1025} 1417}
1026 1418
1027=item cf::player::list_logins 1419=item cf::player::list_logins
1028 1420
1029Returns am arrayref of all valid playernames in the system, can take a 1421Returns am arrayref of all valid playernames in the system, can take a
1030while and may block, so not sync_job-capable, ever. 1422while and may block, so not sync_job-capable, ever.
1031 1423
1032=cut 1424=cut
1033 1425
1034sub list_logins { 1426sub list_logins {
1035 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1427 my $dirs = aio_readdir $PLAYERDIR
1036 or return []; 1428 or return [];
1037 1429
1038 my @logins; 1430 my @logins;
1039 1431
1040 for my $login (@$dirs) { 1432 for my $login (@$dirs) {
1057=cut 1449=cut
1058 1450
1059sub maps($) { 1451sub maps($) {
1060 my ($pl) = @_; 1452 my ($pl) = @_;
1061 1453
1454 $pl = ref $pl ? $pl->ob->name : $pl;
1455
1062 my $files = aio_readdir playerdir $pl 1456 my $files = aio_readdir playerdir $pl
1063 or return; 1457 or return;
1064 1458
1065 my @paths; 1459 my @paths;
1066 1460
1067 for (@$files) { 1461 for (@$files) {
1068 utf8::decode $_; 1462 utf8::decode $_;
1069 next if /\.(?:pl|pst)$/; 1463 next if /\.(?:pl|pst)$/;
1070 next unless /^$PATH_SEP/o; 1464 next unless /^$PATH_SEP/o;
1071 1465
1072 s/\.map$//; 1466 push @paths, cf::map::normalise "~$pl/$_";
1073 push @paths, "~" . $pl->ob->name . "/" . $_;
1074 } 1467 }
1075 1468
1076 \@paths 1469 \@paths
1077} 1470}
1078 1471
1472=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1473
1474Expand crossfire pod fragments into protocol xml.
1475
1476=cut
1477
1478sub expand_cfpod {
1479 ((my $self), (local $_)) = @_;
1480
1481 # escape & and <
1482 s/&/&amp;/g;
1483 s/(?<![BIUGH])</&lt;/g;
1484
1485 # this is buggy, it needs to properly take care of nested <'s
1486
1487 1 while
1488 # replace B<>, I<>, U<> etc.
1489 s/B<([^\>]*)>/<b>$1<\/b>/
1490 || s/I<([^\>]*)>/<i>$1<\/i>/
1491 || s/U<([^\>]*)>/<u>$1<\/u>/
1492 # replace G<male|female> tags
1493 || s{G<([^>|]*)\|([^>]*)>}{
1494 $self->gender ? $2 : $1
1495 }ge
1496 # replace H<hint text>
1497 || s{H<([^\>]*)>}
1498 {
1499 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1500 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1501 "")
1502 [$self->{hintmode}]
1503 }ge;
1504
1505 # create single paragraphs (very hackish)
1506 s/(?<=\S)\n(?=\w)/ /g;
1507
1508 # compress some whitespace
1509 s/\s+\n/\n/g; # ws line-ends
1510 s/\n\n+/\n/g; # double lines
1511 s/^\n+//; # beginning lines
1512 s/\n+$//; # ending lines
1513
1514 $_
1515}
1516
1517sub hintmode {
1518 $_[0]{hintmode} = $_[1] if @_ > 1;
1519 $_[0]{hintmode}
1520}
1521
1079=item $player->ext_reply ($msgid, $msgtype, %msg) 1522=item $player->ext_reply ($msgid, %msg)
1080 1523
1081Sends an ext reply to the player. 1524Sends an ext reply to the player.
1082 1525
1083=cut 1526=cut
1084 1527
1085sub ext_reply($$$%) { 1528sub ext_reply($$%) {
1086 my ($self, $id, %msg) = @_; 1529 my ($self, $id, %msg) = @_;
1087 1530
1088 $msg{msgid} = $id; 1531 $msg{msgid} = $id;
1089 1532 $self->send ("ext " . $self->ns->{json_coder}->encode (\%msg));
1090 $self->send ("ext " . cf::to_json \%msg);
1091} 1533}
1092 1534
1093package cf; 1535=item $player->ext_event ($type, %msg)
1536
1537Sends an ext event to the client.
1538
1539=cut
1540
1541sub ext_event($$%) {
1542 my ($self, $type, %msg) = @_;
1543
1544 $self->ns->ext_event ($type, %msg);
1545}
1546
1547=head3 cf::region
1548
1549=over 4
1550
1551=cut
1552
1553package cf::region;
1554
1555=item cf::region::find_by_path $path
1556
1557Tries to decuce the likely region for a map knowing only its path.
1558
1559=cut
1560
1561sub find_by_path($) {
1562 my ($path) = @_;
1563
1564 my ($match, $specificity);
1565
1566 for my $region (list) {
1567 if ($region->{match} && $path =~ $region->{match}) {
1568 ($match, $specificity) = ($region, $region->specificity)
1569 if $region->specificity > $specificity;
1570 }
1571 }
1572
1573 $match
1574}
1094 1575
1095=back 1576=back
1096
1097 1577
1098=head3 cf::map 1578=head3 cf::map
1099 1579
1100=over 4 1580=over 4
1101 1581
1105 1585
1106use Fcntl; 1586use Fcntl;
1107use Coro::AIO; 1587use Coro::AIO;
1108 1588
1109use overload 1589use overload
1110 '""' => \&as_string; 1590 '""' => \&as_string,
1591 fallback => 1;
1111 1592
1112our $MAX_RESET = 3600; 1593our $MAX_RESET = 3600;
1113our $DEFAULT_RESET = 3000; 1594our $DEFAULT_RESET = 3000;
1114 1595
1115sub generate_random_map { 1596sub generate_random_map {
1116 my ($self, $rmp) = @_; 1597 my ($self, $rmp) = @_;
1117
1118 # mit "rum" bekleckern, nicht 1598 # mit "rum" bekleckern, nicht
1119 $self->_create_random_map ( 1599 $self->_create_random_map (
1120 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1600 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1121 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1601 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1122 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1602 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1129 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1609 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1130 (cf::region::find $rmp->{region}), $rmp->{custom} 1610 (cf::region::find $rmp->{region}), $rmp->{custom}
1131 ) 1611 )
1132} 1612}
1133 1613
1614=item cf::map->register ($regex, $prio)
1615
1616Register a handler for the map path matching the given regex at the
1617givne priority (higher is better, built-in handlers have priority 0, the
1618default).
1619
1620=cut
1621
1134sub register { 1622sub register {
1135 my (undef, $regex) = @_; 1623 my (undef, $regex, $prio) = @_;
1136 my $pkg = caller; 1624 my $pkg = caller;
1137 1625
1138 no strict; 1626 no strict;
1139 push @{"$pkg\::ISA"}, __PACKAGE__; 1627 push @{"$pkg\::ISA"}, __PACKAGE__;
1140 1628
1141 $EXT_MAP{$pkg} = qr<$regex>; 1629 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1142} 1630}
1143 1631
1144# also paths starting with '/' 1632# also paths starting with '/'
1145$EXT_MAP{"cf::map"} = qr{^(?=/)}; 1633$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1634
1635sub thawer_merge {
1636 my ($self, $merge) = @_;
1637
1638 # we have to keep some variables in memory intact
1639 local $self->{path};
1640 local $self->{load_path};
1641
1642 $self->SUPER::thawer_merge ($merge);
1643}
1146 1644
1147sub normalise { 1645sub normalise {
1148 my ($path, $base) = @_; 1646 my ($path, $base) = @_;
1647
1648 $path = "$path"; # make sure its a string
1649
1650 $path =~ s/\.map$//;
1149 1651
1150 # map plan: 1652 # map plan:
1151 # 1653 #
1152 # /! non-realised random map exit (special hack!) 1654 # /! non-realised random map exit (special hack!)
1153 # {... are special paths that are not being touched 1655 # {... are special paths that are not being touched
1181 1683
1182 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object 1684 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1183 1685
1184 $path = normalise $path, $base; 1686 $path = normalise $path, $base;
1185 1687
1186 for my $pkg (keys %EXT_MAP) { 1688 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1187 if ($path =~ $EXT_MAP{$pkg}) { 1689 if ($path =~ $EXT_MAP{$pkg}[1]) {
1188 my $self = bless cf::map::new, $pkg; 1690 my $self = bless cf::map::new, $pkg;
1189 $self->{path} = $path; $self->path ($path); 1691 $self->{path} = $path; $self->path ($path);
1190 $self->init; # pass $1 etc. 1692 $self->init; # pass $1 etc.
1191 return $self; 1693 return $self;
1192 } 1694 }
1193 } 1695 }
1194 1696
1195 Carp::carp "unable to resolve path '$path'."; 1697 Carp::cluck "unable to resolve path '$path' (base '$base').";
1196 () 1698 ()
1197} 1699}
1198 1700
1199sub init { 1701sub init {
1200 my ($self) = @_; 1702 my ($self) = @_;
1215 1717
1216# the original (read-only) location 1718# the original (read-only) location
1217sub load_path { 1719sub load_path {
1218 my ($self) = @_; 1720 my ($self) = @_;
1219 1721
1220 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1722 "$MAPDIR/$self->{path}.map"
1221} 1723}
1222 1724
1223# the temporary/swap location 1725# the temporary/swap location
1224sub save_path { 1726sub save_path {
1225 my ($self) = @_; 1727 my ($self) = @_;
1226 1728
1227 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1729 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1228 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1730 "$TMPDIR/$path.map"
1229} 1731}
1230 1732
1231# the unique path, undef == no special unique path 1733# the unique path, undef == no special unique path
1232sub uniq_path { 1734sub uniq_path {
1233 my ($self) = @_; 1735 my ($self) = @_;
1234 1736
1235 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1737 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1236 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1738 "$UNIQUEDIR/$path"
1237} 1739}
1238 1740
1239# and all this just because we cannot iterate over 1741# and all this just because we cannot iterate over
1240# all maps in C++... 1742# all maps in C++...
1241sub change_all_map_light { 1743sub change_all_map_light {
1243 1745
1244 $_->change_map_light ($change) 1746 $_->change_map_light ($change)
1245 for grep $_->outdoor, values %cf::MAP; 1747 for grep $_->outdoor, values %cf::MAP;
1246} 1748}
1247 1749
1750sub decay_objects {
1751 my ($self) = @_;
1752
1753 return if $self->{deny_reset};
1754
1755 $self->do_decay_objects;
1756}
1757
1248sub unlink_save { 1758sub unlink_save {
1249 my ($self) = @_; 1759 my ($self) = @_;
1250 1760
1251 utf8::encode (my $save = $self->save_path); 1761 utf8::encode (my $save = $self->save_path);
1252 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save; 1762 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1253 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst"; 1763 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1254} 1764}
1255 1765
1256sub load_header_from($) { 1766sub load_header_from($) {
1257 my ($self, $path) = @_; 1767 my ($self, $path) = @_;
1258 1768
1259 utf8::encode $path; 1769 utf8::encode $path;
1260 aio_open $path, O_RDONLY, 0 1770 #aio_open $path, O_RDONLY, 0
1261 or return; 1771 # or return;
1262 1772
1263 $self->_load_header ($path) 1773 $self->_load_header ($path)
1264 or return; 1774 or return;
1265 1775
1266 $self->{load_path} = $path; 1776 $self->{load_path} = $path;
1267 1777
1268 1 1778 1
1269} 1779}
1270 1780
1271sub load_orig { 1781sub load_header_orig {
1272 my ($self) = @_; 1782 my ($self) = @_;
1273 1783
1274 $self->load_header_from ($self->load_path) 1784 $self->load_header_from ($self->load_path)
1275} 1785}
1276 1786
1277sub load_temp { 1787sub load_header_temp {
1278 my ($self) = @_; 1788 my ($self) = @_;
1279 1789
1280 $self->load_header_from ($self->save_path) 1790 $self->load_header_from ($self->save_path)
1791}
1792
1793sub prepare_temp {
1794 my ($self) = @_;
1795
1796 $self->last_access ((delete $self->{last_access})
1797 || $cf::RUNTIME); #d#
1798 # safety
1799 $self->{instantiate_time} = $cf::RUNTIME
1800 if $self->{instantiate_time} > $cf::RUNTIME;
1801}
1802
1803sub prepare_orig {
1804 my ($self) = @_;
1805
1806 $self->{load_original} = 1;
1807 $self->{instantiate_time} = $cf::RUNTIME;
1808 $self->last_access ($cf::RUNTIME);
1809 $self->instantiate;
1281} 1810}
1282 1811
1283sub load_header { 1812sub load_header {
1284 my ($self) = @_; 1813 my ($self) = @_;
1285 1814
1286 if ($self->load_temp) { 1815 if ($self->load_header_temp) {
1287 $self->last_access ((delete $self->{last_access}) 1816 $self->prepare_temp;
1288 || $cf::RUNTIME); #d#
1289 # safety
1290 $self->{instantiate_time} = $cf::RUNTIME
1291 if $self->{instantiate_time} > $cf::RUNTIME;
1292 } else { 1817 } else {
1293 $self->load_orig 1818 $self->load_header_orig
1294 or return; 1819 or return;
1295 1820 $self->prepare_orig;
1296 $self->{load_original} = 1;
1297 $self->{instantiate_time} = $cf::RUNTIME;
1298 $self->last_access ($cf::RUNTIME);
1299 $self->instantiate;
1300 } 1821 }
1822
1823 $self->{deny_reset} = 1
1824 if $self->no_reset;
1825
1826 $self->default_region (cf::region::find_by_path $self->{path})
1827 unless $self->default_region;
1301 1828
1302 1 1829 1
1303} 1830}
1304 1831
1305sub find; 1832sub find;
1318 $map->{last_save} = $cf::RUNTIME; 1845 $map->{last_save} = $cf::RUNTIME;
1319 1846
1320 $map->load_header 1847 $map->load_header
1321 or return; 1848 or return;
1322 1849
1323 if ($map->should_reset) { 1850 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1851 # doing this can freeze the server in a sync job, obviously
1852 #$cf::WAIT_FOR_TICK->wait;
1324 $map->reset; 1853 $map->reset;
1325 undef $guard; 1854 undef $guard;
1326 $map = find $path 1855 return find $path;
1327 or return;
1328 } 1856 }
1329 1857
1330 $cf::MAP{$path} = $map 1858 $cf::MAP{$path} = $map
1331 } 1859 }
1332} 1860}
1861
1862sub pre_load { }
1863sub post_load { }
1333 1864
1334sub load { 1865sub load {
1335 my ($self) = @_; 1866 my ($self) = @_;
1336 1867
1868 local $self->{deny_reset} = 1; # loading can take a long time
1869
1337 my $path = $self->{path}; 1870 my $path = $self->{path};
1871
1872 {
1338 my $guard = cf::lock_acquire "map_load:$path"; 1873 my $guard = cf::lock_acquire "map_load:$path";
1339 1874
1340 return if $self->in_memory != cf::MAP_SWAPPED; 1875 return if $self->in_memory != cf::MAP_SWAPPED;
1341 1876
1342 $self->in_memory (cf::MAP_LOADING); 1877 $self->in_memory (cf::MAP_LOADING);
1343 1878
1344 $self->alloc; 1879 $self->alloc;
1345 $self->_load_objects ($self->{load_path}, 1)
1346 or return;
1347 1880
1348 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1881 $self->pre_load;
1349 if delete $self->{load_original};
1350
1351 if (my $uniq = $self->uniq_path) {
1352 utf8::encode $uniq;
1353 if (aio_open $uniq, O_RDONLY, 0) {
1354 $self->clear_unique_items;
1355 $self->_load_objects ($uniq, 0);
1356 }
1357 }
1358
1359 Coro::cede;
1360
1361 # now do the right thing for maps
1362 $self->link_multipart_objects;
1363
1364 unless ($self->{deny_activate}) {
1365 $self->decay_objects;
1366 $self->fix_auto_apply;
1367 $self->update_buttons;
1368 Coro::cede; 1882 Coro::cede;
1369 $self->set_darkness_map; 1883
1884 $self->_load_objects ($self->{load_path}, 1)
1885 or return;
1886
1887 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1888 if delete $self->{load_original};
1889
1890 if (my $uniq = $self->uniq_path) {
1891 utf8::encode $uniq;
1892 if (aio_open $uniq, O_RDONLY, 0) {
1893 $self->clear_unique_items;
1894 $self->_load_objects ($uniq, 0);
1895 }
1896 }
1897
1898 Coro::cede;
1899 # now do the right thing for maps
1900 $self->link_multipart_objects;
1370 $self->difficulty ($self->estimate_difficulty) 1901 $self->difficulty ($self->estimate_difficulty)
1371 unless $self->difficulty; 1902 unless $self->difficulty;
1372 Coro::cede; 1903 Coro::cede;
1904
1905 unless ($self->{deny_activate}) {
1906 $self->decay_objects;
1907 $self->fix_auto_apply;
1908 $self->update_buttons;
1909 Coro::cede;
1910 $self->set_darkness_map;
1911 Coro::cede;
1373 $self->activate; 1912 $self->activate;
1374 } 1913 }
1375 1914
1376 $self->in_memory (cf::MAP_IN_MEMORY); 1915 $self->in_memory (cf::MAP_IN_MEMORY);
1916 }
1917
1918 $self->post_load;
1377} 1919}
1378 1920
1379sub customise_for { 1921sub customise_for {
1380 my ($self, $ob) = @_; 1922 my ($self, $ob) = @_;
1381 1923
1382 return find "~" . $ob->name . "/" . $self->{path} 1924 return find "~" . $ob->name . "/" . $self->{path}
1383 if $self->per_player; 1925 if $self->per_player;
1926
1927# return find "?party/" . $ob->name . "/" . $self->{path}
1928# if $self->per_party;
1384 1929
1385 $self 1930 $self
1386} 1931}
1387 1932
1388# find and load all maps in the 3x3 area around a map 1933# find and load all maps in the 3x3 area around a map
1420 1965
1421 cf::sync_job { $map->load }; 1966 cf::sync_job { $map->load };
1422} 1967}
1423 1968
1424our %MAP_PREFETCH; 1969our %MAP_PREFETCH;
1425our $MAP_PREFETCHER = Coro::async { 1970our $MAP_PREFETCHER = undef;
1426 while () {
1427 for my $path (keys %MAP_PREFETCH) {
1428 my $map = find $path
1429 or next;
1430 $map->load;
1431
1432 delete $MAP_PREFETCH{$path};
1433 }
1434 Coro::schedule;
1435 }
1436};
1437 1971
1438sub find_async { 1972sub find_async {
1439 my ($path, $origin) = @_; 1973 my ($path, $origin) = @_;
1440 1974
1441 $path = normalise $path, $origin && $origin->{path}; 1975 $path = normalise $path, $origin && $origin->{path};
1442 1976
1443 if (my $map = $cf::MAP{$path}) { 1977 if (my $map = $cf::MAP{$path}) {
1444 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1978 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1445 } 1979 }
1446 1980
1447 $MAP_PREFETCH{$path} = 0; 1981 undef $MAP_PREFETCH{$path};
1982 $MAP_PREFETCHER ||= cf::async {
1983 while (%MAP_PREFETCH) {
1984 for my $path (keys %MAP_PREFETCH) {
1985 if (my $map = find $path) {
1986 $map->load;
1987 }
1988
1989 delete $MAP_PREFETCH{$path};
1990 }
1991 }
1992 undef $MAP_PREFETCHER;
1993 };
1448 $MAP_PREFETCHER->ready; 1994 $MAP_PREFETCHER->prio (6);
1449 1995
1450 () 1996 ()
1451} 1997}
1452 1998
1453sub save { 1999sub save {
1498 2044
1499sub reset_at { 2045sub reset_at {
1500 my ($self) = @_; 2046 my ($self) = @_;
1501 2047
1502 # TODO: safety, remove and allow resettable per-player maps 2048 # TODO: safety, remove and allow resettable per-player maps
1503 return 1e99 if $self->isa ("ext::map_per_player");
1504 return 1e99 if $self->{deny_reset}; 2049 return 1e99 if $self->{deny_reset};
1505 2050
1506 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2051 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1507 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2052 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1508 2053
1513 my ($self) = @_; 2058 my ($self) = @_;
1514 2059
1515 $self->reset_at <= $cf::RUNTIME 2060 $self->reset_at <= $cf::RUNTIME
1516} 2061}
1517 2062
1518sub rename {
1519 my ($self, $new_path) = @_;
1520
1521 normalise $new_path;
1522
1523 $self->unlink_save;
1524
1525 delete $cf::MAP{$self->path};
1526 $self->{path} = $new_path; $self->path ($self->{path});
1527 $cf::MAP{$self->path} = $self;
1528
1529 $self->save;
1530}
1531
1532sub reset { 2063sub reset {
1533 my ($self) = @_; 2064 my ($self) = @_;
1534 2065
1535 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2066 my $lock = cf::lock_acquire "map_data:$self->{path}";
1536 2067
1537 return if $self->players; 2068 return if $self->players;
1538 return if $self->isa ("ext::map_per_player");#d#
1539 2069
1540 warn "resetting map ", $self->path;#d# 2070 warn "resetting map ", $self->path;
2071
2072 $self->in_memory (cf::MAP_SWAPPED);
2073
2074 # need to save uniques path
2075 unless ($self->{deny_save}) {
2076 my $uniq = $self->uniq_path; utf8::encode $uniq;
2077
2078 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2079 if $uniq;
2080 }
1541 2081
1542 delete $cf::MAP{$self->path}; 2082 delete $cf::MAP{$self->path};
1543 2083
1544 $self->in_memory (cf::MAP_SWAPPED);
1545 $self->clear; 2084 $self->clear;
1546 2085
1547 $_->clear_links_to ($self) for values %cf::MAP; 2086 $_->clear_links_to ($self) for values %cf::MAP;
1548 2087
1549 $self->unlink_save; 2088 $self->unlink_save;
1553my $nuke_counter = "aaaa"; 2092my $nuke_counter = "aaaa";
1554 2093
1555sub nuke { 2094sub nuke {
1556 my ($self) = @_; 2095 my ($self) = @_;
1557 2096
2097 delete $cf::MAP{$self->path};
2098
2099 $self->unlink_save;
2100
2101 bless $self, "cf::map";
2102 delete $self->{deny_reset};
1558 $self->{deny_save} = 1; 2103 $self->{deny_save} = 1;
1559 $self->reset_timeout (1); 2104 $self->reset_timeout (1);
1560 $self->rename ("{nuke}/" . ($nuke_counter++)); 2105 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2106
2107 $cf::MAP{$self->path} = $self;
2108
1561 $self->reset; # polite request, might not happen 2109 $self->reset; # polite request, might not happen
2110}
2111
2112=item $maps = cf::map::tmp_maps
2113
2114Returns an arrayref with all map paths of currently instantiated and saved
2115maps. May block.
2116
2117=cut
2118
2119sub tmp_maps() {
2120 [
2121 map {
2122 utf8::decode $_;
2123 /\.map$/
2124 ? normalise $_
2125 : ()
2126 } @{ aio_readdir $TMPDIR or [] }
2127 ]
2128}
2129
2130=item $maps = cf::map::random_maps
2131
2132Returns an arrayref with all map paths of currently instantiated and saved
2133random maps. May block.
2134
2135=cut
2136
2137sub random_maps() {
2138 [
2139 map {
2140 utf8::decode $_;
2141 /\.map$/
2142 ? normalise "?random/$_"
2143 : ()
2144 } @{ aio_readdir $RANDOMDIR or [] }
2145 ]
1562} 2146}
1563 2147
1564=item cf::map::unique_maps 2148=item cf::map::unique_maps
1565 2149
1566Returns an arrayref of paths of all shared maps that have 2150Returns an arrayref of paths of all shared maps that have
1567instantiated unique items. May block. 2151instantiated unique items. May block.
1568 2152
1569=cut 2153=cut
1570 2154
1571sub unique_maps() { 2155sub unique_maps() {
1572 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2156 [
1573 or return; 2157 map {
1574
1575 my @paths;
1576
1577 for (@$files) {
1578 utf8::decode $_; 2158 utf8::decode $_;
1579 next if /\.pst$/;
1580 next unless /^$PATH_SEP/o;
1581
1582 s/\.map$//; 2159 /\.map$/
1583 push @paths, $_; 2160 ? normalise $_
2161 : ()
2162 } @{ aio_readdir $UNIQUEDIR or [] }
1584 } 2163 ]
1585
1586 \@paths
1587} 2164}
1588 2165
1589package cf; 2166package cf;
1590 2167
1591=back 2168=back
1637 2214
1638 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2215 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1639 2216
1640 if ($self->{record_replies}) { 2217 if ($self->{record_replies}) {
1641 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2218 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2219
1642 } else { 2220 } else {
2221 my $pl = $self->contr;
2222
2223 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2224 my $diag = $pl->{npc_dialog};
2225 $diag->{pl}->ext_reply (
2226 $diag->{id},
2227 msgtype => "reply",
2228 msg => $diag->{pl}->expand_cfpod ($msg),
2229 add_topics => []
2230 );
2231
2232 } else {
1643 $msg = $npc->name . " says: $msg" if $npc; 2233 $msg = $npc->name . " says: $msg" if $npc;
1644 $self->message ($msg, $flags); 2234 $self->message ($msg, $flags);
2235 }
1645 } 2236 }
1646} 2237}
1647 2238
1648=item $player_object->may ("access") 2239=item $player_object->may ("access")
1649 2240
1682=cut 2273=cut
1683 2274
1684sub link_map { 2275sub link_map {
1685 unless ($LINK_MAP) { 2276 unless ($LINK_MAP) {
1686 $LINK_MAP = cf::map::find "{link}" 2277 $LINK_MAP = cf::map::find "{link}"
1687 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2278 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1688 $LINK_MAP->load; 2279 $LINK_MAP->load;
1689 } 2280 }
1690 2281
1691 $LINK_MAP 2282 $LINK_MAP
1692} 2283}
1697 $self->deactivate_recursive; 2288 $self->deactivate_recursive;
1698 2289
1699 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2290 return if UNIVERSAL::isa $self->map, "ext::map_link";
1700 2291
1701 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2292 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1702 if $self->map; 2293 if $self->map && $self->map->{path} ne "{link}";
1703 2294
1704 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2295 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1705} 2296}
1706 2297
1707sub cf::object::player::leave_link { 2298sub cf::object::player::leave_link {
1708 my ($self, $map, $x, $y) = @_; 2299 my ($self, $map, $x, $y) = @_;
2300
2301 return unless $self->contr->active;
1709 2302
1710 my $link_pos = delete $self->{_link_pos}; 2303 my $link_pos = delete $self->{_link_pos};
1711 2304
1712 unless ($map) { 2305 unless ($map) {
1713 # restore original map position 2306 # restore original map position
1731 $map->load; 2324 $map->load;
1732 $map->load_diag; 2325 $map->load_diag;
1733 2326
1734 return unless $self->contr->active; 2327 return unless $self->contr->active;
1735 $self->activate_recursive; 2328 $self->activate_recursive;
2329
2330 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1736 $self->enter_map ($map, $x, $y); 2331 $self->enter_map ($map, $x, $y);
1737} 2332}
1738 2333
1739cf::player->attach ( 2334=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1740 on_logout => sub {
1741 my ($pl) = @_;
1742 2335
1743 # abort map switching before logout 2336Moves the player to the given map-path and coordinates by first freezing
1744 if ($pl->ob->{_link_pos}) { 2337her, loading and preparing them map, calling the provided $check callback
1745 cf::sync_job { 2338that has to return the map if sucecssful, and then unfreezes the player on
1746 $pl->ob->leave_link 2339the new (success) or old (failed) map position. In either case, $done will
1747 }; 2340be called at the end of this process.
1748 }
1749 },
1750 on_login => sub {
1751 my ($pl) = @_;
1752 2341
1753 # try to abort aborted map switching on player login :)
1754 # should happen only on crashes
1755 if ($pl->ob->{_link_pos}) {
1756 $pl->ob->enter_link;
1757 (async {
1758 # we need this sleep as the login has a concurrent enter_exit running
1759 # and this sleep increases chances of the player not ending up in scorn
1760 $pl->ob->reply (undef,
1761 "There was an internal problem at your last logout, "
1762 . "the server will try to bring you to your intended destination in a second.",
1763 cf::NDI_RED);
1764 Coro::Timer::sleep 1;
1765 $pl->ob->leave_link;
1766 })->prio (2);
1767 }
1768 },
1769);
1770
1771=item $player_object->goto ($path, $x, $y)
1772
1773=cut 2342=cut
2343
2344our $GOTOGEN;
1774 2345
1775sub cf::object::player::goto { 2346sub cf::object::player::goto {
1776 my ($self, $path, $x, $y) = @_; 2347 my ($self, $path, $x, $y, $check, $done) = @_;
2348
2349 # do generation counting so two concurrent goto's will be executed in-order
2350 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1777 2351
1778 $self->enter_link; 2352 $self->enter_link;
1779 2353
1780 (async { 2354 (async {
2355 my $map = eval {
1781 my $map = cf::map::find $path; 2356 my $map = cf::map::find $path;
2357
2358 if ($map) {
1782 $map = $map->customise_for ($self) if $map; 2359 $map = $map->customise_for ($self);
1783 2360 $map = $check->($map) if $check && $map;
1784# warn "entering ", $map->path, " at ($x, $y)\n" 2361 } else {
1785# if $map;
1786
1787 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED); 2362 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2363 }
1788 2364
2365 $map
2366 };
2367
2368 if ($@) {
2369 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2370 LOG llevError | logBacktrace, Carp::longmess $@;
2371 }
2372
2373 if ($gen == $self->{_goto_generation}) {
2374 delete $self->{_goto_generation};
1789 $self->leave_link ($map, $x, $y); 2375 $self->leave_link ($map, $x, $y);
2376 }
2377
2378 $done->() if $done;
1790 })->prio (1); 2379 })->prio (1);
1791} 2380}
1792 2381
1793=item $player_object->enter_exit ($exit_object) 2382=item $player_object->enter_exit ($exit_object)
1794 2383
1796 2385
1797sub parse_random_map_params { 2386sub parse_random_map_params {
1798 my ($spec) = @_; 2387 my ($spec) = @_;
1799 2388
1800 my $rmp = { # defaults 2389 my $rmp = { # defaults
1801 xsize => 10, 2390 xsize => (cf::rndm 15, 40),
1802 ysize => 10, 2391 ysize => (cf::rndm 15, 40),
2392 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2393 #layout => string,
1803 }; 2394 };
1804 2395
1805 for (split /\n/, $spec) { 2396 for (split /\n/, $spec) {
1806 my ($k, $v) = split /\s+/, $_, 2; 2397 my ($k, $v) = split /\s+/, $_, 2;
1807 2398
1811 $rmp 2402 $rmp
1812} 2403}
1813 2404
1814sub prepare_random_map { 2405sub prepare_random_map {
1815 my ($exit) = @_; 2406 my ($exit) = @_;
2407
2408 my $guard = cf::lock_acquire "exit_prepare:$exit";
1816 2409
1817 # all this does is basically replace the /! path by 2410 # all this does is basically replace the /! path by
1818 # a new random map path (?random/...) with a seed 2411 # a new random map path (?random/...) with a seed
1819 # that depends on the exit object 2412 # that depends on the exit object
1820 2413
1821 my $rmp = parse_random_map_params $exit->msg; 2414 my $rmp = parse_random_map_params $exit->msg;
1822 2415
1823 if ($exit->map) { 2416 if ($exit->map) {
1824 $rmp->{region} = $exit->map->region_name; 2417 $rmp->{region} = $exit->region->name;
1825 $rmp->{origin_map} = $exit->map->path; 2418 $rmp->{origin_map} = $exit->map->path;
1826 $rmp->{origin_x} = $exit->x; 2419 $rmp->{origin_x} = $exit->x;
1827 $rmp->{origin_y} = $exit->y; 2420 $rmp->{origin_y} = $exit->y;
1828 } 2421 }
1829 2422
1830 $rmp->{random_seed} ||= $exit->random_seed; 2423 $rmp->{random_seed} ||= $exit->random_seed;
1831 2424
1832 my $data = cf::to_json $rmp; 2425 my $data = cf::to_json $rmp;
1833 my $md5 = Digest::MD5::md5_hex $data; 2426 my $md5 = Digest::MD5::md5_hex $data;
2427 my $meta = "$RANDOMDIR/$md5.meta";
1834 2428
1835 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) { 2429 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1836 aio_write $fh, 0, (length $data), $data, 0; 2430 aio_write $fh, 0, (length $data), $data, 0;
2431 undef $fh;
2432 aio_rename "$meta~", $meta;
1837 2433
1838 $exit->slaying ("?random/$md5"); 2434 $exit->slaying ("?random/$md5");
1839 $exit->msg (undef); 2435 $exit->msg (undef);
1840 } 2436 }
1841} 2437}
1843sub cf::object::player::enter_exit { 2439sub cf::object::player::enter_exit {
1844 my ($self, $exit) = @_; 2440 my ($self, $exit) = @_;
1845 2441
1846 return unless $self->type == cf::PLAYER; 2442 return unless $self->type == cf::PLAYER;
1847 2443
2444 if ($exit->slaying eq "/!") {
2445 #TODO: this should de-fi-ni-te-ly not be a sync-job
2446 # the problem is that $exit might not survive long enough
2447 # so it needs to be done right now, right here
2448 cf::sync_job { prepare_random_map $exit };
2449 }
2450
2451 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2452 my $hp = $exit->stats->hp;
2453 my $sp = $exit->stats->sp;
2454
1848 $self->enter_link; 2455 $self->enter_link;
2456
2457 # if exit is damned, update players death & WoR home-position
2458 $self->contr->savebed ($slaying, $hp, $sp)
2459 if $exit->flag (FLAG_DAMNED);
1849 2460
1850 (async { 2461 (async {
1851 $self->deactivate_recursive; # just to be sure 2462 $self->deactivate_recursive; # just to be sure
1852 unless (eval { 2463 unless (eval {
1853 prepare_random_map $exit 2464 $self->goto ($slaying, $hp, $sp);
1854 if $exit->slaying eq "/!";
1855
1856 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1857 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1858 2465
1859 1; 2466 1;
1860 }) { 2467 }) {
1861 $self->message ("Something went wrong deep within the crossfire server. " 2468 $self->message ("Something went wrong deep within the crossfire server. "
1862 . "I'll try to bring you back to the map you were before. " 2469 . "I'll try to bring you back to the map you were before. "
1863 . "Please report this to the dungeon master!", 2470 . "Please report this to the dungeon master!",
1864 cf::NDI_UNIQUE | cf::NDI_RED); 2471 cf::NDI_UNIQUE | cf::NDI_RED);
1865 2472
1866 warn "ERROR in enter_exit: $@"; 2473 warn "ERROR in enter_exit: $@";
1867 $self->leave_link; 2474 $self->leave_link;
1868 } 2475 }
1869 })->prio (1); 2476 })->prio (1);
1882 2489
1883sub cf::client::send_drawinfo { 2490sub cf::client::send_drawinfo {
1884 my ($self, $text, $flags) = @_; 2491 my ($self, $text, $flags) = @_;
1885 2492
1886 utf8::encode $text; 2493 utf8::encode $text;
1887 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2494 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1888} 2495}
1889 2496
2497=item $client->send_msg ($channel, $msg, $color, [extra...])
2498
2499Send a drawinfo or msg packet to the client, formatting the msg for the
2500client if neccessary. C<$type> should be a string identifying the type of
2501the message, with C<log> being the default. If C<$color> is negative, suppress
2502the message unless the client supports the msg packet.
2503
2504=cut
2505
2506sub cf::client::send_msg {
2507 my ($self, $channel, $msg, $color, @extra) = @_;
2508
2509 $msg = $self->pl->expand_cfpod ($msg);
2510
2511 $color &= ~cf::NDI_UNIQUE; # just in case...
2512
2513 if (ref $channel) {
2514 # send meta info to client, if not yet sent
2515 unless (exists $self->{channel}{$channel->{id}}) {
2516 $self->{channel}{$channel->{id}} = $channel;
2517 $self->ext_event (channel_info => %$channel);
2518 }
2519
2520 $channel = $channel->{id};
2521 }
2522
2523 return unless @extra || length $msg;
2524
2525 if ($self->can_msg) {
2526 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2527 } else {
2528 # replace some tags by gcfclient-compatible ones
2529 for ($msg) {
2530 1 while
2531 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2532 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2533 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2534 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2535 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2536 }
2537
2538 if ($color >= 0) {
2539 if (0 && $msg =~ /\[/) {
2540 $self->send_packet ("drawextinfo $color 4 0 $msg")
2541 } else {
2542 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2543 $self->send_packet ("drawinfo $color $msg")
2544 }
2545 }
2546 }
2547}
2548
2549=item $client->ext_event ($type, %msg)
2550
2551Sends an ext event to the client.
2552
2553=cut
2554
2555sub cf::client::ext_event($$%) {
2556 my ($self, $type, %msg) = @_;
2557
2558 return unless $self->extcmd;
2559
2560 $msg{msgtype} = "event_$type";
2561 $self->send_packet ("ext " . $self->{json_coder}->encode (\%msg));
2562}
1890 2563
1891=item $success = $client->query ($flags, "text", \&cb) 2564=item $success = $client->query ($flags, "text", \&cb)
1892 2565
1893Queues a query to the client, calling the given callback with 2566Queues a query to the client, calling the given callback with
1894the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2567the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1895C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2568C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1896 2569
1897Queries can fail, so check the return code. Or don't, as queries will become 2570Queries can fail, so check the return code. Or don't, as queries will
1898reliable at some point in the future. 2571become reliable at some point in the future.
1899 2572
1900=cut 2573=cut
1901 2574
1902sub cf::client::query { 2575sub cf::client::query {
1903 my ($self, $flags, $text, $cb) = @_; 2576 my ($self, $flags, $text, $cb) = @_;
1911 utf8::encode $text; 2584 utf8::encode $text;
1912 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2585 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1913 2586
1914 $self->send_packet ($self->{query_queue}[0][0]) 2587 $self->send_packet ($self->{query_queue}[0][0])
1915 if @{ $self->{query_queue} } == 1; 2588 if @{ $self->{query_queue} } == 1;
2589
2590 1
1916} 2591}
1917 2592
1918cf::client->attach ( 2593cf::client->attach (
2594 on_connect => sub {
2595 my ($ns) = @_;
2596
2597 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2598 },
1919 on_reply => sub { 2599 on_reply => sub {
1920 my ($ns, $msg) = @_; 2600 my ($ns, $msg) = @_;
1921 2601
1922 # this weird shuffling is so that direct followup queries 2602 # this weird shuffling is so that direct followup queries
1923 # get handled first 2603 # get handled first
1924 my $queue = delete $ns->{query_queue} 2604 my $queue = delete $ns->{query_queue}
1925 or return; # be conservative, not sure how that can happen, but we saw a crash here 2605 or return; # be conservative, not sure how that can happen, but we saw a crash here
1926 2606
1927 (shift @$queue)->[1]->($msg); 2607 (shift @$queue)->[1]->($msg);
2608 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1928 2609
1929 push @{ $ns->{query_queue} }, @$queue; 2610 push @{ $ns->{query_queue} }, @$queue;
1930 2611
1931 if (@{ $ns->{query_queue} } == @$queue) { 2612 if (@{ $ns->{query_queue} } == @$queue) {
1932 if (@$queue) { 2613 if (@$queue) {
1934 } else { 2615 } else {
1935 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2616 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1936 } 2617 }
1937 } 2618 }
1938 }, 2619 },
2620 on_exticmd => sub {
2621 my ($ns, $buf) = @_;
2622
2623 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2624
2625 if (ref $msg) {
2626 if (my $cb = $EXTICMD{$msg->{msgtype}}) {
2627 if (my %reply = $cb->($ns, $msg)) {
2628 $reply{msgid} = $msg->{msgid};
2629 $ns->send ("ext " . $ns->{json_coder}->encode (\%reply));
2630 }
2631 }
2632 } else {
2633 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2634 }
2635
2636 cf::override;
2637 },
1939); 2638);
1940 2639
1941=item $client->async (\&cb) 2640=item $client->async (\&cb)
1942 2641
1943Create a new coroutine, running the specified callback. The coroutine will 2642Create a new coroutine, running the specified callback. The coroutine will
1990 2689
1991# here we export the classes and methods available to script code 2690# here we export the classes and methods available to script code
1992 2691
1993=pod 2692=pod
1994 2693
1995The following fucntions and emthods are available within a safe environment: 2694The following functions and methods are available within a safe environment:
1996 2695
1997 cf::object contr pay_amount pay_player map 2696 cf::object
2697 contr pay_amount pay_player map x y force_find force_add
2698 insert remove
2699
1998 cf::object::player player 2700 cf::object::player
1999 cf::player peaceful 2701 player
2000 cf::map trigger 2702
2703 cf::player
2704 peaceful
2705
2706 cf::map
2707 trigger
2001 2708
2002=cut 2709=cut
2003 2710
2004for ( 2711for (
2005 ["cf::object" => qw(contr pay_amount pay_player map)], 2712 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2713 insert remove)],
2006 ["cf::object::player" => qw(player)], 2714 ["cf::object::player" => qw(player)],
2007 ["cf::player" => qw(peaceful)], 2715 ["cf::player" => qw(peaceful)],
2008 ["cf::map" => qw(trigger)], 2716 ["cf::map" => qw(trigger)],
2009) { 2717) {
2010 no strict 'refs'; 2718 no strict 'refs';
2081=back 2789=back
2082 2790
2083=cut 2791=cut
2084 2792
2085############################################################################# 2793#############################################################################
2794# the server's init and main functions
2086 2795
2087=head2 EXTENSION DATABASE SUPPORT 2796sub load_facedata($) {
2797 my ($path) = @_;
2088 2798
2089Crossfire maintains a very simple database for extension use. It can 2799 warn "loading facedata from $path\n";
2090currently store anything that can be serialised using Storable, which
2091excludes objects.
2092 2800
2093The parameter C<$family> should best start with the name of the extension 2801 my $facedata;
2094using it, it should be unique. 2802 0 < aio_load $path, $facedata
2803 or die "$path: $!";
2095 2804
2096=over 4 2805 $facedata = Coro::Storable::thaw $facedata;
2097 2806
2098=item $hashref = cf::db_get $family 2807 $facedata->{version} == 2
2808 or cf::cleanup "$path: version mismatch, cannot proceed.";
2099 2809
2100Return a hashref for use by the extension C<$family>, which can be
2101modified. After modifications, you have to call C<cf::db_dirty> or
2102C<cf::db_sync>.
2103
2104=item $value = cf::db_get $family => $key
2105
2106Returns a single value from the database
2107
2108=item cf::db_put $family => $hashref
2109
2110Stores the given family hashref into the database. Updates are delayed, if
2111you want the data to be synced to disk immediately, use C<cf::db_sync>.
2112
2113=item cf::db_put $family => $key => $value
2114
2115Stores the given C<$value> in the family hash. Updates are delayed, if you
2116want the data to be synced to disk immediately, use C<cf::db_sync>.
2117
2118=item cf::db_dirty
2119
2120Marks the database as dirty, to be updated at a later time.
2121
2122=item cf::db_sync
2123
2124Immediately write the database to disk I<if it is dirty>.
2125
2126=cut
2127
2128our $DB;
2129
2130{
2131 my $path = cf::localdir . "/database.pst";
2132
2133 sub db_load() {
2134 $DB = stat $path ? Storable::retrieve $path : { };
2135 } 2810 {
2811 my $faces = $facedata->{faceinfo};
2136 2812
2137 my $pid; 2813 while (my ($face, $info) = each %$faces) {
2814 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2815 cf::face::set_visibility $idx, $info->{visibility};
2816 cf::face::set_magicmap $idx, $info->{magicmap};
2817 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2818 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2138 2819
2139 sub db_save() { 2820 cf::cede_to_tick;
2140 waitpid $pid, 0 if $pid;
2141 if (0 == ($pid = fork)) {
2142 $DB->{_meta}{version} = 1;
2143 Storable::nstore $DB, "$path~";
2144 rename "$path~", $path;
2145 cf::_exit 0 if defined $pid;
2146 }
2147 }
2148
2149 my $dirty;
2150
2151 sub db_sync() {
2152 db_save if $dirty;
2153 undef $dirty;
2154 }
2155
2156 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2157 db_sync;
2158 });
2159
2160 sub db_dirty() {
2161 $dirty = 1;
2162 $idle->start;
2163 }
2164
2165 sub db_get($;$) {
2166 @_ >= 2
2167 ? $DB->{$_[0]}{$_[1]}
2168 : ($DB->{$_[0]} ||= { })
2169 }
2170
2171 sub db_put($$;$) {
2172 if (@_ >= 3) {
2173 $DB->{$_[0]}{$_[1]} = $_[2];
2174 } else {
2175 $DB->{$_[0]} = $_[1];
2176 }
2177 db_dirty;
2178 }
2179
2180 cf::global->attach (
2181 prio => 10000,
2182 on_cleanup => sub {
2183 db_sync;
2184 }, 2821 }
2185 );
2186}
2187 2822
2188############################################################################# 2823 while (my ($face, $info) = each %$faces) {
2189# the server's main() 2824 next unless $info->{smooth};
2825 my $idx = cf::face::find $face
2826 or next;
2827 if (my $smooth = cf::face::find $info->{smooth}) {
2828 cf::face::set_smooth $idx, $smooth;
2829 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2830 } else {
2831 warn "smooth face '$info->{smooth}' not found for face '$face'";
2832 }
2833
2834 cf::cede_to_tick;
2835 }
2836 }
2837
2838 {
2839 my $anims = $facedata->{animinfo};
2840
2841 while (my ($anim, $info) = each %$anims) {
2842 cf::anim::set $anim, $info->{frames}, $info->{facings};
2843 cf::cede_to_tick;
2844 }
2845
2846 cf::anim::invalidate_all; # d'oh
2847 }
2848
2849 {
2850 # TODO: for gcfclient pleasure, we should give resources
2851 # that gcfclient doesn't grok a >10000 face index.
2852 my $res = $facedata->{resource};
2853 my $enc = JSON::XS->new->utf8->canonical;
2854
2855 while (my ($name, $info) = each %$res) {
2856 my $meta = $enc->encode ({
2857 name => $name,
2858 type => $info->{type},
2859 copyright => $info->{copyright}, #TODO#
2860 });
2861
2862 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2863
2864 if ($name =~ /\.jpg$/) {
2865 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};#d# temp hack
2866 cf::face::set_data $idx, 1, $info->{data}, $info->{chksum};#d# temp hack
2867 } else {
2868 my $data = pack "(w/a*)*", $meta, $info->{data};
2869 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2870
2871 cf::face::set_type $idx, 1;
2872 cf::face::set_data $idx, 0, $data, $chk;
2873 }
2874
2875 cf::cede_to_tick;
2876 }
2877 }
2878
2879 1
2880}
2881
2882sub reload_regions {
2883 load_resource_file "$MAPDIR/regions"
2884 or die "unable to load regions file\n";
2885
2886 for (cf::region::list) {
2887 $_->{match} = qr/$_->{match}/
2888 if exists $_->{match};
2889 }
2890}
2891
2892sub reload_facedata {
2893 load_facedata "$DATADIR/facedata"
2894 or die "unable to load facedata\n";
2895}
2896
2897sub reload_archetypes {
2898 load_resource_file "$DATADIR/archetypes"
2899 or die "unable to load archetypes\n";
2900 #d# NEED to laod twice to resolve forward references
2901 # this really needs to be done in an extra post-pass
2902 # (which needs to be synchronous, so solve it differently)
2903 load_resource_file "$DATADIR/archetypes"
2904 or die "unable to load archetypes\n";
2905}
2906
2907sub reload_treasures {
2908 load_resource_file "$DATADIR/treasures"
2909 or die "unable to load treasurelists\n";
2910}
2911
2912sub reload_resources {
2913 warn "reloading resource files...\n";
2914
2915 reload_regions;
2916 reload_facedata;
2917 #reload_archetypes;#d#
2918 reload_archetypes;
2919 reload_treasures;
2920
2921 warn "finished reloading resource files\n";
2922}
2923
2924sub init {
2925 reload_resources;
2926}
2190 2927
2191sub cfg_load { 2928sub cfg_load {
2192 open my $fh, "<:utf8", cf::confdir . "/config" 2929 open my $fh, "<:utf8", "$CONFDIR/config"
2193 or return; 2930 or return;
2194 2931
2195 local $/; 2932 local $/;
2196 *CFG = YAML::Syck::Load <$fh>; 2933 *CFG = YAML::Syck::Load <$fh>;
2197 2934
2211 2948
2212sub main { 2949sub main {
2213 # we must not ever block the main coroutine 2950 # we must not ever block the main coroutine
2214 local $Coro::idle = sub { 2951 local $Coro::idle = sub {
2215 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 2952 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2953 (async {
2216 async { Event::one_event }; 2954 Event::one_event;
2955 })->prio (Coro::PRIO_MAX);
2217 }; 2956 };
2218 2957
2219 cfg_load; 2958 cfg_load;
2220 db_load; 2959 db_init;
2221 load_extensions; 2960 load_extensions;
2961
2962 $TICK_WATCHER->start;
2222 Event::loop; 2963 Event::loop;
2223} 2964}
2224 2965
2225############################################################################# 2966#############################################################################
2226# initialisation and cleanup 2967# initialisation and cleanup
2227 2968
2228# install some emergency cleanup handlers 2969# install some emergency cleanup handlers
2229BEGIN { 2970BEGIN {
2230 for my $signal (qw(INT HUP TERM)) { 2971 for my $signal (qw(INT HUP TERM)) {
2231 Event->signal ( 2972 Event->signal (
2973 reentrant => 0,
2232 data => WF_AUTOCANCEL, 2974 data => WF_AUTOCANCEL,
2233 signal => $signal, 2975 signal => $signal,
2976 prio => 0,
2234 cb => sub { 2977 cb => sub {
2235 cf::cleanup "SIG$signal"; 2978 cf::cleanup "SIG$signal";
2236 }, 2979 },
2237 ); 2980 );
2238 } 2981 }
2982}
2983
2984sub write_runtime {
2985 my $runtime = "$LOCALDIR/runtime";
2986
2987 # first touch the runtime file to show we are still running:
2988 # the fsync below can take a very very long time.
2989
2990 IO::AIO::aio_utime $runtime, undef, undef;
2991
2992 my $guard = cf::lock_acquire "write_runtime";
2993
2994 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
2995 or return;
2996
2997 my $value = $cf::RUNTIME + 90 + 10;
2998 # 10 is the runtime save interval, for a monotonic clock
2999 # 60 allows for the watchdog to kill the server.
3000
3001 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3002 and return;
3003
3004 # always fsync - this file is important
3005 aio_fsync $fh
3006 and return;
3007
3008 # touch it again to show we are up-to-date
3009 aio_utime $fh, undef, undef;
3010
3011 close $fh
3012 or return;
3013
3014 aio_rename "$runtime~", $runtime
3015 and return;
3016
3017 warn "runtime file written.\n";
3018
3019 1
2239} 3020}
2240 3021
2241sub emergency_save() { 3022sub emergency_save() {
2242 my $freeze_guard = cf::freeze_mainloop; 3023 my $freeze_guard = cf::freeze_mainloop;
2243 3024
2260 my $map = $cf::MAP{$path} or next; 3041 my $map = $cf::MAP{$path} or next;
2261 $map->valid or next; 3042 $map->valid or next;
2262 $map->save; 3043 $map->save;
2263 } 3044 }
2264 warn "end emergency map save\n"; 3045 warn "end emergency map save\n";
3046
3047 warn "begin emergency database checkpoint\n";
3048 BDB::db_env_txn_checkpoint $DB_ENV;
3049 warn "end emergency database checkpoint\n";
2265 }; 3050 };
2266 3051
2267 warn "leave emergency perl save\n"; 3052 warn "leave emergency perl save\n";
2268} 3053}
2269 3054
3055sub post_cleanup {
3056 my ($make_core) = @_;
3057
3058 warn Carp::longmess "post_cleanup backtrace"
3059 if $make_core;
3060}
3061
2270sub reload() { 3062sub do_reload_perl() {
2271 # can/must only be called in main 3063 # can/must only be called in main
2272 if ($Coro::current != $Coro::main) { 3064 if ($Coro::current != $Coro::main) {
2273 warn "can only reload from main coroutine\n"; 3065 warn "can only reload from main coroutine";
2274 return; 3066 return;
2275 } 3067 }
2276 3068
2277 warn "reloading..."; 3069 warn "reloading...";
2278 3070
2279 warn "freezing server"; 3071 warn "entering sync_job";
2280 my $guard = freeze_mainloop; 3072
3073 cf::sync_job {
3074 cf::write_runtime; # external watchdog should not bark
2281 cf::emergency_save; 3075 cf::emergency_save;
3076 cf::write_runtime; # external watchdog should not bark
2282 3077
2283 warn "sync database to disk"; 3078 warn "syncing database to disk";
2284 cf::db_sync; 3079 BDB::db_env_txn_checkpoint $DB_ENV;
2285 IO::AIO::flush;
2286 3080
2287 eval {
2288 # if anything goes wrong in here, we should simply crash as we already saved 3081 # if anything goes wrong in here, we should simply crash as we already saved
2289 3082
2290 warn "cancel all watchers"; 3083 warn "cancelling all WF_AUTOCANCEL watchers";
2291 for (Event::all_watchers) { 3084 for (Event::all_watchers) {
2292 $_->cancel if $_->data & WF_AUTOCANCEL; 3085 $_->cancel if $_->data & WF_AUTOCANCEL;
2293 } 3086 }
2294 3087
3088 warn "flushing outstanding aio requests";
3089 for (;;) {
3090 BDB::flush;
3091 IO::AIO::flush;
3092 Coro::cede;
3093 last unless IO::AIO::nreqs || BDB::nreqs;
3094 warn "iterate...";
3095 }
3096
3097 ++$RELOAD;
3098
2295 warn "cancel all extension coros"; 3099 warn "cancelling all extension coros";
2296 $_->cancel for values %EXT_CORO; 3100 $_->cancel for values %EXT_CORO;
2297 %EXT_CORO = (); 3101 %EXT_CORO = ();
2298 3102
2299 warn "remove commands"; 3103 warn "removing commands";
2300 %COMMAND = (); 3104 %COMMAND = ();
2301 3105
2302 warn "remove ext commands"; 3106 warn "removing ext/exti commands";
2303 %EXTCMD = (); 3107 %EXTCMD = ();
3108 %EXTICMD = ();
2304 3109
2305 warn "unload/nuke all extensions"; 3110 warn "unloading/nuking all extensions";
2306 for my $pkg (@EXTS) { 3111 for my $pkg (@EXTS) {
2307 warn "... unloading $pkg"; 3112 warn "... unloading $pkg";
2308 3113
2309 if (my $cb = $pkg->can ("unload")) { 3114 if (my $cb = $pkg->can ("unload")) {
2310 eval { 3115 eval {
2315 3120
2316 warn "... nuking $pkg"; 3121 warn "... nuking $pkg";
2317 Symbol::delete_package $pkg; 3122 Symbol::delete_package $pkg;
2318 } 3123 }
2319 3124
2320 warn "unload all perl modules loaded from $LIBDIR"; 3125 warn "unloading all perl modules loaded from $LIBDIR";
2321 while (my ($k, $v) = each %INC) { 3126 while (my ($k, $v) = each %INC) {
2322 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3127 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2323 3128
2324 warn "removing <$k>"; 3129 warn "... unloading $k";
2325 delete $INC{$k}; 3130 delete $INC{$k};
2326 3131
2327 $k =~ s/\.pm$//; 3132 $k =~ s/\.pm$//;
2328 $k =~ s/\//::/g; 3133 $k =~ s/\//::/g;
2329 3134
2332 } 3137 }
2333 3138
2334 Symbol::delete_package $k; 3139 Symbol::delete_package $k;
2335 } 3140 }
2336 3141
2337 warn "get rid of safe::, as good as possible"; 3142 warn "getting rid of safe::, as good as possible";
2338 Symbol::delete_package "safe::$_" 3143 Symbol::delete_package "safe::$_"
2339 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3144 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2340 3145
2341 warn "unload cf.pm \"a bit\""; 3146 warn "unloading cf.pm \"a bit\"";
2342 delete $INC{"cf.pm"}; 3147 delete $INC{"cf.pm"};
3148 delete $INC{"cf/pod.pm"};
2343 3149
2344 # don't, removes xs symbols, too, 3150 # don't, removes xs symbols, too,
2345 # and global variables created in xs 3151 # and global variables created in xs
2346 #Symbol::delete_package __PACKAGE__; 3152 #Symbol::delete_package __PACKAGE__;
2347 3153
3154 warn "unload completed, starting to reload now";
3155
2348 warn "reloading cf.pm"; 3156 warn "reloading cf.pm";
2349 require cf; 3157 require cf;
2350 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3158 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2351 3159
2352 warn "load config and database again"; 3160 warn "loading config and database again";
2353 cf::cfg_load; 3161 cf::cfg_load;
2354 cf::db_load;
2355 3162
2356 warn "load extensions"; 3163 warn "loading extensions";
2357 cf::load_extensions; 3164 cf::load_extensions;
2358 3165
2359 warn "reattach attachments to objects/players"; 3166 warn "reattaching attachments to objects/players";
2360 _global_reattach; 3167 _global_reattach; # objects, sockets
2361 warn "reattach attachments to maps"; 3168 warn "reattaching attachments to maps";
2362 reattach $_ for values %MAP; 3169 reattach $_ for values %MAP;
2363 }; 3170 warn "reattaching attachments to players";
3171 reattach $_ for values %PLAYER;
2364 3172
2365 if ($@) { 3173 warn "leaving sync_job";
3174
3175 1
3176 } or do {
2366 warn $@; 3177 warn $@;
2367 warn "error while reloading, exiting."; 3178 warn "error while reloading, exiting.";
2368 exit 1; 3179 exit 1;
2369 } 3180 };
2370 3181
2371 warn "reloaded"; 3182 warn "reloaded";
2372}; 3183};
2373 3184
3185our $RELOAD_WATCHER; # used only during reload
3186
3187sub reload_perl() {
3188 # doing reload synchronously and two reloads happen back-to-back,
3189 # coro crashes during coro_state_free->destroy here.
3190
3191 $RELOAD_WATCHER ||= Event->timer (
3192 reentrant => 0,
3193 after => 0,
3194 data => WF_AUTOCANCEL,
3195 cb => sub {
3196 do_reload_perl;
3197 undef $RELOAD_WATCHER;
3198 },
3199 );
3200}
3201
2374register_command "reload" => sub { 3202register_command "reload" => sub {
2375 my ($who, $arg) = @_; 3203 my ($who, $arg) = @_;
2376 3204
2377 if ($who->flag (FLAG_WIZ)) { 3205 if ($who->flag (FLAG_WIZ)) {
2378 $who->message ("start of reload.");
2379 reload;
2380 $who->message ("end of reload."); 3206 $who->message ("reloading server.");
3207 async { reload_perl };
2381 } 3208 }
2382}; 3209};
2383 3210
2384unshift @INC, $LIBDIR; 3211unshift @INC, $LIBDIR;
2385 3212
3213my $bug_warning = 0;
3214
3215our @WAIT_FOR_TICK;
3216our @WAIT_FOR_TICK_BEGIN;
3217
3218sub wait_for_tick {
3219 return unless $TICK_WATCHER->is_active;
3220 return if $Coro::current == $Coro::main;
3221
3222 my $signal = new Coro::Signal;
3223 push @WAIT_FOR_TICK, $signal;
3224 $signal->wait;
3225}
3226
3227sub wait_for_tick_begin {
3228 return unless $TICK_WATCHER->is_active;
3229 return if $Coro::current == $Coro::main;
3230
3231 my $signal = new Coro::Signal;
3232 push @WAIT_FOR_TICK_BEGIN, $signal;
3233 $signal->wait;
3234}
3235
3236 my $min = 1e6;#d#
3237 my $avg = 10;
2386$TICK_WATCHER = Event->timer ( 3238$TICK_WATCHER = Event->timer (
2387 reentrant => 0, 3239 reentrant => 0,
3240 parked => 1,
2388 prio => 0, 3241 prio => 0,
2389 at => $NEXT_TICK || $TICK, 3242 at => $NEXT_TICK || $TICK,
2390 data => WF_AUTOCANCEL, 3243 data => WF_AUTOCANCEL,
2391 cb => sub { 3244 cb => sub {
3245 if ($Coro::current != $Coro::main) {
3246 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3247 unless ++$bug_warning > 10;
3248 return;
3249 }
3250
2392 $NOW = Event::time; 3251 $NOW = $tick_start = Event::time;
2393 3252
2394 cf::server_tick; # one server iteration 3253 cf::server_tick; # one server iteration
3254
3255 0 && sync_job {#d#
3256 for(1..10) {
3257 my $t = Event::time;
3258 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3259 or die;
3260
3261 $map->width (50);
3262 $map->height (50);
3263 $map->alloc;
3264 $map->_load_objects ("/tmp/x.map", 1);
3265 my $t = Event::time - $t;
3266
3267 #next unless $t < 0.0013;#d#
3268 if ($t < $min) {
3269 $min = $t;
3270 }
3271 $avg = $avg * 0.99 + $t * 0.01;
3272 }
3273 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3274 exit 0;
3275 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3276 };
3277
2395 $RUNTIME += $TICK; 3278 $RUNTIME += $TICK;
2396 $NEXT_TICK += $TICK; 3279 $NEXT_TICK += $TICK;
2397 3280
2398 $WAIT_FOR_TICK->broadcast; 3281 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2399 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3282 $NEXT_RUNTIME_WRITE = $NOW + 10;
3283 Coro::async_pool {
3284 write_runtime
3285 or warn "ERROR: unable to write runtime file: $!";
3286 };
3287 }
3288
3289# my $AFTER = Event::time;
3290# warn $AFTER - $NOW;#d#
3291
3292 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3293 $sig->send;
3294 }
3295 while (my $sig = shift @WAIT_FOR_TICK) {
3296 $sig->send;
3297 }
3298
3299 $NOW = Event::time;
2400 3300
2401 # if we are delayed by four ticks or more, skip them all 3301 # if we are delayed by four ticks or more, skip them all
2402 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3302 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2403 3303
2404 $TICK_WATCHER->at ($NEXT_TICK); 3304 $TICK_WATCHER->at ($NEXT_TICK);
2405 $TICK_WATCHER->start; 3305 $TICK_WATCHER->start;
3306
3307 $LOAD = ($NOW - $tick_start) / $TICK;
3308 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3309
3310 _post_tick;
3311
3312
2406 }, 3313 },
2407); 3314);
2408 3315
3316{
3317 BDB::max_poll_time $TICK * 0.1;
3318 $BDB_POLL_WATCHER = Event->io (
3319 reentrant => 0,
3320 fd => BDB::poll_fileno,
3321 poll => 'r',
3322 prio => 0,
3323 data => WF_AUTOCANCEL,
3324 cb => \&BDB::poll_cb,
3325 );
3326 BDB::min_parallel 8;
3327
3328 BDB::set_sync_prepare {
3329 my $status;
3330 my $current = $Coro::current;
3331 (
3332 sub {
3333 $status = $!;
3334 $current->ready; undef $current;
3335 },
3336 sub {
3337 Coro::schedule while defined $current;
3338 $! = $status;
3339 },
3340 )
3341 };
3342
3343 unless ($DB_ENV) {
3344 $DB_ENV = BDB::db_env_create;
3345
3346 cf::sync_job {
3347 eval {
3348 BDB::db_env_open
3349 $DB_ENV,
3350 $BDBDIR,
3351 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3352 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3353 0666;
3354
3355 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3356
3357 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3358 $DB_ENV->set_lk_detect;
3359 };
3360
3361 cf::cleanup "db_env_open(db): $@" if $@;
3362 };
3363 }
3364}
3365
3366{
3367 IO::AIO::min_parallel 8;
3368
3369 undef $Coro::AIO::WATCHER;
2409IO::AIO::max_poll_time $TICK * 0.2; 3370 IO::AIO::max_poll_time $TICK * 0.1;
2410
2411$AIO_POLL_WATCHER = Event->io ( 3371 $AIO_POLL_WATCHER = Event->io (
2412 fd => IO::AIO::poll_fileno, 3372 reentrant => 0,
2413 poll => 'r',
2414 prio => 5,
2415 data => WF_AUTOCANCEL,
2416 cb => \&IO::AIO::poll_cb,
2417);
2418
2419$WRITE_RUNTIME_WATCHER = Event->timer (
2420 data => WF_AUTOCANCEL, 3373 data => WF_AUTOCANCEL,
2421 after => 0, 3374 fd => IO::AIO::poll_fileno,
2422 interval => 10, 3375 poll => 'r',
2423 cb => sub { 3376 prio => 6,
2424 (Coro::unblock_sub { 3377 cb => \&IO::AIO::poll_cb,
2425 write_runtime 3378 );
2426 or warn "ERROR: unable to write runtime file: $!"; 3379}
3380
3381my $_log_backtrace;
3382
3383sub _log_backtrace {
3384 my ($msg, @addr) = @_;
3385
3386 $msg =~ s/\n//;
3387
3388 # limit the # of concurrent backtraces
3389 if ($_log_backtrace < 2) {
3390 ++$_log_backtrace;
3391 async {
3392 my @bt = fork_call {
3393 @addr = map { sprintf "%x", $_ } @addr;
3394 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3395 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3396 or die "addr2line: $!";
3397
3398 my @funcs;
3399 my @res = <$fh>;
3400 chomp for @res;
3401 while (@res) {
3402 my ($func, $line) = splice @res, 0, 2, ();
3403 push @funcs, "[$func] $line";
3404 }
3405
3406 @funcs
3407 };
3408
3409 LOG llevInfo, "[ABT] $msg\n";
3410 LOG llevInfo, "[ABT] $_\n" for @bt;
3411 --$_log_backtrace;
2427 })->(); 3412 };
3413 } else {
3414 LOG llevInfo, "[ABT] $msg\n";
3415 LOG llevInfo, "[ABT] [suppressed]\n";
2428 }, 3416 }
2429); 3417}
3418
3419# load additional modules
3420use cf::pod;
2430 3421
2431END { cf::emergency_save } 3422END { cf::emergency_save }
2432 3423
24331 34241
2434 3425

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines