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.109 by root, Sun Dec 31 22:23:12 2006 UTC vs.
Revision 1.464 by root, Thu Jan 1 18:35:48 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines