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.166 by root, Sat Jan 13 23:06:13 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;
78our $AIO_POLL_WATCHER;
79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
49our $NEXT_TICK; 80our $NEXT_TICK;
50our $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;
51 89
52our %CFG; 90our %CFG;
53 91
54our $UPTIME; $UPTIME ||= time; 92our $UPTIME; $UPTIME ||= time;
55our $RUNTIME; 93our $RUNTIME;
56 94
57our %PLAYER; # all users 95our (%PLAYER, %PLAYER_LOADING); # all users
58our %MAP; # all maps 96our (%MAP, %MAP_LOADING ); # all maps
59our $LINK_MAP; # the special {link} map, which is always available 97our $LINK_MAP; # the special {link} map, which is always available
60our $RANDOM_MAPS = cf::localdir . "/random";
61
62our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
63our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
64 98
65# 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 ∕
66our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 100our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
67 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
68binmode STDOUT; 106binmode STDOUT;
69binmode STDERR; 107binmode STDERR;
70 108
71# read virtual server time, if available 109# read virtual server time, if available
72unless ($RUNTIME || !-e cf::localdir . "/runtime") { 110unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
73 open my $fh, "<", cf::localdir . "/runtime" 111 open my $fh, "<", "$LOCALDIR/runtime"
74 or die "unable to read runtime file: $!"; 112 or die "unable to read runtime file: $!";
75 $RUNTIME = <$fh> + 0.; 113 $RUNTIME = <$fh> + 0.;
76} 114}
77 115
78mkdir cf::localdir; 116mkdir $_
79mkdir cf::localdir . "/" . cf::playerdir; 117 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
80mkdir cf::localdir . "/" . cf::tmpdir;
81mkdir cf::localdir . "/" . cf::uniquedir;
82mkdir $RANDOM_MAPS;
83 118
84our $EMERGENCY_POSITION; 119our $EMERGENCY_POSITION;
120
121sub cf::map::normalise;
85 122
86############################################################################# 123#############################################################################
87 124
88=head2 GLOBAL VARIABLES 125=head2 GLOBAL VARIABLES
89 126
96=item $cf::RUNTIME 133=item $cf::RUNTIME
97 134
98The 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
99every server tick. 136every server tick.
100 137
101=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
102 141
103The perl library directory, where extensions and cf-specific modules can 142Various directories - "/etc", read-only install directory, perl-library
104be 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.
105 146
106=item $cf::NOW 147=item $cf::NOW
107 148
108The time of the last (current) server tick. 149The time of the last (current) server tick.
109 150
110=item $cf::TICK 151=item $cf::TICK
111 152
112The 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.
113 164
114=item %cf::CFG 165=item %cf::CFG
115 166
116Configuration for the server, loaded from C</etc/crossfire/config>, or 167Configuration for the server, loaded from C</etc/crossfire/config>, or
117from wherever your confdir points to. 168from wherever your confdir points to.
118 169
119=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 170=item cf::wait_for_tick, cf::wait_for_tick_begin
120 171
121These 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
122or 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
123processing 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.
124window 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.
125 181
126=back 182=back
127 183
128=cut 184=cut
129 185
130BEGIN { 186BEGIN {
131 *CORE::GLOBAL::warn = sub { 187 *CORE::GLOBAL::warn = sub {
132 my $msg = join "", @_; 188 my $msg = join "", @_;
133 utf8::encode $msg;
134 189
135 $msg .= "\n" 190 $msg .= "\n"
136 unless $msg =~ /\n$/; 191 unless $msg =~ /\n$/;
192
193 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
137 194
138 LOG llevError, $msg; 195 LOG llevError, $msg;
139 }; 196 };
140} 197}
141 198
142@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 199@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
143@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 200@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
144@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 201@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
145@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 202@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
146@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';
147@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)
148 206
149# 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
150# within the Safe compartment. 208# within the Safe compartment.
151for my $pkg (qw( 209for my $pkg (qw(
152 cf::global cf::attachable 210 cf::global cf::attachable
160} 218}
161 219
162$Event::DIED = sub { 220$Event::DIED = sub {
163 warn "error in event callback: @_"; 221 warn "error in event callback: @_";
164}; 222};
223
224#############################################################################
165 225
166=head2 UTILITY FUNCTIONS 226=head2 UTILITY FUNCTIONS
167 227
168=over 4 228=over 4
169 229
188 $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;
189 $d 249 $d
190 } || "[unable to dump $_[0]: '$@']"; 250 } || "[unable to dump $_[0]: '$@']";
191} 251}
192 252
193use JSON::Syck (); # TODO# replace by JSON::PC once working
194
195=item $ref = cf::from_json $json 253=item $ref = cf::from_json $json
196 254
197Converts a JSON string into the corresponding perl data structure. 255Converts a JSON string into the corresponding perl data structure.
198 256
199=cut
200
201sub from_json($) {
202 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
203 JSON::Syck::Load $_[0]
204}
205
206=item $json = cf::to_json $ref 257=item $json = cf::to_json $ref
207 258
208Converts a perl data structure into its JSON representation. 259Converts a perl data structure into its JSON representation.
209 260
210=cut 261=cut
211 262
212sub to_json($) { 263our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
213 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 264
214 JSON::Syck::Dump $_[0] 265sub to_json ($) { $json_coder->encode ($_[0]) }
215} 266sub from_json ($) { $json_coder->decode ($_[0]) }
216 267
217=item cf::lock_wait $string 268=item cf::lock_wait $string
218 269
219Wait until the given lock is available. See cf::lock_acquire. 270Wait until the given lock is available. See cf::lock_acquire.
220 271
223Wait 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
224a 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,
225for example when the coroutine gets canceled), the lock is automatically 276for example when the coroutine gets canceled), the lock is automatically
226returned. 277returned.
227 278
279Locks are *not* recursive, locking from the same coro twice results in a
280deadlocked coro.
281
228Lock 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
229uses map_find and cf::map::load uses map_load). 283uses map_find and cf::map::load uses map_load).
230 284
285=item $locked = cf::lock_active $string
286
287Return true if the lock is currently active, i.e. somebody has locked it.
288
231=cut 289=cut
232 290
233our %LOCK; 291our %LOCK;
292our %LOCKER;#d#
234 293
235sub lock_wait($) { 294sub lock_wait($) {
236 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#
237 301
238 # wait for lock, if any 302 # wait for lock, if any
239 while ($LOCK{$key}) { 303 while ($LOCK{$key}) {
240 push @{ $LOCK{$key} }, $Coro::current; 304 push @{ $LOCK{$key} }, $Coro::current;
241 Coro::schedule; 305 Coro::schedule;
247 311
248 # wait, to be sure we are not locked 312 # wait, to be sure we are not locked
249 lock_wait $key; 313 lock_wait $key;
250 314
251 $LOCK{$key} = []; 315 $LOCK{$key} = [];
316 $LOCKER{$key} = $Coro::current;#d#
252 317
253 Coro::guard { 318 Coro::guard {
319 delete $LOCKER{$key};#d#
254 # wake up all waiters, to be on the safe side 320 # wake up all waiters, to be on the safe side
255 $_->ready for @{ delete $LOCK{$key} }; 321 $_->ready for @{ delete $LOCK{$key} };
256 } 322 }
257} 323}
258 324
325sub lock_active($) {
326 my ($key) = @_;
327
328 ! ! $LOCK{$key}
329}
330
259sub freeze_mainloop { 331sub freeze_mainloop {
260 return unless $TICK_WATCHER->is_active; 332 return unless $TICK_WATCHER->is_active;
261 333
262 my $guard = Coro::guard { $TICK_WATCHER->start }; 334 my $guard = Coro::guard {
335 $TICK_WATCHER->start;
336 };
263 $TICK_WATCHER->stop; 337 $TICK_WATCHER->stop;
264 $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;
265} 397}
266 398
267=item cf::async { BLOCK } 399=item cf::async { BLOCK }
268 400
269Currently the same as Coro::async_pool, meaning you cannot use 401Currently the same as Coro::async_pool, meaning you cannot use
274 406
275BEGIN { *async = \&Coro::async_pool } 407BEGIN { *async = \&Coro::async_pool }
276 408
277=item cf::sync_job { BLOCK } 409=item cf::sync_job { BLOCK }
278 410
279The design of crossfire+ requires that the main coro ($Coro::main) is 411The design of Crossfire TRT requires that the main coroutine ($Coro::main)
280always able to handle events or runnable, as crossfire+ is only partly 412is always able to handle events or runnable, as Crossfire TRT is only
281reentrant. 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.
282 415
283If 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
284the given BLOCK in another coroutine while waiting for the result. The 417the given BLOCK in another coroutine while waiting for the result. The
285server 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
286fast or be very important. 419fast or be very important.
289 422
290sub sync_job(&) { 423sub sync_job(&) {
291 my ($job) = @_; 424 my ($job) = @_;
292 425
293 if ($Coro::current == $Coro::main) { 426 if ($Coro::current == $Coro::main) {
427 my $time = Event::time;
428
294 # this is the main coro, too bad, we have to block 429 # this is the main coro, too bad, we have to block
295 # till the operation succeeds, freezing the server :/ 430 # till the operation succeeds, freezing the server :/
296 431
297 # TODO: use suspend/resume instead 432 # TODO: use suspend/resume instead
298 # (but this is cancel-safe) 433 # (but this is cancel-safe)
300 435
301 my $busy = 1; 436 my $busy = 1;
302 my @res; 437 my @res;
303 438
304 (async { 439 (async {
440 $Coro::current->desc ("sync job coro");
305 @res = eval { $job->() }; 441 @res = eval { $job->() };
306 warn $@ if $@; 442 warn $@ if $@;
307 undef $busy; 443 undef $busy;
308 })->prio (Coro::PRIO_MAX); 444 })->prio (Coro::PRIO_MAX);
309 445
310 while ($busy) { 446 while ($busy) {
311 Coro::cede or Event::one_event; 447 Coro::cede or Event::one_event;
312 } 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
313 456
314 wantarray ? @res : $res[0] 457 wantarray ? @res : $res[0]
315 } else { 458 } else {
316 # we are in another coroutine, how wonderful, everything just works 459 # we are in another coroutine, how wonderful, everything just works
317 460
337 $EXT_CORO{$coro+0} = $coro; 480 $EXT_CORO{$coro+0} = $coro;
338 481
339 $coro 482 $coro
340} 483}
341 484
342sub write_runtime { 485=item fork_call { }, $args
343 return unless $TICK_WATCHER->is_active;
344 486
345 my $runtime = cf::localdir . "/runtime"; 487Executes the given code block with the given arguments in a seperate
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.
346 491
347 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 492=cut
348 or return;
349 493
350 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 494sub fork_call(&@) {
351 (aio_write $fh, 0, (length $value), $value, 0) <= 0 495 my ($cb, @args) = @_;
352 and return;
353 496
354 aio_fsync $fh 497 # we seemingly have to make a local copy of the whole thing,
355 and return; 498 # otherwise perl prematurely frees the stuff :/
499 # TODO: investigate and fix (likely this will be rather laborious)
356 500
357 close $fh 501 my @res = Coro::Util::fork_eval {
358 or return; 502 reset_signals;
503 &$cb
504 }, @args;
359 505
360 aio_rename "$runtime~", $runtime 506 wantarray ? @res : $res[-1]
361 and return; 507}
362 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
363 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 });
364} 645}
365 646
366=back 647=back
367 648
368=cut 649=cut
375attach callbacks/event handlers (a collection of which is called an "attachment") 656attach callbacks/event handlers (a collection of which is called an "attachment")
376to it. All such attachable objects support the following methods. 657to it. All such attachable objects support the following methods.
377 658
378In 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>
379C<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
380crossfire+). 661Crossfire TRT).
381 662
382=over 4 663=over 4
383 664
384=item $attachable->attach ($attachment, key => $value...) 665=item $attachable->attach ($attachment, key => $value...)
385 666
499our @CB_TYPE = (); # registry for type (cf-object class) based events 780our @CB_TYPE = (); # registry for type (cf-object class) based events
500our @CB_MAP = (); 781our @CB_MAP = ();
501 782
502my %attachment; 783my %attachment;
503 784
785sub cf::attachable::thawer_merge {
786 # simply override everything except _meta
787 local $_[0]{_meta};
788 %{$_[0]} = %{$_[1]};
789}
790
504sub _attach_cb($$$$) { 791sub _attach_cb($$$$) {
505 my ($registry, $event, $prio, $cb) = @_; 792 my ($registry, $event, $prio, $cb) = @_;
506 793
507 use sort 'stable'; 794 use sort 'stable';
508 795
542 $registry = $CB_TYPE[$object_type] ||= []; 829 $registry = $CB_TYPE[$object_type] ||= [];
543 830
544 } elsif ($type eq "subtype") { 831 } elsif ($type eq "subtype") {
545 defined $object_type or Carp::croak "subtype specified without type"; 832 defined $object_type or Carp::croak "subtype specified without type";
546 my $object_subtype = shift @arg; 833 my $object_subtype = shift @arg;
547 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 834 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
548 835
549 } elsif ($type eq "package") { 836 } elsif ($type eq "package") {
550 my $pkg = shift @arg; 837 my $pkg = shift @arg;
551 838
552 while (my ($name, $id) = each %cb_id) { 839 while (my ($name, $id) = each %cb_id) {
581 _attach $registry, $klass, @attach; 868 _attach $registry, $klass, @attach;
582 } 869 }
583 870
584 $obj->{$name} = \%arg; 871 $obj->{$name} = \%arg;
585 } else { 872 } else {
586 warn "object uses attachment '$name' that is not available, postponing.\n"; 873 warn "object uses attachment '$name' which is not available, postponing.\n";
587 } 874 }
588 875
589 $obj->{_attachment}{$name} = undef; 876 $obj->{_attachment}{$name} = undef;
590} 877}
591 878
593 if (ref $_[0]) { 880 if (ref $_[0]) {
594 _object_attach @_; 881 _object_attach @_;
595 } else { 882 } else {
596 _attach shift->_attach_registry, @_; 883 _attach shift->_attach_registry, @_;
597 } 884 }
885 _recalc_want;
598}; 886};
599 887
600# all those should be optimised 888# all those should be optimised
601sub cf::attachable::detach { 889sub cf::attachable::detach {
602 my ($obj, $name) = @_; 890 my ($obj, $name) = @_;
605 delete $obj->{_attachment}{$name}; 893 delete $obj->{_attachment}{$name};
606 reattach ($obj); 894 reattach ($obj);
607 } else { 895 } else {
608 Carp::croak "cannot, currently, detach class attachments"; 896 Carp::croak "cannot, currently, detach class attachments";
609 } 897 }
898 _recalc_want;
610}; 899};
611 900
612sub cf::attachable::attached { 901sub cf::attachable::attached {
613 my ($obj, $name) = @_; 902 my ($obj, $name) = @_;
614 903
629 "; 918 ";
630 die if $@; 919 die if $@;
631} 920}
632 921
633our $override; 922our $override;
634our @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?
635 924
636sub override { 925sub override {
637 $override = 1; 926 $override = 1;
638 @invoke_results = (); 927 @INVOKE_RESULTS = (@_);
639} 928}
640 929
641sub do_invoke { 930sub do_invoke {
642 my $event = shift; 931 my $event = shift;
643 my $callbacks = shift; 932 my $callbacks = shift;
644 933
645 @invoke_results = (); 934 @INVOKE_RESULTS = ();
646 935
647 local $override; 936 local $override;
648 937
649 for (@$callbacks) { 938 for (@$callbacks) {
650 eval { &{$_->[1]} }; 939 eval { &{$_->[1]} };
667 956
668Generate an object-specific event with the given arguments. 957Generate an object-specific event with the given arguments.
669 958
670This 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
671removed 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
672results (if you must, access C<@cf::invoke_results> directly). 961results (if you must, access C<@cf::INVOKE_RESULTS> directly).
673 962
674=back 963=back
675 964
676=cut 965=cut
677 966
678############################################################################# 967#############################################################################
679# 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}
680 980
681sub reattach { 981sub reattach {
682 # basically do the same as instantiate, without calling instantiate 982 # basically do the same as instantiate, without calling instantiate
683 my ($obj) = @_; 983 my ($obj) = @_;
984
985 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
684 986
685 my $registry = $obj->registry; 987 my $registry = $obj->registry;
686 988
687 @$registry = (); 989 @$registry = ();
688 990
729sub object_freezer_save { 1031sub object_freezer_save {
730 my ($filename, $rdata, $objs) = @_; 1032 my ($filename, $rdata, $objs) = @_;
731 1033
732 sync_job { 1034 sync_job {
733 if (length $$rdata) { 1035 if (length $$rdata) {
1036 utf8::decode (my $decname = $filename);
734 warn sprintf "saving %s (%d,%d)\n", 1037 warn sprintf "saving %s (%d,%d)\n",
735 $filename, length $$rdata, scalar @$objs; 1038 $decname, length $$rdata, scalar @$objs;
736 1039
737 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1040 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
738 chmod SAVE_MODE, $fh; 1041 chmod SAVE_MODE, $fh;
739 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1042 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
740 aio_fsync $fh; 1043 aio_fsync $fh if $cf::USE_FSYNC;
741 close $fh; 1044 close $fh;
742 1045
743 if (@$objs) { 1046 if (@$objs) {
744 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) {
745 chmod SAVE_MODE, $fh; 1048 chmod SAVE_MODE, $fh;
746 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1049 my $data = Storable::nfreeze { version => 1, objs => $objs };
747 aio_write $fh, 0, (length $data), $data, 0; 1050 aio_write $fh, 0, (length $data), $data, 0;
748 aio_fsync $fh; 1051 aio_fsync $fh if $cf::USE_FSYNC;
749 close $fh; 1052 close $fh;
750 aio_rename "$filename.pst~", "$filename.pst"; 1053 aio_rename "$filename.pst~", "$filename.pst";
751 } 1054 }
752 } else { 1055 } else {
753 aio_unlink "$filename.pst"; 1056 aio_unlink "$filename.pst";
759 } 1062 }
760 } else { 1063 } else {
761 aio_unlink $filename; 1064 aio_unlink $filename;
762 aio_unlink "$filename.pst"; 1065 aio_unlink "$filename.pst";
763 } 1066 }
764 } 1067 };
765} 1068}
766 1069
767sub object_freezer_as_string { 1070sub object_freezer_as_string {
768 my ($rdata, $objs) = @_; 1071 my ($rdata, $objs) = @_;
769 1072
781 or return; 1084 or return;
782 1085
783 unless (aio_stat "$filename.pst") { 1086 unless (aio_stat "$filename.pst") {
784 (aio_load "$filename.pst", $av) >= 0 1087 (aio_load "$filename.pst", $av) >= 0
785 or return; 1088 or return;
1089
786 $av = eval { (Storable::thaw $av)->{objs} }; 1090 $av = eval { (Storable::thaw $av)->{objs} };
787 } 1091 }
788 1092
1093 utf8::decode (my $decname = $filename);
789 warn sprintf "loading %s (%d)\n", 1094 warn sprintf "loading %s (%d,%d)\n",
790 $filename, length $data, scalar @{$av || []};#d# 1095 $decname, length $data, scalar @{$av || []};
1096
791 return ($data, $av); 1097 ($data, $av)
792} 1098}
1099
1100=head2 COMMAND CALLBACKS
1101
1102=over 4
1103
1104=cut
793 1105
794############################################################################# 1106#############################################################################
795# command handling &c 1107# command handling &c
796 1108
797=item cf::register_command $name => \&callback($ob,$args); 1109=item cf::register_command $name => \&callback($ob,$args);
810 push @{ $COMMAND{$name} }, [$caller, $cb]; 1122 push @{ $COMMAND{$name} }, [$caller, $cb];
811} 1123}
812 1124
813=item cf::register_extcmd $name => \&callback($pl,$packet); 1125=item cf::register_extcmd $name => \&callback($pl,$packet);
814 1126
815Register 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.
816 1132
817If 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
818called. 1134called.
819 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
820=cut 1147=cut
821 1148
822sub register_extcmd { 1149sub register_extcmd {
823 my ($name, $cb) = @_; 1150 my ($name, $cb) = @_;
824 1151
825 $EXTCMD{$name} = $cb; 1152 $EXTCMD{$name} = $cb;
1153}
1154
1155sub register_exticmd {
1156 my ($name, $cb) = @_;
1157
1158 $EXTICMD{$name} = $cb;
826} 1159}
827 1160
828cf::player->attach ( 1161cf::player->attach (
829 on_command => sub { 1162 on_command => sub {
830 my ($pl, $name, $params) = @_; 1163 my ($pl, $name, $params) = @_;
839 cf::override; 1172 cf::override;
840 }, 1173 },
841 on_extcmd => sub { 1174 on_extcmd => sub {
842 my ($pl, $buf) = @_; 1175 my ($pl, $buf) = @_;
843 1176
844 my $msg = eval { from_json $buf }; 1177 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
845 1178
846 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
847 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1187 if (my $cb = $EXTCMD{$type}) {
848 if (my %reply = $cb->($pl, $msg)) { 1188 @reply = $cb->($pl, @payload);
849 $pl->ext_reply ($msg->{msgid}, %reply);
850 }
851 } 1189 }
1190
1191 $pl->ext_reply ($reply, @reply)
1192 if $reply;
1193
852 } else { 1194 } else {
853 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1195 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
854 } 1196 }
855 1197
856 cf::override; 1198 cf::override;
857 }, 1199 },
858); 1200);
859 1201
860sub load_extension {
861 my ($path) = @_;
862
863 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
864 my $base = $1;
865 my $pkg = $1;
866 $pkg =~ s/[^[:word:]]/_/g;
867 $pkg = "ext::$pkg";
868
869 warn "... loading '$path' into '$pkg'\n";
870
871 open my $fh, "<:utf8", $path
872 or die "$path: $!";
873
874 my $source =
875 "package $pkg; use strict; use utf8;\n"
876 . "#line 1 \"$path\"\n{\n"
877 . (do { local $/; <$fh> })
878 . "\n};\n1";
879
880 unless (eval $source) {
881 my $msg = $@ ? "$path: $@\n"
882 : "extension disabled.\n";
883 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
884 warn $@;
885 warn "mandatory extension failed to load, exiting.\n";
886 exit 1;
887 }
888 die $@;
889 }
890
891 push @EXTS, $pkg;
892}
893
894sub load_extensions { 1202sub load_extensions {
1203 cf::sync_job {
1204 my %todo;
1205
895 for my $ext (<$LIBDIR/*.ext>) { 1206 for my $path (<$LIBDIR/*.ext>) {
896 next unless -r $ext; 1207 next unless -r $path;
897 eval { 1208
898 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;
899 1 1266 }
900 } or warn "$ext not loaded: $@"; 1267
1268 skip:
1269 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1270 unless $progress;
1271 }
901 } 1272 };
902} 1273}
903 1274
904############################################################################# 1275#############################################################################
905# load/save/clean perl data associated with a map
906 1276
907*cf::mapsupport::on_clean = sub { 1277=back
908 my ($map) = @_;
909
910 my $path = $map->tmpname;
911 defined $path or return;
912
913 unlink "$path.pst";
914};
915
916cf::map->attach (prio => -10000, package => cf::mapsupport::);
917
918#############################################################################
919 1278
920=head2 CORE EXTENSIONS 1279=head2 CORE EXTENSIONS
921 1280
922Functions and methods that extend core crossfire objects. 1281Functions and methods that extend core crossfire objects.
923 1282
929 1288
930=head3 cf::player 1289=head3 cf::player
931 1290
932=over 4 1291=over 4
933 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
934=item cf::player::find $login 1307=item cf::player::find $login
935 1308
936Returns the given player object, loading it if necessary (might block). 1309Returns the given player object, loading it if necessary (might block).
937 1310
938=cut 1311=cut
939 1312
940sub playerdir($) { 1313sub playerdir($) {
941 cf::localdir 1314 "$PLAYERDIR/"
942 . "/"
943 . cf::playerdir
944 . "/"
945 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1315 . (ref $_[0] ? $_[0]->ob->name : $_[0])
946} 1316}
947 1317
948sub path($) { 1318sub path($) {
949 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1319 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
950 1320
951 (playerdir $login) . "/$login.pl" 1321 (playerdir $login) . "/playerdata"
952} 1322}
953 1323
954sub find_active($) { 1324sub find_active($) {
955 $cf::PLAYER{$_[0]} 1325 $cf::PLAYER{$_[0]}
956 and $cf::PLAYER{$_[0]}->active 1326 and $cf::PLAYER{$_[0]}->active
959 1329
960sub exists($) { 1330sub exists($) {
961 my ($login) = @_; 1331 my ($login) = @_;
962 1332
963 $cf::PLAYER{$login} 1333 $cf::PLAYER{$login}
964 or cf::sync_job { !aio_stat $login } 1334 or cf::sync_job { !aio_stat path $login }
965} 1335}
966 1336
967sub find($) { 1337sub find($) {
968 return $cf::PLAYER{$_[0]} || do { 1338 return $cf::PLAYER{$_[0]} || do {
969 my $login = $_[0]; 1339 my $login = $_[0];
970 1340
971 my $guard = cf::lock_acquire "user_find:$login"; 1341 my $guard = cf::lock_acquire "user_find:$login";
972 1342
973 $cf::PLAYER{$_[0]} || do { 1343 $cf::PLAYER{$_[0]} || do {
974 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
975 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;
976 $cf::PLAYER{$login} = $pl 1358 $cf::PLAYER{$login} = $pl
977 } 1359 }
978 } 1360 }
979} 1361}
980 1362
990 1372
991 aio_mkdir playerdir $pl, 0770; 1373 aio_mkdir playerdir $pl, 0770;
992 $pl->{last_save} = $cf::RUNTIME; 1374 $pl->{last_save} = $cf::RUNTIME;
993 1375
994 $pl->save_pl ($path); 1376 $pl->save_pl ($path);
995 Coro::cede; 1377 cf::cede_to_tick;
996} 1378}
997 1379
998sub new($) { 1380sub new($) {
999 my ($login) = @_; 1381 my ($login) = @_;
1000 1382
1006 $cf::PLAYER{$login} = $self; 1388 $cf::PLAYER{$login} = $self;
1007 1389
1008 $self 1390 $self
1009} 1391}
1010 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
1011=item $pl->quit_character 1403=item $pl->quit_character
1012 1404
1013Nukes the player without looking back. If logged in, the connection will 1405Nukes the player without looking back. If logged in, the connection will
1014be destroyed. May block for a long time. 1406be destroyed. May block for a long time.
1015 1407
1016=cut 1408=cut
1017 1409
1018sub quit_character { 1410sub quit_character {
1019 my ($pl) = @_; 1411 my ($pl) = @_;
1412
1413 my $name = $pl->ob->name;
1020 1414
1021 $pl->{deny_save} = 1; 1415 $pl->{deny_save} = 1;
1022 $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
1023 1417
1024 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1418 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1029 my $path = playerdir $pl; 1423 my $path = playerdir $pl;
1030 my $temp = "$path~$cf::RUNTIME~deleting~"; 1424 my $temp = "$path~$cf::RUNTIME~deleting~";
1031 aio_rename $path, $temp; 1425 aio_rename $path, $temp;
1032 delete $cf::PLAYER{$pl->ob->name}; 1426 delete $cf::PLAYER{$pl->ob->name};
1033 $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
1034 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;
1035} 1449}
1036 1450
1037=item cf::player::list_logins 1451=item cf::player::list_logins
1038 1452
1039Returns 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
1040while and may block, so not sync_job-capable, ever. 1454while and may block, so not sync_job-capable, ever.
1041 1455
1042=cut 1456=cut
1043 1457
1044sub list_logins { 1458sub list_logins {
1045 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1459 my $dirs = aio_readdir $PLAYERDIR
1046 or return []; 1460 or return [];
1047 1461
1048 my @logins; 1462 my @logins;
1049 1463
1050 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") {
1051 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1469 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1052 aio_read $fh, 0, 512, my $buf, 0 or next; 1470 aio_read $fh, 0, 512, my $buf, 0 or next;
1053 $buf !~ /^password -------------$/m or next; # official not-valid tag 1471 $buf !~ /^password -------------$/m or next; # official not-valid tag
1472 }
1054 1473
1055 utf8::decode $login; 1474 utf8::decode $login;
1056 push @logins, $login; 1475 push @logins, $login;
1057 } 1476 }
1058 1477
1066 1485
1067=cut 1486=cut
1068 1487
1069sub maps($) { 1488sub maps($) {
1070 my ($pl) = @_; 1489 my ($pl) = @_;
1490
1491 $pl = ref $pl ? $pl->ob->name : $pl;
1071 1492
1072 my $files = aio_readdir playerdir $pl 1493 my $files = aio_readdir playerdir $pl
1073 or return; 1494 or return;
1074 1495
1075 my @paths; 1496 my @paths;
1077 for (@$files) { 1498 for (@$files) {
1078 utf8::decode $_; 1499 utf8::decode $_;
1079 next if /\.(?:pl|pst)$/; 1500 next if /\.(?:pl|pst)$/;
1080 next unless /^$PATH_SEP/o; 1501 next unless /^$PATH_SEP/o;
1081 1502
1082 push @paths, "~" . $pl->ob->name . "/" . $_; 1503 push @paths, cf::map::normalise "~$pl/$_";
1083 } 1504 }
1084 1505
1085 \@paths 1506 \@paths
1086} 1507}
1087 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
1088=item $player->ext_reply ($msgid, $msgtype, %msg) 1560=item $player->ext_reply ($msgid, @msg)
1089 1561
1090Sends an ext reply to the player. 1562Sends an ext reply to the player.
1091 1563
1092=cut 1564=cut
1093 1565
1094sub ext_reply($$$%) { 1566sub ext_reply($$@) {
1095 my ($self, $id, %msg) = @_; 1567 my ($self, $id, @msg) = @_;
1096 1568
1097 $msg{msgid} = $id; 1569 $self->ns->ext_reply ($id, @msg)
1098
1099 $self->send ("ext " . cf::to_json \%msg);
1100} 1570}
1101 1571
1102package 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}
1103 1612
1104=back 1613=back
1105
1106 1614
1107=head3 cf::map 1615=head3 cf::map
1108 1616
1109=over 4 1617=over 4
1110 1618
1114 1622
1115use Fcntl; 1623use Fcntl;
1116use Coro::AIO; 1624use Coro::AIO;
1117 1625
1118use overload 1626use overload
1119 '""' => \&as_string; 1627 '""' => \&as_string,
1628 fallback => 1;
1120 1629
1121our $MAX_RESET = 3600; 1630our $MAX_RESET = 3600;
1122our $DEFAULT_RESET = 3000; 1631our $DEFAULT_RESET = 3000;
1123 1632
1124sub generate_random_map { 1633sub generate_random_map {
1125 my ($self, $rmp) = @_; 1634 my ($self, $rmp) = @_;
1126
1127 # mit "rum" bekleckern, nicht 1635 # mit "rum" bekleckern, nicht
1128 $self->_create_random_map ( 1636 $self->_create_random_map (
1129 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1637 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1130 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1638 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1131 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1639 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1138 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1646 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1139 (cf::region::find $rmp->{region}), $rmp->{custom} 1647 (cf::region::find $rmp->{region}), $rmp->{custom}
1140 ) 1648 )
1141} 1649}
1142 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
1143sub register { 1659sub register {
1144 my (undef, $regex) = @_; 1660 my (undef, $regex, $prio) = @_;
1145 my $pkg = caller; 1661 my $pkg = caller;
1146 1662
1147 no strict; 1663 no strict;
1148 push @{"$pkg\::ISA"}, __PACKAGE__; 1664 push @{"$pkg\::ISA"}, __PACKAGE__;
1149 1665
1150 $EXT_MAP{$pkg} = qr<$regex>; 1666 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1151} 1667}
1152 1668
1153# also paths starting with '/' 1669# also paths starting with '/'
1154$EXT_MAP{"cf::map"} = qr{^(?=/)}; 1670$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1671
1672sub thawer_merge {
1673 my ($self, $merge) = @_;
1674
1675 # we have to keep some variables in memory intact
1676 local $self->{path};
1677 local $self->{load_path};
1678
1679 $self->SUPER::thawer_merge ($merge);
1680}
1155 1681
1156sub normalise { 1682sub normalise {
1157 my ($path, $base) = @_; 1683 my ($path, $base) = @_;
1684
1685 $path = "$path"; # make sure its a string
1686
1687 $path =~ s/\.map$//;
1158 1688
1159 # map plan: 1689 # map plan:
1160 # 1690 #
1161 # /! non-realised random map exit (special hack!) 1691 # /! non-realised random map exit (special hack!)
1162 # {... are special paths that are not being touched 1692 # {... are special paths that are not being touched
1190 1720
1191 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
1192 1722
1193 $path = normalise $path, $base; 1723 $path = normalise $path, $base;
1194 1724
1195 for my $pkg (keys %EXT_MAP) { 1725 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1196 if ($path =~ $EXT_MAP{$pkg}) { 1726 if ($path =~ $EXT_MAP{$pkg}[1]) {
1197 my $self = bless cf::map::new, $pkg; 1727 my $self = bless cf::map::new, $pkg;
1198 $self->{path} = $path; $self->path ($path); 1728 $self->{path} = $path; $self->path ($path);
1199 $self->init; # pass $1 etc. 1729 $self->init; # pass $1 etc.
1200 return $self; 1730 return $self;
1201 } 1731 }
1202 } 1732 }
1203 1733
1204 Carp::carp "unable to resolve path '$path'."; 1734 Carp::cluck "unable to resolve path '$path' (base '$base').";
1205 () 1735 ()
1206} 1736}
1207 1737
1208sub init { 1738sub init {
1209 my ($self) = @_; 1739 my ($self) = @_;
1220# the displayed name, this is a one way mapping 1750# the displayed name, this is a one way mapping
1221sub visible_name { 1751sub visible_name {
1222 &as_string 1752 &as_string
1223} 1753}
1224 1754
1225# escape the /'s in the path
1226sub _escaped_path {
1227 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1228
1229 $path
1230}
1231
1232# the original (read-only) location 1755# the original (read-only) location
1233sub load_path { 1756sub load_path {
1234 my ($self) = @_; 1757 my ($self) = @_;
1235 1758
1236 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1759 "$MAPDIR/$self->{path}.map"
1237} 1760}
1238 1761
1239# the temporary/swap location 1762# the temporary/swap location
1240sub save_path { 1763sub save_path {
1241 my ($self) = @_; 1764 my ($self) = @_;
1242 1765
1243 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $self->_escaped_path 1766 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1767 "$TMPDIR/$path.map"
1244} 1768}
1245 1769
1246# the unique path, undef == no special unique path 1770# the unique path, undef == no special unique path
1247sub uniq_path { 1771sub uniq_path {
1248 my ($self) = @_; 1772 my ($self) = @_;
1249 1773
1250 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path 1774 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1775 "$UNIQUEDIR/$path"
1251} 1776}
1252 1777
1253# and all this just because we cannot iterate over 1778# and all this just because we cannot iterate over
1254# all maps in C++... 1779# all maps in C++...
1255sub change_all_map_light { 1780sub change_all_map_light {
1257 1782
1258 $_->change_map_light ($change) 1783 $_->change_map_light ($change)
1259 for grep $_->outdoor, values %cf::MAP; 1784 for grep $_->outdoor, values %cf::MAP;
1260} 1785}
1261 1786
1787sub decay_objects {
1788 my ($self) = @_;
1789
1790 return if $self->{deny_reset};
1791
1792 $self->do_decay_objects;
1793}
1794
1262sub unlink_save { 1795sub unlink_save {
1263 my ($self) = @_; 1796 my ($self) = @_;
1264 1797
1265 utf8::encode (my $save = $self->save_path); 1798 utf8::encode (my $save = $self->save_path);
1266 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save; 1799 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1267 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst"; 1800 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1268} 1801}
1269 1802
1270sub load_header_from($) { 1803sub load_header_from($) {
1271 my ($self, $path) = @_; 1804 my ($self, $path) = @_;
1272 1805
1273 utf8::encode $path; 1806 utf8::encode $path;
1274 aio_open $path, O_RDONLY, 0 1807 my $f = new_from_file cf::object::thawer $path
1275 or return; 1808 or return;
1276 1809
1277 $self->_load_header ($path) 1810 $self->_load_header ($f)
1278 or return; 1811 or return;
1279 1812
1813 local $MAP_LOADING{$self->{path}} = $self;
1814 $f->resolve_delayed_derefs;
1815
1280 $self->{load_path} = $path; 1816 $self->{load_path} = $path;
1281 1817
1282 1 1818 1
1283} 1819}
1284 1820
1285sub load_orig { 1821sub load_header_orig {
1286 my ($self) = @_; 1822 my ($self) = @_;
1287 1823
1288 $self->load_header_from ($self->load_path) 1824 $self->load_header_from ($self->load_path)
1289} 1825}
1290 1826
1291sub load_temp { 1827sub load_header_temp {
1292 my ($self) = @_; 1828 my ($self) = @_;
1293 1829
1294 $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;
1295} 1850}
1296 1851
1297sub load_header { 1852sub load_header {
1298 my ($self) = @_; 1853 my ($self) = @_;
1299 1854
1300 if ($self->load_temp) { 1855 if ($self->load_header_temp) {
1301 $self->last_access ((delete $self->{last_access}) 1856 $self->prepare_temp;
1302 || $cf::RUNTIME); #d#
1303 # safety
1304 $self->{instantiate_time} = $cf::RUNTIME
1305 if $self->{instantiate_time} > $cf::RUNTIME;
1306 } else { 1857 } else {
1307 $self->load_orig 1858 $self->load_header_orig
1308 or return; 1859 or return;
1309 1860 $self->prepare_orig;
1310 $self->{load_original} = 1;
1311 $self->{instantiate_time} = $cf::RUNTIME;
1312 $self->last_access ($cf::RUNTIME);
1313 $self->instantiate;
1314 } 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;
1315 1868
1316 1 1869 1
1317} 1870}
1318 1871
1319sub find; 1872sub find;
1320sub find { 1873sub find {
1321 my ($path, $origin) = @_; 1874 my ($path, $origin) = @_;
1322 1875
1323 $path = normalise $path, $origin && $origin->path; 1876 $path = normalise $path, $origin && $origin->path;
1324 1877
1878 cf::lock_wait "map_data:$path";#d#remove
1325 cf::lock_wait "map_find:$path"; 1879 cf::lock_wait "map_find:$path";
1326 1880
1327 $cf::MAP{$path} || do { 1881 $cf::MAP{$path} || do {
1328 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
1329 my $map = new_from_path cf::map $path 1885 my $map = new_from_path cf::map $path
1330 or return; 1886 or return;
1331 1887
1332 $map->{last_save} = $cf::RUNTIME; 1888 $map->{last_save} = $cf::RUNTIME;
1333 1889
1334 $map->load_header 1890 $map->load_header
1335 or return; 1891 or return;
1336 1892
1337 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
1895 #$cf::WAIT_FOR_TICK->wait;
1896 undef $guard1;
1897 undef $guard2;
1338 $map->reset; 1898 $map->reset;
1339 undef $guard;
1340 $map = find $path 1899 return find $path;
1341 or return;
1342 } 1900 }
1343 1901
1344 $cf::MAP{$path} = $map 1902 $cf::MAP{$path} = $map
1345 } 1903 }
1346} 1904}
1905
1906sub pre_load { }
1907sub post_load { }
1347 1908
1348sub load { 1909sub load {
1349 my ($self) = @_; 1910 my ($self) = @_;
1350 1911
1912 local $self->{deny_reset} = 1; # loading can take a long time
1913
1351 my $path = $self->{path}; 1914 my $path = $self->{path};
1915
1916 {
1352 my $guard = cf::lock_acquire "map_load:$path"; 1917 my $guard = cf::lock_acquire "map_data:$path";
1353 1918
1919 return unless $self->valid;
1354 return if $self->in_memory != cf::MAP_SWAPPED; 1920 return unless $self->in_memory == cf::MAP_SWAPPED;
1355 1921
1356 $self->in_memory (cf::MAP_LOADING); 1922 $self->in_memory (cf::MAP_LOADING);
1357 1923
1358 $self->alloc; 1924 $self->alloc;
1359 $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)
1360 or return; 1932 or return;
1361 1933
1362 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1934 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1363 if delete $self->{load_original}; 1935 if delete $self->{load_original};
1364 1936
1365 if (my $uniq = $self->uniq_path) { 1937 if (my $uniq = $self->uniq_path) {
1366 utf8::encode $uniq; 1938 utf8::encode $uniq;
1367 if (aio_open $uniq, O_RDONLY, 0) { 1939 unless (aio_stat $uniq) {
1940 if (my $f = new_from_file cf::object::thawer $uniq) {
1368 $self->clear_unique_items; 1941 $self->clear_unique_items;
1369 $self->_load_objects ($uniq, 0); 1942 $self->_load_objects ($f);
1943 $f->resolve_delayed_derefs;
1944 }
1370 } 1945 }
1371 } 1946 }
1372 1947
1373 Coro::cede; 1948 $f->resolve_delayed_derefs;
1374 1949
1950 cf::cede_to_tick;
1375 # now do the right thing for maps 1951 # now do the right thing for maps
1376 $self->link_multipart_objects; 1952 $self->link_multipart_objects;
1377
1378 unless ($self->{deny_activate}) {
1379 $self->decay_objects;
1380 $self->fix_auto_apply;
1381 $self->update_buttons;
1382 Coro::cede;
1383 $self->set_darkness_map;
1384 $self->difficulty ($self->estimate_difficulty) 1953 $self->difficulty ($self->estimate_difficulty)
1385 unless $self->difficulty; 1954 unless $self->difficulty;
1386 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;
1387 $self->activate; 1964 $self->activate;
1388 } 1965 }
1389 1966
1967 $self->{last_save} = $cf::RUNTIME;
1968 $self->last_access ($cf::RUNTIME);
1969
1390 $self->in_memory (cf::MAP_IN_MEMORY); 1970 $self->in_memory (cf::MAP_IN_MEMORY);
1971 }
1972
1973 $self->post_load;
1391} 1974}
1392 1975
1393sub customise_for { 1976sub customise_for {
1394 my ($self, $ob) = @_; 1977 my ($self, $ob) = @_;
1395 1978
1396 return find "~" . $ob->name . "/" . $self->{path} 1979 return find "~" . $ob->name . "/" . $self->{path}
1397 if $self->per_player; 1980 if $self->per_player;
1398 1981
1982# return find "?party/" . $ob->name . "/" . $self->{path}
1983# if $self->per_party;
1984
1399 $self 1985 $self
1400} 1986}
1401 1987
1402# 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
1403sub load_diag { 1989sub load_neighbours {
1404 my ($map) = @_; 1990 my ($map) = @_;
1405 1991
1406 my @diag; # diagonal neighbours 1992 my @neigh; # diagonal neighbours
1407 1993
1408 for (0 .. 3) { 1994 for (0 .. 3) {
1409 my $neigh = $map->tile_path ($_) 1995 my $neigh = $map->tile_path ($_)
1410 or next; 1996 or next;
1411 $neigh = find $neigh, $map 1997 $neigh = find $neigh, $map
1412 or next; 1998 or next;
1413 $neigh->load; 1999 $neigh->load;
1414 2000
2001 push @neigh,
1415 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2002 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1416 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2003 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1417 } 2004 }
1418 2005
1419 for (@diag) { 2006 for (grep defined $_->[0], @neigh) {
2007 my ($path, $origin) = @$_;
1420 my $neigh = find @$_ 2008 my $neigh = find $path, $origin
1421 or next; 2009 or next;
1422 $neigh->load; 2010 $neigh->load;
1423 } 2011 }
1424} 2012}
1425 2013
1430} 2018}
1431 2019
1432sub do_load_sync { 2020sub do_load_sync {
1433 my ($map) = @_; 2021 my ($map) = @_;
1434 2022
2023 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2024 if $Coro::current == $Coro::main;
2025
1435 cf::sync_job { $map->load }; 2026 cf::sync_job { $map->load };
1436} 2027}
1437 2028
1438our %MAP_PREFETCH; 2029our %MAP_PREFETCH;
1439our $MAP_PREFETCHER = Coro::async { 2030our $MAP_PREFETCHER = undef;
1440 while () {
1441 for my $path (keys %MAP_PREFETCH) {
1442 my $map = find $path
1443 or next;
1444 $map->load;
1445
1446 delete $MAP_PREFETCH{$path};
1447 }
1448 Coro::schedule;
1449 }
1450};
1451 2031
1452sub find_async { 2032sub find_async {
1453 my ($path, $origin) = @_; 2033 my ($path, $origin, $load) = @_;
1454 2034
1455 $path = normalise $path, $origin && $origin->{path}; 2035 $path = normalise $path, $origin && $origin->{path};
1456 2036
1457 if (my $map = $cf::MAP{$path}) { 2037 if (my $map = $cf::MAP{$path}) {
1458 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;
1459 } 2056 };
1460
1461 $MAP_PREFETCH{$path} = 0;
1462 $MAP_PREFETCHER->ready; 2057 $MAP_PREFETCHER->prio (6);
1463 2058
1464 () 2059 ()
1465} 2060}
1466 2061
1467sub save { 2062sub save {
1468 my ($self) = @_; 2063 my ($self) = @_;
1469 2064
1470 my $lock = cf::lock_acquire "map_data:" . $self->path; 2065 my $lock = cf::lock_acquire "map_data:$self->{path}";
1471 2066
1472 $self->{last_save} = $cf::RUNTIME; 2067 $self->{last_save} = $cf::RUNTIME;
1473 2068
1474 return unless $self->dirty; 2069 return unless $self->dirty;
1475 2070
1481 return if $self->{deny_save}; 2076 return if $self->{deny_save};
1482 2077
1483 local $self->{last_access} = $self->last_access;#d# 2078 local $self->{last_access} = $self->last_access;#d#
1484 2079
1485 cf::async { 2080 cf::async {
2081 $Coro::current->{desc} = "map player save";
1486 $_->contr->save for $self->players; 2082 $_->contr->save for $self->players;
1487 }; 2083 };
1488 2084
1489 if ($uniq) { 2085 if ($uniq) {
1490 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2086 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1498 my ($self) = @_; 2094 my ($self) = @_;
1499 2095
1500 # save first because save cedes 2096 # save first because save cedes
1501 $self->save; 2097 $self->save;
1502 2098
1503 my $lock = cf::lock_acquire "map_data:" . $self->path; 2099 my $lock = cf::lock_acquire "map_data:$self->{path}";
1504 2100
1505 return if $self->players; 2101 return if $self->players;
1506 return if $self->in_memory != cf::MAP_IN_MEMORY; 2102 return if $self->in_memory != cf::MAP_IN_MEMORY;
1507 return if $self->{deny_save}; 2103 return if $self->{deny_save};
1508 2104
2105 $self->in_memory (cf::MAP_SWAPPED);
2106
2107 $self->deactivate;
2108 $_->clear_links_to ($self) for values %cf::MAP;
1509 $self->clear; 2109 $self->clear;
1510 $self->in_memory (cf::MAP_SWAPPED);
1511} 2110}
1512 2111
1513sub reset_at { 2112sub reset_at {
1514 my ($self) = @_; 2113 my ($self) = @_;
1515 2114
1516 # TODO: safety, remove and allow resettable per-player maps 2115 # TODO: safety, remove and allow resettable per-player maps
1517 return 1e99 if $self->isa ("ext::map_per_player");
1518 return 1e99 if $self->{deny_reset}; 2116 return 1e99 if $self->{deny_reset};
1519 2117
1520 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2118 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1521 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;
1522 2120
1527 my ($self) = @_; 2125 my ($self) = @_;
1528 2126
1529 $self->reset_at <= $cf::RUNTIME 2127 $self->reset_at <= $cf::RUNTIME
1530} 2128}
1531 2129
1532sub rename {
1533 my ($self, $new_path) = @_;
1534
1535 normalise $new_path;
1536
1537 $self->unlink_save;
1538
1539 delete $cf::MAP{$self->path};
1540 $self->{path} = $new_path; $self->path ($self->{path});
1541 $cf::MAP{$self->path} = $self;
1542
1543 $self->save;
1544}
1545
1546sub reset { 2130sub reset {
1547 my ($self) = @_; 2131 my ($self) = @_;
1548 2132
1549 my $lock = cf::lock_acquire "map_data:" . $self->path; 2133 my $lock = cf::lock_acquire "map_data:$self->{path}";
1550 2134
1551 return if $self->players; 2135 return if $self->players;
1552 return if $self->isa ("ext::map_per_player");#d#
1553 2136
1554 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 }
1555 2148
1556 delete $cf::MAP{$self->path}; 2149 delete $cf::MAP{$self->path};
1557 2150
2151 $self->deactivate;
1558 $_->clear_links_to ($self) for values %cf::MAP; 2152 $_->clear_links_to ($self) for values %cf::MAP;
2153 $self->clear;
1559 2154
1560 $self->unlink_save; 2155 $self->unlink_save;
1561 $self->destroy; 2156 $self->destroy;
1562} 2157}
1563 2158
1564my $nuke_counter = "aaaa"; 2159my $nuke_counter = "aaaa";
1565 2160
1566sub nuke { 2161sub nuke {
1567 my ($self) = @_; 2162 my ($self) = @_;
1568 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};
1569 $self->{deny_save} = 1; 2173 $self->{deny_save} = 1;
1570 $self->reset_timeout (1); 2174 $self->reset_timeout (1);
1571 $self->rename ("{nuke}/" . ($nuke_counter++)); 2175 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2176
2177 $cf::MAP{$self->path} = $self;
2178 }
2179
1572 $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 ]
1573} 2217}
1574 2218
1575=item cf::map::unique_maps 2219=item cf::map::unique_maps
1576 2220
1577Returns an arrayref of paths of all shared maps that have 2221Returns an arrayref of paths of all shared maps that have
1578instantiated unique items. May block. 2222instantiated unique items. May block.
1579 2223
1580=cut 2224=cut
1581 2225
1582sub unique_maps() { 2226sub unique_maps() {
1583 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2227 [
1584 or return; 2228 map {
1585
1586 my @paths;
1587
1588 for (@$files) {
1589 utf8::decode $_; 2229 utf8::decode $_;
1590 next if /\.pst$/; 2230 /\.map$/
1591 next unless /^$PATH_SEP/o; 2231 ? normalise $_
1592 2232 : ()
1593 push @paths, $_; 2233 } @{ aio_readdir $UNIQUEDIR or [] }
1594 } 2234 ]
1595
1596 \@paths
1597} 2235}
1598 2236
1599package cf; 2237package cf;
1600 2238
1601=back 2239=back
1619 map { $_, inv_recursive_ $_->inv } @_ 2257 map { $_, inv_recursive_ $_->inv } @_
1620} 2258}
1621 2259
1622sub inv_recursive { 2260sub inv_recursive {
1623 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 }
1624} 2293}
1625 2294
1626package cf; 2295package cf;
1627 2296
1628=back 2297=back
1647 2316
1648 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2317 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1649 2318
1650 if ($self->{record_replies}) { 2319 if ($self->{record_replies}) {
1651 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2320 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2321
1652 } 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 {
1653 $msg = $npc->name . " says: $msg" if $npc; 2330 $msg = $npc->name . " says: $msg" if $npc;
1654 $self->message ($msg, $flags); 2331 $self->message ($msg, $flags);
2332 }
1655 } 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 (@_);
1656} 2344}
1657 2345
1658=item $player_object->may ("access") 2346=item $player_object->may ("access")
1659 2347
1660Returns wether the given player is authorized to access resource "access" 2348Returns wether the given player is authorized to access resource "access"
1692=cut 2380=cut
1693 2381
1694sub link_map { 2382sub link_map {
1695 unless ($LINK_MAP) { 2383 unless ($LINK_MAP) {
1696 $LINK_MAP = cf::map::find "{link}" 2384 $LINK_MAP = cf::map::find "{link}"
1697 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2385 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1698 $LINK_MAP->load; 2386 $LINK_MAP->load;
1699 } 2387 }
1700 2388
1701 $LINK_MAP 2389 $LINK_MAP
1702} 2390}
1707 $self->deactivate_recursive; 2395 $self->deactivate_recursive;
1708 2396
1709 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2397 return if UNIVERSAL::isa $self->map, "ext::map_link";
1710 2398
1711 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2399 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1712 if $self->map; 2400 if $self->map && $self->map->{path} ne "{link}";
1713 2401
1714 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2402 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1715} 2403}
1716 2404
1717sub cf::object::player::leave_link { 2405sub cf::object::player::leave_link {
1718 my ($self, $map, $x, $y) = @_; 2406 my ($self, $map, $x, $y) = @_;
2407
2408 return unless $self->contr->active;
1719 2409
1720 my $link_pos = delete $self->{_link_pos}; 2410 my $link_pos = delete $self->{_link_pos};
1721 2411
1722 unless ($map) { 2412 unless ($map) {
1723 # restore original map position 2413 # restore original map position
1737 # use -1 or undef as default coordinates, not 0, 0 2427 # use -1 or undef as default coordinates, not 0, 0
1738 ($x, $y) = ($map->enter_x, $map->enter_y) 2428 ($x, $y) = ($map->enter_x, $map->enter_y)
1739 if $x <=0 && $y <= 0; 2429 if $x <=0 && $y <= 0;
1740 2430
1741 $map->load; 2431 $map->load;
1742 $map->load_diag; 2432 $map->load_neighbours;
1743 2433
1744 return unless $self->contr->active; 2434 return unless $self->contr->active;
1745 $self->activate_recursive; 2435 $self->activate_recursive;
2436
2437 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1746 $self->enter_map ($map, $x, $y); 2438 $self->enter_map ($map, $x, $y);
1747} 2439}
1748 2440
1749cf::player->attach ( 2441=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1750 on_logout => sub {
1751 my ($pl) = @_;
1752 2442
1753 # abort map switching before logout 2443Moves the player to the given map-path and coordinates by first freezing
1754 if ($pl->ob->{_link_pos}) { 2444her, loading and preparing them map, calling the provided $check callback
1755 cf::sync_job { 2445that has to return the map if sucecssful, and then unfreezes the player on
1756 $pl->ob->leave_link 2446the new (success) or old (failed) map position. In either case, $done will
1757 }; 2447be called at the end of this process.
1758 }
1759 },
1760 on_login => sub {
1761 my ($pl) = @_;
1762 2448
1763 # try to abort aborted map switching on player login :)
1764 # should happen only on crashes
1765 if ($pl->ob->{_link_pos}) {
1766 $pl->ob->enter_link;
1767 (async {
1768 # we need this sleep as the login has a concurrent enter_exit running
1769 # and this sleep increases chances of the player not ending up in scorn
1770 $pl->ob->reply (undef,
1771 "There was an internal problem at your last logout, "
1772 . "the server will try to bring you to your intended destination in a second.",
1773 cf::NDI_RED);
1774 Coro::Timer::sleep 1;
1775 $pl->ob->leave_link;
1776 })->prio (2);
1777 }
1778 },
1779);
1780
1781=item $player_object->goto ($path, $x, $y)
1782
1783=cut 2449=cut
2450
2451our $GOTOGEN;
1784 2452
1785sub cf::object::player::goto { 2453sub cf::object::player::goto {
1786 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;
1787 2458
1788 $self->enter_link; 2459 $self->enter_link;
1789 2460
1790 (async { 2461 (async {
1791 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) {
1792 $map = $map->customise_for ($self) if $map; 2487 $map = $map->customise_for ($self);
1793 2488 $map = $check->($map) if $check && $map;
1794# warn "entering ", $map->path, " at ($x, $y)\n" 2489 } else {
1795# if $map;
1796
1797 $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 }
1798 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};
1799 $self->leave_link ($map, $x, $y); 2503 $self->leave_link ($map, $x, $y);
2504 }
2505
2506 $done->() if $done;
1800 })->prio (1); 2507 })->prio (1);
1801} 2508}
1802 2509
1803=item $player_object->enter_exit ($exit_object) 2510=item $player_object->enter_exit ($exit_object)
1804 2511
1806 2513
1807sub parse_random_map_params { 2514sub parse_random_map_params {
1808 my ($spec) = @_; 2515 my ($spec) = @_;
1809 2516
1810 my $rmp = { # defaults 2517 my $rmp = { # defaults
1811 xsize => 10, 2518 xsize => (cf::rndm 15, 40),
1812 ysize => 10, 2519 ysize => (cf::rndm 15, 40),
2520 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2521 #layout => string,
1813 }; 2522 };
1814 2523
1815 for (split /\n/, $spec) { 2524 for (split /\n/, $spec) {
1816 my ($k, $v) = split /\s+/, $_, 2; 2525 my ($k, $v) = split /\s+/, $_, 2;
1817 2526
1821 $rmp 2530 $rmp
1822} 2531}
1823 2532
1824sub prepare_random_map { 2533sub prepare_random_map {
1825 my ($exit) = @_; 2534 my ($exit) = @_;
2535
2536 my $guard = cf::lock_acquire "exit_prepare:$exit";
1826 2537
1827 # all this does is basically replace the /! path by 2538 # all this does is basically replace the /! path by
1828 # a new random map path (?random/...) with a seed 2539 # a new random map path (?random/...) with a seed
1829 # that depends on the exit object 2540 # that depends on the exit object
1830 2541
1831 my $rmp = parse_random_map_params $exit->msg; 2542 my $rmp = parse_random_map_params $exit->msg;
1832 2543
1833 if ($exit->map) { 2544 if ($exit->map) {
1834 $rmp->{region} = $exit->map->region_name; 2545 $rmp->{region} = $exit->region->name;
1835 $rmp->{origin_map} = $exit->map->path; 2546 $rmp->{origin_map} = $exit->map->path;
1836 $rmp->{origin_x} = $exit->x; 2547 $rmp->{origin_x} = $exit->x;
1837 $rmp->{origin_y} = $exit->y; 2548 $rmp->{origin_y} = $exit->y;
1838 } 2549 }
1839 2550
1840 $rmp->{random_seed} ||= $exit->random_seed; 2551 $rmp->{random_seed} ||= $exit->random_seed;
1841 2552
1842 my $data = cf::to_json $rmp; 2553 my $data = cf::to_json $rmp;
1843 my $md5 = Digest::MD5::md5_hex $data; 2554 my $md5 = Digest::MD5::md5_hex $data;
2555 my $meta = "$RANDOMDIR/$md5.meta";
1844 2556
1845 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) {
1846 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;
1847 2561
1848 $exit->slaying ("?random/$md5"); 2562 $exit->slaying ("?random/$md5");
1849 $exit->msg (undef); 2563 $exit->msg (undef);
1850 } 2564 }
1851} 2565}
1853sub cf::object::player::enter_exit { 2567sub cf::object::player::enter_exit {
1854 my ($self, $exit) = @_; 2568 my ($self, $exit) = @_;
1855 2569
1856 return unless $self->type == cf::PLAYER; 2570 return unless $self->type == cf::PLAYER;
1857 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
1858 $self->enter_link; 2583 $self->enter_link;
1859 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
1860 (async { 2589 (async {
2590 $Coro::current->{desc} = "enter_exit $slaying $hp $sp";
2591
1861 $self->deactivate_recursive; # just to be sure 2592 $self->deactivate_recursive; # just to be sure
1862 unless (eval { 2593 unless (eval {
1863 prepare_random_map $exit 2594 $self->goto ($slaying, $hp, $sp);
1864 if $exit->slaying eq "/!";
1865
1866 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1867 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1868 2595
1869 1; 2596 1;
1870 }) { 2597 }) {
1871 $self->message ("Something went wrong deep within the crossfire server. " 2598 $self->message ("Something went wrong deep within the crossfire server. "
1872 . "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. "
1873 . "Please report this to the dungeon master!", 2600 . "Please report this to the dungeon master!",
1874 cf::NDI_UNIQUE | cf::NDI_RED); 2601 cf::NDI_UNIQUE | cf::NDI_RED);
1875 2602
1876 warn "ERROR in enter_exit: $@"; 2603 warn "ERROR in enter_exit: $@";
1877 $self->leave_link; 2604 $self->leave_link;
1878 } 2605 }
1879 })->prio (1); 2606 })->prio (1);
1892 2619
1893sub cf::client::send_drawinfo { 2620sub cf::client::send_drawinfo {
1894 my ($self, $text, $flags) = @_; 2621 my ($self, $text, $flags) = @_;
1895 2622
1896 utf8::encode $text; 2623 utf8::encode $text;
1897 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2624 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1898} 2625}
1899 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}
1900 2742
1901=item $success = $client->query ($flags, "text", \&cb) 2743=item $success = $client->query ($flags, "text", \&cb)
1902 2744
1903Queues a query to the client, calling the given callback with 2745Queues a query to the client, calling the given callback with
1904the 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>,
1905C<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>.
1906 2748
1907Queries 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
1908reliable at some point in the future. 2750become reliable at some point in the future.
1909 2751
1910=cut 2752=cut
1911 2753
1912sub cf::client::query { 2754sub cf::client::query {
1913 my ($self, $flags, $text, $cb) = @_; 2755 my ($self, $flags, $text, $cb) = @_;
1921 utf8::encode $text; 2763 utf8::encode $text;
1922 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2764 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1923 2765
1924 $self->send_packet ($self->{query_queue}[0][0]) 2766 $self->send_packet ($self->{query_queue}[0][0])
1925 if @{ $self->{query_queue} } == 1; 2767 if @{ $self->{query_queue} } == 1;
2768
2769 1
1926} 2770}
1927 2771
1928cf::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 },
1929 on_reply => sub { 2778 on_reply => sub {
1930 my ($ns, $msg) = @_; 2779 my ($ns, $msg) = @_;
1931 2780
1932 # this weird shuffling is so that direct followup queries 2781 # this weird shuffling is so that direct followup queries
1933 # get handled first 2782 # get handled first
1934 my $queue = delete $ns->{query_queue} 2783 my $queue = delete $ns->{query_queue}
1935 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
1936 2785
1937 (shift @$queue)->[1]->($msg); 2786 (shift @$queue)->[1]->($msg);
2787 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1938 2788
1939 push @{ $ns->{query_queue} }, @$queue; 2789 push @{ $ns->{query_queue} }, @$queue;
1940 2790
1941 if (@{ $ns->{query_queue} } == @$queue) { 2791 if (@{ $ns->{query_queue} } == @$queue) {
1942 if (@$queue) { 2792 if (@$queue) {
1944 } else { 2794 } else {
1945 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2795 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1946 } 2796 }
1947 } 2797 }
1948 }, 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 },
1949); 2825);
1950 2826
1951=item $client->async (\&cb) 2827=item $client->async (\&cb)
1952 2828
1953Create a new coroutine, running the specified callback. The coroutine will 2829Create a new coroutine, running the specified callback. The coroutine will
1994our $safe = new Safe "safe"; 2870our $safe = new Safe "safe";
1995our $safe_hole = new Safe::Hole; 2871our $safe_hole = new Safe::Hole;
1996 2872
1997$SIG{FPE} = 'IGNORE'; 2873$SIG{FPE} = 'IGNORE';
1998 2874
1999$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));
2000 2880
2001# here we export the classes and methods available to script code 2881# here we export the classes and methods available to script code
2002 2882
2003=pod 2883=pod
2004 2884
2005The following fucntions and emthods are available within a safe environment: 2885The following functions and methods are available within a safe environment:
2006 2886
2007 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
2008 cf::object::player player 2891 cf::object::player
2009 cf::player peaceful 2892 player
2010 cf::map trigger 2893
2894 cf::player
2895 peaceful
2896
2897 cf::map
2898 trigger
2011 2899
2012=cut 2900=cut
2013 2901
2014for ( 2902for (
2015 ["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)],
2016 ["cf::object::player" => qw(player)], 2906 ["cf::object::player" => qw(player)],
2017 ["cf::player" => qw(peaceful)], 2907 ["cf::player" => qw(peaceful)],
2018 ["cf::map" => qw(trigger)], 2908 ["cf::map" => qw(trigger)],
2019) { 2909) {
2020 no strict 'refs'; 2910 no strict 'refs';
2091=back 2981=back
2092 2982
2093=cut 2983=cut
2094 2984
2095############################################################################# 2985#############################################################################
2986# the server's init and main functions
2096 2987
2097=head2 EXTENSION DATABASE SUPPORT 2988sub load_facedata($) {
2989 my ($path) = @_;
2098 2990
2099Crossfire maintains a very simple database for extension use. It can 2991 # HACK to clear player env face cache, we need some signal framework
2100currently store anything that can be serialised using Storable, which 2992 # for this (global event?)
2101excludes objects. 2993 %ext::player_env::MUSIC_FACE_CACHE = ();
2102 2994
2103The parameter C<$family> should best start with the name of the extension 2995 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2104using it, it should be unique.
2105 2996
2106=over 4 2997 warn "loading facedata from $path\n";
2107 2998
2108=item $hashref = cf::db_get $family 2999 my $facedata;
3000 0 < aio_load $path, $facedata
3001 or die "$path: $!";
2109 3002
2110Return a hashref for use by the extension C<$family>, which can be 3003 $facedata = Coro::Storable::thaw $facedata;
2111modified. After modifications, you have to call C<cf::db_dirty> or
2112C<cf::db_sync>.
2113 3004
2114=item $value = cf::db_get $family => $key 3005 $facedata->{version} == 2
3006 or cf::cleanup "$path: version mismatch, cannot proceed.";
2115 3007
2116Returns a single value from the database 3008 # patch in the exptable
2117 3009 $facedata->{resource}{"res/exp_table"} = {
2118=item cf::db_put $family => $hashref 3010 type => FT_RSRC,
2119 3011 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2120Stores the given family hashref into the database. Updates are delayed, if
2121you want the data to be synced to disk immediately, use C<cf::db_sync>.
2122
2123=item cf::db_put $family => $key => $value
2124
2125Stores the given C<$value> in the family hash. Updates are delayed, if you
2126want the data to be synced to disk immediately, use C<cf::db_sync>.
2127
2128=item cf::db_dirty
2129
2130Marks the database as dirty, to be updated at a later time.
2131
2132=item cf::db_sync
2133
2134Immediately write the database to disk I<if it is dirty>.
2135
2136=cut
2137
2138our $DB;
2139
2140{
2141 my $path = cf::localdir . "/database.pst";
2142
2143 sub db_load() {
2144 $DB = stat $path ? Storable::retrieve $path : { };
2145 }
2146
2147 my $pid;
2148
2149 sub db_save() {
2150 waitpid $pid, 0 if $pid;
2151 if (0 == ($pid = fork)) {
2152 $DB->{_meta}{version} = 1;
2153 Storable::nstore $DB, "$path~";
2154 rename "$path~", $path;
2155 cf::_exit 0 if defined $pid;
2156 }
2157 }
2158
2159 my $dirty;
2160
2161 sub db_sync() {
2162 db_save if $dirty;
2163 undef $dirty;
2164 }
2165
2166 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2167 db_sync;
2168 }); 3012 };
3013 cf::cede_to_tick;
2169 3014
2170 sub db_dirty() {
2171 $dirty = 1;
2172 $idle->start;
2173 } 3015 {
3016 my $faces = $facedata->{faceinfo};
2174 3017
2175 sub db_get($;$) { 3018 while (my ($face, $info) = each %$faces) {
2176 @_ >= 2 3019 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2177 ? $DB->{$_[0]}{$_[1]} 3020 cf::face::set_visibility $idx, $info->{visibility};
2178 : ($DB->{$_[0]} ||= { }) 3021 cf::face::set_magicmap $idx, $info->{magicmap};
2179 } 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};
2180 3024
2181 sub db_put($$;$) { 3025 cf::cede_to_tick;
2182 if (@_ >= 3) {
2183 $DB->{$_[0]}{$_[1]} = $_[2];
2184 } else {
2185 $DB->{$_[0]} = $_[1];
2186 }
2187 db_dirty;
2188 }
2189
2190 cf::global->attach (
2191 prio => 10000,
2192 on_cleanup => sub {
2193 db_sync;
2194 }, 3026 }
2195 );
2196}
2197 3027
2198############################################################################# 3028 while (my ($face, $info) = each %$faces) {
2199# 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 }
2200 3038
2201sub 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 {
2202 open my $fh, "<:utf8", cf::confdir . "/config" 3165 open my $fh, "<:utf8", "$CONFDIR/config"
2203 or return; 3166 or return;
2204 3167
2205 local $/; 3168 local $/;
2206 *CFG = YAML::Syck::Load <$fh>; 3169 *CFG = YAML::Syck::Load <$fh>;
2207 3170
2221 3184
2222sub main { 3185sub main {
2223 # we must not ever block the main coroutine 3186 # we must not ever block the main coroutine
2224 local $Coro::idle = sub { 3187 local $Coro::idle = sub {
2225 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";
2226 async { Event::one_event }; 3191 Event::one_event;
3192 })->prio (Coro::PRIO_MAX);
2227 }; 3193 };
2228 3194
2229 cfg_load; 3195 reload_config;
2230 db_load; 3196 db_init;
2231 load_extensions; 3197 load_extensions;
3198
3199 $TICK_WATCHER->start;
2232 Event::loop; 3200 Event::loop;
2233} 3201}
2234 3202
2235############################################################################# 3203#############################################################################
2236# initialisation and cleanup 3204# initialisation and cleanup
2237 3205
2238# install some emergency cleanup handlers 3206# install some emergency cleanup handlers
2239BEGIN { 3207BEGIN {
2240 for my $signal (qw(INT HUP TERM)) { 3208 for my $signal (qw(INT HUP TERM)) {
2241 Event->signal ( 3209 Event->signal (
3210 reentrant => 0,
2242 data => WF_AUTOCANCEL, 3211 data => WF_AUTOCANCEL,
2243 signal => $signal, 3212 signal => $signal,
3213 prio => 0,
2244 cb => sub { 3214 cb => sub {
2245 cf::cleanup "SIG$signal"; 3215 cf::cleanup "SIG$signal";
2246 }, 3216 },
2247 ); 3217 );
2248 } 3218 }
2249} 3219}
2250 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
3257}
3258
2251sub emergency_save() { 3259sub emergency_save() {
2252 my $freeze_guard = cf::freeze_mainloop; 3260 my $freeze_guard = cf::freeze_mainloop;
2253 3261
2254 warn "enter emergency perl save\n"; 3262 warn "enter emergency perl save\n";
2255 3263
2256 cf::sync_job { 3264 cf::sync_job {
2257 # use a peculiar iteration method to avoid tripping on perl 3265 # use a peculiar iteration method to avoid tripping on perl
2258 # refcount bugs in for. also avoids problems with players 3266 # refcount bugs in for. also avoids problems with players
2259 # and maps saved/Destroyed asynchronously. 3267 # and maps saved/destroyed asynchronously.
2260 warn "begin emergency player save\n"; 3268 warn "begin emergency player save\n";
2261 for my $login (keys %cf::PLAYER) { 3269 for my $login (keys %cf::PLAYER) {
2262 my $pl = $cf::PLAYER{$login} or next; 3270 my $pl = $cf::PLAYER{$login} or next;
2263 $pl->valid or next; 3271 $pl->valid or next;
2264 $pl->save; 3272 $pl->save;
2270 my $map = $cf::MAP{$path} or next; 3278 my $map = $cf::MAP{$path} or next;
2271 $map->valid or next; 3279 $map->valid or next;
2272 $map->save; 3280 $map->save;
2273 } 3281 }
2274 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";
2275 }; 3287 };
2276 3288
2277 warn "leave emergency perl save\n"; 3289 warn "leave emergency perl save\n";
2278} 3290}
2279 3291
3292sub post_cleanup {
3293 my ($make_core) = @_;
3294
3295 warn Carp::longmess "post_cleanup backtrace"
3296 if $make_core;
3297}
3298
2280sub reload() { 3299sub do_reload_perl() {
2281 # can/must only be called in main 3300 # can/must only be called in main
2282 if ($Coro::current != $Coro::main) { 3301 if ($Coro::current != $Coro::main) {
2283 warn "can only reload from main coroutine\n"; 3302 warn "can only reload from main coroutine";
2284 return; 3303 return;
2285 } 3304 }
2286 3305
2287 warn "reloading..."; 3306 warn "reloading...";
2288 3307
2289 warn "freezing server"; 3308 warn "entering sync_job";
2290 my $guard = freeze_mainloop; 3309
3310 cf::sync_job {
3311 cf::write_runtime; # external watchdog should not bark
2291 cf::emergency_save; 3312 cf::emergency_save;
3313 cf::write_runtime; # external watchdog should not bark
2292 3314
2293 warn "sync database to disk"; 3315 warn "syncing database to disk";
2294 cf::db_sync; 3316 BDB::db_env_txn_checkpoint $DB_ENV;
2295 IO::AIO::flush;
2296 3317
2297 eval {
2298 # 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
2299 3319
2300 warn "cancel all watchers"; 3320 warn "cancelling all WF_AUTOCANCEL watchers";
2301 for (Event::all_watchers) { 3321 for (Event::all_watchers) {
2302 $_->cancel if $_->data & WF_AUTOCANCEL; 3322 $_->cancel if $_->data & WF_AUTOCANCEL;
2303 } 3323 }
2304 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
2305 warn "cancel all extension coros"; 3336 warn "cancelling all extension coros";
2306 $_->cancel for values %EXT_CORO; 3337 $_->cancel for values %EXT_CORO;
2307 %EXT_CORO = (); 3338 %EXT_CORO = ();
2308 3339
2309 warn "remove commands"; 3340 warn "removing commands";
2310 %COMMAND = (); 3341 %COMMAND = ();
2311 3342
2312 warn "remove ext commands"; 3343 warn "removing ext/exti commands";
2313 %EXTCMD = (); 3344 %EXTCMD = ();
3345 %EXTICMD = ();
2314 3346
2315 warn "unload/nuke all extensions"; 3347 warn "unloading/nuking all extensions";
2316 for my $pkg (@EXTS) { 3348 for my $pkg (@EXTS) {
2317 warn "... unloading $pkg"; 3349 warn "... unloading $pkg";
2318 3350
2319 if (my $cb = $pkg->can ("unload")) { 3351 if (my $cb = $pkg->can ("unload")) {
2320 eval { 3352 eval {
2325 3357
2326 warn "... nuking $pkg"; 3358 warn "... nuking $pkg";
2327 Symbol::delete_package $pkg; 3359 Symbol::delete_package $pkg;
2328 } 3360 }
2329 3361
2330 warn "unload all perl modules loaded from $LIBDIR"; 3362 warn "unloading all perl modules loaded from $LIBDIR";
2331 while (my ($k, $v) = each %INC) { 3363 while (my ($k, $v) = each %INC) {
2332 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3364 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2333 3365
2334 warn "removing <$k>"; 3366 warn "... unloading $k";
2335 delete $INC{$k}; 3367 delete $INC{$k};
2336 3368
2337 $k =~ s/\.pm$//; 3369 $k =~ s/\.pm$//;
2338 $k =~ s/\//::/g; 3370 $k =~ s/\//::/g;
2339 3371
2342 } 3374 }
2343 3375
2344 Symbol::delete_package $k; 3376 Symbol::delete_package $k;
2345 } 3377 }
2346 3378
2347 warn "get rid of safe::, as good as possible"; 3379 warn "getting rid of safe::, as good as possible";
2348 Symbol::delete_package "safe::$_" 3380 Symbol::delete_package "safe::$_"
2349 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);
2350 3382
2351 warn "unload cf.pm \"a bit\""; 3383 warn "unloading cf.pm \"a bit\"";
2352 delete $INC{"cf.pm"}; 3384 delete $INC{"cf.pm"};
3385 delete $INC{"cf/pod.pm"};
2353 3386
2354 # don't, removes xs symbols, too, 3387 # don't, removes xs symbols, too,
2355 # and global variables created in xs 3388 # and global variables created in xs
2356 #Symbol::delete_package __PACKAGE__; 3389 #Symbol::delete_package __PACKAGE__;
2357 3390
3391 warn "unload completed, starting to reload now";
3392
2358 warn "reloading cf.pm"; 3393 warn "reloading cf.pm";
2359 require cf; 3394 require cf;
2360 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3395 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2361 3396
2362 warn "load config and database again"; 3397 warn "loading config and database again";
2363 cf::cfg_load; 3398 cf::reload_config;
2364 cf::db_load;
2365 3399
2366 warn "load extensions"; 3400 warn "loading extensions";
2367 cf::load_extensions; 3401 cf::load_extensions;
2368 3402
2369 warn "reattach attachments to objects/players"; 3403 warn "reattaching attachments to objects/players";
2370 _global_reattach; 3404 _global_reattach; # objects, sockets
2371 warn "reattach attachments to maps"; 3405 warn "reattaching attachments to maps";
2372 reattach $_ for values %MAP; 3406 reattach $_ for values %MAP;
2373 }; 3407 warn "reattaching attachments to players";
3408 reattach $_ for values %PLAYER;
2374 3409
2375 if ($@) { 3410 warn "leaving sync_job";
3411
3412 1
3413 } or do {
2376 warn $@; 3414 warn $@;
2377 warn "error while reloading, exiting."; 3415 warn "error while reloading, exiting.";
2378 exit 1; 3416 exit 1;
2379 } 3417 };
2380 3418
2381 warn "reloaded"; 3419 warn "reloaded";
2382}; 3420};
2383 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
2384register_command "reload" => sub { 3439register_command "reload" => sub {
2385 my ($who, $arg) = @_; 3440 my ($who, $arg) = @_;
2386 3441
2387 if ($who->flag (FLAG_WIZ)) { 3442 if ($who->flag (FLAG_WIZ)) {
2388 $who->message ("start of reload.");
2389 reload;
2390 $who->message ("end of reload."); 3443 $who->message ("reloading server.");
3444 async {
3445 $Coro::current->{desc} = "perl_reload";
3446 reload_perl;
3447 };
2391 } 3448 }
2392}; 3449};
2393 3450
2394unshift @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}
2395 3475
2396$TICK_WATCHER = Event->timer ( 3476$TICK_WATCHER = Event->timer (
2397 reentrant => 0, 3477 reentrant => 0,
3478 parked => 1,
2398 prio => 0, 3479 prio => 0,
2399 at => $NEXT_TICK || $TICK, 3480 at => $NEXT_TICK || $TICK,
2400 data => WF_AUTOCANCEL, 3481 data => WF_AUTOCANCEL,
2401 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
2402 $NOW = Event::time; 3489 $NOW = $tick_start = Event::time;
2403 3490
2404 cf::server_tick; # one server iteration 3491 cf::server_tick; # one server iteration
3492
2405 $RUNTIME += $TICK; 3493 $RUNTIME += $TICK;
2406 $NEXT_TICK += $TICK; 3494 $NEXT_TICK += $TICK;
2407 3495
2408 $WAIT_FOR_TICK->broadcast; 3496 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2409 $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;
2410 3513
2411 # 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
2412 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3515 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2413 3516
2414 $TICK_WATCHER->at ($NEXT_TICK); 3517 $TICK_WATCHER->at ($NEXT_TICK);
2415 $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;
2416 }, 3524 },
2417); 3525);
2418 3526
3527{
3528 BDB::min_parallel 8;
2419IO::AIO::max_poll_time $TICK * 0.2; 3529 BDB::max_poll_time $TICK * 0.1;
2420 3530 $BDB_POLL_WATCHER = Event->io (
2421Event->io ( 3531 reentrant => 0,
2422 fd => IO::AIO::poll_fileno, 3532 fd => BDB::poll_fileno,
2423 poll => 'r', 3533 poll => 'r',
2424 prio => 5, 3534 prio => 0,
2425 data => WF_AUTOCANCEL,
2426 cb => \&IO::AIO::poll_cb,
2427);
2428
2429Event->timer (
2430 data => WF_AUTOCANCEL, 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 (
2431 after => 0, 3578 after => 3,
2432 interval => 10, 3579 interval => 1,
3580 hard => 1,
3581 prio => 0,
3582 data => WF_AUTOCANCEL,
2433 cb => sub { 3583 cb => sub {
2434 (Coro::unblock_sub { 3584 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
2435 write_runtime 3585 },
2436 or warn "ERROR: unable to write runtime file: $!"; 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;
3613 IO::AIO::max_poll_time $TICK * 0.1;
3614 $AIO_POLL_WATCHER = Event->io (
3615 reentrant => 0,
3616 data => WF_AUTOCANCEL,
3617 fd => IO::AIO::poll_fileno,
3618 poll => 'r',
3619 prio => 6,
3620 cb => \&IO::AIO::poll_cb,
3621 );
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;
2437 })->(); 3657 };
3658 } else {
3659 LOG llevInfo, "[ABT] $msg\n";
3660 LOG llevInfo, "[ABT] [suppressed]\n";
2438 }, 3661 }
2439); 3662}
3663
3664# load additional modules
3665use cf::pod;
2440 3666
2441END { cf::emergency_save } 3667END { cf::emergency_save }
2442 3668
24431 36691
2444 3670

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines