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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines