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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.168 by root, Sun Jan 14 00:37:14 2007 UTC vs.
Revision 1.407 by root, Sun Jan 13 09:53:53 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines