ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.169 by root, Sun Jan 14 01:09:46 2007 UTC vs.
Revision 1.404 by root, Mon Dec 17 07:27:58 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines