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.200 by root, Mon Jan 29 17:57:22 2007 UTC vs.
Revision 1.347 by root, Thu Aug 30 05:16:09 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 ();
27use BDB ();
20use Data::Dumper; 28use Data::Dumper;
21use Digest::MD5; 29use Digest::MD5;
22use Fcntl; 30use Fcntl;
31use YAML::Syck ();
23use IO::AIO 2.32 (); 32use IO::AIO 2.32 ();
24use YAML::Syck ();
25use Time::HiRes; 33use Time::HiRes;
34use Compress::LZF;
35use Digest::MD5 ();
26 36
37# configure various modules to our taste
38#
39$Storable::canonical = 1; # reduce rsync transfers
40Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
41Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
42
27use 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
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
30 44
31# 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?
32$YAML::Syck::ImplicitUnicode = 1; 46$YAML::Syck::ImplicitUnicode = 1;
33 47
34$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
35 49
50sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
51
36our %COMMAND = (); 52our %COMMAND = ();
37our %COMMAND_TIME = (); 53our %COMMAND_TIME = ();
38 54
39our @EXTS = (); # list of extension package names 55our @EXTS = (); # list of extension package names
40our %EXTCMD = (); 56our %EXTCMD = ();
57our %EXTICMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions 58our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps 59our %EXT_MAP = (); # pluggable maps
43 60
61our $RELOAD; # number of reloads so far
44our @EVENT; 62our @EVENT;
45our $LIBDIR = datadir . "/ext";
46 63
47our $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(!)
48our $TICK_WATCHER; 77our $TICK_WATCHER;
49our $AIO_POLL_WATCHER; 78our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER; 79our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
51our $NEXT_TICK; 80our $NEXT_TICK;
52our $NOW; 81our $NOW;
82our $USE_FSYNC = 1; # use fsync to write maps - default off
83
84our $BDB_POLL_WATCHER;
85our $DB_ENV;
53 86
54our %CFG; 87our %CFG;
55 88
56our $UPTIME; $UPTIME ||= time; 89our $UPTIME; $UPTIME ||= time;
57our $RUNTIME; 90our $RUNTIME;
58 91
59our %PLAYER; # all users 92our %PLAYER; # all users
60our %MAP; # all maps 93our %MAP; # all maps
61our $LINK_MAP; # the special {link} map, which is always available 94our $LINK_MAP; # the special {link} map, which is always available
62our $RANDOM_MAPS = cf::localdir . "/random";
63
64our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
65our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
66 95
67# 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 ∕
68our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 97our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
69 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
70binmode STDOUT; 103binmode STDOUT;
71binmode STDERR; 104binmode STDERR;
72 105
73# read virtual server time, if available 106# read virtual server time, if available
74unless ($RUNTIME || !-e cf::localdir . "/runtime") { 107unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
75 open my $fh, "<", cf::localdir . "/runtime" 108 open my $fh, "<", "$LOCALDIR/runtime"
76 or die "unable to read runtime file: $!"; 109 or die "unable to read runtime file: $!";
77 $RUNTIME = <$fh> + 0.; 110 $RUNTIME = <$fh> + 0.;
78} 111}
79 112
80mkdir cf::localdir; 113mkdir $_
81mkdir cf::localdir . "/" . cf::playerdir; 114 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
82mkdir cf::localdir . "/" . cf::tmpdir;
83mkdir cf::localdir . "/" . cf::uniquedir;
84mkdir $RANDOM_MAPS;
85 115
86our $EMERGENCY_POSITION; 116our $EMERGENCY_POSITION;
87 117
88sub cf::map::normalise; 118sub cf::map::normalise;
89 119
100=item $cf::RUNTIME 130=item $cf::RUNTIME
101 131
102The 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
103every server tick. 133every server tick.
104 134
105=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
106 138
107The perl library directory, where extensions and cf-specific modules can 139Various directories - "/etc", read-only install directory, perl-library
108be 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.
109 143
110=item $cf::NOW 144=item $cf::NOW
111 145
112The time of the last (current) server tick. 146The time of the last (current) server tick.
113 147
114=item $cf::TICK 148=item $cf::TICK
115 149
116The 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.
117 161
118=item %cf::CFG 162=item %cf::CFG
119 163
120Configuration for the server, loaded from C</etc/crossfire/config>, or 164Configuration for the server, loaded from C</etc/crossfire/config>, or
121from wherever your confdir points to. 165from wherever your confdir points to.
122 166
123=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 167=item cf::wait_for_tick, cf::wait_for_tick_begin
124 168
125These 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
126or 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
127processing 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.
128window 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.
129 178
130=back 179=back
131 180
132=cut 181=cut
133 182
134BEGIN { 183BEGIN {
135 *CORE::GLOBAL::warn = sub { 184 *CORE::GLOBAL::warn = sub {
136 my $msg = join "", @_; 185 my $msg = join "", @_;
137 utf8::encode $msg;
138 186
139 $msg .= "\n" 187 $msg .= "\n"
140 unless $msg =~ /\n$/; 188 unless $msg =~ /\n$/;
141 189
190 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
191
192 utf8::encode $msg;
142 LOG llevError, $msg; 193 LOG llevError, $msg;
143 }; 194 };
144} 195}
145 196
146@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 197@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
147@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 198@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
148@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 199@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
149@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 200@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
150@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';
151@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)
152 204
153# 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
154# within the Safe compartment. 206# within the Safe compartment.
155for my $pkg (qw( 207for my $pkg (qw(
156 cf::global cf::attachable 208 cf::global cf::attachable
164} 216}
165 217
166$Event::DIED = sub { 218$Event::DIED = sub {
167 warn "error in event callback: @_"; 219 warn "error in event callback: @_";
168}; 220};
221
222#############################################################################
169 223
170=head2 UTILITY FUNCTIONS 224=head2 UTILITY FUNCTIONS
171 225
172=over 4 226=over 4
173 227
192 $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;
193 $d 247 $d
194 } || "[unable to dump $_[0]: '$@']"; 248 } || "[unable to dump $_[0]: '$@']";
195} 249}
196 250
197use JSON::Syck (); # TODO# replace by JSON::PC once working
198
199=item $ref = cf::from_json $json 251=item $ref = cf::from_json $json
200 252
201Converts a JSON string into the corresponding perl data structure. 253Converts a JSON string into the corresponding perl data structure.
202 254
203=cut
204
205sub from_json($) {
206 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
207 JSON::Syck::Load $_[0]
208}
209
210=item $json = cf::to_json $ref 255=item $json = cf::to_json $ref
211 256
212Converts a perl data structure into its JSON representation. 257Converts a perl data structure into its JSON representation.
213 258
214=cut 259=cut
215 260
216sub to_json($) { 261our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
217 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 262
218 JSON::Syck::Dump $_[0] 263sub to_json ($) { $json_coder->encode ($_[0]) }
219} 264sub from_json ($) { $json_coder->decode ($_[0]) }
220 265
221=item cf::lock_wait $string 266=item cf::lock_wait $string
222 267
223Wait until the given lock is available. See cf::lock_acquire. 268Wait until the given lock is available. See cf::lock_acquire.
224 269
227Wait 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
228a 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,
229for example when the coroutine gets canceled), the lock is automatically 274for example when the coroutine gets canceled), the lock is automatically
230returned. 275returned.
231 276
277Locks are *not* recursive, locking from the same coro twice results in a
278deadlocked coro.
279
232Lock 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
233uses 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.
234 286
235=cut 287=cut
236 288
237our %LOCK; 289our %LOCK;
238 290
258 # wake up all waiters, to be on the safe side 310 # wake up all waiters, to be on the safe side
259 $_->ready for @{ delete $LOCK{$key} }; 311 $_->ready for @{ delete $LOCK{$key} };
260 } 312 }
261} 313}
262 314
315sub lock_active($) {
316 my ($key) = @_;
317
318 ! ! $LOCK{$key}
319}
320
263sub freeze_mainloop { 321sub freeze_mainloop {
264 return unless $TICK_WATCHER->is_active; 322 return unless $TICK_WATCHER->is_active;
265 323
266 my $guard = Coro::guard { 324 my $guard = Coro::guard {
267 $TICK_WATCHER->start; 325 $TICK_WATCHER->start;
268 $WRITE_RUNTIME_WATCHER->start;
269 }; 326 };
270 $WRITE_RUNTIME_WATCHER->stop;
271 $TICK_WATCHER->stop; 327 $TICK_WATCHER->stop;
272 $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;
273} 385}
274 386
275=item cf::async { BLOCK } 387=item cf::async { BLOCK }
276 388
277Currently the same as Coro::async_pool, meaning you cannot use 389Currently the same as Coro::async_pool, meaning you cannot use
282 394
283BEGIN { *async = \&Coro::async_pool } 395BEGIN { *async = \&Coro::async_pool }
284 396
285=item cf::sync_job { BLOCK } 397=item cf::sync_job { BLOCK }
286 398
287The design of crossfire+ requires that the main coro ($Coro::main) is 399The design of Crossfire TRT requires that the main coroutine ($Coro::main)
288always able to handle events or runnable, as crossfire+ is only partly 400is always able to handle events or runnable, as Crossfire TRT is only
289reentrant. 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.
290 403
291If 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
292the given BLOCK in another coroutine while waiting for the result. The 405the given BLOCK in another coroutine while waiting for the result. The
293server 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
294fast or be very important. 407fast or be very important.
297 410
298sub sync_job(&) { 411sub sync_job(&) {
299 my ($job) = @_; 412 my ($job) = @_;
300 413
301 if ($Coro::current == $Coro::main) { 414 if ($Coro::current == $Coro::main) {
415 my $time = Event::time;
416
302 # this is the main coro, too bad, we have to block 417 # this is the main coro, too bad, we have to block
303 # till the operation succeeds, freezing the server :/ 418 # till the operation succeeds, freezing the server :/
304 419
305 # TODO: use suspend/resume instead 420 # TODO: use suspend/resume instead
306 # (but this is cancel-safe) 421 # (but this is cancel-safe)
317 432
318 while ($busy) { 433 while ($busy) {
319 Coro::cede or Event::one_event; 434 Coro::cede or Event::one_event;
320 } 435 }
321 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
322 wantarray ? @res : $res[0] 444 wantarray ? @res : $res[0]
323 } else { 445 } else {
324 # we are in another coroutine, how wonderful, everything just works 446 # we are in another coroutine, how wonderful, everything just works
325 447
326 $job->() 448 $job->()
345 $EXT_CORO{$coro+0} = $coro; 467 $EXT_CORO{$coro+0} = $coro;
346 468
347 $coro 469 $coro
348} 470}
349 471
350sub write_runtime { 472=item fork_call { }, $args
351 my $runtime = cf::localdir . "/runtime";
352 473
353 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 474Executes the given code block with the given arguments in a seperate
354 or return; 475process, returning the results. Everything must be serialisable with
476Coro::Storable. May, of course, block. Note that the executed sub may
477never block itself or use any form of Event handling.
355 478
356 my $value = $cf::RUNTIME + 90 + 10; 479=cut
357 # 10 is the runtime save interval, for a monotonic clock
358 # 60 allows for the watchdog to kill the server.
359 480
360 (aio_write $fh, 0, (length $value), $value, 0) <= 0 481sub fork_call(&@) {
361 and return; 482 my ($cb, @args) = @_;
362 483
363 aio_fsync $fh 484 # we seemingly have to make a local copy of the whole thing,
364 and return; 485 # otherwise perl prematurely frees the stuff :/
486 # TODO: investigate and fix (liekly this will be rather laborious)
365 487
366 close $fh 488 my @res = Coro::Util::fork_eval {
367 or return; 489 reset_signals;
490 &$cb
491 }, @args;
368 492
369 aio_rename "$runtime~", $runtime 493 wantarray ? @res : $res[-1]
370 and return; 494}
371 495
496=item $value = cf::db_get $family => $key
497
498Returns a single value from the environment database.
499
500=item cf::db_put $family => $key => $value
501
502Stores the given C<$value> in the family. It can currently store binary
503data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
504
505=cut
506
507our $DB;
508
509sub db_init {
510 unless ($DB) {
511 $DB = BDB::db_create $DB_ENV;
512
513 cf::sync_job {
514 eval {
515 $DB->set_flags (BDB::CHKSUM);
516
517 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
518 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
519 cf::cleanup "db_open(db): $!" if $!;
520 };
521 cf::cleanup "db_open(db): $@" if $@;
522 };
372 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 });
373} 621}
374 622
375=back 623=back
376 624
377=cut 625=cut
384attach callbacks/event handlers (a collection of which is called an "attachment") 632attach callbacks/event handlers (a collection of which is called an "attachment")
385to it. All such attachable objects support the following methods. 633to it. All such attachable objects support the following methods.
386 634
387In 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>
388C<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
389crossfire+). 637Crossfire TRT).
390 638
391=over 4 639=over 4
392 640
393=item $attachable->attach ($attachment, key => $value...) 641=item $attachable->attach ($attachment, key => $value...)
394 642
557 $registry = $CB_TYPE[$object_type] ||= []; 805 $registry = $CB_TYPE[$object_type] ||= [];
558 806
559 } elsif ($type eq "subtype") { 807 } elsif ($type eq "subtype") {
560 defined $object_type or Carp::croak "subtype specified without type"; 808 defined $object_type or Carp::croak "subtype specified without type";
561 my $object_subtype = shift @arg; 809 my $object_subtype = shift @arg;
562 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 810 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
563 811
564 } elsif ($type eq "package") { 812 } elsif ($type eq "package") {
565 my $pkg = shift @arg; 813 my $pkg = shift @arg;
566 814
567 while (my ($name, $id) = each %cb_id) { 815 while (my ($name, $id) = each %cb_id) {
596 _attach $registry, $klass, @attach; 844 _attach $registry, $klass, @attach;
597 } 845 }
598 846
599 $obj->{$name} = \%arg; 847 $obj->{$name} = \%arg;
600 } else { 848 } else {
601 warn "object uses attachment '$name' that is not available, postponing.\n"; 849 warn "object uses attachment '$name' which is not available, postponing.\n";
602 } 850 }
603 851
604 $obj->{_attachment}{$name} = undef; 852 $obj->{_attachment}{$name} = undef;
605} 853}
606 854
608 if (ref $_[0]) { 856 if (ref $_[0]) {
609 _object_attach @_; 857 _object_attach @_;
610 } else { 858 } else {
611 _attach shift->_attach_registry, @_; 859 _attach shift->_attach_registry, @_;
612 } 860 }
861 _recalc_want;
613}; 862};
614 863
615# all those should be optimised 864# all those should be optimised
616sub cf::attachable::detach { 865sub cf::attachable::detach {
617 my ($obj, $name) = @_; 866 my ($obj, $name) = @_;
620 delete $obj->{_attachment}{$name}; 869 delete $obj->{_attachment}{$name};
621 reattach ($obj); 870 reattach ($obj);
622 } else { 871 } else {
623 Carp::croak "cannot, currently, detach class attachments"; 872 Carp::croak "cannot, currently, detach class attachments";
624 } 873 }
874 _recalc_want;
625}; 875};
626 876
627sub cf::attachable::attached { 877sub cf::attachable::attached {
628 my ($obj, $name) = @_; 878 my ($obj, $name) = @_;
629 879
644 "; 894 ";
645 die if $@; 895 die if $@;
646} 896}
647 897
648our $override; 898our $override;
649our @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?
650 900
651sub override { 901sub override {
652 $override = 1; 902 $override = 1;
653 @invoke_results = (); 903 @INVOKE_RESULTS = (@_);
654} 904}
655 905
656sub do_invoke { 906sub do_invoke {
657 my $event = shift; 907 my $event = shift;
658 my $callbacks = shift; 908 my $callbacks = shift;
659 909
660 @invoke_results = (); 910 @INVOKE_RESULTS = ();
661 911
662 local $override; 912 local $override;
663 913
664 for (@$callbacks) { 914 for (@$callbacks) {
665 eval { &{$_->[1]} }; 915 eval { &{$_->[1]} };
682 932
683Generate an object-specific event with the given arguments. 933Generate an object-specific event with the given arguments.
684 934
685This 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
686removed 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
687results (if you must, access C<@cf::invoke_results> directly). 937results (if you must, access C<@cf::INVOKE_RESULTS> directly).
688 938
689=back 939=back
690 940
691=cut 941=cut
692 942
693############################################################################# 943#############################################################################
694# 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}
695 956
696sub reattach { 957sub reattach {
697 # basically do the same as instantiate, without calling instantiate 958 # basically do the same as instantiate, without calling instantiate
698 my ($obj) = @_; 959 my ($obj) = @_;
699 960
752 $filename, length $$rdata, scalar @$objs; 1013 $filename, length $$rdata, scalar @$objs;
753 1014
754 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1015 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
755 chmod SAVE_MODE, $fh; 1016 chmod SAVE_MODE, $fh;
756 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1017 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
757 aio_fsync $fh; 1018 aio_fsync $fh if $cf::USE_FSYNC;
758 close $fh; 1019 close $fh;
759 1020
760 if (@$objs) { 1021 if (@$objs) {
761 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1022 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
762 chmod SAVE_MODE, $fh; 1023 chmod SAVE_MODE, $fh;
763 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1024 my $data = Storable::nfreeze { version => 1, objs => $objs };
764 aio_write $fh, 0, (length $data), $data, 0; 1025 aio_write $fh, 0, (length $data), $data, 0;
765 aio_fsync $fh; 1026 aio_fsync $fh if $cf::USE_FSYNC;
766 close $fh; 1027 close $fh;
767 aio_rename "$filename.pst~", "$filename.pst"; 1028 aio_rename "$filename.pst~", "$filename.pst";
768 } 1029 }
769 } else { 1030 } else {
770 aio_unlink "$filename.pst"; 1031 aio_unlink "$filename.pst";
776 } 1037 }
777 } else { 1038 } else {
778 aio_unlink $filename; 1039 aio_unlink $filename;
779 aio_unlink "$filename.pst"; 1040 aio_unlink "$filename.pst";
780 } 1041 }
781
782 #d##TODO# nuke non .map-files if exist
783 if ($filename =~ s/\.map$//) {
784 aio_unlink $filename;
785 aio_unlink "$filename.pst";
786 }
787 } 1042 }
788} 1043}
789 1044
790sub object_freezer_as_string { 1045sub object_freezer_as_string {
791 my ($rdata, $objs) = @_; 1046 my ($rdata, $objs) = @_;
797 1052
798sub object_thawer_load { 1053sub object_thawer_load {
799 my ($filename) = @_; 1054 my ($filename) = @_;
800 1055
801 my ($data, $av); 1056 my ($data, $av);
802
803 #d#TODO remove .map if file does not exist
804 aio_stat $filename and $filename =~ s/\.map$//;
805 1057
806 (aio_load $filename, $data) >= 0 1058 (aio_load $filename, $data) >= 0
807 or return; 1059 or return;
808 1060
809 unless (aio_stat "$filename.pst") { 1061 unless (aio_stat "$filename.pst") {
811 or return; 1063 or return;
812 $av = eval { (Storable::thaw $av)->{objs} }; 1064 $av = eval { (Storable::thaw $av)->{objs} };
813 } 1065 }
814 1066
815 warn sprintf "loading %s (%d)\n", 1067 warn sprintf "loading %s (%d)\n",
816 $filename, length $data, scalar @{$av || []};#d# 1068 $filename, length $data, scalar @{$av || []};
817 return ($data, $av); 1069 return ($data, $av);
818} 1070}
1071
1072=head2 COMMAND CALLBACKS
1073
1074=over 4
1075
1076=cut
819 1077
820############################################################################# 1078#############################################################################
821# command handling &c 1079# command handling &c
822 1080
823=item cf::register_command $name => \&callback($ob,$args); 1081=item cf::register_command $name => \&callback($ob,$args);
836 push @{ $COMMAND{$name} }, [$caller, $cb]; 1094 push @{ $COMMAND{$name} }, [$caller, $cb];
837} 1095}
838 1096
839=item cf::register_extcmd $name => \&callback($pl,$packet); 1097=item cf::register_extcmd $name => \&callback($pl,$packet);
840 1098
841Register a callbackf ro execution when the client sends an extcmd packet. 1099Register a callback for execution when the client sends an (synchronous)
1100extcmd packet. Ext commands will be processed in the order they are
1101received by the server, like other user commands. The first argument is
1102the logged-in player. Ext commands can only be processed after a player
1103has logged in successfully.
842 1104
843If the callback returns something, it is sent back as if reply was being 1105If the callback returns something, it is sent back as if reply was being
844called. 1106called.
845 1107
1108=item cf::register_exticmd $name => \&callback($ns,$packet);
1109
1110Register a callback for execution when the client sends an (asynchronous)
1111exticmd packet. Exti commands are processed by the server as soon as they
1112are received, i.e. out of order w.r.t. other commands. The first argument
1113is a client socket. Exti commands can be received anytime, even before
1114log-in.
1115
1116If the callback returns something, it is sent back as if reply was being
1117called.
1118
846=cut 1119=cut
847 1120
848sub register_extcmd { 1121sub register_extcmd {
849 my ($name, $cb) = @_; 1122 my ($name, $cb) = @_;
850 1123
851 $EXTCMD{$name} = $cb; 1124 $EXTCMD{$name} = $cb;
1125}
1126
1127sub register_exticmd {
1128 my ($name, $cb) = @_;
1129
1130 $EXTICMD{$name} = $cb;
852} 1131}
853 1132
854cf::player->attach ( 1133cf::player->attach (
855 on_command => sub { 1134 on_command => sub {
856 my ($pl, $name, $params) = @_; 1135 my ($pl, $name, $params) = @_;
865 cf::override; 1144 cf::override;
866 }, 1145 },
867 on_extcmd => sub { 1146 on_extcmd => sub {
868 my ($pl, $buf) = @_; 1147 my ($pl, $buf) = @_;
869 1148
870 my $msg = eval { from_json $buf }; 1149 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
871 1150
872 if (ref $msg) { 1151 if (ref $msg) {
1152 my ($type, $reply, @payload) =
1153 "ARRAY" eq ref $msg
1154 ? @$msg
1155 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1156
1157 my @reply;
1158
873 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1159 if (my $cb = $EXTCMD{$type}) {
874 if (my %reply = $cb->($pl, $msg)) { 1160 @reply = $cb->($pl, @payload);
875 $pl->ext_reply ($msg->{msgid}, %reply);
876 }
877 } 1161 }
1162
1163 $pl->ext_reply ($reply, @reply)
1164 if $reply;
1165
878 } else { 1166 } else {
879 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1167 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
880 } 1168 }
881 1169
882 cf::override; 1170 cf::override;
883 }, 1171 },
884); 1172);
885 1173
886sub load_extension {
887 my ($path) = @_;
888
889 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
890 my $base = $1;
891 my $pkg = $1;
892 $pkg =~ s/[^[:word:]]/_/g;
893 $pkg = "ext::$pkg";
894
895 warn "... loading '$path' into '$pkg'\n";
896
897 open my $fh, "<:utf8", $path
898 or die "$path: $!";
899
900 my $source =
901 "package $pkg; use strict; use utf8;\n"
902 . "#line 1 \"$path\"\n{\n"
903 . (do { local $/; <$fh> })
904 . "\n};\n1";
905
906 unless (eval $source) {
907 my $msg = $@ ? "$path: $@\n"
908 : "extension disabled.\n";
909 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
910 warn $@;
911 warn "mandatory extension failed to load, exiting.\n";
912 exit 1;
913 }
914 die $@;
915 }
916
917 push @EXTS, $pkg;
918}
919
920sub load_extensions { 1174sub load_extensions {
1175 cf::sync_job {
1176 my %todo;
1177
921 for my $ext (<$LIBDIR/*.ext>) { 1178 for my $path (<$LIBDIR/*.ext>) {
922 next unless -r $ext; 1179 next unless -r $path;
923 eval { 1180
924 load_extension $ext; 1181 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1182 my $base = $1;
1183 my $pkg = $1;
1184 $pkg =~ s/[^[:word:]]/_/g;
1185 $pkg = "ext::$pkg";
1186
1187 open my $fh, "<:utf8", $path
1188 or die "$path: $!";
1189
1190 my $source = do { local $/; <$fh> };
1191
1192 my %ext = (
1193 path => $path,
1194 base => $base,
1195 pkg => $pkg,
1196 );
1197
1198 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1199 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1200
1201 $ext{source} =
1202 "package $pkg; use strict; use utf8;\n"
1203 . "#line 1 \"$path\"\n{\n"
1204 . $source
1205 . "\n};\n1";
1206
1207 $todo{$base} = \%ext;
1208 }
1209
1210 my %done;
1211 while (%todo) {
1212 my $progress;
1213
1214 while (my ($k, $v) = each %todo) {
1215 for (split /,\s*/, $v->{meta}{depends}) {
1216 goto skip
1217 unless exists $done{$_};
1218 }
1219
1220 warn "... loading '$k' into '$v->{pkg}'\n";
1221
1222 unless (eval $v->{source}) {
1223 my $msg = $@ ? "$v->{path}: $@\n"
1224 : "$v->{base}: extension inactive.\n";
1225
1226 if (exists $v->{meta}{mandatory}) {
1227 warn $msg;
1228 warn "mandatory extension failed to load, exiting.\n";
1229 exit 1;
1230 }
1231
1232 warn $msg;
1233 }
1234
1235 $done{$k} = delete $todo{$k};
1236 push @EXTS, $v->{pkg};
1237 $progress = 1;
925 1 1238 }
926 } or warn "$ext not loaded: $@"; 1239
1240 skip:
1241 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1242 unless $progress;
1243 }
927 } 1244 };
928} 1245}
929 1246
930############################################################################# 1247#############################################################################
931 1248
1249=back
1250
932=head2 CORE EXTENSIONS 1251=head2 CORE EXTENSIONS
933 1252
934Functions and methods that extend core crossfire objects. 1253Functions and methods that extend core crossfire objects.
935 1254
936=cut 1255=cut
948Returns the given player object, loading it if necessary (might block). 1267Returns the given player object, loading it if necessary (might block).
949 1268
950=cut 1269=cut
951 1270
952sub playerdir($) { 1271sub playerdir($) {
953 cf::localdir 1272 "$PLAYERDIR/"
954 . "/"
955 . cf::playerdir
956 . "/"
957 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1273 . (ref $_[0] ? $_[0]->ob->name : $_[0])
958} 1274}
959 1275
960sub path($) { 1276sub path($) {
961 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1277 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
962 1278
963 (playerdir $login) . "/$login.pl" 1279 (playerdir $login) . "/playerdata"
964} 1280}
965 1281
966sub find_active($) { 1282sub find_active($) {
967 $cf::PLAYER{$_[0]} 1283 $cf::PLAYER{$_[0]}
968 and $cf::PLAYER{$_[0]}->active 1284 and $cf::PLAYER{$_[0]}->active
981 my $login = $_[0]; 1297 my $login = $_[0];
982 1298
983 my $guard = cf::lock_acquire "user_find:$login"; 1299 my $guard = cf::lock_acquire "user_find:$login";
984 1300
985 $cf::PLAYER{$_[0]} || do { 1301 $cf::PLAYER{$_[0]} || do {
1302 # rename old playerfiles to new ones
1303 #TODO: remove when no longer required
1304 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1305 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1306 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1307 aio_unlink +(playerdir $login) . "/$login.pl";
1308
986 my $pl = load_pl path $login 1309 my $pl = load_pl path $login
987 or return; 1310 or return;
988 $cf::PLAYER{$login} = $pl 1311 $cf::PLAYER{$login} = $pl
989 } 1312 }
990 } 1313 }
1002 1325
1003 aio_mkdir playerdir $pl, 0770; 1326 aio_mkdir playerdir $pl, 0770;
1004 $pl->{last_save} = $cf::RUNTIME; 1327 $pl->{last_save} = $cf::RUNTIME;
1005 1328
1006 $pl->save_pl ($path); 1329 $pl->save_pl ($path);
1007 Coro::cede; 1330 cf::cede_to_tick;
1008} 1331}
1009 1332
1010sub new($) { 1333sub new($) {
1011 my ($login) = @_; 1334 my ($login) = @_;
1012 1335
1018 $cf::PLAYER{$login} = $self; 1341 $cf::PLAYER{$login} = $self;
1019 1342
1020 $self 1343 $self
1021} 1344}
1022 1345
1346=item $player->send_msg ($channel, $msg, $color, [extra...])
1347
1348=cut
1349
1350sub send_msg {
1351 my $ns = shift->ns
1352 or return;
1353 $ns->send_msg (@_);
1354}
1355
1023=item $pl->quit_character 1356=item $pl->quit_character
1024 1357
1025Nukes the player without looking back. If logged in, the connection will 1358Nukes the player without looking back. If logged in, the connection will
1026be destroyed. May block for a long time. 1359be destroyed. May block for a long time.
1027 1360
1028=cut 1361=cut
1029 1362
1030sub quit_character { 1363sub quit_character {
1031 my ($pl) = @_; 1364 my ($pl) = @_;
1365
1366 my $name = $pl->ob->name;
1032 1367
1033 $pl->{deny_save} = 1; 1368 $pl->{deny_save} = 1;
1034 $pl->password ("*"); # this should lock out the player until we nuked the dir 1369 $pl->password ("*"); # this should lock out the player until we nuked the dir
1035 1370
1036 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1371 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1041 my $path = playerdir $pl; 1376 my $path = playerdir $pl;
1042 my $temp = "$path~$cf::RUNTIME~deleting~"; 1377 my $temp = "$path~$cf::RUNTIME~deleting~";
1043 aio_rename $path, $temp; 1378 aio_rename $path, $temp;
1044 delete $cf::PLAYER{$pl->ob->name}; 1379 delete $cf::PLAYER{$pl->ob->name};
1045 $pl->destroy; 1380 $pl->destroy;
1381
1382 my $prefix = qr<^~\Q$name\E/>;
1383
1384 # nuke player maps
1385 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1386
1046 IO::AIO::aio_rmtree $temp; 1387 IO::AIO::aio_rmtree $temp;
1388}
1389
1390=item $pl->kick
1391
1392Kicks a player out of the game. This destroys the connection.
1393
1394=cut
1395
1396sub kick {
1397 my ($pl, $kicker) = @_;
1398
1399 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1400 $pl->killer ("kicked");
1401 $pl->ns->destroy;
1047} 1402}
1048 1403
1049=item cf::player::list_logins 1404=item cf::player::list_logins
1050 1405
1051Returns am arrayref of all valid playernames in the system, can take a 1406Returns am arrayref of all valid playernames in the system, can take a
1052while and may block, so not sync_job-capable, ever. 1407while and may block, so not sync_job-capable, ever.
1053 1408
1054=cut 1409=cut
1055 1410
1056sub list_logins { 1411sub list_logins {
1057 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1412 my $dirs = aio_readdir $PLAYERDIR
1058 or return []; 1413 or return [];
1059 1414
1060 my @logins; 1415 my @logins;
1061 1416
1062 for my $login (@$dirs) { 1417 for my $login (@$dirs) {
1079=cut 1434=cut
1080 1435
1081sub maps($) { 1436sub maps($) {
1082 my ($pl) = @_; 1437 my ($pl) = @_;
1083 1438
1439 $pl = ref $pl ? $pl->ob->name : $pl;
1440
1084 my $files = aio_readdir playerdir $pl 1441 my $files = aio_readdir playerdir $pl
1085 or return; 1442 or return;
1086 1443
1087 my @paths; 1444 my @paths;
1088 1445
1089 for (@$files) { 1446 for (@$files) {
1090 utf8::decode $_; 1447 utf8::decode $_;
1091 next if /\.(?:pl|pst)$/; 1448 next if /\.(?:pl|pst)$/;
1092 next unless /^$PATH_SEP/o; 1449 next unless /^$PATH_SEP/o;
1093 1450
1094 push @paths, cf::map::normalise "~" . $pl->ob->name . "/" . $_; 1451 push @paths, cf::map::normalise "~$pl/$_";
1095 } 1452 }
1096 1453
1097 \@paths 1454 \@paths
1098} 1455}
1099 1456
1457=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1458
1459Expand crossfire pod fragments into protocol xml.
1460
1461=cut
1462
1463sub expand_cfpod {
1464 ((my $self), (local $_)) = @_;
1465
1466 # escape & and <
1467 s/&/&amp;/g;
1468 s/(?<![BIUGH])</&lt;/g;
1469
1470 # this is buggy, it needs to properly take care of nested <'s
1471
1472 1 while
1473 # replace B<>, I<>, U<> etc.
1474 s/B<([^\>]*)>/<b>$1<\/b>/
1475 || s/I<([^\>]*)>/<i>$1<\/i>/
1476 || s/U<([^\>]*)>/<u>$1<\/u>/
1477 # replace G<male|female> tags
1478 || s{G<([^>|]*)\|([^>]*)>}{
1479 $self->gender ? $2 : $1
1480 }ge
1481 # replace H<hint text>
1482 || s{H<([^\>]*)>}
1483 {
1484 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1485 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1486 "")
1487 [$self->{hintmode}]
1488 }ge;
1489
1490 # create single paragraphs (very hackish)
1491 s/(?<=\S)\n(?=\w)/ /g;
1492
1493 # compress some whitespace
1494 s/\s+\n/\n/g; # ws line-ends
1495 s/\n\n+/\n/g; # double lines
1496 s/^\n+//; # beginning lines
1497 s/\n+$//; # ending lines
1498
1499 $_
1500}
1501
1502sub hintmode {
1503 $_[0]{hintmode} = $_[1] if @_ > 1;
1504 $_[0]{hintmode}
1505}
1506
1100=item $player->ext_reply ($msgid, $msgtype, %msg) 1507=item $player->ext_reply ($msgid, @msg)
1101 1508
1102Sends an ext reply to the player. 1509Sends an ext reply to the player.
1103 1510
1104=cut 1511=cut
1105 1512
1106sub ext_reply($$$%) { 1513sub ext_reply($$@) {
1107 my ($self, $id, %msg) = @_; 1514 my ($self, $id, @msg) = @_;
1108 1515
1109 $msg{msgid} = $id; 1516 $self->ns->ext_reply ($id, @msg)
1110
1111 $self->send ("ext " . cf::to_json \%msg);
1112} 1517}
1113 1518
1114package cf; 1519=item $player->ext_msg ($type, @msg)
1520
1521Sends an ext event to the client.
1522
1523=cut
1524
1525sub ext_msg($$@) {
1526 my ($self, $type, @msg) = @_;
1527
1528 $self->ns->ext_msg ($type, @msg);
1529}
1530
1531=head3 cf::region
1532
1533=over 4
1534
1535=cut
1536
1537package cf::region;
1538
1539=item cf::region::find_by_path $path
1540
1541Tries to decuce the likely region for a map knowing only its path.
1542
1543=cut
1544
1545sub find_by_path($) {
1546 my ($path) = @_;
1547
1548 my ($match, $specificity);
1549
1550 for my $region (list) {
1551 if ($region->{match} && $path =~ $region->{match}) {
1552 ($match, $specificity) = ($region, $region->specificity)
1553 if $region->specificity > $specificity;
1554 }
1555 }
1556
1557 $match
1558}
1115 1559
1116=back 1560=back
1117
1118 1561
1119=head3 cf::map 1562=head3 cf::map
1120 1563
1121=over 4 1564=over 4
1122 1565
1177 my ($self, $merge) = @_; 1620 my ($self, $merge) = @_;
1178 1621
1179 # we have to keep some variables in memory intact 1622 # we have to keep some variables in memory intact
1180 local $self->{path}; 1623 local $self->{path};
1181 local $self->{load_path}; 1624 local $self->{load_path};
1182 local $self->{deny_save};
1183 local $self->{deny_reset};
1184 1625
1185 $self->SUPER::thawer_merge ($merge); 1626 $self->SUPER::thawer_merge ($merge);
1186} 1627}
1187 1628
1188sub normalise { 1629sub normalise {
1235 $self->init; # pass $1 etc. 1676 $self->init; # pass $1 etc.
1236 return $self; 1677 return $self;
1237 } 1678 }
1238 } 1679 }
1239 1680
1240 Carp::carp "unable to resolve path '$path' (base '$base')."; 1681 Carp::cluck "unable to resolve path '$path' (base '$base').";
1241 () 1682 ()
1242} 1683}
1243 1684
1244sub init { 1685sub init {
1245 my ($self) = @_; 1686 my ($self) = @_;
1260 1701
1261# the original (read-only) location 1702# the original (read-only) location
1262sub load_path { 1703sub load_path {
1263 my ($self) = @_; 1704 my ($self) = @_;
1264 1705
1265 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1706 "$MAPDIR/$self->{path}.map"
1266} 1707}
1267 1708
1268# the temporary/swap location 1709# the temporary/swap location
1269sub save_path { 1710sub save_path {
1270 my ($self) = @_; 1711 my ($self) = @_;
1271 1712
1272 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1713 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1273 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1714 "$TMPDIR/$path.map"
1274} 1715}
1275 1716
1276# the unique path, undef == no special unique path 1717# the unique path, undef == no special unique path
1277sub uniq_path { 1718sub uniq_path {
1278 my ($self) = @_; 1719 my ($self) = @_;
1279 1720
1280 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1721 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1281 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1722 "$UNIQUEDIR/$path"
1282} 1723}
1283 1724
1284# and all this just because we cannot iterate over 1725# and all this just because we cannot iterate over
1285# all maps in C++... 1726# all maps in C++...
1286sub change_all_map_light { 1727sub change_all_map_light {
1288 1729
1289 $_->change_map_light ($change) 1730 $_->change_map_light ($change)
1290 for grep $_->outdoor, values %cf::MAP; 1731 for grep $_->outdoor, values %cf::MAP;
1291} 1732}
1292 1733
1734sub decay_objects {
1735 my ($self) = @_;
1736
1737 return if $self->{deny_reset};
1738
1739 $self->do_decay_objects;
1740}
1741
1293sub unlink_save { 1742sub unlink_save {
1294 my ($self) = @_; 1743 my ($self) = @_;
1295 1744
1296 utf8::encode (my $save = $self->save_path); 1745 utf8::encode (my $save = $self->save_path);
1297 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1746 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1298 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1747 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1299
1300 #d#TODO remove .map and also nuke
1301 $save =~ s/\.map// or return;#d#
1302 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1303 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1304} 1748}
1305 1749
1306sub load_header_from($) { 1750sub load_header_from($) {
1307 my ($self, $path) = @_; 1751 my ($self, $path) = @_;
1308 1752
1358 $self->load_header_orig 1802 $self->load_header_orig
1359 or return; 1803 or return;
1360 $self->prepare_orig; 1804 $self->prepare_orig;
1361 } 1805 }
1362 1806
1807 $self->{deny_reset} = 1
1808 if $self->no_reset;
1809
1810 $self->default_region (cf::region::find_by_path $self->{path})
1811 unless $self->default_region;
1812
1363 1 1813 1
1364} 1814}
1365 1815
1366sub find; 1816sub find;
1367sub find { 1817sub find {
1379 $map->{last_save} = $cf::RUNTIME; 1829 $map->{last_save} = $cf::RUNTIME;
1380 1830
1381 $map->load_header 1831 $map->load_header
1382 or return; 1832 or return;
1383 1833
1384 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1834 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1385 # doing this can freeze the server in a sync job, obviously 1835 # doing this can freeze the server in a sync job, obviously
1386 #$cf::WAIT_FOR_TICK->wait; 1836 #$cf::WAIT_FOR_TICK->wait;
1387 $map->reset; 1837 $map->reset;
1388 undef $guard; 1838 undef $guard;
1389 return find $path; 1839 return find $path;
1400 my ($self) = @_; 1850 my ($self) = @_;
1401 1851
1402 local $self->{deny_reset} = 1; # loading can take a long time 1852 local $self->{deny_reset} = 1; # loading can take a long time
1403 1853
1404 my $path = $self->{path}; 1854 my $path = $self->{path};
1855
1856 {
1857 my $guard1 = cf::lock_acquire "map_data:$path";
1405 my $guard = cf::lock_acquire "map_load:$path"; 1858 my $guard2 = cf::lock_acquire "map_load:$path";
1406 1859
1407 return if $self->in_memory != cf::MAP_SWAPPED; 1860 return if $self->in_memory != cf::MAP_SWAPPED;
1408 1861
1409 $self->in_memory (cf::MAP_LOADING); 1862 $self->in_memory (cf::MAP_LOADING);
1410 1863
1411 $self->alloc; 1864 $self->alloc;
1412 1865
1413 $self->pre_load; 1866 $self->pre_load;
1867 cf::cede_to_tick;
1414 1868
1415 $self->_load_objects ($self->{load_path}, 1) 1869 $self->_load_objects ($self->{load_path}, 1)
1416 or return; 1870 or return;
1417 1871
1418 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 1872 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1419 if delete $self->{load_original}; 1873 if delete $self->{load_original};
1420 1874
1421 if (my $uniq = $self->uniq_path) { 1875 if (my $uniq = $self->uniq_path) {
1422 utf8::encode $uniq; 1876 utf8::encode $uniq;
1423 if (aio_open $uniq, O_RDONLY, 0) { 1877 if (aio_open $uniq, O_RDONLY, 0) {
1424 $self->clear_unique_items; 1878 $self->clear_unique_items;
1425 $self->_load_objects ($uniq, 0); 1879 $self->_load_objects ($uniq, 0);
1426 } 1880 }
1427 } 1881 }
1428 1882
1429 Coro::cede; 1883 cf::cede_to_tick;
1430
1431 # now do the right thing for maps 1884 # now do the right thing for maps
1432 $self->link_multipart_objects; 1885 $self->link_multipart_objects;
1433
1434 unless ($self->{deny_activate}) {
1435 $self->decay_objects;
1436 $self->fix_auto_apply;
1437 $self->update_buttons;
1438 Coro::cede;
1439 $self->set_darkness_map;
1440 $self->difficulty ($self->estimate_difficulty) 1886 $self->difficulty ($self->estimate_difficulty)
1441 unless $self->difficulty; 1887 unless $self->difficulty;
1442 Coro::cede; 1888 cf::cede_to_tick;
1889
1890 unless ($self->{deny_activate}) {
1891 $self->decay_objects;
1892 $self->fix_auto_apply;
1893 $self->update_buttons;
1894 cf::cede_to_tick;
1895 $self->set_darkness_map;
1896 cf::cede_to_tick;
1443 $self->activate; 1897 $self->activate;
1898 }
1899
1900 $self->{last_save} = $cf::RUNTIME;
1901 $self->last_access ($cf::RUNTIME);
1902
1903 $self->in_memory (cf::MAP_IN_MEMORY);
1444 } 1904 }
1445 1905
1446 $self->post_load; 1906 $self->post_load;
1447
1448 $self->in_memory (cf::MAP_IN_MEMORY);
1449} 1907}
1450 1908
1451sub customise_for { 1909sub customise_for {
1452 my ($self, $ob) = @_; 1910 my ($self, $ob) = @_;
1453 1911
1454 return find "~" . $ob->name . "/" . $self->{path} 1912 return find "~" . $ob->name . "/" . $self->{path}
1455 if $self->per_player; 1913 if $self->per_player;
1456 1914
1915# return find "?party/" . $ob->name . "/" . $self->{path}
1916# if $self->per_party;
1917
1457 $self 1918 $self
1458} 1919}
1459 1920
1460# find and load all maps in the 3x3 area around a map 1921# find and load all maps in the 3x3 area around a map
1461sub load_diag { 1922sub load_neighbours {
1462 my ($map) = @_; 1923 my ($map) = @_;
1463 1924
1464 my @diag; # diagonal neighbours 1925 my @neigh; # diagonal neighbours
1465 1926
1466 for (0 .. 3) { 1927 for (0 .. 3) {
1467 my $neigh = $map->tile_path ($_) 1928 my $neigh = $map->tile_path ($_)
1468 or next; 1929 or next;
1469 $neigh = find $neigh, $map 1930 $neigh = find $neigh, $map
1470 or next; 1931 or next;
1471 $neigh->load; 1932 $neigh->load;
1472 1933
1934 push @neigh,
1473 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 1935 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1474 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 1936 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1475 } 1937 }
1476 1938
1477 for (@diag) { 1939 for (grep defined $_->[0], @neigh) {
1940 my ($path, $origin) = @$_;
1478 my $neigh = find @$_ 1941 my $neigh = find $path, $origin
1479 or next; 1942 or next;
1480 $neigh->load; 1943 $neigh->load;
1481 } 1944 }
1482} 1945}
1483 1946
1488} 1951}
1489 1952
1490sub do_load_sync { 1953sub do_load_sync {
1491 my ($map) = @_; 1954 my ($map) = @_;
1492 1955
1956 cf::LOG cf::llevDebug | cf::logBacktrace, "do_load_sync"
1957 if $Coro::current == $Coro::main;
1958
1493 cf::sync_job { $map->load }; 1959 cf::sync_job { $map->load };
1494} 1960}
1495 1961
1496our %MAP_PREFETCH; 1962our %MAP_PREFETCH;
1497our $MAP_PREFETCHER = undef; 1963our $MAP_PREFETCHER = undef;
1498 1964
1499sub find_async { 1965sub find_async {
1500 my ($path, $origin) = @_; 1966 my ($path, $origin, $load) = @_;
1501 1967
1502 $path = normalise $path, $origin && $origin->{path}; 1968 $path = normalise $path, $origin && $origin->{path};
1503 1969
1504 if (my $map = $cf::MAP{$path}) { 1970 if (my $map = $cf::MAP{$path}) {
1505 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 1971 return $map if !$load || $map->in_memory == cf::MAP_IN_MEMORY;
1506 } 1972 }
1507 1973
1508 undef $MAP_PREFETCH{$path}; 1974 $MAP_PREFETCH{$path} |= $load;
1975
1509 $MAP_PREFETCHER ||= cf::async { 1976 $MAP_PREFETCHER ||= cf::async {
1510 while (%MAP_PREFETCH) { 1977 while (%MAP_PREFETCH) {
1511 for my $path (keys %MAP_PREFETCH) { 1978 while (my ($k, $v) = each %MAP_PREFETCH) {
1512 my $map = find $path 1979 if (my $map = find $k) {
1513 or next;
1514 $map->load; 1980 $map->load if $v;
1981 }
1515 1982
1516 delete $MAP_PREFETCH{$path}; 1983 delete $MAP_PREFETCH{$k};
1517 } 1984 }
1518 } 1985 }
1519 undef $MAP_PREFETCHER; 1986 undef $MAP_PREFETCHER;
1520 }; 1987 };
1521 $MAP_PREFETCHER->prio (6); 1988 $MAP_PREFETCHER->prio (6);
1524} 1991}
1525 1992
1526sub save { 1993sub save {
1527 my ($self) = @_; 1994 my ($self) = @_;
1528 1995
1529 my $lock = cf::lock_acquire "map_data:" . $self->path; 1996 my $lock = cf::lock_acquire "map_data:$self->{path}";
1530 1997
1531 $self->{last_save} = $cf::RUNTIME; 1998 $self->{last_save} = $cf::RUNTIME;
1532 1999
1533 return unless $self->dirty; 2000 return unless $self->dirty;
1534 2001
1557 my ($self) = @_; 2024 my ($self) = @_;
1558 2025
1559 # save first because save cedes 2026 # save first because save cedes
1560 $self->save; 2027 $self->save;
1561 2028
1562 my $lock = cf::lock_acquire "map_data:" . $self->path; 2029 my $lock = cf::lock_acquire "map_data:$self->{path}";
1563 2030
1564 return if $self->players; 2031 return if $self->players;
1565 return if $self->in_memory != cf::MAP_IN_MEMORY; 2032 return if $self->in_memory != cf::MAP_IN_MEMORY;
1566 return if $self->{deny_save}; 2033 return if $self->{deny_save};
1567 2034
1571 2038
1572sub reset_at { 2039sub reset_at {
1573 my ($self) = @_; 2040 my ($self) = @_;
1574 2041
1575 # TODO: safety, remove and allow resettable per-player maps 2042 # TODO: safety, remove and allow resettable per-player maps
1576 return 1e99 if $self->isa ("ext::map_per_player");#d#
1577 return 1e99 if $self->{deny_reset}; 2043 return 1e99 if $self->{deny_reset};
1578 2044
1579 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2045 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1580 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2046 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1581 2047
1592 my ($self) = @_; 2058 my ($self) = @_;
1593 2059
1594 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2060 my $lock = cf::lock_acquire "map_data:$self->{path}";
1595 2061
1596 return if $self->players; 2062 return if $self->players;
1597 return if $self->isa ("ext::map_per_player");#d#
1598 2063
1599 warn "resetting map ", $self->path;#d# 2064 warn "resetting map ", $self->path;
2065
2066 $self->in_memory (cf::MAP_SWAPPED);
2067
2068 # need to save uniques path
2069 unless ($self->{deny_save}) {
2070 my $uniq = $self->uniq_path; utf8::encode $uniq;
2071
2072 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2073 if $uniq;
2074 }
1600 2075
1601 delete $cf::MAP{$self->path}; 2076 delete $cf::MAP{$self->path};
1602 2077
1603 $self->in_memory (cf::MAP_SWAPPED);
1604 $self->clear; 2078 $self->clear;
1605 2079
1606 $_->clear_links_to ($self) for values %cf::MAP; 2080 $_->clear_links_to ($self) for values %cf::MAP;
1607 2081
1608 $self->unlink_save; 2082 $self->unlink_save;
1627 $cf::MAP{$self->path} = $self; 2101 $cf::MAP{$self->path} = $self;
1628 2102
1629 $self->reset; # polite request, might not happen 2103 $self->reset; # polite request, might not happen
1630} 2104}
1631 2105
2106=item $maps = cf::map::tmp_maps
2107
2108Returns an arrayref with all map paths of currently instantiated and saved
2109maps. May block.
2110
2111=cut
2112
2113sub tmp_maps() {
2114 [
2115 map {
2116 utf8::decode $_;
2117 /\.map$/
2118 ? normalise $_
2119 : ()
2120 } @{ aio_readdir $TMPDIR or [] }
2121 ]
2122}
2123
2124=item $maps = cf::map::random_maps
2125
2126Returns an arrayref with all map paths of currently instantiated and saved
2127random maps. May block.
2128
2129=cut
2130
2131sub random_maps() {
2132 [
2133 map {
2134 utf8::decode $_;
2135 /\.map$/
2136 ? normalise "?random/$_"
2137 : ()
2138 } @{ aio_readdir $RANDOMDIR or [] }
2139 ]
2140}
2141
1632=item cf::map::unique_maps 2142=item cf::map::unique_maps
1633 2143
1634Returns an arrayref of paths of all shared maps that have 2144Returns an arrayref of paths of all shared maps that have
1635instantiated unique items. May block. 2145instantiated unique items. May block.
1636 2146
1637=cut 2147=cut
1638 2148
1639sub unique_maps() { 2149sub unique_maps() {
1640 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2150 [
1641 or return; 2151 map {
1642
1643 my @paths;
1644
1645 for (@$files) {
1646 utf8::decode $_; 2152 utf8::decode $_;
1647 next if /\.pst$/; 2153 /\.map$/
1648 next unless /^$PATH_SEP/o; 2154 ? normalise $_
1649 2155 : ()
1650 push @paths, cf::map::normalise $_; 2156 } @{ aio_readdir $UNIQUEDIR or [] }
1651 } 2157 ]
1652
1653 \@paths
1654} 2158}
1655 2159
1656package cf; 2160package cf;
1657 2161
1658=back 2162=back
1704 2208
1705 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2209 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1706 2210
1707 if ($self->{record_replies}) { 2211 if ($self->{record_replies}) {
1708 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2212 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2213
1709 } else { 2214 } else {
2215 my $pl = $self->contr;
2216
2217 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2218 my $dialog = $pl->{npc_dialog};
2219 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2220
2221 } else {
1710 $msg = $npc->name . " says: $msg" if $npc; 2222 $msg = $npc->name . " says: $msg" if $npc;
1711 $self->message ($msg, $flags); 2223 $self->message ($msg, $flags);
2224 }
1712 } 2225 }
2226}
2227
2228=item $object->send_msg ($channel, $msg, $color, [extra...])
2229
2230=cut
2231
2232sub cf::object::send_msg {
2233 my $pl = shift->contr
2234 or return;
2235 $pl->send_msg (@_);
1713} 2236}
1714 2237
1715=item $player_object->may ("access") 2238=item $player_object->may ("access")
1716 2239
1717Returns wether the given player is authorized to access resource "access" 2240Returns wether the given player is authorized to access resource "access"
1764 $self->deactivate_recursive; 2287 $self->deactivate_recursive;
1765 2288
1766 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2289 return if UNIVERSAL::isa $self->map, "ext::map_link";
1767 2290
1768 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2291 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1769 if $self->map; 2292 if $self->map && $self->map->{path} ne "{link}";
1770 2293
1771 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2294 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1772} 2295}
1773 2296
1774sub cf::object::player::leave_link { 2297sub cf::object::player::leave_link {
1775 my ($self, $map, $x, $y) = @_; 2298 my ($self, $map, $x, $y) = @_;
2299
2300 return unless $self->contr->active;
1776 2301
1777 my $link_pos = delete $self->{_link_pos}; 2302 my $link_pos = delete $self->{_link_pos};
1778 2303
1779 unless ($map) { 2304 unless ($map) {
1780 # restore original map position 2305 # restore original map position
1794 # use -1 or undef as default coordinates, not 0, 0 2319 # use -1 or undef as default coordinates, not 0, 0
1795 ($x, $y) = ($map->enter_x, $map->enter_y) 2320 ($x, $y) = ($map->enter_x, $map->enter_y)
1796 if $x <=0 && $y <= 0; 2321 if $x <=0 && $y <= 0;
1797 2322
1798 $map->load; 2323 $map->load;
1799 $map->load_diag; 2324 $map->load_neighbours;
1800 2325
1801 return unless $self->contr->active; 2326 return unless $self->contr->active;
1802 $self->activate_recursive; 2327 $self->activate_recursive;
2328
2329 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1803 $self->enter_map ($map, $x, $y); 2330 $self->enter_map ($map, $x, $y);
1804} 2331}
1805 2332
1806cf::player->attach ( 2333=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1807 on_logout => sub {
1808 my ($pl) = @_;
1809 2334
1810 # abort map switching before logout 2335Moves the player to the given map-path and coordinates by first freezing
1811 if ($pl->ob->{_link_pos}) { 2336her, loading and preparing them map, calling the provided $check callback
1812 cf::sync_job { 2337that has to return the map if sucecssful, and then unfreezes the player on
1813 $pl->ob->leave_link 2338the new (success) or old (failed) map position. In either case, $done will
1814 }; 2339be called at the end of this process.
1815 }
1816 },
1817 on_login => sub {
1818 my ($pl) = @_;
1819 2340
1820 # try to abort aborted map switching on player login :)
1821 # should happen only on crashes
1822 if ($pl->ob->{_link_pos}) {
1823 $pl->ob->enter_link;
1824 (async {
1825 # we need this sleep as the login has a concurrent enter_exit running
1826 # and this sleep increases chances of the player not ending up in scorn
1827 $pl->ob->reply (undef,
1828 "There was an internal problem at your last logout, "
1829 . "the server will try to bring you to your intended destination in a second.",
1830 cf::NDI_RED);
1831 Coro::Timer::sleep 1;
1832 $pl->ob->leave_link;
1833 })->prio (2);
1834 }
1835 },
1836);
1837
1838=item $player_object->goto ($path, $x, $y)
1839
1840=cut 2341=cut
2342
2343our $GOTOGEN;
1841 2344
1842sub cf::object::player::goto { 2345sub cf::object::player::goto {
1843 my ($self, $path, $x, $y) = @_; 2346 my ($self, $path, $x, $y, $check, $done) = @_;
2347
2348 # do generation counting so two concurrent goto's will be executed in-order
2349 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1844 2350
1845 $self->enter_link; 2351 $self->enter_link;
1846 2352
1847 (async { 2353 (async {
1848 my $map = eval { 2354 my $map = eval {
1849 my $map = cf::map::find $path; 2355 my $map = cf::map::find $path;
2356
2357 if ($map) {
1850 $map = $map->customise_for ($self) if $map; 2358 $map = $map->customise_for ($self);
2359 $map = $check->($map) if $check && $map;
2360 } else {
2361 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2362 }
2363
1851 $map 2364 $map
2365 };
2366
2367 if ($@) {
2368 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2369 LOG llevError | logBacktrace, Carp::longmess $@;
1852 } or 2370 }
1853 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1854 2371
2372 if ($gen == $self->{_goto_generation}) {
2373 delete $self->{_goto_generation};
1855 $self->leave_link ($map, $x, $y); 2374 $self->leave_link ($map, $x, $y);
2375 }
2376
2377 $done->() if $done;
1856 })->prio (1); 2378 })->prio (1);
1857} 2379}
1858 2380
1859=item $player_object->enter_exit ($exit_object) 2381=item $player_object->enter_exit ($exit_object)
1860 2382
1899 2421
1900 $rmp->{random_seed} ||= $exit->random_seed; 2422 $rmp->{random_seed} ||= $exit->random_seed;
1901 2423
1902 my $data = cf::to_json $rmp; 2424 my $data = cf::to_json $rmp;
1903 my $md5 = Digest::MD5::md5_hex $data; 2425 my $md5 = Digest::MD5::md5_hex $data;
1904 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2426 my $meta = "$RANDOMDIR/$md5.meta";
1905 2427
1906 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2428 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1907 aio_write $fh, 0, (length $data), $data, 0; 2429 aio_write $fh, 0, (length $data), $data, 0;
1908 undef $fh; 2430 undef $fh;
1909 aio_rename "$meta~", $meta; 2431 aio_rename "$meta~", $meta;
1918 2440
1919 return unless $self->type == cf::PLAYER; 2441 return unless $self->type == cf::PLAYER;
1920 2442
1921 if ($exit->slaying eq "/!") { 2443 if ($exit->slaying eq "/!") {
1922 #TODO: this should de-fi-ni-te-ly not be a sync-job 2444 #TODO: this should de-fi-ni-te-ly not be a sync-job
2445 # the problem is that $exit might not survive long enough
2446 # so it needs to be done right now, right here
1923 cf::sync_job { prepare_random_map $exit }; 2447 cf::sync_job { prepare_random_map $exit };
1924 } 2448 }
1925 2449
1926 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2450 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1927 my $hp = $exit->stats->hp; 2451 my $hp = $exit->stats->hp;
1928 my $sp = $exit->stats->sp; 2452 my $sp = $exit->stats->sp;
1929 2453
1930 $self->enter_link; 2454 $self->enter_link;
2455
2456 # if exit is damned, update players death & WoR home-position
2457 $self->contr->savebed ($slaying, $hp, $sp)
2458 if $exit->flag (FLAG_DAMNED);
1931 2459
1932 (async { 2460 (async {
1933 $self->deactivate_recursive; # just to be sure 2461 $self->deactivate_recursive; # just to be sure
1934 unless (eval { 2462 unless (eval {
1935 $self->goto ($slaying, $hp, $sp); 2463 $self->goto ($slaying, $hp, $sp);
1936 2464
1937 1; 2465 1;
1938 }) { 2466 }) {
1939 $self->message ("Something went wrong deep within the crossfire server. " 2467 $self->message ("Something went wrong deep within the crossfire server. "
1940 . "I'll try to bring you back to the map you were before. " 2468 . "I'll try to bring you back to the map you were before. "
1941 . "Please report this to the dungeon master!", 2469 . "Please report this to the dungeon master!",
1942 cf::NDI_UNIQUE | cf::NDI_RED); 2470 cf::NDI_UNIQUE | cf::NDI_RED);
1943 2471
1944 warn "ERROR in enter_exit: $@"; 2472 warn "ERROR in enter_exit: $@";
1945 $self->leave_link; 2473 $self->leave_link;
1946 } 2474 }
1947 })->prio (1); 2475 })->prio (1);
1960 2488
1961sub cf::client::send_drawinfo { 2489sub cf::client::send_drawinfo {
1962 my ($self, $text, $flags) = @_; 2490 my ($self, $text, $flags) = @_;
1963 2491
1964 utf8::encode $text; 2492 utf8::encode $text;
1965 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2493 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1966} 2494}
1967 2495
2496=item $client->send_msg ($channel, $msg, $color, [extra...])
2497
2498Send a drawinfo or msg packet to the client, formatting the msg for the
2499client if neccessary. C<$type> should be a string identifying the type of
2500the message, with C<log> being the default. If C<$color> is negative, suppress
2501the message unless the client supports the msg packet.
2502
2503=cut
2504
2505sub cf::client::send_msg {
2506 my ($self, $channel, $msg, $color, @extra) = @_;
2507
2508 $msg = $self->pl->expand_cfpod ($msg);
2509
2510 $color &= cf::NDI_CLIENT_MASK; # just in case...
2511
2512 if (ref $channel) {
2513 # send meta info to client, if not yet sent
2514 unless (exists $self->{channel}{$channel->{id}}) {
2515 $self->{channel}{$channel->{id}} = $channel;
2516 $self->ext_msg (channel_info => $channel);
2517 }
2518
2519 $channel = $channel->{id};
2520 }
2521
2522 return unless @extra || length $msg;
2523
2524 if ($self->can_msg) {
2525 # default colour, mask it out
2526 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2527 if $color & cf::NDI_DEF;
2528
2529 $self->send_packet ("msg " . $self->{json_coder}->encode (
2530 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]));
2531 } else {
2532 if ($color >= 0) {
2533 # replace some tags by gcfclient-compatible ones
2534 for ($msg) {
2535 1 while
2536 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2537 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2538 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2539 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2540 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2541 }
2542
2543 $color &= cf::NDI_COLOR_MASK;
2544
2545 utf8::encode $msg;
2546
2547 if (0 && $msg =~ /\[/) {
2548 # COMMAND/INFO
2549 $self->send_packet ("drawextinfo $color 10 8 $msg")
2550 } else {
2551 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2552 $self->send_packet ("drawinfo $color $msg")
2553 }
2554 }
2555 }
2556}
2557
2558=item $client->ext_msg ($type, @msg)
2559
2560Sends an ext event to the client.
2561
2562=cut
2563
2564sub cf::client::ext_msg($$@) {
2565 my ($self, $type, @msg) = @_;
2566
2567 if ($self->extcmd == 2) {
2568 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2569 } elsif ($self->extcmd == 1) { # TODO: remove
2570 push @msg, msgtype => "event_$type";
2571 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2572 }
2573}
2574
2575=item $client->ext_reply ($msgid, @msg)
2576
2577Sends an ext reply to the client.
2578
2579=cut
2580
2581sub cf::client::ext_reply($$@) {
2582 my ($self, $id, @msg) = @_;
2583
2584 if ($self->extcmd == 2) {
2585 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2586 } elsif ($self->extcmd == 1) {
2587 #TODO: version 1, remove
2588 unshift @msg, msgtype => "reply", msgid => $id;
2589 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2590 }
2591}
1968 2592
1969=item $success = $client->query ($flags, "text", \&cb) 2593=item $success = $client->query ($flags, "text", \&cb)
1970 2594
1971Queues a query to the client, calling the given callback with 2595Queues a query to the client, calling the given callback with
1972the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2596the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1973C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2597C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1974 2598
1975Queries can fail, so check the return code. Or don't, as queries will become 2599Queries can fail, so check the return code. Or don't, as queries will
1976reliable at some point in the future. 2600become reliable at some point in the future.
1977 2601
1978=cut 2602=cut
1979 2603
1980sub cf::client::query { 2604sub cf::client::query {
1981 my ($self, $flags, $text, $cb) = @_; 2605 my ($self, $flags, $text, $cb) = @_;
1989 utf8::encode $text; 2613 utf8::encode $text;
1990 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2614 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1991 2615
1992 $self->send_packet ($self->{query_queue}[0][0]) 2616 $self->send_packet ($self->{query_queue}[0][0])
1993 if @{ $self->{query_queue} } == 1; 2617 if @{ $self->{query_queue} } == 1;
2618
2619 1
1994} 2620}
1995 2621
1996cf::client->attach ( 2622cf::client->attach (
2623 on_connect => sub {
2624 my ($ns) = @_;
2625
2626 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2627 },
1997 on_reply => sub { 2628 on_reply => sub {
1998 my ($ns, $msg) = @_; 2629 my ($ns, $msg) = @_;
1999 2630
2000 # this weird shuffling is so that direct followup queries 2631 # this weird shuffling is so that direct followup queries
2001 # get handled first 2632 # get handled first
2002 my $queue = delete $ns->{query_queue} 2633 my $queue = delete $ns->{query_queue}
2003 or return; # be conservative, not sure how that can happen, but we saw a crash here 2634 or return; # be conservative, not sure how that can happen, but we saw a crash here
2004 2635
2005 (shift @$queue)->[1]->($msg); 2636 (shift @$queue)->[1]->($msg);
2637 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2006 2638
2007 push @{ $ns->{query_queue} }, @$queue; 2639 push @{ $ns->{query_queue} }, @$queue;
2008 2640
2009 if (@{ $ns->{query_queue} } == @$queue) { 2641 if (@{ $ns->{query_queue} } == @$queue) {
2010 if (@$queue) { 2642 if (@$queue) {
2012 } else { 2644 } else {
2013 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2645 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2014 } 2646 }
2015 } 2647 }
2016 }, 2648 },
2649 on_exticmd => sub {
2650 my ($ns, $buf) = @_;
2651
2652 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2653
2654 if (ref $msg) {
2655 my ($type, $reply, @payload) =
2656 "ARRAY" eq ref $msg
2657 ? @$msg
2658 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2659
2660 my @reply;
2661
2662 if (my $cb = $EXTICMD{$type}) {
2663 @reply = $cb->($ns, @payload);
2664 }
2665
2666 $ns->ext_reply ($reply, @reply)
2667 if $reply;
2668
2669 } else {
2670 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2671 }
2672
2673 cf::override;
2674 },
2017); 2675);
2018 2676
2019=item $client->async (\&cb) 2677=item $client->async (\&cb)
2020 2678
2021Create a new coroutine, running the specified callback. The coroutine will 2679Create a new coroutine, running the specified callback. The coroutine will
2062our $safe = new Safe "safe"; 2720our $safe = new Safe "safe";
2063our $safe_hole = new Safe::Hole; 2721our $safe_hole = new Safe::Hole;
2064 2722
2065$SIG{FPE} = 'IGNORE'; 2723$SIG{FPE} = 'IGNORE';
2066 2724
2067$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 2725$safe->permit_only (Opcode::opset qw(
2726 :base_core :base_mem :base_orig :base_math
2727 grepstart grepwhile mapstart mapwhile
2728 sort time
2729));
2068 2730
2069# here we export the classes and methods available to script code 2731# here we export the classes and methods available to script code
2070 2732
2071=pod 2733=pod
2072 2734
2073The following fucntions and emthods are available within a safe environment: 2735The following functions and methods are available within a safe environment:
2074 2736
2075 cf::object contr pay_amount pay_player map 2737 cf::object
2738 contr pay_amount pay_player map x y force_find force_add
2739 insert remove name archname title slaying race decrease_ob_nr
2740
2076 cf::object::player player 2741 cf::object::player
2077 cf::player peaceful 2742 player
2078 cf::map trigger 2743
2744 cf::player
2745 peaceful
2746
2747 cf::map
2748 trigger
2079 2749
2080=cut 2750=cut
2081 2751
2082for ( 2752for (
2083 ["cf::object" => qw(contr pay_amount pay_player map)], 2753 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2754 insert remove inv name archname title slaying race
2755 decrease_ob_nr)],
2084 ["cf::object::player" => qw(player)], 2756 ["cf::object::player" => qw(player)],
2085 ["cf::player" => qw(peaceful)], 2757 ["cf::player" => qw(peaceful)],
2086 ["cf::map" => qw(trigger)], 2758 ["cf::map" => qw(trigger)],
2087) { 2759) {
2088 no strict 'refs'; 2760 no strict 'refs';
2159=back 2831=back
2160 2832
2161=cut 2833=cut
2162 2834
2163############################################################################# 2835#############################################################################
2836# the server's init and main functions
2164 2837
2165=head2 EXTENSION DATABASE SUPPORT 2838sub load_facedata($) {
2839 my ($path) = @_;
2166 2840
2167Crossfire maintains a very simple database for extension use. It can 2841 my $enc = JSON::XS->new->utf8->canonical->relaxed;
2168currently store anything that can be serialised using Storable, which
2169excludes objects.
2170 2842
2171The parameter C<$family> should best start with the name of the extension 2843 warn "loading facedata from $path\n";
2172using it, it should be unique.
2173 2844
2174=over 4 2845 my $facedata;
2846 0 < aio_load $path, $facedata
2847 or die "$path: $!";
2175 2848
2176=item $hashref = cf::db_get $family 2849 $facedata = Coro::Storable::thaw $facedata;
2177 2850
2178Return a hashref for use by the extension C<$family>, which can be 2851 $facedata->{version} == 2
2179modified. After modifications, you have to call C<cf::db_dirty> or 2852 or cf::cleanup "$path: version mismatch, cannot proceed.";
2180C<cf::db_sync>.
2181 2853
2182=item $value = cf::db_get $family => $key 2854 # patch in the exptable
2183 2855 $facedata->{resource}{"res/exp_table"} = {
2184Returns a single value from the database 2856 type => FT_RSRC,
2185 2857 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
2186=item cf::db_put $family => $hashref
2187
2188Stores the given family hashref into the database. Updates are delayed, if
2189you want the data to be synced to disk immediately, use C<cf::db_sync>.
2190
2191=item cf::db_put $family => $key => $value
2192
2193Stores the given C<$value> in the family hash. Updates are delayed, if you
2194want the data to be synced to disk immediately, use C<cf::db_sync>.
2195
2196=item cf::db_dirty
2197
2198Marks the database as dirty, to be updated at a later time.
2199
2200=item cf::db_sync
2201
2202Immediately write the database to disk I<if it is dirty>.
2203
2204=cut
2205
2206our $DB;
2207
2208{
2209 my $path = cf::localdir . "/database.pst";
2210
2211 sub db_load() {
2212 $DB = stat $path ? Storable::retrieve $path : { };
2213 } 2858 };
2859 cf::cede_to_tick;
2214 2860
2215 my $pid;
2216
2217 sub db_save() {
2218 waitpid $pid, 0 if $pid;
2219 if (0 == ($pid = fork)) {
2220 $DB->{_meta}{version} = 1;
2221 Storable::nstore $DB, "$path~";
2222 rename "$path~", $path;
2223 cf::_exit 0 if defined $pid;
2224 }
2225 } 2861 {
2862 my $faces = $facedata->{faceinfo};
2226 2863
2227 my $dirty; 2864 while (my ($face, $info) = each %$faces) {
2865 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2866 cf::face::set_visibility $idx, $info->{visibility};
2867 cf::face::set_magicmap $idx, $info->{magicmap};
2868 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
2869 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
2228 2870
2229 sub db_sync() { 2871 cf::cede_to_tick;
2230 db_save if $dirty;
2231 undef $dirty;
2232 }
2233
2234 my $idle = Event->idle (
2235 reentrant => 0,
2236 min => 10,
2237 max => 20,
2238 repeat => 0,
2239 data => WF_AUTOCANCEL,
2240 cb => \&db_sync,
2241 );
2242
2243 sub db_dirty() {
2244 $dirty = 1;
2245 $idle->start;
2246 }
2247
2248 sub db_get($;$) {
2249 @_ >= 2
2250 ? $DB->{$_[0]}{$_[1]}
2251 : ($DB->{$_[0]} ||= { })
2252 }
2253
2254 sub db_put($$;$) {
2255 if (@_ >= 3) {
2256 $DB->{$_[0]}{$_[1]} = $_[2];
2257 } else {
2258 $DB->{$_[0]} = $_[1];
2259 }
2260 db_dirty;
2261 }
2262
2263 cf::global->attach (
2264 prio => 10000,
2265 on_cleanup => sub {
2266 db_sync;
2267 }, 2872 }
2268 );
2269}
2270 2873
2271############################################################################# 2874 while (my ($face, $info) = each %$faces) {
2272# the server's main() 2875 next unless $info->{smooth};
2876 my $idx = cf::face::find $face
2877 or next;
2878 if (my $smooth = cf::face::find $info->{smooth}) {
2879 cf::face::set_smooth $idx, $smooth;
2880 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2881 } else {
2882 warn "smooth face '$info->{smooth}' not found for face '$face'";
2883 }
2273 2884
2274sub cfg_load { 2885 cf::cede_to_tick;
2886 }
2887 }
2888
2889 {
2890 my $anims = $facedata->{animinfo};
2891
2892 while (my ($anim, $info) = each %$anims) {
2893 cf::anim::set $anim, $info->{frames}, $info->{facings};
2894 cf::cede_to_tick;
2895 }
2896
2897 cf::anim::invalidate_all; # d'oh
2898 }
2899
2900 {
2901 # TODO: for gcfclient pleasure, we should give resources
2902 # that gcfclient doesn't grok a >10000 face index.
2903 my $res = $facedata->{resource};
2904
2905 my $soundconf = delete $res->{"res/sound.conf"};
2906
2907 while (my ($name, $info) = each %$res) {
2908 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2909 my $data;
2910
2911 if ($info->{type} & 1) {
2912 # prepend meta info
2913
2914 my $meta = $enc->encode ({
2915 name => $name,
2916 %{ $info->{meta} || {} },
2917 });
2918
2919 $data = pack "(w/a*)*", $meta, $info->{data};
2920 } else {
2921 $data = $info->{data};
2922 }
2923
2924 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
2925 cf::face::set_type $idx, $info->{type};
2926
2927 cf::cede_to_tick;
2928 }
2929
2930 if ($soundconf) {
2931 $soundconf = $enc->decode (delete $soundconf->{data});
2932
2933 for (0 .. SOUND_CAST_SPELL_0 - 1) {
2934 my $sound = $soundconf->{compat}[$_]
2935 or next;
2936
2937 my $face = cf::face::find "sound/$sound->[1]";
2938 cf::sound::set $sound->[0] => $face;
2939 cf::sound::old_sound_index $_, $face; # gcfclient-compat
2940 }
2941
2942 while (my ($k, $v) = each %{$soundconf->{event}}) {
2943 my $face = cf::face::find "sound/$v";
2944 cf::sound::set $k => $face;
2945 }
2946 }
2947 }
2948
2949 1
2950}
2951
2952register_exticmd fx_want => sub {
2953 my ($ns, $want) = @_;
2954
2955 while (my ($k, $v) = each %$want) {
2956 $ns->fx_want ($k, $v);
2957 }
2958};
2959
2960sub reload_regions {
2961 load_resource_file "$MAPDIR/regions"
2962 or die "unable to load regions file\n";
2963
2964 for (cf::region::list) {
2965 $_->{match} = qr/$_->{match}/
2966 if exists $_->{match};
2967 }
2968}
2969
2970sub reload_facedata {
2971 load_facedata "$DATADIR/facedata"
2972 or die "unable to load facedata\n";
2973}
2974
2975sub reload_archetypes {
2976 load_resource_file "$DATADIR/archetypes"
2977 or die "unable to load archetypes\n";
2978 #d# NEED to laod twice to resolve forward references
2979 # this really needs to be done in an extra post-pass
2980 # (which needs to be synchronous, so solve it differently)
2981 load_resource_file "$DATADIR/archetypes"
2982 or die "unable to load archetypes\n";
2983}
2984
2985sub reload_treasures {
2986 load_resource_file "$DATADIR/treasures"
2987 or die "unable to load treasurelists\n";
2988}
2989
2990sub reload_resources {
2991 warn "reloading resource files...\n";
2992
2993 reload_regions;
2994 reload_facedata;
2995 #reload_archetypes;#d#
2996 reload_archetypes;
2997 reload_treasures;
2998
2999 warn "finished reloading resource files\n";
3000}
3001
3002sub init {
3003 reload_resources;
3004}
3005
3006sub reload_config {
2275 open my $fh, "<:utf8", cf::confdir . "/config" 3007 open my $fh, "<:utf8", "$CONFDIR/config"
2276 or return; 3008 or return;
2277 3009
2278 local $/; 3010 local $/;
2279 *CFG = YAML::Syck::Load <$fh>; 3011 *CFG = YAML::Syck::Load <$fh>;
2280 3012
2299 (async { 3031 (async {
2300 Event::one_event; 3032 Event::one_event;
2301 })->prio (Coro::PRIO_MAX); 3033 })->prio (Coro::PRIO_MAX);
2302 }; 3034 };
2303 3035
2304 cfg_load; 3036 reload_config;
2305 db_load; 3037 db_init;
2306 load_extensions; 3038 load_extensions;
2307 3039
2308 $TICK_WATCHER->start; 3040 $TICK_WATCHER->start;
2309 Event::loop; 3041 Event::loop;
2310} 3042}
2325 }, 3057 },
2326 ); 3058 );
2327 } 3059 }
2328} 3060}
2329 3061
3062sub write_runtime {
3063 my $runtime = "$LOCALDIR/runtime";
3064
3065 # first touch the runtime file to show we are still running:
3066 # the fsync below can take a very very long time.
3067
3068 IO::AIO::aio_utime $runtime, undef, undef;
3069
3070 my $guard = cf::lock_acquire "write_runtime";
3071
3072 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3073 or return;
3074
3075 my $value = $cf::RUNTIME + 90 + 10;
3076 # 10 is the runtime save interval, for a monotonic clock
3077 # 60 allows for the watchdog to kill the server.
3078
3079 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3080 and return;
3081
3082 # always fsync - this file is important
3083 aio_fsync $fh
3084 and return;
3085
3086 # touch it again to show we are up-to-date
3087 aio_utime $fh, undef, undef;
3088
3089 close $fh
3090 or return;
3091
3092 aio_rename "$runtime~", $runtime
3093 and return;
3094
3095 warn "runtime file written.\n";
3096
3097 1
3098}
3099
2330sub emergency_save() { 3100sub emergency_save() {
2331 my $freeze_guard = cf::freeze_mainloop; 3101 my $freeze_guard = cf::freeze_mainloop;
2332 3102
2333 warn "enter emergency perl save\n"; 3103 warn "enter emergency perl save\n";
2334 3104
2349 my $map = $cf::MAP{$path} or next; 3119 my $map = $cf::MAP{$path} or next;
2350 $map->valid or next; 3120 $map->valid or next;
2351 $map->save; 3121 $map->save;
2352 } 3122 }
2353 warn "end emergency map save\n"; 3123 warn "end emergency map save\n";
3124
3125 warn "begin emergency database checkpoint\n";
3126 BDB::db_env_txn_checkpoint $DB_ENV;
3127 warn "end emergency database checkpoint\n";
2354 }; 3128 };
2355 3129
2356 warn "leave emergency perl save\n"; 3130 warn "leave emergency perl save\n";
2357} 3131}
2358 3132
3133sub post_cleanup {
3134 my ($make_core) = @_;
3135
3136 warn Carp::longmess "post_cleanup backtrace"
3137 if $make_core;
3138}
3139
2359sub reload() { 3140sub do_reload_perl() {
2360 # can/must only be called in main 3141 # can/must only be called in main
2361 if ($Coro::current != $Coro::main) { 3142 if ($Coro::current != $Coro::main) {
2362 warn "can only reload from main coroutine"; 3143 warn "can only reload from main coroutine";
2363 return; 3144 return;
2364 } 3145 }
2365 3146
2366 warn "reloading..."; 3147 warn "reloading...";
2367 3148
2368 warn "cancelling server ticker"; 3149 warn "entering sync_job";
2369 $TICK_WATCHER->cancel;
2370 3150
3151 cf::sync_job {
3152 cf::write_runtime; # external watchdog should not bark
2371 cf::emergency_save; 3153 cf::emergency_save;
3154 cf::write_runtime; # external watchdog should not bark
2372 3155
2373 eval { 3156 warn "syncing database to disk";
3157 BDB::db_env_txn_checkpoint $DB_ENV;
3158
2374 # if anything goes wrong in here, we should simply crash as we already saved 3159 # if anything goes wrong in here, we should simply crash as we already saved
2375
2376 warn "syncing database to disk";
2377 cf::db_sync;
2378 3160
2379 warn "cancelling all WF_AUTOCANCEL watchers"; 3161 warn "cancelling all WF_AUTOCANCEL watchers";
2380 for (Event::all_watchers) { 3162 for (Event::all_watchers) {
2381 $_->cancel if $_->data & WF_AUTOCANCEL; 3163 $_->cancel if $_->data & WF_AUTOCANCEL;
2382 } 3164 }
2383 3165
2384 warn "flushing outstanding aio requests"; 3166 warn "flushing outstanding aio requests";
2385 for (;;) { 3167 for (;;) {
3168 BDB::flush;
2386 IO::AIO::flush; 3169 IO::AIO::flush;
2387 Coro::cede; 3170 Coro::cede;
2388 last unless IO::AIO::nreqs; 3171 last unless IO::AIO::nreqs || BDB::nreqs;
2389 warn "iterate..."; 3172 warn "iterate...";
2390 } 3173 }
3174
3175 ++$RELOAD;
2391 3176
2392 warn "cancelling all extension coros"; 3177 warn "cancelling all extension coros";
2393 $_->cancel for values %EXT_CORO; 3178 $_->cancel for values %EXT_CORO;
2394 %EXT_CORO = (); 3179 %EXT_CORO = ();
2395 3180
2396 warn "removing commands"; 3181 warn "removing commands";
2397 %COMMAND = (); 3182 %COMMAND = ();
2398 3183
2399 warn "removing ext commands"; 3184 warn "removing ext/exti commands";
2400 %EXTCMD = (); 3185 %EXTCMD = ();
3186 %EXTICMD = ();
2401 3187
2402 warn "unloading/nuking all extensions"; 3188 warn "unloading/nuking all extensions";
2403 for my $pkg (@EXTS) { 3189 for my $pkg (@EXTS) {
2404 warn "... unloading $pkg"; 3190 warn "... unloading $pkg";
2405 3191
2435 Symbol::delete_package "safe::$_" 3221 Symbol::delete_package "safe::$_"
2436 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3222 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2437 3223
2438 warn "unloading cf.pm \"a bit\""; 3224 warn "unloading cf.pm \"a bit\"";
2439 delete $INC{"cf.pm"}; 3225 delete $INC{"cf.pm"};
3226 delete $INC{"cf/pod.pm"};
2440 3227
2441 # don't, removes xs symbols, too, 3228 # don't, removes xs symbols, too,
2442 # and global variables created in xs 3229 # and global variables created in xs
2443 #Symbol::delete_package __PACKAGE__; 3230 #Symbol::delete_package __PACKAGE__;
2444 3231
2447 warn "reloading cf.pm"; 3234 warn "reloading cf.pm";
2448 require cf; 3235 require cf;
2449 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3236 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
2450 3237
2451 warn "loading config and database again"; 3238 warn "loading config and database again";
2452 cf::cfg_load; 3239 cf::reload_config;
2453 cf::db_load;
2454 3240
2455 warn "loading extensions"; 3241 warn "loading extensions";
2456 cf::load_extensions; 3242 cf::load_extensions;
2457 3243
2458 warn "reattaching attachments to objects/players"; 3244 warn "reattaching attachments to objects/players";
2459 _global_reattach; 3245 _global_reattach; # objects, sockets
2460 warn "reattaching attachments to maps"; 3246 warn "reattaching attachments to maps";
2461 reattach $_ for values %MAP; 3247 reattach $_ for values %MAP;
3248 warn "reattaching attachments to players";
3249 reattach $_ for values %PLAYER;
2462 3250
2463 warn "restarting server ticker"; 3251 warn "leaving sync_job";
2464 3252
2465 $TICK_WATCHER->start; 3253 1
2466 }; 3254 } or do {
2467
2468 if ($@) {
2469 warn $@; 3255 warn $@;
2470 warn "error while reloading, exiting."; 3256 warn "error while reloading, exiting.";
2471 exit 1; 3257 exit 1;
2472 } 3258 };
2473 3259
2474 warn "reloaded"; 3260 warn "reloaded";
2475}; 3261};
2476 3262
2477our $RELOAD_WATCHER; # used only during reload 3263our $RELOAD_WATCHER; # used only during reload
2478 3264
3265sub reload_perl() {
3266 # doing reload synchronously and two reloads happen back-to-back,
3267 # coro crashes during coro_state_free->destroy here.
3268
3269 $RELOAD_WATCHER ||= Event->timer (
3270 reentrant => 0,
3271 after => 0,
3272 data => WF_AUTOCANCEL,
3273 cb => sub {
3274 do_reload_perl;
3275 undef $RELOAD_WATCHER;
3276 },
3277 );
3278}
3279
2479register_command "reload" => sub { 3280register_command "reload" => sub {
2480 my ($who, $arg) = @_; 3281 my ($who, $arg) = @_;
2481 3282
2482 if ($who->flag (FLAG_WIZ)) { 3283 if ($who->flag (FLAG_WIZ)) {
2483 $who->message ("reloading server."); 3284 $who->message ("reloading server.");
2484 3285 async { reload_perl };
2485 # doing reload synchronously and two reloads happen back-to-back,
2486 # coro crashes during coro_state_free->destroy here.
2487
2488 $RELOAD_WATCHER ||= Event->timer (
2489 reentrant => 0,
2490 after => 0,
2491 data => WF_AUTOCANCEL,
2492 cb => sub {
2493 reload;
2494 undef $RELOAD_WATCHER;
2495 },
2496 );
2497 } 3286 }
2498}; 3287};
2499 3288
2500unshift @INC, $LIBDIR; 3289unshift @INC, $LIBDIR;
2501 3290
2502my $bug_warning = 0; 3291my $bug_warning = 0;
2503 3292
3293our @WAIT_FOR_TICK;
3294our @WAIT_FOR_TICK_BEGIN;
3295
3296sub wait_for_tick {
3297 return unless $TICK_WATCHER->is_active;
3298 return if $Coro::current == $Coro::main;
3299
3300 my $signal = new Coro::Signal;
3301 push @WAIT_FOR_TICK, $signal;
3302 $signal->wait;
3303}
3304
3305sub wait_for_tick_begin {
3306 return unless $TICK_WATCHER->is_active;
3307 return if $Coro::current == $Coro::main;
3308
3309 my $signal = new Coro::Signal;
3310 push @WAIT_FOR_TICK_BEGIN, $signal;
3311 $signal->wait;
3312}
3313
3314 my $min = 1e6;#d#
3315 my $avg = 10;
2504$TICK_WATCHER = Event->timer ( 3316$TICK_WATCHER = Event->timer (
2505 reentrant => 0, 3317 reentrant => 0,
2506 parked => 1, 3318 parked => 1,
2507 prio => 0, 3319 prio => 0,
2508 at => $NEXT_TICK || $TICK, 3320 at => $NEXT_TICK || $TICK,
2512 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3324 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2513 unless ++$bug_warning > 10; 3325 unless ++$bug_warning > 10;
2514 return; 3326 return;
2515 } 3327 }
2516 3328
2517 $NOW = Event::time; 3329 $NOW = $tick_start = Event::time;
2518 3330
2519 cf::server_tick; # one server iteration 3331 cf::server_tick; # one server iteration
3332
3333 0 && sync_job {#d#
3334 for(1..10) {
3335 my $t = Event::time;
3336 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3337 or die;
3338
3339 $map->width (50);
3340 $map->height (50);
3341 $map->alloc;
3342 $map->_load_objects ("/tmp/x.map", 1);
3343 my $t = Event::time - $t;
3344
3345 #next unless $t < 0.0013;#d#
3346 if ($t < $min) {
3347 $min = $t;
3348 }
3349 $avg = $avg * 0.99 + $t * 0.01;
3350 }
3351 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3352 exit 0;
3353 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3354 };
3355
2520 $RUNTIME += $TICK; 3356 $RUNTIME += $TICK;
2521 $NEXT_TICK += $TICK; 3357 $NEXT_TICK += $TICK;
2522 3358
2523 $WAIT_FOR_TICK->broadcast; 3359 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2524 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; 3360 $NEXT_RUNTIME_WRITE = $NOW + 10;
2525 3361 Coro::async_pool {
2526 Event::sweep; 3362 write_runtime
2527 Coro::cede_notself; 3363 or warn "ERROR: unable to write runtime file: $!";
3364 };
2528 3365 }
3366
2529# my $AFTER = Event::time; 3367# my $AFTER = Event::time;
2530# warn $AFTER - $NOW;#d# 3368# warn $AFTER - $NOW;#d#
2531 3369
3370 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3371 $sig->send;
3372 }
3373 while (my $sig = shift @WAIT_FOR_TICK) {
3374 $sig->send;
3375 }
3376
3377 $NOW = Event::time;
3378
2532 # if we are delayed by four ticks or more, skip them all 3379 # if we are delayed by four ticks or more, skip them all
2533 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3380 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2534 3381
2535 $TICK_WATCHER->at ($NEXT_TICK); 3382 $TICK_WATCHER->at ($NEXT_TICK);
2536 $TICK_WATCHER->start; 3383 $TICK_WATCHER->start;
3384
3385 $LOAD = ($NOW - $tick_start) / $TICK;
3386 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3387
3388 _post_tick;
3389
3390
2537 }, 3391 },
2538); 3392);
2539 3393
3394{
3395 BDB::max_poll_time $TICK * 0.1;
3396 $BDB_POLL_WATCHER = Event->io (
3397 reentrant => 0,
3398 fd => BDB::poll_fileno,
3399 poll => 'r',
3400 prio => 0,
3401 data => WF_AUTOCANCEL,
3402 cb => \&BDB::poll_cb,
3403 );
3404 BDB::min_parallel 8;
3405
3406 BDB::set_sync_prepare {
3407 my $status;
3408 my $current = $Coro::current;
3409 (
3410 sub {
3411 $status = $!;
3412 $current->ready; undef $current;
3413 },
3414 sub {
3415 Coro::schedule while defined $current;
3416 $! = $status;
3417 },
3418 )
3419 };
3420
3421 unless ($DB_ENV) {
3422 $DB_ENV = BDB::db_env_create;
3423
3424 cf::sync_job {
3425 eval {
3426 BDB::db_env_open
3427 $DB_ENV,
3428 $BDBDIR,
3429 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3430 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3431 0666;
3432
3433 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3434
3435 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3436 $DB_ENV->set_lk_detect;
3437 };
3438
3439 cf::cleanup "db_env_open(db): $@" if $@;
3440 };
3441 }
3442}
3443
3444{
3445 IO::AIO::min_parallel 8;
3446
3447 undef $Coro::AIO::WATCHER;
2540IO::AIO::max_poll_time $TICK * 0.1; 3448 IO::AIO::max_poll_time $TICK * 0.1;
2541
2542undef $Coro::AIO::WATCHER;
2543$AIO_POLL_WATCHER = Event->io ( 3449 $AIO_POLL_WATCHER = Event->io (
2544 reentrant => 0, 3450 reentrant => 0,
3451 data => WF_AUTOCANCEL,
2545 fd => IO::AIO::poll_fileno, 3452 fd => IO::AIO::poll_fileno,
2546 poll => 'r', 3453 poll => 'r',
2547 prio => 6, 3454 prio => 6,
2548 data => WF_AUTOCANCEL,
2549 cb => \&IO::AIO::poll_cb, 3455 cb => \&IO::AIO::poll_cb,
2550); 3456 );
3457}
2551 3458
2552$WRITE_RUNTIME_WATCHER = Event->timer ( 3459my $_log_backtrace;
2553 reentrant => 0, 3460
2554 data => WF_AUTOCANCEL, 3461sub _log_backtrace {
2555 after => 1, 3462 my ($msg, @addr) = @_;
2556 interval => 10, 3463
2557 prio => 6, # keep it lowest so it acts like a watchdog 3464 $msg =~ s/\n//;
2558 cb => Coro::unblock_sub { 3465
2559 write_runtime 3466 # limit the # of concurrent backtraces
2560 or warn "ERROR: unable to write runtime file: $!"; 3467 if ($_log_backtrace < 2) {
3468 ++$_log_backtrace;
3469 async {
3470 my @bt = fork_call {
3471 @addr = map { sprintf "%x", $_ } @addr;
3472 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3473 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3474 or die "addr2line: $!";
3475
3476 my @funcs;
3477 my @res = <$fh>;
3478 chomp for @res;
3479 while (@res) {
3480 my ($func, $line) = splice @res, 0, 2, ();
3481 push @funcs, "[$func] $line";
3482 }
3483
3484 @funcs
3485 };
3486
3487 LOG llevInfo, "[ABT] $msg\n";
3488 LOG llevInfo, "[ABT] $_\n" for @bt;
3489 --$_log_backtrace;
3490 };
3491 } else {
3492 LOG llevInfo, "[ABT] $msg\n";
3493 LOG llevInfo, "[ABT] [suppressed]\n";
2561 }, 3494 }
2562); 3495}
3496
3497# load additional modules
3498use cf::pod;
2563 3499
2564END { cf::emergency_save } 3500END { cf::emergency_save }
2565 3501
25661 35021
2567 3503

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines