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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines