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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.213 by root, Tue Feb 13 20:01:04 2007 UTC vs.
Revision 1.358 by root, Fri Sep 7 18:10:52 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.5 (); 15use Coro 3.64 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
24use Coro::Util ();
19 25
26use JSON::XS ();
20use BDB (); 27use BDB ();
21use Data::Dumper; 28use Data::Dumper;
22use Digest::MD5; 29use Digest::MD5;
23use Fcntl; 30use Fcntl;
31use YAML::Syck ();
24use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
25use YAML::Syck ();
26use Time::HiRes; 33use Time::HiRes;
27use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
28 36
37# configure various modules to our taste
38#
39$Storable::canonical = 1; # reduce rsync transfers
40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
29Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 41Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30 42
31use Event; $Event::Eval = 1; # no idea why this is required, but it is 43$Event::Eval = 1; # no idea why this is required, but it is
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 44
35# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 45# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36$YAML::Syck::ImplicitUnicode = 1; 46$YAML::Syck::ImplicitUnicode = 1;
37 47
38$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 48$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39 49
50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
51
40our %COMMAND = (); 52our %COMMAND = ();
41our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
42 54
43our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
44our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
45our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
46our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
47 60
61our $RELOAD; # number of reloads so far
48our @EVENT; 62our @EVENT;
49our $LIBDIR = datadir . "/ext";
50 63
51our $TICK = MAX_TIME * 1e-6; 64our $CONFDIR = confdir;
65our $DATADIR = datadir;
66our $LIBDIR = "$DATADIR/ext";
67our $PODDIR = "$DATADIR/pod";
68our $MAPDIR = "$DATADIR/" . mapdir;
69our $LOCALDIR = localdir;
70our $TMPDIR = "$LOCALDIR/" . tmpdir;
71our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
72our $PLAYERDIR = "$LOCALDIR/" . playerdir;
73our $RANDOMDIR = "$LOCALDIR/random";
74our $BDBDIR = "$LOCALDIR/db";
75
76our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
52our $TICK_WATCHER; 77our $TICK_WATCHER;
53our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
54our $WRITE_RUNTIME_WATCHER; 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55our $NEXT_TICK; 80our $NEXT_TICK;
56our $NOW; 81our $NOW;
57our $USE_FSYNC = 1; # use fsync to write maps - default off 82our $USE_FSYNC = 1; # use fsync to write maps - default off
58 83
59our $BDB_POLL_WATCHER; 84our $BDB_POLL_WATCHER;
62our %CFG; 87our %CFG;
63 88
64our $UPTIME; $UPTIME ||= time; 89our $UPTIME; $UPTIME ||= time;
65our $RUNTIME; 90our $RUNTIME;
66 91
67our %PLAYER; # all users 92our (%PLAYER, %PLAYER_LOADING); # all users
68our %MAP; # all maps 93our (%MAP, %MAP_LOADING ); # all maps
69our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
70our $RANDOM_MAPS = cf::localdir . "/random";
71our $BDB_ENV_DIR = cf::localdir . "/db";
72
73our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75 95
76# used to convert map paths into valid unix filenames by replacing / by ∕ 96# used to convert map paths into valid unix filenames by replacing / by ∕
77our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78 98
99our $LOAD; # a number between 0 (idle) and 1 (too many objects)
100our $LOADAVG; # same thing, but with alpha-smoothing
101our $tick_start; # for load detecting purposes
102
79binmode STDOUT; 103binmode STDOUT;
80binmode STDERR; 104binmode STDERR;
81 105
82# read virtual server time, if available 106# read virtual server time, if available
83unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
85 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
86 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
87} 111}
88 112
89mkdir cf::localdir; 113mkdir $_
90mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91mkdir cf::localdir . "/" . cf::tmpdir;
92mkdir cf::localdir . "/" . cf::uniquedir;
93mkdir $RANDOM_MAPS;
94mkdir $BDB_ENV_DIR;
95 115
96our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
97 117
98sub cf::map::normalise; 118sub cf::map::normalise;
99 119
110=item $cf::RUNTIME 130=item $cf::RUNTIME
111 131
112The time this server has run, starts at 0 and is increased by $cf::TICK on 132The time this server has run, starts at 0 and is increased by $cf::TICK on
113every server tick. 133every server tick.
114 134
115=item $cf::LIBDIR 135=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
136$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
137$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
116 138
117The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
118be found. It will be added to C<@INC> automatically. 140directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
141unique-items directory, player file directory, random maps directory and
142database environment.
119 143
120=item $cf::NOW 144=item $cf::NOW
121 145
122The time of the last (current) server tick. 146The time of the last (current) server tick.
123 147
124=item $cf::TICK 148=item $cf::TICK
125 149
126The interval between server ticks, in seconds. 150The interval between server ticks, in seconds.
151
152=item $cf::LOADAVG
153
154The current CPU load on the server (alpha-smoothed), as a value between 0
155(none) and 1 (overloaded), indicating how much time is spent on processing
156objects per tick. Healthy values are < 0.5.
157
158=item $cf::LOAD
159
160The raw value load value from the last tick.
127 161
128=item %cf::CFG 162=item %cf::CFG
129 163
130Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
131from wherever your confdir points to. 165from wherever your confdir points to.
132 166
133=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 167=item cf::wait_for_tick, cf::wait_for_tick_begin
134 168
135These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
136or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 170returns directly I<after> the tick processing (and consequently, can only wake one process
137processing has been done. Call C<< ->wait >> on them to maximise the 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
138window of cpu time available, or simply to synchronise to the server tick. 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
139 178
140=back 179=back
141 180
142=cut 181=cut
143 182
144BEGIN { 183BEGIN {
145 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
146 my $msg = join "", @_; 185 my $msg = join "", @_;
147 utf8::encode $msg;
148 186
149 $msg .= "\n" 187 $msg .= "\n"
150 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
151 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
152 LOG llevError, $msg; 193 LOG llevError, $msg;
153 }; 194 };
154} 195}
155 196
156@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 201@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
202@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
161@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 203@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
162 204
163# we bless all objects into (empty) derived classes to force a method lookup 205# we bless all objects into (empty) derived classes to force a method lookup
164# within the Safe compartment. 206# within the Safe compartment.
165for my $pkg (qw( 207for my $pkg (qw(
166 cf::global cf::attachable 208 cf::global cf::attachable
174} 216}
175 217
176$Event::DIED = sub { 218$Event::DIED = sub {
177 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
178}; 220};
221
222#############################################################################
179 223
180=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
181 225
182=over 4 226=over 4
183 227
202 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203 $d 247 $d
204 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
205} 249}
206 250
207use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
210 252
211Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
212 254
213=cut
214
215sub from_json($) {
216 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217 JSON::Syck::Load $_[0]
218}
219
220=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
221 256
222Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
223 258
224=cut 259=cut
225 260
226sub to_json($) { 261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 262
228 JSON::Syck::Dump $_[0] 263sub to_json ($) { $json_coder->encode ($_[0]) }
229} 264sub from_json ($) { $json_coder->decode ($_[0]) }
230 265
231=item cf::lock_wait $string 266=item cf::lock_wait $string
232 267
233Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
234 269
237Wait until the given lock is available and then acquires it and returns 272Wait until the given lock is available and then acquires it and returns
238a Coro::guard object. If the guard object gets destroyed (goes out of scope, 273a Coro::guard object. If the guard object gets destroyed (goes out of scope,
239for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
240returned. 275returned.
241 276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
279
242Lock names should begin with a unique identifier (for example, cf::map::find 280Lock names should begin with a unique identifier (for example, cf::map::find
243uses map_find and cf::map::load uses map_load). 281uses map_find and cf::map::load uses map_load).
244 282
283=item $locked = cf::lock_active $string
284
285Return true if the lock is currently active, i.e. somebody has locked it.
286
245=cut 287=cut
246 288
247our %LOCK; 289our %LOCK;
290our %LOCKER;#d#
248 291
249sub lock_wait($) { 292sub lock_wait($) {
250 my ($key) = @_; 293 my ($key) = @_;
294
295 if ($LOCKER{$key} == $Coro::current) {#d#
296 Carp::cluck "lock_wait($key) for already-acquired lock";#d#
297 return;#d#
298 }#d#
251 299
252 # wait for lock, if any 300 # wait for lock, if any
253 while ($LOCK{$key}) { 301 while ($LOCK{$key}) {
254 push @{ $LOCK{$key} }, $Coro::current; 302 push @{ $LOCK{$key} }, $Coro::current;
255 Coro::schedule; 303 Coro::schedule;
261 309
262 # wait, to be sure we are not locked 310 # wait, to be sure we are not locked
263 lock_wait $key; 311 lock_wait $key;
264 312
265 $LOCK{$key} = []; 313 $LOCK{$key} = [];
314 $LOCKER{$key} = $Coro::current;#d#
266 315
267 Coro::guard { 316 Coro::guard {
317 delete $LOCKER{$key};#d#
268 # wake up all waiters, to be on the safe side 318 # wake up all waiters, to be on the safe side
269 $_->ready for @{ delete $LOCK{$key} }; 319 $_->ready for @{ delete $LOCK{$key} };
270 } 320 }
271} 321}
272 322
323sub lock_active($) {
324 my ($key) = @_;
325
326 ! ! $LOCK{$key}
327}
328
273sub freeze_mainloop { 329sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active; 330 return unless $TICK_WATCHER->is_active;
275 331
276 my $guard = Coro::guard { 332 my $guard = Coro::guard {
277 $TICK_WATCHER->start; 333 $TICK_WATCHER->start;
278 $WRITE_RUNTIME_WATCHER->start;
279 }; 334 };
280 $WRITE_RUNTIME_WATCHER->stop;
281 $TICK_WATCHER->stop; 335 $TICK_WATCHER->stop;
282 $guard 336 $guard
337}
338
339=item cf::get_slot $time[, $priority[, $name]]
340
341Allocate $time seconds of blocking CPU time at priority C<$priority>:
342This call blocks and returns only when you have at least C<$time> seconds
343of cpu time till the next tick. The slot is only valid till the next cede.
344
345The optional C<$name> can be used to identify the job to run. It might be
346used for statistical purposes and should identify the same time-class.
347
348Useful for short background jobs.
349
350=cut
351
352our @SLOT_QUEUE;
353our $SLOT_QUEUE;
354
355$SLOT_QUEUE->cancel if $SLOT_QUEUE;
356$SLOT_QUEUE = Coro::async {
357 my $signal = new Coro::Signal;
358
359 while () {
360 next_job:
361 my $avail = cf::till_tick;
362 if ($avail > 0.01) {
363 for (0 .. $#SLOT_QUEUE) {
364 if ($SLOT_QUEUE[$_][0] < $avail) {
365 my $job = splice @SLOT_QUEUE, $_, 1, ();
366 $job->[2]->send;
367 Coro::cede;
368 goto next_job;
369 }
370 }
371 }
372
373 if (@SLOT_QUEUE) {
374 # we do not use wait_For_tick() as it returns immediately when tick is inactive
375 push @cf::WAIT_FOR_TICK, $signal;
376 $signal->wait;
377 } else {
378 Coro::schedule;
379 }
380 }
381};
382
383sub get_slot($;$$) {
384 my ($time, $pri, $name) = @_;
385
386 $time = $TICK * .6 if $time > $TICK * .6;
387 my $sig = new Coro::Signal;
388
389 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
390 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
391 $SLOT_QUEUE->ready;
392 $sig->wait;
283} 393}
284 394
285=item cf::async { BLOCK } 395=item cf::async { BLOCK }
286 396
287Currently the same as Coro::async_pool, meaning you cannot use 397Currently the same as Coro::async_pool, meaning you cannot use
292 402
293BEGIN { *async = \&Coro::async_pool } 403BEGIN { *async = \&Coro::async_pool }
294 404
295=item cf::sync_job { BLOCK } 405=item cf::sync_job { BLOCK }
296 406
297The design of crossfire+ requires that the main coro ($Coro::main) is 407The design of Crossfire TRT requires that the main coroutine ($Coro::main)
298always able to handle events or runnable, as crossfire+ is only partly 408is always able to handle events or runnable, as Crossfire TRT is only
299reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 409partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
410acceptable.
300 411
301If it must be done, put the blocking parts into C<sync_job>. This will run 412If it must be done, put the blocking parts into C<sync_job>. This will run
302the given BLOCK in another coroutine while waiting for the result. The 413the given BLOCK in another coroutine while waiting for the result. The
303server will be frozen during this time, so the block should either finish 414server will be frozen during this time, so the block should either finish
304fast or be very important. 415fast or be very important.
307 418
308sub sync_job(&) { 419sub sync_job(&) {
309 my ($job) = @_; 420 my ($job) = @_;
310 421
311 if ($Coro::current == $Coro::main) { 422 if ($Coro::current == $Coro::main) {
423 my $time = Event::time;
424
312 # this is the main coro, too bad, we have to block 425 # this is the main coro, too bad, we have to block
313 # till the operation succeeds, freezing the server :/ 426 # till the operation succeeds, freezing the server :/
314 427
315 # TODO: use suspend/resume instead 428 # TODO: use suspend/resume instead
316 # (but this is cancel-safe) 429 # (but this is cancel-safe)
327 440
328 while ($busy) { 441 while ($busy) {
329 Coro::cede or Event::one_event; 442 Coro::cede or Event::one_event;
330 } 443 }
331 444
445 $time = Event::time - $time;
446
447 LOG llevError | logBacktrace, Carp::longmess "long sync job"
448 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
449
450 $tick_start += $time; # do not account sync jobs to server load
451
332 wantarray ? @res : $res[0] 452 wantarray ? @res : $res[0]
333 } else { 453 } else {
334 # we are in another coroutine, how wonderful, everything just works 454 # we are in another coroutine, how wonderful, everything just works
335 455
336 $job->() 456 $job->()
355 $EXT_CORO{$coro+0} = $coro; 475 $EXT_CORO{$coro+0} = $coro;
356 476
357 $coro 477 $coro
358} 478}
359 479
360sub write_runtime { 480=item fork_call { }, $args
361 my $runtime = cf::localdir . "/runtime";
362 481
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 482Executes the given code block with the given arguments in a seperate
364 or return; 483process, returning the results. Everything must be serialisable with
484Coro::Storable. May, of course, block. Note that the executed sub may
485never block itself or use any form of Event handling.
365 486
366 my $value = $cf::RUNTIME + 90 + 10; 487=cut
367 # 10 is the runtime save interval, for a monotonic clock
368 # 60 allows for the watchdog to kill the server.
369 488
370 (aio_write $fh, 0, (length $value), $value, 0) <= 0 489sub fork_call(&@) {
371 and return; 490 my ($cb, @args) = @_;
372 491
373 # always fsync - this file is important 492 # we seemingly have to make a local copy of the whole thing,
374 aio_fsync $fh 493 # otherwise perl prematurely frees the stuff :/
375 and return; 494 # TODO: investigate and fix (likely this will be rather laborious)
376 495
377 close $fh 496 my @res = Coro::Util::fork_eval {
378 or return; 497 reset_signals;
498 &$cb
499 }, @args;
379 500
380 aio_rename "$runtime~", $runtime 501 wantarray ? @res : $res[-1]
381 and return; 502}
382 503
504=item $value = cf::db_get $family => $key
505
506Returns a single value from the environment database.
507
508=item cf::db_put $family => $key => $value
509
510Stores the given C<$value> in the family. It can currently store binary
511data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
512
513=cut
514
515our $DB;
516
517sub db_init {
518 unless ($DB) {
519 $DB = BDB::db_create $DB_ENV;
520
521 cf::sync_job {
522 eval {
523 $DB->set_flags (BDB::CHKSUM);
524
525 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
526 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
527 cf::cleanup "db_open(db): $!" if $!;
528 };
529 cf::cleanup "db_open(db): $@" if $@;
530 };
383 1 531 }
532}
533
534sub db_get($$) {
535 my $key = "$_[0]/$_[1]";
536
537 cf::sync_job {
538 BDB::db_get $DB, undef, $key, my $data;
539
540 $! ? ()
541 : $data
542 }
543}
544
545sub db_put($$$) {
546 BDB::dbreq_pri 4;
547 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
548}
549
550=item cf::cache $id => [$paths...], $processversion => $process
551
552Generic caching function that returns the value of the resource $id,
553caching and regenerating as required.
554
555This function can block.
556
557=cut
558
559sub cache {
560 my ($id, $src, $processversion, $process) = @_;
561
562 my $meta =
563 join "\x00",
564 $processversion,
565 map {
566 aio_stat $_
567 and Carp::croak "$_: $!";
568
569 ($_, (stat _)[7,9])
570 } @$src;
571
572 my $dbmeta = db_get cache => "$id/meta";
573 if ($dbmeta ne $meta) {
574 # changed, we may need to process
575
576 my @data;
577 my $md5;
578
579 for (0 .. $#$src) {
580 0 <= aio_load $src->[$_], $data[$_]
581 or Carp::croak "$src->[$_]: $!";
582 }
583
584 # if processing is expensive, check
585 # checksum first
586 if (1) {
587 $md5 =
588 join "\x00",
589 $processversion,
590 map {
591 cf::cede_to_tick;
592 ($src->[$_], Digest::MD5::md5_hex $data[$_])
593 } 0.. $#$src;
594
595
596 my $dbmd5 = db_get cache => "$id/md5";
597 if ($dbmd5 eq $md5) {
598 db_put cache => "$id/meta", $meta;
599
600 return db_get cache => "$id/data";
601 }
602 }
603
604 my $t1 = Time::HiRes::time;
605 my $data = $process->(\@data);
606 my $t2 = Time::HiRes::time;
607
608 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
609
610 db_put cache => "$id/data", $data;
611 db_put cache => "$id/md5" , $md5;
612 db_put cache => "$id/meta", $meta;
613
614 return $data;
615 }
616
617 db_get cache => "$id/data"
618}
619
620=item cf::datalog type => key => value, ...
621
622Log a datalog packet of the given type with the given key-value pairs.
623
624=cut
625
626sub datalog($@) {
627 my ($type, %kv) = @_;
628 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384} 629}
385 630
386=back 631=back
387 632
388=cut 633=cut
395attach callbacks/event handlers (a collection of which is called an "attachment") 640attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods. 641to it. All such attachable objects support the following methods.
397 642
398In the following description, CLASS can be any of C<global>, C<object> 643In the following description, CLASS can be any of C<global>, C<object>
399C<player>, C<client> or C<map> (i.e. the attachable objects in 644C<player>, C<client> or C<map> (i.e. the attachable objects in
400crossfire+). 645Crossfire TRT).
401 646
402=over 4 647=over 4
403 648
404=item $attachable->attach ($attachment, key => $value...) 649=item $attachable->attach ($attachment, key => $value...)
405 650
568 $registry = $CB_TYPE[$object_type] ||= []; 813 $registry = $CB_TYPE[$object_type] ||= [];
569 814
570 } elsif ($type eq "subtype") { 815 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type"; 816 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg; 817 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 818 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574 819
575 } elsif ($type eq "package") { 820 } elsif ($type eq "package") {
576 my $pkg = shift @arg; 821 my $pkg = shift @arg;
577 822
578 while (my ($name, $id) = each %cb_id) { 823 while (my ($name, $id) = each %cb_id) {
607 _attach $registry, $klass, @attach; 852 _attach $registry, $klass, @attach;
608 } 853 }
609 854
610 $obj->{$name} = \%arg; 855 $obj->{$name} = \%arg;
611 } else { 856 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n"; 857 warn "object uses attachment '$name' which is not available, postponing.\n";
613 } 858 }
614 859
615 $obj->{_attachment}{$name} = undef; 860 $obj->{_attachment}{$name} = undef;
616} 861}
617 862
619 if (ref $_[0]) { 864 if (ref $_[0]) {
620 _object_attach @_; 865 _object_attach @_;
621 } else { 866 } else {
622 _attach shift->_attach_registry, @_; 867 _attach shift->_attach_registry, @_;
623 } 868 }
869 _recalc_want;
624}; 870};
625 871
626# all those should be optimised 872# all those should be optimised
627sub cf::attachable::detach { 873sub cf::attachable::detach {
628 my ($obj, $name) = @_; 874 my ($obj, $name) = @_;
631 delete $obj->{_attachment}{$name}; 877 delete $obj->{_attachment}{$name};
632 reattach ($obj); 878 reattach ($obj);
633 } else { 879 } else {
634 Carp::croak "cannot, currently, detach class attachments"; 880 Carp::croak "cannot, currently, detach class attachments";
635 } 881 }
882 _recalc_want;
636}; 883};
637 884
638sub cf::attachable::attached { 885sub cf::attachable::attached {
639 my ($obj, $name) = @_; 886 my ($obj, $name) = @_;
640 887
655 "; 902 ";
656 die if $@; 903 die if $@;
657} 904}
658 905
659our $override; 906our $override;
660our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 907our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
661 908
662sub override { 909sub override {
663 $override = 1; 910 $override = 1;
664 @invoke_results = (); 911 @INVOKE_RESULTS = (@_);
665} 912}
666 913
667sub do_invoke { 914sub do_invoke {
668 my $event = shift; 915 my $event = shift;
669 my $callbacks = shift; 916 my $callbacks = shift;
670 917
671 @invoke_results = (); 918 @INVOKE_RESULTS = ();
672 919
673 local $override; 920 local $override;
674 921
675 for (@$callbacks) { 922 for (@$callbacks) {
676 eval { &{$_->[1]} }; 923 eval { &{$_->[1]} };
693 940
694Generate an object-specific event with the given arguments. 941Generate an object-specific event with the given arguments.
695 942
696This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 943This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
697removed in future versions), and there is no public API to access override 944removed in future versions), and there is no public API to access override
698results (if you must, access C<@cf::invoke_results> directly). 945results (if you must, access C<@cf::INVOKE_RESULTS> directly).
699 946
700=back 947=back
701 948
702=cut 949=cut
703 950
704############################################################################# 951#############################################################################
705# object support 952# object support
953#
954
955sub _can_merge {
956 my ($ob1, $ob2) = @_;
957
958 local $Storable::canonical = 1;
959 my $fob1 = Storable::freeze $ob1;
960 my $fob2 = Storable::freeze $ob2;
961
962 $fob1 eq $fob2
963}
706 964
707sub reattach { 965sub reattach {
708 # basically do the same as instantiate, without calling instantiate 966 # basically do the same as instantiate, without calling instantiate
709 my ($obj) = @_; 967 my ($obj) = @_;
710 968
754 }, 1012 },
755); 1013);
756 1014
757sub object_freezer_save { 1015sub object_freezer_save {
758 my ($filename, $rdata, $objs) = @_; 1016 my ($filename, $rdata, $objs) = @_;
1017
1018 my $guard = cf::lock_acquire "io";
759 1019
760 sync_job { 1020 sync_job {
761 if (length $$rdata) { 1021 if (length $$rdata) {
762 warn sprintf "saving %s (%d,%d)\n", 1022 warn sprintf "saving %s (%d,%d)\n",
763 $filename, length $$rdata, scalar @$objs; 1023 $filename, length $$rdata, scalar @$objs;
787 } 1047 }
788 } else { 1048 } else {
789 aio_unlink $filename; 1049 aio_unlink $filename;
790 aio_unlink "$filename.pst"; 1050 aio_unlink "$filename.pst";
791 } 1051 }
792
793 #d##TODO# nuke non .map-files if exist
794 if ($filename =~ s/\.map$//) {
795 aio_unlink $filename;
796 aio_unlink "$filename.pst";
797 }
798 } 1052 };
1053
1054 undef $guard;
799} 1055}
800 1056
801sub object_freezer_as_string { 1057sub object_freezer_as_string {
802 my ($rdata, $objs) = @_; 1058 my ($rdata, $objs) = @_;
803 1059
809sub object_thawer_load { 1065sub object_thawer_load {
810 my ($filename) = @_; 1066 my ($filename) = @_;
811 1067
812 my ($data, $av); 1068 my ($data, $av);
813 1069
814 #d#TODO remove .map if file does not exist 1070 my $guard = cf::lock_acquire "io";
815 aio_stat $filename and $filename =~ s/\.map$//;
816 1071
817 (aio_load $filename, $data) >= 0 1072 (aio_load $filename, $data) >= 0
818 or return; 1073 or return;
819 1074
820 unless (aio_stat "$filename.pst") { 1075 unless (aio_stat "$filename.pst") {
821 (aio_load "$filename.pst", $av) >= 0 1076 (aio_load "$filename.pst", $av) >= 0
822 or return; 1077 or return;
1078
1079 undef $guard;
823 $av = eval { (Storable::thaw $av)->{objs} }; 1080 $av = eval { (Storable::thaw $av)->{objs} };
824 } 1081 }
825 1082
826 warn sprintf "loading %s (%d)\n", 1083 warn sprintf "loading %s (%d)\n",
827 $filename, length $data, scalar @{$av || []};#d# 1084 $filename, length $data, scalar @{$av || []};
1085
828 return ($data, $av); 1086 ($data, $av)
829} 1087}
1088
1089=head2 COMMAND CALLBACKS
1090
1091=over 4
1092
1093=cut
830 1094
831############################################################################# 1095#############################################################################
832# command handling &c 1096# command handling &c
833 1097
834=item cf::register_command $name => \&callback($ob,$args); 1098=item cf::register_command $name => \&callback($ob,$args);
847 push @{ $COMMAND{$name} }, [$caller, $cb]; 1111 push @{ $COMMAND{$name} }, [$caller, $cb];
848} 1112}
849 1113
850=item cf::register_extcmd $name => \&callback($pl,$packet); 1114=item cf::register_extcmd $name => \&callback($pl,$packet);
851 1115
852Register a callbackf ro execution when the client sends an extcmd packet. 1116Register a callback for execution when the client sends an (synchronous)
1117extcmd packet. Ext commands will be processed in the order they are
1118received by the server, like other user commands. The first argument is
1119the logged-in player. Ext commands can only be processed after a player
1120has logged in successfully.
853 1121
854If the callback returns something, it is sent back as if reply was being 1122If the callback returns something, it is sent back as if reply was being
855called. 1123called.
856 1124
1125=item cf::register_exticmd $name => \&callback($ns,$packet);
1126
1127Register a callback for execution when the client sends an (asynchronous)
1128exticmd packet. Exti commands are processed by the server as soon as they
1129are received, i.e. out of order w.r.t. other commands. The first argument
1130is a client socket. Exti commands can be received anytime, even before
1131log-in.
1132
1133If the callback returns something, it is sent back as if reply was being
1134called.
1135
857=cut 1136=cut
858 1137
859sub register_extcmd { 1138sub register_extcmd {
860 my ($name, $cb) = @_; 1139 my ($name, $cb) = @_;
861 1140
862 $EXTCMD{$name} = $cb; 1141 $EXTCMD{$name} = $cb;
1142}
1143
1144sub register_exticmd {
1145 my ($name, $cb) = @_;
1146
1147 $EXTICMD{$name} = $cb;
863} 1148}
864 1149
865cf::player->attach ( 1150cf::player->attach (
866 on_command => sub { 1151 on_command => sub {
867 my ($pl, $name, $params) = @_; 1152 my ($pl, $name, $params) = @_;
876 cf::override; 1161 cf::override;
877 }, 1162 },
878 on_extcmd => sub { 1163 on_extcmd => sub {
879 my ($pl, $buf) = @_; 1164 my ($pl, $buf) = @_;
880 1165
881 my $msg = eval { from_json $buf }; 1166 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
882 1167
883 if (ref $msg) { 1168 if (ref $msg) {
1169 my ($type, $reply, @payload) =
1170 "ARRAY" eq ref $msg
1171 ? @$msg
1172 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1173
1174 my @reply;
1175
884 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1176 if (my $cb = $EXTCMD{$type}) {
885 if (my %reply = $cb->($pl, $msg)) { 1177 @reply = $cb->($pl, @payload);
886 $pl->ext_reply ($msg->{msgid}, %reply);
887 }
888 } 1178 }
1179
1180 $pl->ext_reply ($reply, @reply)
1181 if $reply;
1182
889 } else { 1183 } else {
890 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1184 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
891 } 1185 }
892 1186
893 cf::override; 1187 cf::override;
894 }, 1188 },
895); 1189);
896 1190
897sub load_extension {
898 my ($path) = @_;
899
900 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
901 my $base = $1;
902 my $pkg = $1;
903 $pkg =~ s/[^[:word:]]/_/g;
904 $pkg = "ext::$pkg";
905
906 warn "... loading '$path' into '$pkg'\n";
907
908 open my $fh, "<:utf8", $path
909 or die "$path: $!";
910
911 my $source =
912 "package $pkg; use strict; use utf8;\n"
913 . "#line 1 \"$path\"\n{\n"
914 . (do { local $/; <$fh> })
915 . "\n};\n1";
916
917 unless (eval $source) {
918 my $msg = $@ ? "$path: $@\n"
919 : "extension disabled.\n";
920 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
921 warn $@;
922 warn "mandatory extension failed to load, exiting.\n";
923 exit 1;
924 }
925 die $@;
926 }
927
928 push @EXTS, $pkg;
929}
930
931sub load_extensions { 1191sub load_extensions {
1192 cf::sync_job {
1193 my %todo;
1194
932 for my $ext (<$LIBDIR/*.ext>) { 1195 for my $path (<$LIBDIR/*.ext>) {
933 next unless -r $ext; 1196 next unless -r $path;
934 eval { 1197
935 load_extension $ext; 1198 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1199 my $base = $1;
1200 my $pkg = $1;
1201 $pkg =~ s/[^[:word:]]/_/g;
1202 $pkg = "ext::$pkg";
1203
1204 open my $fh, "<:utf8", $path
1205 or die "$path: $!";
1206
1207 my $source = do { local $/; <$fh> };
1208
1209 my %ext = (
1210 path => $path,
1211 base => $base,
1212 pkg => $pkg,
1213 );
1214
1215 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1216 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1217
1218 $ext{source} =
1219 "package $pkg; use strict; use utf8;\n"
1220 . "#line 1 \"$path\"\n{\n"
1221 . $source
1222 . "\n};\n1";
1223
1224 $todo{$base} = \%ext;
1225 }
1226
1227 my %done;
1228 while (%todo) {
1229 my $progress;
1230
1231 while (my ($k, $v) = each %todo) {
1232 for (split /,\s*/, $v->{meta}{depends}) {
1233 goto skip
1234 unless exists $done{$_};
1235 }
1236
1237 warn "... loading '$k' into '$v->{pkg}'\n";
1238
1239 unless (eval $v->{source}) {
1240 my $msg = $@ ? "$v->{path}: $@\n"
1241 : "$v->{base}: extension inactive.\n";
1242
1243 if (exists $v->{meta}{mandatory}) {
1244 warn $msg;
1245 warn "mandatory extension failed to load, exiting.\n";
1246 exit 1;
1247 }
1248
1249 warn $msg;
1250 }
1251
1252 $done{$k} = delete $todo{$k};
1253 push @EXTS, $v->{pkg};
1254 $progress = 1;
936 1 1255 }
937 } or warn "$ext not loaded: $@"; 1256
1257 skip:
1258 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1259 unless $progress;
1260 }
938 } 1261 };
939} 1262}
940 1263
941############################################################################# 1264#############################################################################
942 1265
1266=back
1267
943=head2 CORE EXTENSIONS 1268=head2 CORE EXTENSIONS
944 1269
945Functions and methods that extend core crossfire objects. 1270Functions and methods that extend core crossfire objects.
946 1271
947=cut 1272=cut
959Returns the given player object, loading it if necessary (might block). 1284Returns the given player object, loading it if necessary (might block).
960 1285
961=cut 1286=cut
962 1287
963sub playerdir($) { 1288sub playerdir($) {
964 cf::localdir 1289 "$PLAYERDIR/"
965 . "/"
966 . cf::playerdir
967 . "/"
968 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1290 . (ref $_[0] ? $_[0]->ob->name : $_[0])
969} 1291}
970 1292
971sub path($) { 1293sub path($) {
972 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1294 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
973 1295
974 (playerdir $login) . "/$login.pl" 1296 (playerdir $login) . "/playerdata"
975} 1297}
976 1298
977sub find_active($) { 1299sub find_active($) {
978 $cf::PLAYER{$_[0]} 1300 $cf::PLAYER{$_[0]}
979 and $cf::PLAYER{$_[0]}->active 1301 and $cf::PLAYER{$_[0]}->active
992 my $login = $_[0]; 1314 my $login = $_[0];
993 1315
994 my $guard = cf::lock_acquire "user_find:$login"; 1316 my $guard = cf::lock_acquire "user_find:$login";
995 1317
996 $cf::PLAYER{$_[0]} || do { 1318 $cf::PLAYER{$_[0]} || do {
997 my $pl = load_pl path $login 1319 # rename old playerfiles to new ones
1320 #TODO: remove when no longer required
1321 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1322 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1323 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1324 aio_unlink +(playerdir $login) . "/$login.pl";
1325
1326 my $f = new_from_file cf::object::thawer path $login
998 or return; 1327 or return;
1328
1329 $f->next;
1330 my $pl = cf::player::load_pl $f
1331 or return;
1332 local $cf::PLAYER_LOADING{$login} = $pl;
1333 $f->resolve_delayed_derefs;
999 $cf::PLAYER{$login} = $pl 1334 $cf::PLAYER{$login} = $pl
1000 } 1335 }
1001 } 1336 }
1002} 1337}
1003 1338
1013 1348
1014 aio_mkdir playerdir $pl, 0770; 1349 aio_mkdir playerdir $pl, 0770;
1015 $pl->{last_save} = $cf::RUNTIME; 1350 $pl->{last_save} = $cf::RUNTIME;
1016 1351
1017 $pl->save_pl ($path); 1352 $pl->save_pl ($path);
1018 Coro::cede; 1353 cf::cede_to_tick;
1019} 1354}
1020 1355
1021sub new($) { 1356sub new($) {
1022 my ($login) = @_; 1357 my ($login) = @_;
1023 1358
1029 $cf::PLAYER{$login} = $self; 1364 $cf::PLAYER{$login} = $self;
1030 1365
1031 $self 1366 $self
1032} 1367}
1033 1368
1369=item $player->send_msg ($channel, $msg, $color, [extra...])
1370
1371=cut
1372
1373sub send_msg {
1374 my $ns = shift->ns
1375 or return;
1376 $ns->send_msg (@_);
1377}
1378
1034=item $pl->quit_character 1379=item $pl->quit_character
1035 1380
1036Nukes the player without looking back. If logged in, the connection will 1381Nukes the player without looking back. If logged in, the connection will
1037be destroyed. May block for a long time. 1382be destroyed. May block for a long time.
1038 1383
1039=cut 1384=cut
1040 1385
1041sub quit_character { 1386sub quit_character {
1042 my ($pl) = @_; 1387 my ($pl) = @_;
1388
1389 my $name = $pl->ob->name;
1043 1390
1044 $pl->{deny_save} = 1; 1391 $pl->{deny_save} = 1;
1045 $pl->password ("*"); # this should lock out the player until we nuked the dir 1392 $pl->password ("*"); # this should lock out the player until we nuked the dir
1046 1393
1047 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1394 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1052 my $path = playerdir $pl; 1399 my $path = playerdir $pl;
1053 my $temp = "$path~$cf::RUNTIME~deleting~"; 1400 my $temp = "$path~$cf::RUNTIME~deleting~";
1054 aio_rename $path, $temp; 1401 aio_rename $path, $temp;
1055 delete $cf::PLAYER{$pl->ob->name}; 1402 delete $cf::PLAYER{$pl->ob->name};
1056 $pl->destroy; 1403 $pl->destroy;
1404
1405 my $prefix = qr<^~\Q$name\E/>;
1406
1407 # nuke player maps
1408 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1409
1057 IO::AIO::aio_rmtree $temp; 1410 IO::AIO::aio_rmtree $temp;
1411}
1412
1413=item $pl->kick
1414
1415Kicks a player out of the game. This destroys the connection.
1416
1417=cut
1418
1419sub kick {
1420 my ($pl, $kicker) = @_;
1421
1422 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1423 $pl->killer ("kicked");
1424 $pl->ns->destroy;
1058} 1425}
1059 1426
1060=item cf::player::list_logins 1427=item cf::player::list_logins
1061 1428
1062Returns am arrayref of all valid playernames in the system, can take a 1429Returns am arrayref of all valid playernames in the system, can take a
1063while and may block, so not sync_job-capable, ever. 1430while and may block, so not sync_job-capable, ever.
1064 1431
1065=cut 1432=cut
1066 1433
1067sub list_logins { 1434sub list_logins {
1068 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1435 my $dirs = aio_readdir $PLAYERDIR
1069 or return []; 1436 or return [];
1070 1437
1071 my @logins; 1438 my @logins;
1072 1439
1073 for my $login (@$dirs) { 1440 for my $login (@$dirs) {
1441 my $path = path $login;
1442
1443 # a .pst is a dead give-away for a valid player
1444 unless (-e "$path.pst") {
1074 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1445 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1075 aio_read $fh, 0, 512, my $buf, 0 or next; 1446 aio_read $fh, 0, 512, my $buf, 0 or next;
1076 $buf !~ /^password -------------$/m or next; # official not-valid tag 1447 $buf !~ /^password -------------$/m or next; # official not-valid tag
1448 }
1077 1449
1078 utf8::decode $login; 1450 utf8::decode $login;
1079 push @logins, $login; 1451 push @logins, $login;
1080 } 1452 }
1081 1453
1108 } 1480 }
1109 1481
1110 \@paths 1482 \@paths
1111} 1483}
1112 1484
1485=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1486
1487Expand crossfire pod fragments into protocol xml.
1488
1489=cut
1490
1491sub expand_cfpod {
1492 ((my $self), (local $_)) = @_;
1493
1494 # escape & and <
1495 s/&/&amp;/g;
1496 s/(?<![BIUGHT])</&lt;/g;
1497
1498 # this is buggy, it needs to properly take care of nested <'s
1499
1500 1 while
1501 # replace B<>, I<>, U<> etc.
1502 s/B<([^\>]*)>/<b>$1<\/b>/
1503 || s/I<([^\>]*)>/<i>$1<\/i>/
1504 || s/U<([^\>]*)>/<u>$1<\/u>/
1505 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1506 # replace G<male|female> tags
1507 || s{G<([^>|]*)\|([^>]*)>}{
1508 $self->gender ? $2 : $1
1509 }ge
1510 # replace H<hint text>
1511 || s{H<([^\>]*)>}
1512 {
1513 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1514 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1515 "")
1516 [$self->{hintmode}]
1517 }ge;
1518
1519 # create single paragraphs (very hackish)
1520 s/(?<=\S)\n(?=\w)/ /g;
1521
1522 # compress some whitespace
1523 s/\s+\n/\n/g; # ws line-ends
1524 s/\n\n+/\n/g; # double lines
1525 s/^\n+//; # beginning lines
1526 s/\n+$//; # ending lines
1527
1528 $_
1529}
1530
1531sub hintmode {
1532 $_[0]{hintmode} = $_[1] if @_ > 1;
1533 $_[0]{hintmode}
1534}
1535
1113=item $player->ext_reply ($msgid, $msgtype, %msg) 1536=item $player->ext_reply ($msgid, @msg)
1114 1537
1115Sends an ext reply to the player. 1538Sends an ext reply to the player.
1116 1539
1117=cut 1540=cut
1118 1541
1119sub ext_reply($$$%) { 1542sub ext_reply($$@) {
1120 my ($self, $id, %msg) = @_; 1543 my ($self, $id, @msg) = @_;
1121 1544
1122 $msg{msgid} = $id; 1545 $self->ns->ext_reply ($id, @msg)
1123
1124 $self->send ("ext " . cf::to_json \%msg);
1125} 1546}
1126 1547
1127package cf; 1548=item $player->ext_msg ($type, @msg)
1549
1550Sends an ext event to the client.
1551
1552=cut
1553
1554sub ext_msg($$@) {
1555 my ($self, $type, @msg) = @_;
1556
1557 $self->ns->ext_msg ($type, @msg);
1558}
1559
1560=head3 cf::region
1561
1562=over 4
1563
1564=cut
1565
1566package cf::region;
1567
1568=item cf::region::find_by_path $path
1569
1570Tries to decuce the likely region for a map knowing only its path.
1571
1572=cut
1573
1574sub find_by_path($) {
1575 my ($path) = @_;
1576
1577 my ($match, $specificity);
1578
1579 for my $region (list) {
1580 if ($region->{match} && $path =~ $region->{match}) {
1581 ($match, $specificity) = ($region, $region->specificity)
1582 if $region->specificity > $specificity;
1583 }
1584 }
1585
1586 $match
1587}
1128 1588
1129=back 1589=back
1130
1131 1590
1132=head3 cf::map 1591=head3 cf::map
1133 1592
1134=over 4 1593=over 4
1135 1594
1190 my ($self, $merge) = @_; 1649 my ($self, $merge) = @_;
1191 1650
1192 # we have to keep some variables in memory intact 1651 # we have to keep some variables in memory intact
1193 local $self->{path}; 1652 local $self->{path};
1194 local $self->{load_path}; 1653 local $self->{load_path};
1195 local $self->{deny_save};
1196 local $self->{deny_reset};
1197 1654
1198 $self->SUPER::thawer_merge ($merge); 1655 $self->SUPER::thawer_merge ($merge);
1199} 1656}
1200 1657
1201sub normalise { 1658sub normalise {
1248 $self->init; # pass $1 etc. 1705 $self->init; # pass $1 etc.
1249 return $self; 1706 return $self;
1250 } 1707 }
1251 } 1708 }
1252 1709
1253 Carp::carp "unable to resolve path '$path' (base '$base')."; 1710 Carp::cluck "unable to resolve path '$path' (base '$base').";
1254 () 1711 ()
1255} 1712}
1256 1713
1257sub init { 1714sub init {
1258 my ($self) = @_; 1715 my ($self) = @_;
1273 1730
1274# the original (read-only) location 1731# the original (read-only) location
1275sub load_path { 1732sub load_path {
1276 my ($self) = @_; 1733 my ($self) = @_;
1277 1734
1278 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1735 "$MAPDIR/$self->{path}.map"
1279} 1736}
1280 1737
1281# the temporary/swap location 1738# the temporary/swap location
1282sub save_path { 1739sub save_path {
1283 my ($self) = @_; 1740 my ($self) = @_;
1284 1741
1285 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1742 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1286 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1743 "$TMPDIR/$path.map"
1287} 1744}
1288 1745
1289# the unique path, undef == no special unique path 1746# the unique path, undef == no special unique path
1290sub uniq_path { 1747sub uniq_path {
1291 my ($self) = @_; 1748 my ($self) = @_;
1292 1749
1293 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1750 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1294 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1751 "$UNIQUEDIR/$path"
1295} 1752}
1296 1753
1297# and all this just because we cannot iterate over 1754# and all this just because we cannot iterate over
1298# all maps in C++... 1755# all maps in C++...
1299sub change_all_map_light { 1756sub change_all_map_light {
1301 1758
1302 $_->change_map_light ($change) 1759 $_->change_map_light ($change)
1303 for grep $_->outdoor, values %cf::MAP; 1760 for grep $_->outdoor, values %cf::MAP;
1304} 1761}
1305 1762
1763sub decay_objects {
1764 my ($self) = @_;
1765
1766 return if $self->{deny_reset};
1767
1768 $self->do_decay_objects;
1769}
1770
1306sub unlink_save { 1771sub unlink_save {
1307 my ($self) = @_; 1772 my ($self) = @_;
1308 1773
1309 utf8::encode (my $save = $self->save_path); 1774 utf8::encode (my $save = $self->save_path);
1310 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1775 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1311 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1776 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1312
1313 #d#TODO remove .map and also nuke
1314 $save =~ s/\.map// or return;#d#
1315 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1316 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1317} 1777}
1318 1778
1319sub load_header_from($) { 1779sub load_header_from($) {
1320 my ($self, $path) = @_; 1780 my ($self, $path) = @_;
1321 1781
1322 utf8::encode $path; 1782 utf8::encode $path;
1323 #aio_open $path, O_RDONLY, 0 1783 my $f = new_from_file cf::object::thawer $path
1324 # or return;
1325
1326 $self->_load_header ($path)
1327 or return; 1784 or return;
1785
1786 $self->_load_header ($f)
1787 or return;
1788
1789 local $MAP_LOADING{$self->{path}} = $self;
1790 $f->resolve_delayed_derefs;
1328 1791
1329 $self->{load_path} = $path; 1792 $self->{load_path} = $path;
1330 1793
1331 1 1794 1
1332} 1795}
1371 $self->load_header_orig 1834 $self->load_header_orig
1372 or return; 1835 or return;
1373 $self->prepare_orig; 1836 $self->prepare_orig;
1374 } 1837 }
1375 1838
1839 $self->{deny_reset} = 1
1840 if $self->no_reset;
1841
1842 $self->default_region (cf::region::find_by_path $self->{path})
1843 unless $self->default_region;
1844
1376 1 1845 1
1377} 1846}
1378 1847
1379sub find; 1848sub find;
1380sub find { 1849sub find {
1381 my ($path, $origin) = @_; 1850 my ($path, $origin) = @_;
1382 1851
1383 $path = normalise $path, $origin && $origin->path; 1852 $path = normalise $path, $origin && $origin->path;
1384 1853
1854 cf::lock_wait "map_data:$path";#d#remove
1385 cf::lock_wait "map_find:$path"; 1855 cf::lock_wait "map_find:$path";
1386 1856
1387 $cf::MAP{$path} || do { 1857 $cf::MAP{$path} || do {
1388 my $guard = cf::lock_acquire "map_find:$path"; 1858 my $guard1 = cf::lock_acquire "map_find:$path";
1859 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1860
1389 my $map = new_from_path cf::map $path 1861 my $map = new_from_path cf::map $path
1390 or return; 1862 or return;
1391 1863
1392 $map->{last_save} = $cf::RUNTIME; 1864 $map->{last_save} = $cf::RUNTIME;
1393 1865
1394 $map->load_header 1866 $map->load_header
1395 or return; 1867 or return;
1396 1868
1397 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1869 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1398 # doing this can freeze the server in a sync job, obviously 1870 # doing this can freeze the server in a sync job, obviously
1399 #$cf::WAIT_FOR_TICK->wait; 1871 #$cf::WAIT_FOR_TICK->wait;
1872 undef $guard1;
1873 undef $guard2;
1400 $map->reset; 1874 $map->reset;
1401 undef $guard;
1402 return find $path; 1875 return find $path;
1403 } 1876 }
1404 1877
1405 $cf::MAP{$path} = $map 1878 $cf::MAP{$path} = $map
1406 } 1879 }
1413 my ($self) = @_; 1886 my ($self) = @_;
1414 1887
1415 local $self->{deny_reset} = 1; # loading can take a long time 1888 local $self->{deny_reset} = 1; # loading can take a long time
1416 1889
1417 my $path = $self->{path}; 1890 my $path = $self->{path};
1891
1892 {
1418 my $guard = cf::lock_acquire "map_load:$path"; 1893 my $guard = cf::lock_acquire "map_data:$path";
1419 1894
1895 return unless $self->valid;
1420 return if $self->in_memory != cf::MAP_SWAPPED; 1896 return if $self->in_memory != cf::MAP_SWAPPED;
1421 1897
1422 $self->in_memory (cf::MAP_LOADING); 1898 $self->in_memory (cf::MAP_LOADING);
1423 1899
1424 $self->alloc; 1900 $self->alloc;
1425 1901
1426 $self->pre_load; 1902 $self->pre_load;
1903 cf::cede_to_tick;
1427 1904
1428 $self->_load_objects ($self->{load_path}, 1) 1905 my $f = new_from_file cf::object::thawer $self->{load_path};
1906 $f->skip_block;
1907 $self->_load_objects ($f)
1429 or return; 1908 or return;
1430 1909
1431 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1910 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1432 if delete $self->{load_original}; 1911 if delete $self->{load_original};
1433 1912
1434 if (my $uniq = $self->uniq_path) { 1913 if (my $uniq = $self->uniq_path) {
1435 utf8::encode $uniq; 1914 utf8::encode $uniq;
1436 if (aio_open $uniq, O_RDONLY, 0) { 1915 unless (aio_stat $uniq) {
1916 if (my $f = new_from_file cf::object::thawer $uniq) {
1437 $self->clear_unique_items; 1917 $self->clear_unique_items;
1438 $self->_load_objects ($uniq, 0); 1918 $self->_load_objects ($f);
1919 $f->resolve_delayed_derefs;
1920 }
1439 } 1921 }
1440 } 1922 }
1441 1923
1442 Coro::cede; 1924 $f->resolve_delayed_derefs;
1443 1925
1926 cf::cede_to_tick;
1444 # now do the right thing for maps 1927 # now do the right thing for maps
1445 $self->link_multipart_objects; 1928 $self->link_multipart_objects;
1446
1447 unless ($self->{deny_activate}) {
1448 $self->decay_objects;
1449 $self->fix_auto_apply;
1450 $self->update_buttons;
1451 Coro::cede;
1452 $self->set_darkness_map;
1453 $self->difficulty ($self->estimate_difficulty) 1929 $self->difficulty ($self->estimate_difficulty)
1454 unless $self->difficulty; 1930 unless $self->difficulty;
1455 Coro::cede; 1931 cf::cede_to_tick;
1932
1933 unless ($self->{deny_activate}) {
1934 $self->decay_objects;
1935 $self->fix_auto_apply;
1936 $self->update_buttons;
1937 cf::cede_to_tick;
1938 $self->set_darkness_map;
1939 cf::cede_to_tick;
1456 $self->activate; 1940 $self->activate;
1941 }
1942
1943 $self->{last_save} = $cf::RUNTIME;
1944 $self->last_access ($cf::RUNTIME);
1945
1946 $self->in_memory (cf::MAP_IN_MEMORY);
1457 } 1947 }
1458 1948
1459 $self->post_load; 1949 $self->post_load;
1460
1461 $self->in_memory (cf::MAP_IN_MEMORY);
1462} 1950}
1463 1951
1464sub customise_for { 1952sub customise_for {
1465 my ($self, $ob) = @_; 1953 my ($self, $ob) = @_;
1466 1954
1467 return find "~" . $ob->name . "/" . $self->{path} 1955 return find "~" . $ob->name . "/" . $self->{path}
1468 if $self->per_player; 1956 if $self->per_player;
1469 1957
1958# return find "?party/" . $ob->name . "/" . $self->{path}
1959# if $self->per_party;
1960
1470 $self 1961 $self
1471} 1962}
1472 1963
1473# find and load all maps in the 3x3 area around a map 1964# find and load all maps in the 3x3 area around a map
1474sub load_diag { 1965sub load_neighbours {
1475 my ($map) = @_; 1966 my ($map) = @_;
1476 1967
1477 my @diag; # diagonal neighbours 1968 my @neigh; # diagonal neighbours
1478 1969
1479 for (0 .. 3) { 1970 for (0 .. 3) {
1480 my $neigh = $map->tile_path ($_) 1971 my $neigh = $map->tile_path ($_)
1481 or next; 1972 or next;
1482 $neigh = find $neigh, $map 1973 $neigh = find $neigh, $map
1483 or next; 1974 or next;
1484 $neigh->load; 1975 $neigh->load;
1485 1976
1977 push @neigh,
1486 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1978 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1487 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1979 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1488 } 1980 }
1489 1981
1490 for (@diag) { 1982 for (grep defined $_->[0], @neigh) {
1983 my ($path, $origin) = @$_;
1491 my $neigh = find @$_ 1984 my $neigh = find $path, $origin
1492 or next; 1985 or next;
1493 $neigh->load; 1986 $neigh->load;
1494 } 1987 }
1495} 1988}
1496 1989
1501} 1994}
1502 1995
1503sub do_load_sync { 1996sub do_load_sync {
1504 my ($map) = @_; 1997 my ($map) = @_;
1505 1998
1999 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2000 if $Coro::current == $Coro::main;
2001
1506 cf::sync_job { $map->load }; 2002 cf::sync_job { $map->load };
1507} 2003}
1508 2004
1509our %MAP_PREFETCH; 2005our %MAP_PREFETCH;
1510our $MAP_PREFETCHER = undef; 2006our $MAP_PREFETCHER = undef;
1511 2007
1512sub find_async { 2008sub find_async {
1513 my ($path, $origin) = @_; 2009 my ($path, $origin, $load) = @_;
1514 2010
1515 $path = normalise $path, $origin && $origin->{path}; 2011 $path = normalise $path, $origin && $origin->{path};
1516 2012
1517 if (my $map = $cf::MAP{$path}) { 2013 if (my $map = $cf::MAP{$path}) {
1518 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2014 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1519 } 2015 }
1520 2016
1521 undef $MAP_PREFETCH{$path}; 2017 $MAP_PREFETCH{$path} |= $load;
2018
1522 $MAP_PREFETCHER ||= cf::async { 2019 $MAP_PREFETCHER ||= cf::async {
1523 while (%MAP_PREFETCH) { 2020 while (%MAP_PREFETCH) {
1524 for my $path (keys %MAP_PREFETCH) { 2021 while (my ($k, $v) = each %MAP_PREFETCH) {
1525 my $map = find $path 2022 if (my $map = find $k) {
1526 or next;
1527 $map->load; 2023 $map->load if $v;
2024 }
1528 2025
1529 delete $MAP_PREFETCH{$path}; 2026 delete $MAP_PREFETCH{$k};
1530 } 2027 }
1531 } 2028 }
1532 undef $MAP_PREFETCHER; 2029 undef $MAP_PREFETCHER;
1533 }; 2030 };
1534 $MAP_PREFETCHER->prio (6); 2031 $MAP_PREFETCHER->prio (6);
1537} 2034}
1538 2035
1539sub save { 2036sub save {
1540 my ($self) = @_; 2037 my ($self) = @_;
1541 2038
1542 my $lock = cf::lock_acquire "map_data:" . $self->path; 2039 my $lock = cf::lock_acquire "map_data:$self->{path}";
1543 2040
1544 $self->{last_save} = $cf::RUNTIME; 2041 $self->{last_save} = $cf::RUNTIME;
1545 2042
1546 return unless $self->dirty; 2043 return unless $self->dirty;
1547 2044
1570 my ($self) = @_; 2067 my ($self) = @_;
1571 2068
1572 # save first because save cedes 2069 # save first because save cedes
1573 $self->save; 2070 $self->save;
1574 2071
1575 my $lock = cf::lock_acquire "map_data:" . $self->path; 2072 my $lock = cf::lock_acquire "map_data:$self->{path}";
1576 2073
1577 return if $self->players; 2074 return if $self->players;
1578 return if $self->in_memory != cf::MAP_IN_MEMORY; 2075 return if $self->in_memory != cf::MAP_IN_MEMORY;
1579 return if $self->{deny_save}; 2076 return if $self->{deny_save};
1580 2077
2078 $self->deactivate;
1581 $self->clear; 2079 $self->clear;
1582 $self->in_memory (cf::MAP_SWAPPED); 2080 $self->in_memory (cf::MAP_SWAPPED);
1583} 2081}
1584 2082
1585sub reset_at { 2083sub reset_at {
1586 my ($self) = @_; 2084 my ($self) = @_;
1587 2085
1588 # TODO: safety, remove and allow resettable per-player maps 2086 # TODO: safety, remove and allow resettable per-player maps
1589 return 1e99 if $self->isa ("ext::map_per_player");#d#
1590 return 1e99 if $self->{deny_reset}; 2087 return 1e99 if $self->{deny_reset};
1591 2088
1592 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2089 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1593 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2090 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1594 2091
1605 my ($self) = @_; 2102 my ($self) = @_;
1606 2103
1607 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2104 my $lock = cf::lock_acquire "map_data:$self->{path}";
1608 2105
1609 return if $self->players; 2106 return if $self->players;
1610 return if $self->isa ("ext::map_per_player");#d#
1611 2107
1612 warn "resetting map ", $self->path;#d# 2108 warn "resetting map ", $self->path;
1613 2109
1614 $self->in_memory (cf::MAP_SWAPPED); 2110 $self->in_memory (cf::MAP_SWAPPED);
1615 2111
1616 # need to save uniques path 2112 # need to save uniques path
1617 unless ($self->{deny_save}) { 2113 unless ($self->{deny_save}) {
1621 if $uniq; 2117 if $uniq;
1622 } 2118 }
1623 2119
1624 delete $cf::MAP{$self->path}; 2120 delete $cf::MAP{$self->path};
1625 2121
2122 $self->deactivate;
1626 $self->clear; 2123 $self->clear;
1627 2124
1628 $_->clear_links_to ($self) for values %cf::MAP; 2125 $_->clear_links_to ($self) for values %cf::MAP;
1629 2126
1630 $self->unlink_save; 2127 $self->unlink_save;
1634my $nuke_counter = "aaaa"; 2131my $nuke_counter = "aaaa";
1635 2132
1636sub nuke { 2133sub nuke {
1637 my ($self) = @_; 2134 my ($self) = @_;
1638 2135
2136 {
2137 my $lock = cf::lock_acquire "map_data:$self->{path}";
2138
1639 delete $cf::MAP{$self->path}; 2139 delete $cf::MAP{$self->path};
1640 2140
1641 $self->unlink_save; 2141 $self->unlink_save;
1642 2142
1643 bless $self, "cf::map"; 2143 bless $self, "cf::map";
1644 delete $self->{deny_reset}; 2144 delete $self->{deny_reset};
1645 $self->{deny_save} = 1; 2145 $self->{deny_save} = 1;
1646 $self->reset_timeout (1); 2146 $self->reset_timeout (1);
1647 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2147 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1648 2148
1649 $cf::MAP{$self->path} = $self; 2149 $cf::MAP{$self->path} = $self;
2150 }
1650 2151
1651 $self->reset; # polite request, might not happen 2152 $self->reset; # polite request, might not happen
2153}
2154
2155=item $maps = cf::map::tmp_maps
2156
2157Returns an arrayref with all map paths of currently instantiated and saved
2158maps. May block.
2159
2160=cut
2161
2162sub tmp_maps() {
2163 [
2164 map {
2165 utf8::decode $_;
2166 /\.map$/
2167 ? normalise $_
2168 : ()
2169 } @{ aio_readdir $TMPDIR or [] }
2170 ]
2171}
2172
2173=item $maps = cf::map::random_maps
2174
2175Returns an arrayref with all map paths of currently instantiated and saved
2176random maps. May block.
2177
2178=cut
2179
2180sub random_maps() {
2181 [
2182 map {
2183 utf8::decode $_;
2184 /\.map$/
2185 ? normalise "?random/$_"
2186 : ()
2187 } @{ aio_readdir $RANDOMDIR or [] }
2188 ]
1652} 2189}
1653 2190
1654=item cf::map::unique_maps 2191=item cf::map::unique_maps
1655 2192
1656Returns an arrayref of paths of all shared maps that have 2193Returns an arrayref of paths of all shared maps that have
1657instantiated unique items. May block. 2194instantiated unique items. May block.
1658 2195
1659=cut 2196=cut
1660 2197
1661sub unique_maps() { 2198sub unique_maps() {
1662 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2199 [
1663 or return; 2200 map {
1664
1665 my @paths;
1666
1667 for (@$files) {
1668 utf8::decode $_; 2201 utf8::decode $_;
1669 next if /\.pst$/; 2202 /\.map$/
1670 next unless /^$PATH_SEP/o; 2203 ? normalise $_
1671 2204 : ()
1672 push @paths, cf::map::normalise $_; 2205 } @{ aio_readdir $UNIQUEDIR or [] }
1673 } 2206 ]
1674
1675 \@paths
1676} 2207}
1677 2208
1678package cf; 2209package cf;
1679 2210
1680=back 2211=back
1698 map { $_, inv_recursive_ $_->inv } @_ 2229 map { $_, inv_recursive_ $_->inv } @_
1699} 2230}
1700 2231
1701sub inv_recursive { 2232sub inv_recursive {
1702 inv_recursive_ inv $_[0] 2233 inv_recursive_ inv $_[0]
2234}
2235
2236=item $ref = $ob->ref
2237
2238creates and returns a persistent reference to an objetc that can be stored as a string.
2239
2240=item $ob = cf::object::deref ($refstring)
2241
2242returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2243even if the object actually exists. May block.
2244
2245=cut
2246
2247sub deref {
2248 my ($ref) = @_;
2249
2250 # temporary compatibility#TODO#remove
2251 $ref =~ s{^<}{player/<};
2252
2253 if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
2254 my ($uuid, $name) = ($1, $2);
2255 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2256 or return;
2257 $pl->ob->uuid eq $uuid
2258 or return;
2259
2260 $pl->ob
2261 } else {
2262 warn "$ref: cannot resolve object reference\n";
2263 undef
2264 }
1703} 2265}
1704 2266
1705package cf; 2267package cf;
1706 2268
1707=back 2269=back
1726 2288
1727 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2289 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1728 2290
1729 if ($self->{record_replies}) { 2291 if ($self->{record_replies}) {
1730 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2292 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2293
1731 } else { 2294 } else {
2295 my $pl = $self->contr;
2296
2297 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2298 my $dialog = $pl->{npc_dialog};
2299 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2300
2301 } else {
1732 $msg = $npc->name . " says: $msg" if $npc; 2302 $msg = $npc->name . " says: $msg" if $npc;
1733 $self->message ($msg, $flags); 2303 $self->message ($msg, $flags);
2304 }
1734 } 2305 }
2306}
2307
2308=item $object->send_msg ($channel, $msg, $color, [extra...])
2309
2310=cut
2311
2312sub cf::object::send_msg {
2313 my $pl = shift->contr
2314 or return;
2315 $pl->send_msg (@_);
1735} 2316}
1736 2317
1737=item $player_object->may ("access") 2318=item $player_object->may ("access")
1738 2319
1739Returns wether the given player is authorized to access resource "access" 2320Returns wether the given player is authorized to access resource "access"
1786 $self->deactivate_recursive; 2367 $self->deactivate_recursive;
1787 2368
1788 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2369 return if UNIVERSAL::isa $self->map, "ext::map_link";
1789 2370
1790 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2371 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1791 if $self->map; 2372 if $self->map && $self->map->{path} ne "{link}";
1792 2373
1793 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2374 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1794} 2375}
1795 2376
1796sub cf::object::player::leave_link { 2377sub cf::object::player::leave_link {
1797 my ($self, $map, $x, $y) = @_; 2378 my ($self, $map, $x, $y) = @_;
2379
2380 return unless $self->contr->active;
1798 2381
1799 my $link_pos = delete $self->{_link_pos}; 2382 my $link_pos = delete $self->{_link_pos};
1800 2383
1801 unless ($map) { 2384 unless ($map) {
1802 # restore original map position 2385 # restore original map position
1816 # use -1 or undef as default coordinates, not 0, 0 2399 # use -1 or undef as default coordinates, not 0, 0
1817 ($x, $y) = ($map->enter_x, $map->enter_y) 2400 ($x, $y) = ($map->enter_x, $map->enter_y)
1818 if $x <=0 && $y <= 0; 2401 if $x <=0 && $y <= 0;
1819 2402
1820 $map->load; 2403 $map->load;
1821 $map->load_diag; 2404 $map->load_neighbours;
1822 2405
1823 return unless $self->contr->active; 2406 return unless $self->contr->active;
1824 $self->activate_recursive; 2407 $self->activate_recursive;
2408
2409 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1825 $self->enter_map ($map, $x, $y); 2410 $self->enter_map ($map, $x, $y);
1826} 2411}
1827 2412
1828cf::player->attach ( 2413=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1829 on_logout => sub {
1830 my ($pl) = @_;
1831 2414
1832 # abort map switching before logout 2415Moves the player to the given map-path and coordinates by first freezing
1833 if ($pl->ob->{_link_pos}) { 2416her, loading and preparing them map, calling the provided $check callback
1834 cf::sync_job { 2417that has to return the map if sucecssful, and then unfreezes the player on
1835 $pl->ob->leave_link 2418the new (success) or old (failed) map position. In either case, $done will
1836 }; 2419be called at the end of this process.
1837 }
1838 },
1839 on_login => sub {
1840 my ($pl) = @_;
1841 2420
1842 # try to abort aborted map switching on player login :)
1843 # should happen only on crashes
1844 if ($pl->ob->{_link_pos}) {
1845 $pl->ob->enter_link;
1846 (async {
1847 # we need this sleep as the login has a concurrent enter_exit running
1848 # and this sleep increases chances of the player not ending up in scorn
1849 $pl->ob->reply (undef,
1850 "There was an internal problem at your last logout, "
1851 . "the server will try to bring you to your intended destination in a second.",
1852 cf::NDI_RED);
1853 Coro::Timer::sleep 1;
1854 $pl->ob->leave_link;
1855 })->prio (2);
1856 }
1857 },
1858);
1859
1860=item $player_object->goto ($path, $x, $y)
1861
1862=cut 2421=cut
2422
2423our $GOTOGEN;
1863 2424
1864sub cf::object::player::goto { 2425sub cf::object::player::goto {
1865 my ($self, $path, $x, $y) = @_; 2426 my ($self, $path, $x, $y, $check, $done) = @_;
2427
2428 # do generation counting so two concurrent goto's will be executed in-order
2429 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1866 2430
1867 $self->enter_link; 2431 $self->enter_link;
1868 2432
1869 (async { 2433 (async {
1870 my $map = eval { 2434 my $map = eval {
1871 my $map = cf::map::find $path; 2435 my $map = cf::map::find $path;
2436
2437 if ($map) {
1872 $map = $map->customise_for ($self) if $map; 2438 $map = $map->customise_for ($self);
2439 $map = $check->($map) if $check && $map;
2440 } else {
2441 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2442 }
2443
1873 $map 2444 $map
2445 };
2446
2447 if ($@) {
2448 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2449 LOG llevError | logBacktrace, Carp::longmess $@;
1874 } or 2450 }
1875 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1876 2451
2452 if ($gen == $self->{_goto_generation}) {
2453 delete $self->{_goto_generation};
1877 $self->leave_link ($map, $x, $y); 2454 $self->leave_link ($map, $x, $y);
2455 }
2456
2457 $done->() if $done;
1878 })->prio (1); 2458 })->prio (1);
1879} 2459}
1880 2460
1881=item $player_object->enter_exit ($exit_object) 2461=item $player_object->enter_exit ($exit_object)
1882 2462
1921 2501
1922 $rmp->{random_seed} ||= $exit->random_seed; 2502 $rmp->{random_seed} ||= $exit->random_seed;
1923 2503
1924 my $data = cf::to_json $rmp; 2504 my $data = cf::to_json $rmp;
1925 my $md5 = Digest::MD5::md5_hex $data; 2505 my $md5 = Digest::MD5::md5_hex $data;
1926 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2506 my $meta = "$RANDOMDIR/$md5.meta";
1927 2507
1928 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2508 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1929 aio_write $fh, 0, (length $data), $data, 0; 2509 aio_write $fh, 0, (length $data), $data, 0;
1930 undef $fh; 2510 undef $fh;
1931 aio_rename "$meta~", $meta; 2511 aio_rename "$meta~", $meta;
1940 2520
1941 return unless $self->type == cf::PLAYER; 2521 return unless $self->type == cf::PLAYER;
1942 2522
1943 if ($exit->slaying eq "/!") { 2523 if ($exit->slaying eq "/!") {
1944 #TODO: this should de-fi-ni-te-ly not be a sync-job 2524 #TODO: this should de-fi-ni-te-ly not be a sync-job
2525 # the problem is that $exit might not survive long enough
2526 # so it needs to be done right now, right here
1945 cf::sync_job { prepare_random_map $exit }; 2527 cf::sync_job { prepare_random_map $exit };
1946 } 2528 }
1947 2529
1948 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2530 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1949 my $hp = $exit->stats->hp; 2531 my $hp = $exit->stats->hp;
1950 my $sp = $exit->stats->sp; 2532 my $sp = $exit->stats->sp;
1951 2533
1952 $self->enter_link; 2534 $self->enter_link;
2535
2536 # if exit is damned, update players death & WoR home-position
2537 $self->contr->savebed ($slaying, $hp, $sp)
2538 if $exit->flag (FLAG_DAMNED);
1953 2539
1954 (async { 2540 (async {
1955 $self->deactivate_recursive; # just to be sure 2541 $self->deactivate_recursive; # just to be sure
1956 unless (eval { 2542 unless (eval {
1957 $self->goto ($slaying, $hp, $sp); 2543 $self->goto ($slaying, $hp, $sp);
1958 2544
1959 1; 2545 1;
1960 }) { 2546 }) {
1961 $self->message ("Something went wrong deep within the crossfire server. " 2547 $self->message ("Something went wrong deep within the crossfire server. "
1962 . "I'll try to bring you back to the map you were before. " 2548 . "I'll try to bring you back to the map you were before. "
1963 . "Please report this to the dungeon master!", 2549 . "Please report this to the dungeon master!",
1964 cf::NDI_UNIQUE | cf::NDI_RED); 2550 cf::NDI_UNIQUE | cf::NDI_RED);
1965 2551
1966 warn "ERROR in enter_exit: $@"; 2552 warn "ERROR in enter_exit: $@";
1967 $self->leave_link; 2553 $self->leave_link;
1968 } 2554 }
1969 })->prio (1); 2555 })->prio (1);
1982 2568
1983sub cf::client::send_drawinfo { 2569sub cf::client::send_drawinfo {
1984 my ($self, $text, $flags) = @_; 2570 my ($self, $text, $flags) = @_;
1985 2571
1986 utf8::encode $text; 2572 utf8::encode $text;
1987 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2573 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1988} 2574}
1989 2575
2576=item $client->send_msg ($channel, $msg, $color, [extra...])
2577
2578Send a drawinfo or msg packet to the client, formatting the msg for the
2579client if neccessary. C<$type> should be a string identifying the type of
2580the message, with C<log> being the default. If C<$color> is negative, suppress
2581the message unless the client supports the msg packet.
2582
2583=cut
2584
2585our %CHANNEL = (
2586 "c/identify" => {
2587 id => "identify",
2588 title => "Identify",
2589 reply => undef,
2590 tooltip => "Items recently identified",
2591 },
2592 "c/examine" => {
2593 id => "examine",
2594 title => "Examine",
2595 reply => undef,
2596 tooltip => "Signs and other items you examined",
2597 },
2598);
2599
2600sub cf::client::send_msg {
2601 my ($self, $channel, $msg, $color, @extra) = @_;
2602
2603 $msg = $self->pl->expand_cfpod ($msg);
2604
2605 $color &= cf::NDI_CLIENT_MASK; # just in case...
2606
2607 # check predefined channels, for the benefit of C
2608 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2609
2610 if (ref $channel) {
2611 # send meta info to client, if not yet sent
2612 unless (exists $self->{channel}{$channel->{id}}) {
2613 $self->{channel}{$channel->{id}} = $channel;
2614 $self->ext_msg (channel_info => $channel)
2615 if $self->can_msg;
2616 }
2617
2618 $channel = $channel->{id};
2619 }
2620
2621 return unless @extra || length $msg;
2622
2623 if ($self->can_msg) {
2624 # default colour, mask it out
2625 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2626 if $color & cf::NDI_DEF;
2627
2628 $self->send_packet ("msg " . $self->{json_coder}->encode (
2629 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2630 } else {
2631 if ($color >= 0) {
2632 # replace some tags by gcfclient-compatible ones
2633 for ($msg) {
2634 1 while
2635 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2636 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2637 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2638 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2639 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2640 }
2641
2642 $color &= cf::NDI_COLOR_MASK;
2643
2644 utf8::encode $msg;
2645
2646 if (0 && $msg =~ /\[/) {
2647 # COMMAND/INFO
2648 $self->send_packet ("drawextinfo $color 10 8 $msg")
2649 } else {
2650 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2651 $self->send_packet ("drawinfo $color $msg")
2652 }
2653 }
2654 }
2655}
2656
2657=item $client->ext_msg ($type, @msg)
2658
2659Sends an ext event to the client.
2660
2661=cut
2662
2663sub cf::client::ext_msg($$@) {
2664 my ($self, $type, @msg) = @_;
2665
2666 if ($self->extcmd == 2) {
2667 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2668 } elsif ($self->extcmd == 1) { # TODO: remove
2669 push @msg, msgtype => "event_$type";
2670 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2671 }
2672}
2673
2674=item $client->ext_reply ($msgid, @msg)
2675
2676Sends an ext reply to the client.
2677
2678=cut
2679
2680sub cf::client::ext_reply($$@) {
2681 my ($self, $id, @msg) = @_;
2682
2683 if ($self->extcmd == 2) {
2684 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2685 } elsif ($self->extcmd == 1) {
2686 #TODO: version 1, remove
2687 unshift @msg, msgtype => "reply", msgid => $id;
2688 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2689 }
2690}
1990 2691
1991=item $success = $client->query ($flags, "text", \&cb) 2692=item $success = $client->query ($flags, "text", \&cb)
1992 2693
1993Queues a query to the client, calling the given callback with 2694Queues a query to the client, calling the given callback with
1994the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2695the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1995C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2696C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1996 2697
1997Queries can fail, so check the return code. Or don't, as queries will become 2698Queries can fail, so check the return code. Or don't, as queries will
1998reliable at some point in the future. 2699become reliable at some point in the future.
1999 2700
2000=cut 2701=cut
2001 2702
2002sub cf::client::query { 2703sub cf::client::query {
2003 my ($self, $flags, $text, $cb) = @_; 2704 my ($self, $flags, $text, $cb) = @_;
2011 utf8::encode $text; 2712 utf8::encode $text;
2012 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2713 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2013 2714
2014 $self->send_packet ($self->{query_queue}[0][0]) 2715 $self->send_packet ($self->{query_queue}[0][0])
2015 if @{ $self->{query_queue} } == 1; 2716 if @{ $self->{query_queue} } == 1;
2717
2718 1
2016} 2719}
2017 2720
2018cf::client->attach ( 2721cf::client->attach (
2722 on_connect => sub {
2723 my ($ns) = @_;
2724
2725 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2726 },
2019 on_reply => sub { 2727 on_reply => sub {
2020 my ($ns, $msg) = @_; 2728 my ($ns, $msg) = @_;
2021 2729
2022 # this weird shuffling is so that direct followup queries 2730 # this weird shuffling is so that direct followup queries
2023 # get handled first 2731 # get handled first
2035 } else { 2743 } else {
2036 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2744 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2037 } 2745 }
2038 } 2746 }
2039 }, 2747 },
2748 on_exticmd => sub {
2749 my ($ns, $buf) = @_;
2750
2751 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2752
2753 if (ref $msg) {
2754 my ($type, $reply, @payload) =
2755 "ARRAY" eq ref $msg
2756 ? @$msg
2757 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2758
2759 my @reply;
2760
2761 if (my $cb = $EXTICMD{$type}) {
2762 @reply = $cb->($ns, @payload);
2763 }
2764
2765 $ns->ext_reply ($reply, @reply)
2766 if $reply;
2767
2768 } else {
2769 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2770 }
2771
2772 cf::override;
2773 },
2040); 2774);
2041 2775
2042=item $client->async (\&cb) 2776=item $client->async (\&cb)
2043 2777
2044Create a new coroutine, running the specified callback. The coroutine will 2778Create a new coroutine, running the specified callback. The coroutine will
2085our $safe = new Safe "safe"; 2819our $safe = new Safe "safe";
2086our $safe_hole = new Safe::Hole; 2820our $safe_hole = new Safe::Hole;
2087 2821
2088$SIG{FPE} = 'IGNORE'; 2822$SIG{FPE} = 'IGNORE';
2089 2823
2090$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2824$safe->permit_only (Opcode::opset qw(
2825 :base_core :base_mem :base_orig :base_math
2826 grepstart grepwhile mapstart mapwhile
2827 sort time
2828));
2091 2829
2092# here we export the classes and methods available to script code 2830# here we export the classes and methods available to script code
2093 2831
2094=pod 2832=pod
2095 2833
2096The following fucntions and emthods are available within a safe environment: 2834The following functions and methods are available within a safe environment:
2097 2835
2098 cf::object contr pay_amount pay_player map 2836 cf::object
2837 contr pay_amount pay_player map x y force_find force_add
2838 insert remove name archname title slaying race decrease_ob_nr
2839
2099 cf::object::player player 2840 cf::object::player
2100 cf::player peaceful 2841 player
2101 cf::map trigger 2842
2843 cf::player
2844 peaceful
2845
2846 cf::map
2847 trigger
2102 2848
2103=cut 2849=cut
2104 2850
2105for ( 2851for (
2106 ["cf::object" => qw(contr pay_amount pay_player map)], 2852 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2853 insert remove inv name archname title slaying race
2854 decrease_ob_nr)],
2107 ["cf::object::player" => qw(player)], 2855 ["cf::object::player" => qw(player)],
2108 ["cf::player" => qw(peaceful)], 2856 ["cf::player" => qw(peaceful)],
2109 ["cf::map" => qw(trigger)], 2857 ["cf::map" => qw(trigger)],
2110) { 2858) {
2111 no strict 'refs'; 2859 no strict 'refs';
2182=back 2930=back
2183 2931
2184=cut 2932=cut
2185 2933
2186############################################################################# 2934#############################################################################
2187
2188=head2 EXTENSION DATABASE SUPPORT
2189
2190Crossfire maintains a very simple database for extension use. It can
2191currently store anything that can be serialised using Storable, which
2192excludes objects.
2193
2194The parameter C<$family> should best start with the name of the extension
2195using it, it should be unique.
2196
2197=over 4
2198
2199=item $value = cf::db_get $family => $key
2200
2201Returns a single value from the database.
2202
2203=item cf::db_put $family => $key => $value
2204
2205Stores the given C<$value> in the family.
2206
2207=cut
2208
2209our $DB;
2210
2211sub db_init {
2212 unless ($DB) {
2213 $DB = BDB::db_create $DB_ENV;
2214
2215 cf::sync_job {
2216 eval {
2217 $DB->set_flags (BDB::CHKSUM);
2218
2219 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2220 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2221 cf::cleanup "db_open(db): $!" if $!;
2222 };
2223 cf::cleanup "db_open(db): $@" if $@;
2224 };
2225
2226 my $path = cf::localdir . "/database.pst";
2227 if (stat $path) {
2228 cf::sync_job {
2229 my $pst = Storable::retrieve $path;
2230
2231 cf::db_put (board => data => $pst->{board});
2232 cf::db_put (guildrules => data => $pst->{guildrules});
2233 cf::db_put (rent => balance => $pst->{rent}{balance});
2234 BDB::db_env_txn_checkpoint $DB_ENV;
2235
2236 unlink $path;
2237 };
2238 }
2239 }
2240}
2241
2242sub db_get($$) {
2243 my $key = "$_[0]/$_[1]";
2244
2245 cf::sync_job {
2246 BDB::db_get $DB, undef, $key, my $data;
2247
2248 $! ? ()
2249 : Compress::LZF::sthaw $data
2250 }
2251}
2252
2253sub db_put($$$) {
2254 BDB::dbreq_pri 4;
2255 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2256}
2257
2258#############################################################################
2259# the server's init and main functions 2935# the server's init and main functions
2260 2936
2261sub load_resources { 2937sub load_facedata($) {
2262 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2938 my ($path) = @_;
2939
2940 # HACK to clear player env face cache, we need some signal framework
2941 # for this (global event?)
2942 %ext::player_env::MUSIC_FACE_CACHE = ();
2943
2944 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2945
2946 warn "loading facedata from $path\n";
2947
2948 my $facedata;
2949 0 < aio_load $path, $facedata
2950 or die "$path: $!";
2951
2952 $facedata = Coro::Storable::thaw $facedata;
2953
2954 $facedata->{version} == 2
2955 or cf::cleanup "$path: version mismatch, cannot proceed.";
2956
2957 # patch in the exptable
2958 $facedata->{resource}{"res/exp_table"} = {
2959 type => FT_RSRC,
2960 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2961 };
2962 cf::cede_to_tick;
2963
2964 {
2965 my $faces = $facedata->{faceinfo};
2966
2967 while (my ($face, $info) = each %$faces) {
2968 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2969 cf::face::set_visibility $idx, $info->{visibility};
2970 cf::face::set_magicmap $idx, $info->{magicmap};
2971 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2972 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2973
2974 cf::cede_to_tick;
2975 }
2976
2977 while (my ($face, $info) = each %$faces) {
2978 next unless $info->{smooth};
2979 my $idx = cf::face::find $face
2980 or next;
2981 if (my $smooth = cf::face::find $info->{smooth}) {
2982 cf::face::set_smooth $idx, $smooth;
2983 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2984 } else {
2985 warn "smooth face '$info->{smooth}' not found for face '$face'";
2986 }
2987
2988 cf::cede_to_tick;
2989 }
2990 }
2991
2992 {
2993 my $anims = $facedata->{animinfo};
2994
2995 while (my ($anim, $info) = each %$anims) {
2996 cf::anim::set $anim, $info->{frames}, $info->{facings};
2997 cf::cede_to_tick;
2998 }
2999
3000 cf::anim::invalidate_all; # d'oh
3001 }
3002
3003 {
3004 # TODO: for gcfclient pleasure, we should give resources
3005 # that gcfclient doesn't grok a >10000 face index.
3006 my $res = $facedata->{resource};
3007
3008 my $soundconf = delete $res->{"res/sound.conf"};
3009
3010 while (my ($name, $info) = each %$res) {
3011 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3012 my $data;
3013
3014 if ($info->{type} & 1) {
3015 # prepend meta info
3016
3017 my $meta = $enc->encode ({
3018 name => $name,
3019 %{ $info->{meta} || {} },
3020 });
3021
3022 $data = pack "(w/a*)*", $meta, $info->{data};
3023 } else {
3024 $data = $info->{data};
3025 }
3026
3027 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3028 cf::face::set_type $idx, $info->{type};
3029
3030 cf::cede_to_tick;
3031 }
3032
3033 if ($soundconf) {
3034 $soundconf = $enc->decode (delete $soundconf->{data});
3035
3036 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3037 my $sound = $soundconf->{compat}[$_]
3038 or next;
3039
3040 my $face = cf::face::find "sound/$sound->[1]";
3041 cf::sound::set $sound->[0] => $face;
3042 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3043 }
3044
3045 while (my ($k, $v) = each %{$soundconf->{event}}) {
3046 my $face = cf::face::find "sound/$v";
3047 cf::sound::set $k => $face;
3048 }
3049 }
3050 }
3051
3052 1
3053}
3054
3055register_exticmd fx_want => sub {
3056 my ($ns, $want) = @_;
3057
3058 while (my ($k, $v) = each %$want) {
3059 $ns->fx_want ($k, $v);
3060 }
3061};
3062
3063sub reload_regions {
3064 # HACK to clear player env face cache, we need some signal framework
3065 # for this (global event?)
3066 %ext::player_env::MUSIC_FACE_CACHE = ();
3067
3068 load_resource_file "$MAPDIR/regions"
2263 or die "unable to load regions file\n";#d# 3069 or die "unable to load regions file\n";
2264}
2265 3070
2266sub cfg_load { 3071 for (cf::region::list) {
3072 $_->{match} = qr/$_->{match}/
3073 if exists $_->{match};
3074 }
3075}
3076
3077sub reload_facedata {
3078 load_facedata "$DATADIR/facedata"
3079 or die "unable to load facedata\n";
3080}
3081
3082sub reload_archetypes {
3083 load_resource_file "$DATADIR/archetypes"
3084 or die "unable to load archetypes\n";
3085 #d# NEED to laod twice to resolve forward references
3086 # this really needs to be done in an extra post-pass
3087 # (which needs to be synchronous, so solve it differently)
3088 load_resource_file "$DATADIR/archetypes"
3089 or die "unable to load archetypes\n";
3090}
3091
3092sub reload_treasures {
3093 load_resource_file "$DATADIR/treasures"
3094 or die "unable to load treasurelists\n";
3095}
3096
3097sub reload_resources {
3098 warn "reloading resource files...\n";
3099
3100 reload_regions;
3101 reload_facedata;
3102 #reload_archetypes;#d#
3103 reload_archetypes;
3104 reload_treasures;
3105
3106 warn "finished reloading resource files\n";
3107}
3108
3109sub init {
3110 reload_resources;
3111}
3112
3113sub reload_config {
2267 open my $fh, "<:utf8", cf::confdir . "/config" 3114 open my $fh, "<:utf8", "$CONFDIR/config"
2268 or return; 3115 or return;
2269 3116
2270 local $/; 3117 local $/;
2271 *CFG = YAML::Syck::Load <$fh>; 3118 *CFG = YAML::Syck::Load <$fh>;
2272 3119
2280 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3127 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2281 and die "WARNING: m(un)lockall failed: $!\n"; 3128 and die "WARNING: m(un)lockall failed: $!\n";
2282 }; 3129 };
2283 warn $@ if $@; 3130 warn $@ if $@;
2284 } 3131 }
2285}
2286
2287sub init {
2288 load_resources;
2289} 3132}
2290 3133
2291sub main { 3134sub main {
2292 # we must not ever block the main coroutine 3135 # we must not ever block the main coroutine
2293 local $Coro::idle = sub { 3136 local $Coro::idle = sub {
2295 (async { 3138 (async {
2296 Event::one_event; 3139 Event::one_event;
2297 })->prio (Coro::PRIO_MAX); 3140 })->prio (Coro::PRIO_MAX);
2298 }; 3141 };
2299 3142
2300 cfg_load; 3143 reload_config;
2301 db_init; 3144 db_init;
2302 load_extensions; 3145 load_extensions;
2303 3146
2304 $TICK_WATCHER->start; 3147 $TICK_WATCHER->start;
2305 $WRITE_RUNTIME_WATCHER->start;
2306 Event::loop; 3148 Event::loop;
2307} 3149}
2308 3150
2309############################################################################# 3151#############################################################################
2310# initialisation and cleanup 3152# initialisation and cleanup
2322 }, 3164 },
2323 ); 3165 );
2324 } 3166 }
2325} 3167}
2326 3168
3169sub write_runtime {
3170 my $runtime = "$LOCALDIR/runtime";
3171
3172 # first touch the runtime file to show we are still running:
3173 # the fsync below can take a very very long time.
3174
3175 IO::AIO::aio_utime $runtime, undef, undef;
3176
3177 my $guard = cf::lock_acquire "write_runtime";
3178
3179 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3180 or return;
3181
3182 my $value = $cf::RUNTIME + 90 + 10;
3183 # 10 is the runtime save interval, for a monotonic clock
3184 # 60 allows for the watchdog to kill the server.
3185
3186 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3187 and return;
3188
3189 # always fsync - this file is important
3190 aio_fsync $fh
3191 and return;
3192
3193 # touch it again to show we are up-to-date
3194 aio_utime $fh, undef, undef;
3195
3196 close $fh
3197 or return;
3198
3199 aio_rename "$runtime~", $runtime
3200 and return;
3201
3202 warn "runtime file written.\n";
3203
3204 1
3205}
3206
2327sub emergency_save() { 3207sub emergency_save() {
2328 my $freeze_guard = cf::freeze_mainloop; 3208 my $freeze_guard = cf::freeze_mainloop;
2329 3209
2330 warn "enter emergency perl save\n"; 3210 warn "enter emergency perl save\n";
2331 3211
2362 3242
2363 warn Carp::longmess "post_cleanup backtrace" 3243 warn Carp::longmess "post_cleanup backtrace"
2364 if $make_core; 3244 if $make_core;
2365} 3245}
2366 3246
2367sub reload() { 3247sub do_reload_perl() {
2368 # can/must only be called in main 3248 # can/must only be called in main
2369 if ($Coro::current != $Coro::main) { 3249 if ($Coro::current != $Coro::main) {
2370 warn "can only reload from main coroutine"; 3250 warn "can only reload from main coroutine";
2371 return; 3251 return;
2372 } 3252 }
2374 warn "reloading..."; 3254 warn "reloading...";
2375 3255
2376 warn "entering sync_job"; 3256 warn "entering sync_job";
2377 3257
2378 cf::sync_job { 3258 cf::sync_job {
2379 cf::write_runtime; 3259 cf::write_runtime; # external watchdog should not bark
2380 cf::emergency_save; 3260 cf::emergency_save;
2381 cf::write_runtime; 3261 cf::write_runtime; # external watchdog should not bark
2382 3262
2383 warn "syncing database to disk"; 3263 warn "syncing database to disk";
2384 BDB::db_env_txn_checkpoint $DB_ENV; 3264 BDB::db_env_txn_checkpoint $DB_ENV;
2385 3265
2386 # if anything goes wrong in here, we should simply crash as we already saved 3266 # if anything goes wrong in here, we should simply crash as we already saved
2397 Coro::cede; 3277 Coro::cede;
2398 last unless IO::AIO::nreqs || BDB::nreqs; 3278 last unless IO::AIO::nreqs || BDB::nreqs;
2399 warn "iterate..."; 3279 warn "iterate...";
2400 } 3280 }
2401 3281
3282 ++$RELOAD;
3283
2402 warn "cancelling all extension coros"; 3284 warn "cancelling all extension coros";
2403 $_->cancel for values %EXT_CORO; 3285 $_->cancel for values %EXT_CORO;
2404 %EXT_CORO = (); 3286 %EXT_CORO = ();
2405 3287
2406 warn "removing commands"; 3288 warn "removing commands";
2407 %COMMAND = (); 3289 %COMMAND = ();
2408 3290
2409 warn "removing ext commands"; 3291 warn "removing ext/exti commands";
2410 %EXTCMD = (); 3292 %EXTCMD = ();
3293 %EXTICMD = ();
2411 3294
2412 warn "unloading/nuking all extensions"; 3295 warn "unloading/nuking all extensions";
2413 for my $pkg (@EXTS) { 3296 for my $pkg (@EXTS) {
2414 warn "... unloading $pkg"; 3297 warn "... unloading $pkg";
2415 3298
2445 Symbol::delete_package "safe::$_" 3328 Symbol::delete_package "safe::$_"
2446 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3329 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2447 3330
2448 warn "unloading cf.pm \"a bit\""; 3331 warn "unloading cf.pm \"a bit\"";
2449 delete $INC{"cf.pm"}; 3332 delete $INC{"cf.pm"};
3333 delete $INC{"cf/pod.pm"};
2450 3334
2451 # don't, removes xs symbols, too, 3335 # don't, removes xs symbols, too,
2452 # and global variables created in xs 3336 # and global variables created in xs
2453 #Symbol::delete_package __PACKAGE__; 3337 #Symbol::delete_package __PACKAGE__;
2454 3338
2457 warn "reloading cf.pm"; 3341 warn "reloading cf.pm";
2458 require cf; 3342 require cf;
2459 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3343 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2460 3344
2461 warn "loading config and database again"; 3345 warn "loading config and database again";
2462 cf::cfg_load; 3346 cf::reload_config;
2463 3347
2464 warn "loading extensions"; 3348 warn "loading extensions";
2465 cf::load_extensions; 3349 cf::load_extensions;
2466 3350
2467 warn "reattaching attachments to objects/players"; 3351 warn "reattaching attachments to objects/players";
2468 _global_reattach; 3352 _global_reattach; # objects, sockets
2469 warn "reattaching attachments to maps"; 3353 warn "reattaching attachments to maps";
2470 reattach $_ for values %MAP; 3354 reattach $_ for values %MAP;
2471 3355 warn "reattaching attachments to players";
2472 warn "loading reloadable resources"; 3356 reattach $_ for values %PLAYER;
2473 load_resources;
2474 3357
2475 warn "leaving sync_job"; 3358 warn "leaving sync_job";
2476 3359
2477 1 3360 1
2478 } or do { 3361 } or do {
2484 warn "reloaded"; 3367 warn "reloaded";
2485}; 3368};
2486 3369
2487our $RELOAD_WATCHER; # used only during reload 3370our $RELOAD_WATCHER; # used only during reload
2488 3371
3372sub reload_perl() {
3373 # doing reload synchronously and two reloads happen back-to-back,
3374 # coro crashes during coro_state_free->destroy here.
3375
3376 $RELOAD_WATCHER ||= Event->timer (
3377 reentrant => 0,
3378 after => 0,
3379 data => WF_AUTOCANCEL,
3380 cb => sub {
3381 do_reload_perl;
3382 undef $RELOAD_WATCHER;
3383 },
3384 );
3385}
3386
2489register_command "reload" => sub { 3387register_command "reload" => sub {
2490 my ($who, $arg) = @_; 3388 my ($who, $arg) = @_;
2491 3389
2492 if ($who->flag (FLAG_WIZ)) { 3390 if ($who->flag (FLAG_WIZ)) {
2493 $who->message ("reloading server."); 3391 $who->message ("reloading server.");
2494 3392 async { reload_perl };
2495 # doing reload synchronously and two reloads happen back-to-back,
2496 # coro crashes during coro_state_free->destroy here.
2497
2498 $RELOAD_WATCHER ||= Event->timer (
2499 reentrant => 0,
2500 after => 0,
2501 data => WF_AUTOCANCEL,
2502 cb => sub {
2503 reload;
2504 undef $RELOAD_WATCHER;
2505 },
2506 );
2507 } 3393 }
2508}; 3394};
2509 3395
2510unshift @INC, $LIBDIR; 3396unshift @INC, $LIBDIR;
2511 3397
2512my $bug_warning = 0; 3398my $bug_warning = 0;
2513 3399
3400our @WAIT_FOR_TICK;
3401our @WAIT_FOR_TICK_BEGIN;
3402
3403sub wait_for_tick {
3404 return unless $TICK_WATCHER->is_active;
3405 return if $Coro::current == $Coro::main;
3406
3407 my $signal = new Coro::Signal;
3408 push @WAIT_FOR_TICK, $signal;
3409 $signal->wait;
3410}
3411
3412sub wait_for_tick_begin {
3413 return unless $TICK_WATCHER->is_active;
3414 return if $Coro::current == $Coro::main;
3415
3416 my $signal = new Coro::Signal;
3417 push @WAIT_FOR_TICK_BEGIN, $signal;
3418 $signal->wait;
3419}
3420
3421 my $min = 1e6;#d#
3422 my $avg = 10;
2514$TICK_WATCHER = Event->timer ( 3423$TICK_WATCHER = Event->timer (
2515 reentrant => 0, 3424 reentrant => 0,
2516 parked => 1, 3425 parked => 1,
2517 prio => 0, 3426 prio => 0,
2518 at => $NEXT_TICK || $TICK, 3427 at => $NEXT_TICK || $TICK,
2522 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3431 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2523 unless ++$bug_warning > 10; 3432 unless ++$bug_warning > 10;
2524 return; 3433 return;
2525 } 3434 }
2526 3435
2527 $NOW = Event::time; 3436 $NOW = $tick_start = Event::time;
2528 3437
2529 cf::server_tick; # one server iteration 3438 cf::server_tick; # one server iteration
3439
3440 0 && sync_job {#d#
3441 for(1..10) {
3442 my $t = Event::time;
3443 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3444 or die;
3445
3446 $map->width (50);
3447 $map->height (50);
3448 $map->alloc;
3449 $map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
3450 my $t = Event::time - $t;
3451
3452 #next unless $t < 0.0013;#d#
3453 if ($t < $min) {
3454 $min = $t;
3455 }
3456 $avg = $avg * 0.99 + $t * 0.01;
3457 }
3458 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3459 exit 0;
3460 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3461 };
3462
2530 $RUNTIME += $TICK; 3463 $RUNTIME += $TICK;
2531 $NEXT_TICK += $TICK; 3464 $NEXT_TICK += $TICK;
2532 3465
2533 $WAIT_FOR_TICK->broadcast; 3466 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2534 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3467 $NEXT_RUNTIME_WRITE = $NOW + 10;
3468 Coro::async_pool {
3469 write_runtime
3470 or warn "ERROR: unable to write runtime file: $!";
3471 };
3472 }
2535 3473
2536# my $AFTER = Event::time; 3474# my $AFTER = Event::time;
2537# warn $AFTER - $NOW;#d# 3475# warn $AFTER - $NOW;#d#
2538 3476
3477 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3478 $sig->send;
3479 }
3480 while (my $sig = shift @WAIT_FOR_TICK) {
3481 $sig->send;
3482 }
3483
3484 $NOW = Event::time;
3485
2539 # if we are delayed by four ticks or more, skip them all 3486 # if we are delayed by four ticks or more, skip them all
2540 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3487 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2541 3488
2542 $TICK_WATCHER->at ($NEXT_TICK); 3489 $TICK_WATCHER->at ($NEXT_TICK);
2543 $TICK_WATCHER->start; 3490 $TICK_WATCHER->start;
3491
3492 $LOAD = ($NOW - $tick_start) / $TICK;
3493 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3494
3495 _post_tick;
3496
3497
2544 }, 3498 },
2545); 3499);
2546 3500
2547{ 3501{
2548 BDB::max_poll_time $TICK * 0.1; 3502 BDB::max_poll_time $TICK * 0.1;
2576 3530
2577 cf::sync_job { 3531 cf::sync_job {
2578 eval { 3532 eval {
2579 BDB::db_env_open 3533 BDB::db_env_open
2580 $DB_ENV, 3534 $DB_ENV,
2581 $BDB_ENV_DIR, 3535 $BDBDIR,
2582 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3536 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2583 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3537 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2584 0666; 3538 0666;
2585 3539
2586 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3540 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2587 3541
2588 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3542 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2589 $DB_ENV->set_lk_detect; 3543 $DB_ENV->set_lk_detect;
2590 }; 3544 };
2591 3545
2599 3553
2600 undef $Coro::AIO::WATCHER; 3554 undef $Coro::AIO::WATCHER;
2601 IO::AIO::max_poll_time $TICK * 0.1; 3555 IO::AIO::max_poll_time $TICK * 0.1;
2602 $AIO_POLL_WATCHER = Event->io ( 3556 $AIO_POLL_WATCHER = Event->io (
2603 reentrant => 0, 3557 reentrant => 0,
3558 data => WF_AUTOCANCEL,
2604 fd => IO::AIO::poll_fileno, 3559 fd => IO::AIO::poll_fileno,
2605 poll => 'r', 3560 poll => 'r',
2606 prio => 6, 3561 prio => 6,
2607 data => WF_AUTOCANCEL,
2608 cb => \&IO::AIO::poll_cb, 3562 cb => \&IO::AIO::poll_cb,
2609 ); 3563 );
2610} 3564}
2611 3565
2612$WRITE_RUNTIME_WATCHER = Event->timer ( 3566my $_log_backtrace;
2613 reentrant => 0,
2614 data => WF_AUTOCANCEL,
2615 parked => 1,
2616 after => 1,
2617 interval => 10,
2618 prio => 6, # keep it lowest so it acts like a watchdog
2619 cb => sub {
2620 $TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
2621 3567
2622 Coro::async_pool { 3568sub _log_backtrace {
2623 write_runtime 3569 my ($msg, @addr) = @_;
2624 or warn "ERROR: unable to write runtime file: $!"; 3570
3571 $msg =~ s/\n//;
3572
3573 # limit the # of concurrent backtraces
3574 if ($_log_backtrace < 2) {
3575 ++$_log_backtrace;
3576 async {
3577 my @bt = fork_call {
3578 @addr = map { sprintf "%x", $_ } @addr;
3579 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3580 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3581 or die "addr2line: $!";
3582
3583 my @funcs;
3584 my @res = <$fh>;
3585 chomp for @res;
3586 while (@res) {
3587 my ($func, $line) = splice @res, 0, 2, ();
3588 push @funcs, "[$func] $line";
3589 }
3590
3591 @funcs
3592 };
3593
3594 LOG llevInfo, "[ABT] $msg\n";
3595 LOG llevInfo, "[ABT] $_\n" for @bt;
3596 --$_log_backtrace;
2625 }; 3597 };
3598 } else {
3599 LOG llevInfo, "[ABT] $msg\n";
3600 LOG llevInfo, "[ABT] [suppressed]\n";
2626 }, 3601 }
2627); 3602}
3603
3604# load additional modules
3605use cf::pod;
2628 3606
2629END { cf::emergency_save } 3607END { cf::emergency_save }
2630 3608
26311 36091
2632 3610

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines