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.122 by root, Tue Jan 2 17:32:24 2007 UTC vs.
Revision 1.527 by root, Fri Apr 23 04:32:47 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines