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.169 by root, Sun Jan 14 01:09:46 2007 UTC vs.
Revision 1.387 by root, Mon Oct 15 23:49:10 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines