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.140 by root, Fri Jan 5 20:04:02 2007 UTC vs.
Revision 1.371 by root, Thu Sep 13 16:16:01 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines