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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines