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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines