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.139 by root, Fri Jan 5 19:12:03 2007 UTC vs.
Revision 1.358 by root, Fri Sep 7 18:10:52 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines