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.216 by root, Thu Feb 15 14:30:21 2007 UTC vs.
Revision 1.364 by root, Tue Sep 11 08:41:11 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines