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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines