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.167 by root, Sat Jan 13 23:32:43 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;
78our $AIO_POLL_WATCHER;
79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
49our $NEXT_TICK; 80our $NEXT_TICK;
50our $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;
51 88
52our %CFG; 89our %CFG;
53 90
54our $UPTIME; $UPTIME ||= time; 91our $UPTIME; $UPTIME ||= time;
55our $RUNTIME; 92our $RUNTIME;
93our $NOW;
56 94
57our %PLAYER; # all users 95our (%PLAYER, %PLAYER_LOADING); # all users
58our %MAP; # all maps 96our (%MAP, %MAP_LOADING ); # all maps
59our $LINK_MAP; # the special {link} map, which is always available 97our $LINK_MAP; # the special {link} map, which is always available
60our $RANDOM_MAPS = cf::localdir . "/random";
61
62our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
63our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
64 98
65# 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 ∕
66our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 100our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
67 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
68binmode STDOUT; 106binmode STDOUT;
69binmode STDERR; 107binmode STDERR;
70 108
71# read virtual server time, if available 109# read virtual server time, if available
72unless ($RUNTIME || !-e cf::localdir . "/runtime") { 110unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
73 open my $fh, "<", cf::localdir . "/runtime" 111 open my $fh, "<", "$LOCALDIR/runtime"
74 or die "unable to read runtime file: $!"; 112 or die "unable to read runtime file: $!";
75 $RUNTIME = <$fh> + 0.; 113 $RUNTIME = <$fh> + 0.;
76} 114}
77 115
78mkdir cf::localdir; 116mkdir $_
79mkdir cf::localdir . "/" . cf::playerdir; 117 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
80mkdir cf::localdir . "/" . cf::tmpdir;
81mkdir cf::localdir . "/" . cf::uniquedir;
82mkdir $RANDOM_MAPS;
83 118
84our $EMERGENCY_POSITION; 119our $EMERGENCY_POSITION;
120
121sub cf::map::normalise;
85 122
86############################################################################# 123#############################################################################
87 124
88=head2 GLOBAL VARIABLES 125=head2 GLOBAL VARIABLES
89 126
96=item $cf::RUNTIME 133=item $cf::RUNTIME
97 134
98The 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
99every server tick. 136every server tick.
100 137
101=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
102 141
103The perl library directory, where extensions and cf-specific modules can 142Various directories - "/etc", read-only install directory, perl-library
104be 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.
105 146
106=item $cf::NOW 147=item $cf::NOW
107 148
108The time of the last (current) server tick. 149The time of the last (current) server tick.
109 150
110=item $cf::TICK 151=item $cf::TICK
111 152
112The interval between server ticks, in seconds. 153The interval between server ticks, in seconds.
113 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
114=item %cf::CFG 165=item %cf::CFG
115 166
116Configuration for the server, loaded from C</etc/crossfire/config>, or 167Configuration for the server, loaded from C</etc/deliantra-server/config>, or
117from wherever your confdir points to. 168from wherever your confdir points to.
118 169
119=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 170=item cf::wait_for_tick, cf::wait_for_tick_begin
120 171
121These 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
122or 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
123processing 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.
124window 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.
125 181
126=back 182=back
127 183
128=cut 184=cut
129 185
130BEGIN { 186BEGIN {
131 *CORE::GLOBAL::warn = sub { 187 *CORE::GLOBAL::warn = sub {
132 my $msg = join "", @_; 188 my $msg = join "", @_;
133 utf8::encode $msg;
134 189
135 $msg .= "\n" 190 $msg .= "\n"
136 unless $msg =~ /\n$/; 191 unless $msg =~ /\n$/;
137 192
193 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
194
138 LOG llevError, $msg; 195 LOG llevError, $msg;
139 }; 196 };
140} 197}
198
199$Coro::State::DIEHOOK = sub {
200 warn Carp::longmess $_[0];
201 Coro::terminate;
202};
141 203
142@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 204@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
143@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 205@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
144@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 206@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
145@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 207@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
146@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';
147@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)
148 211
149# 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
150# within the Safe compartment. 213# within the Safe compartment.
151for my $pkg (qw( 214for my $pkg (qw(
152 cf::global cf::attachable 215 cf::global cf::attachable
157)) { 220)) {
158 no strict 'refs'; 221 no strict 'refs';
159 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 222 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
160} 223}
161 224
162$Event::DIED = sub { 225$EV::DIED = sub {
163 warn "error in event callback: @_"; 226 warn "error in event callback: @_";
164}; 227};
228
229#############################################################################
165 230
166=head2 UTILITY FUNCTIONS 231=head2 UTILITY FUNCTIONS
167 232
168=over 4 233=over 4
169 234
188 $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;
189 $d 254 $d
190 } || "[unable to dump $_[0]: '$@']"; 255 } || "[unable to dump $_[0]: '$@']";
191} 256}
192 257
193use JSON::Syck (); # TODO# replace by JSON::PC once working
194
195=item $ref = cf::from_json $json 258=item $ref = cf::decode_json $json
196 259
197Converts a JSON string into the corresponding perl data structure. 260Converts a JSON string into the corresponding perl data structure.
198 261
199=cut
200
201sub from_json($) {
202 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
203 JSON::Syck::Load $_[0]
204}
205
206=item $json = cf::to_json $ref 262=item $json = cf::encode_json $ref
207 263
208Converts a perl data structure into its JSON representation. 264Converts a perl data structure into its JSON representation.
209 265
210=cut 266=cut
211 267
212sub to_json($) { 268our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
213 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 269
214 JSON::Syck::Dump $_[0] 270sub encode_json($) { $json_coder->encode ($_[0]) }
215} 271sub decode_json($) { $json_coder->decode ($_[0]) }
216 272
217=item cf::lock_wait $string 273=item cf::lock_wait $string
218 274
219Wait until the given lock is available. See cf::lock_acquire. 275Wait until the given lock is available. See cf::lock_acquire.
220 276
223Wait 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
224a 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,
225for example when the coroutine gets canceled), the lock is automatically 281for example when the coroutine gets canceled), the lock is automatically
226returned. 282returned.
227 283
284Locks are *not* recursive, locking from the same coro twice results in a
285deadlocked coro.
286
228Lock 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
229uses map_find and cf::map::load uses map_load). 288uses map_find and cf::map::load uses map_load).
230 289
290=item $locked = cf::lock_active $string
291
292Return true if the lock is currently active, i.e. somebody has locked it.
293
231=cut 294=cut
232 295
233our %LOCK; 296our %LOCK;
297our %LOCKER;#d#
234 298
235sub lock_wait($) { 299sub lock_wait($) {
236 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#
237 306
238 # wait for lock, if any 307 # wait for lock, if any
239 while ($LOCK{$key}) { 308 while ($LOCK{$key}) {
240 push @{ $LOCK{$key} }, $Coro::current; 309 push @{ $LOCK{$key} }, $Coro::current;
241 Coro::schedule; 310 Coro::schedule;
247 316
248 # wait, to be sure we are not locked 317 # wait, to be sure we are not locked
249 lock_wait $key; 318 lock_wait $key;
250 319
251 $LOCK{$key} = []; 320 $LOCK{$key} = [];
321 $LOCKER{$key} = $Coro::current;#d#
252 322
253 Coro::guard { 323 Coro::guard {
324 delete $LOCKER{$key};#d#
254 # wake up all waiters, to be on the safe side 325 # wake up all waiters, to be on the safe side
255 $_->ready for @{ delete $LOCK{$key} }; 326 $_->ready for @{ delete $LOCK{$key} };
256 } 327 }
257} 328}
258 329
330sub lock_active($) {
331 my ($key) = @_;
332
333 ! ! $LOCK{$key}
334}
335
259sub freeze_mainloop { 336sub freeze_mainloop {
260 return unless $TICK_WATCHER->is_active; 337 return unless $TICK_WATCHER->is_active;
261 338
262 my $guard = Coro::guard { $TICK_WATCHER->start }; 339 my $guard = Coro::guard {
340 $TICK_WATCHER->start;
341 };
263 $TICK_WATCHER->stop; 342 $TICK_WATCHER->stop;
264 $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;
265} 417}
266 418
267=item cf::async { BLOCK } 419=item cf::async { BLOCK }
268 420
269Currently the same as Coro::async_pool, meaning you cannot use 421Currently the same as Coro::async_pool, meaning you cannot use
274 426
275BEGIN { *async = \&Coro::async_pool } 427BEGIN { *async = \&Coro::async_pool }
276 428
277=item cf::sync_job { BLOCK } 429=item cf::sync_job { BLOCK }
278 430
279The design of crossfire+ requires that the main coro ($Coro::main) is 431The design of Deliantra requires that the main coroutine ($Coro::main)
280always able to handle events or runnable, as crossfire+ is only partly 432is always able to handle events or runnable, as Deliantra is only
281reentrant. 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.
282 435
283If 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
284the given BLOCK in another coroutine while waiting for the result. The 437the given BLOCK in another coroutine while waiting for the result. The
285server 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
286fast or be very important. 439fast or be very important.
289 442
290sub sync_job(&) { 443sub sync_job(&) {
291 my ($job) = @_; 444 my ($job) = @_;
292 445
293 if ($Coro::current == $Coro::main) { 446 if ($Coro::current == $Coro::main) {
447 my $time = EV::time;
448
294 # this is the main coro, too bad, we have to block 449 # this is the main coro, too bad, we have to block
295 # till the operation succeeds, freezing the server :/ 450 # till the operation succeeds, freezing the server :/
296 451
452 LOG llevError, Carp::longmess "sync job";#d#
453
297 # TODO: use suspend/resume instead 454 # TODO: use suspend/resume instead
298 # (but this is cancel-safe) 455 # (but this is cancel-safe)
299 my $freeze_guard = freeze_mainloop; 456 my $freeze_guard = freeze_mainloop;
300 457
301 my $busy = 1; 458 my $busy = 1;
302 my @res; 459 my @res;
303 460
304 (async { 461 (async {
462 $Coro::current->desc ("sync job coro");
305 @res = eval { $job->() }; 463 @res = eval { $job->() };
306 warn $@ if $@; 464 warn $@ if $@;
307 undef $busy; 465 undef $busy;
308 })->prio (Coro::PRIO_MAX); 466 })->prio (Coro::PRIO_MAX);
309 467
310 while ($busy) { 468 while ($busy) {
311 Coro::cede or Event::one_event; 469 if (Coro::nready) {
470 Coro::cede_notself;
471 } else {
472 EV::loop EV::LOOP_ONESHOT;
312 } 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
313 482
314 wantarray ? @res : $res[0] 483 wantarray ? @res : $res[0]
315 } else { 484 } else {
316 # we are in another coroutine, how wonderful, everything just works 485 # we are in another coroutine, how wonderful, everything just works
317 486
337 $EXT_CORO{$coro+0} = $coro; 506 $EXT_CORO{$coro+0} = $coro;
338 507
339 $coro 508 $coro
340} 509}
341 510
342sub write_runtime { 511=item fork_call { }, $args
343 return unless $TICK_WATCHER->is_active;
344 512
345 my $runtime = cf::localdir . "/runtime"; 513Executes the given code block with the given arguments in a seperate
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.
346 517
347 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 518=cut
348 or return;
349 519
350 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 520sub fork_call(&@) {
351 (aio_write $fh, 0, (length $value), $value, 0) <= 0 521 my ($cb, @args) = @_;
352 and return;
353 522
354 aio_fsync $fh 523 # we seemingly have to make a local copy of the whole thing,
355 and return; 524 # otherwise perl prematurely frees the stuff :/
525 # TODO: investigate and fix (likely this will be rather laborious)
356 526
357 close $fh 527 my @res = Coro::Util::fork_eval {
358 or return; 528 reset_signals;
529 &$cb
530 }, @args;
359 531
360 aio_rename "$runtime~", $runtime 532 wantarray ? @res : $res[-1]
361 and return; 533}
362 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
363 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 });
364} 671}
365 672
366=back 673=back
367 674
368=cut 675=cut
375attach callbacks/event handlers (a collection of which is called an "attachment") 682attach callbacks/event handlers (a collection of which is called an "attachment")
376to it. All such attachable objects support the following methods. 683to it. All such attachable objects support the following methods.
377 684
378In 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>
379C<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
380crossfire+). 687Deliantra).
381 688
382=over 4 689=over 4
383 690
384=item $attachable->attach ($attachment, key => $value...) 691=item $attachable->attach ($attachment, key => $value...)
385 692
499our @CB_TYPE = (); # registry for type (cf-object class) based events 806our @CB_TYPE = (); # registry for type (cf-object class) based events
500our @CB_MAP = (); 807our @CB_MAP = ();
501 808
502my %attachment; 809my %attachment;
503 810
811sub cf::attachable::thawer_merge {
812 # simply override everything except _meta
813 local $_[0]{_meta};
814 %{$_[0]} = %{$_[1]};
815}
816
504sub _attach_cb($$$$) { 817sub _attach_cb($$$$) {
505 my ($registry, $event, $prio, $cb) = @_; 818 my ($registry, $event, $prio, $cb) = @_;
506 819
507 use sort 'stable'; 820 use sort 'stable';
508 821
542 $registry = $CB_TYPE[$object_type] ||= []; 855 $registry = $CB_TYPE[$object_type] ||= [];
543 856
544 } elsif ($type eq "subtype") { 857 } elsif ($type eq "subtype") {
545 defined $object_type or Carp::croak "subtype specified without type"; 858 defined $object_type or Carp::croak "subtype specified without type";
546 my $object_subtype = shift @arg; 859 my $object_subtype = shift @arg;
547 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 860 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
548 861
549 } elsif ($type eq "package") { 862 } elsif ($type eq "package") {
550 my $pkg = shift @arg; 863 my $pkg = shift @arg;
551 864
552 while (my ($name, $id) = each %cb_id) { 865 while (my ($name, $id) = each %cb_id) {
581 _attach $registry, $klass, @attach; 894 _attach $registry, $klass, @attach;
582 } 895 }
583 896
584 $obj->{$name} = \%arg; 897 $obj->{$name} = \%arg;
585 } else { 898 } else {
586 warn "object uses attachment '$name' that is not available, postponing.\n"; 899 warn "object uses attachment '$name' which is not available, postponing.\n";
587 } 900 }
588 901
589 $obj->{_attachment}{$name} = undef; 902 $obj->{_attachment}{$name} = undef;
590} 903}
591 904
593 if (ref $_[0]) { 906 if (ref $_[0]) {
594 _object_attach @_; 907 _object_attach @_;
595 } else { 908 } else {
596 _attach shift->_attach_registry, @_; 909 _attach shift->_attach_registry, @_;
597 } 910 }
911 _recalc_want;
598}; 912};
599 913
600# all those should be optimised 914# all those should be optimised
601sub cf::attachable::detach { 915sub cf::attachable::detach {
602 my ($obj, $name) = @_; 916 my ($obj, $name) = @_;
605 delete $obj->{_attachment}{$name}; 919 delete $obj->{_attachment}{$name};
606 reattach ($obj); 920 reattach ($obj);
607 } else { 921 } else {
608 Carp::croak "cannot, currently, detach class attachments"; 922 Carp::croak "cannot, currently, detach class attachments";
609 } 923 }
924 _recalc_want;
610}; 925};
611 926
612sub cf::attachable::attached { 927sub cf::attachable::attached {
613 my ($obj, $name) = @_; 928 my ($obj, $name) = @_;
614 929
629 "; 944 ";
630 die if $@; 945 die if $@;
631} 946}
632 947
633our $override; 948our $override;
634our @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?
635 950
636sub override { 951sub override {
637 $override = 1; 952 $override = 1;
638 @invoke_results = (); 953 @INVOKE_RESULTS = (@_);
639} 954}
640 955
641sub do_invoke { 956sub do_invoke {
642 my $event = shift; 957 my $event = shift;
643 my $callbacks = shift; 958 my $callbacks = shift;
644 959
645 @invoke_results = (); 960 @INVOKE_RESULTS = ();
646 961
647 local $override; 962 local $override;
648 963
649 for (@$callbacks) { 964 for (@$callbacks) {
650 eval { &{$_->[1]} }; 965 eval { &{$_->[1]} };
659 } 974 }
660 975
661 0 976 0
662} 977}
663 978
664=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 979=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
665 980
666=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 981=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
667 982
668Generate an object-specific event with the given arguments. 983Generate an object-specific event with the given arguments.
669 984
670This 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
671removed 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
672results (if you must, access C<@cf::invoke_results> directly). 987results (if you must, access C<@cf::INVOKE_RESULTS> directly).
673 988
674=back 989=back
675 990
676=cut 991=cut
677 992
678############################################################################# 993#############################################################################
679# 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}
680 1037
681sub reattach { 1038sub reattach {
682 # basically do the same as instantiate, without calling instantiate 1039 # basically do the same as instantiate, without calling instantiate
683 my ($obj) = @_; 1040 my ($obj) = @_;
1041
1042 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
684 1043
685 my $registry = $obj->registry; 1044 my $registry = $obj->registry;
686 1045
687 @$registry = (); 1046 @$registry = ();
688 1047
703cf::attachable->attach ( 1062cf::attachable->attach (
704 prio => -1000000, 1063 prio => -1000000,
705 on_instantiate => sub { 1064 on_instantiate => sub {
706 my ($obj, $data) = @_; 1065 my ($obj, $data) = @_;
707 1066
708 $data = from_json $data; 1067 $data = decode_json $data;
709 1068
710 for (@$data) { 1069 for (@$data) {
711 my ($name, $args) = @$_; 1070 my ($name, $args) = @$_;
712 1071
713 $obj->attach ($name, %{$args || {} }); 1072 $obj->attach ($name, %{$args || {} });
729sub object_freezer_save { 1088sub object_freezer_save {
730 my ($filename, $rdata, $objs) = @_; 1089 my ($filename, $rdata, $objs) = @_;
731 1090
732 sync_job { 1091 sync_job {
733 if (length $$rdata) { 1092 if (length $$rdata) {
1093 utf8::decode (my $decname = $filename);
734 warn sprintf "saving %s (%d,%d)\n", 1094 warn sprintf "saving %s (%d,%d)\n",
735 $filename, length $$rdata, scalar @$objs; 1095 $decname, length $$rdata, scalar @$objs;
736 1096
737 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1097 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
738 chmod SAVE_MODE, $fh; 1098 chmod SAVE_MODE, $fh;
739 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1099 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
740 aio_fsync $fh; 1100 aio_fsync $fh if $cf::USE_FSYNC;
741 close $fh; 1101 close $fh;
742 1102
743 if (@$objs) { 1103 if (@$objs) {
744 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) {
745 chmod SAVE_MODE, $fh; 1105 chmod SAVE_MODE, $fh;
746 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1106 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
747 aio_write $fh, 0, (length $data), $data, 0; 1107 aio_write $fh, 0, (length $data), $data, 0;
748 aio_fsync $fh; 1108 aio_fsync $fh if $cf::USE_FSYNC;
749 close $fh; 1109 close $fh;
750 aio_rename "$filename.pst~", "$filename.pst"; 1110 aio_rename "$filename.pst~", "$filename.pst";
751 } 1111 }
752 } else { 1112 } else {
753 aio_unlink "$filename.pst"; 1113 aio_unlink "$filename.pst";
759 } 1119 }
760 } else { 1120 } else {
761 aio_unlink $filename; 1121 aio_unlink $filename;
762 aio_unlink "$filename.pst"; 1122 aio_unlink "$filename.pst";
763 } 1123 }
764 } 1124 };
765} 1125}
766 1126
767sub object_freezer_as_string { 1127sub object_freezer_as_string {
768 my ($rdata, $objs) = @_; 1128 my ($rdata, $objs) = @_;
769 1129
781 or return; 1141 or return;
782 1142
783 unless (aio_stat "$filename.pst") { 1143 unless (aio_stat "$filename.pst") {
784 (aio_load "$filename.pst", $av) >= 0 1144 (aio_load "$filename.pst", $av) >= 0
785 or return; 1145 or return;
1146
786 $av = eval { (Storable::thaw $av)->{objs} }; 1147 my $st = eval { Coro::Storable::thaw $av };
1148 $av = $st->{objs};
787 } 1149 }
788 1150
1151 utf8::decode (my $decname = $filename);
789 warn sprintf "loading %s (%d)\n", 1152 warn sprintf "loading %s (%d,%d)\n",
790 $filename, length $data, scalar @{$av || []};#d# 1153 $decname, length $data, scalar @{$av || []};
1154
791 return ($data, $av); 1155 ($data, $av)
792} 1156}
1157
1158=head2 COMMAND CALLBACKS
1159
1160=over 4
1161
1162=cut
793 1163
794############################################################################# 1164#############################################################################
795# command handling &c 1165# command handling &c
796 1166
797=item cf::register_command $name => \&callback($ob,$args); 1167=item cf::register_command $name => \&callback($ob,$args);
810 push @{ $COMMAND{$name} }, [$caller, $cb]; 1180 push @{ $COMMAND{$name} }, [$caller, $cb];
811} 1181}
812 1182
813=item cf::register_extcmd $name => \&callback($pl,$packet); 1183=item cf::register_extcmd $name => \&callback($pl,$packet);
814 1184
815Register 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.
816 1190
817If 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
818called. 1192called.
819 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
820=cut 1205=cut
821 1206
822sub register_extcmd { 1207sub register_extcmd {
823 my ($name, $cb) = @_; 1208 my ($name, $cb) = @_;
824 1209
825 $EXTCMD{$name} = $cb; 1210 $EXTCMD{$name} = $cb;
1211}
1212
1213sub register_exticmd {
1214 my ($name, $cb) = @_;
1215
1216 $EXTICMD{$name} = $cb;
826} 1217}
827 1218
828cf::player->attach ( 1219cf::player->attach (
829 on_command => sub { 1220 on_command => sub {
830 my ($pl, $name, $params) = @_; 1221 my ($pl, $name, $params) = @_;
839 cf::override; 1230 cf::override;
840 }, 1231 },
841 on_extcmd => sub { 1232 on_extcmd => sub {
842 my ($pl, $buf) = @_; 1233 my ($pl, $buf) = @_;
843 1234
844 my $msg = eval { from_json $buf }; 1235 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
845 1236
846 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
847 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1245 if (my $cb = $EXTCMD{$type}) {
848 if (my %reply = $cb->($pl, $msg)) { 1246 @reply = $cb->($pl, @payload);
849 $pl->ext_reply ($msg->{msgid}, %reply);
850 }
851 } 1247 }
1248
1249 $pl->ext_reply ($reply, @reply)
1250 if $reply;
1251
852 } else { 1252 } else {
853 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1253 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
854 } 1254 }
855 1255
856 cf::override; 1256 cf::override;
857 }, 1257 },
858); 1258);
859 1259
860sub load_extension {
861 my ($path) = @_;
862
863 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
864 my $base = $1;
865 my $pkg = $1;
866 $pkg =~ s/[^[:word:]]/_/g;
867 $pkg = "ext::$pkg";
868
869 warn "... loading '$path' into '$pkg'\n";
870
871 open my $fh, "<:utf8", $path
872 or die "$path: $!";
873
874 my $source =
875 "package $pkg; use strict; use utf8;\n"
876 . "#line 1 \"$path\"\n{\n"
877 . (do { local $/; <$fh> })
878 . "\n};\n1";
879
880 unless (eval $source) {
881 my $msg = $@ ? "$path: $@\n"
882 : "extension disabled.\n";
883 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
884 warn $@;
885 warn "mandatory extension failed to load, exiting.\n";
886 exit 1;
887 }
888 die $@;
889 }
890
891 push @EXTS, $pkg;
892}
893
894sub load_extensions { 1260sub load_extensions {
1261 cf::sync_job {
1262 my %todo;
1263
895 for my $ext (<$LIBDIR/*.ext>) { 1264 for my $path (<$LIBDIR/*.ext>) {
896 next unless -r $ext; 1265 next unless -r $path;
897 eval { 1266
898 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;
899 1 1324 }
900 } or warn "$ext not loaded: $@"; 1325
1326 skip:
1327 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1328 unless $progress;
1329 }
901 } 1330 };
902} 1331}
903 1332
904############################################################################# 1333#############################################################################
905 1334
1335=back
1336
906=head2 CORE EXTENSIONS 1337=head2 CORE EXTENSIONS
907 1338
908Functions and methods that extend core crossfire objects. 1339Functions and methods that extend core crossfire objects.
909 1340
910=cut 1341=cut
915 1346
916=head3 cf::player 1347=head3 cf::player
917 1348
918=over 4 1349=over 4
919 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
920=item cf::player::find $login 1365=item cf::player::find $login
921 1366
922Returns the given player object, loading it if necessary (might block). 1367Returns the given player object, loading it if necessary (might block).
923 1368
924=cut 1369=cut
925 1370
926sub playerdir($) { 1371sub playerdir($) {
927 cf::localdir 1372 "$PLAYERDIR/"
928 . "/"
929 . cf::playerdir
930 . "/"
931 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1373 . (ref $_[0] ? $_[0]->ob->name : $_[0])
932} 1374}
933 1375
934sub path($) { 1376sub path($) {
935 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1377 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
936 1378
937 (playerdir $login) . "/$login.pl" 1379 (playerdir $login) . "/playerdata"
938} 1380}
939 1381
940sub find_active($) { 1382sub find_active($) {
941 $cf::PLAYER{$_[0]} 1383 $cf::PLAYER{$_[0]}
942 and $cf::PLAYER{$_[0]}->active 1384 and $cf::PLAYER{$_[0]}->active
945 1387
946sub exists($) { 1388sub exists($) {
947 my ($login) = @_; 1389 my ($login) = @_;
948 1390
949 $cf::PLAYER{$login} 1391 $cf::PLAYER{$login}
950 or cf::sync_job { !aio_stat $login } 1392 or cf::sync_job { !aio_stat path $login }
951} 1393}
952 1394
953sub find($) { 1395sub find($) {
954 return $cf::PLAYER{$_[0]} || do { 1396 return $cf::PLAYER{$_[0]} || do {
955 my $login = $_[0]; 1397 my $login = $_[0];
956 1398
957 my $guard = cf::lock_acquire "user_find:$login"; 1399 my $guard = cf::lock_acquire "user_find:$login";
958 1400
959 $cf::PLAYER{$_[0]} || do { 1401 $cf::PLAYER{$_[0]} || do {
960 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
961 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;
962 $cf::PLAYER{$login} = $pl 1416 $cf::PLAYER{$login} = $pl
963 } 1417 }
964 } 1418 }
965} 1419}
966 1420
976 1430
977 aio_mkdir playerdir $pl, 0770; 1431 aio_mkdir playerdir $pl, 0770;
978 $pl->{last_save} = $cf::RUNTIME; 1432 $pl->{last_save} = $cf::RUNTIME;
979 1433
980 $pl->save_pl ($path); 1434 $pl->save_pl ($path);
981 Coro::cede; 1435 cf::cede_to_tick;
982} 1436}
983 1437
984sub new($) { 1438sub new($) {
985 my ($login) = @_; 1439 my ($login) = @_;
986 1440
992 $cf::PLAYER{$login} = $self; 1446 $cf::PLAYER{$login} = $self;
993 1447
994 $self 1448 $self
995} 1449}
996 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
997=item $pl->quit_character 1461=item $pl->quit_character
998 1462
999Nukes the player without looking back. If logged in, the connection will 1463Nukes the player without looking back. If logged in, the connection will
1000be destroyed. May block for a long time. 1464be destroyed. May block for a long time.
1001 1465
1002=cut 1466=cut
1003 1467
1004sub quit_character { 1468sub quit_character {
1005 my ($pl) = @_; 1469 my ($pl) = @_;
1470
1471 my $name = $pl->ob->name;
1006 1472
1007 $pl->{deny_save} = 1; 1473 $pl->{deny_save} = 1;
1008 $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
1009 1475
1010 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1476 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1015 my $path = playerdir $pl; 1481 my $path = playerdir $pl;
1016 my $temp = "$path~$cf::RUNTIME~deleting~"; 1482 my $temp = "$path~$cf::RUNTIME~deleting~";
1017 aio_rename $path, $temp; 1483 aio_rename $path, $temp;
1018 delete $cf::PLAYER{$pl->ob->name}; 1484 delete $cf::PLAYER{$pl->ob->name};
1019 $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
1020 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;
1021} 1507}
1022 1508
1023=item cf::player::list_logins 1509=item cf::player::list_logins
1024 1510
1025Returns 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
1026while and may block, so not sync_job-capable, ever. 1512while and may block, so not sync_job-capable, ever.
1027 1513
1028=cut 1514=cut
1029 1515
1030sub list_logins { 1516sub list_logins {
1031 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1517 my $dirs = aio_readdir $PLAYERDIR
1032 or return []; 1518 or return [];
1033 1519
1034 my @logins; 1520 my @logins;
1035 1521
1036 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") {
1037 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1527 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1038 aio_read $fh, 0, 512, my $buf, 0 or next; 1528 aio_read $fh, 0, 512, my $buf, 0 or next;
1039 $buf !~ /^password -------------$/m or next; # official not-valid tag 1529 $buf !~ /^password -------------$/m or next; # official not-valid tag
1530 }
1040 1531
1041 utf8::decode $login; 1532 utf8::decode $login;
1042 push @logins, $login; 1533 push @logins, $login;
1043 } 1534 }
1044 1535
1052 1543
1053=cut 1544=cut
1054 1545
1055sub maps($) { 1546sub maps($) {
1056 my ($pl) = @_; 1547 my ($pl) = @_;
1548
1549 $pl = ref $pl ? $pl->ob->name : $pl;
1057 1550
1058 my $files = aio_readdir playerdir $pl 1551 my $files = aio_readdir playerdir $pl
1059 or return; 1552 or return;
1060 1553
1061 my @paths; 1554 my @paths;
1063 for (@$files) { 1556 for (@$files) {
1064 utf8::decode $_; 1557 utf8::decode $_;
1065 next if /\.(?:pl|pst)$/; 1558 next if /\.(?:pl|pst)$/;
1066 next unless /^$PATH_SEP/o; 1559 next unless /^$PATH_SEP/o;
1067 1560
1068 s/\.map$//; 1561 push @paths, cf::map::normalise "~$pl/$_";
1069 push @paths, "~" . $pl->ob->name . "/" . $_;
1070 } 1562 }
1071 1563
1072 \@paths 1564 \@paths
1073} 1565}
1074 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
1075=item $player->ext_reply ($msgid, $msgtype, %msg) 1660=item $player->ext_reply ($msgid, @msg)
1076 1661
1077Sends an ext reply to the player. 1662Sends an ext reply to the player.
1078 1663
1079=cut 1664=cut
1080 1665
1081sub ext_reply($$$%) { 1666sub ext_reply($$@) {
1082 my ($self, $id, %msg) = @_; 1667 my ($self, $id, @msg) = @_;
1083 1668
1084 $msg{msgid} = $id; 1669 $self->ns->ext_reply ($id, @msg)
1085
1086 $self->send ("ext " . cf::to_json \%msg);
1087} 1670}
1088 1671
1089package 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}
1090 1712
1091=back 1713=back
1092
1093 1714
1094=head3 cf::map 1715=head3 cf::map
1095 1716
1096=over 4 1717=over 4
1097 1718
1101 1722
1102use Fcntl; 1723use Fcntl;
1103use Coro::AIO; 1724use Coro::AIO;
1104 1725
1105use overload 1726use overload
1106 '""' => \&as_string; 1727 '""' => \&as_string,
1728 fallback => 1;
1107 1729
1108our $MAX_RESET = 3600; 1730our $MAX_RESET = 3600;
1109our $DEFAULT_RESET = 3000; 1731our $DEFAULT_RESET = 3000;
1110 1732
1111sub generate_random_map { 1733sub generate_random_map {
1112 my ($self, $rmp) = @_; 1734 my ($self, $rmp) = @_;
1113
1114 # mit "rum" bekleckern, nicht 1735 # mit "rum" bekleckern, nicht
1115 $self->_create_random_map ( 1736 $self->_create_random_map (
1116 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1737 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1117 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1738 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1118 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1739 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1125 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1746 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1126 (cf::region::find $rmp->{region}), $rmp->{custom} 1747 (cf::region::find $rmp->{region}), $rmp->{custom}
1127 ) 1748 )
1128} 1749}
1129 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
1130sub register { 1759sub register {
1131 my (undef, $regex) = @_; 1760 my (undef, $regex, $prio) = @_;
1132 my $pkg = caller; 1761 my $pkg = caller;
1133 1762
1134 no strict; 1763 no strict;
1135 push @{"$pkg\::ISA"}, __PACKAGE__; 1764 push @{"$pkg\::ISA"}, __PACKAGE__;
1136 1765
1137 $EXT_MAP{$pkg} = qr<$regex>; 1766 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1138} 1767}
1139 1768
1140# also paths starting with '/' 1769# also paths starting with '/'
1141$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}
1142 1781
1143sub normalise { 1782sub normalise {
1144 my ($path, $base) = @_; 1783 my ($path, $base) = @_;
1784
1785 $path = "$path"; # make sure its a string
1786
1787 $path =~ s/\.map$//;
1145 1788
1146 # map plan: 1789 # map plan:
1147 # 1790 #
1148 # /! non-realised random map exit (special hack!) 1791 # /! non-realised random map exit (special hack!)
1149 # {... are special paths that are not being touched 1792 # {... are special paths that are not being touched
1177 1820
1178 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
1179 1822
1180 $path = normalise $path, $base; 1823 $path = normalise $path, $base;
1181 1824
1182 for my $pkg (keys %EXT_MAP) { 1825 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1183 if ($path =~ $EXT_MAP{$pkg}) { 1826 if ($path =~ $EXT_MAP{$pkg}[1]) {
1184 my $self = bless cf::map::new, $pkg; 1827 my $self = bless cf::map::new, $pkg;
1185 $self->{path} = $path; $self->path ($path); 1828 $self->{path} = $path; $self->path ($path);
1186 $self->init; # pass $1 etc. 1829 $self->init; # pass $1 etc.
1187 return $self; 1830 return $self;
1188 } 1831 }
1189 } 1832 }
1190 1833
1191 Carp::carp "unable to resolve path '$path'."; 1834 Carp::cluck "unable to resolve path '$path' (base '$base').";
1192 () 1835 ()
1193} 1836}
1194 1837
1195sub init { 1838sub init {
1196 my ($self) = @_; 1839 my ($self) = @_;
1211 1854
1212# the original (read-only) location 1855# the original (read-only) location
1213sub load_path { 1856sub load_path {
1214 my ($self) = @_; 1857 my ($self) = @_;
1215 1858
1216 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path} 1859 "$MAPDIR/$self->{path}.map"
1217} 1860}
1218 1861
1219# the temporary/swap location 1862# the temporary/swap location
1220sub save_path { 1863sub save_path {
1221 my ($self) = @_; 1864 my ($self) = @_;
1222 1865
1223 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1866 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1224 sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $path 1867 "$TMPDIR/$path.map"
1225} 1868}
1226 1869
1227# the unique path, undef == no special unique path 1870# the unique path, undef == no special unique path
1228sub uniq_path { 1871sub uniq_path {
1229 my ($self) = @_; 1872 my ($self) = @_;
1230 1873
1231 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1874 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1232 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1875 "$UNIQUEDIR/$path"
1233} 1876}
1234 1877
1235# and all this just because we cannot iterate over 1878# and all this just because we cannot iterate over
1236# all maps in C++... 1879# all maps in C++...
1237sub change_all_map_light { 1880sub change_all_map_light {
1239 1882
1240 $_->change_map_light ($change) 1883 $_->change_map_light ($change)
1241 for grep $_->outdoor, values %cf::MAP; 1884 for grep $_->outdoor, values %cf::MAP;
1242} 1885}
1243 1886
1887sub decay_objects {
1888 my ($self) = @_;
1889
1890 return if $self->{deny_reset};
1891
1892 $self->do_decay_objects;
1893}
1894
1244sub unlink_save { 1895sub unlink_save {
1245 my ($self) = @_; 1896 my ($self) = @_;
1246 1897
1247 utf8::encode (my $save = $self->save_path); 1898 utf8::encode (my $save = $self->save_path);
1248 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink $save; 1899 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1249 IO::AIO::aioreq_pri 4; IO::AIO::aio_unlink "$save.pst"; 1900 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1250} 1901}
1251 1902
1252sub load_header_from($) { 1903sub load_header_from($) {
1253 my ($self, $path) = @_; 1904 my ($self, $path) = @_;
1254 1905
1255 utf8::encode $path; 1906 utf8::encode $path;
1256 aio_open $path, O_RDONLY, 0 1907 my $f = new_from_file cf::object::thawer $path
1257 or return; 1908 or return;
1258 1909
1259 $self->_load_header ($path) 1910 $self->_load_header ($f)
1260 or return; 1911 or return;
1261 1912
1913 local $MAP_LOADING{$self->{path}} = $self;
1914 $f->resolve_delayed_derefs;
1915
1262 $self->{load_path} = $path; 1916 $self->{load_path} = $path;
1263 1917
1264 1 1918 1
1265} 1919}
1266 1920
1267sub load_orig { 1921sub load_header_orig {
1268 my ($self) = @_; 1922 my ($self) = @_;
1269 1923
1270 $self->load_header_from ($self->load_path) 1924 $self->load_header_from ($self->load_path)
1271} 1925}
1272 1926
1273sub load_temp { 1927sub load_header_temp {
1274 my ($self) = @_; 1928 my ($self) = @_;
1275 1929
1276 $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;
1277} 1950}
1278 1951
1279sub load_header { 1952sub load_header {
1280 my ($self) = @_; 1953 my ($self) = @_;
1281 1954
1282 if ($self->load_temp) { 1955 if ($self->load_header_temp) {
1283 $self->last_access ((delete $self->{last_access}) 1956 $self->prepare_temp;
1284 || $cf::RUNTIME); #d#
1285 # safety
1286 $self->{instantiate_time} = $cf::RUNTIME
1287 if $self->{instantiate_time} > $cf::RUNTIME;
1288 } else { 1957 } else {
1289 $self->load_orig 1958 $self->load_header_orig
1290 or return; 1959 or return;
1291 1960 $self->prepare_orig;
1292 $self->{load_original} = 1;
1293 $self->{instantiate_time} = $cf::RUNTIME;
1294 $self->last_access ($cf::RUNTIME);
1295 $self->instantiate;
1296 } 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;
1297 1968
1298 1 1969 1
1299} 1970}
1300 1971
1301sub find; 1972sub find;
1302sub find { 1973sub find {
1303 my ($path, $origin) = @_; 1974 my ($path, $origin) = @_;
1304 1975
1305 $path = normalise $path, $origin && $origin->path; 1976 $path = normalise $path, $origin && $origin->path;
1306 1977
1978 cf::lock_wait "map_data:$path";#d#remove
1307 cf::lock_wait "map_find:$path"; 1979 cf::lock_wait "map_find:$path";
1308 1980
1309 $cf::MAP{$path} || do { 1981 $cf::MAP{$path} || do {
1310 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
1311 my $map = new_from_path cf::map $path 1985 my $map = new_from_path cf::map $path
1312 or return; 1986 or return;
1313 1987
1314 $map->{last_save} = $cf::RUNTIME; 1988 $map->{last_save} = $cf::RUNTIME;
1315 1989
1316 $map->load_header 1990 $map->load_header
1317 or return; 1991 or return;
1318 1992
1319 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;
1320 $map->reset; 1998 $map->reset;
1321 undef $guard;
1322 $map = find $path 1999 return find $path;
1323 or return;
1324 } 2000 }
1325 2001
1326 $cf::MAP{$path} = $map 2002 $cf::MAP{$path} = $map
1327 } 2003 }
1328} 2004}
2005
2006sub pre_load { }
2007sub post_load { }
1329 2008
1330sub load { 2009sub load {
1331 my ($self) = @_; 2010 my ($self) = @_;
1332 2011
2012 local $self->{deny_reset} = 1; # loading can take a long time
2013
1333 my $path = $self->{path}; 2014 my $path = $self->{path};
2015
2016 {
1334 my $guard = cf::lock_acquire "map_load:$path"; 2017 my $guard = cf::lock_acquire "map_data:$path";
1335 2018
2019 return unless $self->valid;
1336 return if $self->in_memory != cf::MAP_SWAPPED; 2020 return unless $self->in_memory == cf::MAP_SWAPPED;
1337 2021
1338 $self->in_memory (cf::MAP_LOADING); 2022 $self->in_memory (cf::MAP_LOADING);
1339 2023
1340 $self->alloc; 2024 $self->alloc;
1341 $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)
1342 or return; 2032 or return;
1343 2033
1344 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2034 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1345 if delete $self->{load_original}; 2035 if delete $self->{load_original};
1346 2036
1347 if (my $uniq = $self->uniq_path) { 2037 if (my $uniq = $self->uniq_path) {
1348 utf8::encode $uniq; 2038 utf8::encode $uniq;
1349 if (aio_open $uniq, O_RDONLY, 0) { 2039 unless (aio_stat $uniq) {
2040 if (my $f = new_from_file cf::object::thawer $uniq) {
1350 $self->clear_unique_items; 2041 $self->clear_unique_items;
1351 $self->_load_objects ($uniq, 0); 2042 $self->_load_objects ($f);
2043 $f->resolve_delayed_derefs;
2044 }
1352 } 2045 }
1353 } 2046 }
1354 2047
1355 Coro::cede; 2048 $f->resolve_delayed_derefs;
1356 2049
2050 cf::cede_to_tick;
1357 # now do the right thing for maps 2051 # now do the right thing for maps
1358 $self->link_multipart_objects; 2052 $self->link_multipart_objects;
1359
1360 unless ($self->{deny_activate}) {
1361 $self->decay_objects;
1362 $self->fix_auto_apply;
1363 $self->update_buttons;
1364 Coro::cede;
1365 $self->set_darkness_map;
1366 $self->difficulty ($self->estimate_difficulty) 2053 $self->difficulty ($self->estimate_difficulty)
1367 unless $self->difficulty; 2054 unless $self->difficulty;
1368 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;
1369 $self->activate; 2064 $self->activate;
1370 } 2065 }
1371 2066
2067 $self->{last_save} = $cf::RUNTIME;
2068 $self->last_access ($cf::RUNTIME);
2069
1372 $self->in_memory (cf::MAP_IN_MEMORY); 2070 $self->in_memory (cf::MAP_IN_MEMORY);
2071 }
2072
2073 $self->post_load;
1373} 2074}
1374 2075
1375sub customise_for { 2076sub customise_for {
1376 my ($self, $ob) = @_; 2077 my ($self, $ob) = @_;
1377 2078
1378 return find "~" . $ob->name . "/" . $self->{path} 2079 return find "~" . $ob->name . "/" . $self->{path}
1379 if $self->per_player; 2080 if $self->per_player;
1380 2081
2082# return find "?party/" . $ob->name . "/" . $self->{path}
2083# if $self->per_party;
2084
1381 $self 2085 $self
1382} 2086}
1383 2087
1384# 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
1385sub load_diag { 2089sub load_neighbours {
1386 my ($map) = @_; 2090 my ($map) = @_;
1387 2091
1388 my @diag; # diagonal neighbours 2092 my @neigh; # diagonal neighbours
1389 2093
1390 for (0 .. 3) { 2094 for (0 .. 3) {
1391 my $neigh = $map->tile_path ($_) 2095 my $neigh = $map->tile_path ($_)
1392 or next; 2096 or next;
1393 $neigh = find $neigh, $map 2097 $neigh = find $neigh, $map
1394 or next; 2098 or next;
1395 $neigh->load; 2099 $neigh->load;
1396 2100
2101 push @neigh,
1397 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2102 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1398 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2103 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1399 } 2104 }
1400 2105
1401 for (@diag) { 2106 for (grep defined $_->[0], @neigh) {
2107 my ($path, $origin) = @$_;
1402 my $neigh = find @$_ 2108 my $neigh = find $path, $origin
1403 or next; 2109 or next;
1404 $neigh->load; 2110 $neigh->load;
1405 } 2111 }
1406} 2112}
1407 2113
1412} 2118}
1413 2119
1414sub do_load_sync { 2120sub do_load_sync {
1415 my ($map) = @_; 2121 my ($map) = @_;
1416 2122
2123 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2124 if $Coro::current == $Coro::main;
2125
1417 cf::sync_job { $map->load }; 2126 cf::sync_job { $map->load };
1418} 2127}
1419 2128
1420our %MAP_PREFETCH; 2129our %MAP_PREFETCH;
1421our $MAP_PREFETCHER = Coro::async { 2130our $MAP_PREFETCHER = undef;
1422 while () {
1423 for my $path (keys %MAP_PREFETCH) {
1424 my $map = find $path
1425 or next;
1426 $map->load;
1427
1428 delete $MAP_PREFETCH{$path};
1429 }
1430 Coro::schedule;
1431 }
1432};
1433 2131
1434sub find_async { 2132sub find_async {
1435 my ($path, $origin) = @_; 2133 my ($path, $origin, $load) = @_;
1436 2134
1437 $path = normalise $path, $origin && $origin->{path}; 2135 $path = normalise $path, $origin && $origin->{path};
1438 2136
1439 if (my $map = $cf::MAP{$path}) { 2137 if (my $map = $cf::MAP{$path}) {
1440 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;
1441 } 2156 };
1442
1443 $MAP_PREFETCH{$path} = 0;
1444 $MAP_PREFETCHER->ready; 2157 $MAP_PREFETCHER->prio (6);
1445 2158
1446 () 2159 ()
1447} 2160}
1448 2161
1449sub save { 2162sub save {
1450 my ($self) = @_; 2163 my ($self) = @_;
1451 2164
1452 my $lock = cf::lock_acquire "map_data:" . $self->path; 2165 my $lock = cf::lock_acquire "map_data:$self->{path}";
1453 2166
1454 $self->{last_save} = $cf::RUNTIME; 2167 $self->{last_save} = $cf::RUNTIME;
1455 2168
1456 return unless $self->dirty; 2169 return unless $self->dirty;
1457 2170
1463 return if $self->{deny_save}; 2176 return if $self->{deny_save};
1464 2177
1465 local $self->{last_access} = $self->last_access;#d# 2178 local $self->{last_access} = $self->last_access;#d#
1466 2179
1467 cf::async { 2180 cf::async {
2181 $Coro::current->{desc} = "map player save";
1468 $_->contr->save for $self->players; 2182 $_->contr->save for $self->players;
1469 }; 2183 };
1470 2184
1471 if ($uniq) { 2185 if ($uniq) {
1472 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2186 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1480 my ($self) = @_; 2194 my ($self) = @_;
1481 2195
1482 # save first because save cedes 2196 # save first because save cedes
1483 $self->save; 2197 $self->save;
1484 2198
1485 my $lock = cf::lock_acquire "map_data:" . $self->path; 2199 my $lock = cf::lock_acquire "map_data:$self->{path}";
1486 2200
1487 return if $self->players; 2201 return if $self->players;
1488 return if $self->in_memory != cf::MAP_IN_MEMORY; 2202 return if $self->in_memory != cf::MAP_IN_MEMORY;
1489 return if $self->{deny_save}; 2203 return if $self->{deny_save};
1490 2204
2205 $self->in_memory (cf::MAP_SWAPPED);
2206
2207 $self->deactivate;
2208 $_->clear_links_to ($self) for values %cf::MAP;
1491 $self->clear; 2209 $self->clear;
1492 $self->in_memory (cf::MAP_SWAPPED);
1493} 2210}
1494 2211
1495sub reset_at { 2212sub reset_at {
1496 my ($self) = @_; 2213 my ($self) = @_;
1497 2214
1498 # TODO: safety, remove and allow resettable per-player maps 2215 # TODO: safety, remove and allow resettable per-player maps
1499 return 1e99 if $self->isa ("ext::map_per_player");
1500 return 1e99 if $self->{deny_reset}; 2216 return 1e99 if $self->{deny_reset};
1501 2217
1502 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2218 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1503 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;
1504 2220
1509 my ($self) = @_; 2225 my ($self) = @_;
1510 2226
1511 $self->reset_at <= $cf::RUNTIME 2227 $self->reset_at <= $cf::RUNTIME
1512} 2228}
1513 2229
1514sub rename {
1515 my ($self, $new_path) = @_;
1516
1517 normalise $new_path;
1518
1519 $self->unlink_save;
1520
1521 delete $cf::MAP{$self->path};
1522 $self->{path} = $new_path; $self->path ($self->{path});
1523 $cf::MAP{$self->path} = $self;
1524
1525 $self->save;
1526}
1527
1528sub reset { 2230sub reset {
1529 my ($self) = @_; 2231 my ($self) = @_;
1530 2232
1531 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2233 my $lock = cf::lock_acquire "map_data:$self->{path}";
1532 2234
1533 return if $self->players; 2235 return if $self->players;
1534 return if $self->isa ("ext::map_per_player");#d#
1535 2236
1536 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 }
1537 2248
1538 delete $cf::MAP{$self->path}; 2249 delete $cf::MAP{$self->path};
1539 2250
1540 $self->in_memory (cf::MAP_SWAPPED); 2251 $self->deactivate;
2252 $_->clear_links_to ($self) for values %cf::MAP;
1541 $self->clear; 2253 $self->clear;
1542
1543 $_->clear_links_to ($self) for values %cf::MAP;
1544 2254
1545 $self->unlink_save; 2255 $self->unlink_save;
1546 $self->destroy; 2256 $self->destroy;
1547} 2257}
1548 2258
1549my $nuke_counter = "aaaa"; 2259my $nuke_counter = "aaaa";
1550 2260
1551sub nuke { 2261sub nuke {
1552 my ($self) = @_; 2262 my ($self) = @_;
1553 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};
1554 $self->{deny_save} = 1; 2273 $self->{deny_save} = 1;
1555 $self->reset_timeout (1); 2274 $self->reset_timeout (1);
1556 $self->rename ("{nuke}/" . ($nuke_counter++)); 2275 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2276
2277 $cf::MAP{$self->path} = $self;
2278 }
2279
1557 $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 ]
1558} 2317}
1559 2318
1560=item cf::map::unique_maps 2319=item cf::map::unique_maps
1561 2320
1562Returns an arrayref of paths of all shared maps that have 2321Returns an arrayref of paths of all shared maps that have
1563instantiated unique items. May block. 2322instantiated unique items. May block.
1564 2323
1565=cut 2324=cut
1566 2325
1567sub unique_maps() { 2326sub unique_maps() {
1568 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2327 [
1569 or return; 2328 map {
1570
1571 my @paths;
1572
1573 for (@$files) {
1574 utf8::decode $_; 2329 utf8::decode $_;
1575 next if /\.pst$/;
1576 next unless /^$PATH_SEP/o;
1577
1578 s/\.map$//; 2330 /\.map$/
1579 push @paths, $_; 2331 ? normalise $_
2332 : ()
2333 } @{ aio_readdir $UNIQUEDIR or [] }
1580 } 2334 ]
1581
1582 \@paths
1583} 2335}
1584 2336
1585package cf; 2337package cf;
1586 2338
1587=back 2339=back
1605 map { $_, inv_recursive_ $_->inv } @_ 2357 map { $_, inv_recursive_ $_->inv } @_
1606} 2358}
1607 2359
1608sub inv_recursive { 2360sub inv_recursive {
1609 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 }
1610} 2390}
1611 2391
1612package cf; 2392package cf;
1613 2393
1614=back 2394=back
1633 2413
1634 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2414 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1635 2415
1636 if ($self->{record_replies}) { 2416 if ($self->{record_replies}) {
1637 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2417 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2418
1638 } 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 {
1639 $msg = $npc->name . " says: $msg" if $npc; 2427 $msg = $npc->name . " says: $msg" if $npc;
1640 $self->message ($msg, $flags); 2428 $self->message ($msg, $flags);
2429 }
1641 } 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 (@_);
1642} 2441}
1643 2442
1644=item $player_object->may ("access") 2443=item $player_object->may ("access")
1645 2444
1646Returns wether the given player is authorized to access resource "access" 2445Returns wether the given player is authorized to access resource "access"
1678=cut 2477=cut
1679 2478
1680sub link_map { 2479sub link_map {
1681 unless ($LINK_MAP) { 2480 unless ($LINK_MAP) {
1682 $LINK_MAP = cf::map::find "{link}" 2481 $LINK_MAP = cf::map::find "{link}"
1683 or do { warn "FATAL: unable to provide {link} map, exiting."; exit 1 }; 2482 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1684 $LINK_MAP->load; 2483 $LINK_MAP->load;
1685 } 2484 }
1686 2485
1687 $LINK_MAP 2486 $LINK_MAP
1688} 2487}
1693 $self->deactivate_recursive; 2492 $self->deactivate_recursive;
1694 2493
1695 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2494 return if UNIVERSAL::isa $self->map, "ext::map_link";
1696 2495
1697 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2496 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1698 if $self->map; 2497 if $self->map && $self->map->{path} ne "{link}";
1699 2498
1700 $self->enter_map ($LINK_MAP || link_map, 20, 20); 2499 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1701} 2500}
1702 2501
1703sub cf::object::player::leave_link { 2502sub cf::object::player::leave_link {
1704 my ($self, $map, $x, $y) = @_; 2503 my ($self, $map, $x, $y) = @_;
2504
2505 return unless $self->contr->active;
1705 2506
1706 my $link_pos = delete $self->{_link_pos}; 2507 my $link_pos = delete $self->{_link_pos};
1707 2508
1708 unless ($map) { 2509 unless ($map) {
1709 # restore original map position 2510 # restore original map position
1723 # use -1 or undef as default coordinates, not 0, 0 2524 # use -1 or undef as default coordinates, not 0, 0
1724 ($x, $y) = ($map->enter_x, $map->enter_y) 2525 ($x, $y) = ($map->enter_x, $map->enter_y)
1725 if $x <=0 && $y <= 0; 2526 if $x <=0 && $y <= 0;
1726 2527
1727 $map->load; 2528 $map->load;
1728 $map->load_diag; 2529 $map->load_neighbours;
1729 2530
1730 return unless $self->contr->active; 2531 return unless $self->contr->active;
1731 $self->activate_recursive; 2532 $self->activate_recursive;
2533
2534 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1732 $self->enter_map ($map, $x, $y); 2535 $self->enter_map ($map, $x, $y);
1733} 2536}
1734 2537
1735cf::player->attach ( 2538=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1736 on_logout => sub {
1737 my ($pl) = @_;
1738 2539
1739 # abort map switching before logout 2540Moves the player to the given map-path and coordinates by first freezing
1740 if ($pl->ob->{_link_pos}) { 2541her, loading and preparing them map, calling the provided $check callback
1741 cf::sync_job { 2542that has to return the map if sucecssful, and then unfreezes the player on
1742 $pl->ob->leave_link 2543the new (success) or old (failed) map position. In either case, $done will
1743 }; 2544be called at the end of this process.
1744 }
1745 },
1746 on_login => sub {
1747 my ($pl) = @_;
1748 2545
1749 # try to abort aborted map switching on player login :)
1750 # should happen only on crashes
1751 if ($pl->ob->{_link_pos}) {
1752 $pl->ob->enter_link;
1753 (async {
1754 # we need this sleep as the login has a concurrent enter_exit running
1755 # and this sleep increases chances of the player not ending up in scorn
1756 $pl->ob->reply (undef,
1757 "There was an internal problem at your last logout, "
1758 . "the server will try to bring you to your intended destination in a second.",
1759 cf::NDI_RED);
1760 Coro::Timer::sleep 1;
1761 $pl->ob->leave_link;
1762 })->prio (2);
1763 }
1764 },
1765);
1766
1767=item $player_object->goto ($path, $x, $y)
1768
1769=cut 2546=cut
2547
2548our $GOTOGEN;
1770 2549
1771sub cf::object::player::goto { 2550sub cf::object::player::goto {
1772 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;
1773 2555
1774 $self->enter_link; 2556 $self->enter_link;
1775 2557
1776 (async { 2558 (async {
1777 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) {
1778 $map = $map->customise_for ($self) if $map; 2584 $map = $map->customise_for ($self);
1779 2585 $map = $check->($map) if $check && $map;
1780# warn "entering ", $map->path, " at ($x, $y)\n" 2586 } else {
1781# if $map;
1782
1783 $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 }
1784 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};
1785 $self->leave_link ($map, $x, $y); 2600 $self->leave_link ($map, $x, $y);
2601 }
2602
2603 $done->() if $done;
1786 })->prio (1); 2604 })->prio (1);
1787} 2605}
1788 2606
1789=item $player_object->enter_exit ($exit_object) 2607=item $player_object->enter_exit ($exit_object)
1790 2608
1792 2610
1793sub parse_random_map_params { 2611sub parse_random_map_params {
1794 my ($spec) = @_; 2612 my ($spec) = @_;
1795 2613
1796 my $rmp = { # defaults 2614 my $rmp = { # defaults
1797 xsize => 10, 2615 xsize => (cf::rndm 15, 40),
1798 ysize => 10, 2616 ysize => (cf::rndm 15, 40),
2617 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2618 #layout => string,
1799 }; 2619 };
1800 2620
1801 for (split /\n/, $spec) { 2621 for (split /\n/, $spec) {
1802 my ($k, $v) = split /\s+/, $_, 2; 2622 my ($k, $v) = split /\s+/, $_, 2;
1803 2623
1807 $rmp 2627 $rmp
1808} 2628}
1809 2629
1810sub prepare_random_map { 2630sub prepare_random_map {
1811 my ($exit) = @_; 2631 my ($exit) = @_;
2632
2633 my $guard = cf::lock_acquire "exit_prepare:$exit";
1812 2634
1813 # all this does is basically replace the /! path by 2635 # all this does is basically replace the /! path by
1814 # a new random map path (?random/...) with a seed 2636 # a new random map path (?random/...) with a seed
1815 # that depends on the exit object 2637 # that depends on the exit object
1816 2638
1817 my $rmp = parse_random_map_params $exit->msg; 2639 my $rmp = parse_random_map_params $exit->msg;
1818 2640
1819 if ($exit->map) { 2641 if ($exit->map) {
1820 $rmp->{region} = $exit->map->region_name; 2642 $rmp->{region} = $exit->region->name;
1821 $rmp->{origin_map} = $exit->map->path; 2643 $rmp->{origin_map} = $exit->map->path;
1822 $rmp->{origin_x} = $exit->x; 2644 $rmp->{origin_x} = $exit->x;
1823 $rmp->{origin_y} = $exit->y; 2645 $rmp->{origin_y} = $exit->y;
1824 } 2646 }
1825 2647
1826 $rmp->{random_seed} ||= $exit->random_seed; 2648 $rmp->{random_seed} ||= $exit->random_seed;
1827 2649
1828 my $data = cf::to_json $rmp; 2650 my $data = cf::encode_json $rmp;
1829 my $md5 = Digest::MD5::md5_hex $data; 2651 my $md5 = Digest::MD5::md5_hex $data;
2652 my $meta = "$RANDOMDIR/$md5.meta";
1830 2653
1831 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) {
1832 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;
1833 2658
1834 $exit->slaying ("?random/$md5"); 2659 $exit->slaying ("?random/$md5");
1835 $exit->msg (undef); 2660 $exit->msg (undef);
1836 } 2661 }
1837} 2662}
1839sub cf::object::player::enter_exit { 2664sub cf::object::player::enter_exit {
1840 my ($self, $exit) = @_; 2665 my ($self, $exit) = @_;
1841 2666
1842 return unless $self->type == cf::PLAYER; 2667 return unless $self->type == cf::PLAYER;
1843 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
1844 $self->enter_link; 2680 $self->enter_link;
1845 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
1846 (async { 2686 (async {
2687 $Coro::current->{desc} = "enter_exit $slaying $hp $sp";
2688
1847 $self->deactivate_recursive; # just to be sure 2689 $self->deactivate_recursive; # just to be sure
1848 unless (eval { 2690 unless (eval {
1849 prepare_random_map $exit 2691 $self->goto ($slaying, $hp, $sp);
1850 if $exit->slaying eq "/!";
1851
1852 my $path = new_from_path cf::map $exit->slaying, $exit->map && $exit->map->path;
1853 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1854 2692
1855 1; 2693 1;
1856 }) { 2694 }) {
1857 $self->message ("Something went wrong deep within the crossfire server. " 2695 $self->message ("Something went wrong deep within the crossfire server. "
1858 . "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. "
1859 . "Please report this to the dungeon master!", 2697 . "Please report this to the dungeon master!",
1860 cf::NDI_UNIQUE | cf::NDI_RED); 2698 cf::NDI_UNIQUE | cf::NDI_RED);
1861 2699
1862 warn "ERROR in enter_exit: $@"; 2700 warn "ERROR in enter_exit: $@";
1863 $self->leave_link; 2701 $self->leave_link;
1864 } 2702 }
1865 })->prio (1); 2703 })->prio (1);
1878 2716
1879sub cf::client::send_drawinfo { 2717sub cf::client::send_drawinfo {
1880 my ($self, $text, $flags) = @_; 2718 my ($self, $text, $flags) = @_;
1881 2719
1882 utf8::encode $text; 2720 utf8::encode $text;
1883 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2721 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1884} 2722}
1885 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}
1886 2882
1887=item $success = $client->query ($flags, "text", \&cb) 2883=item $success = $client->query ($flags, "text", \&cb)
1888 2884
1889Queues a query to the client, calling the given callback with 2885Queues a query to the client, calling the given callback with
1890the 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>,
1891C<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>.
1892 2888
1893Queries 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
1894reliable at some point in the future. 2890become reliable at some point in the future.
1895 2891
1896=cut 2892=cut
1897 2893
1898sub cf::client::query { 2894sub cf::client::query {
1899 my ($self, $flags, $text, $cb) = @_; 2895 my ($self, $flags, $text, $cb) = @_;
1907 utf8::encode $text; 2903 utf8::encode $text;
1908 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2904 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1909 2905
1910 $self->send_packet ($self->{query_queue}[0][0]) 2906 $self->send_packet ($self->{query_queue}[0][0])
1911 if @{ $self->{query_queue} } == 1; 2907 if @{ $self->{query_queue} } == 1;
2908
2909 1
1912} 2910}
1913 2911
1914cf::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 },
1915 on_reply => sub { 2918 on_reply => sub {
1916 my ($ns, $msg) = @_; 2919 my ($ns, $msg) = @_;
1917 2920
1918 # this weird shuffling is so that direct followup queries 2921 # this weird shuffling is so that direct followup queries
1919 # get handled first 2922 # get handled first
1920 my $queue = delete $ns->{query_queue} 2923 my $queue = delete $ns->{query_queue}
1921 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
1922 2925
1923 (shift @$queue)->[1]->($msg); 2926 (shift @$queue)->[1]->($msg);
2927 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1924 2928
1925 push @{ $ns->{query_queue} }, @$queue; 2929 push @{ $ns->{query_queue} }, @$queue;
1926 2930
1927 if (@{ $ns->{query_queue} } == @$queue) { 2931 if (@{ $ns->{query_queue} } == @$queue) {
1928 if (@$queue) { 2932 if (@$queue) {
1930 } else { 2934 } else {
1931 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2935 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1932 } 2936 }
1933 } 2937 }
1934 }, 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 },
1935); 2965);
1936 2966
1937=item $client->async (\&cb) 2967=item $client->async (\&cb)
1938 2968
1939Create a new coroutine, running the specified callback. The coroutine will 2969Create a new coroutine, running the specified callback. The coroutine will
1980our $safe = new Safe "safe"; 3010our $safe = new Safe "safe";
1981our $safe_hole = new Safe::Hole; 3011our $safe_hole = new Safe::Hole;
1982 3012
1983$SIG{FPE} = 'IGNORE'; 3013$SIG{FPE} = 'IGNORE';
1984 3014
1985$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));
1986 3020
1987# here we export the classes and methods available to script code 3021# here we export the classes and methods available to script code
1988 3022
1989=pod 3023=pod
1990 3024
1991The following fucntions and emthods are available within a safe environment: 3025The following functions and methods are available within a safe environment:
1992 3026
1993 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
1994 cf::object::player player 3031 cf::object::player
1995 cf::player peaceful 3032 player
1996 cf::map trigger 3033
3034 cf::player
3035 peaceful
3036
3037 cf::map
3038 trigger
1997 3039
1998=cut 3040=cut
1999 3041
2000for ( 3042for (
2001 ["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)],
2002 ["cf::object::player" => qw(player)], 3046 ["cf::object::player" => qw(player)],
2003 ["cf::player" => qw(peaceful)], 3047 ["cf::player" => qw(peaceful)],
2004 ["cf::map" => qw(trigger)], 3048 ["cf::map" => qw(trigger)],
2005) { 3049) {
2006 no strict 'refs'; 3050 no strict 'refs';
2077=back 3121=back
2078 3122
2079=cut 3123=cut
2080 3124
2081############################################################################# 3125#############################################################################
3126# the server's init and main functions
2082 3127
2083=head2 EXTENSION DATABASE SUPPORT 3128sub load_facedata($) {
3129 my ($path) = @_;
2084 3130
2085Crossfire maintains a very simple database for extension use. It can 3131 # HACK to clear player env face cache, we need some signal framework
2086currently store anything that can be serialised using Storable, which 3132 # for this (global event?)
2087excludes objects. 3133 %ext::player_env::MUSIC_FACE_CACHE = ();
2088 3134
2089The parameter C<$family> should best start with the name of the extension 3135 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2090using it, it should be unique.
2091 3136
2092=over 4 3137 warn "loading facedata from $path\n";
2093 3138
2094=item $hashref = cf::db_get $family 3139 my $facedata;
3140 0 < aio_load $path, $facedata
3141 or die "$path: $!";
2095 3142
2096Return a hashref for use by the extension C<$family>, which can be 3143 $facedata = Coro::Storable::thaw $facedata;
2097modified. After modifications, you have to call C<cf::db_dirty> or
2098C<cf::db_sync>.
2099 3144
2100=item $value = cf::db_get $family => $key 3145 $facedata->{version} == 2
3146 or cf::cleanup "$path: version mismatch, cannot proceed.";
2101 3147
2102Returns a single value from the database 3148 # patch in the exptable
2103 3149 $facedata->{resource}{"res/exp_table"} = {
2104=item cf::db_put $family => $hashref 3150 type => FT_RSRC,
2105 3151 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2106Stores the given family hashref into the database. Updates are delayed, if
2107you want the data to be synced to disk immediately, use C<cf::db_sync>.
2108
2109=item cf::db_put $family => $key => $value
2110
2111Stores the given C<$value> in the family hash. Updates are delayed, if you
2112want the data to be synced to disk immediately, use C<cf::db_sync>.
2113
2114=item cf::db_dirty
2115
2116Marks the database as dirty, to be updated at a later time.
2117
2118=item cf::db_sync
2119
2120Immediately write the database to disk I<if it is dirty>.
2121
2122=cut
2123
2124our $DB;
2125
2126{
2127 my $path = cf::localdir . "/database.pst";
2128
2129 sub db_load() {
2130 $DB = stat $path ? Storable::retrieve $path : { };
2131 }
2132
2133 my $pid;
2134
2135 sub db_save() {
2136 waitpid $pid, 0 if $pid;
2137 if (0 == ($pid = fork)) {
2138 $DB->{_meta}{version} = 1;
2139 Storable::nstore $DB, "$path~";
2140 rename "$path~", $path;
2141 cf::_exit 0 if defined $pid;
2142 }
2143 }
2144
2145 my $dirty;
2146
2147 sub db_sync() {
2148 db_save if $dirty;
2149 undef $dirty;
2150 }
2151
2152 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
2153 db_sync;
2154 }); 3152 };
3153 cf::cede_to_tick;
2155 3154
2156 sub db_dirty() {
2157 $dirty = 1;
2158 $idle->start;
2159 } 3155 {
3156 my $faces = $facedata->{faceinfo};
2160 3157
2161 sub db_get($;$) { 3158 while (my ($face, $info) = each %$faces) {
2162 @_ >= 2 3159 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2163 ? $DB->{$_[0]}{$_[1]}
2164 : ($DB->{$_[0]} ||= { })
2165 }
2166 3160
2167 sub db_put($$;$) { 3161 cf::face::set_visibility $idx, $info->{visibility};
2168 if (@_ >= 3) { 3162 cf::face::set_magicmap $idx, $info->{magicmap};
2169 $DB->{$_[0]}{$_[1]} = $_[2]; 3163 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2170 } else { 3164 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2171 $DB->{$_[0]} = $_[1];
2172 }
2173 db_dirty;
2174 }
2175 3165
2176 cf::global->attach ( 3166 cf::cede_to_tick;
2177 prio => 10000,
2178 on_cleanup => sub {
2179 db_sync;
2180 }, 3167 }
2181 );
2182}
2183 3168
2184############################################################################# 3169 while (my ($face, $info) = each %$faces) {
2185# the server's main() 3170 next unless $info->{smooth};
2186 3171
2187sub 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 {
2188 open my $fh, "<:utf8", cf::confdir . "/config" 3314 open my $fh, "<:utf8", "$CONFDIR/config"
2189 or return; 3315 or return;
2190 3316
2191 local $/; 3317 local $/;
2192 *CFG = YAML::Syck::Load <$fh>; 3318 *CFG = YAML::Syck::Load <$fh>;
2193 3319
2207 3333
2208sub main { 3334sub main {
2209 # we must not ever block the main coroutine 3335 # we must not ever block the main coroutine
2210 local $Coro::idle = sub { 3336 local $Coro::idle = sub {
2211 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#
2212 async { Event::one_event }; 3338 (async {
3339 $Coro::current->{desc} = "IDLE BUG HANDLER";
3340 EV::loop EV::LOOP_ONESHOT;
3341 })->prio (Coro::PRIO_MAX);
2213 }; 3342 };
2214 3343
2215 cfg_load; 3344 reload_config;
2216 db_load; 3345 db_init;
2217 load_extensions; 3346 load_extensions;
3347
3348 $TICK_WATCHER->start;
3349 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
2218 Event::loop; 3350 EV::loop;
2219} 3351}
2220 3352
2221############################################################################# 3353#############################################################################
2222# initialisation and cleanup 3354# initialisation and cleanup
2223 3355
2224# install some emergency cleanup handlers 3356# install some emergency cleanup handlers
2225BEGIN { 3357BEGIN {
3358 our %SIGWATCHER = ();
2226 for my $signal (qw(INT HUP TERM)) { 3359 for my $signal (qw(INT HUP TERM)) {
2227 Event->signal ( 3360 $SIGWATCHER{$signal} = EV::signal $signal, sub {
2228 data => WF_AUTOCANCEL,
2229 signal => $signal,
2230 cb => sub {
2231 cf::cleanup "SIG$signal"; 3361 cf::cleanup "SIG$signal";
2232 },
2233 ); 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
2234 } 3401 1
2235} 3402}
2236 3403
2237sub emergency_save() { 3404sub emergency_save() {
2238 my $freeze_guard = cf::freeze_mainloop; 3405 my $freeze_guard = cf::freeze_mainloop;
2239 3406
2245 # and maps saved/destroyed asynchronously. 3412 # and maps saved/destroyed asynchronously.
2246 warn "begin emergency player save\n"; 3413 warn "begin emergency player save\n";
2247 for my $login (keys %cf::PLAYER) { 3414 for my $login (keys %cf::PLAYER) {
2248 my $pl = $cf::PLAYER{$login} or next; 3415 my $pl = $cf::PLAYER{$login} or next;
2249 $pl->valid or next; 3416 $pl->valid or next;
3417 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2250 $pl->save; 3418 $pl->save;
2251 } 3419 }
2252 warn "end emergency player save\n"; 3420 warn "end emergency player save\n";
2253 3421
2254 warn "begin emergency map save\n"; 3422 warn "begin emergency map save\n";
2256 my $map = $cf::MAP{$path} or next; 3424 my $map = $cf::MAP{$path} or next;
2257 $map->valid or next; 3425 $map->valid or next;
2258 $map->save; 3426 $map->save;
2259 } 3427 }
2260 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";
2261 }; 3433 };
2262 3434
2263 warn "leave emergency perl save\n"; 3435 warn "leave emergency perl save\n";
2264} 3436}
2265 3437
3438sub post_cleanup {
3439 my ($make_core) = @_;
3440
3441 warn Carp::longmess "post_cleanup backtrace"
3442 if $make_core;
3443}
3444
2266sub reload() { 3445sub do_reload_perl() {
2267 # can/must only be called in main 3446 # can/must only be called in main
2268 if ($Coro::current != $Coro::main) { 3447 if ($Coro::current != $Coro::main) {
2269 warn "can only reload from main coroutine\n"; 3448 warn "can only reload from main coroutine";
2270 return; 3449 return;
2271 } 3450 }
2272 3451
2273 warn "reloading..."; 3452 warn "reloading...";
2274 3453
2275 warn "freezing server"; 3454 warn "entering sync_job";
2276 my $guard = freeze_mainloop; 3455
3456 cf::sync_job {
3457 cf::write_runtime; # external watchdog should not bark
2277 cf::emergency_save; 3458 cf::emergency_save;
3459 cf::write_runtime; # external watchdog should not bark
2278 3460
2279 warn "sync database to disk"; 3461 warn "syncing database to disk";
2280 cf::db_sync; 3462 BDB::db_env_txn_checkpoint $DB_ENV;
2281 IO::AIO::flush;
2282 3463
2283 eval {
2284 # 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
2285 3465
2286 warn "cancel all watchers"; 3466 warn "flushing outstanding aio requests";
2287 for (Event::all_watchers) { 3467 for (;;) {
2288 $_->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...";
2289 } 3473 }
2290 3474
3475 ++$RELOAD;
3476
2291 warn "cancel all extension coros"; 3477 warn "cancelling all extension coros";
2292 $_->cancel for values %EXT_CORO; 3478 $_->cancel for values %EXT_CORO;
2293 %EXT_CORO = (); 3479 %EXT_CORO = ();
2294 3480
2295 warn "remove commands"; 3481 warn "removing commands";
2296 %COMMAND = (); 3482 %COMMAND = ();
2297 3483
2298 warn "remove ext commands"; 3484 warn "removing ext/exti commands";
2299 %EXTCMD = (); 3485 %EXTCMD = ();
3486 %EXTICMD = ();
2300 3487
2301 warn "unload/nuke all extensions"; 3488 warn "unloading/nuking all extensions";
2302 for my $pkg (@EXTS) { 3489 for my $pkg (@EXTS) {
2303 warn "... unloading $pkg"; 3490 warn "... unloading $pkg";
2304 3491
2305 if (my $cb = $pkg->can ("unload")) { 3492 if (my $cb = $pkg->can ("unload")) {
2306 eval { 3493 eval {
2311 3498
2312 warn "... nuking $pkg"; 3499 warn "... nuking $pkg";
2313 Symbol::delete_package $pkg; 3500 Symbol::delete_package $pkg;
2314 } 3501 }
2315 3502
2316 warn "unload all perl modules loaded from $LIBDIR"; 3503 warn "unloading all perl modules loaded from $LIBDIR";
2317 while (my ($k, $v) = each %INC) { 3504 while (my ($k, $v) = each %INC) {
2318 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3505 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2319 3506
2320 warn "removing <$k>"; 3507 warn "... unloading $k";
2321 delete $INC{$k}; 3508 delete $INC{$k};
2322 3509
2323 $k =~ s/\.pm$//; 3510 $k =~ s/\.pm$//;
2324 $k =~ s/\//::/g; 3511 $k =~ s/\//::/g;
2325 3512
2328 } 3515 }
2329 3516
2330 Symbol::delete_package $k; 3517 Symbol::delete_package $k;
2331 } 3518 }
2332 3519
2333 warn "get rid of safe::, as good as possible"; 3520 warn "getting rid of safe::, as good as possible";
2334 Symbol::delete_package "safe::$_" 3521 Symbol::delete_package "safe::$_"
2335 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);
2336 3523
2337 warn "unload cf.pm \"a bit\""; 3524 warn "unloading cf.pm \"a bit\"";
2338 delete $INC{"cf.pm"}; 3525 delete $INC{"cf.pm"};
3526 delete $INC{"cf/pod.pm"};
2339 3527
2340 # don't, removes xs symbols, too, 3528 # don't, removes xs symbols, too,
2341 # and global variables created in xs 3529 # and global variables created in xs
2342 #Symbol::delete_package __PACKAGE__; 3530 #Symbol::delete_package __PACKAGE__;
2343 3531
3532 warn "unload completed, starting to reload now";
3533
2344 warn "reloading cf.pm"; 3534 warn "reloading cf.pm";
2345 require cf; 3535 require cf;
2346 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3536 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2347 3537
2348 warn "load config and database again"; 3538 warn "loading config and database again";
2349 cf::cfg_load; 3539 cf::reload_config;
2350 cf::db_load;
2351 3540
2352 warn "load extensions"; 3541 warn "loading extensions";
2353 cf::load_extensions; 3542 cf::load_extensions;
2354 3543
2355 warn "reattach attachments to objects/players"; 3544 warn "reattaching attachments to objects/players";
2356 _global_reattach; 3545 _global_reattach; # objects, sockets
2357 warn "reattach attachments to maps"; 3546 warn "reattaching attachments to maps";
2358 reattach $_ for values %MAP; 3547 reattach $_ for values %MAP;
2359 }; 3548 warn "reattaching attachments to players";
3549 reattach $_ for values %PLAYER;
2360 3550
2361 if ($@) { 3551 warn "leaving sync_job";
3552
3553 1
3554 } or do {
2362 warn $@; 3555 warn $@;
2363 warn "error while reloading, exiting."; 3556 warn "error while reloading, exiting.";
2364 exit 1; 3557 exit 1;
2365 } 3558 };
2366 3559
2367 warn "reloaded"; 3560 warn "reloaded";
2368}; 3561};
2369 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
2370register_command "reload" => sub { 3575register_command "reload" => sub {
2371 my ($who, $arg) = @_; 3576 my ($who, $arg) = @_;
2372 3577
2373 if ($who->flag (FLAG_WIZ)) { 3578 if ($who->flag (FLAG_WIZ)) {
2374 $who->message ("start of reload.");
2375 reload;
2376 $who->message ("end of reload."); 3579 $who->message ("reloading server.");
3580 async {
3581 $Coro::current->{desc} = "perl_reload";
3582 reload_perl;
3583 };
2377 } 3584 }
2378}; 3585};
2379 3586
2380unshift @INC, $LIBDIR; 3587unshift @INC, $LIBDIR;
2381 3588
2382$TICK_WATCHER = Event->timer ( 3589my $bug_warning = 0;
2383 reentrant => 0,
2384 prio => 0,
2385 at => $NEXT_TICK || $TICK,
2386 data => WF_AUTOCANCEL,
2387 cb => sub {
2388 $NOW = Event::time;
2389 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
2390 cf::server_tick; # one server iteration 3621 cf::server_tick; # one server iteration
3622
2391 $RUNTIME += $TICK; 3623 $RUNTIME += $TICK;
2392 $NEXT_TICK += $TICK; 3624 $NEXT_TICK = $_[0]->at;
2393 3625
2394 $WAIT_FOR_TICK->broadcast; 3626 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2395 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3627 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
2396 3628 Coro::async_pool {
2397 # if we are delayed by four ticks or more, skip them all 3629 $Coro::current->{desc} = "runtime saver";
2398 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2399
2400 $TICK_WATCHER->at ($NEXT_TICK);
2401 $TICK_WATCHER->start;
2402 },
2403);
2404
2405IO::AIO::max_poll_time $TICK * 0.2;
2406
2407Event->io (
2408 fd => IO::AIO::poll_fileno,
2409 poll => 'r',
2410 prio => 5,
2411 data => WF_AUTOCANCEL,
2412 cb => \&IO::AIO::poll_cb,
2413);
2414
2415Event->timer (
2416 data => WF_AUTOCANCEL,
2417 after => 0,
2418 interval => 10,
2419 cb => sub {
2420 (Coro::unblock_sub {
2421 write_runtime 3630 write_runtime
2422 or warn "ERROR: unable to write runtime file: $!"; 3631 or warn "ERROR: unable to write runtime file: $!";
2423 })->(); 3632 };
2424 }, 3633 }
2425); 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;
2426 3740
2427END { cf::emergency_save } 3741END { cf::emergency_save }
2428 3742
24291 37431
2430 3744

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines