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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines