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.207 by root, Sun Feb 11 22:42:09 2007 UTC vs.
Revision 1.537 by root, Sun May 2 19:16:16 2010 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify it under
7# the terms of the Affero GNU General Public License as published by the
8# Free Software Foundation, either version 3 of the License, or (at your
9# option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the Affero GNU General Public License
17# and the GNU General Public License along with this program. If not, see
18# <http://www.gnu.org/licenses/>.
19#
20# The authors can be reached via e-mail to <support@deliantra.net>
21#
22
1package cf; 23package cf;
2 24
25use 5.10.0;
3use utf8; 26use utf8;
4use strict; 27use strict qw(vars subs);
5 28
6use Symbol; 29use Symbol;
7use List::Util; 30use List::Util;
8use Storable; 31use Socket;
32use EV;
9use Opcode; 33use Opcode;
10use Safe; 34use Safe;
11use Safe::Hole; 35use Safe::Hole;
36use Storable ();
37use Carp ();
12 38
39use Guard ();
13use Coro 3.5 (); 40use Coro ();
41use Coro::State;
42use Coro::Handle;
43use Coro::EV;
14use Coro::Event; 44use Coro::AnyEvent;
15use Coro::Timer; 45use Coro::Timer;
16use Coro::Signal; 46use Coro::Signal;
17use Coro::Semaphore; 47use Coro::Semaphore;
48use Coro::SemaphoreSet;
49use Coro::AnyEvent;
18use Coro::AIO; 50use Coro::AIO;
51use Coro::BDB 1.6;
52use Coro::Storable;
53use Coro::Util ();
19 54
55use JSON::XS 2.01 ();
20use BDB (); 56use BDB ();
21use Data::Dumper; 57use Data::Dumper;
22use Digest::MD5;
23use Fcntl; 58use Fcntl;
24use IO::AIO 2.32 ();
25use YAML::Syck (); 59use YAML::XS ();
60use IO::AIO ();
26use Time::HiRes; 61use Time::HiRes;
62use Compress::LZF;
63use Digest::MD5 ();
27 64
28use Event; $Event::Eval = 1; # no idea why this is required, but it is 65AnyEvent::detect;
66
67# configure various modules to our taste
68#
69$Storable::canonical = 1; # reduce rsync transfers
70Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
71
72$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
73
74# make sure c-lzf reinitialises itself
75Compress::LZF::set_serializer "Storable", "Storable::net_mstore", "Storable::mretrieve";
76Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
77
78# strictly for debugging
79$SIG{QUIT} = sub { Carp::cluck "SIGQUIT" };
29 80
30sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 81sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
31
32# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
33$YAML::Syck::ImplicitUnicode = 1;
34
35$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
36 82
37our %COMMAND = (); 83our %COMMAND = ();
38our %COMMAND_TIME = (); 84our %COMMAND_TIME = ();
39 85
40our @EXTS = (); # list of extension package names 86our @EXTS = (); # list of extension package names
41our %EXTCMD = (); 87our %EXTCMD = ();
88our %EXTICMD = ();
42our %EXT_CORO = (); # coroutines bound to extensions 89our %EXT_CORO = (); # coroutines bound to extensions
43our %EXT_MAP = (); # pluggable maps 90our %EXT_MAP = (); # pluggable maps
44 91
92our $RELOAD; # number of reloads so far, non-zero while in reload
45our @EVENT; 93our @EVENT;
46our $LIBDIR = datadir . "/ext"; 94our @REFLECT; # set by XS
95our %REFLECT; # set by us
47 96
48our $TICK = MAX_TIME * 1e-6; 97our $CONFDIR = confdir;
49our $TICK_WATCHER; 98our $DATADIR = datadir;
50our $AIO_POLL_WATCHER; 99our $LIBDIR = "$DATADIR/ext";
51our $WRITE_RUNTIME_WATCHER; 100our $PODDIR = "$DATADIR/pod";
101our $MAPDIR = "$DATADIR/" . mapdir;
102our $LOCALDIR = localdir;
103our $TMPDIR = "$LOCALDIR/" . tmpdir;
104our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
105our $PLAYERDIR = "$LOCALDIR/" . playerdir;
106our $RANDOMDIR = "$LOCALDIR/random";
107our $BDBDIR = "$LOCALDIR/db";
108our $PIDFILE = "$LOCALDIR/pid";
109our $RUNTIMEFILE = "$LOCALDIR/runtime";
110
111our %RESOURCE; # unused
112
113our $OUTPUT_RATE_MIN = 3000;
114our $OUTPUT_RATE_MAX = 1000000;
115
116our $MAX_LINKS = 32; # how many chained exits to follow
117our $VERBOSE_IO = 1;
118
119our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
120our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
52our $NEXT_TICK; 121our $NEXT_TICK;
53our $NOW;
54our $USE_FSYNC = 1; # use fsync to write maps - default off 122our $USE_FSYNC = 1; # use fsync to write maps - default on
55 123
124our $BDB_DEADLOCK_WATCHER;
125our $BDB_CHECKPOINT_WATCHER;
56our $BDB_POLL_WATCHER; 126our $BDB_TRICKLE_WATCHER;
57our $DB_ENV; 127our $DB_ENV;
128
129our @EXTRA_MODULES = qw(pod match mapscript);
58 130
59our %CFG; 131our %CFG;
60 132
61our $UPTIME; $UPTIME ||= time; 133our $UPTIME; $UPTIME ||= time;
62our $RUNTIME; 134our $RUNTIME;
135our $NOW;
63 136
64our %PLAYER; # all users 137our (%PLAYER, %PLAYER_LOADING); # all users
65our %MAP; # all maps 138our (%MAP, %MAP_LOADING ); # all maps
66our $LINK_MAP; # the special {link} map, which is always available 139our $LINK_MAP; # the special {link} map, which is always available
67our $RANDOM_MAPS = cf::localdir . "/random";
68our $BDB_ENV_DIR = cf::localdir . "/db";
69
70our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
71our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
72 140
73# used to convert map paths into valid unix filenames by replacing / by ∕ 141# used to convert map paths into valid unix filenames by replacing / by ∕
74our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 142our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
75 143
144our $LOAD; # a number between 0 (idle) and 1 (too many objects)
145our $LOADAVG; # same thing, but with alpha-smoothing
146our $JITTER; # average jitter
147our $TICK_START; # for load detecting purposes
148
149our @POST_INIT;
150
151our $REATTACH_ON_RELOAD; # set to true to force object reattach on reload (slow)
152our $REALLY_UNLOOP; # never set to true, please :)
153
76binmode STDOUT; 154binmode STDOUT;
77binmode STDERR; 155binmode STDERR;
78 156
79# read virtual server time, if available 157# read virtual server time, if available
80unless ($RUNTIME || !-e cf::localdir . "/runtime") { 158unless ($RUNTIME || !-e $RUNTIMEFILE) {
81 open my $fh, "<", cf::localdir . "/runtime" 159 open my $fh, "<", $RUNTIMEFILE
82 or die "unable to read runtime file: $!"; 160 or die "unable to read $RUNTIMEFILE file: $!";
83 $RUNTIME = <$fh> + 0.; 161 $RUNTIME = <$fh> + 0.;
84} 162}
85 163
86mkdir cf::localdir; 164eval "sub TICK() { $TICK } 1" or die;
87mkdir cf::localdir . "/" . cf::playerdir; 165
88mkdir cf::localdir . "/" . cf::tmpdir; 166mkdir $_
89mkdir cf::localdir . "/" . cf::uniquedir; 167 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
90mkdir $RANDOM_MAPS;
91mkdir $BDB_ENV_DIR;
92 168
93our $EMERGENCY_POSITION; 169our $EMERGENCY_POSITION;
94 170
95sub cf::map::normalise; 171sub cf::map::normalise;
172
173sub in_main() {
174 $Coro::current == $Coro::main
175}
176
177#############################################################################
178
179%REFLECT = ();
180for (@REFLECT) {
181 my $reflect = JSON::XS::decode_json $_;
182 $REFLECT{$reflect->{class}} = $reflect;
183}
184
185# this is decidedly evil
186$REFLECT{object}{flags} = { map +($_ => undef), grep $_, map /^FLAG_([A-Z0-9_]+)$/ && lc $1, keys %{"cf::"} };
96 187
97############################################################################# 188#############################################################################
98 189
99=head2 GLOBAL VARIABLES 190=head2 GLOBAL VARIABLES
100 191
107=item $cf::RUNTIME 198=item $cf::RUNTIME
108 199
109The time this server has run, starts at 0 and is increased by $cf::TICK on 200The time this server has run, starts at 0 and is increased by $cf::TICK on
110every server tick. 201every server tick.
111 202
112=item $cf::LIBDIR 203=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
204$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
205$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
113 206
114The perl library directory, where extensions and cf-specific modules can 207Various directories - "/etc", read-only install directory, perl-library
115be found. It will be added to C<@INC> automatically. 208directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
209unique-items directory, player file directory, random maps directory and
210database environment.
116 211
117=item $cf::NOW 212=item $cf::NOW
118 213
119The time of the last (current) server tick. 214The time of the last (current) server tick.
120 215
121=item $cf::TICK 216=item $cf::TICK
122 217
123The interval between server ticks, in seconds. 218The interval between server ticks, in seconds.
124 219
220=item $cf::LOADAVG
221
222The current CPU load on the server (alpha-smoothed), as a value between 0
223(none) and 1 (overloaded), indicating how much time is spent on processing
224objects per tick. Healthy values are < 0.5.
225
226=item $cf::LOAD
227
228The raw value load value from the last tick.
229
125=item %cf::CFG 230=item %cf::CFG
126 231
127Configuration for the server, loaded from C</etc/crossfire/config>, or 232Configuration for the server, loaded from C</etc/deliantra-server/config>, or
128from wherever your confdir points to. 233from wherever your confdir points to.
129 234
130=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 235=item cf::wait_for_tick, cf::wait_for_tick_begin
131 236
132These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 237These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
133or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 238returns directly I<after> the tick processing (and consequently, can only wake one process
134processing has been done. Call C<< ->wait >> on them to maximise the 239per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
135window of cpu time available, or simply to synchronise to the server tick. 240
241=item @cf::INVOKE_RESULTS
242
243This array contains the results of the last C<invoke ()> call. When
244C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
245that call.
246
247=item %cf::REFLECT
248
249Contains, for each (C++) class name, a hash reference with information
250about object members (methods, scalars, arrays and flags) and other
251metadata, which is useful for introspection.
136 252
137=back 253=back
138 254
139=cut 255=cut
140 256
141BEGIN { 257sub error(@) { LOG llevError, join "", @_ }
142 *CORE::GLOBAL::warn = sub { 258sub warn (@) { LOG llevWarn , join "", @_ }
259sub info (@) { LOG llevInfo , join "", @_ }
260sub debug(@) { LOG llevDebug, join "", @_ }
261sub trace(@) { LOG llevTrace, join "", @_ }
262
263$Coro::State::WARNHOOK = sub {
143 my $msg = join "", @_; 264 my $msg = join "", @_;
144 utf8::encode $msg;
145 265
146 $msg .= "\n" 266 $msg .= "\n"
147 unless $msg =~ /\n$/; 267 unless $msg =~ /\n$/;
148 268
269 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
270
149 LOG llevError, $msg; 271 LOG llevWarn, $msg;
150 }; 272};
151} 273
274$Coro::State::DIEHOOK = sub {
275 return unless $^S eq 0; # "eq", not "=="
276
277 error Carp::longmess $_[0];
278
279 if (in_main) {#d#
280 error "DIEHOOK called in main context, Coro bug?\n";#d#
281 return;#d#
282 }#d#
283
284 # kill coroutine otherwise
285 Coro::terminate
286};
152 287
153@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 288@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
154@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 289@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
155@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 290@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
156@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 291@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
157@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 292@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
293@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
158@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 294@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
159 295
160# we bless all objects into (empty) derived classes to force a method lookup 296# we bless all objects into (empty) derived classes to force a method lookup
161# within the Safe compartment. 297# within the Safe compartment.
162for my $pkg (qw( 298for my $pkg (qw(
163 cf::global cf::attachable 299 cf::global cf::attachable
164 cf::object cf::object::player 300 cf::object cf::object::player
165 cf::client cf::player 301 cf::client cf::player
166 cf::arch cf::living 302 cf::arch cf::living
303 cf::map cf::mapspace
167 cf::map cf::party cf::region 304 cf::party cf::region
168)) { 305)) {
169 no strict 'refs';
170 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 306 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
171} 307}
172 308
173$Event::DIED = sub { 309$EV::DIED = sub {
174 warn "error in event callback: @_"; 310 Carp::cluck "error in event callback: @_";
175}; 311};
312
313#############################################################################
176 314
177=head2 UTILITY FUNCTIONS 315=head2 UTILITY FUNCTIONS
178 316
179=over 4 317=over 4
180 318
199 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 337 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
200 $d 338 $d
201 } || "[unable to dump $_[0]: '$@']"; 339 } || "[unable to dump $_[0]: '$@']";
202} 340}
203 341
204use JSON::Syck (); # TODO# replace by JSON::PC once working
205
206=item $ref = cf::from_json $json 342=item $ref = cf::decode_json $json
207 343
208Converts a JSON string into the corresponding perl data structure. 344Converts a JSON string into the corresponding perl data structure.
209 345
210=cut
211
212sub from_json($) {
213 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
214 JSON::Syck::Load $_[0]
215}
216
217=item $json = cf::to_json $ref 346=item $json = cf::encode_json $ref
218 347
219Converts a perl data structure into its JSON representation. 348Converts a perl data structure into its JSON representation.
220 349
221=cut 350=cut
222 351
223sub to_json($) { 352our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
224 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 353
225 JSON::Syck::Dump $_[0] 354sub encode_json($) { $json_coder->encode ($_[0]) }
355sub decode_json($) { $json_coder->decode ($_[0]) }
356
357=item cf::post_init { BLOCK }
358
359Execute the given codeblock, I<after> all extensions have been (re-)loaded,
360but I<before> the server starts ticking again.
361
362The cdoeblock will have a single boolean argument to indicate whether this
363is a reload or not.
364
365=cut
366
367sub post_init(&) {
368 push @POST_INIT, shift;
226} 369}
227 370
228=item cf::lock_wait $string 371=item cf::lock_wait $string
229 372
230Wait until the given lock is available. See cf::lock_acquire. 373Wait until the given lock is available. See cf::lock_acquire.
231 374
232=item my $lock = cf::lock_acquire $string 375=item my $lock = cf::lock_acquire $string
233 376
234Wait until the given lock is available and then acquires it and returns 377Wait until the given lock is available and then acquires it and returns
235a Coro::guard object. If the guard object gets destroyed (goes out of scope, 378a L<Guard> object. If the guard object gets destroyed (goes out of scope,
236for example when the coroutine gets canceled), the lock is automatically 379for example when the coroutine gets canceled), the lock is automatically
237returned. 380returned.
238 381
382Locks are *not* recursive, locking from the same coro twice results in a
383deadlocked coro.
384
239Lock names should begin with a unique identifier (for example, cf::map::find 385Lock names should begin with a unique identifier (for example, cf::map::find
240uses map_find and cf::map::load uses map_load). 386uses map_find and cf::map::load uses map_load).
241 387
242=cut 388=item $locked = cf::lock_active $string
243 389
244our %LOCK; 390Return true if the lock is currently active, i.e. somebody has locked it.
391
392=cut
393
394our $LOCKS = new Coro::SemaphoreSet;
245 395
246sub lock_wait($) { 396sub lock_wait($) {
247 my ($key) = @_; 397 $LOCKS->wait ($_[0]);
248
249 # wait for lock, if any
250 while ($LOCK{$key}) {
251 push @{ $LOCK{$key} }, $Coro::current;
252 Coro::schedule;
253 }
254} 398}
255 399
256sub lock_acquire($) { 400sub lock_acquire($) {
257 my ($key) = @_; 401 $LOCKS->guard ($_[0])
402}
258 403
259 # wait, to be sure we are not locked 404sub lock_active($) {
260 lock_wait $key; 405 $LOCKS->count ($_[0]) < 1
261
262 $LOCK{$key} = [];
263
264 Coro::guard {
265 # wake up all waiters, to be on the safe side
266 $_->ready for @{ delete $LOCK{$key} };
267 }
268} 406}
269 407
270sub freeze_mainloop { 408sub freeze_mainloop {
271 return unless $TICK_WATCHER->is_active; 409 tick_inhibit_inc;
272 410
273 my $guard = Coro::guard { 411 &Guard::guard (\&tick_inhibit_dec);
274 $TICK_WATCHER->start; 412}
275 $WRITE_RUNTIME_WATCHER->start; 413
414=item cf::periodic $interval, $cb
415
416Like EV::periodic, but randomly selects a starting point so that the actions
417get spread over time.
418
419=cut
420
421sub periodic($$) {
422 my ($interval, $cb) = @_;
423
424 my $start = rand List::Util::min 180, $interval;
425
426 EV::periodic $start, $interval, 0, $cb
427}
428
429=item cf::get_slot $time[, $priority[, $name]]
430
431Allocate $time seconds of blocking CPU time at priority C<$priority>:
432This call blocks and returns only when you have at least C<$time> seconds
433of cpu time till the next tick. The slot is only valid till the next cede.
434
435The optional C<$name> can be used to identify the job to run. It might be
436used for statistical purposes and should identify the same time-class.
437
438Useful for short background jobs.
439
440=cut
441
442our @SLOT_QUEUE;
443our $SLOT_QUEUE;
444our $SLOT_DECAY = 0.9;
445
446$SLOT_QUEUE->cancel if $SLOT_QUEUE;
447$SLOT_QUEUE = Coro::async {
448 $Coro::current->desc ("timeslot manager");
449
450 my $signal = new Coro::Signal;
451 my $busy;
452
453 while () {
454 next_job:
455
456 my $avail = cf::till_tick;
457
458 for (0 .. $#SLOT_QUEUE) {
459 if ($SLOT_QUEUE[$_][0] <= $avail) {
460 $busy = 0;
461 my $job = splice @SLOT_QUEUE, $_, 1, ();
462 $job->[2]->send;
463 Coro::cede;
464 goto next_job;
465 } else {
466 $SLOT_QUEUE[$_][0] *= $SLOT_DECAY;
467 }
468 }
469
470 if (@SLOT_QUEUE) {
471 # we do not use wait_for_tick() as it returns immediately when tick is inactive
472 push @cf::WAIT_FOR_TICK, $signal;
473 $signal->wait;
474 } else {
475 $busy = 0;
476 Coro::schedule;
477 }
276 }; 478 }
277 $WRITE_RUNTIME_WATCHER->stop; 479};
278 $TICK_WATCHER->stop; 480
279 $guard 481sub get_slot($;$$) {
482 return if tick_inhibit || $Coro::current == $Coro::main;
483
484 my ($time, $pri, $name) = @_;
485
486 $time = clamp $time, 0.01, $TICK * .6;
487
488 my $sig = new Coro::Signal;
489
490 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
491 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
492 $SLOT_QUEUE->ready;
493 $sig->wait;
280} 494}
281 495
282=item cf::async { BLOCK } 496=item cf::async { BLOCK }
283 497
284Currently the same as Coro::async_pool, meaning you cannot use 498Currently the same as Coro::async_pool, meaning you cannot use
289 503
290BEGIN { *async = \&Coro::async_pool } 504BEGIN { *async = \&Coro::async_pool }
291 505
292=item cf::sync_job { BLOCK } 506=item cf::sync_job { BLOCK }
293 507
294The design of crossfire+ requires that the main coro ($Coro::main) is 508The design of Deliantra requires that the main coroutine ($Coro::main)
295always able to handle events or runnable, as crossfire+ is only partly 509is always able to handle events or runnable, as Deliantra is only
296reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 510partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
511acceptable.
297 512
298If it must be done, put the blocking parts into C<sync_job>. This will run 513If it must be done, put the blocking parts into C<sync_job>. This will run
299the given BLOCK in another coroutine while waiting for the result. The 514the given BLOCK in another coroutine while waiting for the result. The
300server will be frozen during this time, so the block should either finish 515server will be frozen during this time, so the block should either finish
301fast or be very important. 516fast or be very important.
303=cut 518=cut
304 519
305sub sync_job(&) { 520sub sync_job(&) {
306 my ($job) = @_; 521 my ($job) = @_;
307 522
308 if ($Coro::current == $Coro::main) { 523 if (in_main) {
524 my $time = AE::time;
525
309 # this is the main coro, too bad, we have to block 526 # this is the main coro, too bad, we have to block
310 # till the operation succeeds, freezing the server :/ 527 # till the operation succeeds, freezing the server :/
311 528
312 # TODO: use suspend/resume instead 529 #LOG llevError, Carp::longmess "sync job";#d#
313 # (but this is cancel-safe) 530
314 my $freeze_guard = freeze_mainloop; 531 my $freeze_guard = freeze_mainloop;
315 532
316 my $busy = 1; 533 my $busy = 1;
317 my @res; 534 my @res;
318 535
319 (async { 536 (async {
537 $Coro::current->desc ("sync job coro");
320 @res = eval { $job->() }; 538 @res = eval { $job->() };
321 warn $@ if $@; 539 error $@ if $@;
322 undef $busy; 540 undef $busy;
323 })->prio (Coro::PRIO_MAX); 541 })->prio (Coro::PRIO_MAX);
324 542
325 while ($busy) { 543 while ($busy) {
326 Coro::cede or Event::one_event; 544 if (Coro::nready) {
545 Coro::cede_notself;
546 } else {
547 EV::loop EV::LOOP_ONESHOT;
327 } 548 }
549 }
550
551 my $time = AE::time - $time;
552
553 $TICK_START += $time; # do not account sync jobs to server load
328 554
329 wantarray ? @res : $res[0] 555 wantarray ? @res : $res[0]
330 } else { 556 } else {
331 # we are in another coroutine, how wonderful, everything just works 557 # we are in another coroutine, how wonderful, everything just works
332 558
352 $EXT_CORO{$coro+0} = $coro; 578 $EXT_CORO{$coro+0} = $coro;
353 579
354 $coro 580 $coro
355} 581}
356 582
357sub write_runtime { 583=item fork_call { }, $args
358 my $runtime = cf::localdir . "/runtime";
359 584
360 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 585Executes the given code block with the given arguments in a seperate
361 or return; 586process, returning the results. Everything must be serialisable with
587Coro::Storable. May, of course, block. Note that the executed sub may
588never block itself or use any form of event handling.
362 589
363 my $value = $cf::RUNTIME + 90 + 10; 590=cut
364 # 10 is the runtime save interval, for a monotonic clock
365 # 60 allows for the watchdog to kill the server.
366 591
367 (aio_write $fh, 0, (length $value), $value, 0) <= 0 592sub fork_call(&@) {
368 and return; 593 my ($cb, @args) = @_;
369 594
370 # always fsync - this file is important 595 # we seemingly have to make a local copy of the whole thing,
371 aio_fsync $fh 596 # otherwise perl prematurely frees the stuff :/
372 and return; 597 # TODO: investigate and fix (likely this will be rather laborious)
373 598
374 close $fh 599 my @res = Coro::Util::fork_eval {
375 or return; 600 reset_signals;
601 &$cb
602 }, @args;
376 603
377 aio_rename "$runtime~", $runtime 604 wantarray ? @res : $res[-1]
378 and return; 605}
379 606
607sub objinfo {
380 1 608 (
609 "counter value" => cf::object::object_count,
610 "objects created" => cf::object::create_count,
611 "objects destroyed" => cf::object::destroy_count,
612 "freelist size" => cf::object::free_count,
613 "allocated objects" => cf::object::objects_size,
614 "active objects" => cf::object::actives_size,
615 )
616}
617
618=item $coin = coin_from_name $name
619
620=cut
621
622our %coin_alias = (
623 "silver" => "silvercoin",
624 "silvercoin" => "silvercoin",
625 "silvercoins" => "silvercoin",
626 "gold" => "goldcoin",
627 "goldcoin" => "goldcoin",
628 "goldcoins" => "goldcoin",
629 "platinum" => "platinacoin",
630 "platinumcoin" => "platinacoin",
631 "platinumcoins" => "platinacoin",
632 "platina" => "platinacoin",
633 "platinacoin" => "platinacoin",
634 "platinacoins" => "platinacoin",
635 "royalty" => "royalty",
636 "royalties" => "royalty",
637);
638
639sub coin_from_name($) {
640 $coin_alias{$_[0]}
641 ? cf::arch::find $coin_alias{$_[0]}
642 : undef
643}
644
645=item $value = cf::db_get $family => $key
646
647Returns a single value from the environment database.
648
649=item cf::db_put $family => $key => $value
650
651Stores the given C<$value> in the family. It can currently store binary
652data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
653
654=item $db = cf::db_table "name"
655
656Create and/or open a new database table. The string must not be "db" and must be unique
657within each server.
658
659=cut
660
661sub db_table($) {
662 cf::error "db_get called from main context"
663 if $Coro::current == $Coro::main;
664
665 my ($name) = @_;
666 my $db = BDB::db_create $DB_ENV;
667
668 eval {
669 $db->set_flags (BDB::CHKSUM);
670
671 utf8::encode $name;
672 BDB::db_open $db, undef, $name, undef, BDB::BTREE,
673 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
674 cf::cleanup "db_open(db): $!" if $!;
675 };
676 cf::cleanup "db_open(db): $@" if $@;
677
678 $db
679}
680
681our $DB;
682
683sub db_init {
684 $DB ||= db_table "db";
685}
686
687sub db_get($$) {
688 my $key = "$_[0]/$_[1]";
689
690 cf::error "db_get called from main context"
691 if $Coro::current == $Coro::main;
692
693 BDB::db_get $DB, undef, $key, my $data;
694
695 $! ? ()
696 : $data
697}
698
699sub db_put($$$) {
700 BDB::dbreq_pri 4;
701 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
702}
703
704=item cf::cache $id => [$paths...], $processversion => $process
705
706Generic caching function that returns the value of the resource $id,
707caching and regenerating as required.
708
709This function can block.
710
711=cut
712
713sub cache {
714 my ($id, $src, $processversion, $process) = @_;
715
716 my $meta =
717 join "\x00",
718 $processversion,
719 map {
720 aio_stat $_
721 and Carp::croak "$_: $!";
722
723 ($_, (stat _)[7,9])
724 } @$src;
725
726 my $dbmeta = db_get cache => "$id/meta";
727 if ($dbmeta ne $meta) {
728 # changed, we may need to process
729
730 my @data;
731 my $md5;
732
733 for (0 .. $#$src) {
734 0 <= aio_load $src->[$_], $data[$_]
735 or Carp::croak "$src->[$_]: $!";
736 }
737
738 # if processing is expensive, check
739 # checksum first
740 if (1) {
741 $md5 =
742 join "\x00",
743 $processversion,
744 map {
745 cf::cede_to_tick;
746 ($src->[$_], Digest::MD5::md5_hex $data[$_])
747 } 0.. $#$src;
748
749
750 my $dbmd5 = db_get cache => "$id/md5";
751 if ($dbmd5 eq $md5) {
752 db_put cache => "$id/meta", $meta;
753
754 return db_get cache => "$id/data";
755 }
756 }
757
758 my $t1 = Time::HiRes::time;
759 my $data = $process->(\@data);
760 my $t2 = Time::HiRes::time;
761
762 info "cache: '$id' processed in ", $t2 - $t1, "s\n";
763
764 db_put cache => "$id/data", $data;
765 db_put cache => "$id/md5" , $md5;
766 db_put cache => "$id/meta", $meta;
767
768 return $data;
769 }
770
771 db_get cache => "$id/data"
772}
773
774=item cf::datalog type => key => value, ...
775
776Log a datalog packet of the given type with the given key-value pairs.
777
778=cut
779
780sub datalog($@) {
781 my ($type, %kv) = @_;
782 info "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
381} 783}
382 784
383=back 785=back
384 786
385=cut 787=cut
386 788
387############################################################################# 789#############################################################################
388 790
389=head2 ATTACHABLE OBJECTS 791=head2 ATTACHABLE OBJECTS
390 792
391Many objects in crossfire are so-called attachable objects. That means you can 793Many objects in deliantra are so-called attachable objects. That means you can
392attach callbacks/event handlers (a collection of which is called an "attachment") 794attach callbacks/event handlers (a collection of which is called an "attachment")
393to it. All such attachable objects support the following methods. 795to it. All such attachable objects support the following methods.
394 796
395In the following description, CLASS can be any of C<global>, C<object> 797In the following description, CLASS can be any of C<global>, C<object>
396C<player>, C<client> or C<map> (i.e. the attachable objects in 798C<player>, C<client> or C<map> (i.e. the attachable objects in
397crossfire+). 799Deliantra).
398 800
399=over 4 801=over 4
400 802
401=item $attachable->attach ($attachment, key => $value...) 803=item $attachable->attach ($attachment, key => $value...)
402 804
446=item cf::CLASS::attachment $name, ... 848=item cf::CLASS::attachment $name, ...
447 849
448Register an attachment by C<$name> through which attachable objects of the 850Register an attachment by C<$name> through which attachable objects of the
449given CLASS can refer to this attachment. 851given CLASS can refer to this attachment.
450 852
451Some classes such as crossfire maps and objects can specify attachments 853Some classes such as deliantra maps and objects can specify attachments
452that are attached at load/instantiate time, thus the need for a name. 854that are attached at load/instantiate time, thus the need for a name.
453 855
454These calls expect any number of the following handler/hook descriptions: 856These calls expect any number of the following handler/hook descriptions:
455 857
456=over 4 858=over 4
565 $registry = $CB_TYPE[$object_type] ||= []; 967 $registry = $CB_TYPE[$object_type] ||= [];
566 968
567 } elsif ($type eq "subtype") { 969 } elsif ($type eq "subtype") {
568 defined $object_type or Carp::croak "subtype specified without type"; 970 defined $object_type or Carp::croak "subtype specified without type";
569 my $object_subtype = shift @arg; 971 my $object_subtype = shift @arg;
570 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 972 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
571 973
572 } elsif ($type eq "package") { 974 } elsif ($type eq "package") {
573 my $pkg = shift @arg; 975 my $pkg = shift @arg;
574 976
575 while (my ($name, $id) = each %cb_id) { 977 while (my ($name, $id) = each %cb_id) {
580 982
581 } elsif (exists $cb_id{$type}) { 983 } elsif (exists $cb_id{$type}) {
582 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; 984 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
583 985
584 } elsif (ref $type) { 986 } elsif (ref $type) {
585 warn "attaching objects not supported, ignoring.\n"; 987 error "attaching objects not supported, ignoring.\n";
586 988
587 } else { 989 } else {
588 shift @arg; 990 shift @arg;
589 warn "attach argument '$type' not supported, ignoring.\n"; 991 error "attach argument '$type' not supported, ignoring.\n";
590 } 992 }
591 } 993 }
592} 994}
593 995
594sub _object_attach { 996sub _object_attach {
604 _attach $registry, $klass, @attach; 1006 _attach $registry, $klass, @attach;
605 } 1007 }
606 1008
607 $obj->{$name} = \%arg; 1009 $obj->{$name} = \%arg;
608 } else { 1010 } else {
609 warn "object uses attachment '$name' that is not available, postponing.\n"; 1011 info "object uses attachment '$name' which is not available, postponing.\n";
610 } 1012 }
611 1013
612 $obj->{_attachment}{$name} = undef; 1014 $obj->{_attachment}{$name} = undef;
613} 1015}
614 1016
616 if (ref $_[0]) { 1018 if (ref $_[0]) {
617 _object_attach @_; 1019 _object_attach @_;
618 } else { 1020 } else {
619 _attach shift->_attach_registry, @_; 1021 _attach shift->_attach_registry, @_;
620 } 1022 }
1023 _recalc_want;
621}; 1024};
622 1025
623# all those should be optimised 1026# all those should be optimised
624sub cf::attachable::detach { 1027sub cf::attachable::detach {
625 my ($obj, $name) = @_; 1028 my ($obj, $name) = @_;
628 delete $obj->{_attachment}{$name}; 1031 delete $obj->{_attachment}{$name};
629 reattach ($obj); 1032 reattach ($obj);
630 } else { 1033 } else {
631 Carp::croak "cannot, currently, detach class attachments"; 1034 Carp::croak "cannot, currently, detach class attachments";
632 } 1035 }
1036 _recalc_want;
633}; 1037};
634 1038
635sub cf::attachable::attached { 1039sub cf::attachable::attached {
636 my ($obj, $name) = @_; 1040 my ($obj, $name) = @_;
637 1041
652 "; 1056 ";
653 die if $@; 1057 die if $@;
654} 1058}
655 1059
656our $override; 1060our $override;
657our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 1061our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
658 1062
659sub override { 1063sub override {
660 $override = 1; 1064 $override = 1;
661 @invoke_results = (); 1065 @INVOKE_RESULTS = (@_);
662} 1066}
663 1067
664sub do_invoke { 1068sub do_invoke {
665 my $event = shift; 1069 my $event = shift;
666 my $callbacks = shift; 1070 my $callbacks = shift;
667 1071
668 @invoke_results = (); 1072 @INVOKE_RESULTS = ();
669 1073
670 local $override; 1074 local $override;
671 1075
672 for (@$callbacks) { 1076 for (@$callbacks) {
673 eval { &{$_->[1]} }; 1077 eval { &{$_->[1]} };
674 1078
675 if ($@) { 1079 if ($@) {
676 warn "$@";
677 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; 1080 error "$@", "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
678 override; 1081 override;
679 } 1082 }
680 1083
681 return 1 if $override; 1084 return 1 if $override;
682 } 1085 }
683 1086
684 0 1087 0
685} 1088}
686 1089
687=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1090=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
688 1091
689=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1092=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
690 1093
691Generate an object-specific event with the given arguments. 1094Generate an object-specific event with the given arguments.
692 1095
693This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 1096This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
694removed in future versions), and there is no public API to access override 1097removed in future versions), and there is no public API to access override
695results (if you must, access C<@cf::invoke_results> directly). 1098results (if you must, access C<@cf::INVOKE_RESULTS> directly).
696 1099
697=back 1100=back
698 1101
699=cut 1102=cut
700 1103
701############################################################################# 1104#############################################################################
702# object support 1105# object support
1106
1107sub _object_equal($$);
1108sub _object_equal($$) {
1109 my ($a, $b) = @_;
1110
1111 return 0 unless (ref $a) eq (ref $b);
1112
1113 if ("HASH" eq ref $a) {
1114 my @ka = keys %$a;
1115 my @kb = keys %$b;
1116
1117 return 0 if @ka != @kb;
1118
1119 for (0 .. $#ka) {
1120 return 0 unless $ka[$_] eq $kb[$_];
1121 return 0 unless _object_equal $a->{$ka[$_]}, $b->{$kb[$_]};
1122 }
1123
1124 } elsif ("ARRAY" eq ref $a) {
1125
1126 return 0 if @$a != @$b;
1127
1128 for (0 .. $#$a) {
1129 return 0 unless _object_equal $a->[$_], $b->[$_];
1130 }
1131
1132 } elsif ($a ne $b) {
1133 return 0;
1134 }
1135
1136 1
1137}
1138
1139our $SLOW_MERGES;#d#
1140sub _can_merge {
1141 my ($ob1, $ob2) = @_;
1142
1143 ++$SLOW_MERGES;#d#
1144
1145 # we do the slow way here
1146 return _object_equal $ob1, $ob2
1147}
703 1148
704sub reattach { 1149sub reattach {
705 # basically do the same as instantiate, without calling instantiate 1150 # basically do the same as instantiate, without calling instantiate
706 my ($obj) = @_; 1151 my ($obj) = @_;
707 1152
1153 # no longer needed after getting rid of delete_package?
708 bless $obj, ref $obj; # re-bless in case extensions have been reloaded 1154 #bless $obj, ref $obj; # re-bless in case extensions have been reloaded
709 1155
710 my $registry = $obj->registry; 1156 my $registry = $obj->registry;
711 1157
712 @$registry = (); 1158 @$registry = ();
713 1159
718 for (@$attach) { 1164 for (@$attach) {
719 my ($klass, @attach) = @$_; 1165 my ($klass, @attach) = @$_;
720 _attach $registry, $klass, @attach; 1166 _attach $registry, $klass, @attach;
721 } 1167 }
722 } else { 1168 } else {
723 warn "object uses attachment '$name' that is not available, postponing.\n"; 1169 info "object uses attachment '$name' that is not available, postponing.\n";
724 } 1170 }
725 } 1171 }
726} 1172}
727 1173
728cf::attachable->attach ( 1174cf::attachable->attach (
729 prio => -1000000, 1175 prio => -1000000,
730 on_instantiate => sub { 1176 on_instantiate => sub {
731 my ($obj, $data) = @_; 1177 my ($obj, $data) = @_;
732 1178
733 $data = from_json $data; 1179 $data = decode_json $data;
734 1180
735 for (@$data) { 1181 for (@$data) {
736 my ($name, $args) = @$_; 1182 my ($name, $args) = @$_;
737 1183
738 $obj->attach ($name, %{$args || {} }); 1184 $obj->attach ($name, %{$args || {} });
754sub object_freezer_save { 1200sub object_freezer_save {
755 my ($filename, $rdata, $objs) = @_; 1201 my ($filename, $rdata, $objs) = @_;
756 1202
757 sync_job { 1203 sync_job {
758 if (length $$rdata) { 1204 if (length $$rdata) {
1205 utf8::decode (my $decname = $filename);
759 warn sprintf "saving %s (%d,%d)\n", 1206 trace sprintf "saving %s (%d,%d)\n",
760 $filename, length $$rdata, scalar @$objs; 1207 $decname, length $$rdata, scalar @$objs
1208 if $VERBOSE_IO;
761 1209
762 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1210 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
763 chmod SAVE_MODE, $fh; 1211 aio_chmod $fh, SAVE_MODE;
764 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1212 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
765 aio_fsync $fh if $cf::USE_FSYNC; 1213 if ($cf::USE_FSYNC) {
1214 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
1215 aio_fsync $fh;
1216 }
766 close $fh; 1217 aio_close $fh;
767 1218
768 if (@$objs) { 1219 if (@$objs) {
769 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { 1220 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
770 chmod SAVE_MODE, $fh; 1221 aio_chmod $fh, SAVE_MODE;
771 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1222 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
772 aio_write $fh, 0, (length $data), $data, 0; 1223 aio_write $fh, 0, (length $data), $data, 0;
773 aio_fsync $fh if $cf::USE_FSYNC; 1224 if ($cf::USE_FSYNC) {
1225 aio_sync_file_range $fh, 0, 0, IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE | IO::AIO::SYNC_FILE_RANGE_WRITE | IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER;
1226 aio_fsync $fh;
1227 }
774 close $fh; 1228 aio_close $fh;
775 aio_rename "$filename.pst~", "$filename.pst"; 1229 aio_rename "$filename.pst~", "$filename.pst";
776 } 1230 }
777 } else { 1231 } else {
778 aio_unlink "$filename.pst"; 1232 aio_unlink "$filename.pst";
779 } 1233 }
780 1234
781 aio_rename "$filename~", $filename; 1235 aio_rename "$filename~", $filename;
1236
1237 $filename =~ s%/[^/]+$%%;
1238 aio_pathsync $filename if $cf::USE_FSYNC;
782 } else { 1239 } else {
783 warn "FATAL: $filename~: $!\n"; 1240 error "unable to save objects: $filename~: $!\n";
784 } 1241 }
785 } else { 1242 } else {
786 aio_unlink $filename; 1243 aio_unlink $filename;
787 aio_unlink "$filename.pst"; 1244 aio_unlink "$filename.pst";
788 } 1245 }
789
790 #d##TODO# nuke non .map-files if exist
791 if ($filename =~ s/\.map$//) {
792 aio_unlink $filename;
793 aio_unlink "$filename.pst";
794 }
795 } 1246 };
796} 1247}
797 1248
798sub object_freezer_as_string { 1249sub object_freezer_as_string {
799 my ($rdata, $objs) = @_; 1250 my ($rdata, $objs) = @_;
800 1251
805 1256
806sub object_thawer_load { 1257sub object_thawer_load {
807 my ($filename) = @_; 1258 my ($filename) = @_;
808 1259
809 my ($data, $av); 1260 my ($data, $av);
810
811 #d#TODO remove .map if file does not exist
812 aio_stat $filename and $filename =~ s/\.map$//;
813 1261
814 (aio_load $filename, $data) >= 0 1262 (aio_load $filename, $data) >= 0
815 or return; 1263 or return;
816 1264
817 unless (aio_stat "$filename.pst") { 1265 unless (aio_stat "$filename.pst") {
818 (aio_load "$filename.pst", $av) >= 0 1266 (aio_load "$filename.pst", $av) >= 0
819 or return; 1267 or return;
1268
820 $av = eval { (Storable::thaw $av)->{objs} }; 1269 my $st = eval { Coro::Storable::thaw $av };
1270 $av = $st->{objs};
821 } 1271 }
822 1272
1273 utf8::decode (my $decname = $filename);
823 warn sprintf "loading %s (%d)\n", 1274 trace sprintf "loading %s (%d,%d)\n",
824 $filename, length $data, scalar @{$av || []};#d# 1275 $decname, length $data, scalar @{$av || []}
1276 if $VERBOSE_IO;
1277
825 return ($data, $av); 1278 ($data, $av)
826} 1279}
1280
1281=head2 COMMAND CALLBACKS
1282
1283=over 4
1284
1285=cut
827 1286
828############################################################################# 1287#############################################################################
829# command handling &c 1288# command handling &c
830 1289
831=item cf::register_command $name => \&callback($ob,$args); 1290=item cf::register_command $name => \&callback($ob,$args);
844 push @{ $COMMAND{$name} }, [$caller, $cb]; 1303 push @{ $COMMAND{$name} }, [$caller, $cb];
845} 1304}
846 1305
847=item cf::register_extcmd $name => \&callback($pl,$packet); 1306=item cf::register_extcmd $name => \&callback($pl,$packet);
848 1307
849Register a callbackf ro execution when the client sends an extcmd packet. 1308Register a callback for execution when the client sends an (synchronous)
1309extcmd packet. Ext commands will be processed in the order they are
1310received by the server, like other user commands. The first argument is
1311the logged-in player. Ext commands can only be processed after a player
1312has logged in successfully.
850 1313
851If the callback returns something, it is sent back as if reply was being 1314If the callback returns something, it is sent back as if reply was being
852called. 1315called.
853 1316
1317=item cf::register_exticmd $name => \&callback($ns,$packet);
1318
1319Register a callback for execution when the client sends an (asynchronous)
1320exticmd packet. Exti commands are processed by the server as soon as they
1321are received, i.e. out of order w.r.t. other commands. The first argument
1322is a client socket. Exti commands can be received anytime, even before
1323log-in.
1324
1325If the callback returns something, it is sent back as if reply was being
1326called.
1327
854=cut 1328=cut
855 1329
856sub register_extcmd { 1330sub register_extcmd {
857 my ($name, $cb) = @_; 1331 my ($name, $cb) = @_;
858 1332
859 $EXTCMD{$name} = $cb; 1333 $EXTCMD{$name} = $cb;
860} 1334}
861 1335
1336sub register_exticmd {
1337 my ($name, $cb) = @_;
1338
1339 $EXTICMD{$name} = $cb;
1340}
1341
1342use File::Glob ();
1343
862cf::player->attach ( 1344cf::player->attach (
863 on_command => sub { 1345 on_unknown_command => sub {
864 my ($pl, $name, $params) = @_; 1346 my ($pl, $name, $params) = @_;
865 1347
866 my $cb = $COMMAND{$name} 1348 my $cb = $COMMAND{$name}
867 or return; 1349 or return;
868 1350
873 cf::override; 1355 cf::override;
874 }, 1356 },
875 on_extcmd => sub { 1357 on_extcmd => sub {
876 my ($pl, $buf) = @_; 1358 my ($pl, $buf) = @_;
877 1359
878 my $msg = eval { from_json $buf }; 1360 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
879 1361
880 if (ref $msg) { 1362 if (ref $msg) {
1363 my ($type, $reply, @payload) =
1364 "ARRAY" eq ref $msg
1365 ? @$msg
1366 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1367
1368 my @reply;
1369
881 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1370 if (my $cb = $EXTCMD{$type}) {
882 if (my %reply = $cb->($pl, $msg)) { 1371 @reply = $cb->($pl, @payload);
883 $pl->ext_reply ($msg->{msgid}, %reply);
884 }
885 } 1372 }
1373
1374 $pl->ext_reply ($reply, @reply)
1375 if $reply;
1376
886 } else { 1377 } else {
887 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1378 error "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
888 } 1379 }
889 1380
890 cf::override; 1381 cf::override;
891 }, 1382 },
892); 1383);
893 1384
1385# "readahead" all extensions
894sub load_extension { 1386sub cache_extensions {
895 my ($path) = @_; 1387 my $grp = IO::AIO::aio_group;
896 1388
897 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1389 add $grp IO::AIO::aio_readdirx $LIBDIR, IO::AIO::READDIR_STAT_ORDER, sub {
898 my $base = $1; 1390 for (grep /\.ext$/, @{$_[0]}) {
899 my $pkg = $1; 1391 add $grp IO::AIO::aio_load "$LIBDIR/$_", my $data;
900 $pkg =~ s/[^[:word:]]/_/g;
901 $pkg = "ext::$pkg";
902
903 warn "... loading '$path' into '$pkg'\n";
904
905 open my $fh, "<:utf8", $path
906 or die "$path: $!";
907
908 my $source =
909 "package $pkg; use strict; use utf8;\n"
910 . "#line 1 \"$path\"\n{\n"
911 . (do { local $/; <$fh> })
912 . "\n};\n1";
913
914 unless (eval $source) {
915 my $msg = $@ ? "$path: $@\n"
916 : "extension disabled.\n";
917 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
918 warn $@;
919 warn "mandatory extension failed to load, exiting.\n";
920 exit 1;
921 } 1392 }
922 die $@;
923 } 1393 };
924 1394
925 push @EXTS, $pkg; 1395 $grp
926} 1396}
927 1397
928sub load_extensions { 1398sub load_extensions {
1399 info "loading extensions...";
1400
1401 cf::sync_job {
1402 my %todo;
1403
929 for my $ext (<$LIBDIR/*.ext>) { 1404 for my $path (<$LIBDIR/*.ext>) {
930 next unless -r $ext; 1405 next unless -r $path;
931 eval { 1406
932 load_extension $ext; 1407 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1408 my $base = $1;
1409 my $pkg = $1;
1410 $pkg =~ s/[^[:word:]]/_/g;
1411 $pkg = "ext::$pkg";
1412
1413 open my $fh, "<:utf8", $path
1414 or die "$path: $!";
1415
1416 my $source = do { local $/; <$fh> };
1417
1418 my %ext = (
1419 path => $path,
1420 base => $base,
1421 pkg => $pkg,
1422 );
1423
1424 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1425 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1426
1427 $ext{source} =
1428 "package $pkg; use 5.10.0; use strict 'vars', 'subs'; use utf8;\n"
1429 . "#line 1 \"$path\"\n{\n"
1430 . $source
1431 . "\n};\n1";
1432
1433 $todo{$base} = \%ext;
1434 }
1435
1436 my $pass = 0;
1437 my %done;
1438 while (%todo) {
1439 my $progress;
1440
1441 ++$pass;
1442
1443 ext:
1444 while (my ($k, $v) = each %todo) {
1445 for (split /,\s*/, $v->{meta}{depends}) {
1446 next ext
1447 unless exists $done{$_};
1448 }
1449
1450 trace "... pass $pass, loading '$k' into '$v->{pkg}'\n";
1451
1452 my $active = eval $v->{source};
1453
1454 if (length $@) {
1455 error "$v->{path}: $@\n";
1456
1457 cf::cleanup "mandatory extension '$k' failed to load, exiting."
1458 if exists $v->{meta}{mandatory};
1459
1460 warn "$v->{base}: optional extension cannot be loaded, skipping.\n";
1461 delete $todo{$k};
1462 } else {
1463 $done{$k} = delete $todo{$k};
1464 push @EXTS, $v->{pkg};
1465 $progress = 1;
1466
1467 info "$v->{base}: extension inactive.\n"
1468 unless $active;
1469 }
933 1 1470 }
934 } or warn "$ext not loaded: $@"; 1471
1472 unless ($progress) {
1473 warn "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n";
1474
1475 while (my ($k, $v) = each %todo) {
1476 cf::cleanup "mandatory extension '$k' has unresolved dependencies, exiting."
1477 if exists $v->{meta}{mandatory};
1478 }
1479 }
1480 }
935 } 1481 };
936} 1482}
937 1483
938############################################################################# 1484#############################################################################
939 1485
1486=back
1487
940=head2 CORE EXTENSIONS 1488=head2 CORE EXTENSIONS
941 1489
942Functions and methods that extend core crossfire objects. 1490Functions and methods that extend core deliantra objects.
943 1491
944=cut 1492=cut
945 1493
946package cf::player; 1494package cf::player;
947 1495
949 1497
950=head3 cf::player 1498=head3 cf::player
951 1499
952=over 4 1500=over 4
953 1501
1502=item cf::player::num_playing
1503
1504Returns the official number of playing players, as per the Crossfire metaserver rules.
1505
1506=cut
1507
1508sub num_playing {
1509 scalar grep
1510 $_->ob->map
1511 && !$_->hidden
1512 && !$_->ob->flag (cf::FLAG_WIZ),
1513 cf::player::list
1514}
1515
954=item cf::player::find $login 1516=item cf::player::find $login
955 1517
956Returns the given player object, loading it if necessary (might block). 1518Returns the given player object, loading it if necessary (might block).
957 1519
958=cut 1520=cut
959 1521
960sub playerdir($) { 1522sub playerdir($) {
961 cf::localdir 1523 "$PLAYERDIR/"
962 . "/"
963 . cf::playerdir
964 . "/"
965 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1524 . (ref $_[0] ? $_[0]->ob->name : $_[0])
966} 1525}
967 1526
968sub path($) { 1527sub path($) {
969 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1528 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
970 1529
971 (playerdir $login) . "/$login.pl" 1530 (playerdir $login) . "/playerdata"
972} 1531}
973 1532
974sub find_active($) { 1533sub find_active($) {
975 $cf::PLAYER{$_[0]} 1534 $cf::PLAYER{$_[0]}
976 and $cf::PLAYER{$_[0]}->active 1535 and $cf::PLAYER{$_[0]}->active
979 1538
980sub exists($) { 1539sub exists($) {
981 my ($login) = @_; 1540 my ($login) = @_;
982 1541
983 $cf::PLAYER{$login} 1542 $cf::PLAYER{$login}
984 or cf::sync_job { !aio_stat path $login } 1543 or !aio_stat path $login
985} 1544}
986 1545
987sub find($) { 1546sub find($) {
988 return $cf::PLAYER{$_[0]} || do { 1547 return $cf::PLAYER{$_[0]} || do {
989 my $login = $_[0]; 1548 my $login = $_[0];
990 1549
991 my $guard = cf::lock_acquire "user_find:$login"; 1550 my $guard = cf::lock_acquire "user_find:$login";
992 1551
993 $cf::PLAYER{$_[0]} || do { 1552 $cf::PLAYER{$_[0]} || do {
994 my $pl = load_pl path $login 1553 # rename old playerfiles to new ones
1554 #TODO: remove when no longer required
1555 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1556 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1557 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1558 aio_unlink +(playerdir $login) . "/$login.pl";
1559
1560 my $f = new_from_file cf::object::thawer path $login
995 or return; 1561 or return;
1562
1563 my $pl = cf::player::load_pl $f
1564 or return;
1565
1566 local $cf::PLAYER_LOADING{$login} = $pl;
1567 $f->resolve_delayed_derefs;
996 $cf::PLAYER{$login} = $pl 1568 $cf::PLAYER{$login} = $pl
997 } 1569 }
998 } 1570 }
999} 1571}
1572
1573cf::player->attach (
1574 on_load => sub {
1575 my ($pl, $path) = @_;
1576
1577 # restore slots saved in save, below
1578 my $slots = delete $pl->{_slots};
1579
1580 $pl->ob->current_weapon ($slots->[0]);
1581 $pl->combat_ob ($slots->[1]);
1582 $pl->ranged_ob ($slots->[2]);
1583 },
1584);
1000 1585
1001sub save($) { 1586sub save($) {
1002 my ($pl) = @_; 1587 my ($pl) = @_;
1003 1588
1004 return if $pl->{deny_save}; 1589 return if $pl->{deny_save};
1009 return if $pl->{deny_save}; 1594 return if $pl->{deny_save};
1010 1595
1011 aio_mkdir playerdir $pl, 0770; 1596 aio_mkdir playerdir $pl, 0770;
1012 $pl->{last_save} = $cf::RUNTIME; 1597 $pl->{last_save} = $cf::RUNTIME;
1013 1598
1599 cf::get_slot 0.01;
1600
1601 # save slots, to be restored later
1602 local $pl->{_slots} = [$pl->ob->current_weapon, $pl->combat_ob, $pl->ranged_ob];
1603
1014 $pl->save_pl ($path); 1604 $pl->save_pl ($path);
1015 Coro::cede; 1605 cf::cede_to_tick;
1016} 1606}
1017 1607
1018sub new($) { 1608sub new($) {
1019 my ($login) = @_; 1609 my ($login) = @_;
1020 1610
1026 $cf::PLAYER{$login} = $self; 1616 $cf::PLAYER{$login} = $self;
1027 1617
1028 $self 1618 $self
1029} 1619}
1030 1620
1621=item $player->send_msg ($channel, $msg, $color, [extra...])
1622
1623=cut
1624
1625sub send_msg {
1626 my $ns = shift->ns
1627 or return;
1628 $ns->send_msg (@_);
1629}
1630
1031=item $pl->quit_character 1631=item $pl->quit_character
1032 1632
1033Nukes the player without looking back. If logged in, the connection will 1633Nukes the player without looking back. If logged in, the connection will
1034be destroyed. May block for a long time. 1634be destroyed. May block for a long time.
1035 1635
1036=cut 1636=cut
1037 1637
1038sub quit_character { 1638sub quit_character {
1039 my ($pl) = @_; 1639 my ($pl) = @_;
1040 1640
1641 my $name = $pl->ob->name;
1642
1041 $pl->{deny_save} = 1; 1643 $pl->{deny_save} = 1;
1042 $pl->password ("*"); # this should lock out the player until we nuked the dir 1644 $pl->password ("*"); # this should lock out the player until we have nuked the dir
1043 1645
1044 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; 1646 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1045 $pl->deactivate; 1647 $pl->deactivate;
1648 my $killer = cf::arch::get "killer_quit"; $pl->killer ($killer); $killer->destroy;
1046 $pl->invoke (cf::EVENT_PLAYER_QUIT); 1649 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1047 $pl->ns->destroy if $pl->ns; 1650 $pl->ns->destroy if $pl->ns;
1048 1651
1049 my $path = playerdir $pl; 1652 my $path = playerdir $pl;
1050 my $temp = "$path~$cf::RUNTIME~deleting~"; 1653 my $temp = "$path~$cf::RUNTIME~deleting~";
1051 aio_rename $path, $temp; 1654 aio_rename $path, $temp;
1052 delete $cf::PLAYER{$pl->ob->name}; 1655 delete $cf::PLAYER{$pl->ob->name};
1053 $pl->destroy; 1656 $pl->destroy;
1657
1658 my $prefix = qr<^~\Q$name\E/>;
1659
1660 # nuke player maps
1661 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1662
1054 IO::AIO::aio_rmtree $temp; 1663 IO::AIO::aio_rmtree $temp;
1664}
1665
1666=item $pl->kick
1667
1668Kicks a player out of the game. This destroys the connection.
1669
1670=cut
1671
1672sub kick {
1673 my ($pl, $kicker) = @_;
1674
1675 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1676 $pl->killer ("kicked");
1677 $pl->ns->destroy;
1055} 1678}
1056 1679
1057=item cf::player::list_logins 1680=item cf::player::list_logins
1058 1681
1059Returns am arrayref of all valid playernames in the system, can take a 1682Returns am arrayref of all valid playernames in the system, can take a
1060while and may block, so not sync_job-capable, ever. 1683while and may block, so not sync_job-capable, ever.
1061 1684
1062=cut 1685=cut
1063 1686
1064sub list_logins { 1687sub list_logins {
1065 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1688 my $dirs = aio_readdir $PLAYERDIR
1066 or return []; 1689 or return [];
1067 1690
1068 my @logins; 1691 my @logins;
1069 1692
1070 for my $login (@$dirs) { 1693 for my $login (@$dirs) {
1694 my $path = path $login;
1695
1696 # a .pst is a dead give-away for a valid player
1697 # if no pst file found, open and chekc for blocked users
1698 if (aio_stat "$path.pst") {
1071 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; 1699 my $fh = aio_open $path, Fcntl::O_RDONLY, 0 or next;
1072 aio_read $fh, 0, 512, my $buf, 0 or next; 1700 aio_read $fh, 0, 512, my $buf, 0 or next;
1073 $buf !~ /^password -------------$/m or next; # official not-valid tag 1701 $buf !~ /^password -------------$/m or next; # official not-valid tag
1702 }
1074 1703
1075 utf8::decode $login; 1704 utf8::decode $login;
1076 push @logins, $login; 1705 push @logins, $login;
1077 } 1706 }
1078 1707
1079 \@logins 1708 \@logins
1080} 1709}
1081 1710
1082=item $player->maps 1711=item $player->maps
1712
1713=item cf::player::maps $login
1083 1714
1084Returns an arrayref of map paths that are private for this 1715Returns an arrayref of map paths that are private for this
1085player. May block. 1716player. May block.
1086 1717
1087=cut 1718=cut
1105 } 1736 }
1106 1737
1107 \@paths 1738 \@paths
1108} 1739}
1109 1740
1741=item $protocol_xml = $player->expand_cfpod ($cfpod)
1742
1743Expand deliantra pod fragments into protocol xml.
1744
1110=item $player->ext_reply ($msgid, $msgtype, %msg) 1745=item $player->ext_reply ($msgid, @msg)
1111 1746
1112Sends an ext reply to the player. 1747Sends an ext reply to the player.
1113 1748
1114=cut 1749=cut
1115 1750
1116sub ext_reply($$$%) { 1751sub ext_reply($$@) {
1117 my ($self, $id, %msg) = @_; 1752 my ($self, $id, @msg) = @_;
1118 1753
1119 $msg{msgid} = $id; 1754 $self->ns->ext_reply ($id, @msg)
1120
1121 $self->send ("ext " . cf::to_json \%msg);
1122} 1755}
1123 1756
1124package cf; 1757=item $player->ext_msg ($type, @msg)
1758
1759Sends an ext event to the client.
1760
1761=cut
1762
1763sub ext_msg($$@) {
1764 my ($self, $type, @msg) = @_;
1765
1766 $self->ns->ext_msg ($type, @msg);
1767}
1768
1769=head3 cf::region
1770
1771=over 4
1772
1773=cut
1774
1775package cf::region;
1776
1777=item cf::region::find_by_path $path
1778
1779Tries to decuce the likely region for a map knowing only its path.
1780
1781=cut
1782
1783sub find_by_path($) {
1784 my ($path) = @_;
1785
1786 $path =~ s/^~[^\/]*//; # skip ~login
1787
1788 my ($match, $specificity);
1789
1790 for my $region (list) {
1791 if ($region->{match} && $path =~ $region->{match}) {
1792 ($match, $specificity) = ($region, $region->specificity)
1793 if $region->specificity > $specificity;
1794 }
1795 }
1796
1797 $match
1798}
1125 1799
1126=back 1800=back
1127
1128 1801
1129=head3 cf::map 1802=head3 cf::map
1130 1803
1131=over 4 1804=over 4
1132 1805
1144our $MAX_RESET = 3600; 1817our $MAX_RESET = 3600;
1145our $DEFAULT_RESET = 3000; 1818our $DEFAULT_RESET = 3000;
1146 1819
1147sub generate_random_map { 1820sub generate_random_map {
1148 my ($self, $rmp) = @_; 1821 my ($self, $rmp) = @_;
1822
1823 my $lock = cf::lock_acquire "generate_random_map"; # the random map generator is NOT reentrant ATM
1824
1149 # mit "rum" bekleckern, nicht 1825 # mit "rum" bekleckern, nicht
1150 $self->_create_random_map ( 1826 $self->_create_random_map (
1151 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, 1827 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1152 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, 1828 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, $rmp->{miningstyle},
1153 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, 1829 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1154 $rmp->{exit_on_final_map}, 1830 $rmp->{exit_on_final_map},
1155 $rmp->{xsize}, $rmp->{ysize}, 1831 $rmp->{xsize}, $rmp->{ysize},
1156 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, 1832 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1157 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, 1833 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1179 1855
1180 $EXT_MAP{$pkg} = [$prio, qr<$regex>]; 1856 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1181} 1857}
1182 1858
1183# also paths starting with '/' 1859# also paths starting with '/'
1184$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; 1860$EXT_MAP{"cf::map::wrap"} = [0, qr{^(?=/)}];
1185 1861
1186sub thawer_merge { 1862sub thawer_merge {
1187 my ($self, $merge) = @_; 1863 my ($self, $merge) = @_;
1188 1864
1189 # we have to keep some variables in memory intact 1865 # we have to keep some variables in memory intact
1190 local $self->{path}; 1866 local $self->{path};
1191 local $self->{load_path}; 1867 local $self->{load_path};
1192 local $self->{deny_save};
1193 local $self->{deny_reset};
1194 1868
1195 $self->SUPER::thawer_merge ($merge); 1869 $self->SUPER::thawer_merge ($merge);
1196} 1870}
1197 1871
1198sub normalise { 1872sub normalise {
1245 $self->init; # pass $1 etc. 1919 $self->init; # pass $1 etc.
1246 return $self; 1920 return $self;
1247 } 1921 }
1248 } 1922 }
1249 1923
1250 Carp::carp "unable to resolve path '$path' (base '$base')."; 1924 Carp::cluck "unable to resolve path '$path' (base '$base').";
1251 () 1925 ()
1252} 1926}
1253 1927
1254sub init { 1928sub init {
1255 my ($self) = @_; 1929 my ($self) = @_;
1270 1944
1271# the original (read-only) location 1945# the original (read-only) location
1272sub load_path { 1946sub load_path {
1273 my ($self) = @_; 1947 my ($self) = @_;
1274 1948
1275 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1949 "$MAPDIR/$self->{path}.map"
1276} 1950}
1277 1951
1278# the temporary/swap location 1952# the temporary/swap location
1279sub save_path { 1953sub save_path {
1280 my ($self) = @_; 1954 my ($self) = @_;
1281 1955
1282 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1956 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1283 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1957 "$TMPDIR/$path.map"
1284} 1958}
1285 1959
1286# the unique path, undef == no special unique path 1960# the unique path, undef == no special unique path
1287sub uniq_path { 1961sub uniq_path {
1288 my ($self) = @_; 1962 my ($self) = @_;
1289 1963
1290 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1964 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/go;
1291 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1965 "$UNIQUEDIR/$path"
1292} 1966}
1293 1967
1294# and all this just because we cannot iterate over 1968sub decay_objects {
1295# all maps in C++...
1296sub change_all_map_light {
1297 my ($change) = @_; 1969 my ($self) = @_;
1298 1970
1299 $_->change_map_light ($change) 1971 return if $self->{deny_reset};
1300 for grep $_->outdoor, values %cf::MAP; 1972
1973 $self->do_decay_objects;
1301} 1974}
1302 1975
1303sub unlink_save { 1976sub unlink_save {
1304 my ($self) = @_; 1977 my ($self) = @_;
1305 1978
1306 utf8::encode (my $save = $self->save_path); 1979 utf8::encode (my $save = $self->save_path);
1307 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; 1980 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1308 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; 1981 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1309
1310 #d#TODO remove .map and also nuke
1311 $save =~ s/\.map// or return;#d#
1312 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1313 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1314} 1982}
1315 1983
1316sub load_header_from($) { 1984sub load_header_from($) {
1317 my ($self, $path) = @_; 1985 my ($self, $path) = @_;
1318 1986
1319 utf8::encode $path; 1987 utf8::encode $path;
1320 #aio_open $path, O_RDONLY, 0 1988 my $f = new_from_file cf::object::thawer $path
1321 # or return;
1322
1323 $self->_load_header ($path)
1324 or return; 1989 or return;
1990
1991 $self->_load_header ($f)
1992 or return;
1993
1994 local $MAP_LOADING{$self->{path}} = $self;
1995 $f->resolve_delayed_derefs;
1325 1996
1326 $self->{load_path} = $path; 1997 $self->{load_path} = $path;
1327 1998
1328 1 1999 1
1329} 2000}
1368 $self->load_header_orig 2039 $self->load_header_orig
1369 or return; 2040 or return;
1370 $self->prepare_orig; 2041 $self->prepare_orig;
1371 } 2042 }
1372 2043
2044 $self->{deny_reset} = 1
2045 if $self->no_reset;
2046
2047 $self->default_region (cf::region::find_by_path $self->{path})
2048 unless $self->default_region;
2049
1373 1 2050 1
1374} 2051}
1375 2052
1376sub find; 2053sub find;
1377sub find { 2054sub find {
1378 my ($path, $origin) = @_; 2055 my ($path, $origin) = @_;
1379 2056
1380 $path = normalise $path, $origin && $origin->path; 2057 $path = normalise $path, $origin && $origin->path;
1381 2058
2059 my $guard1 = cf::lock_acquire "map_data:$path";#d#remove
1382 cf::lock_wait "map_find:$path"; 2060 my $guard2 = cf::lock_acquire "map_find:$path";
1383 2061
1384 $cf::MAP{$path} || do { 2062 $cf::MAP{$path} || do {
1385 my $guard = cf::lock_acquire "map_find:$path";
1386 my $map = new_from_path cf::map $path 2063 my $map = new_from_path cf::map $path
1387 or return; 2064 or return;
1388 2065
1389 $map->{last_save} = $cf::RUNTIME; 2066 $map->{last_save} = $cf::RUNTIME;
1390 2067
1391 $map->load_header 2068 $map->load_header
1392 or return; 2069 or return;
1393 2070
1394 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 2071 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1395 # doing this can freeze the server in a sync job, obviously 2072 # doing this can freeze the server in a sync job, obviously
1396 #$cf::WAIT_FOR_TICK->wait; 2073 #$cf::WAIT_FOR_TICK->wait;
2074 undef $guard2;
2075 undef $guard1;
1397 $map->reset; 2076 $map->reset;
1398 undef $guard;
1399 return find $path; 2077 return find $path;
1400 } 2078 }
1401 2079
1402 $cf::MAP{$path} = $map 2080 $cf::MAP{$path} = $map
1403 } 2081 }
1404} 2082}
1405 2083
1406sub pre_load { } 2084sub pre_load { }
1407sub post_load { } 2085#sub post_load { } # XS
1408 2086
1409sub load { 2087sub load {
1410 my ($self) = @_; 2088 my ($self) = @_;
1411 2089
1412 local $self->{deny_reset} = 1; # loading can take a long time 2090 local $self->{deny_reset} = 1; # loading can take a long time
1413 2091
1414 my $path = $self->{path}; 2092 my $path = $self->{path};
2093
2094 {
1415 my $guard = cf::lock_acquire "map_load:$path"; 2095 my $guard = cf::lock_acquire "map_data:$path";
1416 2096
2097 return unless $self->valid;
1417 return if $self->in_memory != cf::MAP_SWAPPED; 2098 return unless $self->in_memory == cf::MAP_SWAPPED;
1418 2099
1419 $self->in_memory (cf::MAP_LOADING); 2100 $self->in_memory (cf::MAP_LOADING);
1420 2101
1421 $self->alloc; 2102 $self->alloc;
1422 2103
1423 $self->pre_load; 2104 $self->pre_load;
2105 cf::cede_to_tick;
1424 2106
1425 $self->_load_objects ($self->{load_path}, 1) 2107 my $f = new_from_file cf::object::thawer $self->{load_path};
2108 $f->skip_block;
2109 $self->_load_objects ($f)
1426 or return; 2110 or return;
1427 2111
1428 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) 2112 $self->post_load_original
1429 if delete $self->{load_original}; 2113 if delete $self->{load_original};
1430 2114
1431 if (my $uniq = $self->uniq_path) { 2115 if (my $uniq = $self->uniq_path) {
1432 utf8::encode $uniq; 2116 utf8::encode $uniq;
1433 if (aio_open $uniq, O_RDONLY, 0) { 2117 unless (aio_stat $uniq) {
2118 if (my $f = new_from_file cf::object::thawer $uniq) {
1434 $self->clear_unique_items; 2119 $self->clear_unique_items;
1435 $self->_load_objects ($uniq, 0); 2120 $self->_load_objects ($f);
2121 $f->resolve_delayed_derefs;
2122 }
1436 } 2123 }
1437 } 2124 }
1438 2125
1439 Coro::cede; 2126 $f->resolve_delayed_derefs;
1440 2127
2128 cf::cede_to_tick;
1441 # now do the right thing for maps 2129 # now do the right thing for maps
1442 $self->link_multipart_objects; 2130 $self->link_multipart_objects;
1443
1444 unless ($self->{deny_activate}) {
1445 $self->decay_objects;
1446 $self->fix_auto_apply;
1447 $self->update_buttons;
1448 Coro::cede;
1449 $self->set_darkness_map;
1450 $self->difficulty ($self->estimate_difficulty) 2131 $self->difficulty ($self->estimate_difficulty)
1451 unless $self->difficulty; 2132 unless $self->difficulty;
1452 Coro::cede; 2133 cf::cede_to_tick;
2134
2135 unless ($self->{deny_activate}) {
2136 $self->decay_objects;
2137 $self->fix_auto_apply;
2138 $self->update_buttons;
2139 cf::cede_to_tick;
1453 $self->activate; 2140 $self->activate;
2141 }
2142
2143 $self->{last_save} = $cf::RUNTIME;
2144 $self->last_access ($cf::RUNTIME);
2145
2146 $self->in_memory (cf::MAP_ACTIVE);
1454 } 2147 }
1455 2148
1456 $self->post_load; 2149 $self->post_load;
1457
1458 $self->in_memory (cf::MAP_IN_MEMORY);
1459} 2150}
1460 2151
2152# customize the map for a given player, i.e.
2153# return the _real_ map. used by e.g. per-player
2154# maps to change the path to ~playername/mappath
1461sub customise_for { 2155sub customise_for {
1462 my ($self, $ob) = @_; 2156 my ($self, $ob) = @_;
1463 2157
1464 return find "~" . $ob->name . "/" . $self->{path} 2158 return find "~" . $ob->name . "/" . $self->{path}
1465 if $self->per_player; 2159 if $self->per_player;
1466 2160
2161# return find "?party/" . $ob->name . "/" . $self->{path}
2162# if $self->per_party;
2163
1467 $self 2164 $self
1468} 2165}
1469 2166
1470# find and load all maps in the 3x3 area around a map 2167# find and load all maps in the 3x3 area around a map
1471sub load_diag { 2168sub load_neighbours {
1472 my ($map) = @_; 2169 my ($map) = @_;
1473 2170
1474 my @diag; # diagonal neighbours 2171 my @neigh; # diagonal neighbours
1475 2172
1476 for (0 .. 3) { 2173 for (0 .. 3) {
1477 my $neigh = $map->tile_path ($_) 2174 my $neigh = $map->tile_path ($_)
1478 or next; 2175 or next;
1479 $neigh = find $neigh, $map 2176 $neigh = find $neigh, $map
1480 or next; 2177 or next;
1481 $neigh->load; 2178 $neigh->load;
1482 2179
2180 # now find the diagonal neighbours
2181 push @neigh,
1483 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], 2182 [$neigh->tile_path (($_ + 3) % 4), $neigh],
1484 [$neigh->tile_path (($_ + 1) % 4), $neigh]; 2183 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1485 } 2184 }
1486 2185
1487 for (@diag) { 2186 for (grep defined $_->[0], @neigh) {
2187 my ($path, $origin) = @$_;
1488 my $neigh = find @$_ 2188 my $neigh = find $path, $origin
1489 or next; 2189 or next;
1490 $neigh->load; 2190 $neigh->load;
1491 } 2191 }
1492} 2192}
1493 2193
1494sub find_sync { 2194sub find_sync {
1495 my ($path, $origin) = @_; 2195 my ($path, $origin) = @_;
1496 2196
1497 cf::sync_job { find $path, $origin } 2197 return cf::LOG cf::llevError | cf::logBacktrace, "do_find_sync"
2198 if $Coro::current == $Coro::main;
2199
2200 find $path, $origin
1498} 2201}
1499 2202
1500sub do_load_sync { 2203sub do_load_sync {
1501 my ($map) = @_; 2204 my ($map) = @_;
1502 2205
1503 cf::sync_job { $map->load }; 2206 return cf::LOG cf::llevError | cf::logBacktrace, "do_load_sync"
2207 if $Coro::current == $Coro::main;
2208
2209 $map->load;
1504} 2210}
1505 2211
1506our %MAP_PREFETCH; 2212our %MAP_PREFETCH;
1507our $MAP_PREFETCHER = undef; 2213our $MAP_PREFETCHER = undef;
1508 2214
1509sub find_async { 2215sub find_async {
1510 my ($path, $origin) = @_; 2216 my ($path, $origin, $load) = @_;
1511 2217
1512 $path = normalise $path, $origin && $origin->{path}; 2218 $path = normalise $path, $origin && $origin->{path};
1513 2219
1514 if (my $map = $cf::MAP{$path}) { 2220 if (my $map = $cf::MAP{$path}) {
1515 return $map if $map->in_memory == cf::MAP_IN_MEMORY; 2221 return $map if !$load || $map->in_memory == cf::MAP_ACTIVE;
1516 } 2222 }
1517 2223
1518 undef $MAP_PREFETCH{$path}; 2224 $MAP_PREFETCH{$path} |= $load;
2225
1519 $MAP_PREFETCHER ||= cf::async { 2226 $MAP_PREFETCHER ||= cf::async {
2227 $Coro::current->{desc} = "map prefetcher";
2228
1520 while (%MAP_PREFETCH) { 2229 while (%MAP_PREFETCH) {
1521 for my $path (keys %MAP_PREFETCH) { 2230 while (my ($k, $v) = each %MAP_PREFETCH) {
1522 my $map = find $path 2231 if (my $map = find $k) {
1523 or next;
1524 $map->load; 2232 $map->load if $v;
2233 }
1525 2234
1526 delete $MAP_PREFETCH{$path}; 2235 delete $MAP_PREFETCH{$k};
1527 } 2236 }
1528 } 2237 }
1529 undef $MAP_PREFETCHER; 2238 undef $MAP_PREFETCHER;
1530 }; 2239 };
1531 $MAP_PREFETCHER->prio (6); 2240 $MAP_PREFETCHER->prio (6);
1532 2241
1533 () 2242 ()
1534} 2243}
1535 2244
2245# common code, used by both ->save and ->swapout
1536sub save { 2246sub _save {
1537 my ($self) = @_; 2247 my ($self) = @_;
1538
1539 my $lock = cf::lock_acquire "map_data:" . $self->path;
1540 2248
1541 $self->{last_save} = $cf::RUNTIME; 2249 $self->{last_save} = $cf::RUNTIME;
1542 2250
1543 return unless $self->dirty; 2251 return unless $self->dirty;
1544 2252
1550 return if $self->{deny_save}; 2258 return if $self->{deny_save};
1551 2259
1552 local $self->{last_access} = $self->last_access;#d# 2260 local $self->{last_access} = $self->last_access;#d#
1553 2261
1554 cf::async { 2262 cf::async {
2263 $Coro::current->{desc} = "map player save";
1555 $_->contr->save for $self->players; 2264 $_->contr->save for $self->players;
1556 }; 2265 };
2266
2267 cf::get_slot 0.02;
1557 2268
1558 if ($uniq) { 2269 if ($uniq) {
1559 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); 2270 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1560 $self->_save_objects ($uniq, cf::IO_UNIQUES); 2271 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1561 } else { 2272 } else {
1562 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); 2273 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1563 } 2274 }
1564} 2275}
1565 2276
2277sub save {
2278 my ($self) = @_;
2279
2280 my $lock = cf::lock_acquire "map_data:$self->{path}";
2281
2282 $self->_save;
2283}
2284
1566sub swap_out { 2285sub swap_out {
1567 my ($self) = @_; 2286 my ($self) = @_;
1568 2287
1569 # save first because save cedes
1570 $self->save;
1571
1572 my $lock = cf::lock_acquire "map_data:" . $self->path; 2288 my $lock = cf::lock_acquire "map_data:$self->{path}";
1573 2289
2290 return if $self->in_memory != cf::MAP_ACTIVE;
2291 return if $self->{deny_save};
1574 return if $self->players; 2292 return if $self->players;
1575 return if $self->in_memory != cf::MAP_IN_MEMORY;
1576 return if $self->{deny_save};
1577 2293
2294 # first deactivate the map and "unlink" it from the core
2295 $self->deactivate;
2296 $_->clear_links_to ($self) for values %cf::MAP;
2297 $self->in_memory (cf::MAP_SWAPPED);
2298
2299 # then atomically save
2300 $self->_save;
2301
2302 # then free the map
1578 $self->clear; 2303 $self->clear;
1579 $self->in_memory (cf::MAP_SWAPPED);
1580} 2304}
1581 2305
1582sub reset_at { 2306sub reset_at {
1583 my ($self) = @_; 2307 my ($self) = @_;
1584 2308
1585 # TODO: safety, remove and allow resettable per-player maps 2309 # TODO: safety, remove and allow resettable per-player maps
1586 return 1e99 if $self->isa ("ext::map_per_player");#d#
1587 return 1e99 if $self->{deny_reset}; 2310 return 1e99 if $self->{deny_reset};
1588 2311
1589 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2312 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1590 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2313 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1591 2314
1602 my ($self) = @_; 2325 my ($self) = @_;
1603 2326
1604 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2327 my $lock = cf::lock_acquire "map_data:$self->{path}";
1605 2328
1606 return if $self->players; 2329 return if $self->players;
1607 return if $self->isa ("ext::map_per_player");#d#
1608 2330
1609 warn "resetting map ", $self->path;#d# 2331 cf::trace "resetting map ", $self->path, "\n";
2332
2333 $self->in_memory (cf::MAP_SWAPPED);
2334
2335 # need to save uniques path
2336 unless ($self->{deny_save}) {
2337 my $uniq = $self->uniq_path; utf8::encode $uniq;
2338
2339 $self->_save_objects ($uniq, cf::IO_UNIQUES)
2340 if $uniq;
2341 }
1610 2342
1611 delete $cf::MAP{$self->path}; 2343 delete $cf::MAP{$self->path};
1612 2344
1613 $self->in_memory (cf::MAP_SWAPPED); 2345 $self->deactivate;
2346 $_->clear_links_to ($self) for values %cf::MAP;
1614 $self->clear; 2347 $self->clear;
1615
1616 $_->clear_links_to ($self) for values %cf::MAP;
1617 2348
1618 $self->unlink_save; 2349 $self->unlink_save;
1619 $self->destroy; 2350 $self->destroy;
1620} 2351}
1621 2352
1622my $nuke_counter = "aaaa"; 2353my $nuke_counter = "aaaa";
1623 2354
1624sub nuke { 2355sub nuke {
1625 my ($self) = @_; 2356 my ($self) = @_;
1626 2357
2358 {
2359 my $lock = cf::lock_acquire "map_data:$self->{path}";
2360
1627 delete $cf::MAP{$self->path}; 2361 delete $cf::MAP{$self->path};
1628 2362
1629 $self->unlink_save; 2363 $self->unlink_save;
1630 2364
1631 bless $self, "cf::map"; 2365 bless $self, "cf::map::wrap";
1632 delete $self->{deny_reset}; 2366 delete $self->{deny_reset};
1633 $self->{deny_save} = 1; 2367 $self->{deny_save} = 1;
1634 $self->reset_timeout (1); 2368 $self->reset_timeout (1);
1635 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); 2369 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1636 2370
1637 $cf::MAP{$self->path} = $self; 2371 $cf::MAP{$self->path} = $self;
2372 }
1638 2373
1639 $self->reset; # polite request, might not happen 2374 $self->reset; # polite request, might not happen
2375}
2376
2377=item $maps = cf::map::tmp_maps
2378
2379Returns an arrayref with all map paths of currently instantiated and saved
2380maps. May block.
2381
2382=cut
2383
2384sub tmp_maps() {
2385 [
2386 map {
2387 utf8::decode $_;
2388 /\.map$/
2389 ? normalise $_
2390 : ()
2391 } @{ aio_readdir $TMPDIR or [] }
2392 ]
2393}
2394
2395=item $maps = cf::map::random_maps
2396
2397Returns an arrayref with all map paths of currently instantiated and saved
2398random maps. May block.
2399
2400=cut
2401
2402sub random_maps() {
2403 [
2404 map {
2405 utf8::decode $_;
2406 /\.map$/
2407 ? normalise "?random/$_"
2408 : ()
2409 } @{ aio_readdir $RANDOMDIR or [] }
2410 ]
1640} 2411}
1641 2412
1642=item cf::map::unique_maps 2413=item cf::map::unique_maps
1643 2414
1644Returns an arrayref of paths of all shared maps that have 2415Returns an arrayref of paths of all shared maps that have
1645instantiated unique items. May block. 2416instantiated unique items. May block.
1646 2417
1647=cut 2418=cut
1648 2419
1649sub unique_maps() { 2420sub unique_maps() {
1650 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2421 [
1651 or return; 2422 map {
1652
1653 my @paths;
1654
1655 for (@$files) {
1656 utf8::decode $_; 2423 utf8::decode $_;
1657 next if /\.pst$/; 2424 s/\.map$//; # TODO future compatibility hack
1658 next unless /^$PATH_SEP/o; 2425 /\.pst$/ || !/^$PATH_SEP/o # TODO unique maps apparebntly lack the .map suffix :/
1659 2426 ? ()
1660 push @paths, cf::map::normalise $_; 2427 : normalise $_
2428 } @{ aio_readdir $UNIQUEDIR or [] }
1661 } 2429 ]
1662
1663 \@paths
1664} 2430}
1665 2431
1666package cf; 2432=item cf::map::static_maps
2433
2434Returns an arrayref if paths of all static maps (all preinstalled F<.map>
2435file in the shared directory excluding F</styles> and F</editor>). May
2436block.
2437
2438=cut
2439
2440sub static_maps() {
2441 my @dirs = "";
2442 my @maps;
2443
2444 while (@dirs) {
2445 my $dir = shift @dirs;
2446
2447 next if $dir eq "/styles" || $dir eq "/editor";
2448
2449 my ($dirs, $files) = Coro::AIO::aio_scandir "$MAPDIR$dir", 2
2450 or return;
2451
2452 for (@$files) {
2453 s/\.map$// or next;
2454 utf8::decode $_;
2455 push @maps, "$dir/$_";
2456 }
2457
2458 push @dirs, map "$dir/$_", @$dirs;
2459 }
2460
2461 \@maps
2462}
1667 2463
1668=back 2464=back
1669 2465
1670=head3 cf::object 2466=head3 cf::object
1671 2467
1675 2471
1676=over 4 2472=over 4
1677 2473
1678=item $ob->inv_recursive 2474=item $ob->inv_recursive
1679 2475
1680Returns the inventory of the object _and_ their inventories, recursively. 2476Returns the inventory of the object I<and> their inventories, recursively,
2477but I<not> the object itself.
1681 2478
1682=cut 2479=cut
1683 2480
1684sub inv_recursive_; 2481sub inv_recursive_;
1685sub inv_recursive_ { 2482sub inv_recursive_ {
1688 2485
1689sub inv_recursive { 2486sub inv_recursive {
1690 inv_recursive_ inv $_[0] 2487 inv_recursive_ inv $_[0]
1691} 2488}
1692 2489
2490=item $ref = $ob->ref
2491
2492Creates and returns a persistent reference to an object that can be stored as a string.
2493
2494=item $ob = cf::object::deref ($refstring)
2495
2496returns the objetc referenced by refstring. may return undef when it cnanot find the object,
2497even if the object actually exists. May block.
2498
2499=cut
2500
2501sub deref {
2502 my ($ref) = @_;
2503
2504 if ($ref =~ m{^player\/(<1\.[0-9a-f]+>)/(.*)$}) {
2505 my ($uuid, $name) = ($1, $2);
2506 my $pl = $cf::PLAYER_LOADING{$name} || cf::player::find $name
2507 or return;
2508 $pl->ob->uuid eq $uuid
2509 or return;
2510
2511 $pl->ob
2512 } else {
2513 warn "$ref: cannot resolve object reference\n";
2514 undef
2515 }
2516}
2517
1693package cf; 2518package cf;
1694 2519
1695=back 2520=back
1696 2521
1697=head3 cf::object::player 2522=head3 cf::object::player
1703Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 2528Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
1704can be C<undef>. Does the right thing when the player is currently in a 2529can be C<undef>. Does the right thing when the player is currently in a
1705dialogue with the given NPC character. 2530dialogue with the given NPC character.
1706 2531
1707=cut 2532=cut
2533
2534our $SAY_CHANNEL = {
2535 id => "say",
2536 title => "Map",
2537 reply => "say ",
2538 tooltip => "Things said to and replied from NPCs near you and other players on the same map only.",
2539};
2540
2541our $CHAT_CHANNEL = {
2542 id => "chat",
2543 title => "Chat",
2544 reply => "chat ",
2545 tooltip => "Player chat and shouts, global to the server.",
2546};
1708 2547
1709# rough implementation of a future "reply" method that works 2548# rough implementation of a future "reply" method that works
1710# with dialog boxes. 2549# with dialog boxes.
1711#TODO: the first argument must go, split into a $npc->reply_to ( method 2550#TODO: the first argument must go, split into a $npc->reply_to ( method
1712sub cf::object::player::reply($$$;$) { 2551sub cf::object::player::reply($$$;$) {
1714 2553
1715 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2554 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1716 2555
1717 if ($self->{record_replies}) { 2556 if ($self->{record_replies}) {
1718 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2557 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2558
1719 } else { 2559 } else {
2560 my $pl = $self->contr;
2561
2562 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2563 my $dialog = $pl->{npc_dialog};
2564 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2565
2566 } else {
1720 $msg = $npc->name . " says: $msg" if $npc; 2567 $msg = $npc->name . " says: $msg" if $npc;
1721 $self->message ($msg, $flags); 2568 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2569 }
1722 } 2570 }
2571}
2572
2573=item $object->send_msg ($channel, $msg, $color, [extra...])
2574
2575=cut
2576
2577sub cf::object::send_msg {
2578 my $pl = shift->contr
2579 or return;
2580 $pl->send_msg (@_);
1723} 2581}
1724 2582
1725=item $player_object->may ("access") 2583=item $player_object->may ("access")
1726 2584
1727Returns wether the given player is authorized to access resource "access" 2585Returns wether the given player is authorized to access resource "access"
1740 2598
1741=item $player_object->enter_link 2599=item $player_object->enter_link
1742 2600
1743Freezes the player and moves him/her to a special map (C<{link}>). 2601Freezes the player and moves him/her to a special map (C<{link}>).
1744 2602
1745The player should be reasonably safe there for short amounts of time. You 2603The player should be reasonably safe there for short amounts of time (e.g.
1746I<MUST> call C<leave_link> as soon as possible, though. 2604for loading a map). You I<MUST> call C<leave_link> as soon as possible,
2605though, as the player cannot control the character while it is on the link
2606map.
1747 2607
1748Will never block. 2608Will never block.
1749 2609
1750=item $player_object->leave_link ($map, $x, $y) 2610=item $player_object->leave_link ($map, $x, $y)
1751 2611
1771sub cf::object::player::enter_link { 2631sub cf::object::player::enter_link {
1772 my ($self) = @_; 2632 my ($self) = @_;
1773 2633
1774 $self->deactivate_recursive; 2634 $self->deactivate_recursive;
1775 2635
2636 ++$self->{_link_recursion};
2637
1776 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2638 return if UNIVERSAL::isa $self->map, "ext::map_link";
1777 2639
1778 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2640 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1779 if $self->map; 2641 if $self->map && $self->map->{path} ne "{link}";
1780 2642
1781 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2643 $self->enter_map ($LINK_MAP || link_map, 3, 3);
1782} 2644}
1783 2645
1784sub cf::object::player::leave_link { 2646sub cf::object::player::leave_link {
1785 my ($self, $map, $x, $y) = @_; 2647 my ($self, $map, $x, $y) = @_;
2648
2649 return unless $self->contr->active;
1786 2650
1787 my $link_pos = delete $self->{_link_pos}; 2651 my $link_pos = delete $self->{_link_pos};
1788 2652
1789 unless ($map) { 2653 unless ($map) {
1790 # restore original map position 2654 # restore original map position
1801 ($x, $y) = (-1, -1) 2665 ($x, $y) = (-1, -1)
1802 unless (defined $x) && (defined $y); 2666 unless (defined $x) && (defined $y);
1803 2667
1804 # use -1 or undef as default coordinates, not 0, 0 2668 # use -1 or undef as default coordinates, not 0, 0
1805 ($x, $y) = ($map->enter_x, $map->enter_y) 2669 ($x, $y) = ($map->enter_x, $map->enter_y)
1806 if $x <=0 && $y <= 0; 2670 if $x <= 0 && $y <= 0;
1807 2671
1808 $map->load; 2672 $map->load;
1809 $map->load_diag; 2673 $map->load_neighbours;
1810 2674
1811 return unless $self->contr->active; 2675 return unless $self->contr->active;
2676
2677 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2678 if ($self->enter_map ($map, $x, $y)) {
2679 # entering was successful
2680 delete $self->{_link_recursion};
2681 # only activate afterwards, to support waiting in hooks
1812 $self->activate_recursive; 2682 $self->activate_recursive;
1813 $self->enter_map ($map, $x, $y);
1814}
1815
1816cf::player->attach (
1817 on_logout => sub {
1818 my ($pl) = @_;
1819
1820 # abort map switching before logout
1821 if ($pl->ob->{_link_pos}) {
1822 cf::sync_job {
1823 $pl->ob->leave_link
1824 };
1825 }
1826 }, 2683 }
1827 on_login => sub {
1828 my ($pl) = @_;
1829 2684
1830 # try to abort aborted map switching on player login :) 2685}
1831 # should happen only on crashes
1832 if ($pl->ob->{_link_pos}) {
1833 $pl->ob->enter_link;
1834 (async {
1835 # we need this sleep as the login has a concurrent enter_exit running
1836 # and this sleep increases chances of the player not ending up in scorn
1837 $pl->ob->reply (undef,
1838 "There was an internal problem at your last logout, "
1839 . "the server will try to bring you to your intended destination in a second.",
1840 cf::NDI_RED);
1841 Coro::Timer::sleep 1;
1842 $pl->ob->leave_link;
1843 })->prio (2);
1844 }
1845 },
1846);
1847 2686
1848=item $player_object->goto ($path, $x, $y) 2687=item $player_object->goto ($path, $x, $y[, $check->($map, $x, $y, $player)[, $done->($player)]])
1849 2688
2689Moves the player to the given map-path and coordinates by first freezing
2690her, loading and preparing them map, calling the provided $check callback
2691that has to return the map if sucecssful, and then unfreezes the player on
2692the new (success) or old (failed) map position. In either case, $done will
2693be called at the end of this process.
2694
2695Note that $check will be called with a potentially non-loaded map, so if
2696it needs a loaded map it has to call C<< ->load >>.
2697
1850=cut 2698=cut
2699
2700our $GOTOGEN;
1851 2701
1852sub cf::object::player::goto { 2702sub cf::object::player::goto {
1853 my ($self, $path, $x, $y) = @_; 2703 my ($self, $path, $x, $y, $check, $done) = @_;
2704
2705 if ($self->{_link_recursion} >= $MAX_LINKS) {
2706 error "FATAL: link recursion exceeded, ", $self->name, " goto $path $x $y, redirecting.";
2707 $self->failmsg ("Something went wrong inside the server - please contact an administrator!");
2708 ($path, $x, $y) = @$EMERGENCY_POSITION;
2709 }
2710
2711 # do generation counting so two concurrent goto's will be executed in-order
2712 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1854 2713
1855 $self->enter_link; 2714 $self->enter_link;
1856 2715
1857 (async { 2716 (async {
2717 $Coro::current->{desc} = "player::goto $path $x $y";
2718
2719 # *tag paths override both path and x|y
2720 if ($path =~ /^\*(.*)$/) {
2721 if (my @obs = grep $_->map, ext::map_tags::find $1) {
2722 my $ob = $obs[rand @obs];
2723
2724 # see if we actually can go there
2725 if (@obs = grep !$self->blocked ($_->map, $_->x, $_->y), $ob, $ob->tail) {
2726 $ob = $obs[rand @obs];
2727 } else {
2728 $self->message ("Wow, it's pretty crowded in there.", cf::NDI_UNIQUE | cf::NDI_RED);
2729 }
2730 # else put us there anyways for now #d#
2731
2732 ($path, $x, $y) = ($ob->map, $ob->x, $ob->y);
2733 } else {
2734 ($path, $x, $y) = (undef, undef, undef);
2735 }
2736 }
2737
1858 my $map = eval { 2738 my $map = eval {
1859 my $map = cf::map::find $path; 2739 my $map = defined $path ? cf::map::find $path : undef;
2740
2741 if ($map) {
1860 $map = $map->customise_for ($self) if $map; 2742 $map = $map->customise_for ($self);
2743 $map = $check->($map, $x, $y, $self) if $check && $map;
2744 } else {
2745 $self->message ("The exit to '$path' is closed.", cf::NDI_UNIQUE | cf::NDI_RED);
2746 }
2747
1861 $map 2748 $map
2749 };
2750
2751 if ($@) {
2752 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2753 LOG llevError | logBacktrace, Carp::longmess $@;
1862 } or 2754 }
1863 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1864 2755
2756 if ($gen == $self->{_goto_generation}) {
2757 delete $self->{_goto_generation};
1865 $self->leave_link ($map, $x, $y); 2758 $self->leave_link ($map, $x, $y);
2759 }
2760
2761 $done->($self) if $done;
1866 })->prio (1); 2762 })->prio (1);
1867} 2763}
1868 2764
1869=item $player_object->enter_exit ($exit_object) 2765=item $player_object->enter_exit ($exit_object)
1870 2766
1890} 2786}
1891 2787
1892sub prepare_random_map { 2788sub prepare_random_map {
1893 my ($exit) = @_; 2789 my ($exit) = @_;
1894 2790
1895 my $guard = cf::lock_acquire "exit_prepare:$exit";
1896
1897 # all this does is basically replace the /! path by 2791 # all this does is basically replace the /! path by
1898 # a new random map path (?random/...) with a seed 2792 # a new random map path (?random/...) with a seed
1899 # that depends on the exit object 2793 # that depends on the exit object
1900 2794
1901 my $rmp = parse_random_map_params $exit->msg; 2795 my $rmp = parse_random_map_params $exit->msg;
1903 if ($exit->map) { 2797 if ($exit->map) {
1904 $rmp->{region} = $exit->region->name; 2798 $rmp->{region} = $exit->region->name;
1905 $rmp->{origin_map} = $exit->map->path; 2799 $rmp->{origin_map} = $exit->map->path;
1906 $rmp->{origin_x} = $exit->x; 2800 $rmp->{origin_x} = $exit->x;
1907 $rmp->{origin_y} = $exit->y; 2801 $rmp->{origin_y} = $exit->y;
2802
2803 $exit->map->touch;
1908 } 2804 }
1909 2805
1910 $rmp->{random_seed} ||= $exit->random_seed; 2806 $rmp->{random_seed} ||= $exit->random_seed;
1911 2807
1912 my $data = cf::to_json $rmp; 2808 my $data = JSON::XS->new->utf8->pretty->canonical->encode ($rmp);
1913 my $md5 = Digest::MD5::md5_hex $data; 2809 my $md5 = Digest::MD5::md5_hex $data;
1914 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2810 my $meta = "$RANDOMDIR/$md5.meta";
1915 2811
1916 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2812 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1917 aio_write $fh, 0, (length $data), $data, 0; 2813 aio_write $fh, 0, (length $data), $data, 0;
1918 undef $fh; 2814 undef $fh;
1919 aio_rename "$meta~", $meta; 2815 aio_rename "$meta~", $meta;
1920 2816
2817 my $slaying = "?random/$md5";
2818
2819 if ($exit->valid) {
1921 $exit->slaying ("?random/$md5"); 2820 $exit->slaying ("?random/$md5");
1922 $exit->msg (undef); 2821 $exit->msg (undef);
2822 }
1923 } 2823 }
1924} 2824}
1925 2825
1926sub cf::object::player::enter_exit { 2826sub cf::object::player::enter_exit {
1927 my ($self, $exit) = @_; 2827 my ($self, $exit) = @_;
1928 2828
1929 return unless $self->type == cf::PLAYER; 2829 return unless $self->type == cf::PLAYER;
1930 2830
1931 if ($exit->slaying eq "/!") {
1932 #TODO: this should de-fi-ni-te-ly not be a sync-job
1933 cf::sync_job { prepare_random_map $exit };
1934 }
1935
1936 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1937 my $hp = $exit->stats->hp;
1938 my $sp = $exit->stats->sp;
1939
1940 $self->enter_link; 2831 $self->enter_link;
1941 2832
1942 (async { 2833 (async {
1943 $self->deactivate_recursive; # just to be sure 2834 $Coro::current->{desc} = "enter_exit";
2835
1944 unless (eval { 2836 unless (eval {
2837 $self->deactivate_recursive; # just to be sure
2838
2839 # random map handling
2840 {
2841 my $guard = cf::lock_acquire "exit_prepare:$exit";
2842
2843 prepare_random_map $exit
2844 if $exit->slaying eq "/!";
2845 }
2846
2847 my $map = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2848 my $x = $exit->stats->hp;
2849 my $y = $exit->stats->sp;
2850
1945 $self->goto ($slaying, $hp, $sp); 2851 $self->goto ($map, $x, $y);
1946 2852
2853 # if exit is damned, update players death & WoR home-position
2854 $self->contr->savebed ($map, $x, $y)
2855 if $exit->flag (cf::FLAG_DAMNED);
2856
1947 1; 2857 1
1948 }) { 2858 }) {
1949 $self->message ("Something went wrong deep within the crossfire server. " 2859 $self->message ("Something went wrong deep within the deliantra server. "
1950 . "I'll try to bring you back to the map you were before. " 2860 . "I'll try to bring you back to the map you were before. "
1951 . "Please report this to the dungeon master!", 2861 . "Please report this to the dungeon master!",
1952 cf::NDI_UNIQUE | cf::NDI_RED); 2862 cf::NDI_UNIQUE | cf::NDI_RED);
1953 2863
1954 warn "ERROR in enter_exit: $@"; 2864 error "ERROR in enter_exit: $@";
1955 $self->leave_link; 2865 $self->leave_link;
1956 } 2866 }
1957 })->prio (1); 2867 })->prio (1);
1958} 2868}
1959 2869
1970 2880
1971sub cf::client::send_drawinfo { 2881sub cf::client::send_drawinfo {
1972 my ($self, $text, $flags) = @_; 2882 my ($self, $text, $flags) = @_;
1973 2883
1974 utf8::encode $text; 2884 utf8::encode $text;
1975 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2885 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1976} 2886}
1977 2887
2888=item $client->send_big_packet ($pkt)
2889
2890Like C<send_packet>, but tries to compress large packets, and fragments
2891them as required.
2892
2893=cut
2894
2895our $MAXFRAGSIZE = cf::MAXSOCKBUF - 64;
2896
2897sub cf::client::send_big_packet {
2898 my ($self, $pkt) = @_;
2899
2900 # try lzf for large packets
2901 $pkt = "lzf " . Compress::LZF::compress $pkt
2902 if 1024 <= length $pkt and $self->{can_lzf};
2903
2904 # split very large packets
2905 if ($MAXFRAGSIZE < length $pkt and $self->{can_lzf}) {
2906 $self->send_packet ("frag $_") for unpack "(a$MAXFRAGSIZE)*", $pkt;
2907 $pkt = "frag";
2908 }
2909
2910 $self->send_packet ($pkt);
2911}
2912
2913=item $client->send_msg ($channel, $msg, $color, [extra...])
2914
2915Send a drawinfo or msg packet to the client, formatting the msg for the
2916client if neccessary. C<$type> should be a string identifying the type of
2917the message, with C<log> being the default. If C<$color> is negative, suppress
2918the message unless the client supports the msg packet.
2919
2920=cut
2921
2922# non-persistent channels (usually the info channel)
2923our %CHANNEL = (
2924 "c/motd" => {
2925 id => "infobox",
2926 title => "MOTD",
2927 reply => undef,
2928 tooltip => "The message of the day",
2929 },
2930 "c/identify" => {
2931 id => "infobox",
2932 title => "Identify",
2933 reply => undef,
2934 tooltip => "Items recently identified",
2935 },
2936 "c/examine" => {
2937 id => "infobox",
2938 title => "Examine",
2939 reply => undef,
2940 tooltip => "Signs and other items you examined",
2941 },
2942 "c/shopinfo" => {
2943 id => "infobox",
2944 title => "Shop Info",
2945 reply => undef,
2946 tooltip => "What your bargaining skill tells you about the shop",
2947 },
2948 "c/book" => {
2949 id => "infobox",
2950 title => "Book",
2951 reply => undef,
2952 tooltip => "The contents of a note or book",
2953 },
2954 "c/lookat" => {
2955 id => "infobox",
2956 title => "Look",
2957 reply => undef,
2958 tooltip => "What you saw there",
2959 },
2960 "c/who" => {
2961 id => "infobox",
2962 title => "Players",
2963 reply => undef,
2964 tooltip => "Shows players who are currently online",
2965 },
2966 "c/body" => {
2967 id => "infobox",
2968 title => "Body Parts",
2969 reply => undef,
2970 tooltip => "Shows which body parts you posess and are available",
2971 },
2972 "c/statistics" => {
2973 id => "infobox",
2974 title => "Statistics",
2975 reply => undef,
2976 tooltip => "Shows your primary statistics",
2977 },
2978 "c/skills" => {
2979 id => "infobox",
2980 title => "Skills",
2981 reply => undef,
2982 tooltip => "Shows your experience per skill and item power",
2983 },
2984 "c/shopitems" => {
2985 id => "infobox",
2986 title => "Shop Items",
2987 reply => undef,
2988 tooltip => "Shows the items currently for sale in this shop",
2989 },
2990 "c/resistances" => {
2991 id => "infobox",
2992 title => "Resistances",
2993 reply => undef,
2994 tooltip => "Shows your resistances",
2995 },
2996 "c/pets" => {
2997 id => "infobox",
2998 title => "Pets",
2999 reply => undef,
3000 tooltip => "Shows information abotu your pets/a specific pet",
3001 },
3002 "c/perceiveself" => {
3003 id => "infobox",
3004 title => "Perceive Self",
3005 reply => undef,
3006 tooltip => "You gained detailed knowledge about yourself",
3007 },
3008 "c/uptime" => {
3009 id => "infobox",
3010 title => "Uptime",
3011 reply => undef,
3012 tooltip => "How long the server has been running since last restart",
3013 },
3014 "c/mapinfo" => {
3015 id => "infobox",
3016 title => "Map Info",
3017 reply => undef,
3018 tooltip => "Information related to the maps",
3019 },
3020 "c/party" => {
3021 id => "party",
3022 title => "Party",
3023 reply => "gsay ",
3024 tooltip => "Messages and chat related to your party",
3025 },
3026 "c/death" => {
3027 id => "death",
3028 title => "Death",
3029 reply => undef,
3030 tooltip => "Reason for and more info about your most recent death",
3031 },
3032 "c/say" => $SAY_CHANNEL,
3033 "c/chat" => $CHAT_CHANNEL,
3034);
3035
3036sub cf::client::send_msg {
3037 my ($self, $channel, $msg, $color, @extra) = @_;
3038
3039 $msg = $self->pl->expand_cfpod ($msg)
3040 unless $color & cf::NDI_VERBATIM;
3041
3042 $color &= cf::NDI_CLIENT_MASK; # just in case...
3043
3044 # check predefined channels, for the benefit of C
3045 if ($CHANNEL{$channel}) {
3046 $channel = $CHANNEL{$channel};
3047
3048 $self->ext_msg (channel_info => $channel);
3049 $channel = $channel->{id};
3050
3051 } elsif (ref $channel) {
3052 # send meta info to client, if not yet sent
3053 unless (exists $self->{channel}{$channel->{id}}) {
3054 $self->{channel}{$channel->{id}} = $channel;
3055 $self->ext_msg (channel_info => $channel);
3056 }
3057
3058 $channel = $channel->{id};
3059 }
3060
3061 return unless @extra || length $msg;
3062
3063 # default colour, mask it out
3064 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
3065 if $color & cf::NDI_DEF;
3066
3067 my $pkt = "msg "
3068 . $self->{json_coder}->encode (
3069 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
3070 );
3071
3072 $self->send_big_packet ($pkt);
3073}
3074
3075=item $client->ext_msg ($type, @msg)
3076
3077Sends an ext event to the client.
3078
3079=cut
3080
3081sub cf::client::ext_msg($$@) {
3082 my ($self, $type, @msg) = @_;
3083
3084 if ($self->extcmd == 2) {
3085 $self->send_big_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
3086 } elsif ($self->extcmd == 1) { # TODO: remove
3087 push @msg, msgtype => "event_$type";
3088 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3089 }
3090}
3091
3092=item $client->ext_reply ($msgid, @msg)
3093
3094Sends an ext reply to the client.
3095
3096=cut
3097
3098sub cf::client::ext_reply($$@) {
3099 my ($self, $id, @msg) = @_;
3100
3101 if ($self->extcmd == 2) {
3102 $self->send_big_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
3103 } elsif ($self->extcmd == 1) {
3104 #TODO: version 1, remove
3105 unshift @msg, msgtype => "reply", msgid => $id;
3106 $self->send_big_packet ("ext " . $self->{json_coder}->encode ({@msg}));
3107 }
3108}
1978 3109
1979=item $success = $client->query ($flags, "text", \&cb) 3110=item $success = $client->query ($flags, "text", \&cb)
1980 3111
1981Queues a query to the client, calling the given callback with 3112Queues a query to the client, calling the given callback with
1982the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 3113the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1983C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 3114C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1984 3115
1985Queries can fail, so check the return code. Or don't, as queries will become 3116Queries can fail, so check the return code. Or don't, as queries will
1986reliable at some point in the future. 3117become reliable at some point in the future.
1987 3118
1988=cut 3119=cut
1989 3120
1990sub cf::client::query { 3121sub cf::client::query {
1991 my ($self, $flags, $text, $cb) = @_; 3122 my ($self, $flags, $text, $cb) = @_;
1999 utf8::encode $text; 3130 utf8::encode $text;
2000 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 3131 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2001 3132
2002 $self->send_packet ($self->{query_queue}[0][0]) 3133 $self->send_packet ($self->{query_queue}[0][0])
2003 if @{ $self->{query_queue} } == 1; 3134 if @{ $self->{query_queue} } == 1;
3135
3136 1
2004} 3137}
2005 3138
2006cf::client->attach ( 3139cf::client->attach (
3140 on_connect => sub {
3141 my ($ns) = @_;
3142
3143 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
3144 },
2007 on_reply => sub { 3145 on_reply => sub {
2008 my ($ns, $msg) = @_; 3146 my ($ns, $msg) = @_;
2009 3147
2010 # this weird shuffling is so that direct followup queries 3148 # this weird shuffling is so that direct followup queries
2011 # get handled first 3149 # get handled first
2023 } else { 3161 } else {
2024 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 3162 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2025 } 3163 }
2026 } 3164 }
2027 }, 3165 },
3166 on_exticmd => sub {
3167 my ($ns, $buf) = @_;
3168
3169 my $msg = eval { $ns->{json_coder}->decode ($buf) };
3170
3171 if (ref $msg) {
3172 my ($type, $reply, @payload) =
3173 "ARRAY" eq ref $msg
3174 ? @$msg
3175 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
3176
3177 my @reply;
3178
3179 if (my $cb = $EXTICMD{$type}) {
3180 @reply = $cb->($ns, @payload);
3181 }
3182
3183 $ns->ext_reply ($reply, @reply)
3184 if $reply;
3185
3186 } else {
3187 error "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
3188 }
3189
3190 cf::override;
3191 },
2028); 3192);
2029 3193
2030=item $client->async (\&cb) 3194=item $client->async (\&cb)
2031 3195
2032Create a new coroutine, running the specified callback. The coroutine will 3196Create a new coroutine, running the specified callback. The coroutine will
2048 3212
2049 $coro 3213 $coro
2050} 3214}
2051 3215
2052cf::client->attach ( 3216cf::client->attach (
2053 on_destroy => sub { 3217 on_client_destroy => sub {
2054 my ($ns) = @_; 3218 my ($ns) = @_;
2055 3219
2056 $_->cancel for values %{ (delete $ns->{_coro}) || {} }; 3220 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2057 }, 3221 },
2058); 3222);
2073our $safe = new Safe "safe"; 3237our $safe = new Safe "safe";
2074our $safe_hole = new Safe::Hole; 3238our $safe_hole = new Safe::Hole;
2075 3239
2076$SIG{FPE} = 'IGNORE'; 3240$SIG{FPE} = 'IGNORE';
2077 3241
2078$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3242$safe->permit_only (Opcode::opset qw(
3243 :base_core :base_mem :base_orig :base_math :base_loop
3244 grepstart grepwhile mapstart mapwhile
3245 sort time
3246));
2079 3247
2080# here we export the classes and methods available to script code 3248# here we export the classes and methods available to script code
2081 3249
2082=pod 3250=pod
2083 3251
2084The following fucntions and emthods are available within a safe environment: 3252The following functions and methods are available within a safe environment:
2085 3253
2086 cf::object contr pay_amount pay_player map 3254 cf::object
3255 contr pay_amount pay_player map x y force_find force_add destroy
3256 insert remove name archname title slaying race decrease split
3257 value
3258
2087 cf::object::player player 3259 cf::object::player
2088 cf::player peaceful 3260 player
2089 cf::map trigger 3261
3262 cf::player
3263 peaceful
3264
3265 cf::map
3266 trigger
2090 3267
2091=cut 3268=cut
2092 3269
2093for ( 3270for (
2094 ["cf::object" => qw(contr pay_amount pay_player map)], 3271 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3272 insert remove inv nrof name archname title slaying race
3273 decrease split destroy change_exp value msg lore send_msg)],
2095 ["cf::object::player" => qw(player)], 3274 ["cf::object::player" => qw(player)],
2096 ["cf::player" => qw(peaceful)], 3275 ["cf::player" => qw(peaceful send_msg)],
2097 ["cf::map" => qw(trigger)], 3276 ["cf::map" => qw(trigger)],
2098) { 3277) {
2099 no strict 'refs'; 3278 no strict 'refs';
2100 my ($pkg, @funs) = @$_; 3279 my ($pkg, @funs) = @$_;
2101 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 3280 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
2119 3298
2120 my $qcode = $code; 3299 my $qcode = $code;
2121 $qcode =~ s/"/‟/g; # not allowed in #line filenames 3300 $qcode =~ s/"/‟/g; # not allowed in #line filenames
2122 $qcode =~ s/\n/\\n/g; 3301 $qcode =~ s/\n/\\n/g;
2123 3302
3303 %vars = (_dummy => 0) unless %vars;
3304
3305 my @res;
2124 local $_; 3306 local $_;
2125 local @safe::cf::_safe_eval_args = values %vars;
2126 3307
2127 my $eval = 3308 my $eval =
2128 "do {\n" 3309 "do {\n"
2129 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" 3310 . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n"
2130 . "#line 0 \"{$qcode}\"\n" 3311 . "#line 0 \"{$qcode}\"\n"
2131 . $code 3312 . $code
2132 . "\n}" 3313 . "\n}"
2133 ; 3314 ;
2134 3315
3316 if ($CFG{safe_eval}) {
2135 sub_generation_inc; 3317 sub_generation_inc;
3318 local @safe::cf::_safe_eval_args = values %vars;
2136 my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); 3319 @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval);
2137 sub_generation_inc; 3320 sub_generation_inc;
3321 } else {
3322 local @cf::_safe_eval_args = values %vars;
3323 @res = wantarray ? eval eval : scalar eval $eval;
3324 }
2138 3325
2139 if ($@) { 3326 if ($@) {
2140 warn "$@"; 3327 warn "$@",
2141 warn "while executing safe code '$code'\n"; 3328 "while executing safe code '$code'\n",
2142 warn "with arguments " . (join " ", %vars) . "\n"; 3329 "with arguments " . (join " ", %vars) . "\n";
2143 } 3330 }
2144 3331
2145 wantarray ? @res : $res[0] 3332 wantarray ? @res : $res[0]
2146} 3333}
2147 3334
2161=cut 3348=cut
2162 3349
2163sub register_script_function { 3350sub register_script_function {
2164 my ($fun, $cb) = @_; 3351 my ($fun, $cb) = @_;
2165 3352
2166 no strict 'refs'; 3353 $fun = "safe::$fun" if $CFG{safe_eval};
2167 *{"safe::$fun"} = $safe_hole->wrap ($cb); 3354 *$fun = $safe_hole->wrap ($cb);
2168} 3355}
2169 3356
2170=back 3357=back
2171 3358
2172=cut 3359=cut
2173
2174#############################################################################
2175
2176=head2 EXTENSION DATABASE SUPPORT
2177
2178Crossfire maintains a very simple database for extension use. It can
2179currently store anything that can be serialised using Storable, which
2180excludes objects.
2181
2182The parameter C<$family> should best start with the name of the extension
2183using it, it should be unique.
2184
2185=over 4
2186
2187=item $hashref = cf::db_get $family
2188
2189Return a hashref for use by the extension C<$family>, which can be
2190modified. After modifications, you have to call C<cf::db_dirty> or
2191C<cf::db_sync>.
2192
2193=item $value = cf::db_get $family => $key
2194
2195Returns a single value from the database
2196
2197=item cf::db_put $family => $hashref
2198
2199Stores the given family hashref into the database. Updates are delayed, if
2200you want the data to be synced to disk immediately, use C<cf::db_sync>.
2201
2202=item cf::db_put $family => $key => $value
2203
2204Stores the given C<$value> in the family hash. Updates are delayed, if you
2205want the data to be synced to disk immediately, use C<cf::db_sync>.
2206
2207=item cf::db_dirty
2208
2209Marks the database as dirty, to be updated at a later time.
2210
2211=item cf::db_sync
2212
2213Immediately write the database to disk I<if it is dirty>.
2214
2215=cut
2216
2217our $DB;
2218
2219{
2220 my $path = cf::localdir . "/database.pst";
2221
2222 sub db_load() {
2223 $DB = stat $path ? Storable::retrieve $path : { };
2224 }
2225
2226 my $pid;
2227
2228 sub db_save() {
2229 waitpid $pid, 0 if $pid;
2230 if (0 == ($pid = fork)) {
2231 $DB->{_meta}{version} = 1;
2232 Storable::nstore $DB, "$path~";
2233 rename "$path~", $path;
2234 cf::_exit 0 if defined $pid;
2235 }
2236 }
2237
2238 my $dirty;
2239
2240 sub db_sync() {
2241 db_save if $dirty;
2242 undef $dirty;
2243 }
2244
2245 my $idle = Event->idle (
2246 reentrant => 0,
2247 min => 10,
2248 max => 20,
2249 repeat => 0,
2250 data => WF_AUTOCANCEL,
2251 cb => \&db_sync,
2252 );
2253
2254 sub db_dirty() {
2255 $dirty = 1;
2256 $idle->start;
2257 }
2258
2259 sub db_get($;$) {
2260 @_ >= 2
2261 ? $DB->{$_[0]}{$_[1]}
2262 : ($DB->{$_[0]} ||= { })
2263 }
2264
2265 sub db_put($$;$) {
2266 if (@_ >= 3) {
2267 $DB->{$_[0]}{$_[1]} = $_[2];
2268 } else {
2269 $DB->{$_[0]} = $_[1];
2270 }
2271 db_dirty;
2272 }
2273
2274 cf::global->attach (
2275 prio => 10000,
2276 on_cleanup => sub {
2277 db_sync;
2278 },
2279 );
2280}
2281 3360
2282############################################################################# 3361#############################################################################
2283# the server's init and main functions 3362# the server's init and main functions
2284 3363
3364sub load_facedata($) {
3365 my ($path) = @_;
3366
3367 # HACK to clear player env face cache, we need some signal framework
3368 # for this (global event?)
3369 %ext::player_env::MUSIC_FACE_CACHE = ();
3370
3371 my $enc = JSON::XS->new->utf8->canonical->relaxed;
3372
3373 trace "loading facedata from $path\n";
3374
3375 my $facedata;
3376 0 < aio_load $path, $facedata
3377 or die "$path: $!";
3378
3379 $facedata = Coro::Storable::thaw $facedata;
3380
3381 $facedata->{version} == 2
3382 or cf::cleanup "$path: version mismatch, cannot proceed.";
3383
3384 # patch in the exptable
3385 my $exp_table = $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]);
3386 $facedata->{resource}{"res/exp_table"} = {
3387 type => FT_RSRC,
3388 data => $exp_table,
3389 hash => (Digest::MD5::md5 $exp_table),
3390 };
3391 cf::cede_to_tick;
3392
3393 {
3394 my $faces = $facedata->{faceinfo};
3395
3396 while (my ($face, $info) = each %$faces) {
3397 my $idx = (cf::face::find $face) || cf::face::alloc $face;
3398
3399 cf::face::set_visibility $idx, $info->{visibility};
3400 cf::face::set_magicmap $idx, $info->{magicmap};
3401 cf::face::set_data $idx, 0, $info->{data32}, $info->{hash32};
3402 cf::face::set_data $idx, 1, $info->{data64}, $info->{hash64};
3403
3404 cf::cede_to_tick;
3405 }
3406
3407 while (my ($face, $info) = each %$faces) {
3408 next unless $info->{smooth};
3409
3410 my $idx = cf::face::find $face
3411 or next;
3412
3413 if (my $smooth = cf::face::find $info->{smooth}) {
3414 cf::face::set_smooth $idx, $smooth;
3415 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3416 } else {
3417 error "smooth face '$info->{smooth}' not found for face '$face'";
3418 }
3419
3420 cf::cede_to_tick;
3421 }
3422 }
3423
3424 {
3425 my $anims = $facedata->{animinfo};
3426
3427 while (my ($anim, $info) = each %$anims) {
3428 cf::anim::set $anim, $info->{frames}, $info->{facings};
3429 cf::cede_to_tick;
3430 }
3431
3432 cf::anim::invalidate_all; # d'oh
3433 }
3434
3435 {
3436 my $res = $facedata->{resource};
3437
3438 while (my ($name, $info) = each %$res) {
3439 if (defined $info->{type}) {
3440 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3441
3442 cf::face::set_data $idx, 0, $info->{data}, $info->{hash};
3443 cf::face::set_type $idx, $info->{type};
3444 } else {
3445 $RESOURCE{$name} = $info; # unused
3446 }
3447
3448 cf::cede_to_tick;
3449 }
3450 }
3451
3452 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3453
3454 1
3455}
3456
3457register_exticmd fx_want => sub {
3458 my ($ns, $want) = @_;
3459
3460 while (my ($k, $v) = each %$want) {
3461 $ns->fx_want ($k, $v);
3462 }
3463};
3464
2285sub load_resources { 3465sub load_resource_file($) {
2286 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir 3466 my $guard = lock_acquire "load_resource_file";
3467
3468 my $status = load_resource_file_ $_[0];
3469 get_slot 0.1, 100;
3470 cf::arch::commit_load;
3471
3472 $status
3473}
3474
3475sub reload_regions {
3476 # HACK to clear player env face cache, we need some signal framework
3477 # for this (global event?)
3478 %ext::player_env::MUSIC_FACE_CACHE = ();
3479
3480 load_resource_file "$MAPDIR/regions"
2287 or die "unable to load regions file\n";#d# 3481 or die "unable to load regions file\n";
2288}
2289 3482
2290sub cfg_load { 3483 for (cf::region::list) {
3484 $_->{match} = qr/$_->{match}/
3485 if exists $_->{match};
3486 }
3487}
3488
3489sub reload_facedata {
3490 load_facedata "$DATADIR/facedata"
3491 or die "unable to load facedata\n";
3492}
3493
3494sub reload_archetypes {
3495 load_resource_file "$DATADIR/archetypes"
3496 or die "unable to load archetypes\n";
3497}
3498
3499sub reload_treasures {
3500 load_resource_file "$DATADIR/treasures"
3501 or die "unable to load treasurelists\n";
3502}
3503
3504sub reload_sound {
3505 trace "loading sound config from $DATADIR/sound\n";
3506
3507 0 < Coro::AIO::aio_load "$DATADIR/sound", my $data
3508 or die "$DATADIR/sound $!";
3509
3510 my $soundconf = JSON::XS->new->utf8->relaxed->decode ($data);
3511
3512 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3513 my $sound = $soundconf->{compat}[$_]
3514 or next;
3515
3516 my $face = cf::face::find "sound/$sound->[1]";
3517 cf::sound::set $sound->[0] => $face;
3518 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3519 }
3520
3521 while (my ($k, $v) = each %{$soundconf->{event}}) {
3522 my $face = cf::face::find "sound/$v";
3523 cf::sound::set $k => $face;
3524 }
3525}
3526
3527sub reload_resources {
3528 trace "reloading resource files...\n";
3529
3530 reload_facedata;
3531 reload_sound;
3532 reload_archetypes;
3533 reload_regions;
3534 reload_treasures;
3535
3536 trace "finished reloading resource files\n";
3537}
3538
3539sub reload_config {
3540 trace "reloading config file...\n";
3541
2291 open my $fh, "<:utf8", cf::confdir . "/config" 3542 open my $fh, "<:utf8", "$CONFDIR/config"
2292 or return; 3543 or return;
2293 3544
2294 local $/; 3545 local $/;
2295 *CFG = YAML::Syck::Load <$fh>; 3546 *CFG = YAML::XS::Load scalar <$fh>;
2296 3547
2297 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; 3548 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_104_115", 49, 38];
2298 3549
2299 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; 3550 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2300 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; 3551 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2301 3552
2302 if (exists $CFG{mlockall}) { 3553 if (exists $CFG{mlockall}) {
2304 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 3555 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2305 and die "WARNING: m(un)lockall failed: $!\n"; 3556 and die "WARNING: m(un)lockall failed: $!\n";
2306 }; 3557 };
2307 warn $@ if $@; 3558 warn $@ if $@;
2308 } 3559 }
2309}
2310 3560
2311sub init { 3561 trace "finished reloading resource files\n";
2312 load_resources; 3562}
3563
3564sub pidfile() {
3565 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3566 or die "$PIDFILE: $!";
3567 flock $fh, &Fcntl::LOCK_EX
3568 or die "$PIDFILE: flock: $!";
3569 $fh
3570}
3571
3572# make sure only one server instance is running at any one time
3573sub atomic {
3574 my $fh = pidfile;
3575
3576 my $pid = <$fh>;
3577 kill 9, $pid if $pid > 0;
3578
3579 seek $fh, 0, 0;
3580 print $fh $$;
3581}
3582
3583sub main_loop {
3584 trace "EV::loop starting\n";
3585 if (1) {
3586 EV::loop;
3587 }
3588 trace "EV::loop returned\n";
3589 goto &main_loop unless $REALLY_UNLOOP;
2313} 3590}
2314 3591
2315sub main { 3592sub main {
3593 cf::init_globals; # initialise logging
3594
3595 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3596 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3597 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3598 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3599
3600 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3601
2316 # we must not ever block the main coroutine 3602 # we must not ever block the main coroutine
2317 local $Coro::idle = sub { 3603 local $Coro::idle = sub {
2318 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# 3604 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2319 (async { 3605 (async {
2320 Event::one_event; 3606 $Coro::current->{desc} = "IDLE BUG HANDLER";
3607 EV::loop EV::LOOP_ONESHOT;
2321 })->prio (Coro::PRIO_MAX); 3608 })->prio (Coro::PRIO_MAX);
2322 }; 3609 };
2323 3610
2324 cfg_load; 3611 evthread_start IO::AIO::poll_fileno;
2325 db_load; 3612
3613 cf::sync_job {
3614 cf::init_experience;
3615 cf::init_anim;
3616 cf::init_attackmess;
3617 cf::init_dynamic;
3618
3619 cf::load_settings;
3620 cf::load_materials;
3621
3622 reload_resources;
3623 reload_config;
3624 db_init;
3625
3626 cf::init_uuid;
3627 cf::init_signals;
3628 cf::init_skills;
3629
3630 cf::init_beforeplay;
3631
3632 atomic;
3633
2326 load_extensions; 3634 load_extensions;
2327 3635
2328 $TICK_WATCHER->start; 3636 utime time, time, $RUNTIMEFILE;
2329 Event::loop; 3637
3638 # no (long-running) fork's whatsoever before this point(!)
3639 use POSIX ();
3640 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3641
3642 (pop @POST_INIT)->(0) while @POST_INIT;
3643 };
3644
3645 cf::object::thawer::errors_are_fatal 0;
3646 info "parse errors in files are no longer fatal from this point on.\n";
3647
3648 main_loop;
2330} 3649}
2331 3650
2332############################################################################# 3651#############################################################################
2333# initialisation and cleanup 3652# initialisation and cleanup
2334 3653
2335# install some emergency cleanup handlers 3654# install some emergency cleanup handlers
2336BEGIN { 3655BEGIN {
3656 our %SIGWATCHER = ();
2337 for my $signal (qw(INT HUP TERM)) { 3657 for my $signal (qw(INT HUP TERM)) {
2338 Event->signal ( 3658 $SIGWATCHER{$signal} = AE::signal $signal, sub {
2339 reentrant => 0,
2340 data => WF_AUTOCANCEL,
2341 signal => $signal,
2342 prio => 0,
2343 cb => sub {
2344 cf::cleanup "SIG$signal"; 3659 cf::cleanup "SIG$signal";
2345 },
2346 ); 3660 };
3661 }
3662}
3663
3664sub write_runtime_sync {
3665 my $t0 = AE::time;
3666
3667 # first touch the runtime file to show we are still running:
3668 # the fsync below can take a very very long time.
3669
3670 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3671
3672 my $guard = cf::lock_acquire "write_runtime";
3673
3674 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT | O_TRUNC, 0644
3675 or return;
3676
3677 my $value = $cf::RUNTIME + 90 + 10;
3678 # 10 is the runtime save interval, for a monotonic clock
3679 # 60 allows for the watchdog to kill the server.
3680
3681 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3682 and return;
3683
3684 # always fsync - this file is important
3685 aio_fsync $fh
3686 and return;
3687
3688 # touch it again to show we are up-to-date
3689 aio_utime $fh, undef, undef;
3690
3691 close $fh
3692 or return;
3693
3694 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3695 and return;
3696
3697 trace sprintf "runtime file written (%gs).\n", AE::time - $t0;
3698
2347 } 3699 1
3700}
3701
3702our $uuid_lock;
3703our $uuid_skip;
3704
3705sub write_uuid_sync($) {
3706 $uuid_skip ||= $_[0];
3707
3708 return if $uuid_lock;
3709 local $uuid_lock = 1;
3710
3711 my $uuid = "$LOCALDIR/uuid";
3712
3713 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3714 or return;
3715
3716 my $value = uuid_seq uuid_cur;
3717
3718 unless ($value) {
3719 info "cowardly refusing to write zero uuid value!\n";
3720 return;
3721 }
3722
3723 my $value = uuid_str $value + $uuid_skip;
3724 $uuid_skip = 0;
3725
3726 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3727 and return;
3728
3729 # always fsync - this file is important
3730 aio_fsync $fh
3731 and return;
3732
3733 close $fh
3734 or return;
3735
3736 aio_rename "$uuid~", $uuid
3737 and return;
3738
3739 trace "uuid file written ($value).\n";
3740
3741 1
3742
3743}
3744
3745sub write_uuid($$) {
3746 my ($skip, $sync) = @_;
3747
3748 $sync ? write_uuid_sync $skip
3749 : async { write_uuid_sync $skip };
2348} 3750}
2349 3751
2350sub emergency_save() { 3752sub emergency_save() {
2351 my $freeze_guard = cf::freeze_mainloop; 3753 my $freeze_guard = cf::freeze_mainloop;
2352 3754
2353 warn "enter emergency perl save\n"; 3755 info "emergency_perl_save: enter\n";
3756
3757 # this is a trade-off: we want to be very quick here, so
3758 # save all maps without fsync, and later call a global sync
3759 # (which in turn might be very very slow)
3760 local $USE_FSYNC = 0;
2354 3761
2355 cf::sync_job { 3762 cf::sync_job {
3763 cf::write_runtime_sync; # external watchdog should not bark
3764
2356 # use a peculiar iteration method to avoid tripping on perl 3765 # use a peculiar iteration method to avoid tripping on perl
2357 # refcount bugs in for. also avoids problems with players 3766 # refcount bugs in for. also avoids problems with players
2358 # and maps saved/destroyed asynchronously. 3767 # and maps saved/destroyed asynchronously.
2359 warn "begin emergency player save\n"; 3768 info "emergency_perl_save: begin player save\n";
2360 for my $login (keys %cf::PLAYER) { 3769 for my $login (keys %cf::PLAYER) {
2361 my $pl = $cf::PLAYER{$login} or next; 3770 my $pl = $cf::PLAYER{$login} or next;
2362 $pl->valid or next; 3771 $pl->valid or next;
3772 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
2363 $pl->save; 3773 $pl->save;
2364 } 3774 }
2365 warn "end emergency player save\n"; 3775 info "emergency_perl_save: end player save\n";
2366 3776
2367 warn "begin emergency map save\n"; 3777 cf::write_runtime_sync; # external watchdog should not bark
3778
3779 info "emergency_perl_save: begin map save\n";
2368 for my $path (keys %cf::MAP) { 3780 for my $path (keys %cf::MAP) {
2369 my $map = $cf::MAP{$path} or next; 3781 my $map = $cf::MAP{$path} or next;
2370 $map->valid or next; 3782 $map->valid or next;
2371 $map->save; 3783 $map->save;
2372 } 3784 }
2373 warn "end emergency map save\n"; 3785 info "emergency_perl_save: end map save\n";
3786
3787 cf::write_runtime_sync; # external watchdog should not bark
3788
3789 info "emergency_perl_save: begin database checkpoint\n";
3790 BDB::db_env_txn_checkpoint $DB_ENV;
3791 info "emergency_perl_save: end database checkpoint\n";
3792
3793 info "emergency_perl_save: begin write uuid\n";
3794 write_uuid_sync 1;
3795 info "emergency_perl_save: end write uuid\n";
3796
3797 cf::write_runtime_sync; # external watchdog should not bark
3798
3799 trace "emergency_perl_save: syncing database to disk";
3800 BDB::db_env_txn_checkpoint $DB_ENV;
3801
3802 info "emergency_perl_save: starting sync\n";
3803 IO::AIO::aio_sync sub {
3804 info "emergency_perl_save: finished sync\n";
3805 };
3806
3807 cf::write_runtime_sync; # external watchdog should not bark
3808
3809 trace "emergency_perl_save: flushing outstanding aio requests";
3810 while (IO::AIO::nreqs || BDB::nreqs) {
3811 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
3812 }
3813
3814 cf::write_runtime_sync; # external watchdog should not bark
2374 }; 3815 };
2375 3816
2376 warn "leave emergency perl save\n"; 3817 info "emergency_perl_save: leave\n";
2377} 3818}
2378 3819
3820sub post_cleanup {
3821 my ($make_core) = @_;
3822
3823 IO::AIO::flush;
3824
3825 error Carp::longmess "post_cleanup backtrace"
3826 if $make_core;
3827
3828 my $fh = pidfile;
3829 unlink $PIDFILE if <$fh> == $$;
3830}
3831
3832# a safer delete_package, copied from Symbol
3833sub clear_package($) {
3834 my $pkg = shift;
3835
3836 # expand to full symbol table name if needed
3837 unless ($pkg =~ /^main::.*::$/) {
3838 $pkg = "main$pkg" if $pkg =~ /^::/;
3839 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3840 $pkg .= '::' unless $pkg =~ /::$/;
3841 }
3842
3843 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3844 my $stem_symtab = *{$stem}{HASH};
3845
3846 defined $stem_symtab and exists $stem_symtab->{$leaf}
3847 or return;
3848
3849 # clear all symbols
3850 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3851 for my $name (keys %$leaf_symtab) {
3852 _gv_clear *{"$pkg$name"};
3853# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3854 }
3855}
3856
2379sub reload() { 3857sub do_reload_perl() {
2380 # can/must only be called in main 3858 # can/must only be called in main
2381 if ($Coro::current != $Coro::main) { 3859 if (in_main) {
2382 warn "can only reload from main coroutine"; 3860 error "can only reload from main coroutine";
2383 return; 3861 return;
2384 } 3862 }
2385 3863
3864 return if $RELOAD++;
3865
3866 my $t1 = AE::time;
3867
3868 while ($RELOAD) {
2386 warn "reloading..."; 3869 info "reloading...";
2387 3870
2388 warn "cancelling server ticker"; 3871 trace "entering sync_job";
2389 $TICK_WATCHER->cancel;
2390 3872
3873 cf::sync_job {
2391 cf::emergency_save; 3874 cf::emergency_save;
2392 3875
2393 eval {
2394 # if anything goes wrong in here, we should simply crash as we already saved
2395
2396 warn "syncing database to disk";
2397 cf::db_sync;
2398
2399 warn "cancelling all WF_AUTOCANCEL watchers";
2400 for (Event::all_watchers) {
2401 $_->cancel if $_->data & WF_AUTOCANCEL;
2402 }
2403
2404 warn "flushing outstanding aio requests";
2405 for (;;) {
2406 IO::AIO::flush;
2407 Coro::cede;
2408 last unless IO::AIO::nreqs;
2409 warn "iterate...";
2410 }
2411
2412 warn "cancelling all extension coros"; 3876 trace "cancelling all extension coros";
2413 $_->cancel for values %EXT_CORO; 3877 $_->cancel for values %EXT_CORO;
2414 %EXT_CORO = (); 3878 %EXT_CORO = ();
2415 3879
2416 warn "removing commands"; 3880 trace "removing commands";
2417 %COMMAND = (); 3881 %COMMAND = ();
2418 3882
2419 warn "removing ext commands"; 3883 trace "removing ext/exti commands";
2420 %EXTCMD = (); 3884 %EXTCMD = ();
3885 %EXTICMD = ();
2421 3886
2422 warn "unloading/nuking all extensions"; 3887 trace "unloading/nuking all extensions";
2423 for my $pkg (@EXTS) { 3888 for my $pkg (@EXTS) {
2424 warn "... unloading $pkg"; 3889 trace "... unloading $pkg";
2425 3890
2426 if (my $cb = $pkg->can ("unload")) { 3891 if (my $cb = $pkg->can ("unload")) {
2427 eval { 3892 eval {
2428 $cb->($pkg); 3893 $cb->($pkg);
2429 1 3894 1
2430 } or warn "$pkg unloaded, but with errors: $@"; 3895 } or error "$pkg unloaded, but with errors: $@";
3896 }
3897
3898 trace "... clearing $pkg";
3899 clear_package $pkg;
2431 } 3900 }
2432 3901
2433 warn "... nuking $pkg";
2434 Symbol::delete_package $pkg;
2435 }
2436
2437 warn "unloading all perl modules loaded from $LIBDIR"; 3902 trace "unloading all perl modules loaded from $LIBDIR";
2438 while (my ($k, $v) = each %INC) { 3903 while (my ($k, $v) = each %INC) {
2439 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 3904 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
2440 3905
2441 warn "... unloading $k"; 3906 trace "... unloading $k";
2442 delete $INC{$k}; 3907 delete $INC{$k};
2443 3908
2444 $k =~ s/\.pm$//; 3909 $k =~ s/\.pm$//;
2445 $k =~ s/\//::/g; 3910 $k =~ s/\//::/g;
2446 3911
2447 if (my $cb = $k->can ("unload_module")) { 3912 if (my $cb = $k->can ("unload_module")) {
2448 $cb->(); 3913 $cb->();
3914 }
3915
3916 clear_package $k;
2449 } 3917 }
2450 3918
2451 Symbol::delete_package $k;
2452 }
2453
2454 warn "getting rid of safe::, as good as possible"; 3919 trace "getting rid of safe::, as good as possible";
2455 Symbol::delete_package "safe::$_" 3920 clear_package "safe::$_"
2456 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3921 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2457 3922
2458 warn "unloading cf.pm \"a bit\""; 3923 trace "unloading cf.pm \"a bit\"";
2459 delete $INC{"cf.pm"}; 3924 delete $INC{"cf.pm"};
3925 delete $INC{"cf/$_.pm"} for @EXTRA_MODULES;
2460 3926
2461 # don't, removes xs symbols, too, 3927 # don't, removes xs symbols, too,
2462 # and global variables created in xs 3928 # and global variables created in xs
2463 #Symbol::delete_package __PACKAGE__; 3929 #clear_package __PACKAGE__;
2464 3930
2465 warn "unload completed, starting to reload now"; 3931 info "unload completed, starting to reload now";
2466 3932
2467 warn "reloading cf.pm"; 3933 trace "reloading cf.pm";
2468 require cf; 3934 require cf;
2469 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3935 cf::_connect_to_perl_1;
2470 3936
2471 warn "loading config and database again"; 3937 trace "loading config and database again";
2472 cf::cfg_load; 3938 cf::reload_config;
2473 cf::db_load;
2474 3939
2475 warn "loading extensions"; 3940 trace "loading extensions";
2476 cf::load_extensions; 3941 cf::load_extensions;
2477 3942
3943 if ($REATTACH_ON_RELOAD) {
2478 warn "reattaching attachments to objects/players"; 3944 trace "reattaching attachments to objects/players";
2479 _global_reattach; 3945 _global_reattach; # objects, sockets
2480 warn "reattaching attachments to maps"; 3946 trace "reattaching attachments to maps";
2481 reattach $_ for values %MAP; 3947 reattach $_ for values %MAP;
3948 trace "reattaching attachments to players";
3949 reattach $_ for values %PLAYER;
3950 }
2482 3951
2483 warn "loading reloadable resources"; 3952 trace "running post_init jobs";
2484 load_resources; 3953 (pop @POST_INIT)->(1) while @POST_INIT;
2485 3954
2486 warn "restarting server ticker"; 3955 trace "leaving sync_job";
2487 3956
2488 $TICK_WATCHER->start; 3957 1
3958 } or do {
3959 error $@;
3960 cf::cleanup "error while reloading, exiting.";
3961 };
3962
3963 info "reloaded";
3964 --$RELOAD;
3965 }
3966
3967 $t1 = AE::time - $t1;
3968 info "reload completed in ${t1}s\n";
3969};
3970
3971our $RELOAD_WATCHER; # used only during reload
3972
3973sub reload_perl() {
3974 # doing reload synchronously and two reloads happen back-to-back,
3975 # coro crashes during coro_state_free->destroy here.
3976
3977 $RELOAD_WATCHER ||= cf::async {
3978 Coro::AIO::aio_wait cache_extensions;
3979
3980 $RELOAD_WATCHER = AE::timer $TICK * 1.5, 0, sub {
3981 do_reload_perl;
3982 undef $RELOAD_WATCHER;
3983 };
2489 }; 3984 };
2490 3985}
2491 if ($@) {
2492 warn $@;
2493 warn "error while reloading, exiting.";
2494 exit 1;
2495 }
2496
2497 warn "reloaded";
2498};
2499
2500our $RELOAD_WATCHER; # used only during reload
2501 3986
2502register_command "reload" => sub { 3987register_command "reload" => sub {
2503 my ($who, $arg) = @_; 3988 my ($who, $arg) = @_;
2504 3989
2505 if ($who->flag (FLAG_WIZ)) { 3990 if ($who->flag (FLAG_WIZ)) {
2506 $who->message ("reloading server."); 3991 $who->message ("reloading server.");
2507 3992 async {
2508 # doing reload synchronously and two reloads happen back-to-back, 3993 $Coro::current->{desc} = "perl_reload";
2509 # coro crashes during coro_state_free->destroy here.
2510
2511 $RELOAD_WATCHER ||= Event->timer (
2512 reentrant => 0,
2513 after => 0,
2514 data => WF_AUTOCANCEL,
2515 cb => sub {
2516 reload; 3994 reload_perl;
2517 undef $RELOAD_WATCHER;
2518 },
2519 ); 3995 };
2520 } 3996 }
2521}; 3997};
2522 3998
2523unshift @INC, $LIBDIR; 3999unshift @INC, $LIBDIR;
2524 4000
2525my $bug_warning = 0; 4001my $bug_warning = 0;
2526 4002
2527$TICK_WATCHER = Event->timer ( 4003our @WAIT_FOR_TICK;
2528 reentrant => 0, 4004our @WAIT_FOR_TICK_BEGIN;
2529 parked => 1, 4005
2530 prio => 0, 4006sub wait_for_tick {
2531 at => $NEXT_TICK || $TICK, 4007 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
2532 data => WF_AUTOCANCEL, 4008
2533 cb => sub { 4009 my $signal = new Coro::Signal;
4010 push @WAIT_FOR_TICK, $signal;
4011 $signal->wait;
4012}
4013
4014sub wait_for_tick_begin {
4015 return Coro::cede if tick_inhibit || $Coro::current == $Coro::main;
4016
4017 my $signal = new Coro::Signal;
4018 push @WAIT_FOR_TICK_BEGIN, $signal;
4019 $signal->wait;
4020}
4021
4022sub tick {
2534 if ($Coro::current != $Coro::main) { 4023 if ($Coro::current != $Coro::main) {
2535 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 4024 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2536 unless ++$bug_warning > 10; 4025 unless ++$bug_warning > 10;
2537 return; 4026 return;
2538 } 4027 }
2539 4028
2540 $NOW = Event::time;
2541
2542 cf::server_tick; # one server iteration 4029 cf::server_tick; # one server iteration
2543 $RUNTIME += $TICK;
2544 $NEXT_TICK += $TICK;
2545 4030
2546 $WAIT_FOR_TICK->broadcast; 4031 #for(1..3e6){} AE::now_update; $NOW=AE::now; # generate load #d#
2547 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2548 4032
2549 Event::sweep; 4033 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2550 Coro::cede_notself; 4034 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
4035 Coro::async_pool {
4036 $Coro::current->{desc} = "runtime saver";
4037 write_runtime_sync
4038 or error "ERROR: unable to write runtime file: $!";
4039 };
4040 }
4041
4042 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
4043 $sig->send;
4044 }
4045 while (my $sig = shift @WAIT_FOR_TICK) {
4046 $sig->send;
4047 }
4048
4049 $LOAD = ($NOW - $TICK_START) / $TICK;
4050 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
4051
4052 if (0) {
4053 if ($NEXT_TICK) {
4054 my $jitter = $TICK_START - $NEXT_TICK;
4055 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
4056 debug "jitter $JITTER\n";#d#
2551 4057 }
2552# my $AFTER = Event::time;
2553# warn $AFTER - $NOW;#d#
2554
2555 # if we are delayed by four ticks or more, skip them all
2556 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
2557
2558 $TICK_WATCHER->at ($NEXT_TICK);
2559 $TICK_WATCHER->start;
2560 }, 4058 }
2561); 4059}
2562 4060
2563{ 4061{
2564 BDB::max_poll_time $TICK * 0.1; 4062 # configure BDB
2565 $BDB_POLL_WATCHER = Event->io ( 4063
2566 reentrant => 0,
2567 fd => BDB::poll_fileno,
2568 poll => 'r',
2569 prio => 0,
2570 data => WF_AUTOCANCEL,
2571 cb => \&BDB::poll_cb,
2572 );
2573 BDB::min_parallel 8; 4064 BDB::min_parallel 16;
2574 4065 BDB::max_poll_reqs $TICK * 0.1;
2575 BDB::set_sync_prepare { 4066 $AnyEvent::BDB::WATCHER->priority (1);
2576 my $status;
2577 my $current = $Coro::current;
2578 (
2579 sub {
2580 $status = $!;
2581 $current->ready; undef $current;
2582 },
2583 sub {
2584 Coro::schedule while defined $current;
2585 $! = $status;
2586 },
2587 )
2588 };
2589 4067
2590 unless ($DB_ENV) { 4068 unless ($DB_ENV) {
2591 $DB_ENV = BDB::db_env_create; 4069 $DB_ENV = BDB::db_env_create;
4070 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
4071 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
4072 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
4073 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
4074 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
2592 4075
2593 cf::sync_job { 4076 cf::sync_job {
4077 eval {
2594 BDB::db_env_open 4078 BDB::db_env_open
2595 $DB_ENV, 4079 $DB_ENV,
2596 $BDB_ENV_DIR, 4080 $BDBDIR,
2597 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 4081 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2598 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 4082 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2599 0666; 4083 0666;
2600 4084
2601 cf::cleanup "$!" if $!; 4085 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2602 4086 };
2603 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 4087
2604 $DB_ENV->set_lk_detect; 4088 cf::cleanup "db_env_open(db): $@" if $@;
2605 }; 4089 };
2606 } 4090 }
4091
4092 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
4093 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
4094 };
4095 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
4096 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
4097 };
4098 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
4099 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
4100 };
2607} 4101}
2608 4102
2609{ 4103{
4104 # configure IO::AIO
4105
2610 IO::AIO::min_parallel 8; 4106 IO::AIO::min_parallel 8;
2611
2612 undef $Coro::AIO::WATCHER;
2613 IO::AIO::max_poll_time $TICK * 0.1; 4107 IO::AIO::max_poll_time $TICK * 0.1;
2614 $AIO_POLL_WATCHER = Event->io ( 4108 undef $AnyEvent::AIO::WATCHER;
2615 reentrant => 0,
2616 fd => IO::AIO::poll_fileno,
2617 poll => 'r',
2618 prio => 6,
2619 data => WF_AUTOCANCEL,
2620 cb => \&IO::AIO::poll_cb,
2621 );
2622} 4109}
2623 4110
2624$WRITE_RUNTIME_WATCHER = Event->timer ( 4111my $_log_backtrace;
2625 reentrant => 0, 4112
2626 data => WF_AUTOCANCEL, 4113sub _log_backtrace {
2627 after => 1, 4114 my ($msg, @addr) = @_;
2628 interval => 10, 4115
2629 prio => 6, # keep it lowest so it acts like a watchdog 4116 $msg =~ s/\n//;
2630 cb => Coro::unblock_sub { 4117
2631 write_runtime 4118 # limit the # of concurrent backtraces
2632 or warn "ERROR: unable to write runtime file: $!"; 4119 if ($_log_backtrace < 2) {
4120 ++$_log_backtrace;
4121 my $perl_bt = Carp::longmess $msg;
4122 async {
4123 $Coro::current->{desc} = "abt $msg";
4124
4125 my @bt = fork_call {
4126 @addr = map { sprintf "%x", $_ } @addr;
4127 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
4128 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
4129 or die "addr2line: $!";
4130
4131 my @funcs;
4132 my @res = <$fh>;
4133 chomp for @res;
4134 while (@res) {
4135 my ($func, $line) = splice @res, 0, 2, ();
4136 push @funcs, "[$func] $line";
4137 }
4138
4139 @funcs
4140 };
4141
4142 LOG llevInfo, "[ABT] $perl_bt\n";
4143 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
4144 LOG llevInfo, "[ABT] $_\n" for @bt;
4145 --$_log_backtrace;
4146 };
4147 } else {
4148 LOG llevInfo, "[ABT] $msg\n";
4149 LOG llevInfo, "[ABT] [suppressed]\n";
2633 }, 4150 }
2634); 4151}
4152
4153# load additional modules
4154require "cf/$_.pm" for @EXTRA_MODULES;
4155cf::_connect_to_perl_2;
2635 4156
2636END { cf::emergency_save } 4157END { cf::emergency_save }
2637 4158
26381 41591
2639 4160

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines