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.240 by root, Mon Apr 16 10:14:25 2007 UTC vs.
Revision 1.547 by root, Sun May 9 22:51:13 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines