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.108 by root, Sun Dec 31 21:02:05 2006 UTC vs.
Revision 1.462 by root, Tue Dec 23 06:58:23 2008 UTC

1#
2# This file is part of Deliantra, the Roguelike Realtime MMORPG.
3#
4# Copyright (©) 2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5#
6# Deliantra is free software: you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation, either version 3 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with this program. If not, see <http://www.gnu.org/licenses/>.
18#
19# The authors can be reached via e-mail to <support@deliantra.net>
20#
21
1package cf; 22package cf;
2 23
24use 5.10.0;
3use utf8; 25use utf8;
4use strict; 26use strict "vars", "subs";
5 27
6use Symbol; 28use Symbol;
7use List::Util; 29use List::Util;
8use Storable; 30use Socket;
31use EV;
9use Opcode; 32use Opcode;
10use Safe; 33use Safe;
11use Safe::Hole; 34use Safe::Hole;
35use Storable ();
12 36
37use Guard ();
13use Coro 3.3; 38use Coro ();
39use Coro::State;
40use Coro::Handle;
41use Coro::EV;
14use Coro::Event; 42use Coro::AnyEvent;
15use Coro::Timer; 43use Coro::Timer;
16use Coro::Signal; 44use Coro::Signal;
17use Coro::Semaphore; 45use Coro::Semaphore;
46use Coro::SemaphoreSet;
47use Coro::AnyEvent;
18use Coro::AIO; 48use Coro::AIO;
49use Coro::BDB 1.6;
50use Coro::Storable;
51use Coro::Util ();
19 52
53use JSON::XS 2.01 ();
54use BDB ();
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 $self->{random} = cf::from_json $path;
287 } else {
288 if ($path =~ s{^~([^/]+)?}{}) {
289 $self->{user_rel} = 1;
290
291 if (defined $1) {
292 $self->{user} = $1;
293 } elsif ($base =~ m{^~([^/]+)/}) {
294 $self->{user} = $1;
295 } else {
296 warn "cannot resolve user-relative path without user <$path,$base>\n";
297 }
298 } elsif ($path =~ /^\//) {
299 # already absolute
300 } else {
301 $base =~ s{[^/]+/?$}{};
302 return $class->new ("$base/$path");
303 }
304
305 for ($path) {
306 redo if s{/\.?/}{/};
307 redo if s{/[^/]+/\.\./}{/};
308 }
309 }
310
311 $self->{path} = $path;
312
313 $self
314}
315
316# the name / primary key / in-game path
317sub as_string {
318 my ($self) = @_;
319
320 $self->{user_rel} ? "~$self->{user}$self->{path}"
321 : $self->{random} ? "?random/$self->{path}"
322 : $self->{path}
323}
324
325# the displayed name, this is a one way mapping
326sub visible_name {
327 my ($self) = @_;
328
329 $self->{random} ? "?random/$self->{random}{origin_map}+$self->{random}{origin_x}+$self->{random}{origin_y}/$self->{random}{dungeon_level}"
330 : $self->as_string
331}
332
333# escape the /'s in the path
334sub _escaped_path {
335 # ∕ is U+2215
336 (my $path = $_[0]{path}) =~ s/\//∕/g;
337 $path
338}
339
340# the original (read-only) location
341sub load_path {
342 my ($self) = @_;
343
344 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
345}
346
347# the temporary/swap location
348sub save_path {
349 my ($self) = @_;
350
351 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
352 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, Digest::MD5::md5_hex $self->{path}
353 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
354}
355
356# the unique path, might be eq to save_path
357sub uniq_path {
358 my ($self) = @_;
359
360 $self->{user_rel} || $self->{random}
361 ? undef
362 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
363}
364
365# return random map parameters, or undef
366sub random_map_params {
367 my ($self) = @_;
368
369 $self->{random}
370}
371
372# this is somewhat ugly, but style maps do need special treatment
373sub is_style_map {
374 $_[0]{path} =~ m{^/styles/}
375}
376
377package cf;
378
379#############################################################################
380
381=head2 ATTACHABLE OBJECTS 730=head2 ATTACHABLE OBJECTS
382 731
383Many 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
384attach callbacks/event handlers (a collection of which is called an "attachment") 733attach callbacks/event handlers (a collection of which is called an "attachment")
385to it. All such attachable objects support the following methods. 734to it. All such attachable objects support the following methods.
386 735
387In 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>
388C<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
389crossfire+). 738Deliantra).
390 739
391=over 4 740=over 4
392 741
393=item $attachable->attach ($attachment, key => $value...) 742=item $attachable->attach ($attachment, key => $value...)
394 743
438=item cf::CLASS::attachment $name, ... 787=item cf::CLASS::attachment $name, ...
439 788
440Register an attachment by C<$name> through which attachable objects of the 789Register an attachment by C<$name> through which attachable objects of the
441given CLASS can refer to this attachment. 790given CLASS can refer to this attachment.
442 791
443Some classes such as crossfire maps and objects can specify attachments 792Some classes such as deliantra maps and objects can specify attachments
444that 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.
445 794
446These calls expect any number of the following handler/hook descriptions: 795These calls expect any number of the following handler/hook descriptions:
447 796
448=over 4 797=over 4
508our @CB_TYPE = (); # registry for type (cf-object class) based events 857our @CB_TYPE = (); # registry for type (cf-object class) based events
509our @CB_MAP = (); 858our @CB_MAP = ();
510 859
511my %attachment; 860my %attachment;
512 861
862sub cf::attachable::thawer_merge {
863 # simply override everything except _meta
864 local $_[0]{_meta};
865 %{$_[0]} = %{$_[1]};
866}
867
513sub _attach_cb($$$$) { 868sub _attach_cb($$$$) {
514 my ($registry, $event, $prio, $cb) = @_; 869 my ($registry, $event, $prio, $cb) = @_;
515 870
516 use sort 'stable'; 871 use sort 'stable';
517 872
551 $registry = $CB_TYPE[$object_type] ||= []; 906 $registry = $CB_TYPE[$object_type] ||= [];
552 907
553 } elsif ($type eq "subtype") { 908 } elsif ($type eq "subtype") {
554 defined $object_type or Carp::croak "subtype specified without type"; 909 defined $object_type or Carp::croak "subtype specified without type";
555 my $object_subtype = shift @arg; 910 my $object_subtype = shift @arg;
556 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 911 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
557 912
558 } elsif ($type eq "package") { 913 } elsif ($type eq "package") {
559 my $pkg = shift @arg; 914 my $pkg = shift @arg;
560 915
561 while (my ($name, $id) = each %cb_id) { 916 while (my ($name, $id) = each %cb_id) {
590 _attach $registry, $klass, @attach; 945 _attach $registry, $klass, @attach;
591 } 946 }
592 947
593 $obj->{$name} = \%arg; 948 $obj->{$name} = \%arg;
594 } else { 949 } else {
595 warn "object uses attachment '$name' that is not available, postponing.\n"; 950 warn "object uses attachment '$name' which is not available, postponing.\n";
596 } 951 }
597 952
598 $obj->{_attachment}{$name} = undef; 953 $obj->{_attachment}{$name} = undef;
599} 954}
600 955
602 if (ref $_[0]) { 957 if (ref $_[0]) {
603 _object_attach @_; 958 _object_attach @_;
604 } else { 959 } else {
605 _attach shift->_attach_registry, @_; 960 _attach shift->_attach_registry, @_;
606 } 961 }
962 _recalc_want;
607}; 963};
608 964
609# all those should be optimised 965# all those should be optimised
610sub cf::attachable::detach { 966sub cf::attachable::detach {
611 my ($obj, $name) = @_; 967 my ($obj, $name) = @_;
614 delete $obj->{_attachment}{$name}; 970 delete $obj->{_attachment}{$name};
615 reattach ($obj); 971 reattach ($obj);
616 } else { 972 } else {
617 Carp::croak "cannot, currently, detach class attachments"; 973 Carp::croak "cannot, currently, detach class attachments";
618 } 974 }
975 _recalc_want;
619}; 976};
620 977
621sub cf::attachable::attached { 978sub cf::attachable::attached {
622 my ($obj, $name) = @_; 979 my ($obj, $name) = @_;
623 980
638 "; 995 ";
639 die if $@; 996 die if $@;
640} 997}
641 998
642our $override; 999our $override;
643our @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?
644 1001
645sub override { 1002sub override {
646 $override = 1; 1003 $override = 1;
647 @invoke_results = (); 1004 @INVOKE_RESULTS = (@_);
648} 1005}
649 1006
650sub do_invoke { 1007sub do_invoke {
651 my $event = shift; 1008 my $event = shift;
652 my $callbacks = shift; 1009 my $callbacks = shift;
653 1010
654 @invoke_results = (); 1011 @INVOKE_RESULTS = ();
655 1012
656 local $override; 1013 local $override;
657 1014
658 for (@$callbacks) { 1015 for (@$callbacks) {
659 eval { &{$_->[1]} }; 1016 eval { &{$_->[1]} };
668 } 1025 }
669 1026
670 0 1027 0
671} 1028}
672 1029
673=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) 1030=item $bool = cf::global->invoke (EVENT_CLASS_XXX, ...)
674 1031
675=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) 1032=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
676 1033
677Generate an object-specific event with the given arguments. 1034Generate an object-specific event with the given arguments.
678 1035
679This 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
680removed 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
681results (if you must, access C<@cf::invoke_results> directly). 1038results (if you must, access C<@cf::INVOKE_RESULTS> directly).
682 1039
683=back 1040=back
684 1041
685=cut 1042=cut
686 1043
687############################################################################# 1044#############################################################################
688# 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}
689 1088
690sub reattach { 1089sub reattach {
691 # basically do the same as instantiate, without calling instantiate 1090 # basically do the same as instantiate, without calling instantiate
692 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
693 1095
694 my $registry = $obj->registry; 1096 my $registry = $obj->registry;
695 1097
696 @$registry = (); 1098 @$registry = ();
697 1099
712cf::attachable->attach ( 1114cf::attachable->attach (
713 prio => -1000000, 1115 prio => -1000000,
714 on_instantiate => sub { 1116 on_instantiate => sub {
715 my ($obj, $data) = @_; 1117 my ($obj, $data) = @_;
716 1118
717 $data = from_json $data; 1119 $data = decode_json $data;
718 1120
719 for (@$data) { 1121 for (@$data) {
720 my ($name, $args) = @$_; 1122 my ($name, $args) = @$_;
721 1123
722 $obj->attach ($name, %{$args || {} }); 1124 $obj->attach ($name, %{$args || {} });
738sub object_freezer_save { 1140sub object_freezer_save {
739 my ($filename, $rdata, $objs) = @_; 1141 my ($filename, $rdata, $objs) = @_;
740 1142
741 sync_job { 1143 sync_job {
742 if (length $$rdata) { 1144 if (length $$rdata) {
1145 utf8::decode (my $decname = $filename);
743 warn sprintf "saving %s (%d,%d)\n", 1146 warn sprintf "saving %s (%d,%d)\n",
744 $filename, length $$rdata, scalar @$objs; 1147 $decname, length $$rdata, scalar @$objs;
745 1148
746 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { 1149 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
747 chmod SAVE_MODE, $fh; 1150 aio_chmod $fh, SAVE_MODE;
748 aio_write $fh, 0, (length $$rdata), $$rdata, 0; 1151 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
749 aio_fsync $fh; 1152 aio_fsync $fh if $cf::USE_FSYNC;
750 close $fh; 1153 aio_close $fh;
751 1154
752 if (@$objs) { 1155 if (@$objs) {
753 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) {
754 chmod SAVE_MODE, $fh; 1157 aio_chmod $fh, SAVE_MODE;
755 my $data = Storable::nfreeze { version => 1, objs => $objs }; 1158 my $data = Coro::Storable::nfreeze { version => 1, objs => $objs };
756 aio_write $fh, 0, (length $data), $data, 0; 1159 aio_write $fh, 0, (length $data), $data, 0;
757 aio_fsync $fh; 1160 aio_fsync $fh if $cf::USE_FSYNC;
758 close $fh; 1161 aio_close $fh;
759 aio_rename "$filename.pst~", "$filename.pst"; 1162 aio_rename "$filename.pst~", "$filename.pst";
760 } 1163 }
761 } else { 1164 } else {
762 aio_unlink "$filename.pst"; 1165 aio_unlink "$filename.pst";
763 } 1166 }
764 1167
765 aio_rename "$filename~", $filename; 1168 aio_rename "$filename~", $filename;
1169
1170 $filename =~ s%/[^/]+$%%;
1171 aio_pathsync $filename if $cf::USE_FSYNC;
766 } else { 1172 } else {
767 warn "FATAL: $filename~: $!\n"; 1173 warn "unable to save objects: $filename~: $!\n";
768 } 1174 }
769 } else { 1175 } else {
770 aio_unlink $filename; 1176 aio_unlink $filename;
771 aio_unlink "$filename.pst"; 1177 aio_unlink "$filename.pst";
772 } 1178 }
773 } 1179 };
774} 1180}
775 1181
776sub object_freezer_as_string { 1182sub object_freezer_as_string {
777 my ($rdata, $objs) = @_; 1183 my ($rdata, $objs) = @_;
778 1184
790 or return; 1196 or return;
791 1197
792 unless (aio_stat "$filename.pst") { 1198 unless (aio_stat "$filename.pst") {
793 (aio_load "$filename.pst", $av) >= 0 1199 (aio_load "$filename.pst", $av) >= 0
794 or return; 1200 or return;
1201
795 $av = eval { (Storable::thaw <$av>)->{objs} }; 1202 my $st = eval { Coro::Storable::thaw $av };
1203 $av = $st->{objs};
796 } 1204 }
797 1205
1206 utf8::decode (my $decname = $filename);
1207 warn sprintf "loading %s (%d,%d)\n",
1208 $decname, length $data, scalar @{$av || []};
1209
798 return ($data, $av); 1210 ($data, $av)
799} 1211}
1212
1213=head2 COMMAND CALLBACKS
1214
1215=over 4
1216
1217=cut
800 1218
801############################################################################# 1219#############################################################################
802# command handling &c 1220# command handling &c
803 1221
804=item cf::register_command $name => \&callback($ob,$args); 1222=item cf::register_command $name => \&callback($ob,$args);
817 push @{ $COMMAND{$name} }, [$caller, $cb]; 1235 push @{ $COMMAND{$name} }, [$caller, $cb];
818} 1236}
819 1237
820=item cf::register_extcmd $name => \&callback($pl,$packet); 1238=item cf::register_extcmd $name => \&callback($pl,$packet);
821 1239
822Register 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.
823 1245
824If 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
825called. 1247called.
826 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
827=cut 1260=cut
828 1261
829sub register_extcmd { 1262sub register_extcmd {
830 my ($name, $cb) = @_; 1263 my ($name, $cb) = @_;
831 1264
832 my $caller = caller;
833 #warn "registering extcmd '$name' to '$caller'";
834
835 $EXTCMD{$name} = [$cb, $caller]; 1265 $EXTCMD{$name} = $cb;
836} 1266}
1267
1268sub register_exticmd {
1269 my ($name, $cb) = @_;
1270
1271 $EXTICMD{$name} = $cb;
1272}
1273
1274use File::Glob ();
837 1275
838cf::player->attach ( 1276cf::player->attach (
839 on_command => sub { 1277 on_command => sub {
840 my ($pl, $name, $params) = @_; 1278 my ($pl, $name, $params) = @_;
841 1279
849 cf::override; 1287 cf::override;
850 }, 1288 },
851 on_extcmd => sub { 1289 on_extcmd => sub {
852 my ($pl, $buf) = @_; 1290 my ($pl, $buf) = @_;
853 1291
854 my $msg = eval { from_json $buf }; 1292 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
855 1293
856 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
857 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1302 if (my $cb = $EXTCMD{$type}) {
858 if (my %reply = $cb->[0]->($pl, $msg)) { 1303 @reply = $cb->($pl, @payload);
859 $pl->ext_reply ($msg->{msgid}, %reply);
860 }
861 } 1304 }
1305
1306 $pl->ext_reply ($reply, @reply)
1307 if $reply;
1308
862 } else { 1309 } else {
863 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1310 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
864 } 1311 }
865 1312
866 cf::override; 1313 cf::override;
867 }, 1314 },
868); 1315);
869 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
870sub 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 {
871 my ($base, $pkg) = @_; 1762 my ($self, $merge) = @_;
872 1763
873 #TODO 1764 # we have to keep some variables in memory intact
874} 1765 local $self->{path};
1766 local $self->{load_path};
875 1767
876sub load_extension { 1768 $self->SUPER::thawer_merge ($merge);
1769}
1770
1771sub normalise {
877 my ($path) = @_; 1772 my ($path, $base) = @_;
878 1773
879 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 1774 $path = "$path"; # make sure its a string
880 my $base = $1;
881 my $pkg = $1;
882 $pkg =~ s/[^[:word:]]/_/g;
883 $pkg = "ext::$pkg";
884 1775
885 warn "loading '$path' into '$pkg'\n"; 1776 $path =~ s/\.map$//;
886 1777
887 open my $fh, "<:utf8", $path 1778 # map plan:
888 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
889 1786
890 my $source = 1787 $path =~ s/$PATH_SEP/\//go;
891 "package $pkg; use strict; use utf8;\n"
892 . "#line 1 \"$path\"\n{\n"
893 . (do { local $/; <$fh> })
894 . "\n};\n1";
895 1788
896 eval $source 1789 # treat it as relative path if it starts with
897 or die $@ ? "$path: $@\n" 1790 # something that looks reasonable
898 : "extension disabled.\n"; 1791 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1792 $base or Carp::carp "normalise called with relative path and no base: '$path'";
899 1793
900 push @exts, $pkg; 1794 $base =~ s{[^/]+/?$}{};
901 $ext_pkg{$base} = $pkg; 1795 $path = "$base/$path";
902
903# no strict 'refs';
904# @{"$pkg\::ISA"} = ext::;
905
906 register $base, $pkg;
907}
908
909sub unload_extension {
910 my ($pkg) = @_;
911
912 warn "removing extension $pkg\n";
913
914 # remove hooks
915 #TODO
916# for my $idx (0 .. $#PLUGIN_EVENT) {
917# delete $hook[$idx]{$pkg};
918# } 1796 }
919 1797
920 # remove commands 1798 for ($path) {
921 for my $name (keys %COMMAND) { 1799 redo if s{//}{/};
922 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; 1800 redo if s{/\.?/}{/};
1801 redo if s{/[^/]+/\.\./}{/};
1802 }
923 1803
924 if (@cb) { 1804 $path
925 $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;
926 } else { 1937 } else {
927 delete $COMMAND{$name}; 1938 $self->load_header_orig
928 } 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
929 } 1949 1
1950}
930 1951
931 # remove extcmds 1952sub find;
932 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { 1953sub find {
933 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
934 } 1993 {
1994 my $guard = cf::lock_acquire "map_data:$path";
935 1995
936 if (my $cb = $pkg->can ("unload")) { 1996 return unless $self->valid;
937 eval { 1997 return unless $self->in_memory == cf::MAP_SWAPPED;
938 $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 }
939 1 2022 }
940 } or warn "$pkg unloaded, but with errors: $@"; 2023 }
941 }
942 2024
943 Symbol::delete_package $pkg; 2025 $f->resolve_delayed_derefs;
944}
945 2026
946sub load_extensions { 2027 cf::cede_to_tick;
947 for my $ext (<$LIBDIR/*.ext>) { 2028 # now do the right thing for maps
948 next unless -r $ext; 2029 $self->link_multipart_objects;
949 eval { 2030 $self->difficulty ($self->estimate_difficulty)
950 load_extension $ext; 2031 unless $self->difficulty;
951 1 2032 cf::cede_to_tick;
952 } or warn "$ext not loaded: $@";
953 }
954}
955 2033
956############################################################################# 2034 unless ($self->{deny_activate}) {
957# 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 }
958 2041
959*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 {
960 my ($map) = @_; 2065 my ($map) = @_;
961 2066
962 my $path = $map->tmpname; 2067 my @neigh; # diagonal neighbours
963 defined $path or return;
964 2068
965 unlink "$path.pst"; 2069 for (0 .. 3) {
966}; 2070 my $neigh = $map->tile_path ($_)
2071 or next;
2072 $neigh = find $neigh, $map
2073 or next;
2074 $neigh->load;
967 2075
968cf::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 }
969 2080
970############################################################################# 2081 for (grep defined $_->[0], @neigh) {
971# load/save perl data associated with player->ob objects 2082 my ($path, $origin) = @$_;
972 2083 my $neigh = find $path, $origin
973sub all_objects(@) { 2084 or next;
974 @_, map all_objects ($_->inv), @_ 2085 $neigh->load;
2086 }
975} 2087}
976 2088
977# TODO: compatibility cruft, remove when no longer needed 2089sub find_sync {
978cf::player->attach ( 2090 my ($path, $origin) = @_;
979 on_load => sub {
980 my ($pl, $path) = @_;
981 2091
982 for my $o (all_objects $pl->ob) { 2092 cf::sync_job { find $path, $origin }
983 if (my $value = $o->get_ob_key_value ("_perl_data")) { 2093}
984 $o->set_ob_key_value ("_perl_data");
985 2094
986 %$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};
987 } 2128 }
988 } 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);
989 }, 2167 }
990); 2168}
991 2169
992############################################################################# 2170sub swap_out {
2171 my ($self) = @_;
993 2172
994=head2 CORE EXTENSIONS 2173 # save first because save cedes
2174 $self->save;
995 2175
996Functions and methods that extend core crossfire objects. 2176 my $lock = cf::lock_acquire "map_data:$self->{path}";
997 2177
998=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;
999 2322
1000=over 4 2323=over 4
1001 2324
1002=item cf::player::exists $login 2325=item $ob->inv_recursive
1003 2326
1004Returns true when the given account exists. 2327Returns the inventory of the object I<and> their inventories, recursively,
2328but I<not> the object itself.
1005 2329
1006=cut 2330=cut
1007 2331
1008sub cf::player::exists($) { 2332sub inv_recursive_;
1009 cf::player::find $_[0] 2333sub inv_recursive_ {
1010 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 2334 map { $_, inv_recursive_ $_->inv } @_
1011} 2335}
1012 2336
1013=item $player->ext_reply ($msgid, $msgtype, %msg) 2337sub inv_recursive {
1014 2338 inv_recursive_ inv $_[0]
1015Sends an ext reply to the player.
1016
1017=cut
1018
1019sub cf::player::ext_reply($$$%) {
1020 my ($self, $id, %msg) = @_;
1021
1022 $msg{msgid} = $id;
1023
1024 $self->send ("ext " . to_json \%msg);
1025} 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;
1026 2370
1027=back 2371=back
1028 2372
1029=head3 cf::object::player 2373=head3 cf::object::player
1030 2374
1035Sends 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>
1036can 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
1037dialogue with the given NPC character. 2381dialogue with the given NPC character.
1038 2382
1039=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};
1040 2398
1041# rough implementation of a future "reply" method that works 2399# rough implementation of a future "reply" method that works
1042# with dialog boxes. 2400# with dialog boxes.
1043#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
1044sub cf::object::player::reply($$$;$) { 2402sub cf::object::player::reply($$$;$) {
1046 2404
1047 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2405 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1048 2406
1049 if ($self->{record_replies}) { 2407 if ($self->{record_replies}) {
1050 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2408 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2409
1051 } 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 {
1052 $msg = $npc->name . " says: $msg" if $npc; 2418 $msg = $npc->name . " says: $msg" if $npc;
1053 $self->message ($msg, $flags); 2419 $self->send_msg ($SAY_CHANNEL => $msg, $flags);
2420 }
1054 } 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 (@_);
1055} 2432}
1056 2433
1057=item $player_object->may ("access") 2434=item $player_object->may ("access")
1058 2435
1059Returns wether the given player is authorized to access resource "access" 2436Returns wether the given player is authorized to access resource "access"
1068 (ref $cf::CFG{"may_$access"} 2445 (ref $cf::CFG{"may_$access"}
1069 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 2446 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1070 : $cf::CFG{"may_$access"}) 2447 : $cf::CFG{"may_$access"})
1071} 2448}
1072 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
1073=head3 cf::client 2709=head3 cf::client
1074 2710
1075=over 4 2711=over 4
1076 2712
1077=item $client->send_drawinfo ($text, $flags) 2713=item $client->send_drawinfo ($text, $flags)
1083 2719
1084sub cf::client::send_drawinfo { 2720sub cf::client::send_drawinfo {
1085 my ($self, $text, $flags) = @_; 2721 my ($self, $text, $flags) = @_;
1086 2722
1087 utf8::encode $text; 2723 utf8::encode $text;
1088 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2724 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1089} 2725}
1090 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/say" => $SAY_CHANNEL,
2799 "c/chat" => $CHAT_CHANNEL,
2800);
2801
2802sub cf::client::send_msg {
2803 my ($self, $channel, $msg, $color, @extra) = @_;
2804
2805 $msg = $self->pl->expand_cfpod ($msg)
2806 unless $color & cf::NDI_VERBATIM;
2807
2808 $color &= cf::NDI_CLIENT_MASK; # just in case...
2809
2810 # check predefined channels, for the benefit of C
2811 if ($CHANNEL{$channel}) {
2812 $channel = $CHANNEL{$channel};
2813
2814 $self->ext_msg (channel_info => $channel)
2815 if $self->can_msg;
2816
2817 $channel = $channel->{id};
2818
2819 } elsif (ref $channel) {
2820 # send meta info to client, if not yet sent
2821 unless (exists $self->{channel}{$channel->{id}}) {
2822 $self->{channel}{$channel->{id}} = $channel;
2823 $self->ext_msg (channel_info => $channel)
2824 if $self->can_msg;
2825 }
2826
2827 $channel = $channel->{id};
2828 }
2829
2830 return unless @extra || length $msg;
2831
2832 if ($self->can_msg) {
2833 # default colour, mask it out
2834 $color &= ~(cf::NDI_COLOR_MASK | cf::NDI_DEF)
2835 if $color & cf::NDI_DEF;
2836
2837 my $pkt = "msg "
2838 . $self->{json_coder}->encode (
2839 [$color & cf::NDI_CLIENT_MASK, $channel, $msg, @extra]
2840 );
2841
2842 # try lzf for large packets
2843 $pkt = "lzf " . Compress::LZF::compress $pkt
2844 if 1024 <= length $pkt and $self->{can_lzf};
2845
2846 # split very large packets
2847 if (8192 < length $pkt and $self->{can_lzf}) {
2848 $self->send_packet ("frag $_") for unpack "(a8192)*", $pkt;
2849 $pkt = "frag";
2850 }
2851
2852 $self->send_packet ($pkt);
2853 } else {
2854 if ($color >= 0) {
2855 # replace some tags by gcfclient-compatible ones
2856 for ($msg) {
2857 1 while
2858 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2859 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2860 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2861 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2862 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2863 }
2864
2865 $color &= cf::NDI_COLOR_MASK;
2866
2867 utf8::encode $msg;
2868
2869 if (0 && $msg =~ /\[/) {
2870 # COMMAND/INFO
2871 $self->send_packet ("drawextinfo $color 10 8 $msg")
2872 } else {
2873 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2874 $self->send_packet ("drawinfo $color $msg")
2875 }
2876 }
2877 }
2878}
2879
2880=item $client->ext_msg ($type, @msg)
2881
2882Sends an ext event to the client.
2883
2884=cut
2885
2886sub cf::client::ext_msg($$@) {
2887 my ($self, $type, @msg) = @_;
2888
2889 if ($self->extcmd == 2) {
2890 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2891 } elsif ($self->extcmd == 1) { # TODO: remove
2892 push @msg, msgtype => "event_$type";
2893 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2894 }
2895}
2896
2897=item $client->ext_reply ($msgid, @msg)
2898
2899Sends an ext reply to the client.
2900
2901=cut
2902
2903sub cf::client::ext_reply($$@) {
2904 my ($self, $id, @msg) = @_;
2905
2906 if ($self->extcmd == 2) {
2907 $self->send_packet ("ext " . $self->{json_coder}->encode (["reply-$id", @msg]));
2908 } elsif ($self->extcmd == 1) {
2909 #TODO: version 1, remove
2910 unshift @msg, msgtype => "reply", msgid => $id;
2911 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2912 }
2913}
1091 2914
1092=item $success = $client->query ($flags, "text", \&cb) 2915=item $success = $client->query ($flags, "text", \&cb)
1093 2916
1094Queues a query to the client, calling the given callback with 2917Queues a query to the client, calling the given callback with
1095the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2918the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1096C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2919C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1097 2920
1098Queries can fail, so check the return code. Or don't, as queries will become 2921Queries can fail, so check the return code. Or don't, as queries will
1099reliable at some point in the future. 2922become reliable at some point in the future.
1100 2923
1101=cut 2924=cut
1102 2925
1103sub cf::client::query { 2926sub cf::client::query {
1104 my ($self, $flags, $text, $cb) = @_; 2927 my ($self, $flags, $text, $cb) = @_;
1112 utf8::encode $text; 2935 utf8::encode $text;
1113 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2936 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1114 2937
1115 $self->send_packet ($self->{query_queue}[0][0]) 2938 $self->send_packet ($self->{query_queue}[0][0])
1116 if @{ $self->{query_queue} } == 1; 2939 if @{ $self->{query_queue} } == 1;
2940
2941 1
1117} 2942}
1118 2943
1119cf::client->attach ( 2944cf::client->attach (
2945 on_connect => sub {
2946 my ($ns) = @_;
2947
2948 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2949 },
1120 on_reply => sub { 2950 on_reply => sub {
1121 my ($ns, $msg) = @_; 2951 my ($ns, $msg) = @_;
1122 2952
1123 # this weird shuffling is so that direct followup queries 2953 # this weird shuffling is so that direct followup queries
1124 # get handled first 2954 # get handled first
1125 my $queue = delete $ns->{query_queue}; 2955 my $queue = delete $ns->{query_queue}
2956 or return; # be conservative, not sure how that can happen, but we saw a crash here
1126 2957
1127 (shift @$queue)->[1]->($msg); 2958 (shift @$queue)->[1]->($msg);
2959 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
1128 2960
1129 push @{ $ns->{query_queue} }, @$queue; 2961 push @{ $ns->{query_queue} }, @$queue;
1130 2962
1131 if (@{ $ns->{query_queue} } == @$queue) { 2963 if (@{ $ns->{query_queue} } == @$queue) {
1132 if (@$queue) { 2964 if (@$queue) {
1134 } else { 2966 } else {
1135 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2967 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1136 } 2968 }
1137 } 2969 }
1138 }, 2970 },
2971 on_exticmd => sub {
2972 my ($ns, $buf) = @_;
2973
2974 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2975
2976 if (ref $msg) {
2977 my ($type, $reply, @payload) =
2978 "ARRAY" eq ref $msg
2979 ? @$msg
2980 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2981
2982 my @reply;
2983
2984 if (my $cb = $EXTICMD{$type}) {
2985 @reply = $cb->($ns, @payload);
2986 }
2987
2988 $ns->ext_reply ($reply, @reply)
2989 if $reply;
2990
2991 } else {
2992 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2993 }
2994
2995 cf::override;
2996 },
1139); 2997);
1140 2998
1141=item $client->coro (\&cb) 2999=item $client->async (\&cb)
1142 3000
1143Create a new coroutine, running the specified callback. The coroutine will 3001Create a new coroutine, running the specified callback. The coroutine will
1144be automatically cancelled when the client gets destroyed (e.g. on logout, 3002be automatically cancelled when the client gets destroyed (e.g. on logout,
1145or loss of connection). 3003or loss of connection).
1146 3004
1147=cut 3005=cut
1148 3006
1149sub cf::client::coro { 3007sub cf::client::async {
1150 my ($self, $cb) = @_; 3008 my ($self, $cb) = @_;
1151 3009
1152 my $coro; $coro = async { 3010 my $coro = &Coro::async ($cb);
1153 eval {
1154 $cb->();
1155 };
1156 warn $@ if $@;
1157 };
1158 3011
1159 $coro->on_destroy (sub { 3012 $coro->on_destroy (sub {
1160 delete $self->{_coro}{$coro+0}; 3013 delete $self->{_coro}{$coro+0};
1161 }); 3014 });
1162 3015
1189our $safe = new Safe "safe"; 3042our $safe = new Safe "safe";
1190our $safe_hole = new Safe::Hole; 3043our $safe_hole = new Safe::Hole;
1191 3044
1192$SIG{FPE} = 'IGNORE'; 3045$SIG{FPE} = 'IGNORE';
1193 3046
1194$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); 3047$safe->permit_only (Opcode::opset qw(
3048 :base_core :base_mem :base_orig :base_math
3049 grepstart grepwhile mapstart mapwhile
3050 sort time
3051));
1195 3052
1196# here we export the classes and methods available to script code 3053# here we export the classes and methods available to script code
1197 3054
1198=pod 3055=pod
1199 3056
1200The following fucntions and emthods are available within a safe environment: 3057The following functions and methods are available within a safe environment:
1201 3058
1202 cf::object contr pay_amount pay_player map 3059 cf::object
3060 contr pay_amount pay_player map x y force_find force_add destroy
3061 insert remove name archname title slaying race decrease split
3062
1203 cf::object::player player 3063 cf::object::player
1204 cf::player peaceful 3064 player
1205 cf::map trigger 3065
3066 cf::player
3067 peaceful
3068
3069 cf::map
3070 trigger
1206 3071
1207=cut 3072=cut
1208 3073
1209for ( 3074for (
1210 ["cf::object" => qw(contr pay_amount pay_player map)], 3075 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
3076 insert remove inv nrof name archname title slaying race
3077 decrease split destroy change_exp)],
1211 ["cf::object::player" => qw(player)], 3078 ["cf::object::player" => qw(player)],
1212 ["cf::player" => qw(peaceful)], 3079 ["cf::player" => qw(peaceful)],
1213 ["cf::map" => qw(trigger)], 3080 ["cf::map" => qw(trigger)],
1214) { 3081) {
1215 no strict 'refs'; 3082 no strict 'refs';
1286=back 3153=back
1287 3154
1288=cut 3155=cut
1289 3156
1290############################################################################# 3157#############################################################################
3158# the server's init and main functions
1291 3159
1292=head2 EXTENSION DATABASE SUPPORT 3160sub load_facedata($) {
3161 my ($path) = @_;
1293 3162
1294Crossfire maintains a very simple database for extension use. It can 3163 # HACK to clear player env face cache, we need some signal framework
1295currently store anything that can be serialised using Storable, which 3164 # for this (global event?)
1296excludes objects. 3165 %ext::player_env::MUSIC_FACE_CACHE = ();
1297 3166
1298The parameter C<$family> should best start with the name of the extension 3167 my $enc = JSON::XS->new->utf8->canonical->relaxed;
1299using it, it should be unique.
1300 3168
1301=over 4 3169 warn "loading facedata from $path\n";
1302 3170
1303=item $hashref = cf::db_get $family 3171 my $facedata;
3172 0 < aio_load $path, $facedata
3173 or die "$path: $!";
1304 3174
1305Return a hashref for use by the extension C<$family>, which can be 3175 $facedata = Coro::Storable::thaw $facedata;
1306modified. After modifications, you have to call C<cf::db_dirty> or
1307C<cf::db_sync>.
1308 3176
1309=item $value = cf::db_get $family => $key 3177 $facedata->{version} == 2
3178 or cf::cleanup "$path: version mismatch, cannot proceed.";
1310 3179
1311Returns a single value from the database 3180 # patch in the exptable
1312 3181 $facedata->{resource}{"res/exp_table"} = {
1313=item cf::db_put $family => $hashref 3182 type => FT_RSRC,
1314 3183 data => $enc->encode ([map cf::level_to_min_exp $_, 1 .. cf::settings->max_level]),
1315Stores the given family hashref into the database. Updates are delayed, if
1316you want the data to be synced to disk immediately, use C<cf::db_sync>.
1317
1318=item cf::db_put $family => $key => $value
1319
1320Stores the given C<$value> in the family hash. Updates are delayed, if you
1321want the data to be synced to disk immediately, use C<cf::db_sync>.
1322
1323=item cf::db_dirty
1324
1325Marks the database as dirty, to be updated at a later time.
1326
1327=item cf::db_sync
1328
1329Immediately write the database to disk I<if it is dirty>.
1330
1331=cut
1332
1333our $DB;
1334
1335{
1336 my $path = cf::localdir . "/database.pst";
1337
1338 sub db_load() {
1339 warn "loading database $path\n";#d# remove later
1340 $DB = stat $path ? Storable::retrieve $path : { };
1341 }
1342
1343 my $pid;
1344
1345 sub db_save() {
1346 warn "saving database $path\n";#d# remove later
1347 waitpid $pid, 0 if $pid;
1348 if (0 == ($pid = fork)) {
1349 $DB->{_meta}{version} = 1;
1350 Storable::nstore $DB, "$path~";
1351 rename "$path~", $path;
1352 cf::_exit 0 if defined $pid;
1353 }
1354 }
1355
1356 my $dirty;
1357
1358 sub db_sync() {
1359 db_save if $dirty;
1360 undef $dirty;
1361 }
1362
1363 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1364 db_sync;
1365 }); 3184 };
3185 cf::cede_to_tick;
1366 3186
1367 sub db_dirty() {
1368 $dirty = 1;
1369 $idle->start;
1370 } 3187 {
3188 my $faces = $facedata->{faceinfo};
1371 3189
1372 sub db_get($;$) { 3190 while (my ($face, $info) = each %$faces) {
1373 @_ >= 2 3191 my $idx = (cf::face::find $face) || cf::face::alloc $face;
1374 ? $DB->{$_[0]}{$_[1]}
1375 : ($DB->{$_[0]} ||= { })
1376 }
1377 3192
1378 sub db_put($$;$) { 3193 cf::face::set_visibility $idx, $info->{visibility};
1379 if (@_ >= 3) { 3194 cf::face::set_magicmap $idx, $info->{magicmap};
1380 $DB->{$_[0]}{$_[1]} = $_[2]; 3195 cf::face::set_data $idx, 0, $info->{data32}, Digest::MD5::md5 $info->{data32};
1381 } else { 3196 cf::face::set_data $idx, 1, $info->{data64}, Digest::MD5::md5 $info->{data64};
1382 $DB->{$_[0]} = $_[1];
1383 }
1384 db_dirty;
1385 }
1386 3197
1387 cf::global->attach ( 3198 cf::cede_to_tick;
1388 prio => 10000,
1389 on_cleanup => sub {
1390 db_sync;
1391 }, 3199 }
1392 );
1393}
1394 3200
1395############################################################################# 3201 while (my ($face, $info) = each %$faces) {
1396# the server's main() 3202 next unless $info->{smooth};
1397 3203
1398sub cfg_load { 3204 my $idx = cf::face::find $face
3205 or next;
3206
3207 if (my $smooth = cf::face::find $info->{smooth}) {
3208 cf::face::set_smooth $idx, $smooth;
3209 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
3210 } else {
3211 warn "smooth face '$info->{smooth}' not found for face '$face'";
3212 }
3213
3214 cf::cede_to_tick;
3215 }
3216 }
3217
3218 {
3219 my $anims = $facedata->{animinfo};
3220
3221 while (my ($anim, $info) = each %$anims) {
3222 cf::anim::set $anim, $info->{frames}, $info->{facings};
3223 cf::cede_to_tick;
3224 }
3225
3226 cf::anim::invalidate_all; # d'oh
3227 }
3228
3229 {
3230 # TODO: for gcfclient pleasure, we should give resources
3231 # that gcfclient doesn't grok a >10000 face index.
3232 my $res = $facedata->{resource};
3233
3234 while (my ($name, $info) = each %$res) {
3235 if (defined $info->{type}) {
3236 my $idx = (cf::face::find $name) || cf::face::alloc $name;
3237 my $data;
3238
3239 if ($info->{type} & 1) {
3240 # prepend meta info
3241
3242 my $meta = $enc->encode ({
3243 name => $name,
3244 %{ $info->{meta} || {} },
3245 });
3246
3247 $data = pack "(w/a*)*", $meta, $info->{data};
3248 } else {
3249 $data = $info->{data};
3250 }
3251
3252 cf::face::set_data $idx, 0, $data, Digest::MD5::md5 $data;
3253 cf::face::set_type $idx, $info->{type};
3254 } else {
3255 $RESOURCE{$name} = $info;
3256 }
3257
3258 cf::cede_to_tick;
3259 }
3260 }
3261
3262 cf::global->invoke (EVENT_GLOBAL_RESOURCE_UPDATE);
3263
3264 1
3265}
3266
3267cf::global->attach (on_resource_update => sub {
3268 if (my $soundconf = $RESOURCE{"res/sound.conf"}) {
3269 $soundconf = JSON::XS->new->utf8->relaxed->decode ($soundconf->{data});
3270
3271 for (0 .. SOUND_CAST_SPELL_0 - 1) {
3272 my $sound = $soundconf->{compat}[$_]
3273 or next;
3274
3275 my $face = cf::face::find "sound/$sound->[1]";
3276 cf::sound::set $sound->[0] => $face;
3277 cf::sound::old_sound_index $_, $face; # gcfclient-compat
3278 }
3279
3280 while (my ($k, $v) = each %{$soundconf->{event}}) {
3281 my $face = cf::face::find "sound/$v";
3282 cf::sound::set $k => $face;
3283 }
3284 }
3285});
3286
3287register_exticmd fx_want => sub {
3288 my ($ns, $want) = @_;
3289
3290 while (my ($k, $v) = each %$want) {
3291 $ns->fx_want ($k, $v);
3292 }
3293};
3294
3295sub load_resource_file($) {
3296 my $guard = lock_acquire "load_resource_file";
3297
3298 my $status = load_resource_file_ $_[0];
3299 get_slot 0.1, 100;
3300 cf::arch::commit_load;
3301
3302 $status
3303}
3304
3305sub reload_regions {
3306 # HACK to clear player env face cache, we need some signal framework
3307 # for this (global event?)
3308 %ext::player_env::MUSIC_FACE_CACHE = ();
3309
3310 load_resource_file "$MAPDIR/regions"
3311 or die "unable to load regions file\n";
3312
3313 for (cf::region::list) {
3314 $_->{match} = qr/$_->{match}/
3315 if exists $_->{match};
3316 }
3317}
3318
3319sub reload_facedata {
3320 load_facedata "$DATADIR/facedata"
3321 or die "unable to load facedata\n";
3322}
3323
3324sub reload_archetypes {
3325 load_resource_file "$DATADIR/archetypes"
3326 or die "unable to load archetypes\n";
3327}
3328
3329sub reload_treasures {
3330 load_resource_file "$DATADIR/treasures"
3331 or die "unable to load treasurelists\n";
3332}
3333
3334sub reload_resources {
3335 warn "reloading resource files...\n";
3336
3337 reload_facedata;
3338 reload_archetypes;
3339 reload_regions;
3340 reload_treasures;
3341
3342 warn "finished reloading resource files\n";
3343}
3344
3345sub reload_config {
1399 open my $fh, "<:utf8", cf::confdir . "/config" 3346 open my $fh, "<:utf8", "$CONFDIR/config"
1400 or return; 3347 or return;
1401 3348
1402 local $/; 3349 local $/;
1403 *CFG = YAML::Syck::Load <$fh>; 3350 *CFG = YAML::Load <$fh>;
3351
3352 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
3353
3354 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
3355 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
3356
3357 if (exists $CFG{mlockall}) {
3358 eval {
3359 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
3360 and die "WARNING: m(un)lockall failed: $!\n";
3361 };
3362 warn $@ if $@;
3363 }
3364}
3365
3366sub pidfile() {
3367 sysopen my $fh, $PIDFILE, O_RDWR | O_CREAT
3368 or die "$PIDFILE: $!";
3369 flock $fh, &Fcntl::LOCK_EX
3370 or die "$PIDFILE: flock: $!";
3371 $fh
3372}
3373
3374# make sure only one server instance is running at any one time
3375sub atomic {
3376 my $fh = pidfile;
3377
3378 my $pid = <$fh>;
3379 kill 9, $pid if $pid > 0;
3380
3381 seek $fh, 0, 0;
3382 print $fh $$;
1404} 3383}
1405 3384
1406sub main { 3385sub main {
3386 cf::init_globals; # initialise logging
3387
3388 LOG llevInfo, "Welcome to Deliantra, v" . VERSION;
3389 LOG llevInfo, "Copyright (C) 2005-2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team.";
3390 LOG llevInfo, "Copyright (C) 1994 Mark Wedel.";
3391 LOG llevInfo, "Copyright (C) 1992 Frank Tore Johansen.";
3392
3393 cf::init_experience;
3394 cf::init_anim;
3395 cf::init_attackmess;
3396 cf::init_dynamic;
3397
3398 $Coro::current->prio (Coro::PRIO_MAX); # give the main loop max. priority
3399
1407 # we must not ever block the main coroutine 3400 # we must not ever block the main coroutine
1408 local $Coro::idle = sub { 3401 local $Coro::idle = sub {
1409 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# 3402 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1410 (Coro::unblock_sub { 3403 (async {
1411 Event::one_event; 3404 $Coro::current->{desc} = "IDLE BUG HANDLER";
1412 })->(); 3405 EV::loop EV::LOOP_ONESHOT;
3406 })->prio (Coro::PRIO_MAX);
1413 }; 3407 };
1414 3408
1415 cfg_load; 3409 evthread_start IO::AIO::poll_fileno;
1416 db_load; 3410
3411 cf::sync_job {
3412 reload_resources;
3413 reload_config;
3414 db_init;
3415
3416 cf::load_settings;
3417 cf::load_materials;
3418 cf::init_uuid;
3419 cf::init_signals;
3420 cf::init_commands;
3421 cf::init_skills;
3422
3423 cf::init_beforeplay;
3424
3425 atomic;
3426
1417 load_extensions; 3427 load_extensions;
3428
3429 utime time, time, $RUNTIMEFILE;
3430
3431 # no (long-running) fork's whatsoever before this point(!)
3432 POSIX::close delete $ENV{LOCKUTIL_LOCK_FD} if exists $ENV{LOCKUTIL_LOCK_FD};
3433
3434 (pop @POST_INIT)->(0) while @POST_INIT;
3435 };
3436
1418 Event::loop; 3437 EV::loop;
1419} 3438}
1420 3439
1421############################################################################# 3440#############################################################################
1422# initialisation 3441# initialisation and cleanup
1423 3442
1424sub perl_reload() { 3443# install some emergency cleanup handlers
3444BEGIN {
3445 our %SIGWATCHER = ();
3446 for my $signal (qw(INT HUP TERM)) {
3447 $SIGWATCHER{$signal} = EV::signal $signal, sub {
3448 cf::cleanup "SIG$signal";
3449 };
3450 }
3451}
3452
3453sub write_runtime_sync {
3454 # first touch the runtime file to show we are still running:
3455 # the fsync below can take a very very long time.
3456
3457 IO::AIO::aio_utime $RUNTIMEFILE, undef, undef;
3458
3459 my $guard = cf::lock_acquire "write_runtime";
3460
3461 my $fh = aio_open "$RUNTIMEFILE~", O_WRONLY | O_CREAT, 0644
3462 or return;
3463
3464 my $value = $cf::RUNTIME + 90 + 10;
3465 # 10 is the runtime save interval, for a monotonic clock
3466 # 60 allows for the watchdog to kill the server.
3467
3468 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3469 and return;
3470
3471 # always fsync - this file is important
3472 aio_fsync $fh
3473 and return;
3474
3475 # touch it again to show we are up-to-date
3476 aio_utime $fh, undef, undef;
3477
3478 close $fh
3479 or return;
3480
3481 aio_rename "$RUNTIMEFILE~", $RUNTIMEFILE
3482 and return;
3483
3484 warn "runtime file written.\n";
3485
3486 1
3487}
3488
3489our $uuid_lock;
3490our $uuid_skip;
3491
3492sub write_uuid_sync($) {
3493 $uuid_skip ||= $_[0];
3494
3495 return if $uuid_lock;
3496 local $uuid_lock = 1;
3497
3498 my $uuid = "$LOCALDIR/uuid";
3499
3500 my $fh = aio_open "$uuid~", O_WRONLY | O_CREAT, 0644
3501 or return;
3502
3503 my $value = uuid_seq uuid_cur;
3504
3505 unless ($value) {
3506 warn "cowardly refusing to write zero uuid value!\n";
3507 return;
3508 }
3509
3510 my $value = uuid_str $value + $uuid_skip;
3511 $uuid_skip = 0;
3512
3513 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3514 and return;
3515
3516 # always fsync - this file is important
3517 aio_fsync $fh
3518 and return;
3519
3520 close $fh
3521 or return;
3522
3523 aio_rename "$uuid~", $uuid
3524 and return;
3525
3526 warn "uuid file written ($value).\n";
3527
3528 1
3529
3530}
3531
3532sub write_uuid($$) {
3533 my ($skip, $sync) = @_;
3534
3535 $sync ? write_uuid_sync $skip
3536 : async { write_uuid_sync $skip };
3537}
3538
3539sub emergency_save() {
3540 my $freeze_guard = cf::freeze_mainloop;
3541
3542 warn "emergency_perl_save: enter\n";
3543
3544 cf::sync_job {
3545 # this is a trade-off: we want to be very quick here, so
3546 # save all maps without fsync, and later call a global sync
3547 # (which in turn might be very very slow)
3548 local $USE_FSYNC = 0;
3549
3550 # use a peculiar iteration method to avoid tripping on perl
3551 # refcount bugs in for. also avoids problems with players
3552 # and maps saved/destroyed asynchronously.
3553 warn "emergency_perl_save: begin player save\n";
3554 for my $login (keys %cf::PLAYER) {
3555 my $pl = $cf::PLAYER{$login} or next;
3556 $pl->valid or next;
3557 delete $pl->{unclean_save}; # not strictly necessary, but cannot hurt
3558 $pl->save;
3559 }
3560 warn "emergency_perl_save: end player save\n";
3561
3562 warn "emergency_perl_save: begin map save\n";
3563 for my $path (keys %cf::MAP) {
3564 my $map = $cf::MAP{$path} or next;
3565 $map->valid or next;
3566 $map->save;
3567 }
3568 warn "emergency_perl_save: end map save\n";
3569
3570 warn "emergency_perl_save: begin database checkpoint\n";
3571 BDB::db_env_txn_checkpoint $DB_ENV;
3572 warn "emergency_perl_save: end database checkpoint\n";
3573
3574 warn "emergency_perl_save: begin write uuid\n";
3575 write_uuid_sync 1;
3576 warn "emergency_perl_save: end write uuid\n";
3577 };
3578
3579 warn "emergency_perl_save: starting sync()\n";
3580 IO::AIO::aio_sync sub {
3581 warn "emergency_perl_save: finished sync()\n";
3582 };
3583
3584 warn "emergency_perl_save: leave\n";
3585}
3586
3587sub post_cleanup {
3588 my ($make_core) = @_;
3589
3590 warn Carp::longmess "post_cleanup backtrace"
3591 if $make_core;
3592
3593 my $fh = pidfile;
3594 unlink $PIDFILE if <$fh> == $$;
3595}
3596
3597# a safer delete_package, copied from Symbol
3598sub clear_package($) {
3599 my $pkg = shift;
3600
3601 # expand to full symbol table name if needed
3602 unless ($pkg =~ /^main::.*::$/) {
3603 $pkg = "main$pkg" if $pkg =~ /^::/;
3604 $pkg = "main::$pkg" unless $pkg =~ /^main::/;
3605 $pkg .= '::' unless $pkg =~ /::$/;
3606 }
3607
3608 my($stem, $leaf) = $pkg =~ m/(.*::)(\w+::)$/;
3609 my $stem_symtab = *{$stem}{HASH};
3610
3611 defined $stem_symtab and exists $stem_symtab->{$leaf}
3612 or return;
3613
3614 # clear all symbols
3615 my $leaf_symtab = *{$stem_symtab->{$leaf}}{HASH};
3616 for my $name (keys %$leaf_symtab) {
3617 _gv_clear *{"$pkg$name"};
3618# use PApp::Util; PApp::Util::sv_dump *{"$pkg$name"};
3619 }
3620 warn "cleared package $pkg\n";#d#
3621}
3622
3623sub do_reload_perl() {
1425 # can/must only be called in main 3624 # can/must only be called in main
1426 if ($Coro::current != $Coro::main) { 3625 if ($Coro::current != $Coro::main) {
1427 warn "can only reload from main coroutine\n"; 3626 warn "can only reload from main coroutine";
1428 return; 3627 return;
1429 } 3628 }
1430 3629
3630 return if $RELOAD++;
3631
3632 my $t1 = EV::time;
3633
3634 while ($RELOAD) {
1431 warn "reloading..."; 3635 warn "reloading...";
1432 3636
1433 local $FREEZE = 1; 3637 warn "entering sync_job";
3638
3639 cf::sync_job {
3640 cf::write_runtime_sync; # external watchdog should not bark
1434 cf::emergency_save; 3641 cf::emergency_save;
3642 cf::write_runtime_sync; # external watchdog should not bark
1435 3643
1436 eval { 3644 warn "syncing database to disk";
3645 BDB::db_env_txn_checkpoint $DB_ENV;
3646
1437 # if anything goes wrong in here, we should simply crash as we already saved 3647 # if anything goes wrong in here, we should simply crash as we already saved
1438 3648
1439 # cancel all watchers 3649 warn "flushing outstanding aio requests";
1440 for (Event::all_watchers) { 3650 while (IO::AIO::nreqs || BDB::nreqs) {
1441 $_->cancel if $_->data & WF_AUTOCANCEL; 3651 Coro::EV::timer_once 0.01; # let the sync_job do it's thing
1442 }
1443
1444 # cancel all extension coros
1445 $_->cancel for values %EXT_CORO;
1446 %EXT_CORO = ();
1447
1448 # unload all extensions
1449 for (@exts) {
1450 warn "unloading <$_>";
1451 unload_extension $_;
1452 }
1453
1454 # unload all modules loaded from $LIBDIR
1455 while (my ($k, $v) = each %INC) {
1456 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1457
1458 warn "removing <$k>";
1459 delete $INC{$k};
1460
1461 $k =~ s/\.pm$//;
1462 $k =~ s/\//::/g;
1463
1464 if (my $cb = $k->can ("unload_module")) {
1465 $cb->();
1466 } 3652 }
1467 3653
1468 Symbol::delete_package $k; 3654 warn "cancelling all extension coros";
3655 $_->cancel for values %EXT_CORO;
3656 %EXT_CORO = ();
3657
3658 warn "removing commands";
3659 %COMMAND = ();
3660
3661 warn "removing ext/exti commands";
3662 %EXTCMD = ();
3663 %EXTICMD = ();
3664
3665 warn "unloading/nuking all extensions";
3666 for my $pkg (@EXTS) {
3667 warn "... unloading $pkg";
3668
3669 if (my $cb = $pkg->can ("unload")) {
3670 eval {
3671 $cb->($pkg);
3672 1
3673 } or warn "$pkg unloaded, but with errors: $@";
3674 }
3675
3676 warn "... clearing $pkg";
3677 clear_package $pkg;
1469 } 3678 }
1470 3679
1471 # sync database to disk 3680 warn "unloading all perl modules loaded from $LIBDIR";
1472 cf::db_sync; 3681 while (my ($k, $v) = each %INC) {
1473 IO::AIO::flush; 3682 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1474 3683
3684 warn "... unloading $k";
3685 delete $INC{$k};
3686
3687 $k =~ s/\.pm$//;
3688 $k =~ s/\//::/g;
3689
3690 if (my $cb = $k->can ("unload_module")) {
3691 $cb->();
3692 }
3693
3694 clear_package $k;
3695 }
3696
1475 # get rid of safe::, as good as possible 3697 warn "getting rid of safe::, as good as possible";
1476 Symbol::delete_package "safe::$_" 3698 clear_package "safe::$_"
1477 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3699 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1478 3700
1479 # remove register_script_function callbacks 3701 warn "unloading cf.pm \"a bit\"";
1480 # TODO
1481
1482 # unload cf.pm "a bit"
1483 delete $INC{"cf.pm"}; 3702 delete $INC{"cf.pm"};
3703 delete $INC{"cf/pod.pm"};
1484 3704
1485 # don't, removes xs symbols, too, 3705 # don't, removes xs symbols, too,
1486 # and global variables created in xs 3706 # and global variables created in xs
1487 #Symbol::delete_package __PACKAGE__; 3707 #clear_package __PACKAGE__;
1488 3708
1489 # reload cf.pm 3709 warn "unload completed, starting to reload now";
3710
1490 warn "reloading cf.pm"; 3711 warn "reloading cf.pm";
1491 require cf; 3712 require cf;
1492 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt 3713 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1493 3714
1494 # load config and database again 3715 warn "loading config and database again";
1495 cf::cfg_load; 3716 cf::reload_config;
1496 cf::db_load;
1497 3717
1498 # load extensions
1499 warn "load extensions"; 3718 warn "loading extensions";
1500 cf::load_extensions; 3719 cf::load_extensions;
1501 3720
1502 # reattach attachments to objects 3721 if ($REATTACH_ON_RELOAD) {
3722 warn "reattaching attachments to objects/players";
3723 _global_reattach; # objects, sockets
3724 warn "reattaching attachments to maps";
3725 reattach $_ for values %MAP;
3726 warn "reattaching attachments to players";
3727 reattach $_ for values %PLAYER;
3728 }
3729
3730 warn "running post_init jobs";
3731 (pop @POST_INIT)->(1) while @POST_INIT;
3732
3733 warn "leaving sync_job";
3734
3735 1
3736 } or do {
3737 warn $@;
3738 cf::cleanup "error while reloading, exiting.";
3739 };
3740
1503 warn "reattach"; 3741 warn "reloaded";
1504 _global_reattach; 3742 --$RELOAD;
3743 }
3744
3745 $t1 = EV::time - $t1;
3746 warn "reload completed in ${t1}s\n";
3747};
3748
3749our $RELOAD_WATCHER; # used only during reload
3750
3751sub reload_perl() {
3752 # doing reload synchronously and two reloads happen back-to-back,
3753 # coro crashes during coro_state_free->destroy here.
3754
3755 $RELOAD_WATCHER ||= cf::async {
3756 Coro::AIO::aio_wait cache_extensions;
3757
3758 $RELOAD_WATCHER = EV::timer $TICK * 1.5, 0, sub {
3759 do_reload_perl;
3760 undef $RELOAD_WATCHER;
3761 };
1505 }; 3762 };
3763}
1506 3764
1507 if ($@) { 3765register_command "reload" => sub {
1508 warn $@; 3766 my ($who, $arg) = @_;
1509 warn "error while reloading, exiting.";
1510 exit 1;
1511 }
1512 3767
1513 warn "reloaded successfully"; 3768 if ($who->flag (FLAG_WIZ)) {
3769 $who->message ("reloading server.");
3770 async {
3771 $Coro::current->{desc} = "perl_reload";
3772 reload_perl;
3773 };
3774 }
1514}; 3775};
1515 3776
1516#############################################################################
1517
1518unless ($LINK_MAP) {
1519 $LINK_MAP = cf::map::new;
1520
1521 $LINK_MAP->width (41);
1522 $LINK_MAP->height (41);
1523 $LINK_MAP->alloc;
1524 $LINK_MAP->path ("{link}");
1525 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1526 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1527}
1528
1529register "<global>", __PACKAGE__;
1530
1531register_command "perl-reload" => sub {
1532 my ($who, $arg) = @_;
1533
1534 if ($who->flag (FLAG_WIZ)) {
1535 $who->message ("start of reload.");
1536 perl_reload;
1537 $who->message ("end of reload.");
1538 }
1539};
1540
1541unshift @INC, $LIBDIR; 3777unshift @INC, $LIBDIR;
1542 3778
1543$TICK_WATCHER = Event->timer ( 3779my $bug_warning = 0;
1544 reentrant => 0, 3780
1545 prio => 0, 3781our @WAIT_FOR_TICK;
1546 at => $NEXT_TICK || $TICK, 3782our @WAIT_FOR_TICK_BEGIN;
1547 data => WF_AUTOCANCEL, 3783
1548 cb => sub { 3784sub wait_for_tick {
1549 unless ($FREEZE) { 3785 return if tick_inhibit || $Coro::current == $Coro::main;
3786
3787 my $signal = new Coro::Signal;
3788 push @WAIT_FOR_TICK, $signal;
3789 $signal->wait;
3790}
3791
3792sub wait_for_tick_begin {
3793 return if tick_inhibit || $Coro::current == $Coro::main;
3794
3795 my $signal = new Coro::Signal;
3796 push @WAIT_FOR_TICK_BEGIN, $signal;
3797 $signal->wait;
3798}
3799
3800sub tick {
3801 if ($Coro::current != $Coro::main) {
3802 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
3803 unless ++$bug_warning > 10;
3804 return;
3805 }
3806
1550 cf::server_tick; # one server iteration 3807 cf::server_tick; # one server iteration
1551 $RUNTIME += $TICK;
1552 }
1553 3808
1554 $NEXT_TICK += $TICK; 3809 if ($NOW >= $NEXT_RUNTIME_WRITE) {
1555 3810 $NEXT_RUNTIME_WRITE = List::Util::max $NEXT_RUNTIME_WRITE + 10, $NOW + 5.;
1556 # if we are delayed by four ticks or more, skip them all 3811 Coro::async_pool {
1557 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3812 $Coro::current->{desc} = "runtime saver";
1558
1559 $TICK_WATCHER->at ($NEXT_TICK);
1560 $TICK_WATCHER->start;
1561 },
1562);
1563
1564IO::AIO::max_poll_time $TICK * 0.2;
1565
1566Event->io (
1567 fd => IO::AIO::poll_fileno,
1568 poll => 'r',
1569 prio => 5,
1570 data => WF_AUTOCANCEL,
1571 cb => \&IO::AIO::poll_cb,
1572);
1573
1574Event->timer (
1575 data => WF_AUTOCANCEL,
1576 after => 0,
1577 interval => 10,
1578 cb => sub {
1579 (Coro::unblock_sub {
1580 write_runtime 3813 write_runtime_sync
1581 or warn "ERROR: unable to write runtime file: $!"; 3814 or warn "ERROR: unable to write runtime file: $!";
1582 })->(); 3815 };
1583 }, 3816 }
1584); 3817
3818 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3819 $sig->send;
3820 }
3821 while (my $sig = shift @WAIT_FOR_TICK) {
3822 $sig->send;
3823 }
3824
3825 $LOAD = ($NOW - $TICK_START) / $TICK;
3826 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3827
3828 if (0) {
3829 if ($NEXT_TICK) {
3830 my $jitter = $TICK_START - $NEXT_TICK;
3831 $JITTER = $JITTER * 0.75 + $jitter * 0.25;
3832 warn "jitter $JITTER\n";#d#
3833 }
3834 }
3835}
3836
3837{
3838 # configure BDB
3839
3840 BDB::min_parallel 8;
3841 BDB::max_poll_reqs $TICK * 0.1;
3842 $AnyEvent::BDB::WATCHER->priority (1);
3843
3844 unless ($DB_ENV) {
3845 $DB_ENV = BDB::db_env_create;
3846 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT);
3847 $DB_ENV->set_flags (&BDB::LOG_AUTOREMOVE ) if BDB::VERSION v0, v4.7;
3848 $DB_ENV->log_set_config (&BDB::LOG_AUTO_REMOVE) if BDB::VERSION v4.7;
3849 $DB_ENV->set_timeout (30, BDB::SET_TXN_TIMEOUT);
3850 $DB_ENV->set_timeout (30, BDB::SET_LOCK_TIMEOUT);
3851
3852 cf::sync_job {
3853 eval {
3854 BDB::db_env_open
3855 $DB_ENV,
3856 $BDBDIR,
3857 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3858 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3859 0666;
3860
3861 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3862 };
3863
3864 cf::cleanup "db_env_open(db): $@" if $@;
3865 };
3866 }
3867
3868 $BDB_DEADLOCK_WATCHER = EV::periodic 0, 3, 0, sub {
3869 BDB::db_env_lock_detect $DB_ENV, 0, BDB::LOCK_DEFAULT, 0, sub { };
3870 };
3871 $BDB_CHECKPOINT_WATCHER = EV::periodic 0, 60, 0, sub {
3872 BDB::db_env_txn_checkpoint $DB_ENV, 0, 0, 0, sub { };
3873 };
3874 $BDB_TRICKLE_WATCHER = EV::periodic 0, 10, 0, sub {
3875 BDB::db_env_memp_trickle $DB_ENV, 20, 0, sub { };
3876 };
3877}
3878
3879{
3880 # configure IO::AIO
3881
3882 IO::AIO::min_parallel 8;
3883 IO::AIO::max_poll_time $TICK * 0.1;
3884 undef $AnyEvent::AIO::WATCHER;
3885}
3886
3887my $_log_backtrace;
3888
3889sub _log_backtrace {
3890 my ($msg, @addr) = @_;
3891
3892 $msg =~ s/\n//;
3893
3894 # limit the # of concurrent backtraces
3895 if ($_log_backtrace < 2) {
3896 ++$_log_backtrace;
3897 my $perl_bt = Carp::longmess $msg;
3898 async {
3899 $Coro::current->{desc} = "abt $msg";
3900
3901 my @bt = fork_call {
3902 @addr = map { sprintf "%x", $_ } @addr;
3903 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3904 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3905 or die "addr2line: $!";
3906
3907 my @funcs;
3908 my @res = <$fh>;
3909 chomp for @res;
3910 while (@res) {
3911 my ($func, $line) = splice @res, 0, 2, ();
3912 push @funcs, "[$func] $line";
3913 }
3914
3915 @funcs
3916 };
3917
3918 LOG llevInfo, "[ABT] $perl_bt\n";
3919 LOG llevInfo, "[ABT] --- C backtrace follows ---\n";
3920 LOG llevInfo, "[ABT] $_\n" for @bt;
3921 --$_log_backtrace;
3922 };
3923 } else {
3924 LOG llevInfo, "[ABT] $msg\n";
3925 LOG llevInfo, "[ABT] [suppressed]\n";
3926 }
3927}
3928
3929# load additional modules
3930use cf::pod;
3931
3932END { cf::emergency_save }
1585 3933
15861 39341
1587 3935

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines