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.82 by root, Sun Dec 3 20:59:52 2006 UTC vs.
Revision 1.278 by root, Mon Jun 11 21:38:14 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
8use Socket;
5use Storable; 9use Storable;
10use Event;
6use Opcode; 11use Opcode;
7use Safe; 12use Safe;
8use Safe::Hole; 13use Safe::Hole;
9 14
10use IO::AIO (); 15use Coro 3.61 ();
16use Coro::State;
17use Coro::Handle;
18use Coro::Event;
19use Coro::Timer;
20use Coro::Signal;
21use Coro::Semaphore;
22use Coro::AIO;
23use Coro::Storable;
24
25use BDB ();
26use Data::Dumper;
27use Digest::MD5;
28use Fcntl;
11use YAML::Syck (); 29use YAML::Syck ();
30use IO::AIO 2.32 ();
12use Time::HiRes; 31use Time::HiRes;
13use Event; 32use Compress::LZF;
33
34# configure various modules to our taste
35#
36$Storable::canonical = 1; # reduce rsync transfers
37Coro::State::cctx_stacksize 256000; # 1-2MB stack, for deep recursions in maze generator
38Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later
39
14$Event::Eval = 1; # no idea why this is required, but it is 40$Event::Eval = 1; # no idea why this is required, but it is
15 41
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 42# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1; 43$YAML::Syck::ImplicitUnicode = 1;
18 44
19use strict; 45$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
20 46
21_init_vars; 47sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 48
23our %COMMAND = (); 49our %COMMAND = ();
50our %COMMAND_TIME = ();
51
52our @EXTS = (); # list of extension package names
53our %EXTCMD = ();
54our %EXT_CORO = (); # coroutines bound to extensions
55our %EXT_MAP = (); # pluggable maps
56
57our $RELOAD; # number of reloads so far
24our @EVENT; 58our @EVENT;
25our $LIBDIR = maps_directory "perl";
26 59
27our $TICK = MAX_TIME * 1e-6; 60our $CONFDIR = confdir;
61our $DATADIR = datadir;
62our $LIBDIR = "$DATADIR/ext";
63our $PODDIR = "$DATADIR/pod";
64our $MAPDIR = "$DATADIR/" . mapdir;
65our $LOCALDIR = localdir;
66our $TMPDIR = "$LOCALDIR/" . tmpdir;
67our $UNIQUEDIR = "$LOCALDIR/" . uniquedir;
68our $PLAYERDIR = "$LOCALDIR/" . playerdir;
69our $RANDOMDIR = "$LOCALDIR/random";
70our $BDBDIR = "$LOCALDIR/db";
71
72our $TICK = MAX_TIME * 1e-6; # this is a CONSTANT(!)
28our $TICK_WATCHER; 73our $TICK_WATCHER;
74our $AIO_POLL_WATCHER;
75our $NEXT_RUNTIME_WRITE; # when should the runtime file be written
29our $NEXT_TICK; 76our $NEXT_TICK;
77our $NOW;
78our $USE_FSYNC = 1; # use fsync to write maps - default off
79
80our $BDB_POLL_WATCHER;
81our $DB_ENV;
30 82
31our %CFG; 83our %CFG;
32 84
33our $uptime; 85our $UPTIME; $UPTIME ||= time;
86our $RUNTIME;
34 87
35$uptime ||= time; 88our %PLAYER; # all users
89our %MAP; # all maps
90our $LINK_MAP; # the special {link} map, which is always available
91
92# used to convert map paths into valid unix filenames by replacing / by ∕
93our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
94
95our $LOAD; # a number between 0 (idle) and 1 (too many objects)
96our $LOADAVG; # same thing, but with alpha-smoothing
97our $tick_start; # for load detecting purposes
98
99binmode STDOUT;
100binmode STDERR;
101
102# read virtual server time, if available
103unless ($RUNTIME || !-e "$LOCALDIR/runtime") {
104 open my $fh, "<", "$LOCALDIR/runtime"
105 or die "unable to read runtime file: $!";
106 $RUNTIME = <$fh> + 0.;
107}
108
109mkdir $_
110 for $LOCALDIR, $TMPDIR, $UNIQUEDIR, $PLAYERDIR, $RANDOMDIR, $BDBDIR;
111
112our $EMERGENCY_POSITION;
113
114sub cf::map::normalise;
36 115
37############################################################################# 116#############################################################################
38 117
39=head2 GLOBAL VARIABLES 118=head2 GLOBAL VARIABLES
40 119
41=over 4 120=over 4
42 121
43=item $cf::LIBDIR 122=item $cf::UPTIME
44 123
45The perl library directory, where extensions and cf-specific modules can 124The timestamp of the server start (so not actually an uptime).
46be found. It will be added to C<@INC> automatically. 125
126=item $cf::RUNTIME
127
128The time this server has run, starts at 0 and is increased by $cf::TICK on
129every server tick.
130
131=item $cf::CONFDIR $cf::DATADIR $cf::LIBDIR $cf::PODDIR
132$cf::MAPDIR $cf::LOCALDIR $cf::TMPDIR $cf::UNIQUEDIR
133$cf::PLAYERDIR $cf::RANDOMDIR $cf::BDBDIR
134
135Various directories - "/etc", read-only install directory, perl-library
136directory, pod-directory, read-only maps directory, "/var", "/var/tmp",
137unique-items directory, player file directory, random maps directory and
138database environment.
139
140=item $cf::NOW
141
142The time of the last (current) server tick.
47 143
48=item $cf::TICK 144=item $cf::TICK
49 145
50The interval between server ticks, in seconds. 146The interval between server ticks, in seconds.
147
148=item $cf::LOADAVG
149
150The current CPU load on the server (alpha-smoothed), as a value between 0
151(none) and 1 (overloaded), indicating how much time is spent on processing
152objects per tick. Healthy values are < 0.5.
153
154=item $cf::LOAD
155
156The raw value load value from the last tick.
51 157
52=item %cf::CFG 158=item %cf::CFG
53 159
54Configuration for the server, loaded from C</etc/crossfire/config>, or 160Configuration for the server, loaded from C</etc/crossfire/config>, or
55from wherever your confdir points to. 161from wherever your confdir points to.
162
163=item cf::wait_for_tick, cf::wait_for_tick_begin
164
165These are functions that inhibit the current coroutine one tick. cf::wait_for_tick_begin only
166returns directly I<after> the tick processing (and consequently, can only wake one process
167per tick), while cf::wait_for_tick wakes up all waiters after tick processing.
56 168
57=back 169=back
58 170
59=cut 171=cut
60 172
61BEGIN { 173BEGIN {
62 *CORE::GLOBAL::warn = sub { 174 *CORE::GLOBAL::warn = sub {
63 my $msg = join "", @_; 175 my $msg = join "", @_;
176
64 $msg .= "\n" 177 $msg .= "\n"
65 unless $msg =~ /\n$/; 178 unless $msg =~ /\n$/;
66 179
67 print STDERR "cfperl: $msg"; 180 $msg =~ s/([\x00-\x08\x0b-\x1f])/sprintf "\\x%02x", ord $1/ge;
181
182 utf8::encode $msg;
68 LOG llevError, "cfperl: $msg"; 183 LOG llevError, $msg;
69 }; 184 };
70} 185}
71 186
187@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
188@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
189@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
190@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
191@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
192@safe::cf::arch::ISA = @cf::arch::ISA = 'cf::object';
72@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 193@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; # not really true (yet)
73 194
74# we bless all objects into (empty) derived classes to force a method lookup 195# we bless all objects into (empty) derived classes to force a method lookup
75# within the Safe compartment. 196# within the Safe compartment.
76for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { 197for my $pkg (qw(
198 cf::global cf::attachable
199 cf::object cf::object::player
200 cf::client cf::player
201 cf::arch cf::living
202 cf::map cf::party cf::region
203)) {
77 no strict 'refs'; 204 no strict 'refs';
78 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 205 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
79} 206}
80 207
81$Event::DIED = sub { 208$Event::DIED = sub {
82 warn "error in event callback: @_"; 209 warn "error in event callback: @_";
83}; 210};
84 211
85my %ext_pkg;
86my @exts;
87my @hook;
88my %command;
89my %extcmd;
90
91=head2 UTILITY FUNCTIONS 212=head2 UTILITY FUNCTIONS
92 213
93=over 4 214=over 4
94 215
95=cut 216=item dumpval $ref
96 217
218=cut
219
220sub dumpval {
221 eval {
222 local $SIG{__DIE__};
223 my $d;
224 if (1) {
225 $d = new Data::Dumper([$_[0]], ["*var"]);
226 $d->Terse(1);
227 $d->Indent(2);
228 $d->Quotekeys(0);
229 $d->Useqq(1);
230 #$d->Bless(...);
231 $d->Seen($_[1]) if @_ > 1;
232 $d = $d->Dump();
233 }
234 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
235 $d
236 } || "[unable to dump $_[0]: '$@']";
237}
238
97use JSON::Syck (); # TODO# replace by JSON::PC once working 239use JSON::XS qw(to_json from_json); # TODO# replace by JSON::PC once working
98 240
99=item $ref = cf::from_json $json 241=item $ref = cf::from_json $json
100 242
101Converts a JSON string into the corresponding perl data structure. 243Converts a JSON string into the corresponding perl data structure.
102 244
103=cut
104
105sub from_json($) {
106 $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
107 JSON::Syck::Load $_[0]
108}
109
110=item $json = cf::to_json $ref 245=item $json = cf::to_json $ref
111 246
112Converts a perl data structure into its JSON representation. 247Converts a perl data structure into its JSON representation.
113 248
114=cut 249=item cf::lock_wait $string
115 250
116sub to_json($) { 251Wait until the given lock is available. See cf::lock_acquire.
117 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 252
118 JSON::Syck::Dump $_[0] 253=item my $lock = cf::lock_acquire $string
254
255Wait until the given lock is available and then acquires it and returns
256a Coro::guard object. If the guard object gets destroyed (goes out of scope,
257for example when the coroutine gets canceled), the lock is automatically
258returned.
259
260Lock names should begin with a unique identifier (for example, cf::map::find
261uses map_find and cf::map::load uses map_load).
262
263=item $locked = cf::lock_active $string
264
265Return true if the lock is currently active, i.e. somebody has locked it.
266
267=cut
268
269our %LOCK;
270
271sub lock_wait($) {
272 my ($key) = @_;
273
274 # wait for lock, if any
275 while ($LOCK{$key}) {
276 push @{ $LOCK{$key} }, $Coro::current;
277 Coro::schedule;
278 }
279}
280
281sub lock_acquire($) {
282 my ($key) = @_;
283
284 # wait, to be sure we are not locked
285 lock_wait $key;
286
287 $LOCK{$key} = [];
288
289 Coro::guard {
290 # wake up all waiters, to be on the safe side
291 $_->ready for @{ delete $LOCK{$key} };
292 }
293}
294
295sub lock_active($) {
296 my ($key) = @_;
297
298 ! ! $LOCK{$key}
299}
300
301sub freeze_mainloop {
302 return unless $TICK_WATCHER->is_active;
303
304 my $guard = Coro::guard {
305 $TICK_WATCHER->start;
306 };
307 $TICK_WATCHER->stop;
308 $guard
309}
310
311=item cf::async { BLOCK }
312
313Currently the same as Coro::async_pool, meaning you cannot use
314C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
315thing you are allowed to do is call C<prio> on it.
316
317=cut
318
319BEGIN { *async = \&Coro::async_pool }
320
321=item cf::sync_job { BLOCK }
322
323The design of crossfire+ requires that the main coro ($Coro::main) is
324always able to handle events or runnable, as crossfire+ is only partly
325reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
326
327If it must be done, put the blocking parts into C<sync_job>. This will run
328the given BLOCK in another coroutine while waiting for the result. The
329server will be frozen during this time, so the block should either finish
330fast or be very important.
331
332=cut
333
334sub sync_job(&) {
335 my ($job) = @_;
336
337 if ($Coro::current == $Coro::main) {
338 my $time = Event::time;
339
340 # this is the main coro, too bad, we have to block
341 # till the operation succeeds, freezing the server :/
342
343 # TODO: use suspend/resume instead
344 # (but this is cancel-safe)
345 my $freeze_guard = freeze_mainloop;
346
347 my $busy = 1;
348 my @res;
349
350 (async {
351 @res = eval { $job->() };
352 warn $@ if $@;
353 undef $busy;
354 })->prio (Coro::PRIO_MAX);
355
356 while ($busy) {
357 Coro::cede or Event::one_event;
358 }
359
360 $time = Event::time - $time;
361
362 LOG llevError | logBacktrace, Carp::longmess "long sync job"
363 if $time > $TICK * 0.5 && $TICK_WATCHER->is_active;
364
365 $tick_start += $time; # do not account sync jobs to server load
366
367 wantarray ? @res : $res[0]
368 } else {
369 # we are in another coroutine, how wonderful, everything just works
370
371 $job->()
372 }
373}
374
375=item $coro = cf::async_ext { BLOCK }
376
377Like async, but this coro is automatically being canceled when the
378extension calling this is being unloaded.
379
380=cut
381
382sub async_ext(&) {
383 my $cb = shift;
384
385 my $coro = &Coro::async ($cb);
386
387 $coro->on_destroy (sub {
388 delete $EXT_CORO{$coro+0};
389 });
390 $EXT_CORO{$coro+0} = $coro;
391
392 $coro
393}
394
395sub write_runtime {
396 my $runtime = "$LOCALDIR/runtime";
397
398 # first touch the runtime file to show we are still running:
399 # the fsync below can take a very very long time.
400
401 IO::AIO::aio_utime $runtime, undef, undef;
402
403 my $guard = cf::lock_acquire "write_runtime";
404
405 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
406 or return;
407
408 my $value = $cf::RUNTIME + 90 + 10;
409 # 10 is the runtime save interval, for a monotonic clock
410 # 60 allows for the watchdog to kill the server.
411
412 (aio_write $fh, 0, (length $value), $value, 0) <= 0
413 and return;
414
415 # always fsync - this file is important
416 aio_fsync $fh
417 and return;
418
419 # touch it again to show we are up-to-date
420 aio_utime $fh, undef, undef;
421
422 close $fh
423 or return;
424
425 aio_rename "$runtime~", $runtime
426 and return;
427
428 warn "runtime file written.\n";
429
430 1
431}
432
433=item cf::datalog type => key => value, ...
434
435Log a datalog packet of the given type with the given key-value pairs.
436
437=cut
438
439sub datalog($@) {
440 my ($type, %kv) = @_;
441 warn "DATALOG ", JSON::XS->new->ascii->encode ({ %kv, type => $type });
119} 442}
120 443
121=back 444=back
122 445
123=cut 446=cut
124 447
125############################################################################# 448#############################################################################
126 449
127=head2 EVENTS AND OBJECT ATTACHMENTS 450=head2 ATTACHABLE OBJECTS
451
452Many objects in crossfire are so-called attachable objects. That means you can
453attach callbacks/event handlers (a collection of which is called an "attachment")
454to it. All such attachable objects support the following methods.
455
456In the following description, CLASS can be any of C<global>, C<object>
457C<player>, C<client> or C<map> (i.e. the attachable objects in
458crossfire+).
128 459
129=over 4 460=over 4
130 461
131=item $object->attach ($attachment, key => $value...)
132
133=item $object->detach ($attachment)
134
135Attach/detach a pre-registered attachment to an object.
136
137=item $player->attach ($attachment, key => $value...)
138
139=item $player->detach ($attachment)
140
141Attach/detach a pre-registered attachment to a player.
142
143=item $map->attach ($attachment, key => $value...) 462=item $attachable->attach ($attachment, key => $value...)
144 463
145=item $map->detach ($attachment) 464=item $attachable->detach ($attachment)
146 465
147Attach/detach a pre-registered attachment to a map. 466Attach/detach a pre-registered attachment to a specific object and give it
467the specified key/value pairs as arguments.
148 468
149=item $bool = $object->attached ($name) 469Example, attach a minesweeper attachment to the given object, making it a
47010x10 minesweeper game:
150 471
151=item $bool = $player->attached ($name) 472 $obj->attach (minesweeper => width => 10, height => 10);
152 473
153=item $bool = $map->attached ($name) 474=item $bool = $attachable->attached ($name)
154 475
155Checks wether the named attachment is currently attached to the object. 476Checks wether the named attachment is currently attached to the object.
156 477
157=item cf::attach_global ... 478=item cf::CLASS->attach ...
158 479
159Attach handlers for global events. 480=item cf::CLASS->detach ...
160 481
161This and all following C<attach_*>-functions expect any number of the 482Define an anonymous attachment and attach it to all objects of the given
162following handler/hook descriptions: 483CLASS. See the next function for an explanation of its arguments.
484
485You can attach to global events by using the C<cf::global> class.
486
487Example, log all player logins:
488
489 cf::player->attach (
490 on_login => sub {
491 my ($pl) = @_;
492 ...
493 },
494 );
495
496Example, attach to the jeweler skill:
497
498 cf::object->attach (
499 type => cf::SKILL,
500 subtype => cf::SK_JEWELER,
501 on_use_skill => sub {
502 my ($sk, $ob, $part, $dir, $msg) = @_;
503 ...
504 },
505 );
506
507=item cf::CLASS::attachment $name, ...
508
509Register an attachment by C<$name> through which attachable objects of the
510given CLASS can refer to this attachment.
511
512Some classes such as crossfire maps and objects can specify attachments
513that are attached at load/instantiate time, thus the need for a name.
514
515These calls expect any number of the following handler/hook descriptions:
163 516
164=over 4 517=over 4
165 518
166=item prio => $number 519=item prio => $number
167 520
169by another C<prio> setting). Lower priority handlers get executed 522by another C<prio> setting). Lower priority handlers get executed
170earlier. The default priority is C<0>, and many built-in handlers are 523earlier. The default priority is C<0>, and many built-in handlers are
171registered at priority C<-1000>, so lower priorities should not be used 524registered at priority C<-1000>, so lower priorities should not be used
172unless you know what you are doing. 525unless you know what you are doing.
173 526
527=item type => $type
528
529(Only for C<< cf::object->attach >> calls), limits the attachment to the
530given type of objects only (the additional parameter C<subtype> can be
531used to further limit to the given subtype).
532
174=item on_I<event> => \&cb 533=item on_I<event> => \&cb
175 534
176Call the given code reference whenever the named event happens (event is 535Call the given code reference whenever the named event happens (event is
177something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 536something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
178handlers are recognised generally depends on the type of object these 537handlers are recognised generally depends on the type of object these
187package and register them. Only handlers for eevents supported by the 546package and register them. Only handlers for eevents supported by the
188object/class are recognised. 547object/class are recognised.
189 548
190=back 549=back
191 550
192=item cf::attach_to_type $object_type, $subtype, ... 551Example, define an attachment called "sockpuppet" that calls the given
552event handler when a monster attacks:
193 553
194Attach handlers for a specific object type (e.g. TRANSPORT) and 554 cf::object::attachment sockpuppet =>
195subtype. If C<$subtype> is zero or undef, matches all objects of the given 555 on_skill_attack => sub {
196type. 556 my ($self, $victim) = @_;
197 557 ...
198=item cf::attach_to_objects ...
199
200Attach handlers to all objects. Do not use this except for debugging or
201very rare events, as handlers are (obviously) called for I<all> objects in
202the game.
203
204=item cf::attach_to_players ...
205
206Attach handlers to all players.
207
208=item cf::attach_to_maps ...
209
210Attach handlers to all maps.
211
212=item cf:register_attachment $name, ...
213
214Register an attachment by name through which objects can refer to this
215attachment.
216
217=item cf:register_player_attachment $name, ...
218
219Register an attachment by name through which players can refer to this
220attachment.
221
222=item cf:register_map_attachment $name, ...
223
224Register an attachment by name through which maps can refer to this
225attachment.
226
227=cut
228
229# the following variables are defined in .xs and must not be re-created
230our @CB_GLOBAL = (); # registry for all global events
231our @CB_OBJECT = (); # all objects (should not be used except in emergency)
232our @CB_PLAYER = ();
233our @CB_TYPE = (); # registry for type (cf-object class) based events
234our @CB_MAP = ();
235
236my %attachment;
237
238sub _attach_cb($\%$$$) {
239 my ($registry, $undo, $event, $prio, $cb) = @_;
240
241 use sort 'stable';
242
243 $cb = [$prio, $cb];
244
245 @{$registry->[$event]} = sort
246 { $a->[0] cmp $b->[0] }
247 @{$registry->[$event] || []}, $cb;
248
249 push @{$undo->{cb}}, [$event, $cb];
250}
251
252# attach handles attaching event callbacks
253# the only thing the caller has to do is pass the correct
254# registry (== where the callback attaches to).
255sub _attach(\@$@) {
256 my ($registry, $klass, @arg) = @_;
257
258 my $prio = 0;
259
260 my %undo = (
261 registry => $registry,
262 cb => [],
263 );
264
265 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
266
267 while (@arg) {
268 my $type = shift @arg;
269
270 if ($type eq "prio") {
271 $prio = shift @arg;
272
273 } elsif ($type eq "package") {
274 my $pkg = shift @arg;
275
276 while (my ($name, $id) = each %cb_id) {
277 if (my $cb = $pkg->can ($name)) {
278 _attach_cb $registry, %undo, $id, $prio, $cb;
279 }
280 } 558 }
281
282 } elsif (exists $cb_id{$type}) {
283 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
284
285 } elsif (ref $type) {
286 warn "attaching objects not supported, ignoring.\n";
287
288 } else {
289 shift @arg;
290 warn "attach argument '$type' not supported, ignoring.\n";
291 }
292 }
293
294 \%undo
295}
296
297sub _attach_attachment {
298 my ($obj, $name, %arg) = @_;
299
300 return if exists $obj->{_attachment}{$name};
301
302 my $res;
303
304 if (my $attach = $attachment{$name}) {
305 my $registry = $obj->registry;
306
307 for (@$attach) {
308 my ($klass, @attach) = @$_;
309 $res = _attach @$registry, $klass, @attach;
310 }
311
312 $obj->{$name} = \%arg;
313 } else {
314 warn "object uses attachment '$name' that is not available, postponing.\n";
315 }
316
317 $obj->{_attachment}{$name} = undef;
318
319 $res->{attachment} = $name;
320 $res
321}
322
323*cf::object::attach =
324*cf::player::attach =
325*cf::map::attach = sub {
326 my ($obj, $name, %arg) = @_;
327
328 _attach_attachment $obj, $name, %arg;
329};
330
331# all those should be optimised
332*cf::object::detach =
333*cf::player::detach =
334*cf::map::detach = sub {
335 my ($obj, $name) = @_;
336
337 delete $obj->{_attachment}{$name};
338 reattach ($obj);
339};
340
341*cf::object::attached =
342*cf::player::attached =
343*cf::map::attached = sub {
344 my ($obj, $name) = @_;
345
346 exists $obj->{_attachment}{$name}
347};
348
349sub attach_global {
350 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
351}
352
353sub attach_to_type {
354 my $type = shift;
355 my $subtype = shift;
356
357 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
358}
359
360sub attach_to_objects {
361 _attach @CB_OBJECT, KLASS_OBJECT, @_
362}
363
364sub attach_to_players {
365 _attach @CB_PLAYER, KLASS_PLAYER, @_
366}
367
368sub attach_to_maps {
369 _attach @CB_MAP, KLASS_MAP, @_
370}
371
372sub register_attachment {
373 my $name = shift;
374
375 $attachment{$name} = [[KLASS_OBJECT, @_]];
376}
377
378sub register_player_attachment {
379 my $name = shift;
380
381 $attachment{$name} = [[KLASS_PLAYER, @_]];
382}
383
384sub register_map_attachment {
385 my $name = shift;
386
387 $attachment{$name} = [[KLASS_MAP, @_]];
388}
389
390our $override;
391our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
392
393sub override {
394 $override = 1;
395 @invoke_results = ();
396}
397
398sub do_invoke {
399 my $event = shift;
400 my $callbacks = shift;
401
402 @invoke_results = ();
403
404 local $override;
405
406 for (@$callbacks) {
407 eval { &{$_->[1]} };
408
409 if ($@) {
410 warn "$@";
411 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
412 override;
413 }
414
415 return 1 if $override;
416 }
417
418 0 559 }
419}
420 560
421=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 561=item $attachable->valid
422
423=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
424
425=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
426
427=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
428
429Generate a global/object/player/map-specific event with the given arguments.
430
431This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
432removed in future versions), and there is no public API to access override
433results (if you must, access C<@cf::invoke_results> directly).
434
435=back
436
437=cut
438
439#############################################################################
440
441=head2 METHODS VALID FOR ALL CORE OBJECTS
442
443=over 4
444
445=item $object->valid, $player->valid, $map->valid
446 562
447Just because you have a perl object does not mean that the corresponding 563Just because you have a perl object does not mean that the corresponding
448C-level object still exists. If you try to access an object that has no 564C-level object still exists. If you try to access an object that has no
449valid C counterpart anymore you get an exception at runtime. This method 565valid C counterpart anymore you get an exception at runtime. This method
450can be used to test for existence of the C object part without causing an 566can be used to test for existence of the C object part without causing an
451exception. 567exception.
452 568
569=cut
570
571# the following variables are defined in .xs and must not be re-created
572our @CB_GLOBAL = (); # registry for all global events
573our @CB_ATTACHABLE = (); # registry for all attachables
574our @CB_OBJECT = (); # all objects (should not be used except in emergency)
575our @CB_PLAYER = ();
576our @CB_CLIENT = ();
577our @CB_TYPE = (); # registry for type (cf-object class) based events
578our @CB_MAP = ();
579
580my %attachment;
581
582sub cf::attachable::thawer_merge {
583 # simply override everything except _meta
584 local $_[0]{_meta};
585 %{$_[0]} = %{$_[1]};
586}
587
588sub _attach_cb($$$$) {
589 my ($registry, $event, $prio, $cb) = @_;
590
591 use sort 'stable';
592
593 $cb = [$prio, $cb];
594
595 @{$registry->[$event]} = sort
596 { $a->[0] cmp $b->[0] }
597 @{$registry->[$event] || []}, $cb;
598}
599
600# hack
601my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
602
603# attach handles attaching event callbacks
604# the only thing the caller has to do is pass the correct
605# registry (== where the callback attaches to).
606sub _attach {
607 my ($registry, $klass, @arg) = @_;
608
609 my $object_type;
610 my $prio = 0;
611 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
612
613 #TODO: get rid of this hack
614 if ($attachable_klass{$klass}) {
615 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
616 }
617
618 while (@arg) {
619 my $type = shift @arg;
620
621 if ($type eq "prio") {
622 $prio = shift @arg;
623
624 } elsif ($type eq "type") {
625 $object_type = shift @arg;
626 $registry = $CB_TYPE[$object_type] ||= [];
627
628 } elsif ($type eq "subtype") {
629 defined $object_type or Carp::croak "subtype specified without type";
630 my $object_subtype = shift @arg;
631 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_TYPES] ||= [];
632
633 } elsif ($type eq "package") {
634 my $pkg = shift @arg;
635
636 while (my ($name, $id) = each %cb_id) {
637 if (my $cb = $pkg->can ($name)) {
638 _attach_cb $registry, $id, $prio, $cb;
639 }
640 }
641
642 } elsif (exists $cb_id{$type}) {
643 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
644
645 } elsif (ref $type) {
646 warn "attaching objects not supported, ignoring.\n";
647
648 } else {
649 shift @arg;
650 warn "attach argument '$type' not supported, ignoring.\n";
651 }
652 }
653}
654
655sub _object_attach {
656 my ($obj, $name, %arg) = @_;
657
658 return if exists $obj->{_attachment}{$name};
659
660 if (my $attach = $attachment{$name}) {
661 my $registry = $obj->registry;
662
663 for (@$attach) {
664 my ($klass, @attach) = @$_;
665 _attach $registry, $klass, @attach;
666 }
667
668 $obj->{$name} = \%arg;
669 } else {
670 warn "object uses attachment '$name' that is not available, postponing.\n";
671 }
672
673 $obj->{_attachment}{$name} = undef;
674}
675
676sub cf::attachable::attach {
677 if (ref $_[0]) {
678 _object_attach @_;
679 } else {
680 _attach shift->_attach_registry, @_;
681 }
682 _recalc_want;
683};
684
685# all those should be optimised
686sub cf::attachable::detach {
687 my ($obj, $name) = @_;
688
689 if (ref $obj) {
690 delete $obj->{_attachment}{$name};
691 reattach ($obj);
692 } else {
693 Carp::croak "cannot, currently, detach class attachments";
694 }
695 _recalc_want;
696};
697
698sub cf::attachable::attached {
699 my ($obj, $name) = @_;
700
701 exists $obj->{_attachment}{$name}
702}
703
704for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
705 eval "#line " . __LINE__ . " 'cf.pm'
706 sub cf::\L$klass\E::_attach_registry {
707 (\\\@CB_$klass, KLASS_$klass)
708 }
709
710 sub cf::\L$klass\E::attachment {
711 my \$name = shift;
712
713 \$attachment{\$name} = [[KLASS_$klass, \@_]];
714 }
715 ";
716 die if $@;
717}
718
719our $override;
720our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
721
722sub override {
723 $override = 1;
724 @invoke_results = ();
725}
726
727sub do_invoke {
728 my $event = shift;
729 my $callbacks = shift;
730
731 @invoke_results = ();
732
733 local $override;
734
735 for (@$callbacks) {
736 eval { &{$_->[1]} };
737
738 if ($@) {
739 warn "$@";
740 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
741 override;
742 }
743
744 return 1 if $override;
745 }
746
747 0
748}
749
750=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
751
752=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
753
754Generate an object-specific event with the given arguments.
755
756This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
757removed in future versions), and there is no public API to access override
758results (if you must, access C<@cf::invoke_results> directly).
759
453=back 760=back
454 761
455=cut 762=cut
456
457*cf::object::valid =
458*cf::player::valid =
459*cf::map::valid = \&cf::_valid;
460 763
461############################################################################# 764#############################################################################
462# object support 765# object support
463 766
464sub instantiate {
465 my ($obj, $data) = @_;
466
467 $data = from_json $data;
468
469 for (@$data) {
470 my ($name, $args) = @$_;
471
472 $obj->attach ($name, %{$args || {} });
473 }
474}
475
476# basically do the same as instantiate, without calling instantiate
477sub reattach { 767sub reattach {
768 # basically do the same as instantiate, without calling instantiate
478 my ($obj) = @_; 769 my ($obj) = @_;
770
771 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
772
479 my $registry = $obj->registry; 773 my $registry = $obj->registry;
480 774
481 @$registry = (); 775 @$registry = ();
482 776
483 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 777 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
484 778
485 for my $name (keys %{ $obj->{_attachment} || {} }) { 779 for my $name (keys %{ $obj->{_attachment} || {} }) {
486 if (my $attach = $attachment{$name}) { 780 if (my $attach = $attachment{$name}) {
487 for (@$attach) { 781 for (@$attach) {
488 my ($klass, @attach) = @$_; 782 my ($klass, @attach) = @$_;
489 _attach @$registry, $klass, @attach; 783 _attach $registry, $klass, @attach;
490 } 784 }
491 } else { 785 } else {
492 warn "object uses attachment '$name' that is not available, postponing.\n"; 786 warn "object uses attachment '$name' that is not available, postponing.\n";
493 } 787 }
494 } 788 }
495} 789}
496 790
497sub object_freezer_save { 791cf::attachable->attach (
498 my ($filename, $rdata, $objs) = @_;
499
500 if (length $$rdata) {
501 warn sprintf "saving %s (%d,%d)\n",
502 $filename, length $$rdata, scalar @$objs;
503
504 if (open my $fh, ">:raw", "$filename~") {
505 chmod SAVE_MODE, $fh;
506 syswrite $fh, $$rdata;
507 close $fh;
508
509 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
510 chmod SAVE_MODE, $fh;
511 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
512 close $fh;
513 rename "$filename.pst~", "$filename.pst";
514 } else {
515 unlink "$filename.pst";
516 }
517
518 rename "$filename~", $filename;
519 } else {
520 warn "FATAL: $filename~: $!\n";
521 }
522 } else {
523 unlink $filename;
524 unlink "$filename.pst";
525 }
526}
527
528sub object_freezer_as_string {
529 my ($rdata, $objs) = @_;
530
531 use Data::Dumper;
532
533 $$rdata . Dumper $objs
534}
535
536sub object_thawer_load {
537 my ($filename) = @_;
538
539 local $/;
540
541 my $av;
542
543 #TODO: use sysread etc.
544 if (open my $data, "<:raw:perlio", $filename) {
545 $data = <$data>;
546 if (open my $pst, "<:raw:perlio", "$filename.pst") {
547 $av = eval { (Storable::thaw <$pst>)->{objs} };
548 }
549 return ($data, $av);
550 }
551
552 ()
553}
554
555attach_to_objects
556 prio => -1000000, 792 prio => -1000000,
793 on_instantiate => sub {
794 my ($obj, $data) = @_;
795
796 $data = from_json $data;
797
798 for (@$data) {
799 my ($name, $args) = @$_;
800
801 $obj->attach ($name, %{$args || {} });
802 }
803 },
804 on_reattach => \&reattach,
557 on_clone => sub { 805 on_clone => sub {
558 my ($src, $dst) = @_; 806 my ($src, $dst) = @_;
559 807
560 @{$dst->registry} = @{$src->registry}; 808 @{$dst->registry} = @{$src->registry};
561 809
562 %$dst = %$src; 810 %$dst = %$src;
563 811
564 %{$dst->{_attachment}} = %{$src->{_attachment}} 812 %{$dst->{_attachment}} = %{$src->{_attachment}}
565 if exists $src->{_attachment}; 813 if exists $src->{_attachment};
566 }, 814 },
567; 815);
816
817sub object_freezer_save {
818 my ($filename, $rdata, $objs) = @_;
819
820 sync_job {
821 if (length $$rdata) {
822 warn sprintf "saving %s (%d,%d)\n",
823 $filename, length $$rdata, scalar @$objs;
824
825 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
826 chmod SAVE_MODE, $fh;
827 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
828 aio_fsync $fh if $cf::USE_FSYNC;
829 close $fh;
830
831 if (@$objs) {
832 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
833 chmod SAVE_MODE, $fh;
834 my $data = Storable::nfreeze { version => 1, objs => $objs };
835 aio_write $fh, 0, (length $data), $data, 0;
836 aio_fsync $fh if $cf::USE_FSYNC;
837 close $fh;
838 aio_rename "$filename.pst~", "$filename.pst";
839 }
840 } else {
841 aio_unlink "$filename.pst";
842 }
843
844 aio_rename "$filename~", $filename;
845 } else {
846 warn "FATAL: $filename~: $!\n";
847 }
848 } else {
849 aio_unlink $filename;
850 aio_unlink "$filename.pst";
851 }
852 }
853}
854
855sub object_freezer_as_string {
856 my ($rdata, $objs) = @_;
857
858 use Data::Dumper;
859
860 $$rdata . Dumper $objs
861}
862
863sub object_thawer_load {
864 my ($filename) = @_;
865
866 my ($data, $av);
867
868 (aio_load $filename, $data) >= 0
869 or return;
870
871 unless (aio_stat "$filename.pst") {
872 (aio_load "$filename.pst", $av) >= 0
873 or return;
874 $av = eval { (Storable::thaw $av)->{objs} };
875 }
876
877 warn sprintf "loading %s (%d)\n",
878 $filename, length $data, scalar @{$av || []};
879 return ($data, $av);
880}
568 881
569############################################################################# 882#############################################################################
570# old plug-in events 883# command handling &c
571 884
572sub inject_event { 885=item cf::register_command $name => \&callback($ob,$args);
573 my $extension = shift;
574 my $event_code = shift;
575 886
576 my $cb = $hook[$event_code]{$extension} 887Register a callback for execution when the client sends the user command
577 or return; 888$name.
578 889
579 &$cb 890=cut
580}
581
582sub inject_global_event {
583 my $event = shift;
584
585 my $cb = $hook[$event]
586 or return;
587
588 List::Util::max map &$_, values %$cb
589}
590
591sub inject_command {
592 my ($name, $obj, $params) = @_;
593
594 for my $cmd (@{ $command{$name} }) {
595 $cmd->[1]->($obj, $params);
596 }
597
598 -1
599}
600 891
601sub register_command { 892sub register_command {
602 my ($name, $time, $cb) = @_; 893 my ($name, $cb) = @_;
603 894
604 my $caller = caller; 895 my $caller = caller;
605 #warn "registering command '$name/$time' to '$caller'"; 896 #warn "registering command '$name/$time' to '$caller'";
606 897
607 push @{ $command{$name} }, [$time, $cb, $caller]; 898 push @{ $COMMAND{$name} }, [$caller, $cb];
608 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
609} 899}
900
901=item cf::register_extcmd $name => \&callback($pl,$packet);
902
903Register a callbackf ro execution when the client sends an extcmd packet.
904
905If the callback returns something, it is sent back as if reply was being
906called.
907
908=cut
610 909
611sub register_extcmd { 910sub register_extcmd {
612 my ($name, $cb) = @_; 911 my ($name, $cb) = @_;
613 912
614 my $caller = caller; 913 $EXTCMD{$name} = $cb;
615 #warn "registering extcmd '$name' to '$caller'";
616
617 $extcmd{$name} = [$cb, $caller];
618} 914}
619 915
620sub register { 916cf::player->attach (
621 my ($base, $pkg) = @_; 917 on_command => sub {
918 my ($pl, $name, $params) = @_;
622 919
623 #TODO 920 my $cb = $COMMAND{$name}
624} 921 or return;
625 922
626sub load_extension { 923 for my $cmd (@$cb) {
627 my ($path) = @_; 924 $cmd->[1]->($pl->ob, $params);
628
629 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
630 my $base = $1;
631 my $pkg = $1;
632 $pkg =~ s/[^[:word:]]/_/g;
633 $pkg = "ext::$pkg";
634
635 warn "loading '$path' into '$pkg'\n";
636
637 open my $fh, "<:utf8", $path
638 or die "$path: $!";
639
640 my $source =
641 "package $pkg; use strict; use utf8;\n"
642 . "#line 1 \"$path\"\n{\n"
643 . (do { local $/; <$fh> })
644 . "\n};\n1";
645
646 eval $source
647 or die $@ ? "$path: $@\n"
648 : "extension disabled.\n";
649
650 push @exts, $pkg;
651 $ext_pkg{$base} = $pkg;
652
653# no strict 'refs';
654# @{"$pkg\::ISA"} = ext::;
655
656 register $base, $pkg;
657}
658
659sub unload_extension {
660 my ($pkg) = @_;
661
662 warn "removing extension $pkg\n";
663
664 # remove hooks
665 #TODO
666# for my $idx (0 .. $#PLUGIN_EVENT) {
667# delete $hook[$idx]{$pkg};
668# }
669
670 # remove commands
671 for my $name (keys %command) {
672 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
673
674 if (@cb) {
675 $command{$name} = \@cb;
676 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
677 } else {
678 delete $command{$name};
679 delete $COMMAND{"$name\000"};
680 } 925 }
926
927 cf::override;
681 } 928 },
682
683 # remove extcmds
684 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
685 delete $extcmd{$name};
686 }
687
688 if (my $cb = $pkg->can ("unload")) {
689 eval {
690 $cb->($pkg);
691 1
692 } or warn "$pkg unloaded, but with errors: $@";
693 }
694
695 Symbol::delete_package $pkg;
696}
697
698sub load_extensions {
699 my $LIBDIR = maps_directory "perl";
700
701 for my $ext (<$LIBDIR/*.ext>) {
702 next unless -r $ext;
703 eval {
704 load_extension $ext;
705 1
706 } or warn "$ext not loaded: $@";
707 }
708}
709
710#############################################################################
711# extcmd framework, basically convert ext <msg>
712# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
713
714attach_to_players
715 on_extcmd => sub { 929 on_extcmd => sub {
716 my ($pl, $buf) = @_; 930 my ($pl, $buf) = @_;
717 931
718 my $msg = eval { from_json $buf }; 932 my $msg = eval { from_json $buf };
719 933
720 if (ref $msg) { 934 if (ref $msg) {
721 if (my $cb = $extcmd{$msg->{msgtype}}) { 935 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
722 if (my %reply = $cb->[0]->($pl, $msg)) { 936 if (my %reply = $cb->($pl, $msg)) {
723 $pl->ext_reply ($msg->{msgid}, %reply); 937 $pl->ext_reply ($msg->{msgid}, %reply);
724 } 938 }
725 } 939 }
726 } else { 940 } else {
727 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 941 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
728 } 942 }
729 943
730 cf::override; 944 cf::override;
731 }, 945 },
732; 946);
947
948sub load_extensions {
949 cf::sync_job {
950 my %todo;
951
952 for my $path (<$LIBDIR/*.ext>) {
953 next unless -r $path;
954
955 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
956 my $base = $1;
957 my $pkg = $1;
958 $pkg =~ s/[^[:word:]]/_/g;
959 $pkg = "ext::$pkg";
960
961 open my $fh, "<:utf8", $path
962 or die "$path: $!";
963
964 my $source = do { local $/; <$fh> };
965
966 my %ext = (
967 path => $path,
968 base => $base,
969 pkg => $pkg,
970 );
971
972 $ext{meta} = { map { split /=/, $_, 2 } split /\s+/, $1 }
973 if $source =~ /^#!.*?perl.*?#\s*(.*)$/;
974
975 $ext{source} =
976 "package $pkg; use strict; use utf8;\n"
977 . "#line 1 \"$path\"\n{\n"
978 . $source
979 . "\n};\n1";
980
981 $todo{$base} = \%ext;
982 }
983
984 my %done;
985 while (%todo) {
986 my $progress;
987
988 while (my ($k, $v) = each %todo) {
989 for (split /,\s*/, $ext{meta}{depends}) {
990 goto skip
991 unless exists $done{$_};
992 }
993
994 warn "... loading '$k' into '$v->{pkg}'\n";
995
996 unless (eval $v->{source}) {
997 my $msg = $@ ? "$v->{path}: $@\n"
998 : "extension disabled.\n";
999
1000 if (exists $v->{meta}{mandatory}) {
1001 warn $msg;
1002 warn "mandatory extension failed to load, exiting.\n";
1003 exit 1;
1004 }
1005
1006 die $msg;
1007 }
1008
1009 $done{$k} = delete $todo{$k};
1010 push @EXTS, $v->{pkg};
1011 }
1012
1013 skip:
1014 die "cannot load " . (join ", ", keys %todo) . ": unable to resolve dependencies\n"
1015 unless $progress;
1016 }
1017 };
1018}
733 1019
734############################################################################# 1020#############################################################################
735# load/save/clean perl data associated with a map
736 1021
737*cf::mapsupport::on_clean = sub { 1022=head2 CORE EXTENSIONS
1023
1024Functions and methods that extend core crossfire objects.
1025
1026=cut
1027
1028package cf::player;
1029
1030use Coro::AIO;
1031
1032=head3 cf::player
1033
1034=over 4
1035
1036=item cf::player::find $login
1037
1038Returns the given player object, loading it if necessary (might block).
1039
1040=cut
1041
1042sub playerdir($) {
1043 "$PLAYERDIR/"
1044 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1045}
1046
1047sub path($) {
1048 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1049
1050 (playerdir $login) . "/playerdata"
1051}
1052
1053sub find_active($) {
1054 $cf::PLAYER{$_[0]}
1055 and $cf::PLAYER{$_[0]}->active
1056 and $cf::PLAYER{$_[0]}
1057}
1058
1059sub exists($) {
1060 my ($login) = @_;
1061
1062 $cf::PLAYER{$login}
1063 or cf::sync_job { !aio_stat path $login }
1064}
1065
1066sub find($) {
1067 return $cf::PLAYER{$_[0]} || do {
1068 my $login = $_[0];
1069
1070 my $guard = cf::lock_acquire "user_find:$login";
1071
1072 $cf::PLAYER{$_[0]} || do {
1073 # rename old playerfiles to new ones
1074 #TODO: remove when no longer required
1075 aio_link +(playerdir $login) . "/$login.pl.pst", (playerdir $login) . "/playerdata.pst";
1076 aio_link +(playerdir $login) . "/$login.pl" , (playerdir $login) . "/playerdata";
1077 aio_unlink +(playerdir $login) . "/$login.pl.pst";
1078 aio_unlink +(playerdir $login) . "/$login.pl";
1079
1080 my $pl = load_pl path $login
1081 or return;
1082 $cf::PLAYER{$login} = $pl
1083 }
1084 }
1085}
1086
1087sub save($) {
1088 my ($pl) = @_;
1089
1090 return if $pl->{deny_save};
1091
1092 my $path = path $pl;
1093 my $guard = cf::lock_acquire "user_save:$path";
1094
1095 return if $pl->{deny_save};
1096
1097 aio_mkdir playerdir $pl, 0770;
1098 $pl->{last_save} = $cf::RUNTIME;
1099
1100 $pl->save_pl ($path);
1101 Coro::cede;
1102}
1103
1104sub new($) {
1105 my ($login) = @_;
1106
1107 my $self = create;
1108
1109 $self->ob->name ($login);
1110 $self->{deny_save} = 1;
1111
1112 $cf::PLAYER{$login} = $self;
1113
1114 $self
1115}
1116
1117=item $pl->quit_character
1118
1119Nukes the player without looking back. If logged in, the connection will
1120be destroyed. May block for a long time.
1121
1122=cut
1123
1124sub quit_character {
1125 my ($pl) = @_;
1126
1127 my $name = $pl->ob->name;
1128
1129 $pl->{deny_save} = 1;
1130 $pl->password ("*"); # this should lock out the player until we nuked the dir
1131
1132 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1133 $pl->deactivate;
1134 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1135 $pl->ns->destroy if $pl->ns;
1136
1137 my $path = playerdir $pl;
1138 my $temp = "$path~$cf::RUNTIME~deleting~";
1139 aio_rename $path, $temp;
1140 delete $cf::PLAYER{$pl->ob->name};
1141 $pl->destroy;
1142
1143 my $prefix = qr<^~\Q$name\E/>;
1144
1145 # nuke player maps
1146 $cf::MAP{$_}->nuke for grep /$prefix/, keys %cf::MAP;
1147
1148 IO::AIO::aio_rmtree $temp;
1149}
1150
1151=item $pl->kick
1152
1153Kicks a player out of the game. This destroys the connection.
1154
1155=cut
1156
1157sub kick {
1158 my ($pl, $kicker) = @_;
1159
1160 $pl->invoke (cf::EVENT_PLAYER_KICK, $kicker);
1161 $pl->killer ("kicked");
1162 $pl->ns->destroy;
1163}
1164
1165=item cf::player::list_logins
1166
1167Returns am arrayref of all valid playernames in the system, can take a
1168while and may block, so not sync_job-capable, ever.
1169
1170=cut
1171
1172sub list_logins {
1173 my $dirs = aio_readdir $PLAYERDIR
1174 or return [];
1175
1176 my @logins;
1177
1178 for my $login (@$dirs) {
1179 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1180 aio_read $fh, 0, 512, my $buf, 0 or next;
1181 $buf !~ /^password -------------$/m or next; # official not-valid tag
1182
1183 utf8::decode $login;
1184 push @logins, $login;
1185 }
1186
1187 \@logins
1188}
1189
1190=item $player->maps
1191
1192Returns an arrayref of map paths that are private for this
1193player. May block.
1194
1195=cut
1196
1197sub maps($) {
1198 my ($pl) = @_;
1199
1200 $pl = ref $pl ? $pl->ob->name : $pl;
1201
1202 my $files = aio_readdir playerdir $pl
1203 or return;
1204
1205 my @paths;
1206
1207 for (@$files) {
1208 utf8::decode $_;
1209 next if /\.(?:pl|pst)$/;
1210 next unless /^$PATH_SEP/o;
1211
1212 push @paths, cf::map::normalise "~$pl/$_";
1213 }
1214
1215 \@paths
1216}
1217
1218=item $player->ext_reply ($msgid, %msg)
1219
1220Sends an ext reply to the player.
1221
1222=cut
1223
1224sub ext_reply($$%) {
1225 my ($self, $id, %msg) = @_;
1226
1227 $msg{msgid} = $id;
1228
1229 $self->send ("ext " . cf::to_json \%msg);
1230}
1231
1232=item $player->ext_event ($type, %msg)
1233
1234Sends an ext event to the client.
1235
1236=cut
1237
1238sub ext_event($$%) {
1239 my ($self, $type, %msg) = @_;
1240
1241 $self->ns->ext_event ($type, %msg);
1242}
1243
1244=head3 cf::region
1245
1246=over 4
1247
1248=cut
1249
1250package cf::region;
1251
1252=item cf::region::find_by_path $path
1253
1254Tries to decuce the probable region for a map knowing only its path.
1255
1256=cut
1257
1258sub find_by_path($) {
1259 my ($path) = @_;
1260
1261 my ($match, $specificity);
1262
1263 for my $region (list) {
1264 if ($region->match && $path =~ $region->match) {
1265 ($match, $specificity) = ($region, $region->specificity)
1266 if $region->specificity > $specificity;
1267 }
1268 }
1269
1270 $match
1271}
1272
1273=back
1274
1275=head3 cf::map
1276
1277=over 4
1278
1279=cut
1280
1281package cf::map;
1282
1283use Fcntl;
1284use Coro::AIO;
1285
1286use overload
1287 '""' => \&as_string,
1288 fallback => 1;
1289
1290our $MAX_RESET = 3600;
1291our $DEFAULT_RESET = 3000;
1292
1293sub generate_random_map {
1294 my ($self, $rmp) = @_;
1295 # mit "rum" bekleckern, nicht
1296 $self->_create_random_map (
1297 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1298 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1299 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1300 $rmp->{exit_on_final_map},
1301 $rmp->{xsize}, $rmp->{ysize},
1302 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1303 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1304 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1305 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1306 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1307 (cf::region::find $rmp->{region}), $rmp->{custom}
1308 )
1309}
1310
1311=item cf::map->register ($regex, $prio)
1312
1313Register a handler for the map path matching the given regex at the
1314givne priority (higher is better, built-in handlers have priority 0, the
1315default).
1316
1317=cut
1318
1319sub register {
1320 my (undef, $regex, $prio) = @_;
1321 my $pkg = caller;
1322
1323 no strict;
1324 push @{"$pkg\::ISA"}, __PACKAGE__;
1325
1326 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1327}
1328
1329# also paths starting with '/'
1330$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1331
1332sub thawer_merge {
1333 my ($self, $merge) = @_;
1334
1335 # we have to keep some variables in memory intact
1336 local $self->{path};
1337 local $self->{load_path};
1338
1339 $self->SUPER::thawer_merge ($merge);
1340}
1341
1342sub normalise {
1343 my ($path, $base) = @_;
1344
1345 $path = "$path"; # make sure its a string
1346
1347 $path =~ s/\.map$//;
1348
1349 # map plan:
1350 #
1351 # /! non-realised random map exit (special hack!)
1352 # {... are special paths that are not being touched
1353 # ?xxx/... are special absolute paths
1354 # ?random/... random maps
1355 # /... normal maps
1356 # ~user/... per-player map of a specific user
1357
1358 $path =~ s/$PATH_SEP/\//go;
1359
1360 # treat it as relative path if it starts with
1361 # something that looks reasonable
1362 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1363 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1364
1365 $base =~ s{[^/]+/?$}{};
1366 $path = "$base/$path";
1367 }
1368
1369 for ($path) {
1370 redo if s{//}{/};
1371 redo if s{/\.?/}{/};
1372 redo if s{/[^/]+/\.\./}{/};
1373 }
1374
1375 $path
1376}
1377
1378sub new_from_path {
1379 my (undef, $path, $base) = @_;
1380
1381 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1382
1383 $path = normalise $path, $base;
1384
1385 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1386 if ($path =~ $EXT_MAP{$pkg}[1]) {
1387 my $self = bless cf::map::new, $pkg;
1388 $self->{path} = $path; $self->path ($path);
1389 $self->init; # pass $1 etc.
1390 return $self;
1391 }
1392 }
1393
1394 Carp::carp "unable to resolve path '$path' (base '$base').";
1395 ()
1396}
1397
1398sub init {
1399 my ($self) = @_;
1400
1401 $self
1402}
1403
1404sub as_string {
1405 my ($self) = @_;
1406
1407 "$self->{path}"
1408}
1409
1410# the displayed name, this is a one way mapping
1411sub visible_name {
1412 &as_string
1413}
1414
1415# the original (read-only) location
1416sub load_path {
1417 my ($self) = @_;
1418
1419 "$MAPDIR/$self->{path}.map"
1420}
1421
1422# the temporary/swap location
1423sub save_path {
1424 my ($self) = @_;
1425
1426 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1427 "$TMPDIR/$path.map"
1428}
1429
1430# the unique path, undef == no special unique path
1431sub uniq_path {
1432 my ($self) = @_;
1433
1434 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1435 "$UNIQUEDIR/$path"
1436}
1437
1438# and all this just because we cannot iterate over
1439# all maps in C++...
1440sub change_all_map_light {
1441 my ($change) = @_;
1442
1443 $_->change_map_light ($change)
1444 for grep $_->outdoor, values %cf::MAP;
1445}
1446
1447sub decay_objects {
1448 my ($self) = @_;
1449
1450 return if $self->{deny_reset};
1451
1452 $self->do_decay_objects;
1453}
1454
1455sub unlink_save {
1456 my ($self) = @_;
1457
1458 utf8::encode (my $save = $self->save_path);
1459 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1460 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1461}
1462
1463sub load_header_from($) {
1464 my ($self, $path) = @_;
1465
1466 utf8::encode $path;
1467 #aio_open $path, O_RDONLY, 0
1468 # or return;
1469
1470 $self->_load_header ($path)
1471 or return;
1472
1473 $self->{load_path} = $path;
1474
1475 1
1476}
1477
1478sub load_header_orig {
1479 my ($self) = @_;
1480
1481 $self->load_header_from ($self->load_path)
1482}
1483
1484sub load_header_temp {
1485 my ($self) = @_;
1486
1487 $self->load_header_from ($self->save_path)
1488}
1489
1490sub prepare_temp {
1491 my ($self) = @_;
1492
1493 $self->last_access ((delete $self->{last_access})
1494 || $cf::RUNTIME); #d#
1495 # safety
1496 $self->{instantiate_time} = $cf::RUNTIME
1497 if $self->{instantiate_time} > $cf::RUNTIME;
1498}
1499
1500sub prepare_orig {
1501 my ($self) = @_;
1502
1503 $self->{load_original} = 1;
1504 $self->{instantiate_time} = $cf::RUNTIME;
1505 $self->last_access ($cf::RUNTIME);
1506 $self->instantiate;
1507}
1508
1509sub load_header {
1510 my ($self) = @_;
1511
1512 if ($self->load_header_temp) {
1513 $self->prepare_temp;
1514 } else {
1515 $self->load_header_orig
1516 or return;
1517 $self->prepare_orig;
1518 }
1519
1520 $self->{deny_reset} = 1
1521 if $self->no_reset;
1522
1523 $self->default_region (cf::region::find_by_path $self->{path})
1524 unless $self->default_region;
1525
1526 1
1527}
1528
1529sub find;
1530sub find {
1531 my ($path, $origin) = @_;
1532
1533 $path = normalise $path, $origin && $origin->path;
1534
1535 cf::lock_wait "map_find:$path";
1536
1537 $cf::MAP{$path} || do {
1538 my $guard = cf::lock_acquire "map_find:$path";
1539 my $map = new_from_path cf::map $path
1540 or return;
1541
1542 $map->{last_save} = $cf::RUNTIME;
1543
1544 $map->load_header
1545 or return;
1546
1547 if ($map->should_reset) {#d#TODO# disabled, crashy (locking issue?)
1548 # doing this can freeze the server in a sync job, obviously
1549 #$cf::WAIT_FOR_TICK->wait;
1550 $map->reset;
1551 undef $guard;
1552 return find $path;
1553 }
1554
1555 $cf::MAP{$path} = $map
1556 }
1557}
1558
1559sub pre_load { }
1560sub post_load { }
1561
1562sub load {
1563 my ($self) = @_;
1564
1565 local $self->{deny_reset} = 1; # loading can take a long time
1566
1567 my $path = $self->{path};
1568
1569 {
1570 my $guard = cf::lock_acquire "map_load:$path";
1571
1572 return if $self->in_memory != cf::MAP_SWAPPED;
1573
1574 $self->in_memory (cf::MAP_LOADING);
1575
1576 $self->alloc;
1577
1578 $self->pre_load;
1579 Coro::cede;
1580
1581 $self->_load_objects ($self->{load_path}, 1)
1582 or return;
1583
1584 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1585 if delete $self->{load_original};
1586
1587 if (my $uniq = $self->uniq_path) {
1588 utf8::encode $uniq;
1589 if (aio_open $uniq, O_RDONLY, 0) {
1590 $self->clear_unique_items;
1591 $self->_load_objects ($uniq, 0);
1592 }
1593 }
1594
1595 Coro::cede;
1596 # now do the right thing for maps
1597 $self->link_multipart_objects;
1598 $self->difficulty ($self->estimate_difficulty)
1599 unless $self->difficulty;
1600 Coro::cede;
1601
1602 unless ($self->{deny_activate}) {
1603 $self->decay_objects;
1604 $self->fix_auto_apply;
1605 $self->update_buttons;
1606 Coro::cede;
1607 $self->set_darkness_map;
1608 Coro::cede;
1609 $self->activate;
1610 }
1611
1612 $self->in_memory (cf::MAP_IN_MEMORY);
1613 }
1614
1615 $self->post_load;
1616}
1617
1618sub customise_for {
1619 my ($self, $ob) = @_;
1620
1621 return find "~" . $ob->name . "/" . $self->{path}
1622 if $self->per_player;
1623
1624# return find "?party/" . $ob->name . "/" . $self->{path}
1625# if $self->per_party;
1626
1627 $self
1628}
1629
1630# find and load all maps in the 3x3 area around a map
1631sub load_diag {
738 my ($map) = @_; 1632 my ($map) = @_;
739 1633
740 my $path = $map->tmpname; 1634 my @diag; # diagonal neighbours
741 defined $path or return;
742 1635
743 unlink "$path.pst"; 1636 for (0 .. 3) {
744}; 1637 my $neigh = $map->tile_path ($_)
1638 or next;
1639 $neigh = find $neigh, $map
1640 or next;
1641 $neigh->load;
745 1642
746attach_to_maps prio => -10000, package => cf::mapsupport::; 1643 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1644 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1645 }
747 1646
748############################################################################# 1647 for (@diag) {
749# load/save perl data associated with player->ob objects 1648 my $neigh = find @$_
750 1649 or next;
751sub all_objects(@) { 1650 $neigh->load;
752 @_, map all_objects ($_->inv), @_ 1651 }
753} 1652}
754 1653
755# TODO: compatibility cruft, remove when no longer needed 1654sub find_sync {
756attach_to_players 1655 my ($path, $origin) = @_;
757 on_load => sub {
758 my ($pl, $path) = @_;
759 1656
760 for my $o (all_objects $pl->ob) { 1657 cf::sync_job { find $path, $origin }
761 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1658}
762 $o->set_ob_key_value ("_perl_data");
763 1659
764 %$o = %{ Storable::thaw pack "H*", $value }; 1660sub do_load_sync {
1661 my ($map) = @_;
1662
1663 cf::sync_job { $map->load };
1664}
1665
1666our %MAP_PREFETCH;
1667our $MAP_PREFETCHER = undef;
1668
1669sub find_async {
1670 my ($path, $origin) = @_;
1671
1672 $path = normalise $path, $origin && $origin->{path};
1673
1674 if (my $map = $cf::MAP{$path}) {
1675 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1676 }
1677
1678 undef $MAP_PREFETCH{$path};
1679 $MAP_PREFETCHER ||= cf::async {
1680 while (%MAP_PREFETCH) {
1681 for my $path (keys %MAP_PREFETCH) {
1682 my $map = find $path
1683 or next;
1684 $map->load;
1685
1686 delete $MAP_PREFETCH{$path};
765 } 1687 }
766 } 1688 }
1689 undef $MAP_PREFETCHER;
1690 };
1691 $MAP_PREFETCHER->prio (6);
1692
1693 ()
1694}
1695
1696sub save {
1697 my ($self) = @_;
1698
1699 my $lock = cf::lock_acquire "map_data:" . $self->path;
1700
1701 $self->{last_save} = $cf::RUNTIME;
1702
1703 return unless $self->dirty;
1704
1705 my $save = $self->save_path; utf8::encode $save;
1706 my $uniq = $self->uniq_path; utf8::encode $uniq;
1707
1708 $self->{load_path} = $save;
1709
1710 return if $self->{deny_save};
1711
1712 local $self->{last_access} = $self->last_access;#d#
1713
1714 cf::async {
1715 $_->contr->save for $self->players;
1716 };
1717
1718 if ($uniq) {
1719 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1720 $self->_save_objects ($uniq, cf::IO_UNIQUES);
1721 } else {
1722 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
767 }, 1723 }
768; 1724}
769 1725
770############################################################################# 1726sub swap_out {
1727 my ($self) = @_;
771 1728
772=head2 CORE EXTENSIONS 1729 # save first because save cedes
1730 $self->save;
773 1731
774Functions and methods that extend core crossfire objects. 1732 my $lock = cf::lock_acquire "map_data:" . $self->path;
1733
1734 return if $self->players;
1735 return if $self->in_memory != cf::MAP_IN_MEMORY;
1736 return if $self->{deny_save};
1737
1738 $self->clear;
1739 $self->in_memory (cf::MAP_SWAPPED);
1740}
1741
1742sub reset_at {
1743 my ($self) = @_;
1744
1745 # TODO: safety, remove and allow resettable per-player maps
1746 return 1e99 if $self->{deny_reset};
1747
1748 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1749 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1750
1751 $time + $to
1752}
1753
1754sub should_reset {
1755 my ($self) = @_;
1756
1757 $self->reset_at <= $cf::RUNTIME
1758}
1759
1760sub reset {
1761 my ($self) = @_;
1762
1763 my $lock = cf::lock_acquire "map_data:$self->{path}";
1764
1765 return if $self->players;
1766
1767 warn "resetting map ", $self->path;
1768
1769 $self->in_memory (cf::MAP_SWAPPED);
1770
1771 # need to save uniques path
1772 unless ($self->{deny_save}) {
1773 my $uniq = $self->uniq_path; utf8::encode $uniq;
1774
1775 $self->_save_objects ($uniq, cf::IO_UNIQUES)
1776 if $uniq;
1777 }
1778
1779 delete $cf::MAP{$self->path};
1780
1781 $self->clear;
1782
1783 $_->clear_links_to ($self) for values %cf::MAP;
1784
1785 $self->unlink_save;
1786 $self->destroy;
1787}
1788
1789my $nuke_counter = "aaaa";
1790
1791sub nuke {
1792 my ($self) = @_;
1793
1794 delete $cf::MAP{$self->path};
1795
1796 $self->unlink_save;
1797
1798 bless $self, "cf::map";
1799 delete $self->{deny_reset};
1800 $self->{deny_save} = 1;
1801 $self->reset_timeout (1);
1802 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1803
1804 $cf::MAP{$self->path} = $self;
1805
1806 $self->reset; # polite request, might not happen
1807}
1808
1809=item $maps = cf::map::tmp_maps
1810
1811Returns an arrayref with all map paths of currently instantiated and saved
1812maps. May block.
1813
1814=cut
1815
1816sub tmp_maps() {
1817 [
1818 map {
1819 utf8::decode $_;
1820 /\.map$/
1821 ? normalise $_
1822 : ()
1823 } @{ aio_readdir $TMPDIR or [] }
1824 ]
1825}
1826
1827=item $maps = cf::map::random_maps
1828
1829Returns an arrayref with all map paths of currently instantiated and saved
1830random maps. May block.
1831
1832=cut
1833
1834sub random_maps() {
1835 [
1836 map {
1837 utf8::decode $_;
1838 /\.map$/
1839 ? normalise "?random/$_"
1840 : ()
1841 } @{ aio_readdir $RANDOMDIR or [] }
1842 ]
1843}
1844
1845=item cf::map::unique_maps
1846
1847Returns an arrayref of paths of all shared maps that have
1848instantiated unique items. May block.
1849
1850=cut
1851
1852sub unique_maps() {
1853 [
1854 map {
1855 utf8::decode $_;
1856 /\.map$/
1857 ? normalise $_
1858 : ()
1859 } @{ aio_readdir $UNIQUEDIR or [] }
1860 ]
1861}
1862
1863package cf;
1864
1865=back
1866
1867=head3 cf::object
1868
1869=cut
1870
1871package cf::object;
775 1872
776=over 4 1873=over 4
777 1874
778=item cf::player::exists $login 1875=item $ob->inv_recursive
779 1876
780Returns true when the given account exists. 1877Returns the inventory of the object _and_ their inventories, recursively.
781 1878
782=cut 1879=cut
783 1880
784sub cf::player::exists($) { 1881sub inv_recursive_;
785 cf::player::find $_[0] 1882sub inv_recursive_ {
786 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1883 map { $_, inv_recursive_ $_->inv } @_
787} 1884}
1885
1886sub inv_recursive {
1887 inv_recursive_ inv $_[0]
1888}
1889
1890package cf;
1891
1892=back
1893
1894=head3 cf::object::player
1895
1896=over 4
788 1897
789=item $player_object->reply ($npc, $msg[, $flags]) 1898=item $player_object->reply ($npc, $msg[, $flags])
790 1899
791Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1900Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
792can be C<undef>. Does the right thing when the player is currently in a 1901can be C<undef>. Does the right thing when the player is currently in a
794 1903
795=cut 1904=cut
796 1905
797# rough implementation of a future "reply" method that works 1906# rough implementation of a future "reply" method that works
798# with dialog boxes. 1907# with dialog boxes.
1908#TODO: the first argument must go, split into a $npc->reply_to ( method
799sub cf::object::player::reply($$$;$) { 1909sub cf::object::player::reply($$$;$) {
800 my ($self, $npc, $msg, $flags) = @_; 1910 my ($self, $npc, $msg, $flags) = @_;
801 1911
802 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1912 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
803 1913
807 $msg = $npc->name . " says: $msg" if $npc; 1917 $msg = $npc->name . " says: $msg" if $npc;
808 $self->message ($msg, $flags); 1918 $self->message ($msg, $flags);
809 } 1919 }
810} 1920}
811 1921
812=item $player->ext_reply ($msgid, $msgtype, %msg)
813
814Sends an ext reply to the player.
815
816=cut
817
818sub cf::player::ext_reply($$$%) {
819 my ($self, $id, %msg) = @_;
820
821 $msg{msgid} = $id;
822
823 $self->send ("ext " . to_json \%msg);
824}
825
826=item $player_object->may ("access") 1922=item $player_object->may ("access")
827 1923
828Returns wether the given player is authorized to access resource "access" 1924Returns wether the given player is authorized to access resource "access"
829(e.g. "command_wizcast"). 1925(e.g. "command_wizcast").
830 1926
837 (ref $cf::CFG{"may_$access"} 1933 (ref $cf::CFG{"may_$access"}
838 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1934 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839 : $cf::CFG{"may_$access"}) 1935 : $cf::CFG{"may_$access"})
840} 1936}
841 1937
842=cut 1938=item $player_object->enter_link
843 1939
844############################################################################# 1940Freezes the player and moves him/her to a special map (C<{link}>).
1941
1942The player should be reasonably safe there for short amounts of time. You
1943I<MUST> call C<leave_link> as soon as possible, though.
1944
1945Will never block.
1946
1947=item $player_object->leave_link ($map, $x, $y)
1948
1949Moves the player out of the special C<{link}> map onto the specified
1950map. If the map is not valid (or omitted), the player will be moved back
1951to the location he/she was before the call to C<enter_link>, or, if that
1952fails, to the emergency map position.
1953
1954Might block.
1955
1956=cut
1957
1958sub link_map {
1959 unless ($LINK_MAP) {
1960 $LINK_MAP = cf::map::find "{link}"
1961 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1962 $LINK_MAP->load;
1963 }
1964
1965 $LINK_MAP
1966}
1967
1968sub cf::object::player::enter_link {
1969 my ($self) = @_;
1970
1971 $self->deactivate_recursive;
1972
1973 return if UNIVERSAL::isa $self->map, "ext::map_link";
1974
1975 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1976 if $self->map && $self->map->{path} ne "{link}";
1977
1978 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1979}
1980
1981sub cf::object::player::leave_link {
1982 my ($self, $map, $x, $y) = @_;
1983
1984 return unless $self->contr->active;
1985
1986 my $link_pos = delete $self->{_link_pos};
1987
1988 unless ($map) {
1989 # restore original map position
1990 ($map, $x, $y) = @{ $link_pos || [] };
1991 $map = cf::map::find $map;
1992
1993 unless ($map) {
1994 ($map, $x, $y) = @$EMERGENCY_POSITION;
1995 $map = cf::map::find $map
1996 or die "FATAL: cannot load emergency map\n";
1997 }
1998 }
1999
2000 ($x, $y) = (-1, -1)
2001 unless (defined $x) && (defined $y);
2002
2003 # use -1 or undef as default coordinates, not 0, 0
2004 ($x, $y) = ($map->enter_x, $map->enter_y)
2005 if $x <=0 && $y <= 0;
2006
2007 $map->load;
2008 $map->load_diag;
2009
2010 return unless $self->contr->active;
2011 $self->activate_recursive;
2012
2013 local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext
2014 $self->enter_map ($map, $x, $y);
2015}
2016
2017=item $player_object->goto ($path, $x, $y[, $check->($map)])
2018
2019Moves the player to the given map-path and coordinates by first freezing
2020her, loading and preparing them map, calling the provided $check callback
2021that has to return the map if sucecssful, and then unfreezes the player on
2022the new (success) or old (failed) map position.
2023
2024=cut
2025
2026our $GOTOGEN;
2027
2028sub cf::object::player::goto {
2029 my ($self, $path, $x, $y, $check) = @_;
2030
2031 # do generation counting so two concurrent goto's will be executed in-order
2032 my $gen = $self->{_goto_generation} = ++$GOTOGEN;
2033
2034 $self->enter_link;
2035
2036 (async {
2037 my $map = eval {
2038 my $map = cf::map::find $path;
2039
2040 if ($map) {
2041 $map = $map->customise_for ($self);
2042 $map = $check->($map) if $check && $map;
2043 } else {
2044 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
2045 }
2046
2047 $map
2048 };
2049
2050 if ($@) {
2051 $self->message ("Something went wrong within the server, please report this incident!", cf::NDI_UNIQUE | cf::NDI_RED);
2052 LOG llevError | logBacktrace, Carp::longmess $@;
2053 }
2054
2055 if ($gen == $self->{_goto_generation}) {
2056 delete $self->{_goto_generation};
2057 $self->leave_link ($map, $x, $y);
2058 }
2059 })->prio (1);
2060}
2061
2062=item $player_object->enter_exit ($exit_object)
2063
2064=cut
2065
2066sub parse_random_map_params {
2067 my ($spec) = @_;
2068
2069 my $rmp = { # defaults
2070 xsize => (cf::rndm 15, 40),
2071 ysize => (cf::rndm 15, 40),
2072 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
2073 #layout => string,
2074 };
2075
2076 for (split /\n/, $spec) {
2077 my ($k, $v) = split /\s+/, $_, 2;
2078
2079 $rmp->{lc $k} = $v if (length $k) && (length $v);
2080 }
2081
2082 $rmp
2083}
2084
2085sub prepare_random_map {
2086 my ($exit) = @_;
2087
2088 my $guard = cf::lock_acquire "exit_prepare:$exit";
2089
2090 # all this does is basically replace the /! path by
2091 # a new random map path (?random/...) with a seed
2092 # that depends on the exit object
2093
2094 my $rmp = parse_random_map_params $exit->msg;
2095
2096 if ($exit->map) {
2097 $rmp->{region} = $exit->region->name;
2098 $rmp->{origin_map} = $exit->map->path;
2099 $rmp->{origin_x} = $exit->x;
2100 $rmp->{origin_y} = $exit->y;
2101 }
2102
2103 $rmp->{random_seed} ||= $exit->random_seed;
2104
2105 my $data = cf::to_json $rmp;
2106 my $md5 = Digest::MD5::md5_hex $data;
2107 my $meta = "$RANDOMDIR/$md5.meta";
2108
2109 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
2110 aio_write $fh, 0, (length $data), $data, 0;
2111 undef $fh;
2112 aio_rename "$meta~", $meta;
2113
2114 $exit->slaying ("?random/$md5");
2115 $exit->msg (undef);
2116 }
2117}
2118
2119sub cf::object::player::enter_exit {
2120 my ($self, $exit) = @_;
2121
2122 return unless $self->type == cf::PLAYER;
2123
2124 if ($exit->slaying eq "/!") {
2125 #TODO: this should de-fi-ni-te-ly not be a sync-job
2126 # the problem is that $exit might not survive long enough
2127 # so it needs to be done right now, right here
2128 cf::sync_job { prepare_random_map $exit };
2129 }
2130
2131 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
2132 my $hp = $exit->stats->hp;
2133 my $sp = $exit->stats->sp;
2134
2135 $self->enter_link;
2136
2137 (async {
2138 $self->deactivate_recursive; # just to be sure
2139 unless (eval {
2140 $self->goto ($slaying, $hp, $sp);
2141
2142 1;
2143 }) {
2144 $self->message ("Something went wrong deep within the crossfire server. "
2145 . "I'll try to bring you back to the map you were before. "
2146 . "Please report this to the dungeon master!",
2147 cf::NDI_UNIQUE | cf::NDI_RED);
2148
2149 warn "ERROR in enter_exit: $@";
2150 $self->leave_link;
2151 }
2152 })->prio (1);
2153}
2154
2155=head3 cf::client
2156
2157=over 4
2158
2159=item $client->send_drawinfo ($text, $flags)
2160
2161Sends a drawinfo packet to the client. Circumvents output buffering so
2162should not be used under normal circumstances.
2163
2164=cut
2165
2166sub cf::client::send_drawinfo {
2167 my ($self, $text, $flags) = @_;
2168
2169 utf8::encode $text;
2170 $self->send_packet (sprintf "drawinfo %d %s", $flags || cf::NDI_BLACK, $text);
2171}
2172
2173=item $client->ext_event ($type, %msg)
2174
2175Sends an exti event to the client.
2176
2177=cut
2178
2179sub cf::client::ext_event($$%) {
2180 my ($self, $type, %msg) = @_;
2181
2182 $msg{msgtype} = "event_$type";
2183 $self->send_packet ("ext " . cf::to_json \%msg);
2184}
2185
2186=item $success = $client->query ($flags, "text", \&cb)
2187
2188Queues a query to the client, calling the given callback with
2189the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
2190C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
2191
2192Queries can fail, so check the return code. Or don't, as queries will become
2193reliable at some point in the future.
2194
2195=cut
2196
2197sub cf::client::query {
2198 my ($self, $flags, $text, $cb) = @_;
2199
2200 return unless $self->state == ST_PLAYING
2201 || $self->state == ST_SETUP
2202 || $self->state == ST_CUSTOM;
2203
2204 $self->state (ST_CUSTOM);
2205
2206 utf8::encode $text;
2207 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
2208
2209 $self->send_packet ($self->{query_queue}[0][0])
2210 if @{ $self->{query_queue} } == 1;
2211}
2212
2213cf::client->attach (
2214 on_reply => sub {
2215 my ($ns, $msg) = @_;
2216
2217 # this weird shuffling is so that direct followup queries
2218 # get handled first
2219 my $queue = delete $ns->{query_queue}
2220 or return; # be conservative, not sure how that can happen, but we saw a crash here
2221
2222 (shift @$queue)->[1]->($msg);
2223 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2224
2225 push @{ $ns->{query_queue} }, @$queue;
2226
2227 if (@{ $ns->{query_queue} } == @$queue) {
2228 if (@$queue) {
2229 $ns->send_packet ($ns->{query_queue}[0][0]);
2230 } else {
2231 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2232 }
2233 }
2234 },
2235);
2236
2237=item $client->async (\&cb)
2238
2239Create a new coroutine, running the specified callback. The coroutine will
2240be automatically cancelled when the client gets destroyed (e.g. on logout,
2241or loss of connection).
2242
2243=cut
2244
2245sub cf::client::async {
2246 my ($self, $cb) = @_;
2247
2248 my $coro = &Coro::async ($cb);
2249
2250 $coro->on_destroy (sub {
2251 delete $self->{_coro}{$coro+0};
2252 });
2253
2254 $self->{_coro}{$coro+0} = $coro;
2255
2256 $coro
2257}
2258
2259cf::client->attach (
2260 on_destroy => sub {
2261 my ($ns) = @_;
2262
2263 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2264 },
2265);
2266
2267=back
2268
845 2269
846=head2 SAFE SCRIPTING 2270=head2 SAFE SCRIPTING
847 2271
848Functions that provide a safe environment to compile and execute 2272Functions that provide a safe environment to compile and execute
849snippets of perl code without them endangering the safety of the server 2273snippets of perl code without them endangering the safety of the server
862 2286
863# here we export the classes and methods available to script code 2287# here we export the classes and methods available to script code
864 2288
865=pod 2289=pod
866 2290
867The following fucntions and emthods are available within a safe environment: 2291The following functions and methods are available within a safe environment:
868 2292
869 cf::object contr pay_amount pay_player 2293 cf::object contr pay_amount pay_player map
870 cf::object::player player 2294 cf::object::player player
871 cf::player peaceful 2295 cf::player peaceful
2296 cf::map trigger
872 2297
873=cut 2298=cut
874 2299
875for ( 2300for (
876 ["cf::object" => qw(contr pay_amount pay_player)], 2301 ["cf::object" => qw(contr pay_amount pay_player map)],
877 ["cf::object::player" => qw(player)], 2302 ["cf::object::player" => qw(player)],
878 ["cf::player" => qw(peaceful)], 2303 ["cf::player" => qw(peaceful)],
2304 ["cf::map" => qw(trigger)],
879) { 2305) {
880 no strict 'refs'; 2306 no strict 'refs';
881 my ($pkg, @funs) = @$_; 2307 my ($pkg, @funs) = @$_;
882 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2308 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883 for @funs; 2309 for @funs;
955############################################################################# 2381#############################################################################
956 2382
957=head2 EXTENSION DATABASE SUPPORT 2383=head2 EXTENSION DATABASE SUPPORT
958 2384
959Crossfire maintains a very simple database for extension use. It can 2385Crossfire maintains a very simple database for extension use. It can
960currently store anything that can be serialised using Storable, which 2386currently store binary data only (use Compress::LZF::sfreeze_cr/sthaw to
961excludes objects. 2387convert to/from binary).
962 2388
963The parameter C<$family> should best start with the name of the extension 2389The parameter C<$family> should best start with the name of the extension
964using it, it should be unique. 2390using it, it should be unique.
965 2391
966=over 4 2392=over 4
967 2393
968=item $hashref = cf::db_get $family
969
970Return a hashref for use by the extension C<$family>, which can be
971modified. After modifications, you have to call C<cf::db_dirty> or
972C<cf::db_sync>.
973
974=item $value = cf::db_get $family => $key 2394=item $value = cf::db_get $family => $key
975 2395
976Returns a single value from the database 2396Returns a single value from the database.
977
978=item cf::db_put $family => $hashref
979
980Stores the given family hashref into the database. Updates are delayed, if
981you want the data to be synced to disk immediately, use C<cf::db_sync>.
982 2397
983=item cf::db_put $family => $key => $value 2398=item cf::db_put $family => $key => $value
984 2399
985Stores the given C<$value> in the family hash. Updates are delayed, if you 2400Stores the given C<$value> in the family.
986want the data to be synced to disk immediately, use C<cf::db_sync>.
987
988=item cf::db_dirty
989
990Marks the database as dirty, to be updated at a later time.
991
992=item cf::db_sync
993
994Immediately write the database to disk I<if it is dirty>.
995 2401
996=cut 2402=cut
997 2403
998our $DB; 2404our $DB;
999 2405
1000{ 2406sub db_init {
1001 my $path = cf::localdir . "/database.pst"; 2407 unless ($DB) {
2408 $DB = BDB::db_create $DB_ENV;
1002 2409
1003 sub db_load() { 2410 cf::sync_job {
1004 warn "loading database $path\n";#d# remove later 2411 eval {
1005 $DB = stat $path ? Storable::retrieve $path : { }; 2412 $DB->set_flags (BDB::CHKSUM);
1006 }
1007 2413
1008 my $pid; 2414 BDB::db_open $DB, undef, "db", undef, BDB::BTREE,
1009 2415 BDB::CREATE | BDB::AUTO_COMMIT, 0666;
1010 sub db_save() { 2416 cf::cleanup "db_open(db): $!" if $!;
1011 warn "saving database $path\n";#d# remove later 2417 };
1012 waitpid $pid, 0 if $pid; 2418 cf::cleanup "db_open(db): $@" if $@;
1013 if (0 == ($pid = fork)) {
1014 $DB->{_meta}{version} = 1;
1015 Storable::nstore $DB, "$path~";
1016 rename "$path~", $path;
1017 cf::_exit 0 if defined $pid;
1018 } 2419 };
1019 }
1020
1021 my $dirty;
1022
1023 sub db_sync() {
1024 db_save if $dirty;
1025 undef $dirty;
1026 }
1027
1028 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {
1029 db_sync;
1030 }); 2420 }
2421}
1031 2422
1032 sub db_dirty() {
1033 $dirty = 1;
1034 $idle->start;
1035 }
1036
1037 sub db_get($;$) { 2423sub db_get($$) {
1038 @_ >= 2 2424 my $key = "$_[0]/$_[1]";
1039 ? $DB->{$_[0]}{$_[1]}
1040 : ($DB->{$_[0]} ||= { })
1041 }
1042 2425
2426 cf::sync_job {
2427 BDB::db_get $DB, undef, $key, my $data;
2428
2429 $! ? ()
2430 : $data
2431 }
2432}
2433
1043 sub db_put($$;$) { 2434sub db_put($$$) {
1044 if (@_ >= 3) { 2435 BDB::dbreq_pri 4;
1045 $DB->{$_[0]}{$_[1]} = $_[2]; 2436 BDB::db_put $DB, undef, "$_[0]/$_[1]", $_[2], 0, sub { };
1046 } else { 2437}
1047 $DB->{$_[0]} = $_[1];
1048 }
1049 db_dirty;
1050 }
1051 2438
1052 attach_global 2439=item cf::cache $id => [$paths...], $processversion => $process
1053 prio => 10000, 2440
1054 on_cleanup => sub { 2441Generic caching function that returns the value of the resource $id,
1055 db_sync; 2442caching and regenerating as required.
2443
2444This function can block.
2445
2446=cut
2447
2448sub cache {
2449 my ($id, $src, $processversion, $process) = @_;
2450
2451 my $meta =
2452 join "\x00",
2453 $processversion,
2454 map {
2455 aio_stat $_
2456 and Carp::croak "$_: $!";
2457
2458 ($_, (stat _)[7,9])
2459 } @$src;
2460
2461 my $dbmeta = db_get cache => "$id/meta";
2462 if ($dbmeta ne $meta) {
2463 # changed, we may need to process
2464
2465 my @data;
2466 my $md5;
2467
2468 for (0 .. $#$src) {
2469 0 <= aio_load $src->[$_], $data[$_]
2470 or Carp::croak "$src->[$_]: $!";
1056 }, 2471 }
2472
2473 # if processing is expensive, check
2474 # checksum first
2475 if (1) {
2476 $md5 =
2477 join "\x00",
2478 $processversion,
2479 map {
2480 Coro::cede;
2481 ($src->[$_], Digest::MD5::md5_hex $data[$_])
2482 } 0.. $#$src;
2483
2484
2485 my $dbmd5 = db_get cache => "$id/md5";
2486 if ($dbmd5 eq $md5) {
2487 db_put cache => "$id/meta", $meta;
2488
2489 return db_get cache => "$id/data";
2490 }
2491 }
2492
2493 my $t1 = Time::HiRes::time;
2494 my $data = $process->(\@data);
2495 my $t2 = Time::HiRes::time;
2496
2497 warn "cache: '$id' processed in ", $t2 - $t1, "s\n";
2498
2499 db_put cache => "$id/data", $data;
2500 db_put cache => "$id/md5" , $md5;
2501 db_put cache => "$id/meta", $meta;
2502
2503 return $data;
1057 ; 2504 }
2505
2506 db_get cache => "$id/data"
2507}
2508
2509=item fork_call { }, $args
2510
2511Executes the given code block with the given arguments in a seperate
2512process, returning the results. Everything must be serialisable with
2513Coro::Storable. May, of course, block. Note that the executed sub may
2514never block itself or use any form of Event handling.
2515
2516=cut
2517
2518sub fork_call(&@) {
2519 my ($cb, @args) = @_;
2520
2521# socketpair my $fh1, my $fh2, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC
2522# or die "socketpair: $!";
2523 pipe my $fh1, my $fh2
2524 or die "pipe: $!";
2525
2526 if (my $pid = fork) {
2527 close $fh2;
2528
2529 my $res = (Coro::Handle::unblock $fh1)->readline (undef);
2530 $res = Coro::Storable::thaw $res;
2531
2532 waitpid $pid, 0; # should not block anymore, we expect the child to simply behave
2533
2534 die $$res unless "ARRAY" eq ref $res;
2535
2536 return wantarray ? @$res : $res->[-1];
2537 } else {
2538 reset_signals;
2539 local $SIG{__WARN__};
2540 local $SIG{__DIE__};
2541 eval {
2542 close $fh1;
2543
2544 my @res = eval { $cb->(@args) };
2545 syswrite $fh2, Coro::Storable::freeze +($@ ? \"$@" : \@res);
2546 };
2547
2548 warn $@ if $@;
2549 _exit 0;
2550 }
1058} 2551}
1059 2552
1060############################################################################# 2553#############################################################################
1061# the server's main() 2554# the server's init and main functions
2555
2556sub load_facedata($) {
2557 my ($path) = @_;
2558
2559 warn "loading facedata from $path\n";
2560
2561 my $facedata;
2562 0 < aio_load $path, $facedata
2563 or die "$path: $!";
2564
2565 $facedata = Coro::Storable::thaw $facedata;
2566
2567 $facedata->{version} == 2
2568 or cf::cleanup "$path: version mismatch, cannot proceed.";
2569
2570 {
2571 my $faces = $facedata->{faceinfo};
2572
2573 while (my ($face, $info) = each %$faces) {
2574 my $idx = (cf::face::find $face) || cf::face::alloc $face;
2575 cf::face::set $idx, $info->{visibility}, $info->{magicmap};
2576 cf::face::set_data $idx, 0, $info->{data32}, $info->{chksum32};
2577 cf::face::set_data $idx, 1, $info->{data64}, $info->{chksum64};
2578 Coro::cede;
2579 }
2580
2581 while (my ($face, $info) = each %$faces) {
2582 next unless $info->{smooth};
2583 my $idx = cf::face::find $face
2584 or next;
2585 if (my $smooth = cf::face::find $info->{smooth}) {
2586 cf::face::set_smooth $idx, $smooth, $info->{smoothlevel};
2587 } else {
2588 warn "smooth face '$info->{smooth}' not found for face '$face'";
2589 }
2590 Coro::cede;
2591 }
2592 }
2593
2594 {
2595 my $anims = $facedata->{animinfo};
2596
2597 while (my ($anim, $info) = each %$anims) {
2598 cf::anim::set $anim, $info->{frames}, $info->{facings};
2599 Coro::cede;
2600 }
2601
2602 cf::anim::invalidate_all; # d'oh
2603 }
2604
2605 1
2606}
2607
2608sub reload_regions {
2609 load_resource_file "$MAPDIR/regions"
2610 or die "unable to load regions file\n";
2611}
2612
2613sub reload_facedata {
2614 load_facedata "$DATADIR/facedata"
2615 or die "unable to load facedata\n";
2616}
2617
2618sub reload_archetypes {
2619 load_resource_file "$DATADIR/archetypes"
2620 or die "unable to load archetypes\n";
2621}
2622
2623sub reload_treasures {
2624 load_resource_file "$DATADIR/treasures"
2625 or die "unable to load treasurelists\n";
2626}
2627
2628sub reload_resources {
2629 warn "reloading resource files...\n";
2630
2631 reload_regions;
2632 reload_facedata;
2633 #reload_archetypes;#d#
2634 reload_archetypes;
2635 reload_treasures;
2636
2637 warn "finished reloading resource files\n";
2638}
2639
2640sub init {
2641 reload_resources;
2642}
1062 2643
1063sub cfg_load { 2644sub cfg_load {
1064 open my $fh, "<:utf8", cf::confdir . "/config" 2645 open my $fh, "<:utf8", "$CONFDIR/config"
1065 or return; 2646 or return;
1066 2647
1067 local $/; 2648 local $/;
1068 *CFG = YAML::Syck::Load <$fh>; 2649 *CFG = YAML::Syck::Load <$fh>;
2650
2651 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2652
2653 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2654 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2655
2656 if (exists $CFG{mlockall}) {
2657 eval {
2658 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2659 and die "WARNING: m(un)lockall failed: $!\n";
2660 };
2661 warn $@ if $@;
2662 }
1069} 2663}
1070 2664
1071sub main { 2665sub main {
2666 # we must not ever block the main coroutine
2667 local $Coro::idle = sub {
2668 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2669 (async {
2670 Event::one_event;
2671 })->prio (Coro::PRIO_MAX);
2672 };
2673
1072 cfg_load; 2674 cfg_load;
1073 db_load; 2675 db_init;
1074 load_extensions; 2676 load_extensions;
2677
2678 $TICK_WATCHER->start;
1075 Event::loop; 2679 Event::loop;
1076} 2680}
1077 2681
1078############################################################################# 2682#############################################################################
1079# initialisation 2683# initialisation and cleanup
1080 2684
1081sub _perl_reload(&) { 2685# install some emergency cleanup handlers
2686BEGIN {
2687 for my $signal (qw(INT HUP TERM)) {
2688 Event->signal (
2689 reentrant => 0,
2690 data => WF_AUTOCANCEL,
2691 signal => $signal,
2692 prio => 0,
2693 cb => sub {
2694 cf::cleanup "SIG$signal";
2695 },
2696 );
2697 }
2698}
2699
2700sub emergency_save() {
2701 my $freeze_guard = cf::freeze_mainloop;
2702
2703 warn "enter emergency perl save\n";
2704
2705 cf::sync_job {
2706 # use a peculiar iteration method to avoid tripping on perl
2707 # refcount bugs in for. also avoids problems with players
2708 # and maps saved/destroyed asynchronously.
2709 warn "begin emergency player save\n";
2710 for my $login (keys %cf::PLAYER) {
2711 my $pl = $cf::PLAYER{$login} or next;
2712 $pl->valid or next;
2713 $pl->save;
2714 }
2715 warn "end emergency player save\n";
2716
2717 warn "begin emergency map save\n";
2718 for my $path (keys %cf::MAP) {
2719 my $map = $cf::MAP{$path} or next;
2720 $map->valid or next;
2721 $map->save;
2722 }
2723 warn "end emergency map save\n";
2724
2725 warn "begin emergency database checkpoint\n";
2726 BDB::db_env_txn_checkpoint $DB_ENV;
2727 warn "end emergency database checkpoint\n";
2728 };
2729
2730 warn "leave emergency perl save\n";
2731}
2732
2733sub post_cleanup {
1082 my ($msg) = @_; 2734 my ($make_core) = @_;
1083 2735
1084 $msg->("reloading..."); 2736 warn Carp::longmess "post_cleanup backtrace"
2737 if $make_core;
2738}
1085 2739
1086 eval { 2740sub do_reload_perl() {
1087 # cancel all watchers 2741 # can/must only be called in main
2742 if ($Coro::current != $Coro::main) {
2743 warn "can only reload from main coroutine";
2744 return;
2745 }
2746
2747 warn "reloading...";
2748
2749 warn "entering sync_job";
2750
2751 cf::sync_job {
2752 cf::write_runtime; # external watchdog should not bark
2753 cf::emergency_save;
2754 cf::write_runtime; # external watchdog should not bark
2755
2756 warn "syncing database to disk";
2757 BDB::db_env_txn_checkpoint $DB_ENV;
2758
2759 # if anything goes wrong in here, we should simply crash as we already saved
2760
2761 warn "cancelling all WF_AUTOCANCEL watchers";
1088 $_->cancel for Event::all_watchers; 2762 for (Event::all_watchers) {
2763 $_->cancel if $_->data & WF_AUTOCANCEL;
2764 }
1089 2765
1090 # unload all extensions 2766 warn "flushing outstanding aio requests";
1091 for (@exts) { 2767 for (;;) {
1092 $msg->("unloading <$_>"); 2768 BDB::flush;
1093 unload_extension $_; 2769 IO::AIO::flush;
2770 Coro::cede;
2771 last unless IO::AIO::nreqs || BDB::nreqs;
2772 warn "iterate...";
2773 }
2774
2775 ++$RELOAD;
2776
2777 warn "cancelling all extension coros";
2778 $_->cancel for values %EXT_CORO;
2779 %EXT_CORO = ();
2780
2781 warn "removing commands";
2782 %COMMAND = ();
2783
2784 warn "removing ext commands";
2785 %EXTCMD = ();
2786
2787 warn "unloading/nuking all extensions";
2788 for my $pkg (@EXTS) {
2789 warn "... unloading $pkg";
2790
2791 if (my $cb = $pkg->can ("unload")) {
2792 eval {
2793 $cb->($pkg);
2794 1
2795 } or warn "$pkg unloaded, but with errors: $@";
1094 } 2796 }
1095 2797
2798 warn "... nuking $pkg";
2799 Symbol::delete_package $pkg;
2800 }
2801
1096 # unload all modules loaded from $LIBDIR 2802 warn "unloading all perl modules loaded from $LIBDIR";
1097 while (my ($k, $v) = each %INC) { 2803 while (my ($k, $v) = each %INC) {
1098 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2804 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1099 2805
1100 $msg->("removing <$k>"); 2806 warn "... unloading $k";
1101 delete $INC{$k}; 2807 delete $INC{$k};
1102 2808
1103 $k =~ s/\.pm$//; 2809 $k =~ s/\.pm$//;
1104 $k =~ s/\//::/g; 2810 $k =~ s/\//::/g;
1105 2811
1108 } 2814 }
1109 2815
1110 Symbol::delete_package $k; 2816 Symbol::delete_package $k;
1111 } 2817 }
1112 2818
1113 # sync database to disk
1114 cf::db_sync;
1115
1116 # get rid of safe::, as good as possible 2819 warn "getting rid of safe::, as good as possible";
1117 Symbol::delete_package "safe::$_" 2820 Symbol::delete_package "safe::$_"
1118 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2821 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1119 2822
1120 # remove register_script_function callbacks
1121 # TODO
1122
1123 # unload cf.pm "a bit" 2823 warn "unloading cf.pm \"a bit\"";
1124 delete $INC{"cf.pm"}; 2824 delete $INC{"cf.pm"};
2825 delete $INC{"cf/pod.pm"};
1125 2826
1126 # don't, removes xs symbols, too, 2827 # don't, removes xs symbols, too,
1127 # and global variables created in xs 2828 # and global variables created in xs
1128 #Symbol::delete_package __PACKAGE__; 2829 #Symbol::delete_package __PACKAGE__;
1129 2830
1130 # reload cf.pm 2831 warn "unload completed, starting to reload now";
2832
1131 $msg->("reloading cf.pm"); 2833 warn "reloading cf.pm";
1132 require cf; 2834 require cf;
2835 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1133 2836
1134 # load config and database again 2837 warn "loading config and database again";
1135 cf::cfg_load; 2838 cf::cfg_load;
1136 cf::db_load;
1137 2839
1138 # load extensions 2840 warn "loading extensions";
1139 $msg->("load extensions");
1140 cf::load_extensions; 2841 cf::load_extensions;
1141 2842
1142 # reattach attachments to objects 2843 warn "reattaching attachments to objects/players";
1143 $msg->("reattach"); 2844 _global_reattach; # objects, sockets
1144 _global_reattach; 2845 warn "reattaching attachments to maps";
2846 reattach $_ for values %MAP;
2847 warn "reattaching attachments to players";
2848 reattach $_ for values %PLAYER;
2849
2850 warn "leaving sync_job";
2851
2852 1
2853 } or do {
2854 warn $@;
2855 warn "error while reloading, exiting.";
2856 exit 1;
1145 }; 2857 };
1146 $msg->($@) if $@;
1147 2858
1148 $msg->("reloaded"); 2859 warn "reloaded";
1149}; 2860};
1150 2861
1151sub perl_reload() { 2862our $RELOAD_WATCHER; # used only during reload
1152 _perl_reload { 2863
1153 warn $_[0]; 2864sub reload_perl() {
1154 print "$_[0]\n"; 2865 # doing reload synchronously and two reloads happen back-to-back,
2866 # coro crashes during coro_state_free->destroy here.
2867
2868 $RELOAD_WATCHER ||= Event->timer (
2869 reentrant => 0,
2870 after => 0,
2871 data => WF_AUTOCANCEL,
2872 cb => sub {
2873 do_reload_perl;
2874 undef $RELOAD_WATCHER;
2875 },
1155 }; 2876 );
1156} 2877}
1157 2878
1158register_command "perl-reload", 0, sub { 2879register_command "reload" => sub {
1159 my ($who, $arg) = @_; 2880 my ($who, $arg) = @_;
1160 2881
1161 if ($who->flag (FLAG_WIZ)) { 2882 if ($who->flag (FLAG_WIZ)) {
1162 _perl_reload { 2883 $who->message ("reloading server.");
1163 warn $_[0]; 2884 async { reload_perl };
1164 $who->message ($_[0]); 2885 }
2886};
2887
2888unshift @INC, $LIBDIR;
2889
2890my $bug_warning = 0;
2891
2892our @WAIT_FOR_TICK;
2893our @WAIT_FOR_TICK_BEGIN;
2894
2895sub wait_for_tick {
2896 return unless $TICK_WATCHER->is_active;
2897 return if $Coro::current == $Coro::main;
2898
2899 my $signal = new Coro::Signal;
2900 push @WAIT_FOR_TICK, $signal;
2901 $signal->wait;
2902}
2903
2904sub wait_for_tick_begin {
2905 return unless $TICK_WATCHER->is_active;
2906 return if $Coro::current == $Coro::main;
2907
2908 my $signal = new Coro::Signal;
2909 push @WAIT_FOR_TICK_BEGIN, $signal;
2910 $signal->wait;
2911}
2912
2913 my $min = 1e6;#d#
2914 my $avg = 10;
2915$TICK_WATCHER = Event->timer (
2916 reentrant => 0,
2917 parked => 1,
2918 prio => 0,
2919 at => $NEXT_TICK || $TICK,
2920 data => WF_AUTOCANCEL,
2921 cb => sub {
2922 if ($Coro::current != $Coro::main) {
2923 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2924 unless ++$bug_warning > 10;
2925 return;
2926 }
2927
2928 $NOW = $tick_start = Event::time;
2929
2930 cf::server_tick; # one server iteration
2931
2932 0 && sync_job {#d#
2933 for(1..10) {
2934 my $t = Event::time;
2935 my $map = my $map = new_from_path cf::map "/tmp/x.map"
2936 or die;
2937
2938 $map->width (50);
2939 $map->height (50);
2940 $map->alloc;
2941 $map->_load_objects ("/tmp/x.map", 1);
2942 my $t = Event::time - $t;
2943
2944 #next unless $t < 0.0013;#d#
2945 if ($t < $min) {
2946 $min = $t;
2947 }
2948 $avg = $avg * 0.99 + $t * 0.01;
2949 }
2950 warn "XXXXXXXXXXXXXXXXXX min $min avg $avg\n";#d#
2951 exit 0;
2952 # 2007-05-22 02:33:04.569 min 0.00112509727478027 avg 0.0012259249572477
1165 }; 2953 };
1166 }
1167};
1168 2954
1169register "<global>", __PACKAGE__; 2955 $RUNTIME += $TICK;
1170
1171unshift @INC, $LIBDIR;
1172
1173$TICK_WATCHER = Event->timer (
1174 prio => 1,
1175 async => 1,
1176 at => $NEXT_TICK || 1,
1177 cb => sub {
1178 cf::server_tick; # one server iteration
1179
1180 my $NOW = Event::time;
1181 $NEXT_TICK += $TICK; 2956 $NEXT_TICK += $TICK;
2957
2958 if ($NOW >= $NEXT_RUNTIME_WRITE) {
2959 $NEXT_RUNTIME_WRITE = $NOW + 10;
2960 Coro::async_pool {
2961 write_runtime
2962 or warn "ERROR: unable to write runtime file: $!";
2963 };
2964 }
2965
2966# my $AFTER = Event::time;
2967# warn $AFTER - $NOW;#d#
2968
2969 if (my $sig = shift @WAIT_FOR_TICK_BEGIN) {
2970 $sig->send;
2971 }
2972 while (my $sig = shift @WAIT_FOR_TICK) {
2973 $sig->send;
2974 }
2975
2976 $NOW = Event::time;
1182 2977
1183 # if we are delayed by four ticks or more, skip them all 2978 # if we are delayed by four ticks or more, skip them all
1184 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2979 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;
1185 2980
1186 $TICK_WATCHER->at ($NEXT_TICK); 2981 $TICK_WATCHER->at ($NEXT_TICK);
1187 $TICK_WATCHER->start; 2982 $TICK_WATCHER->start;
2983
2984 $LOAD = ($NOW - $tick_start) / $TICK;
2985 $LOADAVG = $LOADAVG * 0.75 + $LOAD * 0.25;
2986
2987 _post_tick;
2988
2989
1188 }, 2990 },
1189); 2991);
1190 2992
2993{
2994 BDB::max_poll_time $TICK * 0.1;
2995 $BDB_POLL_WATCHER = Event->io (
2996 reentrant => 0,
2997 fd => BDB::poll_fileno,
2998 poll => 'r',
2999 prio => 0,
3000 data => WF_AUTOCANCEL,
3001 cb => \&BDB::poll_cb,
3002 );
3003 BDB::min_parallel 8;
3004
3005 BDB::set_sync_prepare {
3006 my $status;
3007 my $current = $Coro::current;
3008 (
3009 sub {
3010 $status = $!;
3011 $current->ready; undef $current;
3012 },
3013 sub {
3014 Coro::schedule while defined $current;
3015 $! = $status;
3016 },
3017 )
3018 };
3019
3020 unless ($DB_ENV) {
3021 $DB_ENV = BDB::db_env_create;
3022
3023 cf::sync_job {
3024 eval {
3025 BDB::db_env_open
3026 $DB_ENV,
3027 $BDBDIR,
3028 BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN
3029 | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE,
3030 0666;
3031
3032 cf::cleanup "db_env_open($BDBDIR): $!" if $!;
3033
3034 $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1);
3035 $DB_ENV->set_lk_detect;
3036 };
3037
3038 cf::cleanup "db_env_open(db): $@" if $@;
3039 };
3040 }
3041}
3042
3043{
3044 IO::AIO::min_parallel 8;
3045
3046 undef $Coro::AIO::WATCHER;
1191IO::AIO::max_poll_time $TICK * 0.2; 3047 IO::AIO::max_poll_time $TICK * 0.1;
1192 3048 $AIO_POLL_WATCHER = Event->io (
1193Event->io (fd => IO::AIO::poll_fileno, 3049 reentrant => 0,
3050 data => WF_AUTOCANCEL,
3051 fd => IO::AIO::poll_fileno,
1194 poll => 'r', 3052 poll => 'r',
1195 prio => 5, 3053 prio => 6,
1196 cb => \&IO::AIO::poll_cb); 3054 cb => \&IO::AIO::poll_cb,
3055 );
3056}
3057
3058my $_log_backtrace;
3059
3060sub _log_backtrace {
3061 my ($msg, @addr) = @_;
3062
3063 $msg =~ s/\n//;
3064
3065 # limit the # of concurrent backtraces
3066 if ($_log_backtrace < 2) {
3067 ++$_log_backtrace;
3068 async {
3069 my @bt = fork_call {
3070 @addr = map { sprintf "%x", $_ } @addr;
3071 my $self = (-f "/proc/$$/exe") ? "/proc/$$/exe" : $^X;
3072 open my $fh, "exec addr2line -C -f -i -e \Q$self\E @addr 2>&1 |"
3073 or die "addr2line: $!";
3074
3075 my @funcs;
3076 my @res = <$fh>;
3077 chomp for @res;
3078 while (@res) {
3079 my ($func, $line) = splice @res, 0, 2, ();
3080 push @funcs, "[$func] $line";
3081 }
3082
3083 @funcs
3084 };
3085
3086 LOG llevInfo, "[ABT] $msg\n";
3087 LOG llevInfo, "[ABT] $_\n" for @bt;
3088 --$_log_backtrace;
3089 };
3090 } else {
3091 LOG llevInfo, "[ABT] $msg\n";
3092 LOG llevInfo, "[ABT] [suppressed]\n";
3093 }
3094}
3095
3096# load additional modules
3097use cf::pod;
3098
3099END { cf::emergency_save }
1197 3100
11981 31011
1199 3102

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines