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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines