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.200 by root, Mon Jan 29 17:57:22 2007 UTC vs.
Revision 1.549 by root, Tue May 11 13:19:59 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines