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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines