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.121 by root, Tue Jan 2 11:11:52 2007 UTC vs.
Revision 1.352 by root, Sun Sep 2 04:57:14 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines