ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines