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.211 by root, Tue Feb 13 16:23:32 2007 UTC vs.
Revision 1.357 by root, Tue Sep 4 08:42:58 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.5 (); 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 ();
20use BDB (); 27use BDB ();
21use Data::Dumper; 28use Data::Dumper;
22use Digest::MD5; 29use Digest::MD5;
23use Fcntl; 30use Fcntl;
31use YAML::Syck ();
24use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
25use YAML::Syck ();
26use Time::HiRes; 33use Time::HiRes;
27use Compress::LZF; 34use Compress::LZF;
35use Digest::MD5 ();
28 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
29Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 41Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30 42
31use 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
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 44
35# 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?
36$YAML::Syck::ImplicitUnicode = 1; 46$YAML::Syck::ImplicitUnicode = 1;
37 47
38$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
39 49
50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
51
40our %COMMAND = (); 52our %COMMAND = ();
41our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
42 54
43our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
44our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
45our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
46our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
47 60
61our $RELOAD; # number of reloads so far
48our @EVENT; 62our @EVENT;
49our $LIBDIR = datadir . "/ext";
50 63
51our $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(!)
52our $TICK_WATCHER; 77our $TICK_WATCHER;
53our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
54our $WRITE_RUNTIME_WATCHER; 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55our $NEXT_TICK; 80our $NEXT_TICK;
56our $NOW; 81our $NOW;
57our $USE_FSYNC = 1; # use fsync to write maps - default off 82our $USE_FSYNC = 1; # use fsync to write maps - default off
58 83
59our $BDB_POLL_WATCHER; 84our $BDB_POLL_WATCHER;
62our %CFG; 87our %CFG;
63 88
64our $UPTIME; $UPTIME ||= time; 89our $UPTIME; $UPTIME ||= time;
65our $RUNTIME; 90our $RUNTIME;
66 91
67our %PLAYER; # all users 92our (%PLAYER, %PLAYER_LOADING); # all users
68our %MAP; # all maps 93our (%MAP, %MAP_LOADING ); # all maps
69our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
70our $RANDOM_MAPS = cf::localdir . "/random";
71our $BDB_ENV_DIR = cf::localdir . "/db";
72
73our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75 95
76# used to convert map paths into valid unix filenames by replacing / by ∕ 96# used to convert map paths into valid unix filenames by replacing / by ∕
77our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78 98
99our $LOAD; # a number between 0 (idle) and 1 (too many objects)
100our $LOADAVG; # same thing, but with alpha-smoothing
101our $tick_start; # for load detecting purposes
102
79binmode STDOUT; 103binmode STDOUT;
80binmode STDERR; 104binmode STDERR;
81 105
82# read virtual server time, if available 106# read virtual server time, if available
83unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
85 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
86 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
87} 111}
88 112
89mkdir cf::localdir; 113mkdir $_
90mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91mkdir cf::localdir . "/" . cf::tmpdir;
92mkdir cf::localdir . "/" . cf::uniquedir;
93mkdir $RANDOM_MAPS;
94mkdir $BDB_ENV_DIR;
95 115
96our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
97 117
98sub cf::map::normalise; 118sub cf::map::normalise;
99 119
110=item $cf::RUNTIME 130=item $cf::RUNTIME
111 131
112The time this server has run, starts at 0 and is increased by $cf::TICK on 132The time this server has run, starts at 0 and is increased by $cf::TICK on
113every server tick. 133every server tick.
114 134
115=item $cf::LIBDIR 135=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
136$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
137$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
116 138
117The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
118be found. It will be added to C<@INC> automatically. 140directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
141unique-items directory, player file directory, random maps directory and
142database environment.
119 143
120=item $cf::NOW 144=item $cf::NOW
121 145
122The time of the last (current) server tick. 146The time of the last (current) server tick.
123 147
124=item $cf::TICK 148=item $cf::TICK
125 149
126The interval between server ticks, in seconds. 150The interval between server ticks, in seconds.
151
152=item $cf::LOADAVG
153
154The current CPU load on the server (alpha-smoothed), as a value between 0
155(none) and 1 (overloaded), indicating how much time is spent on processing
156objects per tick. Healthy values are < 0.5.
157
158=item $cf::LOAD
159
160The raw value load value from the last tick.
127 161
128=item %cf::CFG 162=item %cf::CFG
129 163
130Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
131from wherever your confdir points to. 165from wherever your confdir points to.
132 166
133=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 167=item cf::wait_for_tick, cf::wait_for_tick_begin
134 168
135These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 169These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
136or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 170returns directly I<after> the tick processing (and consequently, can only wake one process
137processing has been done. Call C<< ->wait >> on them to maximise the 171per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
138window of cpu time available, or simply to synchronise to the server tick. 172
173=item @cf::INVOKE_RESULTS
174
175This array contains the results of the last C<invoke ()> call. When
176C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
177that call.
139 178
140=back 179=back
141 180
142=cut 181=cut
143 182
144BEGIN { 183BEGIN {
145 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
146 my $msg = join "", @_; 185 my $msg = join "", @_;
147 utf8::encode $msg;
148 186
149 $msg .= "\n" 187 $msg .= "\n"
150 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
151 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
152 LOG llevError, $msg; 193 LOG llevError, $msg;
153 }; 194 };
154} 195}
155 196
156@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 201@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
202@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
161@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 203@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
162 204
163# we bless all objects into (empty) derived classes to force a method lookup 205# we bless all objects into (empty) derived classes to force a method lookup
164# within the Safe compartment. 206# within the Safe compartment.
165for my $pkg (qw( 207for my $pkg (qw(
166 cf::global cf::attachable 208 cf::global cf::attachable
174} 216}
175 217
176$Event::DIED = sub { 218$Event::DIED = sub {
177 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
178}; 220};
221
222#############################################################################
179 223
180=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
181 225
182=over 4 226=over 4
183 227
202 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 246 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203 $d 247 $d
204 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
205} 249}
206 250
207use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
210 252
211Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
212 254
213=cut
214
215sub from_json($) {
216 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217 JSON::Syck::Load $_[0]
218}
219
220=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
221 256
222Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
223 258
224=cut 259=cut
225 260
226sub to_json($) { 261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 262
228 JSON::Syck::Dump $_[0] 263sub to_json ($) { $json_coder->encode ($_[0]) }
229} 264sub from_json ($) { $json_coder->decode ($_[0]) }
230 265
231=item cf::lock_wait $string 266=item cf::lock_wait $string
232 267
233Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
234 269
237Wait until the given lock is available and then acquires it and returns 272Wait until the given lock is available and then acquires it and returns
238a Coro::guard object. If the guard object gets destroyed (goes out of scope, 273a Coro::guard object. If the guard object gets destroyed (goes out of scope,
239for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
240returned. 275returned.
241 276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
279
242Lock names should begin with a unique identifier (for example, cf::map::find 280Lock names should begin with a unique identifier (for example, cf::map::find
243uses map_find and cf::map::load uses map_load). 281uses map_find and cf::map::load uses map_load).
282
283=item $locked = cf::lock_active $string
284
285Return true if the lock is currently active, i.e. somebody has locked it.
244 286
245=cut 287=cut
246 288
247our %LOCK; 289our %LOCK;
248 290
268 # wake up all waiters, to be on the safe side 310 # wake up all waiters, to be on the safe side
269 $_->ready for @{ delete $LOCK{$key} }; 311 $_->ready for @{ delete $LOCK{$key} };
270 } 312 }
271} 313}
272 314
315sub lock_active($) {
316 my ($key) = @_;
317
318 ! ! $LOCK{$key}
319}
320
273sub freeze_mainloop { 321sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active; 322 return unless $TICK_WATCHER->is_active;
275 323
276 my $guard = Coro::guard { 324 my $guard = Coro::guard {
277 $TICK_WATCHER->start; 325 $TICK_WATCHER->start;
278 $WRITE_RUNTIME_WATCHER->start;
279 }; 326 };
280 $WRITE_RUNTIME_WATCHER->stop;
281 $TICK_WATCHER->stop; 327 $TICK_WATCHER->stop;
282 $guard 328 $guard
329}
330
331=item cf::get_slot $time[, $priority[, $name]]
332
333Allocate $time seconds of blocking CPU time at priority C<$priority>:
334This call blocks and returns only when you have at least C<$time> seconds
335of cpu time till the next tick. The slot is only valid till the next cede.
336
337The optional C<$name> can be used to identify the job to run. It might be
338used for statistical purposes and should identify the same time-class.
339
340Useful for short background jobs.
341
342=cut
343
344our @SLOT_QUEUE;
345our $SLOT_QUEUE;
346
347$SLOT_QUEUE->cancel if $SLOT_QUEUE;
348$SLOT_QUEUE = Coro::async {
349 my $signal = new Coro::Signal;
350
351 while () {
352 next_job:
353 my $avail = cf::till_tick;
354 if ($avail > 0.01) {
355 for (0 .. $#SLOT_QUEUE) {
356 if ($SLOT_QUEUE[$_][0] < $avail) {
357 my $job = splice @SLOT_QUEUE, $_, 1, ();
358 $job->[2]->send;
359 Coro::cede;
360 goto next_job;
361 }
362 }
363 }
364
365 if (@SLOT_QUEUE) {
366 # we do not use wait_For_tick() as it returns immediately when tick is inactive
367 push @cf::WAIT_FOR_TICK, $signal;
368 $signal->wait;
369 } else {
370 Coro::schedule;
371 }
372 }
373};
374
375sub get_slot($;$$) {
376 my ($time, $pri, $name) = @_;
377
378 $time = $TICK * .6 if $time > $TICK * .6;
379 my $sig = new Coro::Signal;
380
381 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
382 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
383 $SLOT_QUEUE->ready;
384 $sig->wait;
283} 385}
284 386
285=item cf::async { BLOCK } 387=item cf::async { BLOCK }
286 388
287Currently the same as Coro::async_pool, meaning you cannot use 389Currently the same as Coro::async_pool, meaning you cannot use
292 394
293BEGIN { *async = \&Coro::async_pool } 395BEGIN { *async = \&Coro::async_pool }
294 396
295=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
296 398
297The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
298always able to handle events or runnable, as crossfire+ is only partly 400is always able to handle events or runnable, as Crossfire TRT is only
299reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 401partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
402acceptable.
300 403
301If it must be done, put the blocking parts into C<sync_job>. This will run 404If it must be done, put the blocking parts into C<sync_job>. This will run
302the given BLOCK in another coroutine while waiting for the result. The 405the given BLOCK in another coroutine while waiting for the result. The
303server will be frozen during this time, so the block should either finish 406server will be frozen during this time, so the block should either finish
304fast or be very important. 407fast or be very important.
307 410
308sub sync_job(&) { 411sub sync_job(&) {
309 my ($job) = @_; 412 my ($job) = @_;
310 413
311 if ($Coro::current == $Coro::main) { 414 if ($Coro::current == $Coro::main) {
415 my $time = Event::time;
416
312 # this is the main coro, too bad, we have to block 417 # this is the main coro, too bad, we have to block
313 # till the operation succeeds, freezing the server :/ 418 # till the operation succeeds, freezing the server :/
314 419
315 # TODO: use suspend/resume instead 420 # TODO: use suspend/resume instead
316 # (but this is cancel-safe) 421 # (but this is cancel-safe)
327 432
328 while ($busy) { 433 while ($busy) {
329 Coro::cede or Event::one_event; 434 Coro::cede or Event::one_event;
330 } 435 }
331 436
437 $time = Event::time - $time;
438
439 LOG llevError | logBacktrace, Carp::longmess "long sync job"
440 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
441
442 $tick_start += $time; # do not account sync jobs to server load
443
332 wantarray ? @res : $res[0] 444 wantarray ? @res : $res[0]
333 } else { 445 } else {
334 # we are in another coroutine, how wonderful, everything just works 446 # we are in another coroutine, how wonderful, everything just works
335 447
336 $job->() 448 $job->()
355 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
356 468
357 $coro 469 $coro
358} 470}
359 471
360sub write_runtime { 472=item fork_call { }, $args
361 $TICK_WATCHER->is_active or cf::cleanup "mainloop frozen but runtime active", 1;
362 473
363 my $runtime = cf::localdir . "/runtime"; 474Executes the given code block with the given arguments in a seperate
475process, returning the results. Everything must be serialisable with
476Coro::Storable. May, of course, block. Note that the executed sub may
477never block itself or use any form of Event handling.
364 478
365 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 479=cut
366 or return;
367 480
368 my $value = $cf::RUNTIME + 90 + 10; 481sub fork_call(&@) {
369 # 10 is the runtime save interval, for a monotonic clock 482 my ($cb, @args) = @_;
370 # 60 allows for the watchdog to kill the server.
371 483
372 (aio_write $fh, 0, (length $value), $value, 0) <= 0 484 # we seemingly have to make a local copy of the whole thing,
373 and return; 485 # otherwise perl prematurely frees the stuff :/
486 # TODO: investigate and fix (likely this will be rather laborious)
374 487
375 # always fsync - this file is important 488 my @res = Coro::Util::fork_eval {
376 aio_fsync $fh 489 reset_signals;
377 and return; 490 &$cb
491 }, @args;
378 492
379 close $fh 493 wantarray ? @res : $res[-1]
380 or return; 494}
381 495
382 aio_rename "$runtime~", $runtime 496=item $value = cf::db_get $family => $key
383 and return;
384 497
498Returns a single value from the environment database.
499
500=item cf::db_put $family => $key => $value
501
502Stores the given C<$value> in the family. It can currently store binary
503data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
504
505=cut
506
507our $DB;
508
509sub db_init {
510 unless ($DB) {
511 $DB = BDB::db_create $DB_ENV;
512
513 cf::sync_job {
514 eval {
515 $DB->set_flags (BDB::CHKSUM);
516
517 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
518 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
519 cf::cleanup "db_open(db): $!" if $!;
520 };
521 cf::cleanup "db_open(db): $@" if $@;
522 };
385 1 523 }
524}
525
526sub db_get($$) {
527 my $key = "$_[0]/$_[1]";
528
529 cf::sync_job {
530 BDB::db_get $DB, undef, $key, my $data;
531
532 $! ? ()
533 : $data
534 }
535}
536
537sub db_put($$$) {
538 BDB::dbreq_pri 4;
539 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
540}
541
542=item cf::cache $id => [$paths...], $processversion => $process
543
544Generic caching function that returns the value of the resource $id,
545caching and regenerating as required.
546
547This function can block.
548
549=cut
550
551sub cache {
552 my ($id, $src, $processversion, $process) = @_;
553
554 my $meta =
555 join "\x00",
556 $processversion,
557 map {
558 aio_stat $_
559 and Carp::croak "$_: $!";
560
561 ($_, (stat _)[7,9])
562 } @$src;
563
564 my $dbmeta = db_get cache => "$id/meta";
565 if ($dbmeta ne $meta) {
566 # changed, we may need to process
567
568 my @data;
569 my $md5;
570
571 for (0 .. $#$src) {
572 0 <= aio_load $src->[$_], $data[$_]
573 or Carp::croak "$src->[$_]: $!";
574 }
575
576 # if processing is expensive, check
577 # checksum first
578 if (1) {
579 $md5 =
580 join "\x00",
581 $processversion,
582 map {
583 cf::cede_to_tick;
584 ($src->[$_], Digest::MD5::md5_hex $data[$_])
585 } 0.. $#$src;
586
587
588 my $dbmd5 = db_get cache => "$id/md5";
589 if ($dbmd5 eq $md5) {
590 db_put cache => "$id/meta", $meta;
591
592 return db_get cache => "$id/data";
593 }
594 }
595
596 my $t1 = Time::HiRes::time;
597 my $data = $process->(\@data);
598 my $t2 = Time::HiRes::time;
599
600 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
601
602 db_put cache => "$id/data", $data;
603 db_put cache => "$id/md5" , $md5;
604 db_put cache => "$id/meta", $meta;
605
606 return $data;
607 }
608
609 db_get cache => "$id/data"
610}
611
612=item cf::datalog type => key => value, ...
613
614Log a datalog packet of the given type with the given key-value pairs.
615
616=cut
617
618sub datalog($@) {
619 my ($type, %kv) = @_;
620 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
386} 621}
387 622
388=back 623=back
389 624
390=cut 625=cut
397attach callbacks/event handlers (a collection of which is called an "attachment") 632attach callbacks/event handlers (a collection of which is called an "attachment")
398to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
399 634
400In the following description, CLASS can be any of C<global>, C<object> 635In the following description, CLASS can be any of C<global>, C<object>
401C<player>, C<client> or C<map> (i.e. the attachable objects in 636C<player>, C<client> or C<map> (i.e. the attachable objects in
402crossfire+). 637Crossfire TRT).
403 638
404=over 4 639=over 4
405 640
406=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
407 642
570 $registry = $CB_TYPE[$object_type] ||= []; 805 $registry = $CB_TYPE[$object_type] ||= [];
571 806
572 } elsif ($type eq "subtype") { 807 } elsif ($type eq "subtype") {
573 defined $object_type or Carp::croak "subtype specified without type"; 808 defined $object_type or Carp::croak "subtype specified without type";
574 my $object_subtype = shift @arg; 809 my $object_subtype = shift @arg;
575 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 810 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
576 811
577 } elsif ($type eq "package") { 812 } elsif ($type eq "package") {
578 my $pkg = shift @arg; 813 my $pkg = shift @arg;
579 814
580 while (my ($name, $id) = each %cb_id) { 815 while (my ($name, $id) = each %cb_id) {
609 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
610 } 845 }
611 846
612 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
613 } else { 848 } else {
614 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
615 } 850 }
616 851
617 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
618} 853}
619 854
621 if (ref $_[0]) { 856 if (ref $_[0]) {
622 _object_attach @_; 857 _object_attach @_;
623 } else { 858 } else {
624 _attach shift->_attach_registry, @_; 859 _attach shift->_attach_registry, @_;
625 } 860 }
861 _recalc_want;
626}; 862};
627 863
628# all those should be optimised 864# all those should be optimised
629sub cf::attachable::detach { 865sub cf::attachable::detach {
630 my ($obj, $name) = @_; 866 my ($obj, $name) = @_;
633 delete $obj->{_attachment}{$name}; 869 delete $obj->{_attachment}{$name};
634 reattach ($obj); 870 reattach ($obj);
635 } else { 871 } else {
636 Carp::croak "cannot, currently, detach class attachments"; 872 Carp::croak "cannot, currently, detach class attachments";
637 } 873 }
874 _recalc_want;
638}; 875};
639 876
640sub cf::attachable::attached { 877sub cf::attachable::attached {
641 my ($obj, $name) = @_; 878 my ($obj, $name) = @_;
642 879
657 "; 894 ";
658 die if $@; 895 die if $@;
659} 896}
660 897
661our $override; 898our $override;
662our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 899our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
663 900
664sub override { 901sub override {
665 $override = 1; 902 $override = 1;
666 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
667} 904}
668 905
669sub do_invoke { 906sub do_invoke {
670 my $event = shift; 907 my $event = shift;
671 my $callbacks = shift; 908 my $callbacks = shift;
672 909
673 @invoke_results = (); 910 @INVOKE_RESULTS = ();
674 911
675 local $override; 912 local $override;
676 913
677 for (@$callbacks) { 914 for (@$callbacks) {
678 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
695 932
696Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
697 934
698This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 935This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
699removed in future versions), and there is no public API to access override 936removed in future versions), and there is no public API to access override
700results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
701 938
702=back 939=back
703 940
704=cut 941=cut
705 942
706############################################################################# 943#############################################################################
707# object support 944# object support
945#
946
947sub _can_merge {
948 my ($ob1, $ob2) = @_;
949
950 local $Storable::canonical = 1;
951 my $fob1 = Storable::freeze $ob1;
952 my $fob2 = Storable::freeze $ob2;
953
954 $fob1 eq $fob2
955}
708 956
709sub reattach { 957sub reattach {
710 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
711 my ($obj) = @_; 959 my ($obj) = @_;
712 960
756 }, 1004 },
757); 1005);
758 1006
759sub object_freezer_save { 1007sub object_freezer_save {
760 my ($filename, $rdata, $objs) = @_; 1008 my ($filename, $rdata, $objs) = @_;
1009
1010 my $guard = cf::lock_acquire "io";
761 1011
762 sync_job { 1012 sync_job {
763 if (length $$rdata) { 1013 if (length $$rdata) {
764 warn sprintf "saving %s (%d,%d)\n", 1014 warn sprintf "saving %s (%d,%d)\n",
765 $filename, length $$rdata, scalar @$objs; 1015 $filename, length $$rdata, scalar @$objs;
789 } 1039 }
790 } else { 1040 } else {
791 aio_unlink $filename; 1041 aio_unlink $filename;
792 aio_unlink "$filename.pst"; 1042 aio_unlink "$filename.pst";
793 } 1043 }
794
795 #d##TODO# nuke non .map-files if exist
796 if ($filename =~ s/\.map$//) {
797 aio_unlink $filename;
798 aio_unlink "$filename.pst";
799 }
800 } 1044 };
1045
1046 undef $guard;
801} 1047}
802 1048
803sub object_freezer_as_string { 1049sub object_freezer_as_string {
804 my ($rdata, $objs) = @_; 1050 my ($rdata, $objs) = @_;
805 1051
811sub object_thawer_load { 1057sub object_thawer_load {
812 my ($filename) = @_; 1058 my ($filename) = @_;
813 1059
814 my ($data, $av); 1060 my ($data, $av);
815 1061
816 #d#TODO remove .map if file does not exist 1062 my $guard = cf::lock_acquire "io";
817 aio_stat $filename and $filename =~ s/\.map$//;
818 1063
819 (aio_load $filename, $data) >= 0 1064 (aio_load $filename, $data) >= 0
820 or return; 1065 or return;
821 1066
822 unless (aio_stat "$filename.pst") { 1067 unless (aio_stat "$filename.pst") {
823 (aio_load "$filename.pst", $av) >= 0 1068 (aio_load "$filename.pst", $av) >= 0
824 or return; 1069 or return;
1070
1071 undef $guard;
825 $av = eval { (Storable::thaw $av)->{objs} }; 1072 $av = eval { (Storable::thaw $av)->{objs} };
826 } 1073 }
827 1074
828 warn sprintf "loading %s (%d)\n", 1075 warn sprintf "loading %s (%d)\n",
829 $filename, length $data, scalar @{$av || []};#d# 1076 $filename, length $data, scalar @{$av || []};
1077
830 return ($data, $av); 1078 ($data, $av)
831} 1079}
1080
1081=head2 COMMAND CALLBACKS
1082
1083=over 4
1084
1085=cut
832 1086
833############################################################################# 1087#############################################################################
834# command handling &c 1088# command handling &c
835 1089
836=item cf::register_command $name => \&callback($ob,$args); 1090=item cf::register_command $name => \&callback($ob,$args);
849 push @{ $COMMAND{$name} }, [$caller, $cb]; 1103 push @{ $COMMAND{$name} }, [$caller, $cb];
850} 1104}
851 1105
852=item cf::register_extcmd $name => \&callback($pl,$packet); 1106=item cf::register_extcmd $name => \&callback($pl,$packet);
853 1107
854Register a callbackf ro execution when the client sends an extcmd packet. 1108Register a callback for execution when the client sends an (synchronous)
1109extcmd packet. Ext commands will be processed in the order they are
1110received by the server, like other user commands. The first argument is
1111the logged-in player. Ext commands can only be processed after a player
1112has logged in successfully.
855 1113
856If the callback returns something, it is sent back as if reply was being 1114If the callback returns something, it is sent back as if reply was being
857called. 1115called.
858 1116
1117=item cf::register_exticmd $name => \&callback($ns,$packet);
1118
1119Register a callback for execution when the client sends an (asynchronous)
1120exticmd packet. Exti commands are processed by the server as soon as they
1121are received, i.e. out of order w.r.t. other commands. The first argument
1122is a client socket. Exti commands can be received anytime, even before
1123log-in.
1124
1125If the callback returns something, it is sent back as if reply was being
1126called.
1127
859=cut 1128=cut
860 1129
861sub register_extcmd { 1130sub register_extcmd {
862 my ($name, $cb) = @_; 1131 my ($name, $cb) = @_;
863 1132
864 $EXTCMD{$name} = $cb; 1133 $EXTCMD{$name} = $cb;
1134}
1135
1136sub register_exticmd {
1137 my ($name, $cb) = @_;
1138
1139 $EXTICMD{$name} = $cb;
865} 1140}
866 1141
867cf::player->attach ( 1142cf::player->attach (
868 on_command => sub { 1143 on_command => sub {
869 my ($pl, $name, $params) = @_; 1144 my ($pl, $name, $params) = @_;
878 cf::override; 1153 cf::override;
879 }, 1154 },
880 on_extcmd => sub { 1155 on_extcmd => sub {
881 my ($pl, $buf) = @_; 1156 my ($pl, $buf) = @_;
882 1157
883 my $msg = eval { from_json $buf }; 1158 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
884 1159
885 if (ref $msg) { 1160 if (ref $msg) {
1161 my ($type, $reply, @payload) =
1162 "ARRAY" eq ref $msg
1163 ? @$msg
1164 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1165
1166 my @reply;
1167
886 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1168 if (my $cb = $EXTCMD{$type}) {
887 if (my %reply = $cb->($pl, $msg)) { 1169 @reply = $cb->($pl, @payload);
888 $pl->ext_reply ($msg->{msgid}, %reply);
889 }
890 } 1170 }
1171
1172 $pl->ext_reply ($reply, @reply)
1173 if $reply;
1174
891 } else { 1175 } else {
892 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1176 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
893 } 1177 }
894 1178
895 cf::override; 1179 cf::override;
896 }, 1180 },
897); 1181);
898 1182
899sub load_extension {
900 my ($path) = @_;
901
902 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
903 my $base = $1;
904 my $pkg = $1;
905 $pkg =~ s/[^[:word:]]/_/g;
906 $pkg = "ext::$pkg";
907
908 warn "... loading '$path' into '$pkg'\n";
909
910 open my $fh, "<:utf8", $path
911 or die "$path: $!";
912
913 my $source =
914 "package $pkg; use strict; use utf8;\n"
915 . "#line 1 \"$path\"\n{\n"
916 . (do { local $/; <$fh> })
917 . "\n};\n1";
918
919 unless (eval $source) {
920 my $msg = $@ ? "$path: $@\n"
921 : "extension disabled.\n";
922 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
923 warn $@;
924 warn "mandatory extension failed to load, exiting.\n";
925 exit 1;
926 }
927 die $@;
928 }
929
930 push @EXTS, $pkg;
931}
932
933sub load_extensions { 1183sub load_extensions {
1184 cf::sync_job {
1185 my %todo;
1186
934 for my $ext (<$LIBDIR/*.ext>) { 1187 for my $path (<$LIBDIR/*.ext>) {
935 next unless -r $ext; 1188 next unless -r $path;
936 eval { 1189
937 load_extension $ext; 1190 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1191 my $base = $1;
1192 my $pkg = $1;
1193 $pkg =~ s/[^[:word:]]/_/g;
1194 $pkg = "ext::$pkg";
1195
1196 open my $fh, "<:utf8", $path
1197 or die "$path: $!";
1198
1199 my $source = do { local $/; <$fh> };
1200
1201 my %ext = (
1202 path => $path,
1203 base => $base,
1204 pkg => $pkg,
1205 );
1206
1207 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1208 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1209
1210 $ext{source} =
1211 "package $pkg; use strict; use utf8;\n"
1212 . "#line 1 \"$path\"\n{\n"
1213 . $source
1214 . "\n};\n1";
1215
1216 $todo{$base} = \%ext;
1217 }
1218
1219 my %done;
1220 while (%todo) {
1221 my $progress;
1222
1223 while (my ($k, $v) = each %todo) {
1224 for (split /,\s*/, $v->{meta}{depends}) {
1225 goto skip
1226 unless exists $done{$_};
1227 }
1228
1229 warn "... loading '$k' into '$v->{pkg}'\n";
1230
1231 unless (eval $v->{source}) {
1232 my $msg = $@ ? "$v->{path}: $@\n"
1233 : "$v->{base}: extension inactive.\n";
1234
1235 if (exists $v->{meta}{mandatory}) {
1236 warn $msg;
1237 warn "mandatory extension failed to load, exiting.\n";
1238 exit 1;
1239 }
1240
1241 warn $msg;
1242 }
1243
1244 $done{$k} = delete $todo{$k};
1245 push @EXTS, $v->{pkg};
1246 $progress = 1;
938 1 1247 }
939 } or warn "$ext not loaded: $@"; 1248
1249 skip:
1250 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1251 unless $progress;
1252 }
940 } 1253 };
941} 1254}
942 1255
943############################################################################# 1256#############################################################################
944 1257
1258=back
1259
945=head2 CORE EXTENSIONS 1260=head2 CORE EXTENSIONS
946 1261
947Functions and methods that extend core crossfire objects. 1262Functions and methods that extend core crossfire objects.
948 1263
949=cut 1264=cut
961Returns the given player object, loading it if necessary (might block). 1276Returns the given player object, loading it if necessary (might block).
962 1277
963=cut 1278=cut
964 1279
965sub playerdir($) { 1280sub playerdir($) {
966 cf::localdir 1281 "$PLAYERDIR/"
967 . "/"
968 . cf::playerdir
969 . "/"
970 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1282 . (ref $_[0] ? $_[0]->ob->name : $_[0])
971} 1283}
972 1284
973sub path($) { 1285sub path($) {
974 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1286 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
975 1287
976 (playerdir $login) . "/$login.pl" 1288 (playerdir $login) . "/playerdata"
977} 1289}
978 1290
979sub find_active($) { 1291sub find_active($) {
980 $cf::PLAYER{$_[0]} 1292 $cf::PLAYER{$_[0]}
981 and $cf::PLAYER{$_[0]}->active 1293 and $cf::PLAYER{$_[0]}->active
994 my $login = $_[0]; 1306 my $login = $_[0];
995 1307
996 my $guard = cf::lock_acquire "user_find:$login"; 1308 my $guard = cf::lock_acquire "user_find:$login";
997 1309
998 $cf::PLAYER{$_[0]} || do { 1310 $cf::PLAYER{$_[0]} || do {
999 my $pl = load_pl path $login 1311 # rename old playerfiles to new ones
1312 #TODO: remove when no longer required
1313 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1314 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1315 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1316 aio_unlink +(playerdir $login) . "/$login.pl";
1317
1318 my $f = new_from_file cf::object::thawer path $login
1000 or return; 1319 or return;
1320
1321 $f->next;
1322 my $pl = cf::player::load_pl $f
1323 or return;
1324 local $cf::PLAYER_LOADING{$login} = $pl;
1325 $f->resolve_delayed_derefs;
1001 $cf::PLAYER{$login} = $pl 1326 $cf::PLAYER{$login} = $pl
1002 } 1327 }
1003 } 1328 }
1004} 1329}
1005 1330
1015 1340
1016 aio_mkdir playerdir $pl, 0770; 1341 aio_mkdir playerdir $pl, 0770;
1017 $pl->{last_save} = $cf::RUNTIME; 1342 $pl->{last_save} = $cf::RUNTIME;
1018 1343
1019 $pl->save_pl ($path); 1344 $pl->save_pl ($path);
1020 Coro::cede; 1345 cf::cede_to_tick;
1021} 1346}
1022 1347
1023sub new($) { 1348sub new($) {
1024 my ($login) = @_; 1349 my ($login) = @_;
1025 1350
1031 $cf::PLAYER{$login} = $self; 1356 $cf::PLAYER{$login} = $self;
1032 1357
1033 $self 1358 $self
1034} 1359}
1035 1360
1361=item $player->send_msg ($channel, $msg, $color, [extra...])
1362
1363=cut
1364
1365sub send_msg {
1366 my $ns = shift->ns
1367 or return;
1368 $ns->send_msg (@_);
1369}
1370
1036=item $pl->quit_character 1371=item $pl->quit_character
1037 1372
1038Nukes the player without looking back. If logged in, the connection will 1373Nukes the player without looking back. If logged in, the connection will
1039be destroyed. May block for a long time. 1374be destroyed. May block for a long time.
1040 1375
1041=cut 1376=cut
1042 1377
1043sub quit_character { 1378sub quit_character {
1044 my ($pl) = @_; 1379 my ($pl) = @_;
1380
1381 my $name = $pl->ob->name;
1045 1382
1046 $pl->{deny_save} = 1; 1383 $pl->{deny_save} = 1;
1047 $pl->password ("*"); # this should lock out the player until we nuked the dir 1384 $pl->password ("*"); # this should lock out the player until we nuked the dir
1048 1385
1049 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1386 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1054 my $path = playerdir $pl; 1391 my $path = playerdir $pl;
1055 my $temp = "$path~$cf::RUNTIME~deleting~"; 1392 my $temp = "$path~$cf::RUNTIME~deleting~";
1056 aio_rename $path, $temp; 1393 aio_rename $path, $temp;
1057 delete $cf::PLAYER{$pl->ob->name}; 1394 delete $cf::PLAYER{$pl->ob->name};
1058 $pl->destroy; 1395 $pl->destroy;
1396
1397 my $prefix = qr<^~\Q$name\E/>;
1398
1399 # nuke player maps
1400 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1401
1059 IO::AIO::aio_rmtree $temp; 1402 IO::AIO::aio_rmtree $temp;
1403}
1404
1405=item $pl->kick
1406
1407Kicks a player out of the game. This destroys the connection.
1408
1409=cut
1410
1411sub kick {
1412 my ($pl, $kicker) = @_;
1413
1414 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1415 $pl->killer ("kicked");
1416 $pl->ns->destroy;
1060} 1417}
1061 1418
1062=item cf::player::list_logins 1419=item cf::player::list_logins
1063 1420
1064Returns am arrayref of all valid playernames in the system, can take a 1421Returns am arrayref of all valid playernames in the system, can take a
1065while and may block, so not sync_job-capable, ever. 1422while and may block, so not sync_job-capable, ever.
1066 1423
1067=cut 1424=cut
1068 1425
1069sub list_logins { 1426sub list_logins {
1070 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1427 my $dirs = aio_readdir $PLAYERDIR
1071 or return []; 1428 or return [];
1072 1429
1073 my @logins; 1430 my @logins;
1074 1431
1075 for my $login (@$dirs) { 1432 for my $login (@$dirs) {
1433 my $path = path $login;
1434
1435 # a .pst is a dead give-away for a valid player
1436 unless (-e "$path.pst") {
1076 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1437 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1077 aio_read $fh, 0, 512, my $buf, 0 or next; 1438 aio_read $fh, 0, 512, my $buf, 0 or next;
1078 $buf !~ /^password -------------$/m or next; # official not-valid tag 1439 $buf !~ /^password -------------$/m or next; # official not-valid tag
1440 }
1079 1441
1080 utf8::decode $login; 1442 utf8::decode $login;
1081 push @logins, $login; 1443 push @logins, $login;
1082 } 1444 }
1083 1445
1110 } 1472 }
1111 1473
1112 \@paths 1474 \@paths
1113} 1475}
1114 1476
1477=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1478
1479Expand crossfire pod fragments into protocol xml.
1480
1481=cut
1482
1483sub expand_cfpod {
1484 ((my $self), (local $_)) = @_;
1485
1486 # escape & and <
1487 s/&/&amp;/g;
1488 s/(?<![BIUGHT])</&lt;/g;
1489
1490 # this is buggy, it needs to properly take care of nested <'s
1491
1492 1 while
1493 # replace B<>, I<>, U<> etc.
1494 s/B<([^\>]*)>/<b>$1<\/b>/
1495 || s/I<([^\>]*)>/<i>$1<\/i>/
1496 || s/U<([^\>]*)>/<u>$1<\/u>/
1497 || s/T<([^\>]*)>/<big><b>$1<\/b><\/big>/
1498 # replace G<male|female> tags
1499 || s{G<([^>|]*)\|([^>]*)>}{
1500 $self->gender ? $2 : $1
1501 }ge
1502 # replace H<hint text>
1503 || s{H<([^\>]*)>}
1504 {
1505 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1506 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1507 "")
1508 [$self->{hintmode}]
1509 }ge;
1510
1511 # create single paragraphs (very hackish)
1512 s/(?<=\S)\n(?=\w)/ /g;
1513
1514 # compress some whitespace
1515 s/\s+\n/\n/g; # ws line-ends
1516 s/\n\n+/\n/g; # double lines
1517 s/^\n+//; # beginning lines
1518 s/\n+$//; # ending lines
1519
1520 $_
1521}
1522
1523sub hintmode {
1524 $_[0]{hintmode} = $_[1] if @_ > 1;
1525 $_[0]{hintmode}
1526}
1527
1115=item $player->ext_reply ($msgid, $msgtype, %msg) 1528=item $player->ext_reply ($msgid, @msg)
1116 1529
1117Sends an ext reply to the player. 1530Sends an ext reply to the player.
1118 1531
1119=cut 1532=cut
1120 1533
1121sub ext_reply($$$%) { 1534sub ext_reply($$@) {
1122 my ($self, $id, %msg) = @_; 1535 my ($self, $id, @msg) = @_;
1123 1536
1124 $msg{msgid} = $id; 1537 $self->ns->ext_reply ($id, @msg)
1125
1126 $self->send ("ext " . cf::to_json \%msg);
1127} 1538}
1128 1539
1129package cf; 1540=item $player->ext_msg ($type, @msg)
1541
1542Sends an ext event to the client.
1543
1544=cut
1545
1546sub ext_msg($$@) {
1547 my ($self, $type, @msg) = @_;
1548
1549 $self->ns->ext_msg ($type, @msg);
1550}
1551
1552=head3 cf::region
1553
1554=over 4
1555
1556=cut
1557
1558package cf::region;
1559
1560=item cf::region::find_by_path $path
1561
1562Tries to decuce the likely region for a map knowing only its path.
1563
1564=cut
1565
1566sub find_by_path($) {
1567 my ($path) = @_;
1568
1569 my ($match, $specificity);
1570
1571 for my $region (list) {
1572 if ($region->{match} && $path =~ $region->{match}) {
1573 ($match, $specificity) = ($region, $region->specificity)
1574 if $region->specificity > $specificity;
1575 }
1576 }
1577
1578 $match
1579}
1130 1580
1131=back 1581=back
1132
1133 1582
1134=head3 cf::map 1583=head3 cf::map
1135 1584
1136=over 4 1585=over 4
1137 1586
1192 my ($self, $merge) = @_; 1641 my ($self, $merge) = @_;
1193 1642
1194 # we have to keep some variables in memory intact 1643 # we have to keep some variables in memory intact
1195 local $self->{path}; 1644 local $self->{path};
1196 local $self->{load_path}; 1645 local $self->{load_path};
1197 local $self->{deny_save};
1198 local $self->{deny_reset};
1199 1646
1200 $self->SUPER::thawer_merge ($merge); 1647 $self->SUPER::thawer_merge ($merge);
1201} 1648}
1202 1649
1203sub normalise { 1650sub normalise {
1250 $self->init; # pass $1 etc. 1697 $self->init; # pass $1 etc.
1251 return $self; 1698 return $self;
1252 } 1699 }
1253 } 1700 }
1254 1701
1255 Carp::carp "unable to resolve path '$path' (base '$base')."; 1702 Carp::cluck "unable to resolve path '$path' (base '$base').";
1256 () 1703 ()
1257} 1704}
1258 1705
1259sub init { 1706sub init {
1260 my ($self) = @_; 1707 my ($self) = @_;
1275 1722
1276# the original (read-only) location 1723# the original (read-only) location
1277sub load_path { 1724sub load_path {
1278 my ($self) = @_; 1725 my ($self) = @_;
1279 1726
1280 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1727 "$MAPDIR/$self->{path}.map"
1281} 1728}
1282 1729
1283# the temporary/swap location 1730# the temporary/swap location
1284sub save_path { 1731sub save_path {
1285 my ($self) = @_; 1732 my ($self) = @_;
1286 1733
1287 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1734 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1288 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1735 "$TMPDIR/$path.map"
1289} 1736}
1290 1737
1291# the unique path, undef == no special unique path 1738# the unique path, undef == no special unique path
1292sub uniq_path { 1739sub uniq_path {
1293 my ($self) = @_; 1740 my ($self) = @_;
1294 1741
1295 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1742 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1296 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1743 "$UNIQUEDIR/$path"
1297} 1744}
1298 1745
1299# and all this just because we cannot iterate over 1746# and all this just because we cannot iterate over
1300# all maps in C++... 1747# all maps in C++...
1301sub change_all_map_light { 1748sub change_all_map_light {
1303 1750
1304 $_->change_map_light ($change) 1751 $_->change_map_light ($change)
1305 for grep $_->outdoor, values %cf::MAP; 1752 for grep $_->outdoor, values %cf::MAP;
1306} 1753}
1307 1754
1755sub decay_objects {
1756 my ($self) = @_;
1757
1758 return if $self->{deny_reset};
1759
1760 $self->do_decay_objects;
1761}
1762
1308sub unlink_save { 1763sub unlink_save {
1309 my ($self) = @_; 1764 my ($self) = @_;
1310 1765
1311 utf8::encode (my $save = $self->save_path); 1766 utf8::encode (my $save = $self->save_path);
1312 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1767 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1313 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1768 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1314
1315 #d#TODO remove .map and also nuke
1316 $save =~ s/\.map// or return;#d#
1317 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1318 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1319} 1769}
1320 1770
1321sub load_header_from($) { 1771sub load_header_from($) {
1322 my ($self, $path) = @_; 1772 my ($self, $path) = @_;
1323 1773
1324 utf8::encode $path; 1774 utf8::encode $path;
1325 #aio_open $path, O_RDONLY, 0 1775 my $f = new_from_file cf::object::thawer $path
1326 # or return;
1327
1328 $self->_load_header ($path)
1329 or return; 1776 or return;
1777
1778 $self->_load_header ($f)
1779 or return;
1780
1781 local $MAP_LOADING{$self->{path}} = $self;
1782 $f->resolve_delayed_derefs;
1330 1783
1331 $self->{load_path} = $path; 1784 $self->{load_path} = $path;
1332 1785
1333 1 1786 1
1334} 1787}
1373 $self->load_header_orig 1826 $self->load_header_orig
1374 or return; 1827 or return;
1375 $self->prepare_orig; 1828 $self->prepare_orig;
1376 } 1829 }
1377 1830
1831 $self->{deny_reset} = 1
1832 if $self->no_reset;
1833
1834 $self->default_region (cf::region::find_by_path $self->{path})
1835 unless $self->default_region;
1836
1378 1 1837 1
1379} 1838}
1380 1839
1381sub find; 1840sub find;
1382sub find { 1841sub find {
1394 $map->{last_save} = $cf::RUNTIME; 1853 $map->{last_save} = $cf::RUNTIME;
1395 1854
1396 $map->load_header 1855 $map->load_header
1397 or return; 1856 or return;
1398 1857
1399 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1858 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1400 # doing this can freeze the server in a sync job, obviously 1859 # doing this can freeze the server in a sync job, obviously
1401 #$cf::WAIT_FOR_TICK->wait; 1860 #$cf::WAIT_FOR_TICK->wait;
1402 $map->reset; 1861 $map->reset;
1403 undef $guard; 1862 undef $guard;
1404 return find $path; 1863 return find $path;
1415 my ($self) = @_; 1874 my ($self) = @_;
1416 1875
1417 local $self->{deny_reset} = 1; # loading can take a long time 1876 local $self->{deny_reset} = 1; # loading can take a long time
1418 1877
1419 my $path = $self->{path}; 1878 my $path = $self->{path};
1879
1880 {
1420 my $guard = cf::lock_acquire "map_load:$path"; 1881 my $guard = cf::lock_acquire "map_data:$path";
1421 1882
1883 return unless $self->valid;
1422 return if $self->in_memory != cf::MAP_SWAPPED; 1884 return if $self->in_memory != cf::MAP_SWAPPED;
1423 1885
1424 $self->in_memory (cf::MAP_LOADING); 1886 $self->in_memory (cf::MAP_LOADING);
1425 1887
1426 $self->alloc; 1888 $self->alloc;
1427 1889
1428 $self->pre_load; 1890 $self->pre_load;
1891 cf::cede_to_tick;
1429 1892
1430 $self->_load_objects ($self->{load_path}, 1) 1893 my $f = new_from_file cf::object::thawer $self->{load_path};
1894 $f->skip_block;
1895 $self->_load_objects ($f)
1431 or return; 1896 or return;
1432 1897
1433 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1434 if delete $self->{load_original}; 1899 if delete $self->{load_original};
1435 1900
1436 if (my $uniq = $self->uniq_path) { 1901 if (my $uniq = $self->uniq_path) {
1437 utf8::encode $uniq; 1902 utf8::encode $uniq;
1438 if (aio_open $uniq, O_RDONLY, 0) { 1903 unless (aio_stat $uniq) {
1904 if (my $f = new_from_file cf::object::thawer $uniq) {
1439 $self->clear_unique_items; 1905 $self->clear_unique_items;
1440 $self->_load_objects ($uniq, 0); 1906 $self->_load_objects ($f);
1907 $f->resolve_delayed_derefs;
1908 }
1441 } 1909 }
1442 } 1910 }
1443 1911
1444 Coro::cede; 1912 $f->resolve_delayed_derefs;
1445 1913
1914 cf::cede_to_tick;
1446 # now do the right thing for maps 1915 # now do the right thing for maps
1447 $self->link_multipart_objects; 1916 $self->link_multipart_objects;
1448
1449 unless ($self->{deny_activate}) {
1450 $self->decay_objects;
1451 $self->fix_auto_apply;
1452 $self->update_buttons;
1453 Coro::cede;
1454 $self->set_darkness_map;
1455 $self->difficulty ($self->estimate_difficulty) 1917 $self->difficulty ($self->estimate_difficulty)
1456 unless $self->difficulty; 1918 unless $self->difficulty;
1457 Coro::cede; 1919 cf::cede_to_tick;
1920
1921 unless ($self->{deny_activate}) {
1922 $self->decay_objects;
1923 $self->fix_auto_apply;
1924 $self->update_buttons;
1925 cf::cede_to_tick;
1926 $self->set_darkness_map;
1927 cf::cede_to_tick;
1458 $self->activate; 1928 $self->activate;
1929 }
1930
1931 $self->{last_save} = $cf::RUNTIME;
1932 $self->last_access ($cf::RUNTIME);
1933
1934 $self->in_memory (cf::MAP_IN_MEMORY);
1459 } 1935 }
1460 1936
1461 $self->post_load; 1937 $self->post_load;
1462
1463 $self->in_memory (cf::MAP_IN_MEMORY);
1464} 1938}
1465 1939
1466sub customise_for { 1940sub customise_for {
1467 my ($self, $ob) = @_; 1941 my ($self, $ob) = @_;
1468 1942
1469 return find "~" . $ob->name . "/" . $self->{path} 1943 return find "~" . $ob->name . "/" . $self->{path}
1470 if $self->per_player; 1944 if $self->per_player;
1471 1945
1946# return find "?party/" . $ob->name . "/" . $self->{path}
1947# if $self->per_party;
1948
1472 $self 1949 $self
1473} 1950}
1474 1951
1475# find and load all maps in the 3x3 area around a map 1952# find and load all maps in the 3x3 area around a map
1476sub load_diag { 1953sub load_neighbours {
1477 my ($map) = @_; 1954 my ($map) = @_;
1478 1955
1479 my @diag; # diagonal neighbours 1956 my @neigh; # diagonal neighbours
1480 1957
1481 for (0 .. 3) { 1958 for (0 .. 3) {
1482 my $neigh = $map->tile_path ($_) 1959 my $neigh = $map->tile_path ($_)
1483 or next; 1960 or next;
1484 $neigh = find $neigh, $map 1961 $neigh = find $neigh, $map
1485 or next; 1962 or next;
1486 $neigh->load; 1963 $neigh->load;
1487 1964
1965 push @neigh,
1488 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1966 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1489 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1967 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1490 } 1968 }
1491 1969
1492 for (@diag) { 1970 for (grep defined $_->[0], @neigh) {
1971 my ($path, $origin) = @$_;
1493 my $neigh = find @$_ 1972 my $neigh = find $path, $origin
1494 or next; 1973 or next;
1495 $neigh->load; 1974 $neigh->load;
1496 } 1975 }
1497} 1976}
1498 1977
1503} 1982}
1504 1983
1505sub do_load_sync { 1984sub do_load_sync {
1506 my ($map) = @_; 1985 my ($map) = @_;
1507 1986
1987 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1988 if $Coro::current == $Coro::main;
1989
1508 cf::sync_job { $map->load }; 1990 cf::sync_job { $map->load };
1509} 1991}
1510 1992
1511our %MAP_PREFETCH; 1993our %MAP_PREFETCH;
1512our $MAP_PREFETCHER = undef; 1994our $MAP_PREFETCHER = undef;
1513 1995
1514sub find_async { 1996sub find_async {
1515 my ($path, $origin) = @_; 1997 my ($path, $origin, $load) = @_;
1516 1998
1517 $path = normalise $path, $origin && $origin->{path}; 1999 $path = normalise $path, $origin && $origin->{path};
1518 2000
1519 if (my $map = $cf::MAP{$path}) { 2001 if (my $map = $cf::MAP{$path}) {
1520 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2002 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1521 } 2003 }
1522 2004
1523 undef $MAP_PREFETCH{$path}; 2005 $MAP_PREFETCH{$path} |= $load;
2006
1524 $MAP_PREFETCHER ||= cf::async { 2007 $MAP_PREFETCHER ||= cf::async {
1525 while (%MAP_PREFETCH) { 2008 while (%MAP_PREFETCH) {
1526 for my $path (keys %MAP_PREFETCH) { 2009 while (my ($k, $v) = each %MAP_PREFETCH) {
1527 my $map = find $path 2010 if (my $map = find $k) {
1528 or next;
1529 $map->load; 2011 $map->load if $v;
2012 }
1530 2013
1531 delete $MAP_PREFETCH{$path}; 2014 delete $MAP_PREFETCH{$k};
1532 } 2015 }
1533 } 2016 }
1534 undef $MAP_PREFETCHER; 2017 undef $MAP_PREFETCHER;
1535 }; 2018 };
1536 $MAP_PREFETCHER->prio (6); 2019 $MAP_PREFETCHER->prio (6);
1539} 2022}
1540 2023
1541sub save { 2024sub save {
1542 my ($self) = @_; 2025 my ($self) = @_;
1543 2026
1544 my $lock = cf::lock_acquire "map_data:" . $self->path; 2027 my $lock = cf::lock_acquire "map_data:$self->{path}";
1545 2028
1546 $self->{last_save} = $cf::RUNTIME; 2029 $self->{last_save} = $cf::RUNTIME;
1547 2030
1548 return unless $self->dirty; 2031 return unless $self->dirty;
1549 2032
1572 my ($self) = @_; 2055 my ($self) = @_;
1573 2056
1574 # save first because save cedes 2057 # save first because save cedes
1575 $self->save; 2058 $self->save;
1576 2059
1577 my $lock = cf::lock_acquire "map_data:" . $self->path; 2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
1578 2061
1579 return if $self->players; 2062 return if $self->players;
1580 return if $self->in_memory != cf::MAP_IN_MEMORY; 2063 return if $self->in_memory != cf::MAP_IN_MEMORY;
1581 return if $self->{deny_save}; 2064 return if $self->{deny_save};
1582 2065
1586 2069
1587sub reset_at { 2070sub reset_at {
1588 my ($self) = @_; 2071 my ($self) = @_;
1589 2072
1590 # TODO: safety, remove and allow resettable per-player maps 2073 # TODO: safety, remove and allow resettable per-player maps
1591 return 1e99 if $self->isa ("ext::map_per_player");#d#
1592 return 1e99 if $self->{deny_reset}; 2074 return 1e99 if $self->{deny_reset};
1593 2075
1594 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2076 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1595 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2077 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1596 2078
1607 my ($self) = @_; 2089 my ($self) = @_;
1608 2090
1609 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2091 my $lock = cf::lock_acquire "map_data:$self->{path}";
1610 2092
1611 return if $self->players; 2093 return if $self->players;
1612 return if $self->isa ("ext::map_per_player");#d#
1613 2094
1614 warn "resetting map ", $self->path;#d# 2095 warn "resetting map ", $self->path;
1615 2096
1616 $self->in_memory (cf::MAP_SWAPPED); 2097 $self->in_memory (cf::MAP_SWAPPED);
1617 2098
1618 # need to save uniques path 2099 # need to save uniques path
1619 unless ($self->{deny_save}) { 2100 unless ($self->{deny_save}) {
1636my $nuke_counter = "aaaa"; 2117my $nuke_counter = "aaaa";
1637 2118
1638sub nuke { 2119sub nuke {
1639 my ($self) = @_; 2120 my ($self) = @_;
1640 2121
2122 {
2123 my $lock = cf::lock_acquire "map_data:$self->{path}";
2124
1641 delete $cf::MAP{$self->path}; 2125 delete $cf::MAP{$self->path};
1642 2126
1643 $self->unlink_save; 2127 $self->unlink_save;
1644 2128
1645 bless $self, "cf::map"; 2129 bless $self, "cf::map";
1646 delete $self->{deny_reset}; 2130 delete $self->{deny_reset};
1647 $self->{deny_save} = 1; 2131 $self->{deny_save} = 1;
1648 $self->reset_timeout (1); 2132 $self->reset_timeout (1);
1649 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2133 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1650 2134
1651 $cf::MAP{$self->path} = $self; 2135 $cf::MAP{$self->path} = $self;
2136 }
1652 2137
1653 $self->reset; # polite request, might not happen 2138 $self->reset; # polite request, might not happen
2139}
2140
2141=item $maps = cf::map::tmp_maps
2142
2143Returns an arrayref with all map paths of currently instantiated and saved
2144maps. May block.
2145
2146=cut
2147
2148sub tmp_maps() {
2149 [
2150 map {
2151 utf8::decode $_;
2152 /\.map$/
2153 ? normalise $_
2154 : ()
2155 } @{ aio_readdir $TMPDIR or [] }
2156 ]
2157}
2158
2159=item $maps = cf::map::random_maps
2160
2161Returns an arrayref with all map paths of currently instantiated and saved
2162random maps. May block.
2163
2164=cut
2165
2166sub random_maps() {
2167 [
2168 map {
2169 utf8::decode $_;
2170 /\.map$/
2171 ? normalise "?random/$_"
2172 : ()
2173 } @{ aio_readdir $RANDOMDIR or [] }
2174 ]
1654} 2175}
1655 2176
1656=item cf::map::unique_maps 2177=item cf::map::unique_maps
1657 2178
1658Returns an arrayref of paths of all shared maps that have 2179Returns an arrayref of paths of all shared maps that have
1659instantiated unique items. May block. 2180instantiated unique items. May block.
1660 2181
1661=cut 2182=cut
1662 2183
1663sub unique_maps() { 2184sub unique_maps() {
1664 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2185 [
1665 or return; 2186 map {
1666
1667 my @paths;
1668
1669 for (@$files) {
1670 utf8::decode $_; 2187 utf8::decode $_;
1671 next if /\.pst$/; 2188 /\.map$/
1672 next unless /^$PATH_SEP/o; 2189 ? normalise $_
1673 2190 : ()
1674 push @paths, cf::map::normalise $_; 2191 } @{ aio_readdir $UNIQUEDIR or [] }
1675 } 2192 ]
1676
1677 \@paths
1678} 2193}
1679 2194
1680package cf; 2195package cf;
1681 2196
1682=back 2197=back
1700 map { $_, inv_recursive_ $_->inv } @_ 2215 map { $_, inv_recursive_ $_->inv } @_
1701} 2216}
1702 2217
1703sub inv_recursive { 2218sub inv_recursive {
1704 inv_recursive_ inv $_[0] 2219 inv_recursive_ inv $_[0]
2220}
2221
2222=item $ref = $ob->ref
2223
2224creates and returns a persistent reference to an objetc that can be stored as a string.
2225
2226=item $ob = cf::object::deref ($refstring)
2227
2228returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2229even if the object actually exists. May block.
2230
2231=cut
2232
2233sub deref {
2234 my ($ref) = @_;
2235
2236 # temporary compatibility#TODO#remove
2237 $ref =~ s{^<}{player/<};
2238
2239 if ($ref =~ m{^player\/(<1\.\d+>)/(.*)$}) {
2240 my ($uuid, $name) = ($1, $2);
2241 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2242 or return;
2243 $pl->ob->uuid eq $uuid
2244 or return;
2245
2246 $pl->ob
2247 } else {
2248 warn "$ref: cannot resolve object reference\n";
2249 undef
2250 }
1705} 2251}
1706 2252
1707package cf; 2253package cf;
1708 2254
1709=back 2255=back
1728 2274
1729 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2275 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1730 2276
1731 if ($self->{record_replies}) { 2277 if ($self->{record_replies}) {
1732 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2278 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2279
1733 } else { 2280 } else {
2281 my $pl = $self->contr;
2282
2283 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2284 my $dialog = $pl->{npc_dialog};
2285 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2286
2287 } else {
1734 $msg = $npc->name . " says: $msg" if $npc; 2288 $msg = $npc->name . " says: $msg" if $npc;
1735 $self->message ($msg, $flags); 2289 $self->message ($msg, $flags);
2290 }
1736 } 2291 }
2292}
2293
2294=item $object->send_msg ($channel, $msg, $color, [extra...])
2295
2296=cut
2297
2298sub cf::object::send_msg {
2299 my $pl = shift->contr
2300 or return;
2301 $pl->send_msg (@_);
1737} 2302}
1738 2303
1739=item $player_object->may ("access") 2304=item $player_object->may ("access")
1740 2305
1741Returns wether the given player is authorized to access resource "access" 2306Returns wether the given player is authorized to access resource "access"
1788 $self->deactivate_recursive; 2353 $self->deactivate_recursive;
1789 2354
1790 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2355 return if UNIVERSAL::isa $self->map, "ext::map_link";
1791 2356
1792 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2357 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1793 if $self->map; 2358 if $self->map && $self->map->{path} ne "{link}";
1794 2359
1795 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2360 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1796} 2361}
1797 2362
1798sub cf::object::player::leave_link { 2363sub cf::object::player::leave_link {
1799 my ($self, $map, $x, $y) = @_; 2364 my ($self, $map, $x, $y) = @_;
2365
2366 return unless $self->contr->active;
1800 2367
1801 my $link_pos = delete $self->{_link_pos}; 2368 my $link_pos = delete $self->{_link_pos};
1802 2369
1803 unless ($map) { 2370 unless ($map) {
1804 # restore original map position 2371 # restore original map position
1818 # use -1 or undef as default coordinates, not 0, 0 2385 # use -1 or undef as default coordinates, not 0, 0
1819 ($x, $y) = ($map->enter_x, $map->enter_y) 2386 ($x, $y) = ($map->enter_x, $map->enter_y)
1820 if $x <=0 && $y <= 0; 2387 if $x <=0 && $y <= 0;
1821 2388
1822 $map->load; 2389 $map->load;
1823 $map->load_diag; 2390 $map->load_neighbours;
1824 2391
1825 return unless $self->contr->active; 2392 return unless $self->contr->active;
1826 $self->activate_recursive; 2393 $self->activate_recursive;
2394
2395 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1827 $self->enter_map ($map, $x, $y); 2396 $self->enter_map ($map, $x, $y);
1828} 2397}
1829 2398
1830cf::player->attach ( 2399=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1831 on_logout => sub {
1832 my ($pl) = @_;
1833 2400
1834 # abort map switching before logout 2401Moves the player to the given map-path and coordinates by first freezing
1835 if ($pl->ob->{_link_pos}) { 2402her, loading and preparing them map, calling the provided $check callback
1836 cf::sync_job { 2403that has to return the map if sucecssful, and then unfreezes the player on
1837 $pl->ob->leave_link 2404the new (success) or old (failed) map position. In either case, $done will
1838 }; 2405be called at the end of this process.
1839 }
1840 },
1841 on_login => sub {
1842 my ($pl) = @_;
1843 2406
1844 # try to abort aborted map switching on player login :)
1845 # should happen only on crashes
1846 if ($pl->ob->{_link_pos}) {
1847 $pl->ob->enter_link;
1848 (async {
1849 # we need this sleep as the login has a concurrent enter_exit running
1850 # and this sleep increases chances of the player not ending up in scorn
1851 $pl->ob->reply (undef,
1852 "There was an internal problem at your last logout, "
1853 . "the server will try to bring you to your intended destination in a second.",
1854 cf::NDI_RED);
1855 Coro::Timer::sleep 1;
1856 $pl->ob->leave_link;
1857 })->prio (2);
1858 }
1859 },
1860);
1861
1862=item $player_object->goto ($path, $x, $y)
1863
1864=cut 2407=cut
2408
2409our $GOTOGEN;
1865 2410
1866sub cf::object::player::goto { 2411sub cf::object::player::goto {
1867 my ($self, $path, $x, $y) = @_; 2412 my ($self, $path, $x, $y, $check, $done) = @_;
2413
2414 # do generation counting so two concurrent goto's will be executed in-order
2415 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1868 2416
1869 $self->enter_link; 2417 $self->enter_link;
1870 2418
1871 (async { 2419 (async {
1872 my $map = eval { 2420 my $map = eval {
1873 my $map = cf::map::find $path; 2421 my $map = cf::map::find $path;
2422
2423 if ($map) {
1874 $map = $map->customise_for ($self) if $map; 2424 $map = $map->customise_for ($self);
2425 $map = $check->($map) if $check && $map;
2426 } else {
2427 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2428 }
2429
1875 $map 2430 $map
2431 };
2432
2433 if ($@) {
2434 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2435 LOG llevError | logBacktrace, Carp::longmess $@;
1876 } or 2436 }
1877 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1878 2437
2438 if ($gen == $self->{_goto_generation}) {
2439 delete $self->{_goto_generation};
1879 $self->leave_link ($map, $x, $y); 2440 $self->leave_link ($map, $x, $y);
2441 }
2442
2443 $done->() if $done;
1880 })->prio (1); 2444 })->prio (1);
1881} 2445}
1882 2446
1883=item $player_object->enter_exit ($exit_object) 2447=item $player_object->enter_exit ($exit_object)
1884 2448
1923 2487
1924 $rmp->{random_seed} ||= $exit->random_seed; 2488 $rmp->{random_seed} ||= $exit->random_seed;
1925 2489
1926 my $data = cf::to_json $rmp; 2490 my $data = cf::to_json $rmp;
1927 my $md5 = Digest::MD5::md5_hex $data; 2491 my $md5 = Digest::MD5::md5_hex $data;
1928 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2492 my $meta = "$RANDOMDIR/$md5.meta";
1929 2493
1930 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2494 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1931 aio_write $fh, 0, (length $data), $data, 0; 2495 aio_write $fh, 0, (length $data), $data, 0;
1932 undef $fh; 2496 undef $fh;
1933 aio_rename "$meta~", $meta; 2497 aio_rename "$meta~", $meta;
1942 2506
1943 return unless $self->type == cf::PLAYER; 2507 return unless $self->type == cf::PLAYER;
1944 2508
1945 if ($exit->slaying eq "/!") { 2509 if ($exit->slaying eq "/!") {
1946 #TODO: this should de-fi-ni-te-ly not be a sync-job 2510 #TODO: this should de-fi-ni-te-ly not be a sync-job
2511 # the problem is that $exit might not survive long enough
2512 # so it needs to be done right now, right here
1947 cf::sync_job { prepare_random_map $exit }; 2513 cf::sync_job { prepare_random_map $exit };
1948 } 2514 }
1949 2515
1950 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2516 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1951 my $hp = $exit->stats->hp; 2517 my $hp = $exit->stats->hp;
1952 my $sp = $exit->stats->sp; 2518 my $sp = $exit->stats->sp;
1953 2519
1954 $self->enter_link; 2520 $self->enter_link;
2521
2522 # if exit is damned, update players death & WoR home-position
2523 $self->contr->savebed ($slaying, $hp, $sp)
2524 if $exit->flag (FLAG_DAMNED);
1955 2525
1956 (async { 2526 (async {
1957 $self->deactivate_recursive; # just to be sure 2527 $self->deactivate_recursive; # just to be sure
1958 unless (eval { 2528 unless (eval {
1959 $self->goto ($slaying, $hp, $sp); 2529 $self->goto ($slaying, $hp, $sp);
1960 2530
1961 1; 2531 1;
1962 }) { 2532 }) {
1963 $self->message ("Something went wrong deep within the crossfire server. " 2533 $self->message ("Something went wrong deep within the crossfire server. "
1964 . "I'll try to bring you back to the map you were before. " 2534 . "I'll try to bring you back to the map you were before. "
1965 . "Please report this to the dungeon master!", 2535 . "Please report this to the dungeon master!",
1966 cf::NDI_UNIQUE | cf::NDI_RED); 2536 cf::NDI_UNIQUE | cf::NDI_RED);
1967 2537
1968 warn "ERROR in enter_exit: $@"; 2538 warn "ERROR in enter_exit: $@";
1969 $self->leave_link; 2539 $self->leave_link;
1970 } 2540 }
1971 })->prio (1); 2541 })->prio (1);
1984 2554
1985sub cf::client::send_drawinfo { 2555sub cf::client::send_drawinfo {
1986 my ($self, $text, $flags) = @_; 2556 my ($self, $text, $flags) = @_;
1987 2557
1988 utf8::encode $text; 2558 utf8::encode $text;
1989 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2559 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1990} 2560}
1991 2561
2562=item $client->send_msg ($channel, $msg, $color, [extra...])
2563
2564Send a drawinfo or msg packet to the client, formatting the msg for the
2565client if neccessary. C<$type> should be a string identifying the type of
2566the message, with C<log> being the default. If C<$color> is negative, suppress
2567the message unless the client supports the msg packet.
2568
2569=cut
2570
2571our %CHANNEL = (
2572 "c/identify" => {
2573 id => "identify",
2574 title => "Identify",
2575 reply => undef,
2576 tooltip => "Items recently identified",
2577 },
2578 "c/examine" => {
2579 id => "examine",
2580 title => "Examine",
2581 reply => undef,
2582 tooltip => "Signs and other items you examined",
2583 },
2584);
2585
2586sub cf::client::send_msg {
2587 my ($self, $channel, $msg, $color, @extra) = @_;
2588
2589 $msg = $self->pl->expand_cfpod ($msg);
2590
2591 $color &= cf::NDI_CLIENT_MASK; # just in case...
2592
2593 # check predefined channels, for the benefit of C
2594 $channel = $CHANNEL{$channel} if $CHANNEL{$channel};
2595
2596 if (ref $channel) {
2597 # send meta info to client, if not yet sent
2598 unless (exists $self->{channel}{$channel->{id}}) {
2599 $self->{channel}{$channel->{id}} = $channel;
2600 $self->ext_msg (channel_info => $channel)
2601 if $self->can_msg;
2602 }
2603
2604 $channel = $channel->{id};
2605 }
2606
2607 return unless @extra || length $msg;
2608
2609 if ($self->can_msg) {
2610 # default colour, mask it out
2611 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2612 if $color & cf::NDI_DEF;
2613
2614 $self->send_packet ("msg " . $self->{json_coder}->encode (
2615 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2616 } else {
2617 if ($color >= 0) {
2618 # replace some tags by gcfclient-compatible ones
2619 for ($msg) {
2620 1 while
2621 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2622 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2623 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2624 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2625 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2626 }
2627
2628 $color &= cf::NDI_COLOR_MASK;
2629
2630 utf8::encode $msg;
2631
2632 if (0 && $msg =~ /\[/) {
2633 # COMMAND/INFO
2634 $self->send_packet ("drawextinfo $color 10 8 $msg")
2635 } else {
2636 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2637 $self->send_packet ("drawinfo $color $msg")
2638 }
2639 }
2640 }
2641}
2642
2643=item $client->ext_msg ($type, @msg)
2644
2645Sends an ext event to the client.
2646
2647=cut
2648
2649sub cf::client::ext_msg($$@) {
2650 my ($self, $type, @msg) = @_;
2651
2652 if ($self->extcmd == 2) {
2653 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2654 } elsif ($self->extcmd == 1) { # TODO: remove
2655 push @msg, msgtype => "event_$type";
2656 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2657 }
2658}
2659
2660=item $client->ext_reply ($msgid, @msg)
2661
2662Sends an ext reply to the client.
2663
2664=cut
2665
2666sub cf::client::ext_reply($$@) {
2667 my ($self, $id, @msg) = @_;
2668
2669 if ($self->extcmd == 2) {
2670 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2671 } elsif ($self->extcmd == 1) {
2672 #TODO: version 1, remove
2673 unshift @msg, msgtype => "reply", msgid => $id;
2674 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2675 }
2676}
1992 2677
1993=item $success = $client->query ($flags, "text", \&cb) 2678=item $success = $client->query ($flags, "text", \&cb)
1994 2679
1995Queues a query to the client, calling the given callback with 2680Queues a query to the client, calling the given callback with
1996the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2681the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1997C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2682C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1998 2683
1999Queries can fail, so check the return code. Or don't, as queries will become 2684Queries can fail, so check the return code. Or don't, as queries will
2000reliable at some point in the future. 2685become reliable at some point in the future.
2001 2686
2002=cut 2687=cut
2003 2688
2004sub cf::client::query { 2689sub cf::client::query {
2005 my ($self, $flags, $text, $cb) = @_; 2690 my ($self, $flags, $text, $cb) = @_;
2013 utf8::encode $text; 2698 utf8::encode $text;
2014 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2699 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2015 2700
2016 $self->send_packet ($self->{query_queue}[0][0]) 2701 $self->send_packet ($self->{query_queue}[0][0])
2017 if @{ $self->{query_queue} } == 1; 2702 if @{ $self->{query_queue} } == 1;
2703
2704 1
2018} 2705}
2019 2706
2020cf::client->attach ( 2707cf::client->attach (
2708 on_connect => sub {
2709 my ($ns) = @_;
2710
2711 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2712 },
2021 on_reply => sub { 2713 on_reply => sub {
2022 my ($ns, $msg) = @_; 2714 my ($ns, $msg) = @_;
2023 2715
2024 # this weird shuffling is so that direct followup queries 2716 # this weird shuffling is so that direct followup queries
2025 # get handled first 2717 # get handled first
2037 } else { 2729 } else {
2038 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2730 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2039 } 2731 }
2040 } 2732 }
2041 }, 2733 },
2734 on_exticmd => sub {
2735 my ($ns, $buf) = @_;
2736
2737 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2738
2739 if (ref $msg) {
2740 my ($type, $reply, @payload) =
2741 "ARRAY" eq ref $msg
2742 ? @$msg
2743 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2744
2745 my @reply;
2746
2747 if (my $cb = $EXTICMD{$type}) {
2748 @reply = $cb->($ns, @payload);
2749 }
2750
2751 $ns->ext_reply ($reply, @reply)
2752 if $reply;
2753
2754 } else {
2755 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2756 }
2757
2758 cf::override;
2759 },
2042); 2760);
2043 2761
2044=item $client->async (\&cb) 2762=item $client->async (\&cb)
2045 2763
2046Create a new coroutine, running the specified callback. The coroutine will 2764Create a new coroutine, running the specified callback. The coroutine will
2087our $safe = new Safe "safe"; 2805our $safe = new Safe "safe";
2088our $safe_hole = new Safe::Hole; 2806our $safe_hole = new Safe::Hole;
2089 2807
2090$SIG{FPE} = 'IGNORE'; 2808$SIG{FPE} = 'IGNORE';
2091 2809
2092$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2810$safe->permit_only (Opcode::opset qw(
2811 :base_core :base_mem :base_orig :base_math
2812 grepstart grepwhile mapstart mapwhile
2813 sort time
2814));
2093 2815
2094# here we export the classes and methods available to script code 2816# here we export the classes and methods available to script code
2095 2817
2096=pod 2818=pod
2097 2819
2098The following fucntions and emthods are available within a safe environment: 2820The following functions and methods are available within a safe environment:
2099 2821
2100 cf::object contr pay_amount pay_player map 2822 cf::object
2823 contr pay_amount pay_player map x y force_find force_add
2824 insert remove name archname title slaying race decrease_ob_nr
2825
2101 cf::object::player player 2826 cf::object::player
2102 cf::player peaceful 2827 player
2103 cf::map trigger 2828
2829 cf::player
2830 peaceful
2831
2832 cf::map
2833 trigger
2104 2834
2105=cut 2835=cut
2106 2836
2107for ( 2837for (
2108 ["cf::object" => qw(contr pay_amount pay_player map)], 2838 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2839 insert remove inv name archname title slaying race
2840 decrease_ob_nr)],
2109 ["cf::object::player" => qw(player)], 2841 ["cf::object::player" => qw(player)],
2110 ["cf::player" => qw(peaceful)], 2842 ["cf::player" => qw(peaceful)],
2111 ["cf::map" => qw(trigger)], 2843 ["cf::map" => qw(trigger)],
2112) { 2844) {
2113 no strict 'refs'; 2845 no strict 'refs';
2184=back 2916=back
2185 2917
2186=cut 2918=cut
2187 2919
2188############################################################################# 2920#############################################################################
2189
2190=head2 EXTENSION DATABASE SUPPORT
2191
2192Crossfire maintains a very simple database for extension use. It can
2193currently store anything that can be serialised using Storable, which
2194excludes objects.
2195
2196The parameter C<$family> should best start with the name of the extension
2197using it, it should be unique.
2198
2199=over 4
2200
2201=item $value = cf::db_get $family => $key
2202
2203Returns a single value from the database.
2204
2205=item cf::db_put $family => $key => $value
2206
2207Stores the given C<$value> in the family.
2208
2209=cut
2210
2211our $DB;
2212
2213sub db_init {
2214 unless ($DB) {
2215 $DB = BDB::db_create $DB_ENV;
2216
2217 cf::sync_job {
2218 eval {
2219 $DB->set_flags (BDB::CHKSUM);
2220
2221 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2222 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2223 cf::cleanup "db_open(db): $!" if $!;
2224 };
2225 cf::cleanup "db_open(db): $@" if $@;
2226 };
2227
2228 my $path = cf::localdir . "/database.pst";
2229 if (stat $path) {
2230 cf::sync_job {
2231 my $pst = Storable::retrieve $path;
2232
2233 cf::db_put (board => data => $pst->{board});
2234 cf::db_put (guildrules => data => $pst->{guildrules});
2235 cf::db_put (rent => balance => $pst->{rent}{balance});
2236 BDB::db_env_txn_checkpoint $DB_ENV;
2237
2238 unlink $path;
2239 };
2240 }
2241 }
2242}
2243
2244sub db_get($$) {
2245 my $key = "$_[0]/$_[1]";
2246
2247 cf::sync_job {
2248 BDB::db_get $DB, undef, $key, my $data;
2249
2250 $! ? ()
2251 : Compress::LZF::sthaw $data
2252 }
2253}
2254
2255sub db_put($$$) {
2256 BDB::dbreq_pri 4;
2257 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2258}
2259
2260#############################################################################
2261# the server's init and main functions 2921# the server's init and main functions
2262 2922
2263sub load_resources { 2923sub load_facedata($) {
2264 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2924 my ($path) = @_;
2925
2926 # HACK to clear player env face cache, we need some signal framework
2927 # for this (global event?)
2928 %ext::player_env::MUSIC_FACE_CACHE = ();
2929
2930 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2931
2932 warn "loading facedata from $path\n";
2933
2934 my $facedata;
2935 0 < aio_load $path, $facedata
2936 or die "$path: $!";
2937
2938 $facedata = Coro::Storable::thaw $facedata;
2939
2940 $facedata->{version} == 2
2941 or cf::cleanup "$path: version mismatch, cannot proceed.";
2942
2943 # patch in the exptable
2944 $facedata->{resource}{"res/exp_table"} = {
2945 type => FT_RSRC,
2946 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2947 };
2948 cf::cede_to_tick;
2949
2950 {
2951 my $faces = $facedata->{faceinfo};
2952
2953 while (my ($face, $info) = each %$faces) {
2954 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2955 cf::face::set_visibility $idx, $info->{visibility};
2956 cf::face::set_magicmap $idx, $info->{magicmap};
2957 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2958 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2959
2960 cf::cede_to_tick;
2961 }
2962
2963 while (my ($face, $info) = each %$faces) {
2964 next unless $info->{smooth};
2965 my $idx = cf::face::find $face
2966 or next;
2967 if (my $smooth = cf::face::find $info->{smooth}) {
2968 cf::face::set_smooth $idx, $smooth;
2969 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2970 } else {
2971 warn "smooth face '$info->{smooth}' not found for face '$face'";
2972 }
2973
2974 cf::cede_to_tick;
2975 }
2976 }
2977
2978 {
2979 my $anims = $facedata->{animinfo};
2980
2981 while (my ($anim, $info) = each %$anims) {
2982 cf::anim::set $anim, $info->{frames}, $info->{facings};
2983 cf::cede_to_tick;
2984 }
2985
2986 cf::anim::invalidate_all; # d'oh
2987 }
2988
2989 {
2990 # TODO: for gcfclient pleasure, we should give resources
2991 # that gcfclient doesn't grok a >10000 face index.
2992 my $res = $facedata->{resource};
2993
2994 my $soundconf = delete $res->{"res/sound.conf"};
2995
2996 while (my ($name, $info) = each %$res) {
2997 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2998 my $data;
2999
3000 if ($info->{type} & 1) {
3001 # prepend meta info
3002
3003 my $meta = $enc->encode ({
3004 name => $name,
3005 %{ $info->{meta} || {} },
3006 });
3007
3008 $data = pack "(w/a*)*", $meta, $info->{data};
3009 } else {
3010 $data = $info->{data};
3011 }
3012
3013 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3014 cf::face::set_type $idx, $info->{type};
3015
3016 cf::cede_to_tick;
3017 }
3018
3019 if ($soundconf) {
3020 $soundconf = $enc->decode (delete $soundconf->{data});
3021
3022 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3023 my $sound = $soundconf->{compat}[$_]
3024 or next;
3025
3026 my $face = cf::face::find "sound/$sound->[1]";
3027 cf::sound::set $sound->[0] => $face;
3028 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3029 }
3030
3031 while (my ($k, $v) = each %{$soundconf->{event}}) {
3032 my $face = cf::face::find "sound/$v";
3033 cf::sound::set $k => $face;
3034 }
3035 }
3036 }
3037
3038 1
3039}
3040
3041register_exticmd fx_want => sub {
3042 my ($ns, $want) = @_;
3043
3044 while (my ($k, $v) = each %$want) {
3045 $ns->fx_want ($k, $v);
3046 }
3047};
3048
3049sub reload_regions {
3050 # HACK to clear player env face cache, we need some signal framework
3051 # for this (global event?)
3052 %ext::player_env::MUSIC_FACE_CACHE = ();
3053
3054 load_resource_file "$MAPDIR/regions"
2265 or die "unable to load regions file\n";#d# 3055 or die "unable to load regions file\n";
2266}
2267 3056
2268sub cfg_load { 3057 for (cf::region::list) {
3058 $_->{match} = qr/$_->{match}/
3059 if exists $_->{match};
3060 }
3061}
3062
3063sub reload_facedata {
3064 load_facedata "$DATADIR/facedata"
3065 or die "unable to load facedata\n";
3066}
3067
3068sub reload_archetypes {
3069 load_resource_file "$DATADIR/archetypes"
3070 or die "unable to load archetypes\n";
3071 #d# NEED to laod twice to resolve forward references
3072 # this really needs to be done in an extra post-pass
3073 # (which needs to be synchronous, so solve it differently)
3074 load_resource_file "$DATADIR/archetypes"
3075 or die "unable to load archetypes\n";
3076}
3077
3078sub reload_treasures {
3079 load_resource_file "$DATADIR/treasures"
3080 or die "unable to load treasurelists\n";
3081}
3082
3083sub reload_resources {
3084 warn "reloading resource files...\n";
3085
3086 reload_regions;
3087 reload_facedata;
3088 #reload_archetypes;#d#
3089 reload_archetypes;
3090 reload_treasures;
3091
3092 warn "finished reloading resource files\n";
3093}
3094
3095sub init {
3096 reload_resources;
3097}
3098
3099sub reload_config {
2269 open my $fh, "<:utf8", cf::confdir . "/config" 3100 open my $fh, "<:utf8", "$CONFDIR/config"
2270 or return; 3101 or return;
2271 3102
2272 local $/; 3103 local $/;
2273 *CFG = YAML::Syck::Load <$fh>; 3104 *CFG = YAML::Syck::Load <$fh>;
2274 3105
2282 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3113 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2283 and die "WARNING: m(un)lockall failed: $!\n"; 3114 and die "WARNING: m(un)lockall failed: $!\n";
2284 }; 3115 };
2285 warn $@ if $@; 3116 warn $@ if $@;
2286 } 3117 }
2287}
2288
2289sub init {
2290 load_resources;
2291} 3118}
2292 3119
2293sub main { 3120sub main {
2294 # we must not ever block the main coroutine 3121 # we must not ever block the main coroutine
2295 local $Coro::idle = sub { 3122 local $Coro::idle = sub {
2297 (async { 3124 (async {
2298 Event::one_event; 3125 Event::one_event;
2299 })->prio (Coro::PRIO_MAX); 3126 })->prio (Coro::PRIO_MAX);
2300 }; 3127 };
2301 3128
2302 cfg_load; 3129 reload_config;
2303 db_init; 3130 db_init;
2304 load_extensions; 3131 load_extensions;
2305 3132
2306 $TICK_WATCHER->start; 3133 $TICK_WATCHER->start;
2307 Event::loop; 3134 Event::loop;
2323 }, 3150 },
2324 ); 3151 );
2325 } 3152 }
2326} 3153}
2327 3154
3155sub write_runtime {
3156 my $runtime = "$LOCALDIR/runtime";
3157
3158 # first touch the runtime file to show we are still running:
3159 # the fsync below can take a very very long time.
3160
3161 IO::AIO::aio_utime $runtime, undef, undef;
3162
3163 my $guard = cf::lock_acquire "write_runtime";
3164
3165 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3166 or return;
3167
3168 my $value = $cf::RUNTIME + 90 + 10;
3169 # 10 is the runtime save interval, for a monotonic clock
3170 # 60 allows for the watchdog to kill the server.
3171
3172 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3173 and return;
3174
3175 # always fsync - this file is important
3176 aio_fsync $fh
3177 and return;
3178
3179 # touch it again to show we are up-to-date
3180 aio_utime $fh, undef, undef;
3181
3182 close $fh
3183 or return;
3184
3185 aio_rename "$runtime~", $runtime
3186 and return;
3187
3188 warn "runtime file written.\n";
3189
3190 1
3191}
3192
2328sub emergency_save() { 3193sub emergency_save() {
2329 my $freeze_guard = cf::freeze_mainloop; 3194 my $freeze_guard = cf::freeze_mainloop;
2330 3195
2331 warn "enter emergency perl save\n"; 3196 warn "enter emergency perl save\n";
2332 3197
2363 3228
2364 warn Carp::longmess "post_cleanup backtrace" 3229 warn Carp::longmess "post_cleanup backtrace"
2365 if $make_core; 3230 if $make_core;
2366} 3231}
2367 3232
2368sub reload() { 3233sub do_reload_perl() {
2369 # can/must only be called in main 3234 # can/must only be called in main
2370 if ($Coro::current != $Coro::main) { 3235 if ($Coro::current != $Coro::main) {
2371 warn "can only reload from main coroutine"; 3236 warn "can only reload from main coroutine";
2372 return; 3237 return;
2373 } 3238 }
2374 3239
2375 warn "reloading..."; 3240 warn "reloading...";
2376 3241
2377 warn "cancelling server ticker"; 3242 warn "entering sync_job";
2378 $TICK_WATCHER->cancel;
2379 3243
3244 cf::sync_job {
3245 cf::write_runtime; # external watchdog should not bark
2380 cf::emergency_save; 3246 cf::emergency_save;
3247 cf::write_runtime; # external watchdog should not bark
2381 3248
2382 eval { 3249 warn "syncing database to disk";
3250 BDB::db_env_txn_checkpoint $DB_ENV;
3251
2383 # if anything goes wrong in here, we should simply crash as we already saved 3252 # if anything goes wrong in here, we should simply crash as we already saved
2384 3253
2385 warn "cancelling all WF_AUTOCANCEL watchers"; 3254 warn "cancelling all WF_AUTOCANCEL watchers";
2386 for (Event::all_watchers) { 3255 for (Event::all_watchers) {
2387 $_->cancel if $_->data & WF_AUTOCANCEL; 3256 $_->cancel if $_->data & WF_AUTOCANCEL;
2388 } 3257 }
2389
2390 warn "syncing database to disk";
2391 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
2392 3258
2393 warn "flushing outstanding aio requests"; 3259 warn "flushing outstanding aio requests";
2394 for (;;) { 3260 for (;;) {
2395 BDB::flush; 3261 BDB::flush;
2396 IO::AIO::flush; 3262 IO::AIO::flush;
2397 Coro::cede; 3263 Coro::cede;
2398 last unless IO::AIO::nreqs || BDB::nreqs; 3264 last unless IO::AIO::nreqs || BDB::nreqs;
2399 warn "iterate..."; 3265 warn "iterate...";
2400 } 3266 }
2401 3267
3268 ++$RELOAD;
3269
2402 warn "cancelling all extension coros"; 3270 warn "cancelling all extension coros";
2403 $_->cancel for values %EXT_CORO; 3271 $_->cancel for values %EXT_CORO;
2404 %EXT_CORO = (); 3272 %EXT_CORO = ();
2405 3273
2406 warn "removing commands"; 3274 warn "removing commands";
2407 %COMMAND = (); 3275 %COMMAND = ();
2408 3276
2409 warn "removing ext commands"; 3277 warn "removing ext/exti commands";
2410 %EXTCMD = (); 3278 %EXTCMD = ();
3279 %EXTICMD = ();
2411 3280
2412 warn "unloading/nuking all extensions"; 3281 warn "unloading/nuking all extensions";
2413 for my $pkg (@EXTS) { 3282 for my $pkg (@EXTS) {
2414 warn "... unloading $pkg"; 3283 warn "... unloading $pkg";
2415 3284
2445 Symbol::delete_package "safe::$_" 3314 Symbol::delete_package "safe::$_"
2446 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3315 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2447 3316
2448 warn "unloading cf.pm \"a bit\""; 3317 warn "unloading cf.pm \"a bit\"";
2449 delete $INC{"cf.pm"}; 3318 delete $INC{"cf.pm"};
3319 delete $INC{"cf/pod.pm"};
2450 3320
2451 # don't, removes xs symbols, too, 3321 # don't, removes xs symbols, too,
2452 # and global variables created in xs 3322 # and global variables created in xs
2453 #Symbol::delete_package __PACKAGE__; 3323 #Symbol::delete_package __PACKAGE__;
2454 3324
2457 warn "reloading cf.pm"; 3327 warn "reloading cf.pm";
2458 require cf; 3328 require cf;
2459 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3329 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2460 3330
2461 warn "loading config and database again"; 3331 warn "loading config and database again";
2462 cf::cfg_load; 3332 cf::reload_config;
2463 3333
2464 warn "loading extensions"; 3334 warn "loading extensions";
2465 cf::load_extensions; 3335 cf::load_extensions;
2466 3336
2467 warn "reattaching attachments to objects/players"; 3337 warn "reattaching attachments to objects/players";
2468 _global_reattach; 3338 _global_reattach; # objects, sockets
2469 warn "reattaching attachments to maps"; 3339 warn "reattaching attachments to maps";
2470 reattach $_ for values %MAP; 3340 reattach $_ for values %MAP;
3341 warn "reattaching attachments to players";
3342 reattach $_ for values %PLAYER;
2471 3343
2472 warn "loading reloadable resources"; 3344 warn "leaving sync_job";
2473 load_resources;
2474 3345
2475 warn "restarting server ticker"; 3346 1
2476 3347 } or do {
2477 $TICK_WATCHER->start;
2478 };
2479
2480 if ($@) {
2481 warn $@; 3348 warn $@;
2482 warn "error while reloading, exiting."; 3349 warn "error while reloading, exiting.";
2483 exit 1; 3350 exit 1;
2484 } 3351 };
2485 3352
2486 warn "reloaded"; 3353 warn "reloaded";
2487}; 3354};
2488 3355
2489our $RELOAD_WATCHER; # used only during reload 3356our $RELOAD_WATCHER; # used only during reload
2490 3357
3358sub reload_perl() {
3359 # doing reload synchronously and two reloads happen back-to-back,
3360 # coro crashes during coro_state_free->destroy here.
3361
3362 $RELOAD_WATCHER ||= Event->timer (
3363 reentrant => 0,
3364 after => 0,
3365 data => WF_AUTOCANCEL,
3366 cb => sub {
3367 do_reload_perl;
3368 undef $RELOAD_WATCHER;
3369 },
3370 );
3371}
3372
2491register_command "reload" => sub { 3373register_command "reload" => sub {
2492 my ($who, $arg) = @_; 3374 my ($who, $arg) = @_;
2493 3375
2494 if ($who->flag (FLAG_WIZ)) { 3376 if ($who->flag (FLAG_WIZ)) {
2495 $who->message ("reloading server."); 3377 $who->message ("reloading server.");
2496 3378 async { reload_perl };
2497 # doing reload synchronously and two reloads happen back-to-back,
2498 # coro crashes during coro_state_free->destroy here.
2499
2500 $RELOAD_WATCHER ||= Event->timer (
2501 reentrant => 0,
2502 after => 0,
2503 data => WF_AUTOCANCEL,
2504 cb => sub {
2505 reload;
2506 undef $RELOAD_WATCHER;
2507 },
2508 );
2509 } 3379 }
2510}; 3380};
2511 3381
2512unshift @INC, $LIBDIR; 3382unshift @INC, $LIBDIR;
2513 3383
2514my $bug_warning = 0; 3384my $bug_warning = 0;
2515 3385
3386our @WAIT_FOR_TICK;
3387our @WAIT_FOR_TICK_BEGIN;
3388
3389sub wait_for_tick {
3390 return unless $TICK_WATCHER->is_active;
3391 return if $Coro::current == $Coro::main;
3392
3393 my $signal = new Coro::Signal;
3394 push @WAIT_FOR_TICK, $signal;
3395 $signal->wait;
3396}
3397
3398sub wait_for_tick_begin {
3399 return unless $TICK_WATCHER->is_active;
3400 return if $Coro::current == $Coro::main;
3401
3402 my $signal = new Coro::Signal;
3403 push @WAIT_FOR_TICK_BEGIN, $signal;
3404 $signal->wait;
3405}
3406
3407 my $min = 1e6;#d#
3408 my $avg = 10;
2516$TICK_WATCHER = Event->timer ( 3409$TICK_WATCHER = Event->timer (
2517 reentrant => 0, 3410 reentrant => 0,
2518 parked => 1, 3411 parked => 1,
2519 prio => 0, 3412 prio => 0,
2520 at => $NEXT_TICK || $TICK, 3413 at => $NEXT_TICK || $TICK,
2524 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3417 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2525 unless ++$bug_warning > 10; 3418 unless ++$bug_warning > 10;
2526 return; 3419 return;
2527 } 3420 }
2528 3421
2529 $NOW = Event::time; 3422 $NOW = $tick_start = Event::time;
2530 3423
2531 cf::server_tick; # one server iteration 3424 cf::server_tick; # one server iteration
3425
3426 0 && sync_job {#d#
3427 for(1..10) {
3428 my $t = Event::time;
3429 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3430 or die;
3431
3432 $map->width (50);
3433 $map->height (50);
3434 $map->alloc;
3435 $map->_load_objects ("/tmp/x.map", 1); #TODO: does not work
3436 my $t = Event::time - $t;
3437
3438 #next unless $t < 0.0013;#d#
3439 if ($t < $min) {
3440 $min = $t;
3441 }
3442 $avg = $avg * 0.99 + $t * 0.01;
3443 }
3444 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3445 exit 0;
3446 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3447 };
3448
2532 $RUNTIME += $TICK; 3449 $RUNTIME += $TICK;
2533 $NEXT_TICK += $TICK; 3450 $NEXT_TICK += $TICK;
2534 3451
2535 $WAIT_FOR_TICK->broadcast; 3452 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2536 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3453 $NEXT_RUNTIME_WRITE = $NOW + 10;
2537 3454 Coro::async_pool {
2538 Event::sweep; 3455 write_runtime
2539 Coro::cede_notself; 3456 or warn "ERROR: unable to write runtime file: $!";
3457 };
2540 3458 }
3459
2541# my $AFTER = Event::time; 3460# my $AFTER = Event::time;
2542# warn $AFTER - $NOW;#d# 3461# warn $AFTER - $NOW;#d#
2543 3462
3463 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3464 $sig->send;
3465 }
3466 while (my $sig = shift @WAIT_FOR_TICK) {
3467 $sig->send;
3468 }
3469
3470 $NOW = Event::time;
3471
2544 # if we are delayed by four ticks or more, skip them all 3472 # if we are delayed by four ticks or more, skip them all
2545 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3473 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2546 3474
2547 $TICK_WATCHER->at ($NEXT_TICK); 3475 $TICK_WATCHER->at ($NEXT_TICK);
2548 $TICK_WATCHER->start; 3476 $TICK_WATCHER->start;
3477
3478 $LOAD = ($NOW - $tick_start) / $TICK;
3479 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3480
3481 _post_tick;
3482
3483
2549 }, 3484 },
2550); 3485);
2551 3486
2552{ 3487{
2553 BDB::max_poll_time $TICK * 0.1; 3488 BDB::max_poll_time $TICK * 0.1;
2581 3516
2582 cf::sync_job { 3517 cf::sync_job {
2583 eval { 3518 eval {
2584 BDB::db_env_open 3519 BDB::db_env_open
2585 $DB_ENV, 3520 $DB_ENV,
2586 $BDB_ENV_DIR, 3521 $BDBDIR,
2587 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3522 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2588 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3523 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2589 0666; 3524 0666;
2590 3525
2591 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3526 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2592 3527
2593 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3528 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2594 $DB_ENV->set_lk_detect; 3529 $DB_ENV->set_lk_detect;
2595 }; 3530 };
2596 3531
2604 3539
2605 undef $Coro::AIO::WATCHER; 3540 undef $Coro::AIO::WATCHER;
2606 IO::AIO::max_poll_time $TICK * 0.1; 3541 IO::AIO::max_poll_time $TICK * 0.1;
2607 $AIO_POLL_WATCHER = Event->io ( 3542 $AIO_POLL_WATCHER = Event->io (
2608 reentrant => 0, 3543 reentrant => 0,
3544 data => WF_AUTOCANCEL,
2609 fd => IO::AIO::poll_fileno, 3545 fd => IO::AIO::poll_fileno,
2610 poll => 'r', 3546 poll => 'r',
2611 prio => 6, 3547 prio => 6,
2612 data => WF_AUTOCANCEL,
2613 cb => \&IO::AIO::poll_cb, 3548 cb => \&IO::AIO::poll_cb,
2614 ); 3549 );
2615} 3550}
2616 3551
2617$WRITE_RUNTIME_WATCHER = Event->timer ( 3552my $_log_backtrace;
2618 reentrant => 0, 3553
2619 data => WF_AUTOCANCEL, 3554sub _log_backtrace {
2620 after => 1, 3555 my ($msg, @addr) = @_;
2621 interval => 10, 3556
2622 prio => 6, # keep it lowest so it acts like a watchdog 3557 $msg =~ s/\n//;
2623 cb => Coro::unblock_sub { 3558
2624 write_runtime 3559 # limit the # of concurrent backtraces
2625 or warn "ERROR: unable to write runtime file: $!"; 3560 if ($_log_backtrace < 2) {
3561 ++$_log_backtrace;
3562 async {
3563 my @bt = fork_call {
3564 @addr = map { sprintf "%x", $_ } @addr;
3565 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3566 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3567 or die "addr2line: $!";
3568
3569 my @funcs;
3570 my @res = <$fh>;
3571 chomp for @res;
3572 while (@res) {
3573 my ($func, $line) = splice @res, 0, 2, ();
3574 push @funcs, "[$func] $line";
3575 }
3576
3577 @funcs
3578 };
3579
3580 LOG llevInfo, "[ABT] $msg\n";
3581 LOG llevInfo, "[ABT] $_\n" for @bt;
3582 --$_log_backtrace;
3583 };
3584 } else {
3585 LOG llevInfo, "[ABT] $msg\n";
3586 LOG llevInfo, "[ABT] [suppressed]\n";
2626 }, 3587 }
2627); 3588}
3589
3590# load additional modules
3591use cf::pod;
2628 3592
2629END { cf::emergency_save } 3593END { cf::emergency_save }
2630 3594
26311 35951
2632 3596

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines