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.221 by pippijn, Fri Mar 2 13:32:52 2007 UTC vs.
Revision 1.361 by root, Sun Sep 9 12:52:48 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 $NEXT_RUNTIME_WRITE; # when should the runtime file be written 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55our $NEXT_TICK; 80our $NEXT_TICK;
56our $NOW; 81our $NOW;
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 }
321}
322
323sub lock_active($) {
324 my ($key) = @_;
325
326 ! ! $LOCK{$key}
271} 327}
272 328
273sub freeze_mainloop { 329sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active; 330 return unless $TICK_WATCHER->is_active;
275 331
278 }; 334 };
279 $TICK_WATCHER->stop; 335 $TICK_WATCHER->stop;
280 $guard 336 $guard
281} 337}
282 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;
393}
394
283=item cf::async { BLOCK } 395=item cf::async { BLOCK }
284 396
285Currently the same as Coro::async_pool, meaning you cannot use 397Currently the same as Coro::async_pool, meaning you cannot use
286C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 398C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
287thing you are allowed to do is call C<prio> on it. 399thing you are allowed to do is call C<prio> on it.
290 402
291BEGIN { *async = \&Coro::async_pool } 403BEGIN { *async = \&Coro::async_pool }
292 404
293=item cf::sync_job { BLOCK } 405=item cf::sync_job { BLOCK }
294 406
295The design of crossfire+ requires that the main coro ($Coro::main) is 407The design of Crossfire TRT requires that the main coroutine ($Coro::main)
296always able to handle events or runnable, as crossfire+ is only partly 408is always able to handle events or runnable, as Crossfire TRT is only
297reentrant. 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.
298 411
299If 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
300the given BLOCK in another coroutine while waiting for the result. The 413the given BLOCK in another coroutine while waiting for the result. The
301server 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
302fast or be very important. 415fast or be very important.
305 418
306sub sync_job(&) { 419sub sync_job(&) {
307 my ($job) = @_; 420 my ($job) = @_;
308 421
309 if ($Coro::current == $Coro::main) { 422 if ($Coro::current == $Coro::main) {
423 my $time = Event::time;
424
310 # this is the main coro, too bad, we have to block 425 # this is the main coro, too bad, we have to block
311 # till the operation succeeds, freezing the server :/ 426 # till the operation succeeds, freezing the server :/
312 427
313 # TODO: use suspend/resume instead 428 # TODO: use suspend/resume instead
314 # (but this is cancel-safe) 429 # (but this is cancel-safe)
325 440
326 while ($busy) { 441 while ($busy) {
327 Coro::cede or Event::one_event; 442 Coro::cede or Event::one_event;
328 } 443 }
329 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
330 wantarray ? @res : $res[0] 452 wantarray ? @res : $res[0]
331 } else { 453 } else {
332 # we are in another coroutine, how wonderful, everything just works 454 # we are in another coroutine, how wonderful, everything just works
333 455
334 $job->() 456 $job->()
353 $EXT_CORO{$coro+0} = $coro; 475 $EXT_CORO{$coro+0} = $coro;
354 476
355 $coro 477 $coro
356} 478}
357 479
358sub write_runtime { 480=item fork_call { }, $args
359 my $guard = cf::lock_acquire "write_runtime";
360 481
361 my $runtime = cf::localdir . "/runtime"; 482Executes the given code block with the given arguments in a seperate
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.
362 486
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 487=cut
364 or return;
365 488
366 my $value = $cf::RUNTIME + 90 + 10; 489sub fork_call(&@) {
367 # 10 is the runtime save interval, for a monotonic clock 490 my ($cb, @args) = @_;
368 # 60 allows for the watchdog to kill the server.
369 491
370 (aio_write $fh, 0, (length $value), $value, 0) <= 0 492 # we seemingly have to make a local copy of the whole thing,
371 and return; 493 # otherwise perl prematurely frees the stuff :/
494 # TODO: investigate and fix (likely this will be rather laborious)
372 495
373 # always fsync - this file is important 496 my @res = Coro::Util::fork_eval {
374 aio_fsync $fh 497 reset_signals;
375 and return; 498 &$cb
499 }, @args;
376 500
377 close $fh 501 wantarray ? @res : $res[-1]
378 or return; 502}
379 503
380 aio_rename "$runtime~", $runtime 504=item $value = cf::db_get $family => $key
381 and return;
382 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 } 1052 };
1053
1054 undef $guard;
793} 1055}
794 1056
795sub object_freezer_as_string { 1057sub object_freezer_as_string {
796 my ($rdata, $objs) = @_; 1058 my ($rdata, $objs) = @_;
797 1059
802 1064
803sub object_thawer_load { 1065sub object_thawer_load {
804 my ($filename) = @_; 1066 my ($filename) = @_;
805 1067
806 my ($data, $av); 1068 my ($data, $av);
1069
1070 my $guard = cf::lock_acquire "io";
807 1071
808 (aio_load $filename, $data) >= 0 1072 (aio_load $filename, $data) >= 0
809 or return; 1073 or return;
810 1074
811 unless (aio_stat "$filename.pst") { 1075 unless (aio_stat "$filename.pst") {
812 (aio_load "$filename.pst", $av) >= 0 1076 (aio_load "$filename.pst", $av) >= 0
813 or return; 1077 or return;
1078
1079 undef $guard;
814 $av = eval { (Storable::thaw $av)->{objs} }; 1080 $av = eval { (Storable::thaw $av)->{objs} };
815 } 1081 }
816 1082
817 warn sprintf "loading %s (%d)\n", 1083 warn sprintf "loading %s (%d)\n",
818 $filename, length $data, scalar @{$av || []};#d# 1084 $filename, length $data, scalar @{$av || []};
1085
819 return ($data, $av); 1086 ($data, $av)
820} 1087}
1088
1089=head2 COMMAND CALLBACKS
1090
1091=over 4
1092
1093=cut
821 1094
822############################################################################# 1095#############################################################################
823# command handling &c 1096# command handling &c
824 1097
825=item cf::register_command $name => \&callback($ob,$args); 1098=item cf::register_command $name => \&callback($ob,$args);
838 push @{ $COMMAND{$name} }, [$caller, $cb]; 1111 push @{ $COMMAND{$name} }, [$caller, $cb];
839} 1112}
840 1113
841=item cf::register_extcmd $name => \&callback($pl,$packet); 1114=item cf::register_extcmd $name => \&callback($pl,$packet);
842 1115
843Register 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.
844 1121
845If 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
846called. 1123called.
847 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
848=cut 1136=cut
849 1137
850sub register_extcmd { 1138sub register_extcmd {
851 my ($name, $cb) = @_; 1139 my ($name, $cb) = @_;
852 1140
853 $EXTCMD{$name} = $cb; 1141 $EXTCMD{$name} = $cb;
1142}
1143
1144sub register_exticmd {
1145 my ($name, $cb) = @_;
1146
1147 $EXTICMD{$name} = $cb;
854} 1148}
855 1149
856cf::player->attach ( 1150cf::player->attach (
857 on_command => sub { 1151 on_command => sub {
858 my ($pl, $name, $params) = @_; 1152 my ($pl, $name, $params) = @_;
867 cf::override; 1161 cf::override;
868 }, 1162 },
869 on_extcmd => sub { 1163 on_extcmd => sub {
870 my ($pl, $buf) = @_; 1164 my ($pl, $buf) = @_;
871 1165
872 my $msg = eval { from_json $buf }; 1166 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873 1167
874 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
875 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1176 if (my $cb = $EXTCMD{$type}) {
876 if (my %reply = $cb->($pl, $msg)) { 1177 @reply = $cb->($pl, @payload);
877 $pl->ext_reply ($msg->{msgid}, %reply);
878 }
879 } 1178 }
1179
1180 $pl->ext_reply ($reply, @reply)
1181 if $reply;
1182
880 } else { 1183 } else {
881 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1184 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
882 } 1185 }
883 1186
884 cf::override; 1187 cf::override;
885 }, 1188 },
886); 1189);
887 1190
888sub load_extension {
889 my ($path) = @_;
890
891 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
892 my $base = $1;
893 my $pkg = $1;
894 $pkg =~ s/[^[:word:]]/_/g;
895 $pkg = "ext::$pkg";
896
897 warn "... loading '$path' into '$pkg'\n";
898
899 open my $fh, "<:utf8", $path
900 or die "$path: $!";
901
902 my $source =
903 "package $pkg; use strict; use utf8;\n"
904 . "#line 1 \"$path\"\n{\n"
905 . (do { local $/; <$fh> })
906 . "\n};\n1";
907
908 unless (eval $source) {
909 my $msg = $@ ? "$path: $@\n"
910 : "extension disabled.\n";
911 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912 warn $@;
913 warn "mandatory extension failed to load, exiting.\n";
914 exit 1;
915 }
916 die $@;
917 }
918
919 push @EXTS, $pkg;
920}
921
922sub load_extensions { 1191sub load_extensions {
1192 cf::sync_job {
1193 my %todo;
1194
923 for my $ext (<$LIBDIR/*.ext>) { 1195 for my $path (<$LIBDIR/*.ext>) {
924 next unless -r $ext; 1196 next unless -r $path;
925 eval { 1197
926 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;
927 1 1255 }
928 } or warn "$ext not loaded: $@"; 1256
1257 skip:
1258 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1259 unless $progress;
1260 }
929 } 1261 };
930} 1262}
931 1263
932############################################################################# 1264#############################################################################
933 1265
1266=back
1267
934=head2 CORE EXTENSIONS 1268=head2 CORE EXTENSIONS
935 1269
936Functions and methods that extend core crossfire objects. 1270Functions and methods that extend core crossfire objects.
937 1271
938=cut 1272=cut
943 1277
944=head3 cf::player 1278=head3 cf::player
945 1279
946=over 4 1280=over 4
947 1281
1282=item cf::player::num_playing
1283
1284Returns the official number of playing players, as per the Crossfire metaserver rules.
1285
1286=cut
1287
1288sub num_playing {
1289 scalar grep
1290 $_->ob->map
1291 && !$_->hidden
1292 && !$_->ob->flag (cf::FLAG_WIZ),
1293 cf::player::list
1294}
1295
948=item cf::player::find $login 1296=item cf::player::find $login
949 1297
950Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
951 1299
952=cut 1300=cut
953 1301
954sub playerdir($) { 1302sub playerdir($) {
955 cf::localdir 1303 "$PLAYERDIR/"
956 . "/"
957 . cf::playerdir
958 . "/"
959 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
960} 1305}
961 1306
962sub path($) { 1307sub path($) {
963 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964 1309
965 (playerdir $login) . "/$login.pl" 1310 (playerdir $login) . "/playerdata"
966} 1311}
967 1312
968sub find_active($) { 1313sub find_active($) {
969 $cf::PLAYER{$_[0]} 1314 $cf::PLAYER{$_[0]}
970 and $cf::PLAYER{$_[0]}->active 1315 and $cf::PLAYER{$_[0]}->active
983 my $login = $_[0]; 1328 my $login = $_[0];
984 1329
985 my $guard = cf::lock_acquire "user_find:$login"; 1330 my $guard = cf::lock_acquire "user_find:$login";
986 1331
987 $cf::PLAYER{$_[0]} || do { 1332 $cf::PLAYER{$_[0]} || do {
988 my $pl = load_pl path $login 1333 # rename old playerfiles to new ones
1334 #TODO: remove when no longer required
1335 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1336 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1337 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1338 aio_unlink +(playerdir $login) . "/$login.pl";
1339
1340 my $f = new_from_file cf::object::thawer path $login
989 or return; 1341 or return;
1342
1343 $f->next;
1344 my $pl = cf::player::load_pl $f
1345 or return;
1346 local $cf::PLAYER_LOADING{$login} = $pl;
1347 $f->resolve_delayed_derefs;
990 $cf::PLAYER{$login} = $pl 1348 $cf::PLAYER{$login} = $pl
991 } 1349 }
992 } 1350 }
993} 1351}
994 1352
1004 1362
1005 aio_mkdir playerdir $pl, 0770; 1363 aio_mkdir playerdir $pl, 0770;
1006 $pl->{last_save} = $cf::RUNTIME; 1364 $pl->{last_save} = $cf::RUNTIME;
1007 1365
1008 $pl->save_pl ($path); 1366 $pl->save_pl ($path);
1009 Coro::cede; 1367 cf::cede_to_tick;
1010} 1368}
1011 1369
1012sub new($) { 1370sub new($) {
1013 my ($login) = @_; 1371 my ($login) = @_;
1014 1372
1018 $self->{deny_save} = 1; 1376 $self->{deny_save} = 1;
1019 1377
1020 $cf::PLAYER{$login} = $self; 1378 $cf::PLAYER{$login} = $self;
1021 1379
1022 $self 1380 $self
1381}
1382
1383=item $player->send_msg ($channel, $msg, $color, [extra...])
1384
1385=cut
1386
1387sub send_msg {
1388 my $ns = shift->ns
1389 or return;
1390 $ns->send_msg (@_);
1023} 1391}
1024 1392
1025=item $pl->quit_character 1393=item $pl->quit_character
1026 1394
1027Nukes the player without looking back. If logged in, the connection will 1395Nukes the player without looking back. If logged in, the connection will
1076while and may block, so not sync_job-capable, ever. 1444while and may block, so not sync_job-capable, ever.
1077 1445
1078=cut 1446=cut
1079 1447
1080sub list_logins { 1448sub list_logins {
1081 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1449 my $dirs = aio_readdir $PLAYERDIR
1082 or return []; 1450 or return [];
1083 1451
1084 my @logins; 1452 my @logins;
1085 1453
1086 for my $login (@$dirs) { 1454 for my $login (@$dirs) {
1455 my $path = path $login;
1456
1457 # a .pst is a dead give-away for a valid player
1458 unless (-e "$path.pst") {
1087 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1459 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1088 aio_read $fh, 0, 512, my $buf, 0 or next; 1460 aio_read $fh, 0, 512, my $buf, 0 or next;
1089 $buf !~ /^password -------------$/m or next; # official not-valid tag 1461 $buf !~ /^password -------------$/m or next; # official not-valid tag
1462 }
1090 1463
1091 utf8::decode $login; 1464 utf8::decode $login;
1092 push @logins, $login; 1465 push @logins, $login;
1093 } 1466 }
1094 1467
1121 } 1494 }
1122 1495
1123 \@paths 1496 \@paths
1124} 1497}
1125 1498
1499=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1500
1501Expand crossfire pod fragments into protocol xml.
1502
1503=cut
1504
1505sub expand_cfpod {
1506 ((my $self), (local $_)) = @_;
1507
1508 # escape & and <
1509 s/&/&amp;/g;
1510 s/(?<![BIUGHT])</&lt;/g;
1511
1512 # this is buggy, it needs to properly take care of nested <'s
1513
1514 1 while
1515 # replace B<>, I<>, U<> etc.
1516 s/B<([^\>]*)>/<b>$1<\/b>/
1517 || s/I<([^\>]*)>/<i>$1<\/i>/
1518 || s/U<([^\>]*)>/<u>$1<\/u>/
1519 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1520 # replace G<male|female> tags
1521 || s{G<([^>|]*)\|([^>]*)>}{
1522 $self->gender ? $2 : $1
1523 }ge
1524 # replace H<hint text>
1525 || s{H<([^\>]*)>}
1526 {
1527 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1528 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1529 "")
1530 [$self->{hintmode}]
1531 }ge;
1532
1533 # create single paragraphs (very hackish)
1534 s/(?<=\S)\n(?=\w)/ /g;
1535
1536 # compress some whitespace
1537 s/\s+\n/\n/g; # ws line-ends
1538 s/\n\n+/\n/g; # double lines
1539 s/^\n+//; # beginning lines
1540 s/\n+$//; # ending lines
1541
1542 $_
1543}
1544
1545sub hintmode {
1546 $_[0]{hintmode} = $_[1] if @_ > 1;
1547 $_[0]{hintmode}
1548}
1549
1126=item $player->ext_reply ($msgid, $msgtype, %msg) 1550=item $player->ext_reply ($msgid, @msg)
1127 1551
1128Sends an ext reply to the player. 1552Sends an ext reply to the player.
1129 1553
1130=cut 1554=cut
1131 1555
1132sub ext_reply($$$%) { 1556sub ext_reply($$@) {
1133 my ($self, $id, %msg) = @_; 1557 my ($self, $id, @msg) = @_;
1134 1558
1135 $msg{msgid} = $id; 1559 $self->ns->ext_reply ($id, @msg)
1136
1137 $self->send ("ext " . cf::to_json \%msg);
1138} 1560}
1139 1561
1140package cf; 1562=item $player->ext_msg ($type, @msg)
1563
1564Sends an ext event to the client.
1565
1566=cut
1567
1568sub ext_msg($$@) {
1569 my ($self, $type, @msg) = @_;
1570
1571 $self->ns->ext_msg ($type, @msg);
1572}
1573
1574=head3 cf::region
1575
1576=over 4
1577
1578=cut
1579
1580package cf::region;
1581
1582=item cf::region::find_by_path $path
1583
1584Tries to decuce the likely region for a map knowing only its path.
1585
1586=cut
1587
1588sub find_by_path($) {
1589 my ($path) = @_;
1590
1591 my ($match, $specificity);
1592
1593 for my $region (list) {
1594 if ($region->{match} && $path =~ $region->{match}) {
1595 ($match, $specificity) = ($region, $region->specificity)
1596 if $region->specificity > $specificity;
1597 }
1598 }
1599
1600 $match
1601}
1141 1602
1142=back 1603=back
1143
1144 1604
1145=head3 cf::map 1605=head3 cf::map
1146 1606
1147=over 4 1607=over 4
1148 1608
1203 my ($self, $merge) = @_; 1663 my ($self, $merge) = @_;
1204 1664
1205 # we have to keep some variables in memory intact 1665 # we have to keep some variables in memory intact
1206 local $self->{path}; 1666 local $self->{path};
1207 local $self->{load_path}; 1667 local $self->{load_path};
1208 local $self->{deny_save};
1209 local $self->{deny_reset};
1210 1668
1211 $self->SUPER::thawer_merge ($merge); 1669 $self->SUPER::thawer_merge ($merge);
1212} 1670}
1213 1671
1214sub normalise { 1672sub normalise {
1261 $self->init; # pass $1 etc. 1719 $self->init; # pass $1 etc.
1262 return $self; 1720 return $self;
1263 } 1721 }
1264 } 1722 }
1265 1723
1266 Carp::carp "unable to resolve path '$path' (base '$base')."; 1724 Carp::cluck "unable to resolve path '$path' (base '$base').";
1267 () 1725 ()
1268} 1726}
1269 1727
1270sub init { 1728sub init {
1271 my ($self) = @_; 1729 my ($self) = @_;
1286 1744
1287# the original (read-only) location 1745# the original (read-only) location
1288sub load_path { 1746sub load_path {
1289 my ($self) = @_; 1747 my ($self) = @_;
1290 1748
1291 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1749 "$MAPDIR/$self->{path}.map"
1292} 1750}
1293 1751
1294# the temporary/swap location 1752# the temporary/swap location
1295sub save_path { 1753sub save_path {
1296 my ($self) = @_; 1754 my ($self) = @_;
1297 1755
1298 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1756 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1299 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1757 "$TMPDIR/$path.map"
1300} 1758}
1301 1759
1302# the unique path, undef == no special unique path 1760# the unique path, undef == no special unique path
1303sub uniq_path { 1761sub uniq_path {
1304 my ($self) = @_; 1762 my ($self) = @_;
1305 1763
1306 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1764 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1307 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1765 "$UNIQUEDIR/$path"
1308} 1766}
1309 1767
1310# and all this just because we cannot iterate over 1768# and all this just because we cannot iterate over
1311# all maps in C++... 1769# all maps in C++...
1312sub change_all_map_light { 1770sub change_all_map_light {
1314 1772
1315 $_->change_map_light ($change) 1773 $_->change_map_light ($change)
1316 for grep $_->outdoor, values %cf::MAP; 1774 for grep $_->outdoor, values %cf::MAP;
1317} 1775}
1318 1776
1777sub decay_objects {
1778 my ($self) = @_;
1779
1780 return if $self->{deny_reset};
1781
1782 $self->do_decay_objects;
1783}
1784
1319sub unlink_save { 1785sub unlink_save {
1320 my ($self) = @_; 1786 my ($self) = @_;
1321 1787
1322 utf8::encode (my $save = $self->save_path); 1788 utf8::encode (my $save = $self->save_path);
1323 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1789 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1326 1792
1327sub load_header_from($) { 1793sub load_header_from($) {
1328 my ($self, $path) = @_; 1794 my ($self, $path) = @_;
1329 1795
1330 utf8::encode $path; 1796 utf8::encode $path;
1331 #aio_open $path, O_RDONLY, 0 1797 my $f = new_from_file cf::object::thawer $path
1332 # or return;
1333
1334 $self->_load_header ($path)
1335 or return; 1798 or return;
1799
1800 $self->_load_header ($f)
1801 or return;
1802
1803 local $MAP_LOADING{$self->{path}} = $self;
1804 $f->resolve_delayed_derefs;
1336 1805
1337 $self->{load_path} = $path; 1806 $self->{load_path} = $path;
1338 1807
1339 1 1808 1
1340} 1809}
1379 $self->load_header_orig 1848 $self->load_header_orig
1380 or return; 1849 or return;
1381 $self->prepare_orig; 1850 $self->prepare_orig;
1382 } 1851 }
1383 1852
1853 $self->{deny_reset} = 1
1854 if $self->no_reset;
1855
1856 $self->default_region (cf::region::find_by_path $self->{path})
1857 unless $self->default_region;
1858
1384 1 1859 1
1385} 1860}
1386 1861
1387sub find; 1862sub find;
1388sub find { 1863sub find {
1389 my ($path, $origin) = @_; 1864 my ($path, $origin) = @_;
1390 1865
1391 $path = normalise $path, $origin && $origin->path; 1866 $path = normalise $path, $origin && $origin->path;
1392 1867
1868 cf::lock_wait "map_data:$path";#d#remove
1393 cf::lock_wait "map_find:$path"; 1869 cf::lock_wait "map_find:$path";
1394 1870
1395 $cf::MAP{$path} || do { 1871 $cf::MAP{$path} || do {
1396 my $guard = cf::lock_acquire "map_find:$path"; 1872 my $guard1 = cf::lock_acquire "map_find:$path";
1873 my $guard2 = cf::lock_acquire "map_data:$path"; # just for the fun of it
1874
1397 my $map = new_from_path cf::map $path 1875 my $map = new_from_path cf::map $path
1398 or return; 1876 or return;
1399 1877
1400 $map->{last_save} = $cf::RUNTIME; 1878 $map->{last_save} = $cf::RUNTIME;
1401 1879
1402 $map->load_header 1880 $map->load_header
1403 or return; 1881 or return;
1404 1882
1405 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1883 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1406 # doing this can freeze the server in a sync job, obviously 1884 # doing this can freeze the server in a sync job, obviously
1407 #$cf::WAIT_FOR_TICK->wait; 1885 #$cf::WAIT_FOR_TICK->wait;
1886 undef $guard1;
1887 undef $guard2;
1408 $map->reset; 1888 $map->reset;
1409 undef $guard;
1410 return find $path; 1889 return find $path;
1411 } 1890 }
1412 1891
1413 $cf::MAP{$path} = $map 1892 $cf::MAP{$path} = $map
1414 } 1893 }
1421 my ($self) = @_; 1900 my ($self) = @_;
1422 1901
1423 local $self->{deny_reset} = 1; # loading can take a long time 1902 local $self->{deny_reset} = 1; # loading can take a long time
1424 1903
1425 my $path = $self->{path}; 1904 my $path = $self->{path};
1905
1906 {
1426 my $guard = cf::lock_acquire "map_load:$path"; 1907 my $guard = cf::lock_acquire "map_data:$path";
1427 1908
1909 return unless $self->valid;
1428 return if $self->in_memory != cf::MAP_SWAPPED; 1910 return unless $self->in_memory == cf::MAP_SWAPPED;
1429 1911
1430 $self->in_memory (cf::MAP_LOADING); 1912 $self->in_memory (cf::MAP_LOADING);
1431 1913
1432 $self->alloc; 1914 $self->alloc;
1433 1915
1434 $self->pre_load; 1916 $self->pre_load;
1917 cf::cede_to_tick;
1435 1918
1436 $self->_load_objects ($self->{load_path}, 1) 1919 my $f = new_from_file cf::object::thawer $self->{load_path};
1920 $f->skip_block;
1921 $self->_load_objects ($f)
1437 or return; 1922 or return;
1438 1923
1439 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1924 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1440 if delete $self->{load_original}; 1925 if delete $self->{load_original};
1441 1926
1442 if (my $uniq = $self->uniq_path) { 1927 if (my $uniq = $self->uniq_path) {
1443 utf8::encode $uniq; 1928 utf8::encode $uniq;
1444 if (aio_open $uniq, O_RDONLY, 0) { 1929 unless (aio_stat $uniq) {
1930 if (my $f = new_from_file cf::object::thawer $uniq) {
1445 $self->clear_unique_items; 1931 $self->clear_unique_items;
1446 $self->_load_objects ($uniq, 0); 1932 $self->_load_objects ($f);
1933 $f->resolve_delayed_derefs;
1934 }
1447 } 1935 }
1448 } 1936 }
1449 1937
1450 Coro::cede; 1938 $f->resolve_delayed_derefs;
1451 1939
1940 cf::cede_to_tick;
1452 # now do the right thing for maps 1941 # now do the right thing for maps
1453 $self->link_multipart_objects; 1942 $self->link_multipart_objects;
1454
1455 unless ($self->{deny_activate}) {
1456 $self->decay_objects;
1457 $self->fix_auto_apply;
1458 $self->update_buttons;
1459 Coro::cede;
1460 $self->set_darkness_map;
1461 $self->difficulty ($self->estimate_difficulty) 1943 $self->difficulty ($self->estimate_difficulty)
1462 unless $self->difficulty; 1944 unless $self->difficulty;
1463 Coro::cede; 1945 cf::cede_to_tick;
1946
1947 unless ($self->{deny_activate}) {
1948 $self->decay_objects;
1949 $self->fix_auto_apply;
1950 $self->update_buttons;
1951 cf::cede_to_tick;
1952 $self->set_darkness_map;
1953 cf::cede_to_tick;
1464 $self->activate; 1954 $self->activate;
1955 }
1956
1957 $self->{last_save} = $cf::RUNTIME;
1958 $self->last_access ($cf::RUNTIME);
1959
1960 $self->in_memory (cf::MAP_IN_MEMORY);
1465 } 1961 }
1466 1962
1467 $self->post_load; 1963 $self->post_load;
1468
1469 $self->in_memory (cf::MAP_IN_MEMORY);
1470} 1964}
1471 1965
1472sub customise_for { 1966sub customise_for {
1473 my ($self, $ob) = @_; 1967 my ($self, $ob) = @_;
1474 1968
1475 return find "~" . $ob->name . "/" . $self->{path} 1969 return find "~" . $ob->name . "/" . $self->{path}
1476 if $self->per_player; 1970 if $self->per_player;
1477 1971
1972# return find "?party/" . $ob->name . "/" . $self->{path}
1973# if $self->per_party;
1974
1478 $self 1975 $self
1479} 1976}
1480 1977
1481# find and load all maps in the 3x3 area around a map 1978# find and load all maps in the 3x3 area around a map
1482sub load_diag { 1979sub load_neighbours {
1483 my ($map) = @_; 1980 my ($map) = @_;
1484 1981
1485 my @diag; # diagonal neighbours 1982 my @neigh; # diagonal neighbours
1486 1983
1487 for (0 .. 3) { 1984 for (0 .. 3) {
1488 my $neigh = $map->tile_path ($_) 1985 my $neigh = $map->tile_path ($_)
1489 or next; 1986 or next;
1490 $neigh = find $neigh, $map 1987 $neigh = find $neigh, $map
1491 or next; 1988 or next;
1492 $neigh->load; 1989 $neigh->load;
1493 1990
1991 push @neigh,
1494 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1992 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1495 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1993 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1496 } 1994 }
1497 1995
1498 for (@diag) { 1996 for (grep defined $_->[0], @neigh) {
1997 my ($path, $origin) = @$_;
1499 my $neigh = find @$_ 1998 my $neigh = find $path, $origin
1500 or next; 1999 or next;
1501 $neigh->load; 2000 $neigh->load;
1502 } 2001 }
1503} 2002}
1504 2003
1509} 2008}
1510 2009
1511sub do_load_sync { 2010sub do_load_sync {
1512 my ($map) = @_; 2011 my ($map) = @_;
1513 2012
2013 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2014 if $Coro::current == $Coro::main;
2015
1514 cf::sync_job { $map->load }; 2016 cf::sync_job { $map->load };
1515} 2017}
1516 2018
1517our %MAP_PREFETCH; 2019our %MAP_PREFETCH;
1518our $MAP_PREFETCHER = undef; 2020our $MAP_PREFETCHER = undef;
1519 2021
1520sub find_async { 2022sub find_async {
1521 my ($path, $origin) = @_; 2023 my ($path, $origin, $load) = @_;
1522 2024
1523 $path = normalise $path, $origin && $origin->{path}; 2025 $path = normalise $path, $origin && $origin->{path};
1524 2026
1525 if (my $map = $cf::MAP{$path}) { 2027 if (my $map = $cf::MAP{$path}) {
1526 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2028 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1527 } 2029 }
1528 2030
1529 undef $MAP_PREFETCH{$path}; 2031 $MAP_PREFETCH{$path} |= $load;
2032
1530 $MAP_PREFETCHER ||= cf::async { 2033 $MAP_PREFETCHER ||= cf::async {
1531 while (%MAP_PREFETCH) { 2034 while (%MAP_PREFETCH) {
1532 for my $path (keys %MAP_PREFETCH) { 2035 while (my ($k, $v) = each %MAP_PREFETCH) {
1533 my $map = find $path 2036 if (my $map = find $k) {
1534 or next;
1535 $map->load; 2037 $map->load if $v;
2038 }
1536 2039
1537 delete $MAP_PREFETCH{$path}; 2040 delete $MAP_PREFETCH{$k};
1538 } 2041 }
1539 } 2042 }
1540 undef $MAP_PREFETCHER; 2043 undef $MAP_PREFETCHER;
1541 }; 2044 };
1542 $MAP_PREFETCHER->prio (6); 2045 $MAP_PREFETCHER->prio (6);
1545} 2048}
1546 2049
1547sub save { 2050sub save {
1548 my ($self) = @_; 2051 my ($self) = @_;
1549 2052
1550 my $lock = cf::lock_acquire "map_data:" . $self->path; 2053 my $lock = cf::lock_acquire "map_data:$self->{path}";
1551 2054
1552 $self->{last_save} = $cf::RUNTIME; 2055 $self->{last_save} = $cf::RUNTIME;
1553 2056
1554 return unless $self->dirty; 2057 return unless $self->dirty;
1555 2058
1578 my ($self) = @_; 2081 my ($self) = @_;
1579 2082
1580 # save first because save cedes 2083 # save first because save cedes
1581 $self->save; 2084 $self->save;
1582 2085
1583 my $lock = cf::lock_acquire "map_data:" . $self->path; 2086 my $lock = cf::lock_acquire "map_data:$self->{path}";
1584 2087
1585 return if $self->players; 2088 return if $self->players;
1586 return if $self->in_memory != cf::MAP_IN_MEMORY; 2089 return if $self->in_memory != cf::MAP_IN_MEMORY;
1587 return if $self->{deny_save}; 2090 return if $self->{deny_save};
1588 2091
2092 $self->in_memory (cf::MAP_SWAPPED);
2093
2094 $self->deactivate;
2095 $_->clear_links_to ($self) for values %cf::MAP;
1589 $self->clear; 2096 $self->clear;
1590 $self->in_memory (cf::MAP_SWAPPED);
1591} 2097}
1592 2098
1593sub reset_at { 2099sub reset_at {
1594 my ($self) = @_; 2100 my ($self) = @_;
1595 2101
1596 # TODO: safety, remove and allow resettable per-player maps 2102 # TODO: safety, remove and allow resettable per-player maps
1597 return 1e99 if $self->isa ("ext::map_per_player");#d#
1598 return 1e99 if $self->{deny_reset}; 2103 return 1e99 if $self->{deny_reset};
1599 2104
1600 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2105 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1601 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2106 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1602 2107
1613 my ($self) = @_; 2118 my ($self) = @_;
1614 2119
1615 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2120 my $lock = cf::lock_acquire "map_data:$self->{path}";
1616 2121
1617 return if $self->players; 2122 return if $self->players;
1618 return if $self->isa ("ext::map_per_player");#d#
1619 2123
1620 warn "resetting map ", $self->path;#d# 2124 warn "resetting map ", $self->path;
1621 2125
1622 $self->in_memory (cf::MAP_SWAPPED); 2126 $self->in_memory (cf::MAP_SWAPPED);
1623 2127
1624 # need to save uniques path 2128 # need to save uniques path
1625 unless ($self->{deny_save}) { 2129 unless ($self->{deny_save}) {
1629 if $uniq; 2133 if $uniq;
1630 } 2134 }
1631 2135
1632 delete $cf::MAP{$self->path}; 2136 delete $cf::MAP{$self->path};
1633 2137
2138 $self->deactivate;
2139 $_->clear_links_to ($self) for values %cf::MAP;
1634 $self->clear; 2140 $self->clear;
1635
1636 $_->clear_links_to ($self) for values %cf::MAP;
1637 2141
1638 $self->unlink_save; 2142 $self->unlink_save;
1639 $self->destroy; 2143 $self->destroy;
1640} 2144}
1641 2145
1642my $nuke_counter = "aaaa"; 2146my $nuke_counter = "aaaa";
1643 2147
1644sub nuke { 2148sub nuke {
1645 my ($self) = @_; 2149 my ($self) = @_;
1646 2150
2151 {
2152 my $lock = cf::lock_acquire "map_data:$self->{path}";
2153
1647 delete $cf::MAP{$self->path}; 2154 delete $cf::MAP{$self->path};
1648 2155
1649 $self->unlink_save; 2156 $self->unlink_save;
1650 2157
1651 bless $self, "cf::map"; 2158 bless $self, "cf::map";
1652 delete $self->{deny_reset}; 2159 delete $self->{deny_reset};
1653 $self->{deny_save} = 1; 2160 $self->{deny_save} = 1;
1654 $self->reset_timeout (1); 2161 $self->reset_timeout (1);
1655 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2162 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1656 2163
1657 $cf::MAP{$self->path} = $self; 2164 $cf::MAP{$self->path} = $self;
2165 }
1658 2166
1659 $self->reset; # polite request, might not happen 2167 $self->reset; # polite request, might not happen
2168}
2169
2170=item $maps = cf::map::tmp_maps
2171
2172Returns an arrayref with all map paths of currently instantiated and saved
2173maps. May block.
2174
2175=cut
2176
2177sub tmp_maps() {
2178 [
2179 map {
2180 utf8::decode $_;
2181 /\.map$/
2182 ? normalise $_
2183 : ()
2184 } @{ aio_readdir $TMPDIR or [] }
2185 ]
2186}
2187
2188=item $maps = cf::map::random_maps
2189
2190Returns an arrayref with all map paths of currently instantiated and saved
2191random maps. May block.
2192
2193=cut
2194
2195sub random_maps() {
2196 [
2197 map {
2198 utf8::decode $_;
2199 /\.map$/
2200 ? normalise "?random/$_"
2201 : ()
2202 } @{ aio_readdir $RANDOMDIR or [] }
2203 ]
1660} 2204}
1661 2205
1662=item cf::map::unique_maps 2206=item cf::map::unique_maps
1663 2207
1664Returns an arrayref of paths of all shared maps that have 2208Returns an arrayref of paths of all shared maps that have
1665instantiated unique items. May block. 2209instantiated unique items. May block.
1666 2210
1667=cut 2211=cut
1668 2212
1669sub unique_maps() { 2213sub unique_maps() {
1670 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2214 [
1671 or return; 2215 map {
1672
1673 my @paths;
1674
1675 for (@$files) {
1676 utf8::decode $_; 2216 utf8::decode $_;
1677 next if /\.pst$/; 2217 /\.map$/
1678 next unless /^$PATH_SEP/o; 2218 ? normalise $_
1679 2219 : ()
1680 push @paths, cf::map::normalise $_; 2220 } @{ aio_readdir $UNIQUEDIR or [] }
1681 } 2221 ]
1682
1683 \@paths
1684} 2222}
1685 2223
1686package cf; 2224package cf;
1687 2225
1688=back 2226=back
1706 map { $_, inv_recursive_ $_->inv } @_ 2244 map { $_, inv_recursive_ $_->inv } @_
1707} 2245}
1708 2246
1709sub inv_recursive { 2247sub inv_recursive {
1710 inv_recursive_ inv $_[0] 2248 inv_recursive_ inv $_[0]
2249}
2250
2251=item $ref = $ob->ref
2252
2253creates and returns a persistent reference to an objetc that can be stored as a string.
2254
2255=item $ob = cf::object::deref ($refstring)
2256
2257returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2258even if the object actually exists. May block.
2259
2260=cut
2261
2262sub deref {
2263 my ($ref) = @_;
2264
2265 # temporary compatibility#TODO#remove
2266 $ref =~ s{^<}{player/<};
2267
2268 if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
2269 my ($uuid, $name) = ($1, $2);
2270 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2271 or return;
2272 $pl->ob->uuid eq $uuid
2273 or return;
2274
2275 $pl->ob
2276 } else {
2277 warn "$ref: cannot resolve object reference\n";
2278 undef
2279 }
1711} 2280}
1712 2281
1713package cf; 2282package cf;
1714 2283
1715=back 2284=back
1734 2303
1735 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2304 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1736 2305
1737 if ($self->{record_replies}) { 2306 if ($self->{record_replies}) {
1738 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2307 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2308
1739 } else { 2309 } else {
2310 my $pl = $self->contr;
2311
2312 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2313 my $dialog = $pl->{npc_dialog};
2314 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2315
2316 } else {
1740 $msg = $npc->name . " says: $msg" if $npc; 2317 $msg = $npc->name . " says: $msg" if $npc;
1741 $self->message ($msg, $flags); 2318 $self->message ($msg, $flags);
2319 }
1742 } 2320 }
2321}
2322
2323=item $object->send_msg ($channel, $msg, $color, [extra...])
2324
2325=cut
2326
2327sub cf::object::send_msg {
2328 my $pl = shift->contr
2329 or return;
2330 $pl->send_msg (@_);
1743} 2331}
1744 2332
1745=item $player_object->may ("access") 2333=item $player_object->may ("access")
1746 2334
1747Returns wether the given player is authorized to access resource "access" 2335Returns wether the given player is authorized to access resource "access"
1794 $self->deactivate_recursive; 2382 $self->deactivate_recursive;
1795 2383
1796 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2384 return if UNIVERSAL::isa $self->map, "ext::map_link";
1797 2385
1798 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2386 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1799 if $self->map; 2387 if $self->map && $self->map->{path} ne "{link}";
1800 2388
1801 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2389 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1802} 2390}
1803 2391
1804sub cf::object::player::leave_link { 2392sub cf::object::player::leave_link {
1805 my ($self, $map, $x, $y) = @_; 2393 my ($self, $map, $x, $y) = @_;
2394
2395 return unless $self->contr->active;
1806 2396
1807 my $link_pos = delete $self->{_link_pos}; 2397 my $link_pos = delete $self->{_link_pos};
1808 2398
1809 unless ($map) { 2399 unless ($map) {
1810 # restore original map position 2400 # restore original map position
1824 # use -1 or undef as default coordinates, not 0, 0 2414 # use -1 or undef as default coordinates, not 0, 0
1825 ($x, $y) = ($map->enter_x, $map->enter_y) 2415 ($x, $y) = ($map->enter_x, $map->enter_y)
1826 if $x <=0 && $y <= 0; 2416 if $x <=0 && $y <= 0;
1827 2417
1828 $map->load; 2418 $map->load;
1829 $map->load_diag; 2419 $map->load_neighbours;
1830 2420
1831 return unless $self->contr->active; 2421 return unless $self->contr->active;
1832 $self->activate_recursive; 2422 $self->activate_recursive;
1833 2423
1834 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2424 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1835 $self->enter_map ($map, $x, $y); 2425 $self->enter_map ($map, $x, $y);
1836} 2426}
1837 2427
1838cf::player->attach ( 2428=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1839 on_logout => sub {
1840 my ($pl) = @_;
1841 2429
1842 # abort map switching before logout 2430Moves the player to the given map-path and coordinates by first freezing
1843 if ($pl->ob->{_link_pos}) { 2431her, loading and preparing them map, calling the provided $check callback
1844 cf::sync_job { 2432that has to return the map if sucecssful, and then unfreezes the player on
1845 $pl->ob->leave_link 2433the new (success) or old (failed) map position. In either case, $done will
1846 }; 2434be called at the end of this process.
1847 }
1848 },
1849 on_login => sub {
1850 my ($pl) = @_;
1851 2435
1852 # try to abort aborted map switching on player login :)
1853 # should happen only on crashes
1854 if ($pl->ob->{_link_pos}) {
1855 $pl->ob->enter_link;
1856 (async {
1857 $pl->ob->reply (undef,
1858 "There was an internal problem at your last logout, "
1859 . "the server will try to bring you to your intended destination in a second.",
1860 cf::NDI_RED);
1861 # we need this sleep as the login has a concurrent enter_exit running
1862 # and this sleep increases chances of the player not ending up in scorn
1863 Coro::Timer::sleep 1;
1864 $pl->ob->leave_link;
1865 })->prio (2);
1866 }
1867 },
1868);
1869
1870=item $player_object->goto ($path, $x, $y)
1871
1872=cut 2436=cut
2437
2438our $GOTOGEN;
1873 2439
1874sub cf::object::player::goto { 2440sub cf::object::player::goto {
1875 my ($self, $path, $x, $y) = @_; 2441 my ($self, $path, $x, $y, $check, $done) = @_;
2442
2443 # do generation counting so two concurrent goto's will be executed in-order
2444 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1876 2445
1877 $self->enter_link; 2446 $self->enter_link;
1878 2447
1879 (async { 2448 (async {
1880 my $map = eval { 2449 my $map = eval {
1881 my $map = cf::map::find $path; 2450 my $map = cf::map::find $path;
2451
2452 if ($map) {
1882 $map = $map->customise_for ($self) if $map; 2453 $map = $map->customise_for ($self);
2454 $map = $check->($map) if $check && $map;
2455 } else {
2456 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2457 }
2458
1883 $map 2459 $map
2460 };
2461
2462 if ($@) {
2463 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2464 LOG llevError | logBacktrace, Carp::longmess $@;
1884 } or 2465 }
1885 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1886 2466
2467 if ($gen == $self->{_goto_generation}) {
2468 delete $self->{_goto_generation};
1887 $self->leave_link ($map, $x, $y); 2469 $self->leave_link ($map, $x, $y);
2470 }
2471
2472 $done->() if $done;
1888 })->prio (1); 2473 })->prio (1);
1889} 2474}
1890 2475
1891=item $player_object->enter_exit ($exit_object) 2476=item $player_object->enter_exit ($exit_object)
1892 2477
1931 2516
1932 $rmp->{random_seed} ||= $exit->random_seed; 2517 $rmp->{random_seed} ||= $exit->random_seed;
1933 2518
1934 my $data = cf::to_json $rmp; 2519 my $data = cf::to_json $rmp;
1935 my $md5 = Digest::MD5::md5_hex $data; 2520 my $md5 = Digest::MD5::md5_hex $data;
1936 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2521 my $meta = "$RANDOMDIR/$md5.meta";
1937 2522
1938 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2523 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1939 aio_write $fh, 0, (length $data), $data, 0; 2524 aio_write $fh, 0, (length $data), $data, 0;
1940 undef $fh; 2525 undef $fh;
1941 aio_rename "$meta~", $meta; 2526 aio_rename "$meta~", $meta;
1950 2535
1951 return unless $self->type == cf::PLAYER; 2536 return unless $self->type == cf::PLAYER;
1952 2537
1953 if ($exit->slaying eq "/!") { 2538 if ($exit->slaying eq "/!") {
1954 #TODO: this should de-fi-ni-te-ly not be a sync-job 2539 #TODO: this should de-fi-ni-te-ly not be a sync-job
2540 # the problem is that $exit might not survive long enough
2541 # so it needs to be done right now, right here
1955 cf::sync_job { prepare_random_map $exit }; 2542 cf::sync_job { prepare_random_map $exit };
1956 } 2543 }
1957 2544
1958 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2545 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1959 my $hp = $exit->stats->hp; 2546 my $hp = $exit->stats->hp;
1960 my $sp = $exit->stats->sp; 2547 my $sp = $exit->stats->sp;
1961 2548
1962 $self->enter_link; 2549 $self->enter_link;
2550
2551 # if exit is damned, update players death & WoR home-position
2552 $self->contr->savebed ($slaying, $hp, $sp)
2553 if $exit->flag (FLAG_DAMNED);
1963 2554
1964 (async { 2555 (async {
1965 $self->deactivate_recursive; # just to be sure 2556 $self->deactivate_recursive; # just to be sure
1966 unless (eval { 2557 unless (eval {
1967 $self->goto ($slaying, $hp, $sp); 2558 $self->goto ($slaying, $hp, $sp);
1968 2559
1969 1; 2560 1;
1970 }) { 2561 }) {
1971 $self->message ("Something went wrong deep within the crossfire server. " 2562 $self->message ("Something went wrong deep within the crossfire server. "
1972 . "I'll try to bring you back to the map you were before. " 2563 . "I'll try to bring you back to the map you were before. "
1973 . "Please report this to the dungeon master!", 2564 . "Please report this to the dungeon master!",
1974 cf::NDI_UNIQUE | cf::NDI_RED); 2565 cf::NDI_UNIQUE | cf::NDI_RED);
1975 2566
1976 warn "ERROR in enter_exit: $@"; 2567 warn "ERROR in enter_exit: $@";
1977 $self->leave_link; 2568 $self->leave_link;
1978 } 2569 }
1979 })->prio (1); 2570 })->prio (1);
1992 2583
1993sub cf::client::send_drawinfo { 2584sub cf::client::send_drawinfo {
1994 my ($self, $text, $flags) = @_; 2585 my ($self, $text, $flags) = @_;
1995 2586
1996 utf8::encode $text; 2587 utf8::encode $text;
1997 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2588 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1998} 2589}
1999 2590
2591=item $client->send_msg ($channel, $msg, $color, [extra...])
2592
2593Send a drawinfo or msg packet to the client, formatting the msg for the
2594client if neccessary. C<$type> should be a string identifying the type of
2595the message, with C<log> being the default. If C<$color> is negative, suppress
2596the message unless the client supports the msg packet.
2597
2598=cut
2599
2600our %CHANNEL = (
2601 "c/identify" => {
2602 id => "identify",
2603 title => "Identify",
2604 reply => undef,
2605 tooltip => "Items recently identified",
2606 },
2607 "c/examine" => {
2608 id => "examine",
2609 title => "Examine",
2610 reply => undef,
2611 tooltip => "Signs and other items you examined",
2612 },
2613);
2614
2615sub cf::client::send_msg {
2616 my ($self, $channel, $msg, $color, @extra) = @_;
2617
2618 $msg = $self->pl->expand_cfpod ($msg);
2619
2620 $color &= cf::NDI_CLIENT_MASK; # just in case...
2621
2622 # check predefined channels, for the benefit of C
2623 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2624
2625 if (ref $channel) {
2626 # send meta info to client, if not yet sent
2627 unless (exists $self->{channel}{$channel->{id}}) {
2628 $self->{channel}{$channel->{id}} = $channel;
2629 $self->ext_msg (channel_info => $channel)
2630 if $self->can_msg;
2631 }
2632
2633 $channel = $channel->{id};
2634 }
2635
2636 return unless @extra || length $msg;
2637
2638 if ($self->can_msg) {
2639 # default colour, mask it out
2640 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2641 if $color & cf::NDI_DEF;
2642
2643 $self->send_packet ("msg " . $self->{json_coder}->encode (
2644 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2645 } else {
2646 if ($color >= 0) {
2647 # replace some tags by gcfclient-compatible ones
2648 for ($msg) {
2649 1 while
2650 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2651 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2652 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2653 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2654 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2655 }
2656
2657 $color &= cf::NDI_COLOR_MASK;
2658
2659 utf8::encode $msg;
2660
2661 if (0 && $msg =~ /\[/) {
2662 # COMMAND/INFO
2663 $self->send_packet ("drawextinfo $color 10 8 $msg")
2664 } else {
2665 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2666 $self->send_packet ("drawinfo $color $msg")
2667 }
2668 }
2669 }
2670}
2671
2672=item $client->ext_msg ($type, @msg)
2673
2674Sends an ext event to the client.
2675
2676=cut
2677
2678sub cf::client::ext_msg($$@) {
2679 my ($self, $type, @msg) = @_;
2680
2681 if ($self->extcmd == 2) {
2682 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2683 } elsif ($self->extcmd == 1) { # TODO: remove
2684 push @msg, msgtype => "event_$type";
2685 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2686 }
2687}
2688
2689=item $client->ext_reply ($msgid, @msg)
2690
2691Sends an ext reply to the client.
2692
2693=cut
2694
2695sub cf::client::ext_reply($$@) {
2696 my ($self, $id, @msg) = @_;
2697
2698 if ($self->extcmd == 2) {
2699 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2700 } elsif ($self->extcmd == 1) {
2701 #TODO: version 1, remove
2702 unshift @msg, msgtype => "reply", msgid => $id;
2703 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2704 }
2705}
2000 2706
2001=item $success = $client->query ($flags, "text", \&cb) 2707=item $success = $client->query ($flags, "text", \&cb)
2002 2708
2003Queues a query to the client, calling the given callback with 2709Queues a query to the client, calling the given callback with
2004the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2710the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2005C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2711C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2006 2712
2007Queries can fail, so check the return code. Or don't, as queries will become 2713Queries can fail, so check the return code. Or don't, as queries will
2008reliable at some point in the future. 2714become reliable at some point in the future.
2009 2715
2010=cut 2716=cut
2011 2717
2012sub cf::client::query { 2718sub cf::client::query {
2013 my ($self, $flags, $text, $cb) = @_; 2719 my ($self, $flags, $text, $cb) = @_;
2021 utf8::encode $text; 2727 utf8::encode $text;
2022 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2728 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2023 2729
2024 $self->send_packet ($self->{query_queue}[0][0]) 2730 $self->send_packet ($self->{query_queue}[0][0])
2025 if @{ $self->{query_queue} } == 1; 2731 if @{ $self->{query_queue} } == 1;
2732
2733 1
2026} 2734}
2027 2735
2028cf::client->attach ( 2736cf::client->attach (
2737 on_connect => sub {
2738 my ($ns) = @_;
2739
2740 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2741 },
2029 on_reply => sub { 2742 on_reply => sub {
2030 my ($ns, $msg) = @_; 2743 my ($ns, $msg) = @_;
2031 2744
2032 # this weird shuffling is so that direct followup queries 2745 # this weird shuffling is so that direct followup queries
2033 # get handled first 2746 # get handled first
2045 } else { 2758 } else {
2046 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2759 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2047 } 2760 }
2048 } 2761 }
2049 }, 2762 },
2763 on_exticmd => sub {
2764 my ($ns, $buf) = @_;
2765
2766 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2767
2768 if (ref $msg) {
2769 my ($type, $reply, @payload) =
2770 "ARRAY" eq ref $msg
2771 ? @$msg
2772 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2773
2774 my @reply;
2775
2776 if (my $cb = $EXTICMD{$type}) {
2777 @reply = $cb->($ns, @payload);
2778 }
2779
2780 $ns->ext_reply ($reply, @reply)
2781 if $reply;
2782
2783 } else {
2784 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2785 }
2786
2787 cf::override;
2788 },
2050); 2789);
2051 2790
2052=item $client->async (\&cb) 2791=item $client->async (\&cb)
2053 2792
2054Create a new coroutine, running the specified callback. The coroutine will 2793Create a new coroutine, running the specified callback. The coroutine will
2095our $safe = new Safe "safe"; 2834our $safe = new Safe "safe";
2096our $safe_hole = new Safe::Hole; 2835our $safe_hole = new Safe::Hole;
2097 2836
2098$SIG{FPE} = 'IGNORE'; 2837$SIG{FPE} = 'IGNORE';
2099 2838
2100$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2839$safe->permit_only (Opcode::opset qw(
2840 :base_core :base_mem :base_orig :base_math
2841 grepstart grepwhile mapstart mapwhile
2842 sort time
2843));
2101 2844
2102# here we export the classes and methods available to script code 2845# here we export the classes and methods available to script code
2103 2846
2104=pod 2847=pod
2105 2848
2106The following fucntions and emthods are available within a safe environment: 2849The following functions and methods are available within a safe environment:
2107 2850
2108 cf::object contr pay_amount pay_player map 2851 cf::object
2852 contr pay_amount pay_player map x y force_find force_add
2853 insert remove name archname title slaying race decrease_ob_nr
2854
2109 cf::object::player player 2855 cf::object::player
2110 cf::player peaceful 2856 player
2111 cf::map trigger 2857
2858 cf::player
2859 peaceful
2860
2861 cf::map
2862 trigger
2112 2863
2113=cut 2864=cut
2114 2865
2115for ( 2866for (
2116 ["cf::object" => qw(contr pay_amount pay_player map)], 2867 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2868 insert remove inv name archname title slaying race
2869 decrease_ob_nr)],
2117 ["cf::object::player" => qw(player)], 2870 ["cf::object::player" => qw(player)],
2118 ["cf::player" => qw(peaceful)], 2871 ["cf::player" => qw(peaceful)],
2119 ["cf::map" => qw(trigger)], 2872 ["cf::map" => qw(trigger)],
2120) { 2873) {
2121 no strict 'refs'; 2874 no strict 'refs';
2192=back 2945=back
2193 2946
2194=cut 2947=cut
2195 2948
2196############################################################################# 2949#############################################################################
2197
2198=head2 EXTENSION DATABASE SUPPORT
2199
2200Crossfire maintains a very simple database for extension use. It can
2201currently store anything that can be serialised using Storable, which
2202excludes objects.
2203
2204The parameter C<$family> should best start with the name of the extension
2205using it, it should be unique.
2206
2207=over 4
2208
2209=item $value = cf::db_get $family => $key
2210
2211Returns a single value from the database.
2212
2213=item cf::db_put $family => $key => $value
2214
2215Stores the given C<$value> in the family.
2216
2217=cut
2218
2219our $DB;
2220
2221sub db_init {
2222 unless ($DB) {
2223 $DB = BDB::db_create $DB_ENV;
2224
2225 cf::sync_job {
2226 eval {
2227 $DB->set_flags (BDB::CHKSUM);
2228
2229 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2230 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2231 cf::cleanup "db_open(db): $!" if $!;
2232 };
2233 cf::cleanup "db_open(db): $@" if $@;
2234 };
2235
2236 my $path = cf::localdir . "/database.pst";
2237 if (stat $path) {
2238 cf::sync_job {
2239 my $pst = Storable::retrieve $path;
2240
2241 cf::db_put (board => data => $pst->{board});
2242 cf::db_put (guildrules => data => $pst->{guildrules});
2243 cf::db_put (rent => balance => $pst->{rent}{balance});
2244 BDB::db_env_txn_checkpoint $DB_ENV;
2245
2246 unlink $path;
2247 };
2248 }
2249 }
2250}
2251
2252sub db_get($$) {
2253 my $key = "$_[0]/$_[1]";
2254
2255 cf::sync_job {
2256 BDB::db_get $DB, undef, $key, my $data;
2257
2258 $! ? ()
2259 : Compress::LZF::sthaw $data
2260 }
2261}
2262
2263sub db_put($$$) {
2264 BDB::dbreq_pri 4;
2265 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2266}
2267
2268#############################################################################
2269# the server's init and main functions 2950# the server's init and main functions
2270 2951
2271sub init_resources { 2952sub load_facedata($) {
2272 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2953 my ($path) = @_;
2954
2955 # HACK to clear player env face cache, we need some signal framework
2956 # for this (global event?)
2957 %ext::player_env::MUSIC_FACE_CACHE = ();
2958
2959 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2960
2961 warn "loading facedata from $path\n";
2962
2963 my $facedata;
2964 0 < aio_load $path, $facedata
2965 or die "$path: $!";
2966
2967 $facedata = Coro::Storable::thaw $facedata;
2968
2969 $facedata->{version} == 2
2970 or cf::cleanup "$path: version mismatch, cannot proceed.";
2971
2972 # patch in the exptable
2973 $facedata->{resource}{"res/exp_table"} = {
2974 type => FT_RSRC,
2975 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2976 };
2977 cf::cede_to_tick;
2978
2979 {
2980 my $faces = $facedata->{faceinfo};
2981
2982 while (my ($face, $info) = each %$faces) {
2983 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2984 cf::face::set_visibility $idx, $info->{visibility};
2985 cf::face::set_magicmap $idx, $info->{magicmap};
2986 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2987 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2988
2989 cf::cede_to_tick;
2990 }
2991
2992 while (my ($face, $info) = each %$faces) {
2993 next unless $info->{smooth};
2994 my $idx = cf::face::find $face
2995 or next;
2996 if (my $smooth = cf::face::find $info->{smooth}) {
2997 cf::face::set_smooth $idx, $smooth;
2998 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2999 } else {
3000 warn "smooth face '$info->{smooth}' not found for face '$face'";
3001 }
3002
3003 cf::cede_to_tick;
3004 }
3005 }
3006
3007 {
3008 my $anims = $facedata->{animinfo};
3009
3010 while (my ($anim, $info) = each %$anims) {
3011 cf::anim::set $anim, $info->{frames}, $info->{facings};
3012 cf::cede_to_tick;
3013 }
3014
3015 cf::anim::invalidate_all; # d'oh
3016 }
3017
3018 {
3019 # TODO: for gcfclient pleasure, we should give resources
3020 # that gcfclient doesn't grok a >10000 face index.
3021 my $res = $facedata->{resource};
3022
3023 my $soundconf = delete $res->{"res/sound.conf"};
3024
3025 while (my ($name, $info) = each %$res) {
3026 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3027 my $data;
3028
3029 if ($info->{type} & 1) {
3030 # prepend meta info
3031
3032 my $meta = $enc->encode ({
3033 name => $name,
3034 %{ $info->{meta} || {} },
3035 });
3036
3037 $data = pack "(w/a*)*", $meta, $info->{data};
3038 } else {
3039 $data = $info->{data};
3040 }
3041
3042 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3043 cf::face::set_type $idx, $info->{type};
3044
3045 cf::cede_to_tick;
3046 }
3047
3048 if ($soundconf) {
3049 $soundconf = $enc->decode (delete $soundconf->{data});
3050
3051 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3052 my $sound = $soundconf->{compat}[$_]
3053 or next;
3054
3055 my $face = cf::face::find "sound/$sound->[1]";
3056 cf::sound::set $sound->[0] => $face;
3057 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3058 }
3059
3060 while (my ($k, $v) = each %{$soundconf->{event}}) {
3061 my $face = cf::face::find "sound/$v";
3062 cf::sound::set $k => $face;
3063 }
3064 }
3065 }
3066
3067 1
3068}
3069
3070register_exticmd fx_want => sub {
3071 my ($ns, $want) = @_;
3072
3073 while (my ($k, $v) = each %$want) {
3074 $ns->fx_want ($k, $v);
3075 }
3076};
3077
3078sub reload_regions {
3079 # HACK to clear player env face cache, we need some signal framework
3080 # for this (global event?)
3081 %ext::player_env::MUSIC_FACE_CACHE = ();
3082
3083 load_resource_file "$MAPDIR/regions"
2273 or die "unable to load regions file\n";#d# 3084 or die "unable to load regions file\n";
2274}
2275 3085
2276sub cfg_load { 3086 for (cf::region::list) {
3087 $_->{match} = qr/$_->{match}/
3088 if exists $_->{match};
3089 }
3090}
3091
3092sub reload_facedata {
3093 load_facedata "$DATADIR/facedata"
3094 or die "unable to load facedata\n";
3095}
3096
3097sub reload_archetypes {
3098 load_resource_file "$DATADIR/archetypes"
3099 or die "unable to load archetypes\n";
3100 #d# NEED to laod twice to resolve forward references
3101 # this really needs to be done in an extra post-pass
3102 # (which needs to be synchronous, so solve it differently)
3103 load_resource_file "$DATADIR/archetypes"
3104 or die "unable to load archetypes\n";
3105}
3106
3107sub reload_treasures {
3108 load_resource_file "$DATADIR/treasures"
3109 or die "unable to load treasurelists\n";
3110}
3111
3112sub reload_resources {
3113 warn "reloading resource files...\n";
3114
3115 reload_regions;
3116 reload_facedata;
3117 #reload_archetypes;#d#
3118 reload_archetypes;
3119 reload_treasures;
3120
3121 warn "finished reloading resource files\n";
3122}
3123
3124sub init {
3125 reload_resources;
3126}
3127
3128sub reload_config {
2277 open my $fh, "<:utf8", cf::confdir . "/config" 3129 open my $fh, "<:utf8", "$CONFDIR/config"
2278 or return; 3130 or return;
2279 3131
2280 local $/; 3132 local $/;
2281 *CFG = YAML::Syck::Load <$fh>; 3133 *CFG = YAML::Syck::Load <$fh>;
2282 3134
2290 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3142 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2291 and die "WARNING: m(un)lockall failed: $!\n"; 3143 and die "WARNING: m(un)lockall failed: $!\n";
2292 }; 3144 };
2293 warn $@ if $@; 3145 warn $@ if $@;
2294 } 3146 }
2295}
2296
2297sub init {
2298 init_resources;
2299} 3147}
2300 3148
2301sub main { 3149sub main {
2302 # we must not ever block the main coroutine 3150 # we must not ever block the main coroutine
2303 local $Coro::idle = sub { 3151 local $Coro::idle = sub {
2305 (async { 3153 (async {
2306 Event::one_event; 3154 Event::one_event;
2307 })->prio (Coro::PRIO_MAX); 3155 })->prio (Coro::PRIO_MAX);
2308 }; 3156 };
2309 3157
2310 cfg_load; 3158 reload_config;
2311 db_init; 3159 db_init;
2312 load_extensions; 3160 load_extensions;
2313 3161
2314 $TICK_WATCHER->start; 3162 $TICK_WATCHER->start;
2315 Event::loop; 3163 Event::loop;
2331 }, 3179 },
2332 ); 3180 );
2333 } 3181 }
2334} 3182}
2335 3183
3184sub write_runtime {
3185 my $runtime = "$LOCALDIR/runtime";
3186
3187 # first touch the runtime file to show we are still running:
3188 # the fsync below can take a very very long time.
3189
3190 IO::AIO::aio_utime $runtime, undef, undef;
3191
3192 my $guard = cf::lock_acquire "write_runtime";
3193
3194 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3195 or return;
3196
3197 my $value = $cf::RUNTIME + 90 + 10;
3198 # 10 is the runtime save interval, for a monotonic clock
3199 # 60 allows for the watchdog to kill the server.
3200
3201 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3202 and return;
3203
3204 # always fsync - this file is important
3205 aio_fsync $fh
3206 and return;
3207
3208 # touch it again to show we are up-to-date
3209 aio_utime $fh, undef, undef;
3210
3211 close $fh
3212 or return;
3213
3214 aio_rename "$runtime~", $runtime
3215 and return;
3216
3217 warn "runtime file written.\n";
3218
3219 1
3220}
3221
2336sub emergency_save() { 3222sub emergency_save() {
2337 my $freeze_guard = cf::freeze_mainloop; 3223 my $freeze_guard = cf::freeze_mainloop;
2338 3224
2339 warn "enter emergency perl save\n"; 3225 warn "enter emergency perl save\n";
2340 3226
2371 3257
2372 warn Carp::longmess "post_cleanup backtrace" 3258 warn Carp::longmess "post_cleanup backtrace"
2373 if $make_core; 3259 if $make_core;
2374} 3260}
2375 3261
2376sub reload() { 3262sub do_reload_perl() {
2377 # can/must only be called in main 3263 # can/must only be called in main
2378 if ($Coro::current != $Coro::main) { 3264 if ($Coro::current != $Coro::main) {
2379 warn "can only reload from main coroutine"; 3265 warn "can only reload from main coroutine";
2380 return; 3266 return;
2381 } 3267 }
2406 Coro::cede; 3292 Coro::cede;
2407 last unless IO::AIO::nreqs || BDB::nreqs; 3293 last unless IO::AIO::nreqs || BDB::nreqs;
2408 warn "iterate..."; 3294 warn "iterate...";
2409 } 3295 }
2410 3296
3297 ++$RELOAD;
3298
2411 warn "cancelling all extension coros"; 3299 warn "cancelling all extension coros";
2412 $_->cancel for values %EXT_CORO; 3300 $_->cancel for values %EXT_CORO;
2413 %EXT_CORO = (); 3301 %EXT_CORO = ();
2414 3302
2415 warn "removing commands"; 3303 warn "removing commands";
2416 %COMMAND = (); 3304 %COMMAND = ();
2417 3305
2418 warn "removing ext commands"; 3306 warn "removing ext/exti commands";
2419 %EXTCMD = (); 3307 %EXTCMD = ();
3308 %EXTICMD = ();
2420 3309
2421 warn "unloading/nuking all extensions"; 3310 warn "unloading/nuking all extensions";
2422 for my $pkg (@EXTS) { 3311 for my $pkg (@EXTS) {
2423 warn "... unloading $pkg"; 3312 warn "... unloading $pkg";
2424 3313
2454 Symbol::delete_package "safe::$_" 3343 Symbol::delete_package "safe::$_"
2455 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3344 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2456 3345
2457 warn "unloading cf.pm \"a bit\""; 3346 warn "unloading cf.pm \"a bit\"";
2458 delete $INC{"cf.pm"}; 3347 delete $INC{"cf.pm"};
3348 delete $INC{"cf/pod.pm"};
2459 3349
2460 # don't, removes xs symbols, too, 3350 # don't, removes xs symbols, too,
2461 # and global variables created in xs 3351 # and global variables created in xs
2462 #Symbol::delete_package __PACKAGE__; 3352 #Symbol::delete_package __PACKAGE__;
2463 3353
2466 warn "reloading cf.pm"; 3356 warn "reloading cf.pm";
2467 require cf; 3357 require cf;
2468 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3358 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2469 3359
2470 warn "loading config and database again"; 3360 warn "loading config and database again";
2471 cf::cfg_load; 3361 cf::reload_config;
2472 3362
2473 warn "loading extensions"; 3363 warn "loading extensions";
2474 cf::load_extensions; 3364 cf::load_extensions;
2475 3365
2476 warn "reattaching attachments to objects/players"; 3366 warn "reattaching attachments to objects/players";
2477 _global_reattach; 3367 _global_reattach; # objects, sockets
2478 warn "reattaching attachments to maps"; 3368 warn "reattaching attachments to maps";
2479 reattach $_ for values %MAP; 3369 reattach $_ for values %MAP;
2480 3370 warn "reattaching attachments to players";
2481 warn "loading reloadable resources"; 3371 reattach $_ for values %PLAYER;
2482 init_resources;
2483 3372
2484 warn "leaving sync_job"; 3373 warn "leaving sync_job";
2485 3374
2486 1 3375 1
2487 } or do { 3376 } or do {
2493 warn "reloaded"; 3382 warn "reloaded";
2494}; 3383};
2495 3384
2496our $RELOAD_WATCHER; # used only during reload 3385our $RELOAD_WATCHER; # used only during reload
2497 3386
3387sub reload_perl() {
3388 # doing reload synchronously and two reloads happen back-to-back,
3389 # coro crashes during coro_state_free->destroy here.
3390
3391 $RELOAD_WATCHER ||= Event->timer (
3392 reentrant => 0,
3393 after => 0,
3394 data => WF_AUTOCANCEL,
3395 cb => sub {
3396 do_reload_perl;
3397 undef $RELOAD_WATCHER;
3398 },
3399 );
3400}
3401
2498register_command "reload" => sub { 3402register_command "reload" => sub {
2499 my ($who, $arg) = @_; 3403 my ($who, $arg) = @_;
2500 3404
2501 if ($who->flag (FLAG_WIZ)) { 3405 if ($who->flag (FLAG_WIZ)) {
2502 $who->message ("reloading server."); 3406 $who->message ("reloading server.");
2503 3407 async { reload_perl };
2504 # doing reload synchronously and two reloads happen back-to-back,
2505 # coro crashes during coro_state_free->destroy here.
2506
2507 $RELOAD_WATCHER ||= Event->timer (
2508 reentrant => 0,
2509 after => 0,
2510 data => WF_AUTOCANCEL,
2511 cb => sub {
2512 reload;
2513 undef $RELOAD_WATCHER;
2514 },
2515 );
2516 } 3408 }
2517}; 3409};
2518 3410
2519unshift @INC, $LIBDIR; 3411unshift @INC, $LIBDIR;
2520 3412
2521my $bug_warning = 0; 3413my $bug_warning = 0;
2522 3414
3415our @WAIT_FOR_TICK;
3416our @WAIT_FOR_TICK_BEGIN;
3417
3418sub wait_for_tick {
3419 return unless $TICK_WATCHER->is_active;
3420 return if $Coro::current == $Coro::main;
3421
3422 my $signal = new Coro::Signal;
3423 push @WAIT_FOR_TICK, $signal;
3424 $signal->wait;
3425}
3426
3427sub wait_for_tick_begin {
3428 return unless $TICK_WATCHER->is_active;
3429 return if $Coro::current == $Coro::main;
3430
3431 my $signal = new Coro::Signal;
3432 push @WAIT_FOR_TICK_BEGIN, $signal;
3433 $signal->wait;
3434}
3435
3436 my $min = 1e6;#d#
3437 my $avg = 10;
2523$TICK_WATCHER = Event->timer ( 3438$TICK_WATCHER = Event->timer (
2524 reentrant => 0, 3439 reentrant => 0,
2525 parked => 1, 3440 parked => 1,
2526 prio => 0, 3441 prio => 0,
2527 at => $NEXT_TICK || $TICK, 3442 at => $NEXT_TICK || $TICK,
2531 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3446 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2532 unless ++$bug_warning > 10; 3447 unless ++$bug_warning > 10;
2533 return; 3448 return;
2534 } 3449 }
2535 3450
2536 $NOW = Event::time; 3451 $NOW = $tick_start = Event::time;
2537 3452
2538 cf::server_tick; # one server iteration 3453 cf::server_tick; # one server iteration
3454
3455 0 && sync_job {#d#
3456 for(1..10) {
3457 my $t = Event::time;
3458 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3459 or die;
3460
3461 $map->width (50);
3462 $map->height (50);
3463 $map->alloc;
3464 $map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
3465 my $t = Event::time - $t;
3466
3467 #next unless $t < 0.0013;#d#
3468 if ($t < $min) {
3469 $min = $t;
3470 }
3471 $avg = $avg * 0.99 + $t * 0.01;
3472 }
3473 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3474 exit 0;
3475 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3476 };
3477
2539 $RUNTIME += $TICK; 3478 $RUNTIME += $TICK;
2540 $NEXT_TICK += $TICK; 3479 $NEXT_TICK += $TICK;
2541 3480
2542 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3481 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2543 $NEXT_RUNTIME_WRITE = $NOW + 10; 3482 $NEXT_RUNTIME_WRITE = $NOW + 10;
2545 write_runtime 3484 write_runtime
2546 or warn "ERROR: unable to write runtime file: $!"; 3485 or warn "ERROR: unable to write runtime file: $!";
2547 }; 3486 };
2548 } 3487 }
2549 3488
2550 $WAIT_FOR_TICK->broadcast;
2551 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2552
2553# my $AFTER = Event::time; 3489# my $AFTER = Event::time;
2554# warn $AFTER - $NOW;#d# 3490# warn $AFTER - $NOW;#d#
2555 3491
3492 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3493 $sig->send;
3494 }
3495 while (my $sig = shift @WAIT_FOR_TICK) {
3496 $sig->send;
3497 }
3498
3499 $NOW = Event::time;
3500
2556 # if we are delayed by four ticks or more, skip them all 3501 # if we are delayed by four ticks or more, skip them all
2557 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3502 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2558 3503
2559 $TICK_WATCHER->at ($NEXT_TICK); 3504 $TICK_WATCHER->at ($NEXT_TICK);
2560 $TICK_WATCHER->start; 3505 $TICK_WATCHER->start;
3506
3507 $LOAD = ($NOW - $tick_start) / $TICK;
3508 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3509
3510 _post_tick;
3511
3512
2561 }, 3513 },
2562); 3514);
2563 3515
2564{ 3516{
2565 BDB::max_poll_time $TICK * 0.1; 3517 BDB::max_poll_time $TICK * 0.1;
2593 3545
2594 cf::sync_job { 3546 cf::sync_job {
2595 eval { 3547 eval {
2596 BDB::db_env_open 3548 BDB::db_env_open
2597 $DB_ENV, 3549 $DB_ENV,
2598 $BDB_ENV_DIR, 3550 $BDBDIR,
2599 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3551 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2600 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3552 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2601 0666; 3553 0666;
2602 3554
2603 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3555 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2604 3556
2605 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3557 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2606 $DB_ENV->set_lk_detect; 3558 $DB_ENV->set_lk_detect;
2607 }; 3559 };
2608 3560
2624 prio => 6, 3576 prio => 6,
2625 cb => \&IO::AIO::poll_cb, 3577 cb => \&IO::AIO::poll_cb,
2626 ); 3578 );
2627} 3579}
2628 3580
3581my $_log_backtrace;
3582
3583sub _log_backtrace {
3584 my ($msg, @addr) = @_;
3585
3586 $msg =~ s/\n//;
3587
3588 # limit the # of concurrent backtraces
3589 if ($_log_backtrace < 2) {
3590 ++$_log_backtrace;
3591 async {
3592 my @bt = fork_call {
3593 @addr = map { sprintf "%x", $_ } @addr;
3594 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3595 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3596 or die "addr2line: $!";
3597
3598 my @funcs;
3599 my @res = <$fh>;
3600 chomp for @res;
3601 while (@res) {
3602 my ($func, $line) = splice @res, 0, 2, ();
3603 push @funcs, "[$func] $line";
3604 }
3605
3606 @funcs
3607 };
3608
3609 LOG llevInfo, "[ABT] $msg\n";
3610 LOG llevInfo, "[ABT] $_\n" for @bt;
3611 --$_log_backtrace;
3612 };
3613 } else {
3614 LOG llevInfo, "[ABT] $msg\n";
3615 LOG llevInfo, "[ABT] [suppressed]\n";
3616 }
3617}
3618
3619# load additional modules
3620use cf::pod;
3621
2629END { cf::emergency_save } 3622END { cf::emergency_save }
2630 3623
26311 36241
2632 3625

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines