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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines