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.72 by root, Sun Oct 1 11:41:37 2006 UTC vs.
Revision 1.204 by root, Fri Feb 2 19:59:22 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Storable;
6use Opcode; 9use Opcode;
7use Safe; 10use Safe;
8use Safe::Hole; 11use Safe::Hole;
9 12
13use Coro 3.5 ();
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18use Coro::AIO;
19
20use Data::Dumper;
21use Digest::MD5;
22use Fcntl;
23use IO::AIO 2.32 ();
10use YAML::Syck (); 24use YAML::Syck ();
11use Time::HiRes; 25use Time::HiRes;
12use Event; 26
13$Event::Eval = 1; # no idea why this is required, but it is 27use Event; $Event::Eval = 1; # no idea why this is required, but it is
28
29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
14 30
15# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
16$YAML::Syck::ImplicitUnicode = 1; 32$YAML::Syck::ImplicitUnicode = 1;
17 33
18use strict; 34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
19 35
20_init_vars;
21
22our %COMMAND = (); 36our %COMMAND = ();
37our %COMMAND_TIME = ();
38
39our @EXTS = (); # list of extension package names
40our %EXTCMD = ();
41our %EXT_CORO = (); # coroutines bound to extensions
42our %EXT_MAP = (); # pluggable maps
43
23our @EVENT; 44our @EVENT;
24our $LIBDIR = maps_directory "perl"; 45our $LIBDIR = datadir . "/ext";
25 46
26our $TICK = MAX_TIME * 1e-6; 47our $TICK = MAX_TIME * 1e-6;
27our $TICK_WATCHER; 48our $TICK_WATCHER;
49our $AIO_POLL_WATCHER;
50our $WRITE_RUNTIME_WATCHER;
28our $NEXT_TICK; 51our $NEXT_TICK;
52our $NOW;
53our $USE_FSYNC; # use fsync to write maps - default off
29 54
30our %CFG; 55our %CFG;
31 56
57our $UPTIME; $UPTIME ||= time;
58our $RUNTIME;
59
60our %PLAYER; # all users
61our %MAP; # all maps
62our $LINK_MAP; # the special {link} map, which is always available
63our $RANDOM_MAPS = cf::localdir . "/random";
64
65our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
66our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
67
68# used to convert map paths into valid unix filenames by replacing / by ∕
69our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
70
71binmode STDOUT;
72binmode STDERR;
73
74# read virtual server time, if available
75unless ($RUNTIME || !-e cf::localdir . "/runtime") {
76 open my $fh, "<", cf::localdir . "/runtime"
77 or die "unable to read runtime file: $!";
78 $RUNTIME = <$fh> + 0.;
79}
80
81mkdir cf::localdir;
82mkdir cf::localdir . "/" . cf::playerdir;
83mkdir cf::localdir . "/" . cf::tmpdir;
84mkdir cf::localdir . "/" . cf::uniquedir;
85mkdir $RANDOM_MAPS;
86
87our $EMERGENCY_POSITION;
88
89sub cf::map::normalise;
90
32############################################################################# 91#############################################################################
33 92
34=head2 GLOBAL VARIABLES 93=head2 GLOBAL VARIABLES
35 94
36=over 4 95=over 4
96
97=item $cf::UPTIME
98
99The timestamp of the server start (so not actually an uptime).
100
101=item $cf::RUNTIME
102
103The time this server has run, starts at 0 and is increased by $cf::TICK on
104every server tick.
37 105
38=item $cf::LIBDIR 106=item $cf::LIBDIR
39 107
40The perl library directory, where extensions and cf-specific modules can 108The perl library directory, where extensions and cf-specific modules can
41be found. It will be added to C<@INC> automatically. 109be found. It will be added to C<@INC> automatically.
42 110
111=item $cf::NOW
112
113The time of the last (current) server tick.
114
43=item $cf::TICK 115=item $cf::TICK
44 116
45The interval between server ticks, in seconds. 117The interval between server ticks, in seconds.
46 118
47=item %cf::CFG 119=item %cf::CFG
48 120
49Configuration for the server, loaded from C</etc/crossfire/config>, or 121Configuration for the server, loaded from C</etc/crossfire/config>, or
50from wherever your confdir points to. 122from wherever your confdir points to.
123
124=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
125
126These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
127or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
128processing has been done. Call C<< ->wait >> on them to maximise the
129window of cpu time available, or simply to synchronise to the server tick.
51 130
52=back 131=back
53 132
54=cut 133=cut
55 134
56BEGIN { 135BEGIN {
57 *CORE::GLOBAL::warn = sub { 136 *CORE::GLOBAL::warn = sub {
58 my $msg = join "", @_; 137 my $msg = join "", @_;
138 utf8::encode $msg;
139
59 $msg .= "\n" 140 $msg .= "\n"
60 unless $msg =~ /\n$/; 141 unless $msg =~ /\n$/;
61 142
62 print STDERR "cfperl: $msg";
63 LOG llevError, "cfperl: $msg"; 143 LOG llevError, $msg;
64 }; 144 };
65} 145}
66 146
147@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
148@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
149@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
150@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
151@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
67@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 152@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
68 153
69# we bless all objects into (empty) derived classes to force a method lookup 154# we bless all objects into (empty) derived classes to force a method lookup
70# within the Safe compartment. 155# within the Safe compartment.
71for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { 156for my $pkg (qw(
157 cf::global cf::attachable
158 cf::object cf::object::player
159 cf::client cf::player
160 cf::arch cf::living
161 cf::map cf::party cf::region
162)) {
72 no strict 'refs'; 163 no strict 'refs';
73 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 164 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
74} 165}
75 166
76$Event::DIED = sub { 167$Event::DIED = sub {
77 warn "error in event callback: @_"; 168 warn "error in event callback: @_";
78}; 169};
79 170
80my %ext_pkg;
81my @exts;
82my @hook;
83my %command;
84my %extcmd;
85
86=head2 UTILITY FUNCTIONS 171=head2 UTILITY FUNCTIONS
87 172
88=over 4 173=over 4
89 174
175=item dumpval $ref
176
90=cut 177=cut
178
179sub dumpval {
180 eval {
181 local $SIG{__DIE__};
182 my $d;
183 if (1) {
184 $d = new Data::Dumper([$_[0]], ["*var"]);
185 $d->Terse(1);
186 $d->Indent(2);
187 $d->Quotekeys(0);
188 $d->Useqq(1);
189 #$d->Bless(...);
190 $d->Seen($_[1]) if @_ > 1;
191 $d = $d->Dump();
192 }
193 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
194 $d
195 } || "[unable to dump $_[0]: '$@']";
196}
91 197
92use JSON::Syck (); # TODO# replace by JSON::PC once working 198use JSON::Syck (); # TODO# replace by JSON::PC once working
93 199
94=item $ref = cf::from_json $json 200=item $ref = cf::from_json $json
95 201
111sub to_json($) { 217sub to_json($) {
112 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 218 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
113 JSON::Syck::Dump $_[0] 219 JSON::Syck::Dump $_[0]
114} 220}
115 221
222=item cf::lock_wait $string
223
224Wait until the given lock is available. See cf::lock_acquire.
225
226=item my $lock = cf::lock_acquire $string
227
228Wait until the given lock is available and then acquires it and returns
229a Coro::guard object. If the guard object gets destroyed (goes out of scope,
230for example when the coroutine gets canceled), the lock is automatically
231returned.
232
233Lock names should begin with a unique identifier (for example, cf::map::find
234uses map_find and cf::map::load uses map_load).
235
236=cut
237
238our %LOCK;
239
240sub lock_wait($) {
241 my ($key) = @_;
242
243 # wait for lock, if any
244 while ($LOCK{$key}) {
245 push @{ $LOCK{$key} }, $Coro::current;
246 Coro::schedule;
247 }
248}
249
250sub lock_acquire($) {
251 my ($key) = @_;
252
253 # wait, to be sure we are not locked
254 lock_wait $key;
255
256 $LOCK{$key} = [];
257
258 Coro::guard {
259 # wake up all waiters, to be on the safe side
260 $_->ready for @{ delete $LOCK{$key} };
261 }
262}
263
264sub freeze_mainloop {
265 return unless $TICK_WATCHER->is_active;
266
267 my $guard = Coro::guard {
268 $TICK_WATCHER->start;
269 $WRITE_RUNTIME_WATCHER->start;
270 };
271 $WRITE_RUNTIME_WATCHER->stop;
272 $TICK_WATCHER->stop;
273 $guard
274}
275
276=item cf::async { BLOCK }
277
278Currently the same as Coro::async_pool, meaning you cannot use
279C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
280thing you are allowed to do is call C<prio> on it.
281
282=cut
283
284BEGIN { *async = \&Coro::async_pool }
285
286=item cf::sync_job { BLOCK }
287
288The design of crossfire+ requires that the main coro ($Coro::main) is
289always able to handle events or runnable, as crossfire+ is only partly
290reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
291
292If it must be done, put the blocking parts into C<sync_job>. This will run
293the given BLOCK in another coroutine while waiting for the result. The
294server will be frozen during this time, so the block should either finish
295fast or be very important.
296
297=cut
298
299sub sync_job(&) {
300 my ($job) = @_;
301
302 if ($Coro::current == $Coro::main) {
303 # this is the main coro, too bad, we have to block
304 # till the operation succeeds, freezing the server :/
305
306 # TODO: use suspend/resume instead
307 # (but this is cancel-safe)
308 my $freeze_guard = freeze_mainloop;
309
310 my $busy = 1;
311 my @res;
312
313 (async {
314 @res = eval { $job->() };
315 warn $@ if $@;
316 undef $busy;
317 })->prio (Coro::PRIO_MAX);
318
319 while ($busy) {
320 Coro::cede or Event::one_event;
321 }
322
323 wantarray ? @res : $res[0]
324 } else {
325 # we are in another coroutine, how wonderful, everything just works
326
327 $job->()
328 }
329}
330
331=item $coro = cf::async_ext { BLOCK }
332
333Like async, but this coro is automatically being canceled when the
334extension calling this is being unloaded.
335
336=cut
337
338sub async_ext(&) {
339 my $cb = shift;
340
341 my $coro = &Coro::async ($cb);
342
343 $coro->on_destroy (sub {
344 delete $EXT_CORO{$coro+0};
345 });
346 $EXT_CORO{$coro+0} = $coro;
347
348 $coro
349}
350
351sub write_runtime {
352 my $runtime = cf::localdir . "/runtime";
353
354 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
355 or return;
356
357 my $value = $cf::RUNTIME + 90 + 10;
358 # 10 is the runtime save interval, for a monotonic clock
359 # 60 allows for the watchdog to kill the server.
360
361 (aio_write $fh, 0, (length $value), $value, 0) <= 0
362 and return;
363
364 # always fsync - this file is important
365 aio_fsync $fh
366 and return;
367
368 close $fh
369 or return;
370
371 aio_rename "$runtime~", $runtime
372 and return;
373
374 1
375}
376
116=back 377=back
117 378
118=cut 379=cut
119 380
120############################################################################# 381#############################################################################
121 382
122=head2 EVENTS AND OBJECT ATTACHMENTS 383=head2 ATTACHABLE OBJECTS
384
385Many objects in crossfire are so-called attachable objects. That means you can
386attach callbacks/event handlers (a collection of which is called an "attachment")
387to it. All such attachable objects support the following methods.
388
389In the following description, CLASS can be any of C<global>, C<object>
390C<player>, C<client> or C<map> (i.e. the attachable objects in
391crossfire+).
123 392
124=over 4 393=over 4
125 394
126=item $object->attach ($attachment, key => $value...)
127
128=item $object->detach ($attachment)
129
130Attach/detach a pre-registered attachment to an object.
131
132=item $player->attach ($attachment, key => $value...)
133
134=item $player->detach ($attachment)
135
136Attach/detach a pre-registered attachment to a player.
137
138=item $map->attach ($attachment, key => $value...) 395=item $attachable->attach ($attachment, key => $value...)
139 396
140=item $map->detach ($attachment) 397=item $attachable->detach ($attachment)
141 398
142Attach/detach a pre-registered attachment to a map. 399Attach/detach a pre-registered attachment to a specific object and give it
400the specified key/value pairs as arguments.
143 401
144=item $bool = $object->attached ($name) 402Example, attach a minesweeper attachment to the given object, making it a
40310x10 minesweeper game:
145 404
146=item $bool = $player->attached ($name) 405 $obj->attach (minesweeper => width => 10, height => 10);
147 406
148=item $bool = $map->attached ($name) 407=item $bool = $attachable->attached ($name)
149 408
150Checks wether the named attachment is currently attached to the object. 409Checks wether the named attachment is currently attached to the object.
151 410
152=item cf::attach_global ... 411=item cf::CLASS->attach ...
153 412
154Attach handlers for global events. 413=item cf::CLASS->detach ...
155 414
156This and all following C<attach_*>-functions expect any number of the 415Define an anonymous attachment and attach it to all objects of the given
157following handler/hook descriptions: 416CLASS. See the next function for an explanation of its arguments.
417
418You can attach to global events by using the C<cf::global> class.
419
420Example, log all player logins:
421
422 cf::player->attach (
423 on_login => sub {
424 my ($pl) = @_;
425 ...
426 },
427 );
428
429Example, attach to the jeweler skill:
430
431 cf::object->attach (
432 type => cf::SKILL,
433 subtype => cf::SK_JEWELER,
434 on_use_skill => sub {
435 my ($sk, $ob, $part, $dir, $msg) = @_;
436 ...
437 },
438 );
439
440=item cf::CLASS::attachment $name, ...
441
442Register an attachment by C<$name> through which attachable objects of the
443given CLASS can refer to this attachment.
444
445Some classes such as crossfire maps and objects can specify attachments
446that are attached at load/instantiate time, thus the need for a name.
447
448These calls expect any number of the following handler/hook descriptions:
158 449
159=over 4 450=over 4
160 451
161=item prio => $number 452=item prio => $number
162 453
164by another C<prio> setting). Lower priority handlers get executed 455by another C<prio> setting). Lower priority handlers get executed
165earlier. The default priority is C<0>, and many built-in handlers are 456earlier. The default priority is C<0>, and many built-in handlers are
166registered at priority C<-1000>, so lower priorities should not be used 457registered at priority C<-1000>, so lower priorities should not be used
167unless you know what you are doing. 458unless you know what you are doing.
168 459
460=item type => $type
461
462(Only for C<< cf::object->attach >> calls), limits the attachment to the
463given type of objects only (the additional parameter C<subtype> can be
464used to further limit to the given subtype).
465
169=item on_I<event> => \&cb 466=item on_I<event> => \&cb
170 467
171Call the given code reference whenever the named event happens (event is 468Call the given code reference whenever the named event happens (event is
172something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 469something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
173handlers are recognised generally depends on the type of object these 470handlers are recognised generally depends on the type of object these
182package and register them. Only handlers for eevents supported by the 479package and register them. Only handlers for eevents supported by the
183object/class are recognised. 480object/class are recognised.
184 481
185=back 482=back
186 483
187=item cf::attach_to_type $object_type, $subtype, ... 484Example, define an attachment called "sockpuppet" that calls the given
485event handler when a monster attacks:
188 486
189Attach handlers for a specific object type (e.g. TRANSPORT) and 487 cf::object::attachment sockpuppet =>
190subtype. If C<$subtype> is zero or undef, matches all objects of the given 488 on_skill_attack => sub {
191type. 489 my ($self, $victim) = @_;
192 490 ...
193=item cf::attach_to_objects ...
194
195Attach handlers to all objects. Do not use this except for debugging or
196very rare events, as handlers are (obviously) called for I<all> objects in
197the game.
198
199=item cf::attach_to_players ...
200
201Attach handlers to all players.
202
203=item cf::attach_to_maps ...
204
205Attach handlers to all maps.
206
207=item cf:register_attachment $name, ...
208
209Register an attachment by name through which objects can refer to this
210attachment.
211
212=item cf:register_player_attachment $name, ...
213
214Register an attachment by name through which players can refer to this
215attachment.
216
217=item cf:register_map_attachment $name, ...
218
219Register an attachment by name through which maps can refer to this
220attachment.
221
222=cut
223
224# the following variables are defined in .xs and must not be re-created
225our @CB_GLOBAL = (); # registry for all global events
226our @CB_OBJECT = (); # all objects (should not be used except in emergency)
227our @CB_PLAYER = ();
228our @CB_TYPE = (); # registry for type (cf-object class) based events
229our @CB_MAP = ();
230
231my %attachment;
232
233sub _attach_cb($\%$$$) {
234 my ($registry, $undo, $event, $prio, $cb) = @_;
235
236 use sort 'stable';
237
238 $cb = [$prio, $cb];
239
240 @{$registry->[$event]} = sort
241 { $a->[0] cmp $b->[0] }
242 @{$registry->[$event] || []}, $cb;
243
244 push @{$undo->{cb}}, [$event, $cb];
245}
246
247# attach handles attaching event callbacks
248# the only thing the caller has to do is pass the correct
249# registry (== where the callback attaches to).
250sub _attach(\@$@) {
251 my ($registry, $klass, @arg) = @_;
252
253 my $prio = 0;
254
255 my %undo = (
256 registry => $registry,
257 cb => [],
258 );
259
260 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
261
262 while (@arg) {
263 my $type = shift @arg;
264
265 if ($type eq "prio") {
266 $prio = shift @arg;
267
268 } elsif ($type eq "package") {
269 my $pkg = shift @arg;
270
271 while (my ($name, $id) = each %cb_id) {
272 if (my $cb = $pkg->can ($name)) {
273 _attach_cb $registry, %undo, $id, $prio, $cb;
274 }
275 } 491 }
276
277 } elsif (exists $cb_id{$type}) {
278 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
279
280 } elsif (ref $type) {
281 warn "attaching objects not supported, ignoring.\n";
282
283 } else {
284 shift @arg;
285 warn "attach argument '$type' not supported, ignoring.\n";
286 }
287 }
288
289 \%undo
290}
291
292sub _attach_attachment {
293 my ($obj, $name, %arg) = @_;
294
295 return if exists $obj->{_attachment}{$name};
296
297 my $res;
298
299 if (my $attach = $attachment{$name}) {
300 my $registry = $obj->registry;
301
302 for (@$attach) {
303 my ($klass, @attach) = @$_;
304 $res = _attach @$registry, $klass, @attach;
305 }
306
307 $obj->{$name} = \%arg;
308 } else {
309 warn "object uses attachment '$name' that is not available, postponing.\n";
310 }
311
312 $obj->{_attachment}{$name} = undef;
313
314 $res->{attachment} = $name;
315 $res
316}
317
318*cf::object::attach =
319*cf::player::attach =
320*cf::map::attach = sub {
321 my ($obj, $name, %arg) = @_;
322
323 _attach_attachment $obj, $name, %arg;
324};
325
326# all those should be optimised
327*cf::object::detach =
328*cf::player::detach =
329*cf::map::detach = sub {
330 my ($obj, $name) = @_;
331
332 delete $obj->{_attachment}{$name};
333 reattach ($obj);
334};
335
336*cf::object::attached =
337*cf::player::attached =
338*cf::map::attached = sub {
339 my ($obj, $name) = @_;
340
341 exists $obj->{_attachment}{$name}
342};
343
344sub attach_global {
345 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
346}
347
348sub attach_to_type {
349 my $type = shift;
350 my $subtype = shift;
351
352 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
353}
354
355sub attach_to_objects {
356 _attach @CB_OBJECT, KLASS_OBJECT, @_
357}
358
359sub attach_to_players {
360 _attach @CB_PLAYER, KLASS_PLAYER, @_
361}
362
363sub attach_to_maps {
364 _attach @CB_MAP, KLASS_MAP, @_
365}
366
367sub register_attachment {
368 my $name = shift;
369
370 $attachment{$name} = [[KLASS_OBJECT, @_]];
371}
372
373sub register_player_attachment {
374 my $name = shift;
375
376 $attachment{$name} = [[KLASS_PLAYER, @_]];
377}
378
379sub register_map_attachment {
380 my $name = shift;
381
382 $attachment{$name} = [[KLASS_MAP, @_]];
383}
384
385our $override;
386our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
387
388sub override {
389 $override = 1;
390 @invoke_results = ();
391}
392
393sub do_invoke {
394 my $event = shift;
395 my $callbacks = shift;
396
397 @invoke_results = ();
398
399 local $override;
400
401 for (@$callbacks) {
402 eval { &{$_->[1]} };
403
404 if ($@) {
405 warn "$@";
406 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
407 override;
408 }
409
410 return 1 if $override;
411 }
412
413 0 492 }
414}
415 493
416=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 494=item $attachable->valid
417
418=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
419
420=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
421
422=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
423
424Generate a global/object/player/map-specific event with the given arguments.
425
426This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
427removed in future versions), and there is no public API to access override
428results (if you must, access C<@cf::invoke_results> directly).
429
430=back
431
432=cut
433
434#############################################################################
435
436=head2 METHODS VALID FOR ALL CORE OBJECTS
437
438=over 4
439
440=item $object->valid, $player->valid, $map->valid
441 495
442Just because you have a perl object does not mean that the corresponding 496Just because you have a perl object does not mean that the corresponding
443C-level object still exists. If you try to access an object that has no 497C-level object still exists. If you try to access an object that has no
444valid C counterpart anymore you get an exception at runtime. This method 498valid C counterpart anymore you get an exception at runtime. This method
445can be used to test for existence of the C object part without causing an 499can be used to test for existence of the C object part without causing an
446exception. 500exception.
447 501
502=cut
503
504# the following variables are defined in .xs and must not be re-created
505our @CB_GLOBAL = (); # registry for all global events
506our @CB_ATTACHABLE = (); # registry for all attachables
507our @CB_OBJECT = (); # all objects (should not be used except in emergency)
508our @CB_PLAYER = ();
509our @CB_CLIENT = ();
510our @CB_TYPE = (); # registry for type (cf-object class) based events
511our @CB_MAP = ();
512
513my %attachment;
514
515sub cf::attachable::thawer_merge {
516 # simply override everything except _meta
517 local $_[0]{_meta};
518 %{$_[0]} = %{$_[1]};
519}
520
521sub _attach_cb($$$$) {
522 my ($registry, $event, $prio, $cb) = @_;
523
524 use sort 'stable';
525
526 $cb = [$prio, $cb];
527
528 @{$registry->[$event]} = sort
529 { $a->[0] cmp $b->[0] }
530 @{$registry->[$event] || []}, $cb;
531}
532
533# hack
534my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
535
536# attach handles attaching event callbacks
537# the only thing the caller has to do is pass the correct
538# registry (== where the callback attaches to).
539sub _attach {
540 my ($registry, $klass, @arg) = @_;
541
542 my $object_type;
543 my $prio = 0;
544 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
545
546 #TODO: get rid of this hack
547 if ($attachable_klass{$klass}) {
548 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
549 }
550
551 while (@arg) {
552 my $type = shift @arg;
553
554 if ($type eq "prio") {
555 $prio = shift @arg;
556
557 } elsif ($type eq "type") {
558 $object_type = shift @arg;
559 $registry = $CB_TYPE[$object_type] ||= [];
560
561 } elsif ($type eq "subtype") {
562 defined $object_type or Carp::croak "subtype specified without type";
563 my $object_subtype = shift @arg;
564 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
565
566 } elsif ($type eq "package") {
567 my $pkg = shift @arg;
568
569 while (my ($name, $id) = each %cb_id) {
570 if (my $cb = $pkg->can ($name)) {
571 _attach_cb $registry, $id, $prio, $cb;
572 }
573 }
574
575 } elsif (exists $cb_id{$type}) {
576 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
577
578 } elsif (ref $type) {
579 warn "attaching objects not supported, ignoring.\n";
580
581 } else {
582 shift @arg;
583 warn "attach argument '$type' not supported, ignoring.\n";
584 }
585 }
586}
587
588sub _object_attach {
589 my ($obj, $name, %arg) = @_;
590
591 return if exists $obj->{_attachment}{$name};
592
593 if (my $attach = $attachment{$name}) {
594 my $registry = $obj->registry;
595
596 for (@$attach) {
597 my ($klass, @attach) = @$_;
598 _attach $registry, $klass, @attach;
599 }
600
601 $obj->{$name} = \%arg;
602 } else {
603 warn "object uses attachment '$name' that is not available, postponing.\n";
604 }
605
606 $obj->{_attachment}{$name} = undef;
607}
608
609sub cf::attachable::attach {
610 if (ref $_[0]) {
611 _object_attach @_;
612 } else {
613 _attach shift->_attach_registry, @_;
614 }
615};
616
617# all those should be optimised
618sub cf::attachable::detach {
619 my ($obj, $name) = @_;
620
621 if (ref $obj) {
622 delete $obj->{_attachment}{$name};
623 reattach ($obj);
624 } else {
625 Carp::croak "cannot, currently, detach class attachments";
626 }
627};
628
629sub cf::attachable::attached {
630 my ($obj, $name) = @_;
631
632 exists $obj->{_attachment}{$name}
633}
634
635for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
636 eval "#line " . __LINE__ . " 'cf.pm'
637 sub cf::\L$klass\E::_attach_registry {
638 (\\\@CB_$klass, KLASS_$klass)
639 }
640
641 sub cf::\L$klass\E::attachment {
642 my \$name = shift;
643
644 \$attachment{\$name} = [[KLASS_$klass, \@_]];
645 }
646 ";
647 die if $@;
648}
649
650our $override;
651our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
652
653sub override {
654 $override = 1;
655 @invoke_results = ();
656}
657
658sub do_invoke {
659 my $event = shift;
660 my $callbacks = shift;
661
662 @invoke_results = ();
663
664 local $override;
665
666 for (@$callbacks) {
667 eval { &{$_->[1]} };
668
669 if ($@) {
670 warn "$@";
671 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
672 override;
673 }
674
675 return 1 if $override;
676 }
677
678 0
679}
680
681=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
682
683=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
684
685Generate an object-specific event with the given arguments.
686
687This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
688removed in future versions), and there is no public API to access override
689results (if you must, access C<@cf::invoke_results> directly).
690
448=back 691=back
449 692
450=cut 693=cut
451
452*cf::object::valid =
453*cf::player::valid =
454*cf::map::valid = \&cf::_valid;
455 694
456############################################################################# 695#############################################################################
457# object support 696# object support
458 697
459sub instantiate {
460 my ($obj, $data) = @_;
461
462 $data = from_json $data;
463
464 for (@$data) {
465 my ($name, $args) = @$_;
466
467 $obj->attach ($name, %{$args || {} });
468 }
469}
470
471# basically do the same as instantiate, without calling instantiate
472sub reattach { 698sub reattach {
699 # basically do the same as instantiate, without calling instantiate
473 my ($obj) = @_; 700 my ($obj) = @_;
701
702 bless $obj, ref $obj; # re-bless in case extensions have been reloaded
703
474 my $registry = $obj->registry; 704 my $registry = $obj->registry;
475 705
476 @$registry = (); 706 @$registry = ();
477 707
478 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 708 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
479 709
480 for my $name (keys %{ $obj->{_attachment} || {} }) { 710 for my $name (keys %{ $obj->{_attachment} || {} }) {
481 if (my $attach = $attachment{$name}) { 711 if (my $attach = $attachment{$name}) {
482 for (@$attach) { 712 for (@$attach) {
483 my ($klass, @attach) = @$_; 713 my ($klass, @attach) = @$_;
484 _attach @$registry, $klass, @attach; 714 _attach $registry, $klass, @attach;
485 } 715 }
486 } else { 716 } else {
487 warn "object uses attachment '$name' that is not available, postponing.\n"; 717 warn "object uses attachment '$name' that is not available, postponing.\n";
488 } 718 }
489 } 719 }
490} 720}
491 721
492sub object_freezer_save { 722cf::attachable->attach (
493 my ($filename, $rdata, $objs) = @_;
494
495 if (length $$rdata) {
496 warn sprintf "saving %s (%d,%d)\n",
497 $filename, length $$rdata, scalar @$objs;
498
499 if (open my $fh, ">:raw", "$filename~") {
500 chmod SAVE_MODE, $fh;
501 syswrite $fh, $$rdata;
502 close $fh;
503
504 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
505 chmod SAVE_MODE, $fh;
506 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
507 close $fh;
508 rename "$filename.pst~", "$filename.pst";
509 } else {
510 unlink "$filename.pst";
511 }
512
513 rename "$filename~", $filename;
514 } else {
515 warn "FATAL: $filename~: $!\n";
516 }
517 } else {
518 unlink $filename;
519 unlink "$filename.pst";
520 }
521}
522
523sub object_thawer_load {
524 my ($filename) = @_;
525
526 local $/;
527
528 my $av;
529
530 #TODO: use sysread etc.
531 if (open my $data, "<:raw:perlio", $filename) {
532 $data = <$data>;
533 if (open my $pst, "<:raw:perlio", "$filename.pst") {
534 $av = eval { (Storable::thaw <$pst>)->{objs} };
535 }
536 return ($data, $av);
537 }
538
539 ()
540}
541
542attach_to_objects
543 prio => -1000000, 723 prio => -1000000,
724 on_instantiate => sub {
725 my ($obj, $data) = @_;
726
727 $data = from_json $data;
728
729 for (@$data) {
730 my ($name, $args) = @$_;
731
732 $obj->attach ($name, %{$args || {} });
733 }
734 },
735 on_reattach => \&reattach,
544 on_clone => sub { 736 on_clone => sub {
545 my ($src, $dst) = @_; 737 my ($src, $dst) = @_;
546 738
547 @{$dst->registry} = @{$src->registry}; 739 @{$dst->registry} = @{$src->registry};
548 740
549 %$dst = %$src; 741 %$dst = %$src;
550 742
551 %{$dst->{_attachment}} = %{$src->{_attachment}} 743 %{$dst->{_attachment}} = %{$src->{_attachment}}
552 if exists $src->{_attachment}; 744 if exists $src->{_attachment};
553 }, 745 },
554; 746);
747
748sub object_freezer_save {
749 my ($filename, $rdata, $objs) = @_;
750
751 sync_job {
752 if (length $$rdata) {
753 warn sprintf "saving %s (%d,%d)\n",
754 $filename, length $$rdata, scalar @$objs;
755
756 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
757 chmod SAVE_MODE, $fh;
758 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
759 aio_fsync $fh if $cf::USE_FSYNC;
760 close $fh;
761
762 if (@$objs) {
763 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
764 chmod SAVE_MODE, $fh;
765 my $data = Storable::nfreeze { version => 1, objs => $objs };
766 aio_write $fh, 0, (length $data), $data, 0;
767 aio_fsync $fh if $cf::USE_FSYNC;
768 close $fh;
769 aio_rename "$filename.pst~", "$filename.pst";
770 }
771 } else {
772 aio_unlink "$filename.pst";
773 }
774
775 aio_rename "$filename~", $filename;
776 } else {
777 warn "FATAL: $filename~: $!\n";
778 }
779 } else {
780 aio_unlink $filename;
781 aio_unlink "$filename.pst";
782 }
783
784 #d##TODO# nuke non .map-files if exist
785 if ($filename =~ s/\.map$//) {
786 aio_unlink $filename;
787 aio_unlink "$filename.pst";
788 }
789 }
790}
791
792sub object_freezer_as_string {
793 my ($rdata, $objs) = @_;
794
795 use Data::Dumper;
796
797 $$rdata . Dumper $objs
798}
799
800sub object_thawer_load {
801 my ($filename) = @_;
802
803 my ($data, $av);
804
805 #d#TODO remove .map if file does not exist
806 aio_stat $filename and $filename =~ s/\.map$//;
807
808 (aio_load $filename, $data) >= 0
809 or return;
810
811 unless (aio_stat "$filename.pst") {
812 (aio_load "$filename.pst", $av) >= 0
813 or return;
814 $av = eval { (Storable::thaw $av)->{objs} };
815 }
816
817 warn sprintf "loading %s (%d)\n",
818 $filename, length $data, scalar @{$av || []};#d#
819 return ($data, $av);
820}
555 821
556############################################################################# 822#############################################################################
557# old plug-in events 823# command handling &c
558 824
559sub inject_event { 825=item cf::register_command $name => \&callback($ob,$args);
560 my $extension = shift;
561 my $event_code = shift;
562 826
563 my $cb = $hook[$event_code]{$extension} 827Register a callback for execution when the client sends the user command
564 or return; 828$name.
565 829
566 &$cb 830=cut
567}
568
569sub inject_global_event {
570 my $event = shift;
571
572 my $cb = $hook[$event]
573 or return;
574
575 List::Util::max map &$_, values %$cb
576}
577
578sub inject_command {
579 my ($name, $obj, $params) = @_;
580
581 for my $cmd (@{ $command{$name} }) {
582 $cmd->[1]->($obj, $params);
583 }
584
585 -1
586}
587 831
588sub register_command { 832sub register_command {
589 my ($name, $time, $cb) = @_; 833 my ($name, $cb) = @_;
590 834
591 my $caller = caller; 835 my $caller = caller;
592 #warn "registering command '$name/$time' to '$caller'"; 836 #warn "registering command '$name/$time' to '$caller'";
593 837
594 push @{ $command{$name} }, [$time, $cb, $caller]; 838 push @{ $COMMAND{$name} }, [$caller, $cb];
595 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
596} 839}
840
841=item cf::register_extcmd $name => \&callback($pl,$packet);
842
843Register a callbackf ro execution when the client sends an extcmd packet.
844
845If the callback returns something, it is sent back as if reply was being
846called.
847
848=cut
597 849
598sub register_extcmd { 850sub register_extcmd {
599 my ($name, $cb) = @_; 851 my ($name, $cb) = @_;
600 852
601 my $caller = caller; 853 $EXTCMD{$name} = $cb;
602 #warn "registering extcmd '$name' to '$caller'";
603
604 $extcmd{$name} = [$cb, $caller];
605} 854}
606 855
607sub register { 856cf::player->attach (
608 my ($base, $pkg) = @_; 857 on_command => sub {
858 my ($pl, $name, $params) = @_;
609 859
610 #TODO 860 my $cb = $COMMAND{$name}
611} 861 or return;
862
863 for my $cmd (@$cb) {
864 $cmd->[1]->($pl->ob, $params);
865 }
866
867 cf::override;
868 },
869 on_extcmd => sub {
870 my ($pl, $buf) = @_;
871
872 my $msg = eval { from_json $buf };
873
874 if (ref $msg) {
875 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
876 if (my %reply = $cb->($pl, $msg)) {
877 $pl->ext_reply ($msg->{msgid}, %reply);
878 }
879 }
880 } else {
881 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
882 }
883
884 cf::override;
885 },
886);
612 887
613sub load_extension { 888sub load_extension {
614 my ($path) = @_; 889 my ($path) = @_;
615 890
616 $path =~ /([^\/\\]+)\.ext$/ or die "$path"; 891 $path =~ /([^\/\\]+)\.ext$/ or die "$path";
617 my $base = $1; 892 my $base = $1;
618 my $pkg = $1; 893 my $pkg = $1;
619 $pkg =~ s/[^[:word:]]/_/g; 894 $pkg =~ s/[^[:word:]]/_/g;
620 $pkg = "ext::$pkg"; 895 $pkg = "ext::$pkg";
621 896
622 warn "loading '$path' into '$pkg'\n"; 897 warn "... loading '$path' into '$pkg'\n";
623 898
624 open my $fh, "<:utf8", $path 899 open my $fh, "<:utf8", $path
625 or die "$path: $!"; 900 or die "$path: $!";
626 901
627 my $source = 902 my $source =
628 "package $pkg; use strict; use utf8;\n" 903 "package $pkg; use strict; use utf8;\n"
629 . "#line 1 \"$path\"\n{\n" 904 . "#line 1 \"$path\"\n{\n"
630 . (do { local $/; <$fh> }) 905 . (do { local $/; <$fh> })
631 . "\n};\n1"; 906 . "\n};\n1";
632 907
633 eval $source 908 unless (eval $source) {
634 or die "$path: $@"; 909 my $msg = $@ ? "$path: $@\n"
635 910 : "extension disabled.\n";
636 push @exts, $pkg; 911 if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match
637 $ext_pkg{$base} = $pkg; 912 warn $@;
638 913 warn "mandatory extension failed to load, exiting.\n";
639# no strict 'refs'; 914 exit 1;
640# @{"$pkg\::ISA"} = ext::; 915 }
641 916 die $@;
642 register $base, $pkg;
643}
644
645sub unload_extension {
646 my ($pkg) = @_;
647
648 warn "removing extension $pkg\n";
649
650 # remove hooks
651 #TODO
652# for my $idx (0 .. $#PLUGIN_EVENT) {
653# delete $hook[$idx]{$pkg};
654# } 917 }
655 918
656 # remove commands 919 push @EXTS, $pkg;
657 for my $name (keys %command) {
658 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };
659
660 if (@cb) {
661 $command{$name} = \@cb;
662 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
663 } else {
664 delete $command{$name};
665 delete $COMMAND{"$name\000"};
666 }
667 }
668
669 # remove extcmds
670 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {
671 delete $extcmd{$name};
672 }
673
674 if (my $cb = $pkg->can ("unload")) {
675 eval {
676 $cb->($pkg);
677 1
678 } or warn "$pkg unloaded, but with errors: $@";
679 }
680
681 Symbol::delete_package $pkg;
682} 920}
683 921
684sub load_extensions { 922sub load_extensions {
685 my $LIBDIR = maps_directory "perl";
686
687 for my $ext (<$LIBDIR/*.ext>) { 923 for my $ext (<$LIBDIR/*.ext>) {
688 next unless -r $ext; 924 next unless -r $ext;
689 eval { 925 eval {
690 load_extension $ext; 926 load_extension $ext;
691 1 927 1
692 } or warn "$ext not loaded: $@"; 928 } or warn "$ext not loaded: $@";
693 } 929 }
694} 930}
695 931
696############################################################################# 932#############################################################################
697# extcmd framework, basically convert ext <msg>
698# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
699 933
700attach_to_players 934=head2 CORE EXTENSIONS
701 on_extcmd => sub { 935
936Functions and methods that extend core crossfire objects.
937
938=cut
939
940package cf::player;
941
942use Coro::AIO;
943
944=head3 cf::player
945
946=over 4
947
948=item cf::player::find $login
949
950Returns the given player object, loading it if necessary (might block).
951
952=cut
953
954sub playerdir($) {
955 cf::localdir
956 . "/"
957 . cf::playerdir
958 . "/"
959 . (ref $_[0] ? $_[0]->ob->name : $_[0])
960}
961
962sub path($) {
963 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
964
965 (playerdir $login) . "/$login.pl"
966}
967
968sub find_active($) {
969 $cf::PLAYER{$_[0]}
970 and $cf::PLAYER{$_[0]}->active
971 and $cf::PLAYER{$_[0]}
972}
973
974sub exists($) {
975 my ($login) = @_;
976
977 $cf::PLAYER{$login}
978 or cf::sync_job { !aio_stat path $login }
979}
980
981sub find($) {
982 return $cf::PLAYER{$_[0]} || do {
983 my $login = $_[0];
984
985 my $guard = cf::lock_acquire "user_find:$login";
986
987 $cf::PLAYER{$_[0]} || do {
988 my $pl = load_pl path $login
989 or return;
990 $cf::PLAYER{$login} = $pl
991 }
992 }
993}
994
995sub save($) {
996 my ($pl) = @_;
997
998 return if $pl->{deny_save};
999
1000 my $path = path $pl;
1001 my $guard = cf::lock_acquire "user_save:$path";
1002
1003 return if $pl->{deny_save};
1004
1005 aio_mkdir playerdir $pl, 0770;
1006 $pl->{last_save} = $cf::RUNTIME;
1007
1008 $pl->save_pl ($path);
1009 Coro::cede;
1010}
1011
1012sub new($) {
1013 my ($login) = @_;
1014
1015 my $self = create;
1016
1017 $self->ob->name ($login);
1018 $self->{deny_save} = 1;
1019
1020 $cf::PLAYER{$login} = $self;
1021
1022 $self
1023}
1024
1025=item $pl->quit_character
1026
1027Nukes the player without looking back. If logged in, the connection will
1028be destroyed. May block for a long time.
1029
1030=cut
1031
1032sub quit_character {
1033 my ($pl) = @_;
1034
1035 $pl->{deny_save} = 1;
1036 $pl->password ("*"); # this should lock out the player until we nuked the dir
1037
1038 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1039 $pl->deactivate;
1040 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1041 $pl->ns->destroy if $pl->ns;
1042
1043 my $path = playerdir $pl;
1044 my $temp = "$path~$cf::RUNTIME~deleting~";
1045 aio_rename $path, $temp;
1046 delete $cf::PLAYER{$pl->ob->name};
1047 $pl->destroy;
1048 IO::AIO::aio_rmtree $temp;
1049}
1050
1051=item cf::player::list_logins
1052
1053Returns am arrayref of all valid playernames in the system, can take a
1054while and may block, so not sync_job-capable, ever.
1055
1056=cut
1057
1058sub list_logins {
1059 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1060 or return [];
1061
1062 my @logins;
1063
1064 for my $login (@$dirs) {
1065 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1066 aio_read $fh, 0, 512, my $buf, 0 or next;
1067 $buf !~ /^password -------------$/m or next; # official not-valid tag
1068
1069 utf8::decode $login;
1070 push @logins, $login;
1071 }
1072
1073 \@logins
1074}
1075
1076=item $player->maps
1077
1078Returns an arrayref of map paths that are private for this
1079player. May block.
1080
1081=cut
1082
1083sub maps($) {
1084 my ($pl) = @_;
1085
1086 $pl = ref $pl ? $pl->ob->name : $pl;
1087
1088 my $files = aio_readdir playerdir $pl
1089 or return;
1090
1091 my @paths;
1092
1093 for (@$files) {
1094 utf8::decode $_;
1095 next if /\.(?:pl|pst)$/;
1096 next unless /^$PATH_SEP/o;
1097
1098 push @paths, cf::map::normalise "~$pl/$_";
1099 }
1100
1101 \@paths
1102}
1103
1104=item $player->ext_reply ($msgid, $msgtype, %msg)
1105
1106Sends an ext reply to the player.
1107
1108=cut
1109
1110sub ext_reply($$$%) {
1111 my ($self, $id, %msg) = @_;
1112
1113 $msg{msgid} = $id;
1114
1115 $self->send ("ext " . cf::to_json \%msg);
1116}
1117
1118package cf;
1119
1120=back
1121
1122
1123=head3 cf::map
1124
1125=over 4
1126
1127=cut
1128
1129package cf::map;
1130
1131use Fcntl;
1132use Coro::AIO;
1133
1134use overload
1135 '""' => \&as_string,
1136 fallback => 1;
1137
1138our $MAX_RESET = 3600;
1139our $DEFAULT_RESET = 3000;
1140
1141sub generate_random_map {
1142 my ($self, $rmp) = @_;
1143 # mit "rum" bekleckern, nicht
1144 $self->_create_random_map (
1145 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1146 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1147 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1148 $rmp->{exit_on_final_map},
1149 $rmp->{xsize}, $rmp->{ysize},
1150 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1151 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1152 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1153 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1154 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1155 (cf::region::find $rmp->{region}), $rmp->{custom}
1156 )
1157}
1158
1159=item cf::map->register ($regex, $prio)
1160
1161Register a handler for the map path matching the given regex at the
1162givne priority (higher is better, built-in handlers have priority 0, the
1163default).
1164
1165=cut
1166
1167sub register {
1168 my (undef, $regex, $prio) = @_;
1169 my $pkg = caller;
1170
1171 no strict;
1172 push @{"$pkg\::ISA"}, __PACKAGE__;
1173
1174 $EXT_MAP{$pkg} = [$prio, qr<$regex>];
1175}
1176
1177# also paths starting with '/'
1178$EXT_MAP{"cf::map"} = [0, qr{^(?=/)}];
1179
1180sub thawer_merge {
1181 my ($self, $merge) = @_;
1182
1183 # we have to keep some variables in memory intact
1184 local $self->{path};
1185 local $self->{load_path};
1186 local $self->{deny_save};
1187 local $self->{deny_reset};
1188
1189 $self->SUPER::thawer_merge ($merge);
1190}
1191
1192sub normalise {
1193 my ($path, $base) = @_;
1194
1195 $path = "$path"; # make sure its a string
1196
1197 $path =~ s/\.map$//;
1198
1199 # map plan:
1200 #
1201 # /! non-realised random map exit (special hack!)
1202 # {... are special paths that are not being touched
1203 # ?xxx/... are special absolute paths
1204 # ?random/... random maps
1205 # /... normal maps
1206 # ~user/... per-player map of a specific user
1207
1208 $path =~ s/$PATH_SEP/\//go;
1209
1210 # treat it as relative path if it starts with
1211 # something that looks reasonable
1212 if ($path =~ m{^(?:\./|\.\./|\w)}) {
1213 $base or Carp::carp "normalise called with relative path and no base: '$path'";
1214
1215 $base =~ s{[^/]+/?$}{};
1216 $path = "$base/$path";
1217 }
1218
1219 for ($path) {
1220 redo if s{//}{/};
1221 redo if s{/\.?/}{/};
1222 redo if s{/[^/]+/\.\./}{/};
1223 }
1224
1225 $path
1226}
1227
1228sub new_from_path {
1229 my (undef, $path, $base) = @_;
1230
1231 return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object
1232
1233 $path = normalise $path, $base;
1234
1235 for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) {
1236 if ($path =~ $EXT_MAP{$pkg}[1]) {
1237 my $self = bless cf::map::new, $pkg;
1238 $self->{path} = $path; $self->path ($path);
1239 $self->init; # pass $1 etc.
1240 return $self;
1241 }
1242 }
1243
1244 Carp::carp "unable to resolve path '$path' (base '$base').";
1245 ()
1246}
1247
1248sub init {
1249 my ($self) = @_;
1250
1251 $self
1252}
1253
1254sub as_string {
1255 my ($self) = @_;
1256
1257 "$self->{path}"
1258}
1259
1260# the displayed name, this is a one way mapping
1261sub visible_name {
1262 &as_string
1263}
1264
1265# the original (read-only) location
1266sub load_path {
1267 my ($self) = @_;
1268
1269 sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path}
1270}
1271
1272# the temporary/swap location
1273sub save_path {
1274 my ($self) = @_;
1275
1276 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1277 sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path
1278}
1279
1280# the unique path, undef == no special unique path
1281sub uniq_path {
1282 my ($self) = @_;
1283
1284 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
1285 sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path
1286}
1287
1288# and all this just because we cannot iterate over
1289# all maps in C++...
1290sub change_all_map_light {
1291 my ($change) = @_;
1292
1293 $_->change_map_light ($change)
1294 for grep $_->outdoor, values %cf::MAP;
1295}
1296
1297sub unlink_save {
1298 my ($self) = @_;
1299
1300 utf8::encode (my $save = $self->save_path);
1301 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;
1302 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";
1303
1304 #d#TODO remove .map and also nuke
1305 $save =~ s/\.map// or return;#d#
1306 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save;#d#
1307 IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst";#d#
1308}
1309
1310sub load_header_from($) {
1311 my ($self, $path) = @_;
1312
1313 utf8::encode $path;
1314 #aio_open $path, O_RDONLY, 0
1315 # or return;
1316
1317 $self->_load_header ($path)
1318 or return;
1319
1320 $self->{load_path} = $path;
1321
1322 1
1323}
1324
1325sub load_header_orig {
1326 my ($self) = @_;
1327
1328 $self->load_header_from ($self->load_path)
1329}
1330
1331sub load_header_temp {
1332 my ($self) = @_;
1333
1334 $self->load_header_from ($self->save_path)
1335}
1336
1337sub prepare_temp {
1338 my ($self) = @_;
1339
1340 $self->last_access ((delete $self->{last_access})
1341 || $cf::RUNTIME); #d#
1342 # safety
1343 $self->{instantiate_time} = $cf::RUNTIME
1344 if $self->{instantiate_time} > $cf::RUNTIME;
1345}
1346
1347sub prepare_orig {
1348 my ($self) = @_;
1349
1350 $self->{load_original} = 1;
1351 $self->{instantiate_time} = $cf::RUNTIME;
1352 $self->last_access ($cf::RUNTIME);
1353 $self->instantiate;
1354}
1355
1356sub load_header {
1357 my ($self) = @_;
1358
1359 if ($self->load_header_temp) {
1360 $self->prepare_temp;
1361 } else {
1362 $self->load_header_orig
1363 or return;
1364 $self->prepare_orig;
1365 }
1366
1367 1
1368}
1369
1370sub find;
1371sub find {
1372 my ($path, $origin) = @_;
1373
1374 $path = normalise $path, $origin && $origin->path;
1375
1376 cf::lock_wait "map_find:$path";
1377
1378 $cf::MAP{$path} || do {
1379 my $guard = cf::lock_acquire "map_find:$path";
1380 my $map = new_from_path cf::map $path
1381 or return;
1382
1383 $map->{last_save} = $cf::RUNTIME;
1384
1385 $map->load_header
1386 or return;
1387
1388 if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?)
1389 # doing this can freeze the server in a sync job, obviously
1390 #$cf::WAIT_FOR_TICK->wait;
1391 $map->reset;
1392 undef $guard;
1393 return find $path;
1394 }
1395
1396 $cf::MAP{$path} = $map
1397 }
1398}
1399
1400sub pre_load { }
1401sub post_load { }
1402
1403sub load {
1404 my ($self) = @_;
1405
1406 local $self->{deny_reset} = 1; # loading can take a long time
1407
1408 my $path = $self->{path};
1409 my $guard = cf::lock_acquire "map_load:$path";
1410
1411 return if $self->in_memory != cf::MAP_SWAPPED;
1412
1413 $self->in_memory (cf::MAP_LOADING);
1414
1415 $self->alloc;
1416
1417 $self->pre_load;
1418
1419 $self->_load_objects ($self->{load_path}, 1)
1420 or return;
1421
1422 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1423 if delete $self->{load_original};
1424
1425 if (my $uniq = $self->uniq_path) {
1426 utf8::encode $uniq;
1427 if (aio_open $uniq, O_RDONLY, 0) {
1428 $self->clear_unique_items;
1429 $self->_load_objects ($uniq, 0);
1430 }
1431 }
1432
1433 Coro::cede;
1434
1435 # now do the right thing for maps
1436 $self->link_multipart_objects;
1437
1438 unless ($self->{deny_activate}) {
1439 $self->decay_objects;
1440 $self->fix_auto_apply;
1441 $self->update_buttons;
1442 Coro::cede;
1443 $self->set_darkness_map;
1444 $self->difficulty ($self->estimate_difficulty)
1445 unless $self->difficulty;
1446 Coro::cede;
1447 $self->activate;
1448 }
1449
1450 $self->post_load;
1451
1452 $self->in_memory (cf::MAP_IN_MEMORY);
1453}
1454
1455sub customise_for {
702 my ($pl, $buf) = @_; 1456 my ($self, $ob) = @_;
703 1457
704 my $msg = eval { from_json $buf }; 1458 return find "~" . $ob->name . "/" . $self->{path}
1459 if $self->per_player;
705 1460
706 if (ref $msg) { 1461 $self
707 if (my $cb = $extcmd{$msg->{msgtype}}) { 1462}
708 if (my %reply = $cb->[0]->($pl, $msg)) { 1463
709 $pl->ext_reply ($msg->{msgid}, %reply); 1464# find and load all maps in the 3x3 area around a map
710 } 1465sub load_diag {
1466 my ($map) = @_;
1467
1468 my @diag; # diagonal neighbours
1469
1470 for (0 .. 3) {
1471 my $neigh = $map->tile_path ($_)
1472 or next;
1473 $neigh = find $neigh, $map
1474 or next;
1475 $neigh->load;
1476
1477 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1478 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1479 }
1480
1481 for (@diag) {
1482 my $neigh = find @$_
1483 or next;
1484 $neigh->load;
1485 }
1486}
1487
1488sub find_sync {
1489 my ($path, $origin) = @_;
1490
1491 cf::sync_job { find $path, $origin }
1492}
1493
1494sub do_load_sync {
1495 my ($map) = @_;
1496
1497 cf::sync_job { $map->load };
1498}
1499
1500our %MAP_PREFETCH;
1501our $MAP_PREFETCHER = undef;
1502
1503sub find_async {
1504 my ($path, $origin) = @_;
1505
1506 $path = normalise $path, $origin && $origin->{path};
1507
1508 if (my $map = $cf::MAP{$path}) {
1509 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1510 }
1511
1512 undef $MAP_PREFETCH{$path};
1513 $MAP_PREFETCHER ||= cf::async {
1514 while (%MAP_PREFETCH) {
1515 for my $path (keys %MAP_PREFETCH) {
1516 my $map = find $path
1517 or next;
1518 $map->load;
1519
1520 delete $MAP_PREFETCH{$path};
711 } 1521 }
1522 }
1523 undef $MAP_PREFETCHER;
1524 };
1525 $MAP_PREFETCHER->prio (6);
1526
1527 ()
1528}
1529
1530sub save {
1531 my ($self) = @_;
1532
1533 my $lock = cf::lock_acquire "map_data:" . $self->path;
1534
1535 $self->{last_save} = $cf::RUNTIME;
1536
1537 return unless $self->dirty;
1538
1539 my $save = $self->save_path; utf8::encode $save;
1540 my $uniq = $self->uniq_path; utf8::encode $uniq;
1541
1542 $self->{load_path} = $save;
1543
1544 return if $self->{deny_save};
1545
1546 local $self->{last_access} = $self->last_access;#d#
1547
1548 cf::async {
1549 $_->contr->save for $self->players;
1550 };
1551
1552 if ($uniq) {
1553 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1554 $self->_save_objects ($uniq, cf::IO_UNIQUES);
712 } else { 1555 } else {
713 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 1556 $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
714 }
715
716 cf::override;
717 }, 1557 }
718; 1558}
719 1559
720############################################################################# 1560sub swap_out {
721# load/save/clean perl data associated with a map
722
723*cf::mapsupport::on_clean = sub {
724 my ($map) = @_; 1561 my ($self) = @_;
725 1562
726 my $path = $map->tmpname; 1563 # save first because save cedes
727 defined $path or return; 1564 $self->save;
728 1565
729 unlink "$path.pst"; 1566 my $lock = cf::lock_acquire "map_data:" . $self->path;
730};
731 1567
732attach_to_maps prio => -10000, package => cf::mapsupport::; 1568 return if $self->players;
1569 return if $self->in_memory != cf::MAP_IN_MEMORY;
1570 return if $self->{deny_save};
733 1571
734############################################################################# 1572 $self->clear;
735# load/save perl data associated with player->ob objects 1573 $self->in_memory (cf::MAP_SWAPPED);
736
737sub all_objects(@) {
738 @_, map all_objects ($_->inv), @_
739} 1574}
740 1575
741# TODO: compatibility cruft, remove when no longer needed 1576sub reset_at {
742attach_to_players 1577 my ($self) = @_;
743 on_load => sub {
744 my ($pl, $path) = @_;
745 1578
746 for my $o (all_objects $pl->ob) { 1579 # TODO: safety, remove and allow resettable per-player maps
747 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1580 return 1e99 if $self->isa ("ext::map_per_player");#d#
748 $o->set_ob_key_value ("_perl_data"); 1581 return 1e99 if $self->{deny_reset};
749 1582
750 %$o = %{ Storable::thaw pack "H*", $value }; 1583 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
751 } 1584 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
752 } 1585
1586 $time + $to
1587}
1588
1589sub should_reset {
1590 my ($self) = @_;
1591
1592 $self->reset_at <= $cf::RUNTIME
1593}
1594
1595sub reset {
1596 my ($self) = @_;
1597
1598 my $lock = cf::lock_acquire "map_data:$self->{path}";
1599
1600 return if $self->players;
1601 return if $self->isa ("ext::map_per_player");#d#
1602
1603 warn "resetting map ", $self->path;#d#
1604
1605 delete $cf::MAP{$self->path};
1606
1607 $self->in_memory (cf::MAP_SWAPPED);
1608 $self->clear;
1609
1610 $_->clear_links_to ($self) for values %cf::MAP;
1611
1612 $self->unlink_save;
1613 $self->destroy;
1614}
1615
1616my $nuke_counter = "aaaa";
1617
1618sub nuke {
1619 my ($self) = @_;
1620
1621 delete $cf::MAP{$self->path};
1622
1623 $self->unlink_save;
1624
1625 bless $self, "cf::map";
1626 delete $self->{deny_reset};
1627 $self->{deny_save} = 1;
1628 $self->reset_timeout (1);
1629 $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++));
1630
1631 $cf::MAP{$self->path} = $self;
1632
1633 $self->reset; # polite request, might not happen
1634}
1635
1636=item cf::map::unique_maps
1637
1638Returns an arrayref of paths of all shared maps that have
1639instantiated unique items. May block.
1640
1641=cut
1642
1643sub unique_maps() {
1644 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1645 or return;
1646
1647 my @paths;
1648
1649 for (@$files) {
1650 utf8::decode $_;
1651 next if /\.pst$/;
1652 next unless /^$PATH_SEP/o;
1653
1654 push @paths, cf::map::normalise $_;
753 }, 1655 }
754;
755 1656
756############################################################################# 1657 \@paths
1658}
757 1659
758=head2 CORE EXTENSIONS 1660package cf;
759 1661
760Functions and methods that extend core crossfire objects. 1662=back
1663
1664=head3 cf::object
1665
1666=cut
1667
1668package cf::object;
761 1669
762=over 4 1670=over 4
763 1671
764=item cf::player::exists $login 1672=item $ob->inv_recursive
765 1673
766Returns true when the given account exists. 1674Returns the inventory of the object _and_ their inventories, recursively.
767 1675
768=cut 1676=cut
769 1677
770sub cf::player::exists($) { 1678sub inv_recursive_;
771 cf::player::find $_[0] 1679sub inv_recursive_ {
772 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1680 map { $_, inv_recursive_ $_->inv } @_
773} 1681}
774 1682
1683sub inv_recursive {
1684 inv_recursive_ inv $_[0]
1685}
1686
1687package cf;
1688
1689=back
1690
1691=head3 cf::object::player
1692
1693=over 4
1694
775=item $player->reply ($npc, $msg[, $flags]) 1695=item $player_object->reply ($npc, $msg[, $flags])
776 1696
777Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1697Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
778can be C<undef>. Does the right thing when the player is currently in a 1698can be C<undef>. Does the right thing when the player is currently in a
779dialogue with the given NPC character. 1699dialogue with the given NPC character.
780 1700
781=cut 1701=cut
782 1702
783# rough implementation of a future "reply" method that works 1703# rough implementation of a future "reply" method that works
784# with dialog boxes. 1704# with dialog boxes.
1705#TODO: the first argument must go, split into a $npc->reply_to ( method
785sub cf::object::player::reply($$$;$) { 1706sub cf::object::player::reply($$$;$) {
786 my ($self, $npc, $msg, $flags) = @_; 1707 my ($self, $npc, $msg, $flags) = @_;
787 1708
788 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1709 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
789 1710
793 $msg = $npc->name . " says: $msg" if $npc; 1714 $msg = $npc->name . " says: $msg" if $npc;
794 $self->message ($msg, $flags); 1715 $self->message ($msg, $flags);
795 } 1716 }
796} 1717}
797 1718
798=item $player->ext_reply ($msgid, $msgtype, %msg) 1719=item $player_object->may ("access")
799 1720
800Sends an ext reply to the player. 1721Returns wether the given player is authorized to access resource "access"
1722(e.g. "command_wizcast").
801 1723
802=cut 1724=cut
803 1725
804sub cf::player::ext_reply($$$%) { 1726sub cf::object::player::may {
1727 my ($self, $access) = @_;
1728
1729 $self->flag (cf::FLAG_WIZ) ||
1730 (ref $cf::CFG{"may_$access"}
1731 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1732 : $cf::CFG{"may_$access"})
1733}
1734
1735=item $player_object->enter_link
1736
1737Freezes the player and moves him/her to a special map (C<{link}>).
1738
1739The player should be reasonably safe there for short amounts of time. You
1740I<MUST> call C<leave_link> as soon as possible, though.
1741
1742Will never block.
1743
1744=item $player_object->leave_link ($map, $x, $y)
1745
1746Moves the player out of the special C<{link}> map onto the specified
1747map. If the map is not valid (or omitted), the player will be moved back
1748to the location he/she was before the call to C<enter_link>, or, if that
1749fails, to the emergency map position.
1750
1751Might block.
1752
1753=cut
1754
1755sub link_map {
1756 unless ($LINK_MAP) {
1757 $LINK_MAP = cf::map::find "{link}"
1758 or cf::cleanup "FATAL: unable to provide {link} map, exiting.";
1759 $LINK_MAP->load;
1760 }
1761
1762 $LINK_MAP
1763}
1764
1765sub cf::object::player::enter_link {
1766 my ($self) = @_;
1767
1768 $self->deactivate_recursive;
1769
1770 return if UNIVERSAL::isa $self->map, "ext::map_link";
1771
1772 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1773 if $self->map;
1774
1775 $self->enter_map ($LINK_MAP || link_map, 10, 10);
1776}
1777
1778sub cf::object::player::leave_link {
1779 my ($self, $map, $x, $y) = @_;
1780
1781 my $link_pos = delete $self->{_link_pos};
1782
1783 unless ($map) {
1784 # restore original map position
1785 ($map, $x, $y) = @{ $link_pos || [] };
1786 $map = cf::map::find $map;
1787
1788 unless ($map) {
1789 ($map, $x, $y) = @$EMERGENCY_POSITION;
1790 $map = cf::map::find $map
1791 or die "FATAL: cannot load emergency map\n";
1792 }
1793 }
1794
1795 ($x, $y) = (-1, -1)
1796 unless (defined $x) && (defined $y);
1797
1798 # use -1 or undef as default coordinates, not 0, 0
1799 ($x, $y) = ($map->enter_x, $map->enter_y)
1800 if $x <=0 && $y <= 0;
1801
1802 $map->load;
1803 $map->load_diag;
1804
1805 return unless $self->contr->active;
1806 $self->activate_recursive;
1807 $self->enter_map ($map, $x, $y);
1808}
1809
1810cf::player->attach (
1811 on_logout => sub {
1812 my ($pl) = @_;
1813
1814 # abort map switching before logout
1815 if ($pl->ob->{_link_pos}) {
1816 cf::sync_job {
1817 $pl->ob->leave_link
1818 };
1819 }
1820 },
1821 on_login => sub {
1822 my ($pl) = @_;
1823
1824 # try to abort aborted map switching on player login :)
1825 # should happen only on crashes
1826 if ($pl->ob->{_link_pos}) {
1827 $pl->ob->enter_link;
1828 (async {
1829 # we need this sleep as the login has a concurrent enter_exit running
1830 # and this sleep increases chances of the player not ending up in scorn
1831 $pl->ob->reply (undef,
1832 "There was an internal problem at your last logout, "
1833 . "the server will try to bring you to your intended destination in a second.",
1834 cf::NDI_RED);
1835 Coro::Timer::sleep 1;
1836 $pl->ob->leave_link;
1837 })->prio (2);
1838 }
1839 },
1840);
1841
1842=item $player_object->goto ($path, $x, $y)
1843
1844=cut
1845
1846sub cf::object::player::goto {
1847 my ($self, $path, $x, $y) = @_;
1848
1849 $self->enter_link;
1850
1851 (async {
1852 my $map = eval {
1853 my $map = cf::map::find $path;
1854 $map = $map->customise_for ($self) if $map;
1855 $map
1856 } or
1857 $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1858
1859 $self->leave_link ($map, $x, $y);
1860 })->prio (1);
1861}
1862
1863=item $player_object->enter_exit ($exit_object)
1864
1865=cut
1866
1867sub parse_random_map_params {
1868 my ($spec) = @_;
1869
1870 my $rmp = { # defaults
1871 xsize => (cf::rndm 15, 40),
1872 ysize => (cf::rndm 15, 40),
1873 symmetry => (cf::rndm 1, cf::SYMMETRY_XY),
1874 #layout => string,
1875 };
1876
1877 for (split /\n/, $spec) {
1878 my ($k, $v) = split /\s+/, $_, 2;
1879
1880 $rmp->{lc $k} = $v if (length $k) && (length $v);
1881 }
1882
1883 $rmp
1884}
1885
1886sub prepare_random_map {
1887 my ($exit) = @_;
1888
1889 my $guard = cf::lock_acquire "exit_prepare:$exit";
1890
1891 # all this does is basically replace the /! path by
1892 # a new random map path (?random/...) with a seed
1893 # that depends on the exit object
1894
1895 my $rmp = parse_random_map_params $exit->msg;
1896
1897 if ($exit->map) {
1898 $rmp->{region} = $exit->region->name;
1899 $rmp->{origin_map} = $exit->map->path;
1900 $rmp->{origin_x} = $exit->x;
1901 $rmp->{origin_y} = $exit->y;
1902 }
1903
1904 $rmp->{random_seed} ||= $exit->random_seed;
1905
1906 my $data = cf::to_json $rmp;
1907 my $md5 = Digest::MD5::md5_hex $data;
1908 my $meta = "$cf::RANDOM_MAPS/$md5.meta";
1909
1910 if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) {
1911 aio_write $fh, 0, (length $data), $data, 0;
1912 undef $fh;
1913 aio_rename "$meta~", $meta;
1914
1915 $exit->slaying ("?random/$md5");
1916 $exit->msg (undef);
1917 }
1918}
1919
1920sub cf::object::player::enter_exit {
805 my ($self, $id, %msg) = @_; 1921 my ($self, $exit) = @_;
806 1922
807 $msg{msgid} = $id; 1923 return unless $self->type == cf::PLAYER;
808 1924
809 $self->send ("ext " . to_json \%msg); 1925 if ($exit->slaying eq "/!") {
1926 #TODO: this should de-fi-ni-te-ly not be a sync-job
1927 cf::sync_job { prepare_random_map $exit };
1928 }
1929
1930 my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path;
1931 my $hp = $exit->stats->hp;
1932 my $sp = $exit->stats->sp;
1933
1934 $self->enter_link;
1935
1936 (async {
1937 $self->deactivate_recursive; # just to be sure
1938 unless (eval {
1939 $self->goto ($slaying, $hp, $sp);
1940
1941 1;
1942 }) {
1943 $self->message ("Something went wrong deep within the crossfire server. "
1944 . "I'll try to bring you back to the map you were before. "
1945 . "Please report this to the dungeon master!",
1946 cf::NDI_UNIQUE | cf::NDI_RED);
1947
1948 warn "ERROR in enter_exit: $@";
1949 $self->leave_link;
1950 }
1951 })->prio (1);
810} 1952}
1953
1954=head3 cf::client
1955
1956=over 4
1957
1958=item $client->send_drawinfo ($text, $flags)
1959
1960Sends a drawinfo packet to the client. Circumvents output buffering so
1961should not be used under normal circumstances.
1962
1963=cut
1964
1965sub cf::client::send_drawinfo {
1966 my ($self, $text, $flags) = @_;
1967
1968 utf8::encode $text;
1969 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1970}
1971
1972
1973=item $success = $client->query ($flags, "text", \&cb)
1974
1975Queues a query to the client, calling the given callback with
1976the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1977C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1978
1979Queries can fail, so check the return code. Or don't, as queries will become
1980reliable at some point in the future.
1981
1982=cut
1983
1984sub cf::client::query {
1985 my ($self, $flags, $text, $cb) = @_;
1986
1987 return unless $self->state == ST_PLAYING
1988 || $self->state == ST_SETUP
1989 || $self->state == ST_CUSTOM;
1990
1991 $self->state (ST_CUSTOM);
1992
1993 utf8::encode $text;
1994 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1995
1996 $self->send_packet ($self->{query_queue}[0][0])
1997 if @{ $self->{query_queue} } == 1;
1998}
1999
2000cf::client->attach (
2001 on_reply => sub {
2002 my ($ns, $msg) = @_;
2003
2004 # this weird shuffling is so that direct followup queries
2005 # get handled first
2006 my $queue = delete $ns->{query_queue}
2007 or return; # be conservative, not sure how that can happen, but we saw a crash here
2008
2009 (shift @$queue)->[1]->($msg);
2010 return unless $ns->valid; # temporary(?) workaround for callback destroying socket
2011
2012 push @{ $ns->{query_queue} }, @$queue;
2013
2014 if (@{ $ns->{query_queue} } == @$queue) {
2015 if (@$queue) {
2016 $ns->send_packet ($ns->{query_queue}[0][0]);
2017 } else {
2018 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2019 }
2020 }
2021 },
2022);
2023
2024=item $client->async (\&cb)
2025
2026Create a new coroutine, running the specified callback. The coroutine will
2027be automatically cancelled when the client gets destroyed (e.g. on logout,
2028or loss of connection).
2029
2030=cut
2031
2032sub cf::client::async {
2033 my ($self, $cb) = @_;
2034
2035 my $coro = &Coro::async ($cb);
2036
2037 $coro->on_destroy (sub {
2038 delete $self->{_coro}{$coro+0};
2039 });
2040
2041 $self->{_coro}{$coro+0} = $coro;
2042
2043 $coro
2044}
2045
2046cf::client->attach (
2047 on_destroy => sub {
2048 my ($ns) = @_;
2049
2050 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2051 },
2052);
811 2053
812=back 2054=back
813 2055
814=cut
815
816#############################################################################
817 2056
818=head2 SAFE SCRIPTING 2057=head2 SAFE SCRIPTING
819 2058
820Functions that provide a safe environment to compile and execute 2059Functions that provide a safe environment to compile and execute
821snippets of perl code without them endangering the safety of the server 2060snippets of perl code without them endangering the safety of the server
822itself. Looping constructs, I/O operators and other built-in functionality 2061itself. Looping constructs, I/O operators and other built-in functionality
823is not available in the safe scripting environment, and the number of 2062is not available in the safe scripting environment, and the number of
824functions and methods that cna be called is greatly reduced. 2063functions and methods that can be called is greatly reduced.
825 2064
826=cut 2065=cut
827 2066
828our $safe = new Safe "safe"; 2067our $safe = new Safe "safe";
829our $safe_hole = new Safe::Hole; 2068our $safe_hole = new Safe::Hole;
836 2075
837=pod 2076=pod
838 2077
839The following fucntions and emthods are available within a safe environment: 2078The following fucntions and emthods are available within a safe environment:
840 2079
841 cf::object contr pay_amount pay_player 2080 cf::object contr pay_amount pay_player map
842 cf::object::player player 2081 cf::object::player player
843 cf::player peaceful 2082 cf::player peaceful
2083 cf::map trigger
844 2084
845=cut 2085=cut
846 2086
847for ( 2087for (
848 ["cf::object" => qw(contr pay_amount pay_player)], 2088 ["cf::object" => qw(contr pay_amount pay_player map)],
849 ["cf::object::player" => qw(player)], 2089 ["cf::object::player" => qw(player)],
850 ["cf::player" => qw(peaceful)], 2090 ["cf::player" => qw(peaceful)],
2091 ["cf::map" => qw(trigger)],
851) { 2092) {
852 no strict 'refs'; 2093 no strict 'refs';
853 my ($pkg, @funs) = @$_; 2094 my ($pkg, @funs) = @$_;
854 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2095 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
855 for @funs; 2096 for @funs;
965 2206
966Immediately write the database to disk I<if it is dirty>. 2207Immediately write the database to disk I<if it is dirty>.
967 2208
968=cut 2209=cut
969 2210
2211our $DB;
2212
970{ 2213{
971 my $db;
972 my $path = cf::localdir . "/database.pst"; 2214 my $path = cf::localdir . "/database.pst";
973 2215
974 sub db_load() { 2216 sub db_load() {
975 warn "loading database $path\n";#d# remove later
976 $db = stat $path ? Storable::retrieve $path : { }; 2217 $DB = stat $path ? Storable::retrieve $path : { };
977 } 2218 }
978 2219
979 my $pid; 2220 my $pid;
980 2221
981 sub db_save() { 2222 sub db_save() {
982 warn "saving database $path\n";#d# remove later
983 waitpid $pid, 0 if $pid; 2223 waitpid $pid, 0 if $pid;
984 if (0 == ($pid = fork)) { 2224 if (0 == ($pid = fork)) {
985 $db->{_meta}{version} = 1; 2225 $DB->{_meta}{version} = 1;
986 Storable::nstore $db, "$path~"; 2226 Storable::nstore $DB, "$path~";
987 rename "$path~", $path; 2227 rename "$path~", $path;
988 cf::_exit 0 if defined $pid; 2228 cf::_exit 0 if defined $pid;
989 } 2229 }
990 } 2230 }
991 2231
994 sub db_sync() { 2234 sub db_sync() {
995 db_save if $dirty; 2235 db_save if $dirty;
996 undef $dirty; 2236 undef $dirty;
997 } 2237 }
998 2238
999 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { 2239 my $idle = Event->idle (
1000 db_sync; 2240 reentrant => 0,
2241 min => 10,
2242 max => 20,
2243 repeat => 0,
2244 data => WF_AUTOCANCEL,
2245 cb => \&db_sync,
1001 }); 2246 );
1002 2247
1003 sub db_dirty() { 2248 sub db_dirty() {
1004 $dirty = 1; 2249 $dirty = 1;
1005 $idle->start; 2250 $idle->start;
1006 } 2251 }
1007 2252
1008 sub db_get($;$) { 2253 sub db_get($;$) {
1009 @_ >= 2 2254 @_ >= 2
1010 ? $db->{$_[0]}{$_[1]} 2255 ? $DB->{$_[0]}{$_[1]}
1011 : ($db->{$_[0]} ||= { }) 2256 : ($DB->{$_[0]} ||= { })
1012 } 2257 }
1013 2258
1014 sub db_put($$;$) { 2259 sub db_put($$;$) {
1015 if (@_ >= 3) { 2260 if (@_ >= 3) {
1016 $db->{$_[0]}{$_[1]} = $_[2]; 2261 $DB->{$_[0]}{$_[1]} = $_[2];
1017 } else { 2262 } else {
1018 $db->{$_[0]} = $_[1]; 2263 $DB->{$_[0]} = $_[1];
1019 } 2264 }
1020 db_dirty; 2265 db_dirty;
1021 } 2266 }
1022 2267
1023 attach_global 2268 cf::global->attach (
1024 prio => 10000, 2269 prio => 10000,
1025 on_cleanup => sub { 2270 on_cleanup => sub {
1026 db_sync; 2271 db_sync;
1027 }, 2272 },
1028 ; 2273 );
1029} 2274}
1030 2275
1031############################################################################# 2276#############################################################################
1032# the server's main() 2277# the server's init and main functions
1033 2278
1034sub load_cfg { 2279sub load_resources {
2280 load_regions sprintf "%s/%s/regions", cf::datadir, cf::mapdir
2281 or die "unable to load regions file\n";#d#
2282}
2283
2284sub cfg_load {
1035 open my $fh, "<:utf8", cf::confdir . "/config" 2285 open my $fh, "<:utf8", cf::confdir . "/config"
1036 or return; 2286 or return;
1037 2287
1038 local $/; 2288 local $/;
1039 *CFG = YAML::Syck::Load <$fh>; 2289 *CFG = YAML::Syck::Load <$fh>;
1040 2290
1041 use Data::Dumper; warn Dumper \%CFG; 2291 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2292
2293 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2294 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2295
2296 if (exists $CFG{mlockall}) {
2297 eval {
2298 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2299 and die "WARNING: m(un)lockall failed: $!\n";
2300 };
2301 warn $@ if $@;
2302 }
2303}
2304
2305sub init {
2306 load_resources;
1042} 2307}
1043 2308
1044sub main { 2309sub main {
1045 load_cfg; 2310 # we must not ever block the main coroutine
2311 local $Coro::idle = sub {
2312 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2313 (async {
2314 Event::one_event;
2315 })->prio (Coro::PRIO_MAX);
2316 };
2317
2318 cfg_load;
1046 db_load; 2319 db_load;
1047 load_extensions; 2320 load_extensions;
2321
2322 $TICK_WATCHER->start;
1048 Event::loop; 2323 Event::loop;
1049} 2324}
1050 2325
1051############################################################################# 2326#############################################################################
1052# initialisation 2327# initialisation and cleanup
1053 2328
2329# install some emergency cleanup handlers
2330BEGIN {
2331 for my $signal (qw(INT HUP TERM)) {
2332 Event->signal (
2333 reentrant => 0,
2334 data => WF_AUTOCANCEL,
2335 signal => $signal,
2336 prio => 0,
2337 cb => sub {
2338 cf::cleanup "SIG$signal";
2339 },
2340 );
2341 }
2342}
2343
2344sub emergency_save() {
2345 my $freeze_guard = cf::freeze_mainloop;
2346
2347 warn "enter emergency perl save\n";
2348
2349 cf::sync_job {
2350 # use a peculiar iteration method to avoid tripping on perl
2351 # refcount bugs in for. also avoids problems with players
2352 # and maps saved/destroyed asynchronously.
2353 warn "begin emergency player save\n";
2354 for my $login (keys %cf::PLAYER) {
2355 my $pl = $cf::PLAYER{$login} or next;
2356 $pl->valid or next;
2357 $pl->save;
2358 }
2359 warn "end emergency player save\n";
2360
2361 warn "begin emergency map save\n";
2362 for my $path (keys %cf::MAP) {
2363 my $map = $cf::MAP{$path} or next;
2364 $map->valid or next;
2365 $map->save;
2366 }
2367 warn "end emergency map save\n";
2368 };
2369
2370 warn "leave emergency perl save\n";
2371}
2372
1054sub _perl_reload(&) { 2373sub reload() {
1055 my ($msg) = @_; 2374 # can/must only be called in main
2375 if ($Coro::current != $Coro::main) {
2376 warn "can only reload from main coroutine";
2377 return;
2378 }
1056 2379
1057 $msg->("reloading..."); 2380 warn "reloading...";
2381
2382 warn "cancelling server ticker";
2383 $TICK_WATCHER->cancel;
2384
2385 cf::emergency_save;
1058 2386
1059 eval { 2387 eval {
1060 # cancel all watchers 2388 # if anything goes wrong in here, we should simply crash as we already saved
2389
2390 warn "syncing database to disk";
2391 cf::db_sync;
2392
2393 warn "cancelling all WF_AUTOCANCEL watchers";
1061 $_->cancel for Event::all_watchers; 2394 for (Event::all_watchers) {
2395 $_->cancel if $_->data & WF_AUTOCANCEL;
2396 }
1062 2397
1063 # unload all extensions 2398 warn "flushing outstanding aio requests";
1064 for (@exts) { 2399 for (;;) {
1065 $msg->("unloading <$_>"); 2400 IO::AIO::flush;
1066 unload_extension $_; 2401 Coro::cede;
2402 last unless IO::AIO::nreqs;
2403 warn "iterate...";
2404 }
2405
2406 warn "cancelling all extension coros";
2407 $_->cancel for values %EXT_CORO;
2408 %EXT_CORO = ();
2409
2410 warn "removing commands";
2411 %COMMAND = ();
2412
2413 warn "removing ext commands";
2414 %EXTCMD = ();
2415
2416 warn "unloading/nuking all extensions";
2417 for my $pkg (@EXTS) {
2418 warn "... unloading $pkg";
2419
2420 if (my $cb = $pkg->can ("unload")) {
2421 eval {
2422 $cb->($pkg);
2423 1
2424 } or warn "$pkg unloaded, but with errors: $@";
1067 } 2425 }
1068 2426
2427 warn "... nuking $pkg";
2428 Symbol::delete_package $pkg;
2429 }
2430
1069 # unload all modules loaded from $LIBDIR 2431 warn "unloading all perl modules loaded from $LIBDIR";
1070 while (my ($k, $v) = each %INC) { 2432 while (my ($k, $v) = each %INC) {
1071 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2433 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1072 2434
1073 $msg->("removing <$k>"); 2435 warn "... unloading $k";
1074 delete $INC{$k}; 2436 delete $INC{$k};
1075 2437
1076 $k =~ s/\.pm$//; 2438 $k =~ s/\.pm$//;
1077 $k =~ s/\//::/g; 2439 $k =~ s/\//::/g;
1078 2440
1081 } 2443 }
1082 2444
1083 Symbol::delete_package $k; 2445 Symbol::delete_package $k;
1084 } 2446 }
1085 2447
1086 # sync database to disk
1087 cf::db_sync;
1088
1089 # get rid of safe::, as good as possible 2448 warn "getting rid of safe::, as good as possible";
1090 Symbol::delete_package "safe::$_" 2449 Symbol::delete_package "safe::$_"
1091 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2450 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1092 2451
1093 # remove register_script_function callbacks
1094 # TODO
1095
1096 # unload cf.pm "a bit" 2452 warn "unloading cf.pm \"a bit\"";
1097 delete $INC{"cf.pm"}; 2453 delete $INC{"cf.pm"};
1098 2454
1099 # don't, removes xs symbols, too, 2455 # don't, removes xs symbols, too,
1100 # and global variables created in xs 2456 # and global variables created in xs
1101 #Symbol::delete_package __PACKAGE__; 2457 #Symbol::delete_package __PACKAGE__;
1102 2458
1103 # reload cf.pm 2459 warn "unload completed, starting to reload now";
2460
1104 $msg->("reloading cf.pm"); 2461 warn "reloading cf.pm";
1105 require cf; 2462 require cf;
2463 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1106 2464
1107 # load database again 2465 warn "loading config and database again";
2466 cf::cfg_load;
1108 cf::db_load; 2467 cf::db_load;
1109 2468
1110 # load extensions 2469 warn "loading extensions";
1111 $msg->("load extensions");
1112 cf::load_extensions; 2470 cf::load_extensions;
1113 2471
1114 # reattach attachments to objects 2472 warn "reattaching attachments to objects/players";
1115 $msg->("reattach");
1116 _global_reattach; 2473 _global_reattach;
2474 warn "reattaching attachments to maps";
2475 reattach $_ for values %MAP;
2476
2477 warn "loading reloadable resources";
2478 load_resources;
2479
2480 warn "restarting server ticker";
2481
2482 $TICK_WATCHER->start;
1117 }; 2483 };
1118 $msg->($@) if $@;
1119 2484
1120 $msg->("reloaded"); 2485 if ($@) {
2486 warn $@;
2487 warn "error while reloading, exiting.";
2488 exit 1;
2489 }
2490
2491 warn "reloaded";
1121}; 2492};
1122 2493
1123sub perl_reload() { 2494our $RELOAD_WATCHER; # used only during reload
1124 _perl_reload {
1125 warn $_[0];
1126 print "$_[0]\n";
1127 };
1128}
1129 2495
1130register_command "perl-reload", 0, sub { 2496register_command "reload" => sub {
1131 my ($who, $arg) = @_; 2497 my ($who, $arg) = @_;
1132 2498
1133 if ($who->flag (FLAG_WIZ)) { 2499 if ($who->flag (FLAG_WIZ)) {
1134 _perl_reload { 2500 $who->message ("reloading server.");
1135 warn $_[0]; 2501
1136 $who->message ($_[0]); 2502 # doing reload synchronously and two reloads happen back-to-back,
2503 # coro crashes during coro_state_free->destroy here.
2504
2505 $RELOAD_WATCHER ||= Event->timer (
2506 reentrant => 0,
2507 after => 0,
2508 data => WF_AUTOCANCEL,
2509 cb => sub {
2510 reload;
2511 undef $RELOAD_WATCHER;
2512 },
1137 }; 2513 );
1138 } 2514 }
1139}; 2515};
1140 2516
1141register "<global>", __PACKAGE__;
1142
1143unshift @INC, $LIBDIR; 2517unshift @INC, $LIBDIR;
1144 2518
2519my $bug_warning = 0;
2520
1145$TICK_WATCHER = Event->timer ( 2521$TICK_WATCHER = Event->timer (
2522 reentrant => 0,
2523 parked => 1,
1146 prio => 1, 2524 prio => 0,
1147 at => $NEXT_TICK || 1, 2525 at => $NEXT_TICK || $TICK,
2526 data => WF_AUTOCANCEL,
1148 cb => sub { 2527 cb => sub {
2528 if ($Coro::current != $Coro::main) {
2529 Carp::cluck "major BUG: server tick called outside of main coro, skipping it"
2530 unless ++$bug_warning > 10;
2531 return;
2532 }
2533
2534 $NOW = Event::time;
2535
1149 cf::server_tick; # one server iteration 2536 cf::server_tick; # one server iteration
1150 2537 $RUNTIME += $TICK;
1151 my $NOW = Event::time;
1152 $NEXT_TICK += $TICK; 2538 $NEXT_TICK += $TICK;
1153 2539
2540 $WAIT_FOR_TICK->broadcast;
2541 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2542
2543 Event::sweep;
2544 Coro::cede_notself;
2545
2546# my $AFTER = Event::time;
2547# warn $AFTER - $NOW;#d#
2548
1154 # if we are delayed by four ticks, skip them all 2549 # if we are delayed by four ticks or more, skip them all
1155 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2550 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1156 2551
1157 $TICK_WATCHER->at ($NEXT_TICK); 2552 $TICK_WATCHER->at ($NEXT_TICK);
1158 $TICK_WATCHER->start; 2553 $TICK_WATCHER->start;
1159 }, 2554 },
1160); 2555);
1161 2556
2557IO::AIO::max_poll_time $TICK * 0.1;
2558
2559undef $Coro::AIO::WATCHER;
2560$AIO_POLL_WATCHER = Event->io (
2561 reentrant => 0,
2562 fd => IO::AIO::poll_fileno,
2563 poll => 'r',
2564 prio => 6,
2565 data => WF_AUTOCANCEL,
2566 cb => \&IO::AIO::poll_cb,
2567);
2568
2569$WRITE_RUNTIME_WATCHER = Event->timer (
2570 reentrant => 0,
2571 data => WF_AUTOCANCEL,
2572 after => 1,
2573 interval => 10,
2574 prio => 6, # keep it lowest so it acts like a watchdog
2575 cb => Coro::unblock_sub {
2576 write_runtime
2577 or warn "ERROR: unable to write runtime file: $!";
2578 },
2579);
2580
2581END { cf::emergency_save }
2582
11621 25831
1163 2584

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines