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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines