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.166 by root, Sat Jan 13 23:06:13 2007 UTC vs.
Revision 1.405 by root, Mon Dec 17 08:03:22 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines