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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines