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.141 by root, Fri Jan 5 20:08:53 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)
276 442
277 while ($busy) { 443 while ($busy) {
278 Coro::cede or Event::one_event; 444 Coro::cede or Event::one_event;
279 } 445 }
280 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
453
281 wantarray ? @res : $res[0] 454 wantarray ? @res : $res[0]
282 } else { 455 } else {
283 # we are in another coroutine, how wonderful, everything just works 456 # we are in another coroutine, how wonderful, everything just works
284 457
285 $job->() 458 $job->()
286 } 459 }
287} 460}
288 461
289=item $coro = cf::async_ext { BLOCK } 462=item $coro = cf::async_ext { BLOCK }
290 463
291Like async, but this coro is automcatially being canceled when the 464Like async, but this coro is automatically being canceled when the
292extension calling this is being unloaded. 465extension calling this is being unloaded.
293 466
294=cut 467=cut
295 468
296sub async_ext(&) { 469sub async_ext(&) {
304 $EXT_CORO{$coro+0} = $coro; 477 $EXT_CORO{$coro+0} = $coro;
305 478
306 $coro 479 $coro
307} 480}
308 481
309sub write_runtime { 482=item fork_call { }, $args
310 my $runtime = cf::localdir . "/runtime";
311 483
312 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 484Executes the given code block with the given arguments in a seperate
313 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.
314 488
315 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock 489=cut
316 (aio_write $fh, 0, (length $value), $value, 0) <= 0
317 and return;
318 490
319 aio_fsync $fh 491sub fork_call(&@) {
320 and return; 492 my ($cb, @args) = @_;
321 493
322 close $fh 494 # we seemingly have to make a local copy of the whole thing,
323 or return; 495 # otherwise perl prematurely frees the stuff :/
496 # TODO: investigate and fix (likely this will be rather laborious)
324 497
325 aio_rename "$runtime~", $runtime 498 my @res = Coro::Util::fork_eval {
326 and return; 499 reset_signals;
500 &$cb
501 }, @args;
327 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
328 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 });
329} 642}
330 643
331=back 644=back
332 645
333=cut 646=cut
334
335#############################################################################
336
337package cf::path;
338
339sub new {
340 my ($class, $path, $base) = @_;
341
342 $path = $path->as_string if ref $path;
343
344 my $self = bless { }, $class;
345
346 # {... are special paths that are not touched
347 # ?xxx/... are special absolute paths
348 # ?random/... random maps
349 # /! non-realised random map exit
350 # /... normal maps
351 # ~/... per-player maps without a specific player (DO NOT USE)
352 # ~user/... per-player map of a specific user
353
354 if ($path =~ /^{/) {
355 # fine as it is
356 } elsif ($path =~ s{^\?random/}{}) {
357 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
358 $self->{random} = cf::from_json $data;
359 } else {
360 if ($path =~ s{^~([^/]+)?}{}) {
361 $self->{user_rel} = 1;
362
363 if (defined $1) {
364 $self->{user} = $1;
365 } elsif ($base =~ m{^~([^/]+)/}) {
366 $self->{user} = $1;
367 } else {
368 warn "cannot resolve user-relative path without user <$path,$base>\n";
369 }
370 } elsif ($path =~ /^\//) {
371 # already absolute
372 } else {
373 $base =~ s{[^/]+/?$}{};
374 return $class->new ("$base/$path");
375 }
376
377 for ($path) {
378 redo if s{/\.?/}{/};
379 redo if s{/[^/]+/\.\./}{/};
380 }
381 }
382
383 $self->{path} = $path;
384
385 $self
386}
387
388# the name / primary key / in-game path
389sub as_string {
390 my ($self) = @_;
391
392 $self->{user_rel} ? "~$self->{user}$self->{path}"
393 : $self->{random} ? "?random/$self->{path}"
394 : $self->{path}
395}
396
397# the displayed name, this is a one way mapping
398sub visible_name {
399 my ($self) = @_;
400
401# if (my $rmp = $self->{random}) {
402# # todo: be more intelligent about this
403# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
404# } else {
405 $self->as_string
406# }
407}
408
409# escape the /'s in the path
410sub _escaped_path {
411 # ∕ is U+2215
412 (my $path = $_[0]{path}) =~ s/\//∕/g;
413 $path
414}
415
416# the original (read-only) location
417sub load_path {
418 my ($self) = @_;
419
420 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
421}
422
423# the temporary/swap location
424sub save_path {
425 my ($self) = @_;
426
427 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
428 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
429 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
430}
431
432# the unique path, might be eq to save_path
433sub uniq_path {
434 my ($self) = @_;
435
436 $self->{user_rel} || $self->{random}
437 ? undef
438 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
439}
440
441# return random map parameters, or undef
442sub random_map_params {
443 my ($self) = @_;
444
445 $self->{random}
446}
447
448# this is somewhat ugly, but style maps do need special treatment
449sub is_style_map {
450 $_[0]{path} =~ m{^/styles/}
451}
452
453package cf;
454 647
455############################################################################# 648#############################################################################
456 649
457=head2 ATTACHABLE OBJECTS 650=head2 ATTACHABLE OBJECTS
458 651
460attach callbacks/event handlers (a collection of which is called an "attachment") 653attach callbacks/event handlers (a collection of which is called an "attachment")
461to it. All such attachable objects support the following methods. 654to it. All such attachable objects support the following methods.
462 655
463In 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>
464C<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
465crossfire+). 658Crossfire TRT).
466 659
467=over 4 660=over 4
468 661
469=item $attachable->attach ($attachment, key => $value...) 662=item $attachable->attach ($attachment, key => $value...)
470 663
584our @CB_TYPE = (); # registry for type (cf-object class) based events 777our @CB_TYPE = (); # registry for type (cf-object class) based events
585our @CB_MAP = (); 778our @CB_MAP = ();
586 779
587my %attachment; 780my %attachment;
588 781
782sub cf::attachable::thawer_merge {
783 # simply override everything except _meta
784 local $_[0]{_meta};
785 %{$_[0]} = %{$_[1]};
786}
787
589sub _attach_cb($$$$) { 788sub _attach_cb($$$$) {
590 my ($registry, $event, $prio, $cb) = @_; 789 my ($registry, $event, $prio, $cb) = @_;
591 790
592 use sort 'stable'; 791 use sort 'stable';
593 792
627 $registry = $CB_TYPE[$object_type] ||= []; 826 $registry = $CB_TYPE[$object_type] ||= [];
628 827
629 } elsif ($type eq "subtype") { 828 } elsif ($type eq "subtype") {
630 defined $object_type or Carp::croak "subtype specified without type"; 829 defined $object_type or Carp::croak "subtype specified without type";
631 my $object_subtype = shift @arg; 830 my $object_subtype = shift @arg;
632 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 831 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
633 832
634 } elsif ($type eq "package") { 833 } elsif ($type eq "package") {
635 my $pkg = shift @arg; 834 my $pkg = shift @arg;
636 835
637 while (my ($name, $id) = each %cb_id) { 836 while (my ($name, $id) = each %cb_id) {
666 _attach $registry, $klass, @attach; 865 _attach $registry, $klass, @attach;
667 } 866 }
668 867
669 $obj->{$name} = \%arg; 868 $obj->{$name} = \%arg;
670 } else { 869 } else {
671 warn "object uses attachment '$name' that is not available, postponing.\n"; 870 warn "object uses attachment '$name' which is not available, postponing.\n";
672 } 871 }
673 872
674 $obj->{_attachment}{$name} = undef; 873 $obj->{_attachment}{$name} = undef;
675} 874}
676 875
678 if (ref $_[0]) { 877 if (ref $_[0]) {
679 _object_attach @_; 878 _object_attach @_;
680 } else { 879 } else {
681 _attach shift->_attach_registry, @_; 880 _attach shift->_attach_registry, @_;
682 } 881 }
882 _recalc_want;
683}; 883};
684 884
685# all those should be optimised 885# all those should be optimised
686sub cf::attachable::detach { 886sub cf::attachable::detach {
687 my ($obj, $name) = @_; 887 my ($obj, $name) = @_;
690 delete $obj->{_attachment}{$name}; 890 delete $obj->{_attachment}{$name};
691 reattach ($obj); 891 reattach ($obj);
692 } else { 892 } else {
693 Carp::croak "cannot, currently, detach class attachments"; 893 Carp::croak "cannot, currently, detach class attachments";
694 } 894 }
895 _recalc_want;
695}; 896};
696 897
697sub cf::attachable::attached { 898sub cf::attachable::attached {
698 my ($obj, $name) = @_; 899 my ($obj, $name) = @_;
699 900
714 "; 915 ";
715 die if $@; 916 die if $@;
716} 917}
717 918
718our $override; 919our $override;
719our @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?
720 921
721sub override { 922sub override {
722 $override = 1; 923 $override = 1;
723 @invoke_results = (); 924 @INVOKE_RESULTS = (@_);
724} 925}
725 926
726sub do_invoke { 927sub do_invoke {
727 my $event = shift; 928 my $event = shift;
728 my $callbacks = shift; 929 my $callbacks = shift;
729 930
730 @invoke_results = (); 931 @INVOKE_RESULTS = ();
731 932
732 local $override; 933 local $override;
733 934
734 for (@$callbacks) { 935 for (@$callbacks) {
735 eval { &{$_->[1]} }; 936 eval { &{$_->[1]} };
752 953
753Generate an object-specific event with the given arguments. 954Generate an object-specific event with the given arguments.
754 955
755This 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
756removed 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
757results (if you must, access C<@cf::invoke_results> directly). 958results (if you must, access C<@cf::INVOKE_RESULTS> directly).
758 959
759=back 960=back
760 961
761=cut 962=cut
762 963
763############################################################################# 964#############################################################################
764# 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}
765 977
766sub reattach { 978sub reattach {
767 # basically do the same as instantiate, without calling instantiate 979 # basically do the same as instantiate, without calling instantiate
768 my ($obj) = @_; 980 my ($obj) = @_;
981
982 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
769 983
770 my $registry = $obj->registry; 984 my $registry = $obj->registry;
771 985
772 @$registry = (); 986 @$registry = ();
773 987
812); 1026);
813 1027
814sub object_freezer_save { 1028sub object_freezer_save {
815 my ($filename, $rdata, $objs) = @_; 1029 my ($filename, $rdata, $objs) = @_;
816 1030
1031 my $guard = cf::lock_acquire "io";
1032
817 sync_job { 1033 sync_job {
818 if (length $$rdata) { 1034 if (length $$rdata) {
1035 utf8::decode (my $decname = $filename);
819 warn sprintf "saving %s (%d,%d)\n", 1036 warn sprintf "saving %s (%d,%d)\n",
820 $filename, length $$rdata, scalar @$objs; 1037 $decname, length $$rdata, scalar @$objs;
821 1038
822 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1039 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
823 chmod SAVE_MODE, $fh; 1040 chmod SAVE_MODE, $fh;
824 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1041 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
825 aio_fsync $fh; 1042 aio_fsync $fh if $cf::USE_FSYNC;
826 close $fh; 1043 close $fh;
827 1044
828 if (@$objs) { 1045 if (@$objs) {
829 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) {
830 chmod SAVE_MODE, $fh; 1047 chmod SAVE_MODE, $fh;
831 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1048 my $data = Storable::nfreeze { version => 1, objs => $objs };
832 aio_write $fh, 0, (length $data), $data, 0; 1049 aio_write $fh, 0, (length $data), $data, 0;
833 aio_fsync $fh; 1050 aio_fsync $fh if $cf::USE_FSYNC;
834 close $fh; 1051 close $fh;
835 aio_rename "$filename.pst~", "$filename.pst"; 1052 aio_rename "$filename.pst~", "$filename.pst";
836 } 1053 }
837 } else { 1054 } else {
838 aio_unlink "$filename.pst"; 1055 aio_unlink "$filename.pst";
844 } 1061 }
845 } else { 1062 } else {
846 aio_unlink $filename; 1063 aio_unlink $filename;
847 aio_unlink "$filename.pst"; 1064 aio_unlink "$filename.pst";
848 } 1065 }
849 } 1066 };
1067
1068 undef $guard;
850} 1069}
851 1070
852sub object_freezer_as_string { 1071sub object_freezer_as_string {
853 my ($rdata, $objs) = @_; 1072 my ($rdata, $objs) = @_;
854 1073
859 1078
860sub object_thawer_load { 1079sub object_thawer_load {
861 my ($filename) = @_; 1080 my ($filename) = @_;
862 1081
863 my ($data, $av); 1082 my ($data, $av);
1083
1084 my $guard = cf::lock_acquire "io";
864 1085
865 (aio_load $filename, $data) >= 0 1086 (aio_load $filename, $data) >= 0
866 or return; 1087 or return;
867 1088
868 unless (aio_stat "$filename.pst") { 1089 unless (aio_stat "$filename.pst") {
869 (aio_load "$filename.pst", $av) >= 0 1090 (aio_load "$filename.pst", $av) >= 0
870 or return; 1091 or return;
1092
1093 undef $guard;
871 $av = eval { (Storable::thaw $av)->{objs} }; 1094 $av = eval { (Storable::thaw $av)->{objs} };
872 } 1095 }
873 1096
1097 utf8::decode (my $decname = $filename);
874 warn sprintf "loading %s (%d)\n", 1098 warn sprintf "loading %s (%d,%d)\n",
875 $filename, length $data, scalar @{$av || []};#d# 1099 $decname, length $data, scalar @{$av || []};
1100
876 return ($data, $av); 1101 ($data, $av)
877} 1102}
1103
1104=head2 COMMAND CALLBACKS
1105
1106=over 4
1107
1108=cut
878 1109
879############################################################################# 1110#############################################################################
880# command handling &c 1111# command handling &c
881 1112
882=item cf::register_command $name => \&callback($ob,$args); 1113=item cf::register_command $name => \&callback($ob,$args);
895 push @{ $COMMAND{$name} }, [$caller, $cb]; 1126 push @{ $COMMAND{$name} }, [$caller, $cb];
896} 1127}
897 1128
898=item cf::register_extcmd $name => \&callback($pl,$packet); 1129=item cf::register_extcmd $name => \&callback($pl,$packet);
899 1130
900Register 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.
901 1136
902If 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
903called. 1138called.
904 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
905=cut 1151=cut
906 1152
907sub register_extcmd { 1153sub register_extcmd {
908 my ($name, $cb) = @_; 1154 my ($name, $cb) = @_;
909 1155
910 my $caller = caller;
911 #warn "registering extcmd '$name' to '$caller'";
912
913 $EXTCMD{$name} = [$cb, $caller]; 1156 $EXTCMD{$name} = $cb;
1157}
1158
1159sub register_exticmd {
1160 my ($name, $cb) = @_;
1161
1162 $EXTICMD{$name} = $cb;
914} 1163}
915 1164
916cf::player->attach ( 1165cf::player->attach (
917 on_command => sub { 1166 on_command => sub {
918 my ($pl, $name, $params) = @_; 1167 my ($pl, $name, $params) = @_;
927 cf::override; 1176 cf::override;
928 }, 1177 },
929 on_extcmd => sub { 1178 on_extcmd => sub {
930 my ($pl, $buf) = @_; 1179 my ($pl, $buf) = @_;
931 1180
932 my $msg = eval { from_json $buf }; 1181 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
933 1182
934 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
935 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
936 if (my %reply = $cb->[0]->($pl, $msg)) { 1192 @reply = $cb->($pl, @payload);
937 $pl->ext_reply ($msg->{msgid}, %reply);
938 }
939 } 1193 }
1194
1195 $pl->ext_reply ($reply, @reply)
1196 if $reply;
1197
940 } else { 1198 } else {
941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1199 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
942 } 1200 }
943 1201
944 cf::override; 1202 cf::override;
945 }, 1203 },
946); 1204);
947 1205
948sub register {
949 my ($base, $pkg) = @_;
950
951 #TODO
952}
953
954sub 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($) {
955 my ($path) = @_; 1604 my ($path) = @_;
956 1605
957 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1606 my ($match, $specificity);
958 my $base = $1;
959 my $pkg = $1;
960 $pkg =~ s/[^[:word:]]/_/g;
961 $pkg = "ext::$pkg";
962 1607
963 warn "loading '$path' into '$pkg'\n"; 1608 for my $region (list) {
964 1609 if ($region->{match} && $path =~ $region->{match}) {
965 open my $fh, "<:utf8", $path 1610 ($match, $specificity) = ($region, $region->specificity)
966 or die "$path: $!"; 1611 if $region->specificity > $specificity;
967 1612 }
968 my $source =
969 "package $pkg; use strict; use utf8;\n"
970 . "#line 1 \"$path\"\n{\n"
971 . (do { local $/; <$fh> })
972 . "\n};\n1";
973
974 eval $source
975 or die $@ ? "$path: $@\n"
976 : "extension disabled.\n";
977
978 push @exts, $pkg;
979 $ext_pkg{$base} = $pkg;
980
981# no strict 'refs';
982# @{"$pkg\::ISA"} = ext::;
983
984 register $base, $pkg;
985}
986
987sub unload_extension {
988 my ($pkg) = @_;
989
990 warn "removing extension $pkg\n";
991
992 # remove hooks
993 #TODO
994# for my $idx (0 .. $#PLUGIN_EVENT) {
995# delete $hook[$idx]{$pkg};
996# } 1613 }
997 1614
998 # remove commands 1615 $match
999 for my $name (keys %COMMAND) {
1000 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
1001
1002 if (@cb) {
1003 $COMMAND{$name} = \@cb;
1004 } else {
1005 delete $COMMAND{$name};
1006 }
1007 }
1008
1009 # remove extcmds
1010 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
1011 delete $EXTCMD{$name};
1012 }
1013
1014 if (my $cb = $pkg->can ("unload")) {
1015 eval {
1016 $cb->($pkg);
1017 1
1018 } or warn "$pkg unloaded, but with errors: $@";
1019 }
1020
1021 Symbol::delete_package $pkg;
1022}
1023
1024sub load_extensions {
1025 for my $ext (<$LIBDIR/*.ext>) {
1026 next unless -r $ext;
1027 eval {
1028 load_extension $ext;
1029 1
1030 } or warn "$ext not loaded: $@";
1031 }
1032}
1033
1034#############################################################################
1035# load/save/clean perl data associated with a map
1036
1037*cf::mapsupport::on_clean = sub {
1038 my ($map) = @_;
1039
1040 my $path = $map->tmpname;
1041 defined $path or return;
1042
1043 unlink "$path.pst";
1044};
1045
1046cf::map->attach (prio => -10000, package => cf::mapsupport::);
1047
1048#############################################################################
1049# load/save perl data associated with player->ob objects
1050
1051sub all_objects(@) {
1052 @_, map all_objects ($_->inv), @_
1053}
1054
1055# TODO: compatibility cruft, remove when no longer needed
1056cf::player->attach (
1057 on_load => sub {
1058 my ($pl, $path) = @_;
1059
1060 for my $o (all_objects $pl->ob) {
1061 if (my $value = $o->get_ob_key_value ("_perl_data")) {
1062 $o->set_ob_key_value ("_perl_data");
1063
1064 %$o = %{ Storable::thaw pack "H*", $value };
1065 }
1066 }
1067 },
1068);
1069
1070#############################################################################
1071
1072=head2 CORE EXTENSIONS
1073
1074Functions and methods that extend core crossfire objects.
1075
1076=head3 cf::player
1077
1078=over 4
1079
1080=item cf::player::exists $login
1081
1082Returns true when the given account exists.
1083
1084=cut
1085
1086sub cf::player::exists($) {
1087 cf::player::find $_[0]
1088 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
1089}
1090
1091=item $player->ext_reply ($msgid, $msgtype, %msg)
1092
1093Sends an ext reply to the player.
1094
1095=cut
1096
1097sub cf::player::ext_reply($$$%) {
1098 my ($self, $id, %msg) = @_;
1099
1100 $msg{msgid} = $id;
1101
1102 $self->send ("ext " . to_json \%msg);
1103} 1616}
1104 1617
1105=back 1618=back
1106
1107 1619
1108=head3 cf::map 1620=head3 cf::map
1109 1621
1110=over 4 1622=over 4
1111 1623
1114package cf::map; 1626package cf::map;
1115 1627
1116use Fcntl; 1628use Fcntl;
1117use Coro::AIO; 1629use Coro::AIO;
1118 1630
1631use overload
1632 '""' => \&as_string,
1633 fallback => 1;
1634
1119our $MAX_RESET = 3600; 1635our $MAX_RESET = 3600;
1120our $DEFAULT_RESET = 3000; 1636our $DEFAULT_RESET = 3000;
1121 1637
1122sub generate_random_map { 1638sub generate_random_map {
1123 my ($path, $rmp) = @_; 1639 my ($self, $rmp) = @_;
1124
1125 # mit "rum" bekleckern, nicht 1640 # mit "rum" bekleckern, nicht
1126 cf::map::_create_random_map 1641 $self->_create_random_map (
1127 $path,
1128 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1642 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1129 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1643 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1130 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1644 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1131 $rmp->{exit_on_final_map}, 1645 $rmp->{exit_on_final_map},
1132 $rmp->{xsize}, $rmp->{ysize}, 1646 $rmp->{xsize}, $rmp->{ysize},
1133 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1647 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1134 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1648 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1135 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, 1649 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1136 $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},
1137 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, 1651 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1138 (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"
1139} 1781}
1140 1782
1141# and all this just because we cannot iterate over 1783# and all this just because we cannot iterate over
1142# all maps in C++... 1784# all maps in C++...
1143sub change_all_map_light { 1785sub change_all_map_light {
1145 1787
1146 $_->change_map_light ($change) 1788 $_->change_map_light ($change)
1147 for grep $_->outdoor, values %cf::MAP; 1789 for grep $_->outdoor, values %cf::MAP;
1148} 1790}
1149 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
1150sub try_load_header($) { 1808sub load_header_from($) {
1151 my ($path) = @_; 1809 my ($self, $path) = @_;
1152 1810
1153 utf8::encode $path; 1811 utf8::encode $path;
1154 aio_open $path, O_RDONLY, 0 1812 my $f = new_from_file cf::object::thawer $path
1155 or return; 1813 or return;
1156 1814
1157 my $map = cf::map::new 1815 $self->_load_header ($f)
1158 or return; 1816 or return;
1159 1817
1160 # for better error messages only, will be overwritten 1818 local $MAP_LOADING{$self->{path}} = $self;
1161 $map->path ($path); 1819 $f->resolve_delayed_derefs;
1162 1820
1163 $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
1164 or return; 1864 or return;
1865 $self->prepare_orig;
1866 }
1165 1867
1166 $map->{load_path} = $path; 1868 $self->{deny_reset} = 1
1869 if $self->no_reset;
1167 1870
1168 $map 1871 $self->default_region (cf::region::find_by_path $self->{path})
1872 unless $self->default_region;
1873
1874 1
1169} 1875}
1170 1876
1171sub find; 1877sub find;
1172sub find { 1878sub find {
1173 my ($path, $origin) = @_; 1879 my ($path, $origin) = @_;
1174 1880
1175 #warn "find<$path,$origin>\n";#d#
1176
1177 $path = new cf::path $path, $origin && $origin->path; 1881 $path = normalise $path, $origin && $origin->path;
1178 my $key = $path->as_string;
1179 1882
1883 cf::lock_wait "map_data:$path";#d#remove
1180 cf::lock_wait "map_find:$key"; 1884 cf::lock_wait "map_find:$path";
1181 1885
1182 $cf::MAP{$key} || do { 1886 $cf::MAP{$path} || do {
1183 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
1184 1889
1185 # do it the slow way 1890 my $map = new_from_path cf::map $path
1186 my $map = try_load_header $path->save_path;
1187
1188 Coro::cede;
1189
1190 if ($map) {
1191 $map->last_access ((delete $map->{last_access})
1192 || $cf::RUNTIME); #d#
1193 # safety
1194 $map->{instantiate_time} = $cf::RUNTIME
1195 if $map->{instantiate_time} > $cf::RUNTIME;
1196 } else {
1197 if (my $rmp = $path->random_map_params) {
1198 $map = generate_random_map $key, $rmp;
1199 } else {
1200 $map = try_load_header $path->load_path;
1201 }
1202
1203 $map or return; 1891 or return;
1204 1892
1205 $map->{load_original} = 1;
1206 $map->{instantiate_time} = $cf::RUNTIME;
1207 $map->last_access ($cf::RUNTIME);
1208 $map->instantiate;
1209
1210 # per-player maps become, after loading, normal maps
1211 $map->per_player (0) if $path->{user_rel};
1212 }
1213
1214 $map->path ($key);
1215 $map->{path} = $path;
1216 $map->{last_save} = $cf::RUNTIME; 1893 $map->{last_save} = $cf::RUNTIME;
1217 1894
1218 Coro::cede; 1895 $map->load_header
1896 or return;
1219 1897
1220 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;
1221 $map->reset; 1903 $map->reset;
1222 undef $guard;
1223 $map = find $path 1904 return find $path;
1224 or return;
1225 } 1905 }
1226 1906
1227 $cf::MAP{$key} = $map 1907 $cf::MAP{$path} = $map
1228 } 1908 }
1229} 1909}
1910
1911sub pre_load { }
1912sub post_load { }
1230 1913
1231sub load { 1914sub load {
1232 my ($self) = @_; 1915 my ($self) = @_;
1233 1916
1917 local $self->{deny_reset} = 1; # loading can take a long time
1918
1234 my $path = $self->{path}; 1919 my $path = $self->{path};
1920
1921 {
1235 my $guard = cf::lock_acquire "map_load:" . $path->as_string; 1922 my $guard = cf::lock_acquire "map_data:$path";
1236 1923
1924 return unless $self->valid;
1237 return if $self->in_memory != cf::MAP_SWAPPED; 1925 return unless $self->in_memory == cf::MAP_SWAPPED;
1238 1926
1239 $self->in_memory (cf::MAP_LOADING); 1927 $self->in_memory (cf::MAP_LOADING);
1240 1928
1241 $self->alloc; 1929 $self->alloc;
1242 $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)
1243 or return; 1937 or return;
1244 1938
1245 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1939 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1246 if delete $self->{load_original}; 1940 if delete $self->{load_original};
1247 1941
1248 if (my $uniq = $path->uniq_path) { 1942 if (my $uniq = $self->uniq_path) {
1249 utf8::encode $uniq; 1943 utf8::encode $uniq;
1250 if (aio_open $uniq, O_RDONLY, 0) { 1944 unless (aio_stat $uniq) {
1945 if (my $f = new_from_file cf::object::thawer $uniq) {
1251 $self->clear_unique_items; 1946 $self->clear_unique_items;
1252 $self->load_objects ($uniq, 0); 1947 $self->_load_objects ($f);
1948 $f->resolve_delayed_derefs;
1949 }
1253 } 1950 }
1254 } 1951 }
1255 1952
1256 Coro::cede; 1953 $f->resolve_delayed_derefs;
1257 1954
1955 cf::cede_to_tick;
1258 # now do the right thing for maps 1956 # now do the right thing for maps
1259 $self->link_multipart_objects; 1957 $self->link_multipart_objects;
1260
1261 if ($self->{path}->is_style_map) {
1262 $self->{deny_save} = 1;
1263 $self->{deny_reset} = 1;
1264 } else {
1265 $self->fix_auto_apply;
1266 $self->decay_objects;
1267 $self->update_buttons;
1268 $self->set_darkness_map;
1269 $self->difficulty ($self->estimate_difficulty) 1958 $self->difficulty ($self->estimate_difficulty)
1270 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;
1271 $self->activate; 1969 $self->activate;
1272 } 1970 }
1273 1971
1274 Coro::cede; 1972 $self->{last_save} = $cf::RUNTIME;
1973 $self->last_access ($cf::RUNTIME);
1275 1974
1276 $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 }
1277} 2017}
1278 2018
1279sub find_sync { 2019sub find_sync {
1280 my ($path, $origin) = @_; 2020 my ($path, $origin) = @_;
1281 2021
1282 cf::sync_job { cf::map::find $path, $origin } 2022 cf::sync_job { find $path, $origin }
1283} 2023}
1284 2024
1285sub do_load_sync { 2025sub do_load_sync {
1286 my ($map) = @_; 2026 my ($map) = @_;
1287 2027
2028 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
2029 if $Coro::current == $Coro::main;
2030
1288 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 ()
1289} 2063}
1290 2064
1291sub save { 2065sub save {
1292 my ($self) = @_; 2066 my ($self) = @_;
1293 2067
1294 my $lock = cf::lock_acquire "map_data:" . $self->path; 2068 my $lock = cf::lock_acquire "map_data:$self->{path}";
1295 2069
1296 $self->{last_save} = $cf::RUNTIME; 2070 $self->{last_save} = $cf::RUNTIME;
1297 2071
1298 return unless $self->dirty; 2072 return unless $self->dirty;
1299 2073
1300 my $save = $self->{path}->save_path; utf8::encode $save; 2074 my $save = $self->save_path; utf8::encode $save;
1301 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq; 2075 my $uniq = $self->uniq_path; utf8::encode $uniq;
1302 2076
1303 $self->{load_path} = $save; 2077 $self->{load_path} = $save;
1304 2078
1305 return if $self->{deny_save}; 2079 return if $self->{deny_save};
1306 2080
1307 local $self->{last_access} = $self->last_access;#d# 2081 local $self->{last_access} = $self->last_access;#d#
1308 2082
2083 cf::async {
2084 $_->contr->save for $self->players;
2085 };
2086
1309 if ($uniq) { 2087 if ($uniq) {
1310 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2088 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1311 $self->save_objects ($uniq, cf::IO_UNIQUES); 2089 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1312 } else { 2090 } else {
1313 $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);
1314 } 2092 }
1315} 2093}
1316 2094
1317sub swap_out { 2095sub swap_out {
1318 my ($self) = @_; 2096 my ($self) = @_;
1319 2097
1320 # save first because save cedes 2098 # save first because save cedes
1321 $self->save; 2099 $self->save;
1322 2100
1323 my $lock = cf::lock_acquire "map_data:" . $self->path; 2101 my $lock = cf::lock_acquire "map_data:$self->{path}";
1324 2102
1325 return if $self->players; 2103 return if $self->players;
1326 return if $self->in_memory != cf::MAP_IN_MEMORY; 2104 return if $self->in_memory != cf::MAP_IN_MEMORY;
1327 return if $self->{deny_save}; 2105 return if $self->{deny_save};
1328 2106
2107 $self->in_memory (cf::MAP_SWAPPED);
2108
2109 $self->deactivate;
2110 $_->clear_links_to ($self) for values %cf::MAP;
1329 $self->clear; 2111 $self->clear;
1330 $self->in_memory (cf::MAP_SWAPPED);
1331} 2112}
1332 2113
1333sub reset_at { 2114sub reset_at {
1334 my ($self) = @_; 2115 my ($self) = @_;
1335 2116
1336 # TODO: safety, remove and allow resettable per-player maps 2117 # TODO: safety, remove and allow resettable per-player maps
1337 return 1e99 if $self->{path}{user_rel};
1338 return 1e99 if $self->{deny_reset}; 2118 return 1e99 if $self->{deny_reset};
1339 2119
1340 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2120 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1341 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;
1342 2122
1347 my ($self) = @_; 2127 my ($self) = @_;
1348 2128
1349 $self->reset_at <= $cf::RUNTIME 2129 $self->reset_at <= $cf::RUNTIME
1350} 2130}
1351 2131
1352sub unlink_save {
1353 my ($self) = @_;
1354
1355 utf8::encode (my $save = $self->{path}->save_path);
1356 aioreq_pri 3; IO::AIO::aio_unlink $save;
1357 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1358}
1359
1360sub rename {
1361 my ($self, $new_path) = @_;
1362
1363 $self->unlink_save;
1364
1365 delete $cf::MAP{$self->path};
1366 $self->{path} = new cf::path $new_path;
1367 $self->path ($self->{path}->as_string);
1368 $cf::MAP{$self->path} = $self;
1369
1370 $self->save;
1371}
1372
1373sub reset { 2132sub reset {
1374 my ($self) = @_; 2133 my ($self) = @_;
1375 2134
1376 my $lock = cf::lock_acquire "map_data:" . $self->path; 2135 my $lock = cf::lock_acquire "map_data:$self->{path}";
1377 2136
1378 return if $self->players; 2137 return if $self->players;
1379 return if $self->{path}{user_rel};#d#
1380 2138
1381 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 }
1382 2150
1383 delete $cf::MAP{$self->path}; 2151 delete $cf::MAP{$self->path};
1384 2152
2153 $self->deactivate;
1385 $_->clear_links_to ($self) for values %cf::MAP; 2154 $_->clear_links_to ($self) for values %cf::MAP;
2155 $self->clear;
1386 2156
1387 $self->unlink_save; 2157 $self->unlink_save;
1388 $self->destroy; 2158 $self->destroy;
1389} 2159}
1390 2160
1391my $nuke_counter = "aaaa"; 2161my $nuke_counter = "aaaa";
1392 2162
1393sub nuke { 2163sub nuke {
1394 my ($self) = @_; 2164 my ($self) = @_;
1395 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};
1396 $self->{deny_save} = 1; 2175 $self->{deny_save} = 1;
1397 $self->reset_timeout (1); 2176 $self->reset_timeout (1);
1398 $self->rename ("{nuke}/" . ($nuke_counter++)); 2177 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
2178
2179 $cf::MAP{$self->path} = $self;
2180 }
2181
1399 $self->reset; # polite request, might not happen 2182 $self->reset; # polite request, might not happen
1400} 2183}
1401 2184
1402sub customise_for { 2185=item $maps = cf::map::tmp_maps
1403 my ($map, $ob) = @_;
1404 2186
1405 if ($map->per_player) { 2187Returns an arrayref with all map paths of currently instantiated and saved
1406 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path}; 2188maps. May block.
2189
2190=cut
2191
2192sub tmp_maps() {
1407 } 2193 [
1408 2194 map {
1409 $map 2195 utf8::decode $_;
2196 /\.map$/
2197 ? normalise $_
2198 : ()
2199 } @{ aio_readdir $TMPDIR or [] }
2200 ]
1410} 2201}
1411 2202
1412sub emergency_save { 2203=item $maps = cf::map::random_maps
1413 my $freeze_guard = cf::freeze_mainloop;
1414 2204
1415 warn "enter emergency map save\n"; 2205Returns an arrayref with all map paths of currently instantiated and saved
2206random maps. May block.
1416 2207
1417 cf::sync_job { 2208=cut
1418 warn "begin emergency map save\n";
1419 $_->save for values %cf::MAP;
1420 };
1421 2209
1422 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 ]
1423} 2237}
1424 2238
1425package cf; 2239package cf;
1426 2240
1427=back 2241=back
1428 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
1429 2300
1430=head3 cf::object::player 2301=head3 cf::object::player
1431 2302
1432=over 4 2303=over 4
1433 2304
1447 2318
1448 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2319 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1449 2320
1450 if ($self->{record_replies}) { 2321 if ($self->{record_replies}) {
1451 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2322 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2323
1452 } 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 {
1453 $msg = $npc->name . " says: $msg" if $npc; 2332 $msg = $npc->name . " says: $msg" if $npc;
1454 $self->message ($msg, $flags); 2333 $self->message ($msg, $flags);
2334 }
1455 } 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 (@_);
1456} 2346}
1457 2347
1458=item $player_object->may ("access") 2348=item $player_object->may ("access")
1459 2349
1460Returns wether the given player is authorized to access resource "access" 2350Returns wether the given player is authorized to access resource "access"
1473 2363
1474=item $player_object->enter_link 2364=item $player_object->enter_link
1475 2365
1476Freezes 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}>).
1477 2367
1478The 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
1479I<MUST> call C<leave_link> as soon as possible, though. 2369I<MUST> call C<leave_link> as soon as possible, though.
1480 2370
2371Will never block.
2372
1481=item $player_object->leave_link ($map, $x, $y) 2373=item $player_object->leave_link ($map, $x, $y)
1482 2374
1483Moves 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
1484map 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
1485location 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
1486to the emergency map position. 2378fails, to the emergency map position.
1487 2379
1488Might block. 2380Might block.
1489 2381
1490=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}
1491 2393
1492sub cf::object::player::enter_link { 2394sub cf::object::player::enter_link {
1493 my ($self) = @_; 2395 my ($self) = @_;
1494 2396
1495 $self->deactivate_recursive; 2397 $self->deactivate_recursive;
1496 2398
1497 return if $self->map == $LINK_MAP; 2399 return if UNIVERSAL::isa $self->map, "ext::map_link";
1498 2400
1499 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2401 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1500 if $self->map; 2402 if $self->map && $self->map->{path} ne "{link}";
1501 2403
1502 $self->enter_map ($LINK_MAP, 20, 20); 2404 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1503} 2405}
1504 2406
1505sub cf::object::player::leave_link { 2407sub cf::object::player::leave_link {
1506 my ($self, $map, $x, $y) = @_; 2408 my ($self, $map, $x, $y) = @_;
2409
2410 return unless $self->contr->active;
1507 2411
1508 my $link_pos = delete $self->{_link_pos}; 2412 my $link_pos = delete $self->{_link_pos};
1509 2413
1510 unless ($map) { 2414 unless ($map) {
1511 # restore original map position 2415 # restore original map position
1525 # use -1 or undef as default coordinates, not 0, 0 2429 # use -1 or undef as default coordinates, not 0, 0
1526 ($x, $y) = ($map->enter_x, $map->enter_y) 2430 ($x, $y) = ($map->enter_x, $map->enter_y)
1527 if $x <=0 && $y <= 0; 2431 if $x <=0 && $y <= 0;
1528 2432
1529 $map->load; 2433 $map->load;
2434 $map->load_neighbours;
1530 2435
2436 return unless $self->contr->active;
1531 $self->activate_recursive; 2437 $self->activate_recursive;
2438
2439 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1532 $self->enter_map ($map, $x, $y); 2440 $self->enter_map ($map, $x, $y);
1533} 2441}
1534 2442
1535cf::player->attach ( 2443=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1536 on_logout => sub {
1537 my ($pl) = @_;
1538 2444
1539 # abort map switching before logout 2445Moves the player to the given map-path and coordinates by first freezing
1540 if ($pl->ob->{_link_pos}) { 2446her, loading and preparing them map, calling the provided $check callback
1541 cf::sync_job { 2447that has to return the map if sucecssful, and then unfreezes the player on
1542 $pl->ob->leave_link 2448the new (success) or old (failed) map position. In either case, $done will
1543 }; 2449be called at the end of this process.
1544 }
1545 },
1546 on_login => sub {
1547 my ($pl) = @_;
1548 2450
1549 # try to abort aborted map switching on player login :)
1550 # should happen only on crashes
1551 if ($pl->ob->{_link_pos}) {
1552
1553 $pl->ob->enter_link;
1554 (async {
1555 # we need this sleep as the login has a concurrent enter_exit running
1556 # and this sleep increases chances of the player not ending up in scorn
1557 $pl->ob->reply (undef,
1558 "There was an internal problem at your last logout, "
1559 . "the server will try to bring you to your intended destination in a second.",
1560 cf::NDI_RED);
1561 Coro::Timer::sleep 1;
1562 $pl->ob->leave_link;
1563 })->prio (2);
1564 }
1565 },
1566);
1567
1568=item $player_object->goto ($path, $x, $y)
1569
1570=cut 2451=cut
2452
2453our $GOTOGEN;
1571 2454
1572sub cf::object::player::goto { 2455sub cf::object::player::goto {
1573 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;
1574 2460
1575 $self->enter_link; 2461 $self->enter_link;
1576 2462
1577 (async { 2463 (async {
1578 $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];
1579 2468
1580 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) {
1581 $map = $map->customise_for ($self) if $map; 2487 $map = $map->customise_for ($self);
1582 2488 $map = $check->($map) if $check && $map;
1583# warn "entering ", $map->path, " at ($x, $y)\n" 2489 } else {
1584# if $map;
1585
1586 $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 }
1587 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};
1588 $self->leave_link ($map, $x, $y); 2503 $self->leave_link ($map, $x, $y);
2504 }
2505
2506 $done->() if $done;
1589 })->prio (1); 2507 })->prio (1);
1590} 2508}
1591 2509
1592=item $player_object->enter_exit ($exit_object) 2510=item $player_object->enter_exit ($exit_object)
1593 2511
1595 2513
1596sub parse_random_map_params { 2514sub parse_random_map_params {
1597 my ($spec) = @_; 2515 my ($spec) = @_;
1598 2516
1599 my $rmp = { # defaults 2517 my $rmp = { # defaults
1600 xsize => 10, 2518 xsize => (cf::rndm 15, 40),
1601 ysize => 10, 2519 ysize => (cf::rndm 15, 40),
2520 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2521 #layout => string,
1602 }; 2522 };
1603 2523
1604 for (split /\n/, $spec) { 2524 for (split /\n/, $spec) {
1605 my ($k, $v) = split /\s+/, $_, 2; 2525 my ($k, $v) = split /\s+/, $_, 2;
1606 2526
1610 $rmp 2530 $rmp
1611} 2531}
1612 2532
1613sub prepare_random_map { 2533sub prepare_random_map {
1614 my ($exit) = @_; 2534 my ($exit) = @_;
2535
2536 my $guard = cf::lock_acquire "exit_prepare:$exit";
1615 2537
1616 # all this does is basically replace the /! path by 2538 # all this does is basically replace the /! path by
1617 # a new random map path (?random/...) with a seed 2539 # a new random map path (?random/...) with a seed
1618 # that depends on the exit object 2540 # that depends on the exit object
1619 2541
1620 my $rmp = parse_random_map_params $exit->msg; 2542 my $rmp = parse_random_map_params $exit->msg;
1621 2543
1622 if ($exit->map) { 2544 if ($exit->map) {
1623 $rmp->{region} = $exit->map->region_name; 2545 $rmp->{region} = $exit->region->name;
1624 $rmp->{origin_map} = $exit->map->path; 2546 $rmp->{origin_map} = $exit->map->path;
1625 $rmp->{origin_x} = $exit->x; 2547 $rmp->{origin_x} = $exit->x;
1626 $rmp->{origin_y} = $exit->y; 2548 $rmp->{origin_y} = $exit->y;
1627 } 2549 }
1628 2550
1629 $rmp->{random_seed} ||= $exit->random_seed; 2551 $rmp->{random_seed} ||= $exit->random_seed;
1630 2552
1631 my $data = cf::to_json $rmp; 2553 my $data = cf::to_json $rmp;
1632 my $md5 = Digest::MD5::md5_hex $data; 2554 my $md5 = Digest::MD5::md5_hex $data;
2555 my $meta = "$RANDOMDIR/$md5.meta";
1633 2556
1634 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) {
1635 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;
1636 2561
1637 $exit->slaying ("?random/$md5"); 2562 $exit->slaying ("?random/$md5");
1638 $exit->msg (undef); 2563 $exit->msg (undef);
1639 } 2564 }
1640} 2565}
1642sub cf::object::player::enter_exit { 2567sub cf::object::player::enter_exit {
1643 my ($self, $exit) = @_; 2568 my ($self, $exit) = @_;
1644 2569
1645 return unless $self->type == cf::PLAYER; 2570 return unless $self->type == cf::PLAYER;
1646 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
1647 $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);
1648 2588
1649 (async { 2589 (async {
1650 $self->deactivate_recursive; # just to be sure 2590 $self->deactivate_recursive; # just to be sure
1651 unless (eval { 2591 unless (eval {
1652 prepare_random_map $exit 2592 $self->goto ($slaying, $hp, $sp);
1653 if $exit->slaying eq "/!";
1654
1655 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1656 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1657 2593
1658 1; 2594 1;
1659 }) { 2595 }) {
1660 $self->message ("Something went wrong deep within the crossfire server. " 2596 $self->message ("Something went wrong deep within the crossfire server. "
1661 . "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. "
1662 . "Please report this to the dungeon master", 2598 . "Please report this to the dungeon master!",
1663 cf::NDI_UNIQUE | cf::NDI_RED); 2599 cf::NDI_UNIQUE | cf::NDI_RED);
1664 2600
1665 warn "ERROR in enter_exit: $@"; 2601 warn "ERROR in enter_exit: $@";
1666 $self->leave_link; 2602 $self->leave_link;
1667 } 2603 }
1668 })->prio (1); 2604 })->prio (1);
1681 2617
1682sub cf::client::send_drawinfo { 2618sub cf::client::send_drawinfo {
1683 my ($self, $text, $flags) = @_; 2619 my ($self, $text, $flags) = @_;
1684 2620
1685 utf8::encode $text; 2621 utf8::encode $text;
1686 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2622 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1687} 2623}
1688 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}
1689 2740
1690=item $success = $client->query ($flags, "text", \&cb) 2741=item $success = $client->query ($flags, "text", \&cb)
1691 2742
1692Queues a query to the client, calling the given callback with 2743Queues a query to the client, calling the given callback with
1693the 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>,
1694C<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>.
1695 2746
1696Queries 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
1697reliable at some point in the future. 2748become reliable at some point in the future.
1698 2749
1699=cut 2750=cut
1700 2751
1701sub cf::client::query { 2752sub cf::client::query {
1702 my ($self, $flags, $text, $cb) = @_; 2753 my ($self, $flags, $text, $cb) = @_;
1710 utf8::encode $text; 2761 utf8::encode $text;
1711 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2762 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1712 2763
1713 $self->send_packet ($self->{query_queue}[0][0]) 2764 $self->send_packet ($self->{query_queue}[0][0])
1714 if @{ $self->{query_queue} } == 1; 2765 if @{ $self->{query_queue} } == 1;
2766
2767 1
1715} 2768}
1716 2769
1717cf::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 },
1718 on_reply => sub { 2776 on_reply => sub {
1719 my ($ns, $msg) = @_; 2777 my ($ns, $msg) = @_;
1720 2778
1721 # this weird shuffling is so that direct followup queries 2779 # this weird shuffling is so that direct followup queries
1722 # get handled first 2780 # get handled first
1723 my $queue = delete $ns->{query_queue} 2781 my $queue = delete $ns->{query_queue}
1724 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
1725 2783
1726 (shift @$queue)->[1]->($msg); 2784 (shift @$queue)->[1]->($msg);
2785 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1727 2786
1728 push @{ $ns->{query_queue} }, @$queue; 2787 push @{ $ns->{query_queue} }, @$queue;
1729 2788
1730 if (@{ $ns->{query_queue} } == @$queue) { 2789 if (@{ $ns->{query_queue} } == @$queue) {
1731 if (@$queue) { 2790 if (@$queue) {
1733 } else { 2792 } else {
1734 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2793 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1735 } 2794 }
1736 } 2795 }
1737 }, 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 },
1738); 2823);
1739 2824
1740=item $client->async (\&cb) 2825=item $client->async (\&cb)
1741 2826
1742Create a new coroutine, running the specified callback. The coroutine will 2827Create a new coroutine, running the specified callback. The coroutine will
1783our $safe = new Safe "safe"; 2868our $safe = new Safe "safe";
1784our $safe_hole = new Safe::Hole; 2869our $safe_hole = new Safe::Hole;
1785 2870
1786$SIG{FPE} = 'IGNORE'; 2871$SIG{FPE} = 'IGNORE';
1787 2872
1788$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));
1789 2878
1790# here we export the classes and methods available to script code 2879# here we export the classes and methods available to script code
1791 2880
1792=pod 2881=pod
1793 2882
1794The following fucntions and emthods are available within a safe environment: 2883The following functions and methods are available within a safe environment:
1795 2884
1796 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
1797 cf::object::player player 2889 cf::object::player
1798 cf::player peaceful 2890 player
1799 cf::map trigger 2891
2892 cf::player
2893 peaceful
2894
2895 cf::map
2896 trigger
1800 2897
1801=cut 2898=cut
1802 2899
1803for ( 2900for (
1804 ["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)],
1805 ["cf::object::player" => qw(player)], 2904 ["cf::object::player" => qw(player)],
1806 ["cf::player" => qw(peaceful)], 2905 ["cf::player" => qw(peaceful)],
1807 ["cf::map" => qw(trigger)], 2906 ["cf::map" => qw(trigger)],
1808) { 2907) {
1809 no strict 'refs'; 2908 no strict 'refs';
1880=back 2979=back
1881 2980
1882=cut 2981=cut
1883 2982
1884############################################################################# 2983#############################################################################
2984# the server's init and main functions
1885 2985
1886=head2 EXTENSION DATABASE SUPPORT 2986sub load_facedata($) {
2987 my ($path) = @_;
1887 2988
1888Crossfire maintains a very simple database for extension use. It can 2989 # HACK to clear player env face cache, we need some signal framework
1889currently store anything that can be serialised using Storable, which 2990 # for this (global event?)
1890excludes objects. 2991 %ext::player_env::MUSIC_FACE_CACHE = ();
1891 2992
1892The parameter C<$family> should best start with the name of the extension 2993 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1893using it, it should be unique.
1894 2994
1895=over 4 2995 warn "loading facedata from $path\n";
1896 2996
1897=item $hashref = cf::db_get $family 2997 my $facedata;
2998 0 < aio_load $path, $facedata
2999 or die "$path: $!";
1898 3000
1899Return a hashref for use by the extension C<$family>, which can be 3001 $facedata = Coro::Storable::thaw $facedata;
1900modified. After modifications, you have to call C<cf::db_dirty> or
1901C<cf::db_sync>.
1902 3002
1903=item $value = cf::db_get $family => $key 3003 $facedata->{version} == 2
3004 or cf::cleanup "$path: version mismatch, cannot proceed.";
1904 3005
1905Returns a single value from the database 3006 # patch in the exptable
1906 3007 $facedata->{resource}{"res/exp_table"} = {
1907=item cf::db_put $family => $hashref 3008 type => FT_RSRC,
1908 3009 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1909Stores the given family hashref into the database. Updates are delayed, if
1910you want the data to be synced to disk immediately, use C<cf::db_sync>.
1911
1912=item cf::db_put $family => $key => $value
1913
1914Stores the given C<$value> in the family hash. Updates are delayed, if you
1915want the data to be synced to disk immediately, use C<cf::db_sync>.
1916
1917=item cf::db_dirty
1918
1919Marks the database as dirty, to be updated at a later time.
1920
1921=item cf::db_sync
1922
1923Immediately write the database to disk I<if it is dirty>.
1924
1925=cut
1926
1927our $DB;
1928
1929{
1930 my $path = cf::localdir . "/database.pst";
1931
1932 sub db_load() {
1933 $DB = stat $path ? Storable::retrieve $path : { };
1934 }
1935
1936 my $pid;
1937
1938 sub db_save() {
1939 waitpid $pid, 0 if $pid;
1940 if (0 == ($pid = fork)) {
1941 $DB->{_meta}{version} = 1;
1942 Storable::nstore $DB, "$path~";
1943 rename "$path~", $path;
1944 cf::_exit 0 if defined $pid;
1945 }
1946 }
1947
1948 my $dirty;
1949
1950 sub db_sync() {
1951 db_save if $dirty;
1952 undef $dirty;
1953 }
1954
1955 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1956 db_sync;
1957 }); 3010 };
3011 cf::cede_to_tick;
1958 3012
1959 sub db_dirty() {
1960 $dirty = 1;
1961 $idle->start;
1962 } 3013 {
3014 my $faces = $facedata->{faceinfo};
1963 3015
1964 sub db_get($;$) { 3016 while (my ($face, $info) = each %$faces) {
1965 @_ >= 2 3017 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1966 ? $DB->{$_[0]}{$_[1]} 3018 cf::face::set_visibility $idx, $info->{visibility};
1967 : ($DB->{$_[0]} ||= { }) 3019 cf::face::set_magicmap $idx, $info->{magicmap};
1968 } 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};
1969 3022
1970 sub db_put($$;$) { 3023 cf::cede_to_tick;
1971 if (@_ >= 3) {
1972 $DB->{$_[0]}{$_[1]} = $_[2];
1973 } else {
1974 $DB->{$_[0]} = $_[1];
1975 }
1976 db_dirty;
1977 }
1978
1979 cf::global->attach (
1980 prio => 10000,
1981 on_cleanup => sub {
1982 db_sync;
1983 }, 3024 }
1984 );
1985}
1986 3025
1987############################################################################# 3026 while (my ($face, $info) = each %$faces) {
1988# 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 }
1989 3036
1990sub 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 {
1991 open my $fh, "<:utf8", cf::confdir . "/config" 3163 open my $fh, "<:utf8", "$CONFDIR/config"
1992 or return; 3164 or return;
1993 3165
1994 local $/; 3166 local $/;
1995 *CFG = YAML::Syck::Load <$fh>; 3167 *CFG = YAML::Syck::Load <$fh>;
1996 3168
1999 $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};
2000 $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};
2001 3173
2002 if (exists $CFG{mlockall}) { 3174 if (exists $CFG{mlockall}) {
2003 eval { 3175 eval {
2004 $CFG{mlockall} ? &mlockall : &munlockall 3176 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2005 and die "WARNING: m(un)lockall failed: $!\n"; 3177 and die "WARNING: m(un)lockall failed: $!\n";
2006 }; 3178 };
2007 warn $@ if $@; 3179 warn $@ if $@;
2008 } 3180 }
2009} 3181}
2010 3182
2011sub main { 3183sub main {
2012 # we must not ever block the main coroutine 3184 # we must not ever block the main coroutine
2013 local $Coro::idle = sub { 3185 local $Coro::idle = sub {
2014 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 {
2015 async { Event::one_event }; 3188 Event::one_event;
3189 })->prio (Coro::PRIO_MAX);
2016 }; 3190 };
2017 3191
2018 cfg_load; 3192 reload_config;
2019 db_load; 3193 db_init;
2020 load_extensions; 3194 load_extensions;
3195
3196 $TICK_WATCHER->start;
2021 Event::loop; 3197 Event::loop;
2022} 3198}
2023 3199
2024############################################################################# 3200#############################################################################
2025# initialisation 3201# initialisation and cleanup
2026 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
2027sub reload() { 3296sub do_reload_perl() {
2028 # can/must only be called in main 3297 # can/must only be called in main
2029 if ($Coro::current != $Coro::main) { 3298 if ($Coro::current != $Coro::main) {
2030 warn "can only reload from main coroutine\n"; 3299 warn "can only reload from main coroutine";
2031 return; 3300 return;
2032 } 3301 }
2033 3302
2034 warn "reloading..."; 3303 warn "reloading...";
2035 3304
2036 my $guard = freeze_mainloop; 3305 warn "entering sync_job";
3306
3307 cf::sync_job {
3308 cf::write_runtime; # external watchdog should not bark
2037 cf::emergency_save; 3309 cf::emergency_save;
3310 cf::write_runtime; # external watchdog should not bark
2038 3311
2039 eval { 3312 warn "syncing database to disk";
3313 BDB::db_env_txn_checkpoint $DB_ENV;
3314
2040 # 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
2041 3316
2042 # cancel all watchers 3317 warn "cancelling all WF_AUTOCANCEL watchers";
2043 for (Event::all_watchers) { 3318 for (Event::all_watchers) {
2044 $_->cancel if $_->data & WF_AUTOCANCEL; 3319 $_->cancel if $_->data & WF_AUTOCANCEL;
2045 } 3320 }
2046 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
2047 # cancel all extension coros 3333 warn "cancelling all extension coros";
2048 $_->cancel for values %EXT_CORO; 3334 $_->cancel for values %EXT_CORO;
2049 %EXT_CORO = (); 3335 %EXT_CORO = ();
2050 3336
2051 # unload all extensions 3337 warn "removing commands";
2052 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) {
2053 warn "unloading <$_>"; 3346 warn "... unloading $pkg";
2054 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: $@";
2055 } 3353 }
2056 3354
3355 warn "... nuking $pkg";
3356 Symbol::delete_package $pkg;
3357 }
3358
2057 # unload all modules loaded from $LIBDIR 3359 warn "unloading all perl modules loaded from $LIBDIR";
2058 while (my ($k, $v) = each %INC) { 3360 while (my ($k, $v) = each %INC) {
2059 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3361 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2060 3362
2061 warn "removing <$k>"; 3363 warn "... unloading $k";
2062 delete $INC{$k}; 3364 delete $INC{$k};
2063 3365
2064 $k =~ s/\.pm$//; 3366 $k =~ s/\.pm$//;
2065 $k =~ s/\//::/g; 3367 $k =~ s/\//::/g;
2066 3368
2069 } 3371 }
2070 3372
2071 Symbol::delete_package $k; 3373 Symbol::delete_package $k;
2072 } 3374 }
2073 3375
2074 # sync database to disk
2075 cf::db_sync;
2076 IO::AIO::flush;
2077
2078 # get rid of safe::, as good as possible 3376 warn "getting rid of safe::, as good as possible";
2079 Symbol::delete_package "safe::$_" 3377 Symbol::delete_package "safe::$_"
2080 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);
2081 3379
2082 # remove register_script_function callbacks
2083 # TODO
2084
2085 # unload cf.pm "a bit" 3380 warn "unloading cf.pm \"a bit\"";
2086 delete $INC{"cf.pm"}; 3381 delete $INC{"cf.pm"};
3382 delete $INC{"cf/pod.pm"};
2087 3383
2088 # don't, removes xs symbols, too, 3384 # don't, removes xs symbols, too,
2089 # and global variables created in xs 3385 # and global variables created in xs
2090 #Symbol::delete_package __PACKAGE__; 3386 #Symbol::delete_package __PACKAGE__;
2091 3387
2092 # reload cf.pm 3388 warn "unload completed, starting to reload now";
3389
2093 warn "reloading cf.pm"; 3390 warn "reloading cf.pm";
2094 require cf; 3391 require cf;
2095 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3392 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2096 3393
2097 # load config and database again 3394 warn "loading config and database again";
2098 cf::cfg_load; 3395 cf::reload_config;
2099 cf::db_load;
2100 3396
2101 # load extensions
2102 warn "load extensions"; 3397 warn "loading extensions";
2103 cf::load_extensions; 3398 cf::load_extensions;
2104 3399
2105 # reattach attachments to objects 3400 warn "reattaching attachments to objects/players";
2106 warn "reattach"; 3401 _global_reattach; # objects, sockets
2107 _global_reattach; 3402 warn "reattaching attachments to maps";
2108 }; 3403 reattach $_ for values %MAP;
3404 warn "reattaching attachments to players";
3405 reattach $_ for values %PLAYER;
2109 3406
2110 if ($@) { 3407 warn "leaving sync_job";
3408
3409 1
3410 } or do {
2111 warn $@; 3411 warn $@;
2112 warn "error while reloading, exiting."; 3412 warn "error while reloading, exiting.";
2113 exit 1; 3413 exit 1;
2114 } 3414 };
2115 3415
2116 warn "reloaded successfully"; 3416 warn "reloaded";
2117}; 3417};
2118 3418
2119############################################################################# 3419our $RELOAD_WATCHER; # used only during reload
2120 3420
2121unless ($LINK_MAP) { 3421sub reload_perl() {
2122 $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.
2123 3424
2124 $LINK_MAP->width (41); 3425 $RELOAD_WATCHER ||= Event->timer (
2125 $LINK_MAP->height (41); 3426 reentrant => 0,
2126 $LINK_MAP->alloc;
2127 $LINK_MAP->path ("{link}");
2128 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2129 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2130
2131 # dirty hack because... archetypes are not yet loaded
2132 Event->timer (
2133 after => 2, 3427 after => 0,
3428 data => WF_AUTOCANCEL,
2134 cb => sub { 3429 cb => sub {
2135 $_[0]->w->cancel; 3430 do_reload_perl;
2136 3431 undef $RELOAD_WATCHER;
2137 # provide some exits "home"
2138 my $exit = cf::object::new "exit";
2139
2140 $exit->slaying ($EMERGENCY_POSITION->[0]);
2141 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2142 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2143
2144 $LINK_MAP->insert ($exit->clone, 19, 19);
2145 $LINK_MAP->insert ($exit->clone, 19, 20);
2146 $LINK_MAP->insert ($exit->clone, 19, 21);
2147 $LINK_MAP->insert ($exit->clone, 20, 19);
2148 $LINK_MAP->insert ($exit->clone, 20, 21);
2149 $LINK_MAP->insert ($exit->clone, 21, 19);
2150 $LINK_MAP->insert ($exit->clone, 21, 20);
2151 $LINK_MAP->insert ($exit->clone, 21, 21);
2152
2153 $exit->destroy;
2154 }); 3432 },
2155 3433 );
2156 $LINK_MAP->{deny_save} = 1;
2157 $LINK_MAP->{deny_reset} = 1;
2158
2159 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2160} 3434}
2161
2162register "<global>", __PACKAGE__;
2163 3435
2164register_command "reload" => sub { 3436register_command "reload" => sub {
2165 my ($who, $arg) = @_; 3437 my ($who, $arg) = @_;
2166 3438
2167 if ($who->flag (FLAG_WIZ)) { 3439 if ($who->flag (FLAG_WIZ)) {
2168 $who->message ("start of reload.");
2169 reload;
2170 $who->message ("end of reload."); 3440 $who->message ("reloading server.");
3441 async { reload_perl };
2171 } 3442 }
2172}; 3443};
2173 3444
2174unshift @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}
2175 3469
2176$TICK_WATCHER = Event->timer ( 3470$TICK_WATCHER = Event->timer (
2177 reentrant => 0, 3471 reentrant => 0,
3472 parked => 1,
2178 prio => 0, 3473 prio => 0,
2179 at => $NEXT_TICK || $TICK, 3474 at => $NEXT_TICK || $TICK,
2180 data => WF_AUTOCANCEL, 3475 data => WF_AUTOCANCEL,
2181 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
2182 cf::server_tick; # one server iteration 3485 cf::server_tick; # one server iteration
3486
2183 $RUNTIME += $TICK; 3487 $RUNTIME += $TICK;
2184 $NEXT_TICK += $TICK; 3488 $NEXT_TICK += $TICK;
2185 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
2186 # 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
2187 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3508 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2188 3509
2189 $TICK_WATCHER->at ($NEXT_TICK); 3510 $TICK_WATCHER->at ($NEXT_TICK);
2190 $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;
2191 }, 3517 },
2192); 3518);
2193 3519
3520{
3521 BDB::min_parallel 8;
2194IO::AIO::max_poll_time $TICK * 0.2; 3522 BDB::max_poll_time $TICK * 0.1;
2195 3523 $BDB_POLL_WATCHER = Event->io (
2196Event->io ( 3524 reentrant => 0,
2197 fd => IO::AIO::poll_fileno, 3525 fd => BDB::poll_fileno,
2198 poll => 'r', 3526 poll => 'r',
2199 prio => 5, 3527 prio => 0,
2200 data => WF_AUTOCANCEL,
2201 cb => \&IO::AIO::poll_cb,
2202);
2203
2204Event->timer (
2205 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 (
2206 after => 0, 3571 after => 3,
2207 interval => 10, 3572 interval => 1,
3573 hard => 1,
3574 prio => 0,
3575 data => WF_AUTOCANCEL,
2208 cb => sub { 3576 cb => sub {
2209 (Coro::unblock_sub { 3577 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
2210 write_runtime 3578 },
2211 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;
2212 })->(); 3648 };
3649 } else {
3650 LOG llevInfo, "[ABT] $msg\n";
3651 LOG llevInfo, "[ABT] [suppressed]\n";
2213 }, 3652 }
2214); 3653}
3654
3655# load additional modules
3656use cf::pod;
2215 3657
2216END { cf::emergency_save } 3658END { cf::emergency_save }
2217 3659
22181 36601
2219 3661

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines