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.146 by root, Sun Jan 7 23:10:43 2007 UTC vs.
Revision 1.478 by root, Thu Sep 17 01:57:31 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines