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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines