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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines