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.222 by root, Tue Mar 6 03:06:00 2007 UTC vs.
Revision 1.320 by root, Tue Jul 24 22:49:40 2007 UTC

3use utf8; 3use utf8;
4use strict; 4use strict;
5 5
6use Symbol; 6use Symbol;
7use List::Util; 7use List::Util;
8use Socket;
8use Storable; 9use Storable;
10use Event;
9use Opcode; 11use Opcode;
10use Safe; 12use Safe;
11use Safe::Hole; 13use Safe::Hole;
12 14
13use Coro 3.5 (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
14use Coro::Event; 18use Coro::Event;
15use Coro::Timer; 19use Coro::Timer;
16use Coro::Signal; 20use Coro::Signal;
17use Coro::Semaphore; 21use Coro::Semaphore;
18use Coro::AIO; 22use Coro::AIO;
23use Coro::Storable;
19 24
25use JSON::XS 1.4 ();
20use BDB (); 26use BDB ();
21use Data::Dumper; 27use Data::Dumper;
22use Digest::MD5; 28use Digest::MD5;
23use Fcntl; 29use Fcntl;
30use YAML::Syck ();
24use IO::AIO 2.32 (); 31use IO::AIO 2.32 ();
25use YAML::Syck ();
26use Time::HiRes; 32use Time::HiRes;
27use Compress::LZF; 33use Compress::LZF;
34use Digest::MD5 ();
28 35
36# configure various modules to our taste
37#
38$Storable::canonical = 1; # reduce rsync transfers
39Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
29Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later 40Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
30 41
31use Event; $Event::Eval = 1; # no idea why this is required, but it is 42$Event::Eval = 1; # no idea why this is required, but it is
32
33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
34 43
35# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 44# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
36$YAML::Syck::ImplicitUnicode = 1; 45$YAML::Syck::ImplicitUnicode = 1;
37 46
38$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority 47$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
39 48
49sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
50
40our %COMMAND = (); 51our %COMMAND = ();
41our %COMMAND_TIME = (); 52our %COMMAND_TIME = ();
42 53
43our @EXTS = (); # list of extension package names 54our @EXTS = (); # list of extension package names
44our %EXTCMD = (); 55our %EXTCMD = ();
56our %EXTICMD = ();
45our %EXT_CORO = (); # coroutines bound to extensions 57our %EXT_CORO = (); # coroutines bound to extensions
46our %EXT_MAP = (); # pluggable maps 58our %EXT_MAP = (); # pluggable maps
47 59
60our $RELOAD; # number of reloads so far
48our @EVENT; 61our @EVENT;
49our $LIBDIR = datadir . "/ext";
50 62
51our $TICK = MAX_TIME * 1e-6; 63our $CONFDIR = confdir;
64our $DATADIR = datadir;
65our $LIBDIR = "$DATADIR/ext";
66our $PODDIR = "$DATADIR/pod";
67our $MAPDIR = "$DATADIR/" . mapdir;
68our $LOCALDIR = localdir;
69our $TMPDIR = "$LOCALDIR/" . tmpdir;
70our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
71our $PLAYERDIR = "$LOCALDIR/" . playerdir;
72our $RANDOMDIR = "$LOCALDIR/random";
73our $BDBDIR = "$LOCALDIR/db";
74
75our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
52our $TICK_WATCHER; 76our $TICK_WATCHER;
53our $AIO_POLL_WATCHER; 77our $AIO_POLL_WATCHER;
54our $NEXT_RUNTIME_WRITE; # when should the runtime file be written 78our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
55our $NEXT_TICK; 79our $NEXT_TICK;
56our $NOW; 80our $NOW;
65our $RUNTIME; 89our $RUNTIME;
66 90
67our %PLAYER; # all users 91our %PLAYER; # all users
68our %MAP; # all maps 92our %MAP; # all maps
69our $LINK_MAP; # the special {link} map, which is always available 93our $LINK_MAP; # the special {link} map, which is always available
70our $RANDOM_MAPS = cf::localdir . "/random";
71our $BDB_ENV_DIR = cf::localdir . "/db";
72
73our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
74our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
75 94
76# used to convert map paths into valid unix filenames by replacing / by ∕ 95# used to convert map paths into valid unix filenames by replacing / by ∕
77our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons 96our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
78 97
98our $LOAD; # a number between 0 (idle) and 1 (too many objects)
99our $LOADAVG; # same thing, but with alpha-smoothing
100our $tick_start; # for load detecting purposes
101
79binmode STDOUT; 102binmode STDOUT;
80binmode STDERR; 103binmode STDERR;
81 104
82# read virtual server time, if available 105# read virtual server time, if available
83unless ($RUNTIME || !-e cf::localdir . "/runtime") { 106unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
84 open my $fh, "<", cf::localdir . "/runtime" 107 open my $fh, "<", "$LOCALDIR/runtime"
85 or die "unable to read runtime file: $!"; 108 or die "unable to read runtime file: $!";
86 $RUNTIME = <$fh> + 0.; 109 $RUNTIME = <$fh> + 0.;
87} 110}
88 111
89mkdir cf::localdir; 112mkdir $_
90mkdir cf::localdir . "/" . cf::playerdir; 113 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
91mkdir cf::localdir . "/" . cf::tmpdir;
92mkdir cf::localdir . "/" . cf::uniquedir;
93mkdir $RANDOM_MAPS;
94mkdir $BDB_ENV_DIR;
95 114
96our $EMERGENCY_POSITION; 115our $EMERGENCY_POSITION;
97 116
98sub cf::map::normalise; 117sub cf::map::normalise;
99 118
110=item $cf::RUNTIME 129=item $cf::RUNTIME
111 130
112The time this server has run, starts at 0 and is increased by $cf::TICK on 131The time this server has run, starts at 0 and is increased by $cf::TICK on
113every server tick. 132every server tick.
114 133
115=item $cf::LIBDIR 134=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
135$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
136$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
116 137
117The perl library directory, where extensions and cf-specific modules can 138Various directories - "/etc", read-only install directory, perl-library
118be found. It will be added to C<@INC> automatically. 139directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
140unique-items directory, player file directory, random maps directory and
141database environment.
119 142
120=item $cf::NOW 143=item $cf::NOW
121 144
122The time of the last (current) server tick. 145The time of the last (current) server tick.
123 146
124=item $cf::TICK 147=item $cf::TICK
125 148
126The interval between server ticks, in seconds. 149The interval between server ticks, in seconds.
150
151=item $cf::LOADAVG
152
153The current CPU load on the server (alpha-smoothed), as a value between 0
154(none) and 1 (overloaded), indicating how much time is spent on processing
155objects per tick. Healthy values are < 0.5.
156
157=item $cf::LOAD
158
159The raw value load value from the last tick.
127 160
128=item %cf::CFG 161=item %cf::CFG
129 162
130Configuration for the server, loaded from C</etc/crossfire/config>, or 163Configuration for the server, loaded from C</etc/crossfire/config>, or
131from wherever your confdir points to. 164from wherever your confdir points to.
132 165
133=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE 166=item cf::wait_for_tick, cf::wait_for_tick_begin
134 167
135These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) 168These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
136or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick 169returns directly I<after> the tick processing (and consequently, can only wake one process
137processing has been done. Call C<< ->wait >> on them to maximise the 170per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
138window of cpu time available, or simply to synchronise to the server tick. 171
172=item @cf::INVOKE_RESULTS
173
174This array contains the results of the last C<invoke ()> call. When
175C<cf::override> is called C<@cf::INVOKE_RESULTS> is set to the parameters of
176that call.
139 177
140=back 178=back
141 179
142=cut 180=cut
143 181
144BEGIN { 182BEGIN {
145 *CORE::GLOBAL::warn = sub { 183 *CORE::GLOBAL::warn = sub {
146 my $msg = join "", @_; 184 my $msg = join "", @_;
147 utf8::encode $msg;
148 185
149 $msg .= "\n" 186 $msg .= "\n"
150 unless $msg =~ /\n$/; 187 unless $msg =~ /\n$/;
151 188
189 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
190
191 utf8::encode $msg;
152 LOG llevError, $msg; 192 LOG llevError, $msg;
153 }; 193 };
154} 194}
155 195
156@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; 196@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
157@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; 197@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
158@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; 198@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
159@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; 199@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
160@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; 200@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
201@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
161@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 202@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
162 203
163# we bless all objects into (empty) derived classes to force a method lookup 204# we bless all objects into (empty) derived classes to force a method lookup
164# within the Safe compartment. 205# within the Safe compartment.
165for my $pkg (qw( 206for my $pkg (qw(
166 cf::global cf::attachable 207 cf::global cf::attachable
174} 215}
175 216
176$Event::DIED = sub { 217$Event::DIED = sub {
177 warn "error in event callback: @_"; 218 warn "error in event callback: @_";
178}; 219};
220
221#############################################################################
179 222
180=head2 UTILITY FUNCTIONS 223=head2 UTILITY FUNCTIONS
181 224
182=over 4 225=over 4
183 226
202 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; 245 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
203 $d 246 $d
204 } || "[unable to dump $_[0]: '$@']"; 247 } || "[unable to dump $_[0]: '$@']";
205} 248}
206 249
207use JSON::Syck (); # TODO# replace by JSON::PC once working
208
209=item $ref = cf::from_json $json 250=item $ref = cf::from_json $json
210 251
211Converts a JSON string into the corresponding perl data structure. 252Converts a JSON string into the corresponding perl data structure.
212 253
213=cut
214
215sub from_json($) {
216 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
217 JSON::Syck::Load $_[0]
218}
219
220=item $json = cf::to_json $ref 254=item $json = cf::to_json $ref
221 255
222Converts a perl data structure into its JSON representation. 256Converts a perl data structure into its JSON representation.
223 257
224=cut 258=cut
225 259
226sub to_json($) { 260our $json_coder = JSON::XS->new->utf8->max_size (1e6); # accept ~1mb max
227 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 261
228 JSON::Syck::Dump $_[0] 262sub to_json ($) { $json_coder->encode ($_[0]) }
229} 263sub from_json ($) { $json_coder->decode ($_[0]) }
230 264
231=item cf::lock_wait $string 265=item cf::lock_wait $string
232 266
233Wait until the given lock is available. See cf::lock_acquire. 267Wait until the given lock is available. See cf::lock_acquire.
234 268
240returned. 274returned.
241 275
242Lock names should begin with a unique identifier (for example, cf::map::find 276Lock names should begin with a unique identifier (for example, cf::map::find
243uses map_find and cf::map::load uses map_load). 277uses map_find and cf::map::load uses map_load).
244 278
279=item $locked = cf::lock_active $string
280
281Return true if the lock is currently active, i.e. somebody has locked it.
282
245=cut 283=cut
246 284
247our %LOCK; 285our %LOCK;
248 286
249sub lock_wait($) { 287sub lock_wait($) {
266 304
267 Coro::guard { 305 Coro::guard {
268 # wake up all waiters, to be on the safe side 306 # wake up all waiters, to be on the safe side
269 $_->ready for @{ delete $LOCK{$key} }; 307 $_->ready for @{ delete $LOCK{$key} };
270 } 308 }
309}
310
311sub lock_active($) {
312 my ($key) = @_;
313
314 ! ! $LOCK{$key}
271} 315}
272 316
273sub freeze_mainloop { 317sub freeze_mainloop {
274 return unless $TICK_WATCHER->is_active; 318 return unless $TICK_WATCHER->is_active;
275 319
278 }; 322 };
279 $TICK_WATCHER->stop; 323 $TICK_WATCHER->stop;
280 $guard 324 $guard
281} 325}
282 326
327=item cf::get_slot $time[, $priority[, $name]]
328
329Allocate $time seconds of blocking CPU time at priority C<$priority>:
330This call blocks and returns only when you have at least C<$time> seconds
331of cpu time till the next tick. The slot is only valid till the next cede.
332
333The optional C<$name> can be used to identify the job to run. It might be
334used for statistical purposes and should identify the same time-class.
335
336Useful for short background jobs.
337
338=cut
339
340our @SLOT_QUEUE;
341our $SLOT_QUEUE;
342
343$SLOT_QUEUE->cancel if $SLOT_QUEUE;
344$SLOT_QUEUE = Coro::async {
345 my $signal = new Coro::Signal;
346
347 while () {
348 next_job:
349 my $avail = cf::till_tick;
350 if ($avail > 0.01) {
351 for (0 .. $#SLOT_QUEUE) {
352 if ($SLOT_QUEUE[$_][0] < $avail) {
353 my $job = splice @SLOT_QUEUE, $_, 1, ();
354 $job->[2]->send;
355 Coro::cede;
356 goto next_job;
357 }
358 }
359 }
360
361 if (@SLOT_QUEUE) {
362 # we do not use wait_For_tick() as it returns immediately when tick is inactive
363 push @cf::WAIT_FOR_TICK, $signal;
364 $signal->wait;
365 } else {
366 Coro::schedule;
367 }
368 }
369};
370
371sub get_slot($;$$) {
372 my ($time, $pri, $name) = @_;
373
374 $time = $TICK * .6 if $time > $TICK * .6;
375 my $sig = new Coro::Signal;
376
377 push @SLOT_QUEUE, [$time, $pri, $sig, $name];
378 @SLOT_QUEUE = sort { $b->[1] <=> $a->[1] } @SLOT_QUEUE;
379 $SLOT_QUEUE->ready;
380 $sig->wait;
381}
382
283=item cf::async { BLOCK } 383=item cf::async { BLOCK }
284 384
285Currently the same as Coro::async_pool, meaning you cannot use 385Currently the same as Coro::async_pool, meaning you cannot use
286C<on_destroy>, C<join> or other gimmicks on these coroutines. The only 386C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
287thing you are allowed to do is call C<prio> on it. 387thing you are allowed to do is call C<prio> on it.
290 390
291BEGIN { *async = \&Coro::async_pool } 391BEGIN { *async = \&Coro::async_pool }
292 392
293=item cf::sync_job { BLOCK } 393=item cf::sync_job { BLOCK }
294 394
295The design of crossfire+ requires that the main coro ($Coro::main) is 395The design of Crossfire TRT requires that the main coroutine ($Coro::main)
296always able to handle events or runnable, as crossfire+ is only partly 396is always able to handle events or runnable, as Crossfire TRT is only
297reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. 397partly reentrant. Thus "blocking" it by e.g. waiting for I/O is not
398acceptable.
298 399
299If it must be done, put the blocking parts into C<sync_job>. This will run 400If it must be done, put the blocking parts into C<sync_job>. This will run
300the given BLOCK in another coroutine while waiting for the result. The 401the given BLOCK in another coroutine while waiting for the result. The
301server will be frozen during this time, so the block should either finish 402server will be frozen during this time, so the block should either finish
302fast or be very important. 403fast or be very important.
305 406
306sub sync_job(&) { 407sub sync_job(&) {
307 my ($job) = @_; 408 my ($job) = @_;
308 409
309 if ($Coro::current == $Coro::main) { 410 if ($Coro::current == $Coro::main) {
411 my $time = Event::time;
412
310 # this is the main coro, too bad, we have to block 413 # this is the main coro, too bad, we have to block
311 # till the operation succeeds, freezing the server :/ 414 # till the operation succeeds, freezing the server :/
312 415
313 # TODO: use suspend/resume instead 416 # TODO: use suspend/resume instead
314 # (but this is cancel-safe) 417 # (but this is cancel-safe)
325 428
326 while ($busy) { 429 while ($busy) {
327 Coro::cede or Event::one_event; 430 Coro::cede or Event::one_event;
328 } 431 }
329 432
433 $time = Event::time - $time;
434
435 LOG llevError | logBacktrace, Carp::longmess "long sync job"
436 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
437
438 $tick_start += $time; # do not account sync jobs to server load
439
330 wantarray ? @res : $res[0] 440 wantarray ? @res : $res[0]
331 } else { 441 } else {
332 # we are in another coroutine, how wonderful, everything just works 442 # we are in another coroutine, how wonderful, everything just works
333 443
334 $job->() 444 $job->()
353 $EXT_CORO{$coro+0} = $coro; 463 $EXT_CORO{$coro+0} = $coro;
354 464
355 $coro 465 $coro
356} 466}
357 467
358sub write_runtime { 468=item fork_call { }, $args
359 my $guard = cf::lock_acquire "write_runtime";
360 469
361 my $runtime = cf::localdir . "/runtime"; 470Executes the given code block with the given arguments in a seperate
471process, returning the results. Everything must be serialisable with
472Coro::Storable. May, of course, block. Note that the executed sub may
473never block itself or use any form of Event handling.
362 474
363 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 475=cut
364 or return;
365 476
366 my $value = $cf::RUNTIME + 90 + 10; 477sub _store_scalar {
367 # 10 is the runtime save interval, for a monotonic clock 478 open my $fh, ">", \my $buf
368 # 60 allows for the watchdog to kill the server. 479 or die "fork_call: cannot open fh-to-buf in child : $!";
369 480 Storable::store_fd $_[0], $fh;
370 (aio_write $fh, 0, (length $value), $value, 0) <= 0
371 and return;
372
373 # always fsync - this file is important
374 aio_fsync $fh
375 and return;
376
377 close $fh 481 close $fh;
378 or return;
379 482
380 aio_rename "$runtime~", $runtime 483 $buf
381 and return; 484}
382 485
486sub fork_call(&@) {
487 my ($cb, @args) = @_;
488
489# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
490# or die "socketpair: $!";
491 pipe my $fh1, my $fh2
492 or die "pipe: $!";
493
494 if (my $pid = fork) {
495 close $fh2;
496
497 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
498 warn "pst<$res>" unless $res =~ /^pst/;
499 $res = Coro::Storable::thaw $res;
500
501 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
502
503 Carp::confess $$res unless "ARRAY" eq ref $res;
504
505 return wantarray ? @$res : $res->[-1];
506 } else {
507 reset_signals;
508 local $SIG{__WARN__};
509 local $SIG{__DIE__};
510 # just in case, this hack effectively disables event
511 # in the child. cleaner and slower would be canceling all watchers,
512 # but this works for the time being.
513 local $Coro::idle;
514 $Coro::current->prio (Coro::PRIO_MAX);
515
516 eval {
517 close $fh1;
518
519 my @res = eval { $cb->(@args) };
520
521 syswrite $fh2, _store_scalar $@ ? \"$@" : \@res;
522 close $fh2;
523 };
524
525 warn $@ if $@;
526 _exit 0;
383 1 527 }
528}
529
530=item $value = cf::db_get $family => $key
531
532Returns a single value from the environment database.
533
534=item cf::db_put $family => $key => $value
535
536Stores the given C<$value> in the family. It can currently store binary
537data only (use Compress::LZF::sfreeze_cr/sthaw to convert to/from binary).
538
539=cut
540
541our $DB;
542
543sub db_init {
544 unless ($DB) {
545 $DB = BDB::db_create $DB_ENV;
546
547 cf::sync_job {
548 eval {
549 $DB->set_flags (BDB::CHKSUM);
550
551 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
552 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
553 cf::cleanup "db_open(db): $!" if $!;
554 };
555 cf::cleanup "db_open(db): $@" if $@;
556 };
557 }
558}
559
560sub db_get($$) {
561 my $key = "$_[0]/$_[1]";
562
563 cf::sync_job {
564 BDB::db_get $DB, undef, $key, my $data;
565
566 $! ? ()
567 : $data
568 }
569}
570
571sub db_put($$$) {
572 BDB::dbreq_pri 4;
573 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
574}
575
576=item cf::cache $id => [$paths...], $processversion => $process
577
578Generic caching function that returns the value of the resource $id,
579caching and regenerating as required.
580
581This function can block.
582
583=cut
584
585sub cache {
586 my ($id, $src, $processversion, $process) = @_;
587
588 my $meta =
589 join "\x00",
590 $processversion,
591 map {
592 aio_stat $_
593 and Carp::croak "$_: $!";
594
595 ($_, (stat _)[7,9])
596 } @$src;
597
598 my $dbmeta = db_get cache => "$id/meta";
599 if ($dbmeta ne $meta) {
600 # changed, we may need to process
601
602 my @data;
603 my $md5;
604
605 for (0 .. $#$src) {
606 0 <= aio_load $src->[$_], $data[$_]
607 or Carp::croak "$src->[$_]: $!";
608 }
609
610 # if processing is expensive, check
611 # checksum first
612 if (1) {
613 $md5 =
614 join "\x00",
615 $processversion,
616 map {
617 Coro::cede;
618 ($src->[$_], Digest::MD5::md5_hex $data[$_])
619 } 0.. $#$src;
620
621
622 my $dbmd5 = db_get cache => "$id/md5";
623 if ($dbmd5 eq $md5) {
624 db_put cache => "$id/meta", $meta;
625
626 return db_get cache => "$id/data";
627 }
628 }
629
630 my $t1 = Time::HiRes::time;
631 my $data = $process->(\@data);
632 my $t2 = Time::HiRes::time;
633
634 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
635
636 db_put cache => "$id/data", $data;
637 db_put cache => "$id/md5" , $md5;
638 db_put cache => "$id/meta", $meta;
639
640 return $data;
641 }
642
643 db_get cache => "$id/data"
644}
645
646=item cf::datalog type => key => value, ...
647
648Log a datalog packet of the given type with the given key-value pairs.
649
650=cut
651
652sub datalog($@) {
653 my ($type, %kv) = @_;
654 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
384} 655}
385 656
386=back 657=back
387 658
388=cut 659=cut
395attach callbacks/event handlers (a collection of which is called an "attachment") 666attach callbacks/event handlers (a collection of which is called an "attachment")
396to it. All such attachable objects support the following methods. 667to it. All such attachable objects support the following methods.
397 668
398In the following description, CLASS can be any of C<global>, C<object> 669In the following description, CLASS can be any of C<global>, C<object>
399C<player>, C<client> or C<map> (i.e. the attachable objects in 670C<player>, C<client> or C<map> (i.e. the attachable objects in
400crossfire+). 671Crossfire TRT).
401 672
402=over 4 673=over 4
403 674
404=item $attachable->attach ($attachment, key => $value...) 675=item $attachable->attach ($attachment, key => $value...)
405 676
568 $registry = $CB_TYPE[$object_type] ||= []; 839 $registry = $CB_TYPE[$object_type] ||= [];
569 840
570 } elsif ($type eq "subtype") { 841 } elsif ($type eq "subtype") {
571 defined $object_type or Carp::croak "subtype specified without type"; 842 defined $object_type or Carp::croak "subtype specified without type";
572 my $object_subtype = shift @arg; 843 my $object_subtype = shift @arg;
573 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; 844 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
574 845
575 } elsif ($type eq "package") { 846 } elsif ($type eq "package") {
576 my $pkg = shift @arg; 847 my $pkg = shift @arg;
577 848
578 while (my ($name, $id) = each %cb_id) { 849 while (my ($name, $id) = each %cb_id) {
607 _attach $registry, $klass, @attach; 878 _attach $registry, $klass, @attach;
608 } 879 }
609 880
610 $obj->{$name} = \%arg; 881 $obj->{$name} = \%arg;
611 } else { 882 } else {
612 warn "object uses attachment '$name' that is not available, postponing.\n"; 883 warn "object uses attachment '$name' which is not available, postponing.\n";
613 } 884 }
614 885
615 $obj->{_attachment}{$name} = undef; 886 $obj->{_attachment}{$name} = undef;
616} 887}
617 888
619 if (ref $_[0]) { 890 if (ref $_[0]) {
620 _object_attach @_; 891 _object_attach @_;
621 } else { 892 } else {
622 _attach shift->_attach_registry, @_; 893 _attach shift->_attach_registry, @_;
623 } 894 }
895 _recalc_want;
624}; 896};
625 897
626# all those should be optimised 898# all those should be optimised
627sub cf::attachable::detach { 899sub cf::attachable::detach {
628 my ($obj, $name) = @_; 900 my ($obj, $name) = @_;
631 delete $obj->{_attachment}{$name}; 903 delete $obj->{_attachment}{$name};
632 reattach ($obj); 904 reattach ($obj);
633 } else { 905 } else {
634 Carp::croak "cannot, currently, detach class attachments"; 906 Carp::croak "cannot, currently, detach class attachments";
635 } 907 }
908 _recalc_want;
636}; 909};
637 910
638sub cf::attachable::attached { 911sub cf::attachable::attached {
639 my ($obj, $name) = @_; 912 my ($obj, $name) = @_;
640 913
655 "; 928 ";
656 die if $@; 929 die if $@;
657} 930}
658 931
659our $override; 932our $override;
660our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? 933our @INVOKE_RESULTS = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
661 934
662sub override { 935sub override {
663 $override = 1; 936 $override = 1;
664 @invoke_results = (); 937 @INVOKE_RESULTS = (@_);
665} 938}
666 939
667sub do_invoke { 940sub do_invoke {
668 my $event = shift; 941 my $event = shift;
669 my $callbacks = shift; 942 my $callbacks = shift;
670 943
671 @invoke_results = (); 944 @INVOKE_RESULTS = ();
672 945
673 local $override; 946 local $override;
674 947
675 for (@$callbacks) { 948 for (@$callbacks) {
676 eval { &{$_->[1]} }; 949 eval { &{$_->[1]} };
693 966
694Generate an object-specific event with the given arguments. 967Generate an object-specific event with the given arguments.
695 968
696This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be 969This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
697removed in future versions), and there is no public API to access override 970removed in future versions), and there is no public API to access override
698results (if you must, access C<@cf::invoke_results> directly). 971results (if you must, access C<@cf::INVOKE_RESULTS> directly).
699 972
700=back 973=back
701 974
702=cut 975=cut
703 976
704############################################################################# 977#############################################################################
705# object support 978# object support
979#
980
981sub _can_merge {
982 my ($ob1, $ob2) = @_;
983
984 local $Storable::canonical = 1;
985 my $fob1 = Storable::freeze $ob1;
986 my $fob2 = Storable::freeze $ob2;
987
988 $fob1 eq $fob2
989}
706 990
707sub reattach { 991sub reattach {
708 # basically do the same as instantiate, without calling instantiate 992 # basically do the same as instantiate, without calling instantiate
709 my ($obj) = @_; 993 my ($obj) = @_;
710 994
813 or return; 1097 or return;
814 $av = eval { (Storable::thaw $av)->{objs} }; 1098 $av = eval { (Storable::thaw $av)->{objs} };
815 } 1099 }
816 1100
817 warn sprintf "loading %s (%d)\n", 1101 warn sprintf "loading %s (%d)\n",
818 $filename, length $data, scalar @{$av || []};#d# 1102 $filename, length $data, scalar @{$av || []};
819 return ($data, $av); 1103 return ($data, $av);
820} 1104}
1105
1106=head2 COMMAND CALLBACKS
1107
1108=over 4
1109
1110=cut
821 1111
822############################################################################# 1112#############################################################################
823# command handling &c 1113# command handling &c
824 1114
825=item cf::register_command $name => \&callback($ob,$args); 1115=item cf::register_command $name => \&callback($ob,$args);
838 push @{ $COMMAND{$name} }, [$caller, $cb]; 1128 push @{ $COMMAND{$name} }, [$caller, $cb];
839} 1129}
840 1130
841=item cf::register_extcmd $name => \&callback($pl,$packet); 1131=item cf::register_extcmd $name => \&callback($pl,$packet);
842 1132
843Register a callbackf ro execution when the client sends an extcmd packet. 1133Register a callback for execution when the client sends an (synchronous)
1134extcmd packet. Ext commands will be processed in the order they are
1135received by the server, like other user commands. The first argument is
1136the logged-in player. Ext commands can only be processed after a player
1137has logged in successfully.
844 1138
845If the callback returns something, it is sent back as if reply was being 1139If the callback returns something, it is sent back as if reply was being
846called. 1140called.
847 1141
1142=item cf::register_exticmd $name => \&callback($ns,$packet);
1143
1144Register a callback for execution when the client sends an (asynchronous)
1145exticmd packet. Exti commands are processed by the server as soon as they
1146are received, i.e. out of order w.r.t. other commands. The first argument
1147is a client socket. Exti commands can be received anytime, even before
1148log-in.
1149
1150If the callback returns something, it is sent back as if reply was being
1151called.
1152
848=cut 1153=cut
849 1154
850sub register_extcmd { 1155sub register_extcmd {
851 my ($name, $cb) = @_; 1156 my ($name, $cb) = @_;
852 1157
853 $EXTCMD{$name} = $cb; 1158 $EXTCMD{$name} = $cb;
1159}
1160
1161sub register_exticmd {
1162 my ($name, $cb) = @_;
1163
1164 $EXTICMD{$name} = $cb;
854} 1165}
855 1166
856cf::player->attach ( 1167cf::player->attach (
857 on_command => sub { 1168 on_command => sub {
858 my ($pl, $name, $params) = @_; 1169 my ($pl, $name, $params) = @_;
867 cf::override; 1178 cf::override;
868 }, 1179 },
869 on_extcmd => sub { 1180 on_extcmd => sub {
870 my ($pl, $buf) = @_; 1181 my ($pl, $buf) = @_;
871 1182
872 my $msg = eval { from_json $buf }; 1183 my $msg = eval { $pl->ns->{json_coder}->decode ($buf) };
873 1184
874 if (ref $msg) { 1185 if (ref $msg) {
1186 my ($type, $reply, @payload) =
1187 "ARRAY" eq ref $msg
1188 ? @$msg
1189 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
1190
875 if (my $cb = $EXTCMD{$msg->{msgtype}}) { 1191 if (my $cb = $EXTCMD{$type}) {
876 if (my %reply = $cb->($pl, $msg)) { 1192 my @reply = $cb->($pl, @payload);
1193
877 $pl->ext_reply ($msg->{msgid}, %reply); 1194 $pl->ext_reply ($reply, @reply)
878 } 1195 if $reply;
879 } 1196 }
880 } else { 1197 } else {
881 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1198 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
882 } 1199 }
883 1200
884 cf::override; 1201 cf::override;
885 }, 1202 },
886); 1203);
887 1204
888sub load_extension {
889 my ($path) = @_;
890
891 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
892 my $base = $1;
893 my $pkg = $1;
894 $pkg =~ s/[^[:word:]]/_/g;
895 $pkg = "ext::$pkg";
896
897 warn "... loading '$path' into '$pkg'\n";
898
899 open my $fh, "<:utf8", $path
900 or die "$path: $!";
901
902 my $source =
903 "package $pkg; use strict; use utf8;\n"
904 . "#line 1 \"$path\"\n{\n"
905 . (do { local $/; <$fh> })
906 . "\n};\n1";
907
908 unless (eval $source) {
909 my $msg = $@ ? "$path: $@\n"
910 : "extension disabled.\n";
911 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
912 warn $@;
913 warn "mandatory extension failed to load, exiting.\n";
914 exit 1;
915 }
916 die $@;
917 }
918
919 push @EXTS, $pkg;
920}
921
922sub load_extensions { 1205sub load_extensions {
1206 cf::sync_job {
1207 my %todo;
1208
923 for my $ext (<$LIBDIR/*.ext>) { 1209 for my $path (<$LIBDIR/*.ext>) {
924 next unless -r $ext; 1210 next unless -r $path;
925 eval { 1211
926 load_extension $ext; 1212 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
1213 my $base = $1;
1214 my $pkg = $1;
1215 $pkg =~ s/[^[:word:]]/_/g;
1216 $pkg = "ext::$pkg";
1217
1218 open my $fh, "<:utf8", $path
1219 or die "$path: $!";
1220
1221 my $source = do { local $/; <$fh> };
1222
1223 my %ext = (
1224 path => $path,
1225 base => $base,
1226 pkg => $pkg,
1227 );
1228
1229 $ext{meta} = { map { (split /=/, $_, 2)[0, 1] } split /\s+/, $1 }
1230 if $source =~ /\A#!.*?perl.*?#\s*(.*)$/m;
1231
1232 $ext{source} =
1233 "package $pkg; use strict; use utf8;\n"
1234 . "#line 1 \"$path\"\n{\n"
1235 . $source
1236 . "\n};\n1";
1237
1238 $todo{$base} = \%ext;
1239 }
1240
1241 my %done;
1242 while (%todo) {
1243 my $progress;
1244
1245 while (my ($k, $v) = each %todo) {
1246 for (split /,\s*/, $v->{meta}{depends}) {
1247 goto skip
1248 unless exists $done{$_};
1249 }
1250
1251 warn "... loading '$k' into '$v->{pkg}'\n";
1252
1253 unless (eval $v->{source}) {
1254 my $msg = $@ ? "$v->{path}: $@\n"
1255 : "$v->{base}: extension inactive.\n";
1256
1257 if (exists $v->{meta}{mandatory}) {
1258 warn $msg;
1259 warn "mandatory extension failed to load, exiting.\n";
1260 exit 1;
1261 }
1262
1263 warn $msg;
1264 }
1265
1266 $done{$k} = delete $todo{$k};
1267 push @EXTS, $v->{pkg};
1268 $progress = 1;
927 1 1269 }
928 } or warn "$ext not loaded: $@"; 1270
1271 skip:
1272 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1273 unless $progress;
1274 }
929 } 1275 };
930} 1276}
931 1277
932############################################################################# 1278#############################################################################
933 1279
1280=back
1281
934=head2 CORE EXTENSIONS 1282=head2 CORE EXTENSIONS
935 1283
936Functions and methods that extend core crossfire objects. 1284Functions and methods that extend core crossfire objects.
937 1285
938=cut 1286=cut
950Returns the given player object, loading it if necessary (might block). 1298Returns the given player object, loading it if necessary (might block).
951 1299
952=cut 1300=cut
953 1301
954sub playerdir($) { 1302sub playerdir($) {
955 cf::localdir 1303 "$PLAYERDIR/"
956 . "/"
957 . cf::playerdir
958 . "/"
959 . (ref $_[0] ? $_[0]->ob->name : $_[0]) 1304 . (ref $_[0] ? $_[0]->ob->name : $_[0])
960} 1305}
961 1306
962sub path($) { 1307sub path($) {
963 my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; 1308 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964 1309
965 (playerdir $login) . "/$login.pl" 1310 (playerdir $login) . "/playerdata"
966} 1311}
967 1312
968sub find_active($) { 1313sub find_active($) {
969 $cf::PLAYER{$_[0]} 1314 $cf::PLAYER{$_[0]}
970 and $cf::PLAYER{$_[0]}->active 1315 and $cf::PLAYER{$_[0]}->active
983 my $login = $_[0]; 1328 my $login = $_[0];
984 1329
985 my $guard = cf::lock_acquire "user_find:$login"; 1330 my $guard = cf::lock_acquire "user_find:$login";
986 1331
987 $cf::PLAYER{$_[0]} || do { 1332 $cf::PLAYER{$_[0]} || do {
1333 # rename old playerfiles to new ones
1334 #TODO: remove when no longer required
1335 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1336 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1337 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1338 aio_unlink +(playerdir $login) . "/$login.pl";
1339
988 my $pl = load_pl path $login 1340 my $pl = load_pl path $login
989 or return; 1341 or return;
990 $cf::PLAYER{$login} = $pl 1342 $cf::PLAYER{$login} = $pl
991 } 1343 }
992 } 1344 }
1076while and may block, so not sync_job-capable, ever. 1428while and may block, so not sync_job-capable, ever.
1077 1429
1078=cut 1430=cut
1079 1431
1080sub list_logins { 1432sub list_logins {
1081 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir 1433 my $dirs = aio_readdir $PLAYERDIR
1082 or return []; 1434 or return [];
1083 1435
1084 my @logins; 1436 my @logins;
1085 1437
1086 for my $login (@$dirs) { 1438 for my $login (@$dirs) {
1121 } 1473 }
1122 1474
1123 \@paths 1475 \@paths
1124} 1476}
1125 1477
1478=item $protocol_xml = $player->expand_cfpod ($crossfire_pod)
1479
1480Expand crossfire pod fragments into protocol xml.
1481
1482=cut
1483
1484sub expand_cfpod {
1485 ((my $self), (local $_)) = @_;
1486
1487 # escape & and <
1488 s/&/&amp;/g;
1489 s/(?<![BIUGH])</&lt;/g;
1490
1491 # this is buggy, it needs to properly take care of nested <'s
1492
1493 1 while
1494 # replace B<>, I<>, U<> etc.
1495 s/B<([^\>]*)>/<b>$1<\/b>/
1496 || s/I<([^\>]*)>/<i>$1<\/i>/
1497 || s/U<([^\>]*)>/<u>$1<\/u>/
1498 # replace G<male|female> tags
1499 || s{G<([^>|]*)\|([^>]*)>}{
1500 $self->gender ? $2 : $1
1501 }ge
1502 # replace H<hint text>
1503 || s{H<([^\>]*)>}
1504 {
1505 ("<fg name=\"lightblue\">[$1 (Use hintmode to suppress hints)]</fg>",
1506 "<fg name=\"lightblue\">[Hint suppressed, see hintmode]</fg>",
1507 "")
1508 [$self->{hintmode}]
1509 }ge;
1510
1511 # create single paragraphs (very hackish)
1512 s/(?<=\S)\n(?=\w)/ /g;
1513
1514 # compress some whitespace
1515 s/\s+\n/\n/g; # ws line-ends
1516 s/\n\n+/\n/g; # double lines
1517 s/^\n+//; # beginning lines
1518 s/\n+$//; # ending lines
1519
1520 $_
1521}
1522
1523sub hintmode {
1524 $_[0]{hintmode} = $_[1] if @_ > 1;
1525 $_[0]{hintmode}
1526}
1527
1126=item $player->ext_reply ($msgid, $msgtype, %msg) 1528=item $player->ext_reply ($msgid, @msg)
1127 1529
1128Sends an ext reply to the player. 1530Sends an ext reply to the player.
1129 1531
1130=cut 1532=cut
1131 1533
1132sub ext_reply($$$%) { 1534sub ext_reply($$@) {
1133 my ($self, $id, %msg) = @_; 1535 my ($self, $id, @msg) = @_;
1134 1536
1135 $msg{msgid} = $id; 1537 if ($self->ns->extcmd == 2) {
1136 1538 $self->send ("ext " . $self->ns->{json_coder}->encode (["reply-$id", @msg]));
1137 $self->send ("ext " . cf::to_json \%msg); 1539 } elsif ($self->ns->extcmd == 1) {
1540 #TODO: version 1, remove
1541 unshift @msg, msgtype => "reply", msgid => $id;
1542 $self->send ("ext " . $self->ns->{json_coder}->encode ({@msg}));
1543 }
1138} 1544}
1139 1545
1140package cf; 1546=item $player->ext_msg ($type, @msg)
1547
1548Sends an ext event to the client.
1549
1550=cut
1551
1552sub ext_msg($$@) {
1553 my ($self, $type, @msg) = @_;
1554
1555 $self->ns->ext_msg ($type, @msg);
1556}
1557
1558=head3 cf::region
1559
1560=over 4
1561
1562=cut
1563
1564package cf::region;
1565
1566=item cf::region::find_by_path $path
1567
1568Tries to decuce the likely region for a map knowing only its path.
1569
1570=cut
1571
1572sub find_by_path($) {
1573 my ($path) = @_;
1574
1575 my ($match, $specificity);
1576
1577 for my $region (list) {
1578 if ($region->{match} && $path =~ $region->{match}) {
1579 ($match, $specificity) = ($region, $region->specificity)
1580 if $region->specificity > $specificity;
1581 }
1582 }
1583
1584 $match
1585}
1141 1586
1142=back 1587=back
1143
1144 1588
1145=head3 cf::map 1589=head3 cf::map
1146 1590
1147=over 4 1591=over 4
1148 1592
1203 my ($self, $merge) = @_; 1647 my ($self, $merge) = @_;
1204 1648
1205 # we have to keep some variables in memory intact 1649 # we have to keep some variables in memory intact
1206 local $self->{path}; 1650 local $self->{path};
1207 local $self->{load_path}; 1651 local $self->{load_path};
1208 local $self->{deny_save};
1209 local $self->{deny_reset};
1210 1652
1211 $self->SUPER::thawer_merge ($merge); 1653 $self->SUPER::thawer_merge ($merge);
1212} 1654}
1213 1655
1214sub normalise { 1656sub normalise {
1261 $self->init; # pass $1 etc. 1703 $self->init; # pass $1 etc.
1262 return $self; 1704 return $self;
1263 } 1705 }
1264 } 1706 }
1265 1707
1266 Carp::carp "unable to resolve path '$path' (base '$base')."; 1708 Carp::cluck "unable to resolve path '$path' (base '$base').";
1267 () 1709 ()
1268} 1710}
1269 1711
1270sub init { 1712sub init {
1271 my ($self) = @_; 1713 my ($self) = @_;
1286 1728
1287# the original (read-only) location 1729# the original (read-only) location
1288sub load_path { 1730sub load_path {
1289 my ($self) = @_; 1731 my ($self) = @_;
1290 1732
1291 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} 1733 "$MAPDIR/$self->{path}.map"
1292} 1734}
1293 1735
1294# the temporary/swap location 1736# the temporary/swap location
1295sub save_path { 1737sub save_path {
1296 my ($self) = @_; 1738 my ($self) = @_;
1297 1739
1298 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1740 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1299 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path 1741 "$TMPDIR/$path.map"
1300} 1742}
1301 1743
1302# the unique path, undef == no special unique path 1744# the unique path, undef == no special unique path
1303sub uniq_path { 1745sub uniq_path {
1304 my ($self) = @_; 1746 my ($self) = @_;
1305 1747
1306 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; 1748 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1307 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path 1749 "$UNIQUEDIR/$path"
1308} 1750}
1309 1751
1310# and all this just because we cannot iterate over 1752# and all this just because we cannot iterate over
1311# all maps in C++... 1753# all maps in C++...
1312sub change_all_map_light { 1754sub change_all_map_light {
1313 my ($change) = @_; 1755 my ($change) = @_;
1314 1756
1315 $_->change_map_light ($change) 1757 $_->change_map_light ($change)
1316 for grep $_->outdoor, values %cf::MAP; 1758 for grep $_->outdoor, values %cf::MAP;
1759}
1760
1761sub decay_objects {
1762 my ($self) = @_;
1763
1764 return if $self->{deny_reset};
1765
1766 $self->do_decay_objects;
1317} 1767}
1318 1768
1319sub unlink_save { 1769sub unlink_save {
1320 my ($self) = @_; 1770 my ($self) = @_;
1321 1771
1379 $self->load_header_orig 1829 $self->load_header_orig
1380 or return; 1830 or return;
1381 $self->prepare_orig; 1831 $self->prepare_orig;
1382 } 1832 }
1383 1833
1834 $self->{deny_reset} = 1
1835 if $self->no_reset;
1836
1837 $self->default_region (cf::region::find_by_path $self->{path})
1838 unless $self->default_region;
1839
1384 1 1840 1
1385} 1841}
1386 1842
1387sub find; 1843sub find;
1388sub find { 1844sub find {
1400 $map->{last_save} = $cf::RUNTIME; 1856 $map->{last_save} = $cf::RUNTIME;
1401 1857
1402 $map->load_header 1858 $map->load_header
1403 or return; 1859 or return;
1404 1860
1405 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) 1861 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1406 # doing this can freeze the server in a sync job, obviously 1862 # doing this can freeze the server in a sync job, obviously
1407 #$cf::WAIT_FOR_TICK->wait; 1863 #$cf::WAIT_FOR_TICK->wait;
1408 $map->reset; 1864 $map->reset;
1409 undef $guard; 1865 undef $guard;
1410 return find $path; 1866 return find $path;
1421 my ($self) = @_; 1877 my ($self) = @_;
1422 1878
1423 local $self->{deny_reset} = 1; # loading can take a long time 1879 local $self->{deny_reset} = 1; # loading can take a long time
1424 1880
1425 my $path = $self->{path}; 1881 my $path = $self->{path};
1882
1883 {
1426 my $guard = cf::lock_acquire "map_load:$path"; 1884 my $guard = cf::lock_acquire "map_load:$path";
1427 1885
1428 return if $self->in_memory != cf::MAP_SWAPPED; 1886 return if $self->in_memory != cf::MAP_SWAPPED;
1429 1887
1430 $self->in_memory (cf::MAP_LOADING); 1888 $self->in_memory (cf::MAP_LOADING);
1431 1889
1432 $self->alloc; 1890 $self->alloc;
1433 1891
1434 $self->pre_load; 1892 $self->pre_load;
1435
1436 $self->_load_objects ($self->{load_path}, 1)
1437 or return;
1438
1439 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1440 if delete $self->{load_original};
1441
1442 if (my $uniq = $self->uniq_path) {
1443 utf8::encode $uniq;
1444 if (aio_open $uniq, O_RDONLY, 0) {
1445 $self->clear_unique_items;
1446 $self->_load_objects ($uniq, 0);
1447 }
1448 }
1449
1450 Coro::cede;
1451
1452 # now do the right thing for maps
1453 $self->link_multipart_objects;
1454
1455 unless ($self->{deny_activate}) {
1456 $self->decay_objects;
1457 $self->fix_auto_apply;
1458 $self->update_buttons;
1459 Coro::cede; 1893 Coro::cede;
1460 $self->set_darkness_map; 1894
1895 $self->_load_objects ($self->{load_path}, 1)
1896 or return;
1897
1898 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1899 if delete $self->{load_original};
1900
1901 if (my $uniq = $self->uniq_path) {
1902 utf8::encode $uniq;
1903 if (aio_open $uniq, O_RDONLY, 0) {
1904 $self->clear_unique_items;
1905 $self->_load_objects ($uniq, 0);
1906 }
1907 }
1908
1909 Coro::cede;
1910 # now do the right thing for maps
1911 $self->link_multipart_objects;
1461 $self->difficulty ($self->estimate_difficulty) 1912 $self->difficulty ($self->estimate_difficulty)
1462 unless $self->difficulty; 1913 unless $self->difficulty;
1463 Coro::cede; 1914 Coro::cede;
1915
1916 unless ($self->{deny_activate}) {
1917 $self->decay_objects;
1918 $self->fix_auto_apply;
1919 $self->update_buttons;
1920 Coro::cede;
1921 $self->set_darkness_map;
1922 Coro::cede;
1464 $self->activate; 1923 $self->activate;
1924 }
1925
1926 $self->in_memory (cf::MAP_IN_MEMORY);
1465 } 1927 }
1466 1928
1467 $self->post_load; 1929 $self->post_load;
1468
1469 $self->in_memory (cf::MAP_IN_MEMORY);
1470} 1930}
1471 1931
1472sub customise_for { 1932sub customise_for {
1473 my ($self, $ob) = @_; 1933 my ($self, $ob) = @_;
1474 1934
1475 return find "~" . $ob->name . "/" . $self->{path} 1935 return find "~" . $ob->name . "/" . $self->{path}
1476 if $self->per_player; 1936 if $self->per_player;
1937
1938# return find "?party/" . $ob->name . "/" . $self->{path}
1939# if $self->per_party;
1477 1940
1478 $self 1941 $self
1479} 1942}
1480 1943
1481# find and load all maps in the 3x3 area around a map 1944# find and load all maps in the 3x3 area around a map
1528 1991
1529 undef $MAP_PREFETCH{$path}; 1992 undef $MAP_PREFETCH{$path};
1530 $MAP_PREFETCHER ||= cf::async { 1993 $MAP_PREFETCHER ||= cf::async {
1531 while (%MAP_PREFETCH) { 1994 while (%MAP_PREFETCH) {
1532 for my $path (keys %MAP_PREFETCH) { 1995 for my $path (keys %MAP_PREFETCH) {
1533 my $map = find $path 1996 if (my $map = find $path) {
1534 or next;
1535 $map->load; 1997 $map->load;
1998 }
1536 1999
1537 delete $MAP_PREFETCH{$path}; 2000 delete $MAP_PREFETCH{$path};
1538 } 2001 }
1539 } 2002 }
1540 undef $MAP_PREFETCHER; 2003 undef $MAP_PREFETCHER;
1592 2055
1593sub reset_at { 2056sub reset_at {
1594 my ($self) = @_; 2057 my ($self) = @_;
1595 2058
1596 # TODO: safety, remove and allow resettable per-player maps 2059 # TODO: safety, remove and allow resettable per-player maps
1597 return 1e99 if $self->isa ("ext::map_per_player");#d#
1598 return 1e99 if $self->{deny_reset}; 2060 return 1e99 if $self->{deny_reset};
1599 2061
1600 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; 2062 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1601 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; 2063 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1602 2064
1613 my ($self) = @_; 2075 my ($self) = @_;
1614 2076
1615 my $lock = cf::lock_acquire "map_data:$self->{path}"; 2077 my $lock = cf::lock_acquire "map_data:$self->{path}";
1616 2078
1617 return if $self->players; 2079 return if $self->players;
1618 return if $self->isa ("ext::map_per_player");#d#
1619 2080
1620 warn "resetting map ", $self->path;#d# 2081 warn "resetting map ", $self->path;
1621 2082
1622 $self->in_memory (cf::MAP_SWAPPED); 2083 $self->in_memory (cf::MAP_SWAPPED);
1623 2084
1624 # need to save uniques path 2085 # need to save uniques path
1625 unless ($self->{deny_save}) { 2086 unless ($self->{deny_save}) {
1657 $cf::MAP{$self->path} = $self; 2118 $cf::MAP{$self->path} = $self;
1658 2119
1659 $self->reset; # polite request, might not happen 2120 $self->reset; # polite request, might not happen
1660} 2121}
1661 2122
2123=item $maps = cf::map::tmp_maps
2124
2125Returns an arrayref with all map paths of currently instantiated and saved
2126maps. May block.
2127
2128=cut
2129
2130sub tmp_maps() {
2131 [
2132 map {
2133 utf8::decode $_;
2134 /\.map$/
2135 ? normalise $_
2136 : ()
2137 } @{ aio_readdir $TMPDIR or [] }
2138 ]
2139}
2140
2141=item $maps = cf::map::random_maps
2142
2143Returns an arrayref with all map paths of currently instantiated and saved
2144random maps. May block.
2145
2146=cut
2147
2148sub random_maps() {
2149 [
2150 map {
2151 utf8::decode $_;
2152 /\.map$/
2153 ? normalise "?random/$_"
2154 : ()
2155 } @{ aio_readdir $RANDOMDIR or [] }
2156 ]
2157}
2158
1662=item cf::map::unique_maps 2159=item cf::map::unique_maps
1663 2160
1664Returns an arrayref of paths of all shared maps that have 2161Returns an arrayref of paths of all shared maps that have
1665instantiated unique items. May block. 2162instantiated unique items. May block.
1666 2163
1667=cut 2164=cut
1668 2165
1669sub unique_maps() { 2166sub unique_maps() {
1670 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir 2167 [
1671 or return; 2168 map {
1672
1673 my @paths;
1674
1675 for (@$files) {
1676 utf8::decode $_; 2169 utf8::decode $_;
1677 next if /\.pst$/; 2170 /\.map$/
1678 next unless /^$PATH_SEP/o; 2171 ? normalise $_
1679 2172 : ()
1680 push @paths, cf::map::normalise $_; 2173 } @{ aio_readdir $UNIQUEDIR or [] }
1681 } 2174 ]
1682
1683 \@paths
1684} 2175}
1685 2176
1686package cf; 2177package cf;
1687 2178
1688=back 2179=back
1734 2225
1735 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 2226 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
1736 2227
1737 if ($self->{record_replies}) { 2228 if ($self->{record_replies}) {
1738 push @{ $self->{record_replies} }, [$npc, $msg, $flags]; 2229 push @{ $self->{record_replies} }, [$npc, $msg, $flags];
2230
1739 } else { 2231 } else {
2232 my $pl = $self->contr;
2233
2234 if ($pl->{npc_dialog} && $pl->{npc_dialog}->{id}) {
2235 my $dialog = $pl->{npc_dialog};
2236 $dialog->{pl}->ext_msg ($dialog->{id}, update => msg => $dialog->{pl}->expand_cfpod ($msg));
2237
2238 } else {
1740 $msg = $npc->name . " says: $msg" if $npc; 2239 $msg = $npc->name . " says: $msg" if $npc;
1741 $self->message ($msg, $flags); 2240 $self->message ($msg, $flags);
2241 }
1742 } 2242 }
1743} 2243}
1744 2244
1745=item $player_object->may ("access") 2245=item $player_object->may ("access")
1746 2246
1794 $self->deactivate_recursive; 2294 $self->deactivate_recursive;
1795 2295
1796 return if UNIVERSAL::isa $self->map, "ext::map_link"; 2296 return if UNIVERSAL::isa $self->map, "ext::map_link";
1797 2297
1798 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] 2298 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1799 if $self->map; 2299 if $self->map && $self->map->{path} ne "{link}";
1800 2300
1801 $self->enter_map ($LINK_MAP || link_map, 10, 10); 2301 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1802} 2302}
1803 2303
1804sub cf::object::player::leave_link { 2304sub cf::object::player::leave_link {
1805 my ($self, $map, $x, $y) = @_; 2305 my ($self, $map, $x, $y) = @_;
2306
2307 return unless $self->contr->active;
1806 2308
1807 my $link_pos = delete $self->{_link_pos}; 2309 my $link_pos = delete $self->{_link_pos};
1808 2310
1809 unless ($map) { 2311 unless ($map) {
1810 # restore original map position 2312 # restore original map position
1833 2335
1834 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext 2336 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
1835 $self->enter_map ($map, $x, $y); 2337 $self->enter_map ($map, $x, $y);
1836} 2338}
1837 2339
1838cf::player->attach ( 2340=item $player_object->goto ($path, $x, $y[, $check->($map)[, $done->()]])
1839 on_logout => sub {
1840 my ($pl) = @_;
1841 2341
1842 # abort map switching before logout 2342Moves the player to the given map-path and coordinates by first freezing
1843 if ($pl->ob->{_link_pos}) { 2343her, loading and preparing them map, calling the provided $check callback
1844 cf::sync_job { 2344that has to return the map if sucecssful, and then unfreezes the player on
1845 $pl->ob->leave_link 2345the new (success) or old (failed) map position. In either case, $done will
1846 }; 2346be called at the end of this process.
1847 }
1848 },
1849 on_login => sub {
1850 my ($pl) = @_;
1851 2347
1852 # try to abort aborted map switching on player login :)
1853 # should happen only on crashes
1854 if ($pl->ob->{_link_pos}) {
1855 $pl->ob->enter_link;
1856 (async {
1857 $pl->ob->reply (undef,
1858 "There was an internal problem at your last logout, "
1859 . "the server will try to bring you to your intended destination in a second.",
1860 cf::NDI_RED);
1861 # we need this sleep as the login has a concurrent enter_exit running
1862 # and this sleep increases chances of the player not ending up in scorn
1863 Coro::Timer::sleep 1;
1864 $pl->ob->leave_link;
1865 })->prio (2);
1866 }
1867 },
1868);
1869
1870=item $player_object->goto ($path, $x, $y)
1871
1872=cut 2348=cut
2349
2350our $GOTOGEN;
1873 2351
1874sub cf::object::player::goto { 2352sub cf::object::player::goto {
1875 my ($self, $path, $x, $y) = @_; 2353 my ($self, $path, $x, $y, $check, $done) = @_;
2354
2355 # do generation counting so two concurrent goto's will be executed in-order
2356 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
1876 2357
1877 $self->enter_link; 2358 $self->enter_link;
1878 2359
1879 (async { 2360 (async {
1880 my $map = eval { 2361 my $map = eval {
1881 my $map = cf::map::find $path; 2362 my $map = cf::map::find $path;
2363
2364 if ($map) {
1882 $map = $map->customise_for ($self) if $map; 2365 $map = $map->customise_for ($self);
2366 $map = $check->($map) if $check && $map;
2367 } else {
2368 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2369 }
2370
1883 $map 2371 $map
2372 };
2373
2374 if ($@) {
2375 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2376 LOG llevError | logBacktrace, Carp::longmess $@;
1884 } or 2377 }
1885 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1886 2378
2379 if ($gen == $self->{_goto_generation}) {
2380 delete $self->{_goto_generation};
1887 $self->leave_link ($map, $x, $y); 2381 $self->leave_link ($map, $x, $y);
2382 }
2383
2384 $done->() if $done;
1888 })->prio (1); 2385 })->prio (1);
1889} 2386}
1890 2387
1891=item $player_object->enter_exit ($exit_object) 2388=item $player_object->enter_exit ($exit_object)
1892 2389
1931 2428
1932 $rmp->{random_seed} ||= $exit->random_seed; 2429 $rmp->{random_seed} ||= $exit->random_seed;
1933 2430
1934 my $data = cf::to_json $rmp; 2431 my $data = cf::to_json $rmp;
1935 my $md5 = Digest::MD5::md5_hex $data; 2432 my $md5 = Digest::MD5::md5_hex $data;
1936 my $meta = "$cf::RANDOM_MAPS/$md5.meta"; 2433 my $meta = "$RANDOMDIR/$md5.meta";
1937 2434
1938 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { 2435 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1939 aio_write $fh, 0, (length $data), $data, 0; 2436 aio_write $fh, 0, (length $data), $data, 0;
1940 undef $fh; 2437 undef $fh;
1941 aio_rename "$meta~", $meta; 2438 aio_rename "$meta~", $meta;
1950 2447
1951 return unless $self->type == cf::PLAYER; 2448 return unless $self->type == cf::PLAYER;
1952 2449
1953 if ($exit->slaying eq "/!") { 2450 if ($exit->slaying eq "/!") {
1954 #TODO: this should de-fi-ni-te-ly not be a sync-job 2451 #TODO: this should de-fi-ni-te-ly not be a sync-job
2452 # the problem is that $exit might not survive long enough
2453 # so it needs to be done right now, right here
1955 cf::sync_job { prepare_random_map $exit }; 2454 cf::sync_job { prepare_random_map $exit };
1956 } 2455 }
1957 2456
1958 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; 2457 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1959 my $hp = $exit->stats->hp; 2458 my $hp = $exit->stats->hp;
1960 my $sp = $exit->stats->sp; 2459 my $sp = $exit->stats->sp;
1961 2460
1962 $self->enter_link; 2461 $self->enter_link;
2462
2463 # if exit is damned, update players death & WoR home-position
2464 $self->contr->savebed ($slaying, $hp, $sp)
2465 if $exit->flag (FLAG_DAMNED);
1963 2466
1964 (async { 2467 (async {
1965 $self->deactivate_recursive; # just to be sure 2468 $self->deactivate_recursive; # just to be sure
1966 unless (eval { 2469 unless (eval {
1967 $self->goto ($slaying, $hp, $sp); 2470 $self->goto ($slaying, $hp, $sp);
1968 2471
1969 1; 2472 1;
1970 }) { 2473 }) {
1971 $self->message ("Something went wrong deep within the crossfire server. " 2474 $self->message ("Something went wrong deep within the crossfire server. "
1972 . "I'll try to bring you back to the map you were before. " 2475 . "I'll try to bring you back to the map you were before. "
1973 . "Please report this to the dungeon master!", 2476 . "Please report this to the dungeon master!",
1974 cf::NDI_UNIQUE | cf::NDI_RED); 2477 cf::NDI_UNIQUE | cf::NDI_RED);
1975 2478
1976 warn "ERROR in enter_exit: $@"; 2479 warn "ERROR in enter_exit: $@";
1977 $self->leave_link; 2480 $self->leave_link;
1978 } 2481 }
1979 })->prio (1); 2482 })->prio (1);
1992 2495
1993sub cf::client::send_drawinfo { 2496sub cf::client::send_drawinfo {
1994 my ($self, $text, $flags) = @_; 2497 my ($self, $text, $flags) = @_;
1995 2498
1996 utf8::encode $text; 2499 utf8::encode $text;
1997 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); 2500 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
1998} 2501}
1999 2502
2503=item $client->send_msg ($channel, $msg, $color, [extra...])
2504
2505Send a drawinfo or msg packet to the client, formatting the msg for the
2506client if neccessary. C<$type> should be a string identifying the type of
2507the message, with C<log> being the default. If C<$color> is negative, suppress
2508the message unless the client supports the msg packet.
2509
2510=cut
2511
2512sub cf::client::send_msg {
2513 my ($self, $channel, $msg, $color, @extra) = @_;
2514
2515 $msg = $self->pl->expand_cfpod ($msg);
2516
2517 $color &= ~cf::NDI_UNIQUE; # just in case...
2518
2519 if (ref $channel) {
2520 # send meta info to client, if not yet sent
2521 unless (exists $self->{channel}{$channel->{id}}) {
2522 $self->{channel}{$channel->{id}} = $channel;
2523 $self->ext_msg (channel_info => $channel);
2524 }
2525
2526 $channel = $channel->{id};
2527 }
2528
2529 return unless @extra || length $msg;
2530
2531 if ($self->can_msg) {
2532 $self->send_packet ("msg " . $self->{json_coder}->encode ([$color, $channel, $msg, @extra]));
2533 } else {
2534 # replace some tags by gcfclient-compatible ones
2535 for ($msg) {
2536 1 while
2537 s/<b>([^<]*)<\/b>/[b]${1}[\/b]/
2538 || s/<i>([^<]*)<\/i>/[i]${1}[\/i]/
2539 || s/<u>([^<]*)<\/u>/[ul]${1}[\/ul]/
2540 || s/<tt>([^<]*)<\/tt>/[fixed]${1}[\/fixed]/
2541 || s/<fg name=\"([^"]+)\">([^<]*)<\/fg>/[color=$1]${2}[\/color]/;
2542 }
2543
2544 if ($color >= 0) {
2545 if (0 && $msg =~ /\[/) {
2546 $self->send_packet ("drawextinfo $color 4 0 $msg")
2547 } else {
2548 $msg =~ s/\[\/?(?:b|i|u|fixed|color)[^\]]*\]//g;
2549 $self->send_packet ("drawinfo $color $msg")
2550 }
2551 }
2552 }
2553}
2554
2555=item $client->ext_msg ($type, @msg)
2556
2557Sends an ext event to the client.
2558
2559=cut
2560
2561sub cf::client::ext_msg($$@) {
2562 my ($self, $type, @msg) = @_;
2563
2564 my $extcmd = $self->extcmd;
2565
2566 if ($extcmd == 2) {
2567 $self->send_packet ("ext " . $self->{json_coder}->encode ([$type, @msg]));
2568 } elsif ($extcmd == 1) { # TODO: remove
2569 push @msg, msgtype => "event_$type";
2570 $self->send_packet ("ext " . $self->{json_coder}->encode ({@msg}));
2571 }
2572}
2000 2573
2001=item $success = $client->query ($flags, "text", \&cb) 2574=item $success = $client->query ($flags, "text", \&cb)
2002 2575
2003Queues a query to the client, calling the given callback with 2576Queues a query to the client, calling the given callback with
2004the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, 2577the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2005C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. 2578C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2006 2579
2007Queries can fail, so check the return code. Or don't, as queries will become 2580Queries can fail, so check the return code. Or don't, as queries will
2008reliable at some point in the future. 2581become reliable at some point in the future.
2009 2582
2010=cut 2583=cut
2011 2584
2012sub cf::client::query { 2585sub cf::client::query {
2013 my ($self, $flags, $text, $cb) = @_; 2586 my ($self, $flags, $text, $cb) = @_;
2021 utf8::encode $text; 2594 utf8::encode $text;
2022 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; 2595 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2023 2596
2024 $self->send_packet ($self->{query_queue}[0][0]) 2597 $self->send_packet ($self->{query_queue}[0][0])
2025 if @{ $self->{query_queue} } == 1; 2598 if @{ $self->{query_queue} } == 1;
2599
2600 1
2026} 2601}
2027 2602
2028cf::client->attach ( 2603cf::client->attach (
2604 on_connect => sub {
2605 my ($ns) = @_;
2606
2607 $ns->{json_coder} = JSON::XS->new->utf8->max_size (1e6)->convert_blessed;
2608 },
2029 on_reply => sub { 2609 on_reply => sub {
2030 my ($ns, $msg) = @_; 2610 my ($ns, $msg) = @_;
2031 2611
2032 # this weird shuffling is so that direct followup queries 2612 # this weird shuffling is so that direct followup queries
2033 # get handled first 2613 # get handled first
2045 } else { 2625 } else {
2046 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; 2626 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2047 } 2627 }
2048 } 2628 }
2049 }, 2629 },
2630 on_exticmd => sub {
2631 my ($ns, $buf) = @_;
2632
2633 my $msg = eval { $ns->{json_coder}->decode ($buf) };
2634
2635 if (ref $msg) {
2636 my ($type, $reply, @payload) =
2637 "ARRAY" eq ref $msg
2638 ? @$msg
2639 : ($msg->{msgtype}, $msg->{msgid}, %$msg); # TODO: version 1, remove
2640
2641 if (my $cb = $EXTICMD{$type}) {
2642 my @reply = $cb->($ns, @payload);
2643
2644 $ns->ext_reply ($reply, @reply)
2645 if $reply;
2646 }
2647 } else {
2648 warn "client " . ($ns->pl ? $ns->pl->ob->name : $ns->host) . " sent unparseable exti message: <$buf>\n";
2649 }
2650
2651 cf::override;
2652 },
2050); 2653);
2051 2654
2052=item $client->async (\&cb) 2655=item $client->async (\&cb)
2053 2656
2054Create a new coroutine, running the specified callback. The coroutine will 2657Create a new coroutine, running the specified callback. The coroutine will
2101 2704
2102# here we export the classes and methods available to script code 2705# here we export the classes and methods available to script code
2103 2706
2104=pod 2707=pod
2105 2708
2106The following fucntions and emthods are available within a safe environment: 2709The following functions and methods are available within a safe environment:
2107 2710
2108 cf::object contr pay_amount pay_player map 2711 cf::object
2712 contr pay_amount pay_player map x y force_find force_add
2713 insert remove
2714
2109 cf::object::player player 2715 cf::object::player
2110 cf::player peaceful 2716 player
2111 cf::map trigger 2717
2718 cf::player
2719 peaceful
2720
2721 cf::map
2722 trigger
2112 2723
2113=cut 2724=cut
2114 2725
2115for ( 2726for (
2116 ["cf::object" => qw(contr pay_amount pay_player map)], 2727 ["cf::object" => qw(contr pay_amount pay_player map force_find force_add x y
2728 insert remove)],
2117 ["cf::object::player" => qw(player)], 2729 ["cf::object::player" => qw(player)],
2118 ["cf::player" => qw(peaceful)], 2730 ["cf::player" => qw(peaceful)],
2119 ["cf::map" => qw(trigger)], 2731 ["cf::map" => qw(trigger)],
2120) { 2732) {
2121 no strict 'refs'; 2733 no strict 'refs';
2192=back 2804=back
2193 2805
2194=cut 2806=cut
2195 2807
2196############################################################################# 2808#############################################################################
2197
2198=head2 EXTENSION DATABASE SUPPORT
2199
2200Crossfire maintains a very simple database for extension use. It can
2201currently store anything that can be serialised using Storable, which
2202excludes objects.
2203
2204The parameter C<$family> should best start with the name of the extension
2205using it, it should be unique.
2206
2207=over 4
2208
2209=item $value = cf::db_get $family => $key
2210
2211Returns a single value from the database.
2212
2213=item cf::db_put $family => $key => $value
2214
2215Stores the given C<$value> in the family.
2216
2217=cut
2218
2219our $DB;
2220
2221sub db_init {
2222 unless ($DB) {
2223 $DB = BDB::db_create $DB_ENV;
2224
2225 cf::sync_job {
2226 eval {
2227 $DB->set_flags (BDB::CHKSUM);
2228
2229 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
2230 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
2231 cf::cleanup "db_open(db): $!" if $!;
2232 };
2233 cf::cleanup "db_open(db): $@" if $@;
2234 };
2235
2236 my $path = cf::localdir . "/database.pst";
2237 if (stat $path) {
2238 cf::sync_job {
2239 my $pst = Storable::retrieve $path;
2240
2241 cf::db_put (board => data => $pst->{board});
2242 cf::db_put (guildrules => data => $pst->{guildrules});
2243 cf::db_put (rent => balance => $pst->{rent}{balance});
2244 BDB::db_env_txn_checkpoint $DB_ENV;
2245
2246 unlink $path;
2247 };
2248 }
2249 }
2250}
2251
2252sub db_get($$) {
2253 my $key = "$_[0]/$_[1]";
2254
2255 cf::sync_job {
2256 BDB::db_get $DB, undef, $key, my $data;
2257
2258 $! ? ()
2259 : Compress::LZF::sthaw $data
2260 }
2261}
2262
2263sub db_put($$$) {
2264 BDB::dbreq_pri 4;
2265 BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { };
2266}
2267
2268#############################################################################
2269# the server's init and main functions 2809# the server's init and main functions
2270 2810
2271sub init_resources { 2811sub load_facedata($) {
2272 load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir 2812 my ($path) = @_;
2813
2814 warn "loading facedata from $path\n";
2815
2816 my $facedata;
2817 0 < aio_load $path, $facedata
2818 or die "$path: $!";
2819
2820 $facedata = Coro::Storable::thaw $facedata;
2821
2822 $facedata->{version} == 2
2823 or cf::cleanup "$path: version mismatch, cannot proceed.";
2824
2825 {
2826 my $faces = $facedata->{faceinfo};
2827
2828 while (my ($face, $info) = each %$faces) {
2829 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2830 cf::face::set_visibility $idx, $info->{visibility};
2831 cf::face::set_magicmap $idx, $info->{magicmap};
2832 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2833 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2834
2835 cf::cede_to_tick;
2836 }
2837
2838 while (my ($face, $info) = each %$faces) {
2839 next unless $info->{smooth};
2840 my $idx = cf::face::find $face
2841 or next;
2842 if (my $smooth = cf::face::find $info->{smooth}) {
2843 cf::face::set_smooth $idx, $smooth;
2844 cf::face::set_smoothlevel $idx, $info->{smoothlevel};
2845 } else {
2846 warn "smooth face '$info->{smooth}' not found for face '$face'";
2847 }
2848
2849 cf::cede_to_tick;
2850 }
2851 }
2852
2853 {
2854 my $anims = $facedata->{animinfo};
2855
2856 while (my ($anim, $info) = each %$anims) {
2857 cf::anim::set $anim, $info->{frames}, $info->{facings};
2858 cf::cede_to_tick;
2859 }
2860
2861 cf::anim::invalidate_all; # d'oh
2862 }
2863
2864 {
2865 # TODO: for gcfclient pleasure, we should give resources
2866 # that gcfclient doesn't grok a >10000 face index.
2867 my $res = $facedata->{resource};
2868 my $enc = JSON::XS->new->utf8->canonical;
2869
2870 if (my $soundconf = delete $res->{"res/sound.conf"}) {
2871 $soundconf = $enc->decode (delete $soundconf->{data});
2872 # todo
2873 }
2874
2875 while (my ($name, $info) = each %$res) {
2876 my $meta = $enc->encode ({
2877 name => $name,
2878 %{ $info->{meta} || {} },
2879 });
2880
2881 my $idx = (cf::face::find $name) || cf::face::alloc $name;
2882
2883 if ($info->{type} & 1) {
2884 # prepend meta info
2885
2886 my $data = pack "(w/a*)*", $meta, $info->{data};
2887 my $chk = Digest::MD5::md5 "$info->{chksum},$meta"; # mangle data checksum and metadata
2888
2889 cf::face::set_data $idx, 0, $data, $chk;
2890 } else {
2891 cf::face::set_data $idx, 0, $info->{data}, $info->{chksum};
2892 }
2893
2894 cf::face::set_type $idx, $info->{type};
2895
2896 cf::cede_to_tick;
2897 }
2898 }
2899
2900 1
2901}
2902
2903register_exticmd fx_want => sub {
2904 my ($ns, $want) = @_;
2905
2906 while (my ($k, $v) = each %$want) {
2907 $ns->fx_want ($k, $v);
2908 }
2909};
2910
2911sub reload_regions {
2912 load_resource_file "$MAPDIR/regions"
2273 or die "unable to load regions file\n";#d# 2913 or die "unable to load regions file\n";
2914
2915 for (cf::region::list) {
2916 $_->{match} = qr/$_->{match}/
2917 if exists $_->{match};
2918 }
2919}
2920
2921sub reload_facedata {
2922 load_facedata "$DATADIR/facedata"
2923 or die "unable to load facedata\n";
2924}
2925
2926sub reload_archetypes {
2927 load_resource_file "$DATADIR/archetypes"
2928 or die "unable to load archetypes\n";
2929 #d# NEED to laod twice to resolve forward references
2930 # this really needs to be done in an extra post-pass
2931 # (which needs to be synchronous, so solve it differently)
2932 load_resource_file "$DATADIR/archetypes"
2933 or die "unable to load archetypes\n";
2934}
2935
2936sub reload_treasures {
2937 load_resource_file "$DATADIR/treasures"
2938 or die "unable to load treasurelists\n";
2939}
2940
2941sub reload_resources {
2942 warn "reloading resource files...\n";
2943
2944 reload_regions;
2945 reload_facedata;
2946 #reload_archetypes;#d#
2947 reload_archetypes;
2948 reload_treasures;
2949
2950 warn "finished reloading resource files\n";
2951}
2952
2953sub init {
2954 reload_resources;
2274} 2955}
2275 2956
2276sub cfg_load { 2957sub cfg_load {
2277 open my $fh, "<:utf8", cf::confdir . "/config" 2958 open my $fh, "<:utf8", "$CONFDIR/config"
2278 or return; 2959 or return;
2279 2960
2280 local $/; 2961 local $/;
2281 *CFG = YAML::Syck::Load <$fh>; 2962 *CFG = YAML::Syck::Load <$fh>;
2282 2963
2290 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" 2971 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2291 and die "WARNING: m(un)lockall failed: $!\n"; 2972 and die "WARNING: m(un)lockall failed: $!\n";
2292 }; 2973 };
2293 warn $@ if $@; 2974 warn $@ if $@;
2294 } 2975 }
2295}
2296
2297sub init {
2298 init_resources;
2299} 2976}
2300 2977
2301sub main { 2978sub main {
2302 # we must not ever block the main coroutine 2979 # we must not ever block the main coroutine
2303 local $Coro::idle = sub { 2980 local $Coro::idle = sub {
2331 }, 3008 },
2332 ); 3009 );
2333 } 3010 }
2334} 3011}
2335 3012
3013sub write_runtime {
3014 my $runtime = "$LOCALDIR/runtime";
3015
3016 # first touch the runtime file to show we are still running:
3017 # the fsync below can take a very very long time.
3018
3019 IO::AIO::aio_utime $runtime, undef, undef;
3020
3021 my $guard = cf::lock_acquire "write_runtime";
3022
3023 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
3024 or return;
3025
3026 my $value = $cf::RUNTIME + 90 + 10;
3027 # 10 is the runtime save interval, for a monotonic clock
3028 # 60 allows for the watchdog to kill the server.
3029
3030 (aio_write $fh, 0, (length $value), $value, 0) <= 0
3031 and return;
3032
3033 # always fsync - this file is important
3034 aio_fsync $fh
3035 and return;
3036
3037 # touch it again to show we are up-to-date
3038 aio_utime $fh, undef, undef;
3039
3040 close $fh
3041 or return;
3042
3043 aio_rename "$runtime~", $runtime
3044 and return;
3045
3046 warn "runtime file written.\n";
3047
3048 1
3049}
3050
2336sub emergency_save() { 3051sub emergency_save() {
2337 my $freeze_guard = cf::freeze_mainloop; 3052 my $freeze_guard = cf::freeze_mainloop;
2338 3053
2339 warn "enter emergency perl save\n"; 3054 warn "enter emergency perl save\n";
2340 3055
2371 3086
2372 warn Carp::longmess "post_cleanup backtrace" 3087 warn Carp::longmess "post_cleanup backtrace"
2373 if $make_core; 3088 if $make_core;
2374} 3089}
2375 3090
2376sub reload() { 3091sub do_reload_perl() {
2377 # can/must only be called in main 3092 # can/must only be called in main
2378 if ($Coro::current != $Coro::main) { 3093 if ($Coro::current != $Coro::main) {
2379 warn "can only reload from main coroutine"; 3094 warn "can only reload from main coroutine";
2380 return; 3095 return;
2381 } 3096 }
2406 Coro::cede; 3121 Coro::cede;
2407 last unless IO::AIO::nreqs || BDB::nreqs; 3122 last unless IO::AIO::nreqs || BDB::nreqs;
2408 warn "iterate..."; 3123 warn "iterate...";
2409 } 3124 }
2410 3125
3126 ++$RELOAD;
3127
2411 warn "cancelling all extension coros"; 3128 warn "cancelling all extension coros";
2412 $_->cancel for values %EXT_CORO; 3129 $_->cancel for values %EXT_CORO;
2413 %EXT_CORO = (); 3130 %EXT_CORO = ();
2414 3131
2415 warn "removing commands"; 3132 warn "removing commands";
2416 %COMMAND = (); 3133 %COMMAND = ();
2417 3134
2418 warn "removing ext commands"; 3135 warn "removing ext/exti commands";
2419 %EXTCMD = (); 3136 %EXTCMD = ();
3137 %EXTICMD = ();
2420 3138
2421 warn "unloading/nuking all extensions"; 3139 warn "unloading/nuking all extensions";
2422 for my $pkg (@EXTS) { 3140 for my $pkg (@EXTS) {
2423 warn "... unloading $pkg"; 3141 warn "... unloading $pkg";
2424 3142
2454 Symbol::delete_package "safe::$_" 3172 Symbol::delete_package "safe::$_"
2455 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); 3173 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
2456 3174
2457 warn "unloading cf.pm \"a bit\""; 3175 warn "unloading cf.pm \"a bit\"";
2458 delete $INC{"cf.pm"}; 3176 delete $INC{"cf.pm"};
3177 delete $INC{"cf/pod.pm"};
2459 3178
2460 # don't, removes xs symbols, too, 3179 # don't, removes xs symbols, too,
2461 # and global variables created in xs 3180 # and global variables created in xs
2462 #Symbol::delete_package __PACKAGE__; 3181 #Symbol::delete_package __PACKAGE__;
2463 3182
2478 warn "reattaching attachments to maps"; 3197 warn "reattaching attachments to maps";
2479 reattach $_ for values %MAP; 3198 reattach $_ for values %MAP;
2480 warn "reattaching attachments to players"; 3199 warn "reattaching attachments to players";
2481 reattach $_ for values %PLAYER; 3200 reattach $_ for values %PLAYER;
2482 3201
2483 warn "loading reloadable resources";
2484 init_resources;
2485
2486 warn "leaving sync_job"; 3202 warn "leaving sync_job";
2487 3203
2488 1 3204 1
2489 } or do { 3205 } or do {
2490 warn $@; 3206 warn $@;
2495 warn "reloaded"; 3211 warn "reloaded";
2496}; 3212};
2497 3213
2498our $RELOAD_WATCHER; # used only during reload 3214our $RELOAD_WATCHER; # used only during reload
2499 3215
3216sub reload_perl() {
3217 # doing reload synchronously and two reloads happen back-to-back,
3218 # coro crashes during coro_state_free->destroy here.
3219
3220 $RELOAD_WATCHER ||= Event->timer (
3221 reentrant => 0,
3222 after => 0,
3223 data => WF_AUTOCANCEL,
3224 cb => sub {
3225 do_reload_perl;
3226 undef $RELOAD_WATCHER;
3227 },
3228 );
3229}
3230
2500register_command "reload" => sub { 3231register_command "reload" => sub {
2501 my ($who, $arg) = @_; 3232 my ($who, $arg) = @_;
2502 3233
2503 if ($who->flag (FLAG_WIZ)) { 3234 if ($who->flag (FLAG_WIZ)) {
2504 $who->message ("reloading server."); 3235 $who->message ("reloading server.");
2505 3236 async { reload_perl };
2506 # doing reload synchronously and two reloads happen back-to-back,
2507 # coro crashes during coro_state_free->destroy here.
2508
2509 $RELOAD_WATCHER ||= Event->timer (
2510 reentrant => 0,
2511 after => 0,
2512 data => WF_AUTOCANCEL,
2513 cb => sub {
2514 reload;
2515 undef $RELOAD_WATCHER;
2516 },
2517 );
2518 } 3237 }
2519}; 3238};
2520 3239
2521unshift @INC, $LIBDIR; 3240unshift @INC, $LIBDIR;
2522 3241
2523my $bug_warning = 0; 3242my $bug_warning = 0;
2524 3243
3244our @WAIT_FOR_TICK;
3245our @WAIT_FOR_TICK_BEGIN;
3246
3247sub wait_for_tick {
3248 return unless $TICK_WATCHER->is_active;
3249 return if $Coro::current == $Coro::main;
3250
3251 my $signal = new Coro::Signal;
3252 push @WAIT_FOR_TICK, $signal;
3253 $signal->wait;
3254}
3255
3256sub wait_for_tick_begin {
3257 return unless $TICK_WATCHER->is_active;
3258 return if $Coro::current == $Coro::main;
3259
3260 my $signal = new Coro::Signal;
3261 push @WAIT_FOR_TICK_BEGIN, $signal;
3262 $signal->wait;
3263}
3264
3265 my $min = 1e6;#d#
3266 my $avg = 10;
2525$TICK_WATCHER = Event->timer ( 3267$TICK_WATCHER = Event->timer (
2526 reentrant => 0, 3268 reentrant => 0,
2527 parked => 1, 3269 parked => 1,
2528 prio => 0, 3270 prio => 0,
2529 at => $NEXT_TICK || $TICK, 3271 at => $NEXT_TICK || $TICK,
2533 Carp::cluck "major BUG: server tick called outside of main coro, skipping it" 3275 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2534 unless ++$bug_warning > 10; 3276 unless ++$bug_warning > 10;
2535 return; 3277 return;
2536 } 3278 }
2537 3279
2538 $NOW = Event::time; 3280 $NOW = $tick_start = Event::time;
2539 3281
2540 cf::server_tick; # one server iteration 3282 cf::server_tick; # one server iteration
3283
3284 0 && sync_job {#d#
3285 for(1..10) {
3286 my $t = Event::time;
3287 my $map = my $map = new_from_path cf::map "/tmp/x.map"
3288 or die;
3289
3290 $map->width (50);
3291 $map->height (50);
3292 $map->alloc;
3293 $map->_load_objects ("/tmp/x.map", 1);
3294 my $t = Event::time - $t;
3295
3296 #next unless $t < 0.0013;#d#
3297 if ($t < $min) {
3298 $min = $t;
3299 }
3300 $avg = $avg * 0.99 + $t * 0.01;
3301 }
3302 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
3303 exit 0;
3304 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
3305 };
3306
2541 $RUNTIME += $TICK; 3307 $RUNTIME += $TICK;
2542 $NEXT_TICK += $TICK; 3308 $NEXT_TICK += $TICK;
2543 3309
2544 if ($NOW >= $NEXT_RUNTIME_WRITE) { 3310 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2545 $NEXT_RUNTIME_WRITE = $NOW + 10; 3311 $NEXT_RUNTIME_WRITE = $NOW + 10;
2547 write_runtime 3313 write_runtime
2548 or warn "ERROR: unable to write runtime file: $!"; 3314 or warn "ERROR: unable to write runtime file: $!";
2549 }; 3315 };
2550 } 3316 }
2551 3317
2552 $WAIT_FOR_TICK->broadcast;
2553 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2554
2555# my $AFTER = Event::time; 3318# my $AFTER = Event::time;
2556# warn $AFTER - $NOW;#d# 3319# warn $AFTER - $NOW;#d#
2557 3320
3321 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
3322 $sig->send;
3323 }
3324 while (my $sig = shift @WAIT_FOR_TICK) {
3325 $sig->send;
3326 }
3327
3328 $NOW = Event::time;
3329
2558 # if we are delayed by four ticks or more, skip them all 3330 # if we are delayed by four ticks or more, skip them all
2559 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; 3331 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
2560 3332
2561 $TICK_WATCHER->at ($NEXT_TICK); 3333 $TICK_WATCHER->at ($NEXT_TICK);
2562 $TICK_WATCHER->start; 3334 $TICK_WATCHER->start;
3335
3336 $LOAD = ($NOW - $tick_start) / $TICK;
3337 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
3338
3339 _post_tick;
3340
3341
2563 }, 3342 },
2564); 3343);
2565 3344
2566{ 3345{
2567 BDB::max_poll_time $TICK * 0.1; 3346 BDB::max_poll_time $TICK * 0.1;
2595 3374
2596 cf::sync_job { 3375 cf::sync_job {
2597 eval { 3376 eval {
2598 BDB::db_env_open 3377 BDB::db_env_open
2599 $DB_ENV, 3378 $DB_ENV,
2600 $BDB_ENV_DIR, 3379 $BDBDIR,
2601 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN 3380 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
2602 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, 3381 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
2603 0666; 3382 0666;
2604 3383
2605 cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; 3384 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
2606 3385
2607 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); 3386 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
2608 $DB_ENV->set_lk_detect; 3387 $DB_ENV->set_lk_detect;
2609 }; 3388 };
2610 3389
2626 prio => 6, 3405 prio => 6,
2627 cb => \&IO::AIO::poll_cb, 3406 cb => \&IO::AIO::poll_cb,
2628 ); 3407 );
2629} 3408}
2630 3409
3410my $_log_backtrace;
3411
3412sub _log_backtrace {
3413 my ($msg, @addr) = @_;
3414
3415 $msg =~ s/\n//;
3416
3417 # limit the # of concurrent backtraces
3418 if ($_log_backtrace < 2) {
3419 ++$_log_backtrace;
3420 async {
3421 my @bt = fork_call {
3422 @addr = map { sprintf "%x", $_ } @addr;
3423 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3424 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3425 or die "addr2line: $!";
3426
3427 my @funcs;
3428 my @res = <$fh>;
3429 chomp for @res;
3430 while (@res) {
3431 my ($func, $line) = splice @res, 0, 2, ();
3432 push @funcs, "[$func] $line";
3433 }
3434
3435 @funcs
3436 };
3437
3438 LOG llevInfo, "[ABT] $msg\n";
3439 LOG llevInfo, "[ABT] $_\n" for @bt;
3440 --$_log_backtrace;
3441 };
3442 } else {
3443 LOG llevInfo, "[ABT] $msg\n";
3444 LOG llevInfo, "[ABT] [suppressed]\n";
3445 }
3446}
3447
3448# load additional modules
3449use cf::pod;
3450
2631END { cf::emergency_save } 3451END { cf::emergency_save }
2632 3452
26331 34531
2634 3454

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines