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.180 by root, Fri Jan 19 00:38:02 2007 UTC vs.
Revision 1.406 by root, Mon Dec 17 08:27:44 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines