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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines