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.171 by root, Sun Jan 14 12:24:48 2007 UTC vs.
Revision 1.374 by root, Wed Sep 19 22:07:16 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines