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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines