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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines