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.172 by root, Sun Jan 14 13:32:48 2007 UTC vs.
Revision 1.368 by root, Wed Sep 12 11:18:25 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines