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.92 by root, Thu Dec 21 06:42:28 2006 UTC vs.
Revision 1.115 by root, Mon Jan 1 16:50:10 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.3;
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18use Coro::AIO;
19
20use Digest::MD5;
21use Fcntl;
10use IO::AIO (); 22use IO::AIO 2.31 ();
11use YAML::Syck (); 23use YAML::Syck ();
12use Time::HiRes; 24use Time::HiRes;
13use Event; 25
14$Event::Eval = 1; # no idea why this is required, but it is 26use Event; $Event::Eval = 1; # no idea why this is required, but it is
15 27
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1; 29$YAML::Syck::ImplicitUnicode = 1;
18 30
19use strict; 31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
20 32
21sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload 33sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22 34
23our %COMMAND = (); 35our %COMMAND = ();
24our %COMMAND_TIME = (); 36our %COMMAND_TIME = ();
25our %EXTCMD = (); 37our %EXTCMD = ();
26 38
27_init_vars;
28
29our @EVENT; 39our @EVENT;
30our $LIBDIR = datadir . "/ext"; 40our $LIBDIR = datadir . "/ext";
31 41
32our $TICK = MAX_TIME * 1e-6; 42our $TICK = MAX_TIME * 1e-6;
33our $TICK_WATCHER; 43our $TICK_WATCHER;
34our $NEXT_TICK; 44our $NEXT_TICK;
45our $NOW;
35 46
36our %CFG; 47our %CFG;
37 48
38our $UPTIME; $UPTIME ||= time; 49our $UPTIME; $UPTIME ||= time;
50our $RUNTIME;
51
52our %MAP; # all maps
53our $LINK_MAP; # the special {link} map
54our $FREEZE;
55our $RANDOM_MAPS = cf::localdir . "/random";
56our %EXT_CORO;
57
58binmode STDOUT;
59binmode STDERR;
60
61# read virtual server time, if available
62unless ($RUNTIME || !-e cf::localdir . "/runtime") {
63 open my $fh, "<", cf::localdir . "/runtime"
64 or die "unable to read runtime file: $!";
65 $RUNTIME = <$fh> + 0.;
66}
67
68mkdir cf::localdir;
69mkdir cf::localdir . "/" . cf::playerdir;
70mkdir cf::localdir . "/" . cf::tmpdir;
71mkdir cf::localdir . "/" . cf::uniquedir;
72mkdir $RANDOM_MAPS;
73
74# a special map that is always available
75our $LINK_MAP;
76
77our $EMERGENCY_POSITION = $cf::CFG{emergency_position} || ["/world/world_105_115", 5, 37];
39 78
40############################################################################# 79#############################################################################
41 80
42=head2 GLOBAL VARIABLES 81=head2 GLOBAL VARIABLES
43 82
44=over 4 83=over 4
45 84
46=item $cf::UPTIME 85=item $cf::UPTIME
47 86
48The timestamp of the server start (so not actually an uptime). 87The timestamp of the server start (so not actually an uptime).
88
89=item $cf::RUNTIME
90
91The time this server has run, starts at 0 and is increased by $cf::TICK on
92every server tick.
49 93
50=item $cf::LIBDIR 94=item $cf::LIBDIR
51 95
52The perl library directory, where extensions and cf-specific modules can 96The perl library directory, where extensions and cf-specific modules can
53be found. It will be added to C<@INC> automatically. 97be found. It will be added to C<@INC> automatically.
98
99=item $cf::NOW
100
101The time of the last (current) server tick.
54 102
55=item $cf::TICK 103=item $cf::TICK
56 104
57The interval between server ticks, in seconds. 105The interval between server ticks, in seconds.
58 106
66=cut 114=cut
67 115
68BEGIN { 116BEGIN {
69 *CORE::GLOBAL::warn = sub { 117 *CORE::GLOBAL::warn = sub {
70 my $msg = join "", @_; 118 my $msg = join "", @_;
119 utf8::encode $msg;
120
71 $msg .= "\n" 121 $msg .= "\n"
72 unless $msg =~ /\n$/; 122 unless $msg =~ /\n$/;
73 123
74 print STDERR "cfperl: $msg";
75 LOG llevError, "cfperl: $msg"; 124 LOG llevError, "cfperl: $msg";
76 }; 125 };
77} 126}
78 127
128@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
129@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
130@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
131@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
132@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
79@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 133@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
80 134
81# we bless all objects into (empty) derived classes to force a method lookup 135# we bless all objects into (empty) derived classes to force a method lookup
82# within the Safe compartment. 136# within the Safe compartment.
83for my $pkg (qw( 137for my $pkg (qw(
138 cf::global cf::attachable
84 cf::object cf::object::player 139 cf::object cf::object::player
85 cf::client cf::player 140 cf::client cf::player
86 cf::arch cf::living 141 cf::arch cf::living
87 cf::map cf::party cf::region 142 cf::map cf::party cf::region
88)) { 143)) {
126sub to_json($) { 181sub to_json($) {
127 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 182 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
128 JSON::Syck::Dump $_[0] 183 JSON::Syck::Dump $_[0]
129} 184}
130 185
186=item cf::sync_job { BLOCK }
187
188The design of crossfire+ requires that the main coro ($Coro::main) is
189always able to handle events or runnable, as crossfire+ is only partly
190reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
191
192If it must be done, put the blocking parts into C<sync_job>. This will run
193the given BLOCK in another coroutine while waiting for the result. The
194server will be frozen during this time, so the block should either finish
195fast or be very important.
196
197=cut
198
199sub sync_job(&) {
200 my ($job) = @_;
201
202 if ($Coro::current == $Coro::main) {
203 # this is the main coro, too bad, we have to block
204 # till the operation succeeds, freezing the server :/
205
206 # TODO: use suspend/resume instead
207 # (but this is cancel-safe)
208 local $FREEZE = 1;
209
210 my $busy = 1;
211 my @res;
212
213 (Coro::async {
214 @res = eval { $job->() };
215 warn $@ if $@;
216 undef $busy;
217 })->prio (Coro::PRIO_MAX);
218
219 while ($busy) {
220 Coro::cede_notself;
221 Event::one_event unless Coro::nready;
222 }
223
224 wantarray ? @res : $res[0]
225 } else {
226 # we are in another coroutine, how wonderful, everything just works
227
228 $job->()
229 }
230}
231
232=item $coro = cf::coro { BLOCK }
233
234Creates and returns a new coro. This coro is automcatially being canceled
235when the extension calling this is being unloaded.
236
237=cut
238
239sub coro(&) {
240 my $cb = shift;
241
242 my $coro; $coro = async {
243 eval {
244 $cb->();
245 };
246 warn $@ if $@;
247 };
248
249 $coro->on_destroy (sub {
250 delete $EXT_CORO{$coro+0};
251 });
252 $EXT_CORO{$coro+0} = $coro;
253
254 $coro
255}
256
257sub write_runtime {
258 my $runtime = cf::localdir . "/runtime";
259
260 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
261 or return;
262
263 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
264 (aio_write $fh, 0, (length $value), $value, 0) <= 0
265 and return;
266
267 aio_fsync $fh
268 and return;
269
270 close $fh
271 or return;
272
273 aio_rename "$runtime~", $runtime
274 and return;
275
276 1
277}
278
131=back 279=back
132 280
133=cut 281=cut
134 282
135############################################################################# 283#############################################################################
136 284
137=head2 EVENTS AND OBJECT ATTACHMENTS 285package cf::path;
286
287sub new {
288 my ($class, $path, $base) = @_;
289
290 $path = $path->as_string if ref $path;
291
292 my $self = bless { }, $class;
293
294 # {... are special paths that are not touched
295 # ?xxx/... are special absolute paths
296 # ?random/... random maps
297 # /! non-realised random map exit
298 # /... normal maps
299 # ~/... per-player maps without a specific player (DO NOT USE)
300 # ~user/... per-player map of a specific user
301
302 if ($path =~ /^{/) {
303 # fine as it is
304 } elsif ($path =~ s{^\?random/}{}) {
305 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
306 $self->{random} = cf::from_json $data;
307 } else {
308 if ($path =~ s{^~([^/]+)?}{}) {
309 $self->{user_rel} = 1;
310
311 if (defined $1) {
312 $self->{user} = $1;
313 } elsif ($base =~ m{^~([^/]+)/}) {
314 $self->{user} = $1;
315 } else {
316 warn "cannot resolve user-relative path without user <$path,$base>\n";
317 }
318 } elsif ($path =~ /^\//) {
319 # already absolute
320 } else {
321 $base =~ s{[^/]+/?$}{};
322 return $class->new ("$base/$path");
323 }
324
325 for ($path) {
326 redo if s{/\.?/}{/};
327 redo if s{/[^/]+/\.\./}{/};
328 }
329 }
330
331 $self->{path} = $path;
332
333 $self
334}
335
336# the name / primary key / in-game path
337sub as_string {
338 my ($self) = @_;
339
340 $self->{user_rel} ? "~$self->{user}$self->{path}"
341 : $self->{random} ? "?random/$self->{path}"
342 : $self->{path}
343}
344
345# the displayed name, this is a one way mapping
346sub visible_name {
347 my ($self) = @_;
348
349# if (my $rmp = $self->{random}) {
350# # todo: be more intelligent about this
351# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
352# } else {
353 $self->as_string
354# }
355}
356
357# escape the /'s in the path
358sub _escaped_path {
359 # ∕ is U+2215
360 (my $path = $_[0]{path}) =~ s/\//∕/g;
361 $path
362}
363
364# the original (read-only) location
365sub load_path {
366 my ($self) = @_;
367
368 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
369}
370
371# the temporary/swap location
372sub save_path {
373 my ($self) = @_;
374
375 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
376 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
377 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
378}
379
380# the unique path, might be eq to save_path
381sub uniq_path {
382 my ($self) = @_;
383
384 $self->{user_rel} || $self->{random}
385 ? undef
386 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
387}
388
389# return random map parameters, or undef
390sub random_map_params {
391 my ($self) = @_;
392
393 $self->{random}
394}
395
396# this is somewhat ugly, but style maps do need special treatment
397sub is_style_map {
398 $_[0]{path} =~ m{^/styles/}
399}
400
401package cf;
402
403#############################################################################
404
405=head2 ATTACHABLE OBJECTS
406
407Many objects in crossfire are so-called attachable objects. That means you can
408attach callbacks/event handlers (a collection of which is called an "attachment")
409to it. All such attachable objects support the following methods.
410
411In the following description, CLASS can be any of C<global>, C<object>
412C<player>, C<client> or C<map> (i.e. the attachable objects in
413crossfire+).
138 414
139=over 4 415=over 4
140 416
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...)
154
155=item $map->detach ($attachment)
156
157Attach/detach a pre-registered attachment to a client.
158
159=item $client->attach ($attachment, key => $value...) 417=item $attachable->attach ($attachment, key => $value...)
160 418
161=item $client->detach ($attachment) 419=item $attachable->detach ($attachment)
162 420
163Attach/detach a pre-registered attachment to a map. 421Attach/detach a pre-registered attachment to a specific object and give it
422the specified key/value pairs as arguments.
164 423
165=item $bool = $object->attached ($name) 424Example, attach a minesweeper attachment to the given object, making it a
42510x10 minesweeper game:
166 426
167=item $bool = $player->attached ($name) 427 $obj->attach (minesweeper => width => 10, height => 10);
168 428
169=item $bool = $client->attached ($name) 429=item $bool = $attachable->attached ($name)
170
171=item $bool = $map->attached ($name)
172 430
173Checks wether the named attachment is currently attached to the object. 431Checks wether the named attachment is currently attached to the object.
174 432
175=item cf::attach_global ... 433=item cf::CLASS->attach ...
176 434
177Attach handlers for global events. 435=item cf::CLASS->detach ...
178 436
179This and all following C<attach_*>-functions expect any number of the 437Define an anonymous attachment and attach it to all objects of the given
180following handler/hook descriptions: 438CLASS. See the next function for an explanation of its arguments.
439
440You can attach to global events by using the C<cf::global> class.
441
442Example, log all player logins:
443
444 cf::player->attach (
445 on_login => sub {
446 my ($pl) = @_;
447 ...
448 },
449 );
450
451Example, attach to the jeweler skill:
452
453 cf::object->attach (
454 type => cf::SKILL,
455 subtype => cf::SK_JEWELER,
456 on_use_skill => sub {
457 my ($sk, $ob, $part, $dir, $msg) = @_;
458 ...
459 },
460 );
461
462=item cf::CLASS::attachment $name, ...
463
464Register an attachment by C<$name> through which attachable objects of the
465given CLASS can refer to this attachment.
466
467Some classes such as crossfire maps and objects can specify attachments
468that are attached at load/instantiate time, thus the need for a name.
469
470These calls expect any number of the following handler/hook descriptions:
181 471
182=over 4 472=over 4
183 473
184=item prio => $number 474=item prio => $number
185 475
187by another C<prio> setting). Lower priority handlers get executed 477by another C<prio> setting). Lower priority handlers get executed
188earlier. The default priority is C<0>, and many built-in handlers are 478earlier. The default priority is C<0>, and many built-in handlers are
189registered at priority C<-1000>, so lower priorities should not be used 479registered at priority C<-1000>, so lower priorities should not be used
190unless you know what you are doing. 480unless you know what you are doing.
191 481
482=item type => $type
483
484(Only for C<< cf::object->attach >> calls), limits the attachment to the
485given type of objects only (the additional parameter C<subtype> can be
486used to further limit to the given subtype).
487
192=item on_I<event> => \&cb 488=item on_I<event> => \&cb
193 489
194Call the given code reference whenever the named event happens (event is 490Call the given code reference whenever the named event happens (event is
195something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 491something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
196handlers are recognised generally depends on the type of object these 492handlers are recognised generally depends on the type of object these
205package and register them. Only handlers for eevents supported by the 501package and register them. Only handlers for eevents supported by the
206object/class are recognised. 502object/class are recognised.
207 503
208=back 504=back
209 505
210=item cf::attach_to_type $object_type, $subtype, ... 506Example, define an attachment called "sockpuppet" that calls the given
507event handler when a monster attacks:
211 508
212Attach handlers for a specific object type (e.g. TRANSPORT) and 509 cf::object::attachment sockpuppet =>
213subtype. If C<$subtype> is zero or undef, matches all objects of the given 510 on_skill_attack => sub {
214type. 511 my ($self, $victim) = @_;
215 512 ...
216=item cf::attach_to_objects ...
217
218Attach handlers to all objects. Do not use this except for debugging or
219very rare events, as handlers are (obviously) called for I<all> objects in
220the game.
221
222=item cf::attach_to_players ...
223
224Attach handlers to all players.
225
226=item cf::attach_to_clients ...
227
228Attach handlers to all players.
229
230=item cf::attach_to_maps ...
231
232Attach handlers to all maps.
233
234=item cf:register_attachment $name, ...
235
236Register an attachment by name through which objects can refer to this
237attachment.
238
239=item cf:register_player_attachment $name, ...
240
241Register an attachment by name through which players can refer to this
242attachment.
243
244=item cf:register_map_attachment $name, ...
245
246Register an attachment by name through which maps can refer to this
247attachment.
248
249=cut
250
251# the following variables are defined in .xs and must not be re-created
252our @CB_GLOBAL = (); # registry for all global events
253our @CB_OBJECT = (); # all objects (should not be used except in emergency)
254our @CB_PLAYER = ();
255our @CB_CLIENT = ();
256our @CB_TYPE = (); # registry for type (cf-object class) based events
257our @CB_MAP = ();
258
259my %attachment;
260
261sub _attach_cb($\%$$$) {
262 my ($registry, $undo, $event, $prio, $cb) = @_;
263
264 use sort 'stable';
265
266 $cb = [$prio, $cb];
267
268 @{$registry->[$event]} = sort
269 { $a->[0] cmp $b->[0] }
270 @{$registry->[$event] || []}, $cb;
271
272 push @{$undo->{cb}}, [$event, $cb];
273}
274
275# attach handles attaching event callbacks
276# the only thing the caller has to do is pass the correct
277# registry (== where the callback attaches to).
278sub _attach(\@$@) {
279 my ($registry, $klass, @arg) = @_;
280
281 my $prio = 0;
282
283 my %undo = (
284 registry => $registry,
285 cb => [],
286 );
287
288 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
289
290 while (@arg) {
291 my $type = shift @arg;
292
293 if ($type eq "prio") {
294 $prio = shift @arg;
295
296 } elsif ($type eq "package") {
297 my $pkg = shift @arg;
298
299 while (my ($name, $id) = each %cb_id) {
300 if (my $cb = $pkg->can ($name)) {
301 _attach_cb $registry, %undo, $id, $prio, $cb;
302 }
303 } 513 }
304
305 } elsif (exists $cb_id{$type}) {
306 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
307
308 } elsif (ref $type) {
309 warn "attaching objects not supported, ignoring.\n";
310
311 } else {
312 shift @arg;
313 warn "attach argument '$type' not supported, ignoring.\n";
314 }
315 }
316
317 \%undo
318}
319
320sub _attach_attachment {
321 my ($obj, $name, %arg) = @_;
322
323 return if exists $obj->{_attachment}{$name};
324
325 my $res;
326
327 if (my $attach = $attachment{$name}) {
328 my $registry = $obj->registry;
329
330 for (@$attach) {
331 my ($klass, @attach) = @$_;
332 $res = _attach @$registry, $klass, @attach;
333 }
334
335 $obj->{$name} = \%arg;
336 } else {
337 warn "object uses attachment '$name' that is not available, postponing.\n";
338 }
339
340 $obj->{_attachment}{$name} = undef;
341
342 $res->{attachment} = $name;
343 $res
344}
345
346*cf::object::attach =
347*cf::player::attach =
348*cf::client::attach =
349*cf::map::attach = sub {
350 my ($obj, $name, %arg) = @_;
351
352 _attach_attachment $obj, $name, %arg;
353};
354
355# all those should be optimised
356*cf::object::detach =
357*cf::player::detach =
358*cf::client::detach =
359*cf::map::detach = sub {
360 my ($obj, $name) = @_;
361
362 delete $obj->{_attachment}{$name};
363 reattach ($obj);
364};
365
366*cf::object::attached =
367*cf::player::attached =
368*cf::client::attached =
369*cf::map::attached = sub {
370 my ($obj, $name) = @_;
371
372 exists $obj->{_attachment}{$name}
373};
374
375sub attach_global {
376 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
377}
378
379sub attach_to_type {
380 my $type = shift;
381 my $subtype = shift;
382
383 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
384}
385
386sub attach_to_objects {
387 _attach @CB_OBJECT, KLASS_OBJECT, @_
388}
389
390sub attach_to_players {
391 _attach @CB_PLAYER, KLASS_PLAYER, @_
392}
393
394sub attach_to_clients {
395 _attach @CB_CLIENT, KLASS_CLIENT, @_
396}
397
398sub attach_to_maps {
399 _attach @CB_MAP, KLASS_MAP, @_
400}
401
402sub register_attachment {
403 my $name = shift;
404
405 $attachment{$name} = [[KLASS_OBJECT, @_]];
406}
407
408sub register_player_attachment {
409 my $name = shift;
410
411 $attachment{$name} = [[KLASS_PLAYER, @_]];
412}
413
414sub register_client_attachment {
415 my $name = shift;
416
417 $attachment{$name} = [[KLASS_CLIENT, @_]];
418}
419
420sub register_map_attachment {
421 my $name = shift;
422
423 $attachment{$name} = [[KLASS_MAP, @_]];
424}
425
426our $override;
427our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
428
429sub override {
430 $override = 1;
431 @invoke_results = ();
432}
433
434sub do_invoke {
435 my $event = shift;
436 my $callbacks = shift;
437
438 @invoke_results = ();
439
440 local $override;
441
442 for (@$callbacks) {
443 eval { &{$_->[1]} };
444
445 if ($@) {
446 warn "$@";
447 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
448 override;
449 }
450
451 return 1 if $override;
452 }
453
454 0 514 }
455}
456 515
457=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 516=item $attachable->valid
458
459=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
460
461=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
462
463=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)
464
465=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
466
467Generate a global/object/player/map-specific event with the given arguments.
468
469This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
470removed in future versions), and there is no public API to access override
471results (if you must, access C<@cf::invoke_results> directly).
472
473=back
474
475=cut
476
477#############################################################################
478
479=head2 METHODS VALID FOR ALL CORE OBJECTS
480
481=over 4
482
483=item $object->valid, $player->valid, $client->valid, $map->valid
484 517
485Just because you have a perl object does not mean that the corresponding 518Just because you have a perl object does not mean that the corresponding
486C-level object still exists. If you try to access an object that has no 519C-level object still exists. If you try to access an object that has no
487valid C counterpart anymore you get an exception at runtime. This method 520valid C counterpart anymore you get an exception at runtime. This method
488can be used to test for existence of the C object part without causing an 521can be used to test for existence of the C object part without causing an
489exception. 522exception.
490 523
524=cut
525
526# the following variables are defined in .xs and must not be re-created
527our @CB_GLOBAL = (); # registry for all global events
528our @CB_ATTACHABLE = (); # registry for all attachables
529our @CB_OBJECT = (); # all objects (should not be used except in emergency)
530our @CB_PLAYER = ();
531our @CB_CLIENT = ();
532our @CB_TYPE = (); # registry for type (cf-object class) based events
533our @CB_MAP = ();
534
535my %attachment;
536
537sub _attach_cb($$$$) {
538 my ($registry, $event, $prio, $cb) = @_;
539
540 use sort 'stable';
541
542 $cb = [$prio, $cb];
543
544 @{$registry->[$event]} = sort
545 { $a->[0] cmp $b->[0] }
546 @{$registry->[$event] || []}, $cb;
547}
548
549# hack
550my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
551
552# attach handles attaching event callbacks
553# the only thing the caller has to do is pass the correct
554# registry (== where the callback attaches to).
555sub _attach {
556 my ($registry, $klass, @arg) = @_;
557
558 my $object_type;
559 my $prio = 0;
560 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
561
562 #TODO: get rid of this hack
563 if ($attachable_klass{$klass}) {
564 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
565 }
566
567 while (@arg) {
568 my $type = shift @arg;
569
570 if ($type eq "prio") {
571 $prio = shift @arg;
572
573 } elsif ($type eq "type") {
574 $object_type = shift @arg;
575 $registry = $CB_TYPE[$object_type] ||= [];
576
577 } elsif ($type eq "subtype") {
578 defined $object_type or Carp::croak "subtype specified without type";
579 my $object_subtype = shift @arg;
580 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
581
582 } elsif ($type eq "package") {
583 my $pkg = shift @arg;
584
585 while (my ($name, $id) = each %cb_id) {
586 if (my $cb = $pkg->can ($name)) {
587 _attach_cb $registry, $id, $prio, $cb;
588 }
589 }
590
591 } elsif (exists $cb_id{$type}) {
592 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
593
594 } elsif (ref $type) {
595 warn "attaching objects not supported, ignoring.\n";
596
597 } else {
598 shift @arg;
599 warn "attach argument '$type' not supported, ignoring.\n";
600 }
601 }
602}
603
604sub _object_attach {
605 my ($obj, $name, %arg) = @_;
606
607 return if exists $obj->{_attachment}{$name};
608
609 if (my $attach = $attachment{$name}) {
610 my $registry = $obj->registry;
611
612 for (@$attach) {
613 my ($klass, @attach) = @$_;
614 _attach $registry, $klass, @attach;
615 }
616
617 $obj->{$name} = \%arg;
618 } else {
619 warn "object uses attachment '$name' that is not available, postponing.\n";
620 }
621
622 $obj->{_attachment}{$name} = undef;
623}
624
625sub cf::attachable::attach {
626 if (ref $_[0]) {
627 _object_attach @_;
628 } else {
629 _attach shift->_attach_registry, @_;
630 }
631};
632
633# all those should be optimised
634sub cf::attachable::detach {
635 my ($obj, $name) = @_;
636
637 if (ref $obj) {
638 delete $obj->{_attachment}{$name};
639 reattach ($obj);
640 } else {
641 Carp::croak "cannot, currently, detach class attachments";
642 }
643};
644
645sub cf::attachable::attached {
646 my ($obj, $name) = @_;
647
648 exists $obj->{_attachment}{$name}
649}
650
651for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
652 eval "#line " . __LINE__ . " 'cf.pm'
653 sub cf::\L$klass\E::_attach_registry {
654 (\\\@CB_$klass, KLASS_$klass)
655 }
656
657 sub cf::\L$klass\E::attachment {
658 my \$name = shift;
659
660 \$attachment{\$name} = [[KLASS_$klass, \@_]];
661 }
662 ";
663 die if $@;
664}
665
666our $override;
667our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
668
669sub override {
670 $override = 1;
671 @invoke_results = ();
672}
673
674sub do_invoke {
675 my $event = shift;
676 my $callbacks = shift;
677
678 @invoke_results = ();
679
680 local $override;
681
682 for (@$callbacks) {
683 eval { &{$_->[1]} };
684
685 if ($@) {
686 warn "$@";
687 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
688 override;
689 }
690
691 return 1 if $override;
692 }
693
694 0
695}
696
697=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
698
699=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
700
701Generate an object-specific event with the given arguments.
702
703This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
704removed in future versions), and there is no public API to access override
705results (if you must, access C<@cf::invoke_results> directly).
706
491=back 707=back
492 708
493=cut 709=cut
494
495*cf::object::valid =
496*cf::player::valid =
497*cf::client::valid =
498*cf::map::valid = \&cf::_valid;
499 710
500############################################################################# 711#############################################################################
501# object support 712# object support
502 713
503sub instantiate {
504 my ($obj, $data) = @_;
505
506 $data = from_json $data;
507
508 for (@$data) {
509 my ($name, $args) = @$_;
510
511 $obj->attach ($name, %{$args || {} });
512 }
513}
514
515# basically do the same as instantiate, without calling instantiate
516sub reattach { 714sub reattach {
715 # basically do the same as instantiate, without calling instantiate
517 my ($obj) = @_; 716 my ($obj) = @_;
717
518 my $registry = $obj->registry; 718 my $registry = $obj->registry;
519 719
520 @$registry = (); 720 @$registry = ();
521 721
522 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 722 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
523 723
524 for my $name (keys %{ $obj->{_attachment} || {} }) { 724 for my $name (keys %{ $obj->{_attachment} || {} }) {
525 if (my $attach = $attachment{$name}) { 725 if (my $attach = $attachment{$name}) {
526 for (@$attach) { 726 for (@$attach) {
527 my ($klass, @attach) = @$_; 727 my ($klass, @attach) = @$_;
528 _attach @$registry, $klass, @attach; 728 _attach $registry, $klass, @attach;
529 } 729 }
530 } else { 730 } else {
531 warn "object uses attachment '$name' that is not available, postponing.\n"; 731 warn "object uses attachment '$name' that is not available, postponing.\n";
532 } 732 }
533 } 733 }
534} 734}
535 735
536sub object_freezer_save { 736cf::attachable->attach (
537 my ($filename, $rdata, $objs) = @_;
538
539 if (length $$rdata) {
540 warn sprintf "saving %s (%d,%d)\n",
541 $filename, length $$rdata, scalar @$objs;
542
543 if (open my $fh, ">:raw", "$filename~") {
544 chmod SAVE_MODE, $fh;
545 syswrite $fh, $$rdata;
546 close $fh;
547
548 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
549 chmod SAVE_MODE, $fh;
550 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
551 close $fh;
552 rename "$filename.pst~", "$filename.pst";
553 } else {
554 unlink "$filename.pst";
555 }
556
557 rename "$filename~", $filename;
558 } else {
559 warn "FATAL: $filename~: $!\n";
560 }
561 } else {
562 unlink $filename;
563 unlink "$filename.pst";
564 }
565}
566
567sub object_freezer_as_string {
568 my ($rdata, $objs) = @_;
569
570 use Data::Dumper;
571
572 $$rdata . Dumper $objs
573}
574
575sub object_thawer_load {
576 my ($filename) = @_;
577
578 local $/;
579
580 my $av;
581
582 #TODO: use sysread etc.
583 if (open my $data, "<:raw:perlio", $filename) {
584 $data = <$data>;
585 if (open my $pst, "<:raw:perlio", "$filename.pst") {
586 $av = eval { (Storable::thaw <$pst>)->{objs} };
587 }
588 return ($data, $av);
589 }
590
591 ()
592}
593
594attach_to_objects
595 prio => -1000000, 737 prio => -1000000,
738 on_instantiate => sub {
739 my ($obj, $data) = @_;
740
741 $data = from_json $data;
742
743 for (@$data) {
744 my ($name, $args) = @$_;
745
746 $obj->attach ($name, %{$args || {} });
747 }
748 },
749 on_reattach => \&reattach,
596 on_clone => sub { 750 on_clone => sub {
597 my ($src, $dst) = @_; 751 my ($src, $dst) = @_;
598 752
599 @{$dst->registry} = @{$src->registry}; 753 @{$dst->registry} = @{$src->registry};
600 754
601 %$dst = %$src; 755 %$dst = %$src;
602 756
603 %{$dst->{_attachment}} = %{$src->{_attachment}} 757 %{$dst->{_attachment}} = %{$src->{_attachment}}
604 if exists $src->{_attachment}; 758 if exists $src->{_attachment};
605 }, 759 },
606; 760);
761
762sub object_freezer_save {
763 my ($filename, $rdata, $objs) = @_;
764
765 sync_job {
766 if (length $$rdata) {
767 warn sprintf "saving %s (%d,%d)\n",
768 $filename, length $$rdata, scalar @$objs;
769
770 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
771 chmod SAVE_MODE, $fh;
772 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
773 aio_fsync $fh;
774 close $fh;
775
776 if (@$objs) {
777 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
778 chmod SAVE_MODE, $fh;
779 my $data = Storable::nfreeze { version => 1, objs => $objs };
780 aio_write $fh, 0, (length $data), $data, 0;
781 aio_fsync $fh;
782 close $fh;
783 aio_rename "$filename.pst~", "$filename.pst";
784 }
785 } else {
786 aio_unlink "$filename.pst";
787 }
788
789 aio_rename "$filename~", $filename;
790 } else {
791 warn "FATAL: $filename~: $!\n";
792 }
793 } else {
794 aio_unlink $filename;
795 aio_unlink "$filename.pst";
796 }
797 }
798}
799
800sub object_freezer_as_string {
801 my ($rdata, $objs) = @_;
802
803 use Data::Dumper;
804
805 $$rdata . Dumper $objs
806}
807
808sub object_thawer_load {
809 my ($filename) = @_;
810
811 my ($data, $av);
812
813 (aio_load $filename, $data) >= 0
814 or return;
815
816 unless (aio_stat "$filename.pst") {
817 (aio_load "$filename.pst", $av) >= 0
818 or return;
819 $av = eval { (Storable::thaw $av)->{objs} };
820 }
821
822 return ($data, $av);
823}
607 824
608############################################################################# 825#############################################################################
609# command handling &c 826# command handling &c
610 827
611=item cf::register_command $name => \&callback($ob,$args); 828=item cf::register_command $name => \&callback($ob,$args);
640 #warn "registering extcmd '$name' to '$caller'"; 857 #warn "registering extcmd '$name' to '$caller'";
641 858
642 $EXTCMD{$name} = [$cb, $caller]; 859 $EXTCMD{$name} = [$cb, $caller];
643} 860}
644 861
645attach_to_players 862cf::player->attach (
646 on_command => sub { 863 on_command => sub {
647 my ($pl, $name, $params) = @_; 864 my ($pl, $name, $params) = @_;
648 865
649 my $cb = $COMMAND{$name} 866 my $cb = $COMMAND{$name}
650 or return; 867 or return;
670 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 887 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
671 } 888 }
672 889
673 cf::override; 890 cf::override;
674 }, 891 },
675; 892);
676 893
677sub register { 894sub register {
678 my ($base, $pkg) = @_; 895 my ($base, $pkg) = @_;
679 896
680 #TODO 897 #TODO
770 defined $path or return; 987 defined $path or return;
771 988
772 unlink "$path.pst"; 989 unlink "$path.pst";
773}; 990};
774 991
775attach_to_maps prio => -10000, package => cf::mapsupport::; 992cf::map->attach (prio => -10000, package => cf::mapsupport::);
776 993
777############################################################################# 994#############################################################################
778# load/save perl data associated with player->ob objects 995# load/save perl data associated with player->ob objects
779 996
780sub all_objects(@) { 997sub all_objects(@) {
781 @_, map all_objects ($_->inv), @_ 998 @_, map all_objects ($_->inv), @_
782} 999}
783 1000
784# TODO: compatibility cruft, remove when no longer needed 1001# TODO: compatibility cruft, remove when no longer needed
785attach_to_players 1002cf::player->attach (
786 on_load => sub { 1003 on_load => sub {
787 my ($pl, $path) = @_; 1004 my ($pl, $path) = @_;
788 1005
789 for my $o (all_objects $pl->ob) { 1006 for my $o (all_objects $pl->ob) {
790 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1007 if (my $value = $o->get_ob_key_value ("_perl_data")) {
792 1009
793 %$o = %{ Storable::thaw pack "H*", $value }; 1010 %$o = %{ Storable::thaw pack "H*", $value };
794 } 1011 }
795 } 1012 }
796 }, 1013 },
797; 1014);
798 1015
799############################################################################# 1016#############################################################################
800 1017
801=head2 CORE EXTENSIONS 1018=head2 CORE EXTENSIONS
802 1019
803Functions and methods that extend core crossfire objects. 1020Functions and methods that extend core crossfire objects.
1021
1022=head3 cf::player
804 1023
805=over 4 1024=over 4
806 1025
807=item cf::player::exists $login 1026=item cf::player::exists $login
808 1027
813sub cf::player::exists($) { 1032sub cf::player::exists($) {
814 cf::player::find $_[0] 1033 cf::player::find $_[0]
815 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1034 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
816} 1035}
817 1036
1037=item $player->ext_reply ($msgid, $msgtype, %msg)
1038
1039Sends an ext reply to the player.
1040
1041=cut
1042
1043sub cf::player::ext_reply($$$%) {
1044 my ($self, $id, %msg) = @_;
1045
1046 $msg{msgid} = $id;
1047
1048 $self->send ("ext " . to_json \%msg);
1049}
1050
1051=back
1052
1053
1054=head3 cf::map
1055
1056=over 4
1057
1058=cut
1059
1060package cf::map;
1061
1062use Fcntl;
1063use Coro::AIO;
1064
1065our $MAX_RESET = 7200;
1066our $DEFAULT_RESET = 3600;
1067
1068sub generate_random_map {
1069 my ($path, $rmp) = @_;
1070
1071 # mit "rum" bekleckern, nicht
1072 cf::map::_create_random_map
1073 $path,
1074 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1075 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1076 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1077 $rmp->{exit_on_final_map},
1078 $rmp->{xsize}, $rmp->{ysize},
1079 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1080 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1081 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1082 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1083 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1084 (cf::region::find $rmp->{region})
1085}
1086
1087# and all this just because we cannot iterate over
1088# all maps in C++...
1089sub change_all_map_light {
1090 my ($change) = @_;
1091
1092 $_->change_map_light ($change) for values %cf::MAP;
1093}
1094
1095sub try_load_header($) {
1096 my ($path) = @_;
1097
1098 utf8::encode $path;
1099 aio_open $path, O_RDONLY, 0
1100 or return;
1101
1102 my $map = cf::map::new
1103 or return;
1104
1105 $map->load_header ($path)
1106 or return;
1107
1108 $map->{load_path} = $path;
1109
1110 $map
1111}
1112
1113sub find_map {
1114 my ($path, $origin) = @_;
1115
1116 #warn "find_map<$path,$origin>\n";#d#
1117
1118 $path = new cf::path $path, $origin && $origin->path;
1119 my $key = $path->as_string;
1120
1121 $cf::MAP{$key} || do {
1122 # do it the slow way
1123 my $map = try_load_header $path->save_path;
1124
1125 if ($map) {
1126 # safety
1127 $map->{instantiate_time} = $cf::RUNTIME
1128 if $map->{instantiate_time} > $cf::RUNTIME;
1129 } else {
1130 if (my $rmp = $path->random_map_params) {
1131 $map = generate_random_map $key, $rmp;
1132 } else {
1133 $map = try_load_header $path->load_path;
1134 }
1135
1136 $map or return;
1137
1138 $map->{load_original} = 1;
1139 $map->{instantiate_time} = $cf::RUNTIME;
1140 $map->instantiate;
1141
1142 # per-player maps become, after loading, normal maps
1143 $map->per_player (0) if $path->{user_rel};
1144 }
1145
1146 $map->path ($key);
1147 $map->{path} = $path;
1148 $map->last_access ($cf::RUNTIME);
1149
1150 if ($map->should_reset) {
1151 $map->reset;
1152 $map = find_map $path;
1153 }
1154
1155 $cf::MAP{$key} = $map
1156 }
1157}
1158
1159sub load {
1160 my ($self) = @_;
1161
1162 return if $self->in_memory != cf::MAP_SWAPPED;
1163
1164 $self->in_memory (cf::MAP_LOADING);
1165
1166 my $path = $self->{path};
1167
1168 $self->alloc;
1169 $self->load_objects ($self->{load_path}, 1)
1170 or return;
1171
1172 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1173 if delete $self->{load_original};
1174
1175 if (my $uniq = $path->uniq_path) {
1176 utf8::encode $uniq;
1177 if (aio_open $uniq, O_RDONLY, 0) {
1178 $self->clear_unique_items;
1179 $self->load_objects ($uniq, 0);
1180 }
1181 }
1182
1183 # now do the right thing for maps
1184 $self->link_multipart_objects;
1185
1186 if ($self->{path}->is_style_map) {
1187 $self->{deny_save} = 1;
1188 $self->{deny_reset} = 1;
1189 } else {
1190 $self->fix_auto_apply;
1191 $self->decay_objects;
1192 $self->update_buttons;
1193 $self->set_darkness_map;
1194 $self->difficulty ($self->estimate_difficulty)
1195 unless $self->difficulty;
1196 $self->activate;
1197 }
1198
1199 $self->in_memory (cf::MAP_IN_MEMORY);
1200}
1201
1202sub load_map_sync {
1203 my ($path, $origin) = @_;
1204
1205 #warn "load_map_sync<$path, $origin>\n";#d#
1206
1207 cf::sync_job {
1208 my $map = cf::map::find_map $path, $origin
1209 or return;
1210 $map->load;
1211 $map
1212 }
1213}
1214
1215sub save {
1216 my ($self) = @_;
1217
1218 my $save = $self->{path}->save_path; utf8::encode $save;
1219 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1220
1221 $self->{last_save} = $cf::RUNTIME;
1222
1223 return unless $self->dirty;
1224
1225 $self->{load_path} = $save;
1226
1227 return if $self->{deny_save};
1228
1229 if ($uniq) {
1230 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1231 $self->save_objects ($uniq, cf::IO_UNIQUES);
1232 } else {
1233 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1234 }
1235}
1236
1237sub swap_out {
1238 my ($self) = @_;
1239
1240 return if $self->players;
1241 return if $self->in_memory != cf::MAP_IN_MEMORY;
1242 return if $self->{deny_save};
1243
1244 $self->save;
1245 $self->clear;
1246 $self->in_memory (cf::MAP_SWAPPED);
1247}
1248
1249sub reset_at {
1250 my ($self) = @_;
1251
1252 # TODO: safety, remove and allow resettable per-player maps
1253 return 1e99 if $self->{path}{user_rel};
1254 return 1e99 if $self->{deny_reset};
1255
1256 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1257 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1258
1259 $time + $to
1260}
1261
1262sub should_reset {
1263 my ($self) = @_;
1264
1265 $self->reset_at <= $cf::RUNTIME
1266}
1267
1268sub unlink_save {
1269 my ($self) = @_;
1270
1271 utf8::encode (my $save = $self->{path}->save_path);
1272 aioreq_pri 3; IO::AIO::aio_unlink $save;
1273 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1274}
1275
1276sub rename {
1277 my ($self, $new_path) = @_;
1278
1279 $self->unlink_save;
1280
1281 delete $cf::MAP{$self->path};
1282 $self->{path} = new cf::path $new_path;
1283 $self->path ($self->{path}->as_string);
1284 $cf::MAP{$self->path} = $self;
1285
1286 $self->save;
1287}
1288
1289sub reset {
1290 my ($self) = @_;
1291
1292 return if $self->players;
1293 return if $self->{path}{user_rel};#d#
1294
1295 warn "resetting map ", $self->path;#d#
1296
1297 delete $cf::MAP{$self->path};
1298
1299 $_->clear_links_to ($self) for values %cf::MAP;
1300
1301 $self->unlink_save;
1302 $self->destroy;
1303}
1304
1305my $nuke_counter = "aaaa";
1306
1307sub nuke {
1308 my ($self) = @_;
1309
1310 $self->{deny_save} = 1;
1311 $self->reset_timeout (1);
1312 $self->rename ("{nuke}/" . ($nuke_counter++));
1313 $self->reset; # polite request, might not happen
1314}
1315
1316sub customise_for {
1317 my ($map, $ob) = @_;
1318
1319 if ($map->per_player) {
1320 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
1321 }
1322
1323 $map
1324}
1325
1326sub emergency_save {
1327 local $cf::FREEZE = 1;
1328
1329 warn "enter emergency map save\n";
1330
1331 cf::sync_job {
1332 warn "begin emergency map save\n";
1333 $_->save for values %cf::MAP;
1334 };
1335
1336 warn "end emergency map save\n";
1337}
1338
1339package cf;
1340
1341=back
1342
1343
1344=head3 cf::object::player
1345
1346=over 4
1347
818=item $player_object->reply ($npc, $msg[, $flags]) 1348=item $player_object->reply ($npc, $msg[, $flags])
819 1349
820Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1350Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
821can be C<undef>. Does the right thing when the player is currently in a 1351can be C<undef>. Does the right thing when the player is currently in a
822dialogue with the given NPC character. 1352dialogue with the given NPC character.
823 1353
824=cut 1354=cut
825 1355
826# rough implementation of a future "reply" method that works 1356# rough implementation of a future "reply" method that works
827# with dialog boxes. 1357# with dialog boxes.
1358#TODO: the first argument must go, split into a $npc->reply_to ( method
828sub cf::object::player::reply($$$;$) { 1359sub cf::object::player::reply($$$;$) {
829 my ($self, $npc, $msg, $flags) = @_; 1360 my ($self, $npc, $msg, $flags) = @_;
830 1361
831 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1362 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
832 1363
836 $msg = $npc->name . " says: $msg" if $npc; 1367 $msg = $npc->name . " says: $msg" if $npc;
837 $self->message ($msg, $flags); 1368 $self->message ($msg, $flags);
838 } 1369 }
839} 1370}
840 1371
841=item $player->ext_reply ($msgid, $msgtype, %msg)
842
843Sends an ext reply to the player.
844
845=cut
846
847sub cf::player::ext_reply($$$%) {
848 my ($self, $id, %msg) = @_;
849
850 $msg{msgid} = $id;
851
852 $self->send ("ext " . to_json \%msg);
853}
854
855=item $player_object->may ("access") 1372=item $player_object->may ("access")
856 1373
857Returns wether the given player is authorized to access resource "access" 1374Returns wether the given player is authorized to access resource "access"
858(e.g. "command_wizcast"). 1375(e.g. "command_wizcast").
859 1376
866 (ref $cf::CFG{"may_$access"} 1383 (ref $cf::CFG{"may_$access"}
867 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1384 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
868 : $cf::CFG{"may_$access"}) 1385 : $cf::CFG{"may_$access"})
869} 1386}
870 1387
871=cut 1388=item $player_object->enter_link
872 1389
873############################################################################# 1390Freezes the player and moves him/her to a special map (C<{link}>).
1391
1392The player should be reaosnably safe there for short amounts of time. You
1393I<MUST> call C<leave_link> as soon as possible, though.
1394
1395=item $player_object->leave_link ($map, $x, $y)
1396
1397Moves the player out of the specila link map onto the given map. If the
1398map is not valid (or omitted), the player will be moved back to the
1399location he/she was before the call to C<enter_link>, or, if that fails,
1400to the emergency map position.
1401
1402Might block.
1403
1404=cut
1405
1406sub cf::object::player::enter_link {
1407 my ($self) = @_;
1408
1409 return if $self->map == $LINK_MAP;
1410
1411 $self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1412 if $self->map;
1413
1414 $self->enter_map ($LINK_MAP, 20, 20);
1415 $self->deactivate_recursive;
1416}
1417
1418sub cf::object::player::leave_link {
1419 my ($self, $map, $x, $y) = @_;
1420
1421 my $link_pos = delete $self->{_link_pos};
1422
1423 unless ($map) {
1424 # restore original map position
1425 ($map, $x, $y) = @{ $link_pos || [] };
1426 $map = cf::map::find_map $map;
1427
1428 unless ($map) {
1429 ($map, $x, $y) = @$EMERGENCY_POSITION;
1430 $map = cf::map::find_map $map
1431 or die "FATAL: cannot load emergency map\n";
1432 }
1433 }
1434
1435 ($x, $y) = (-1, -1)
1436 unless (defined $x) && (defined $y);
1437
1438 # use -1 or undef as default coordinates, not 0, 0
1439 ($x, $y) = ($map->enter_x, $map->enter_y)
1440 if $x <=0 && $y <= 0;
1441
1442 $map->load;
1443
1444 $self->activate_recursive;
1445 $self->enter_map ($map, $x, $y);
1446}
1447
1448=item $player_object->goto_map ($map, $x, $y)
1449
1450=cut
1451
1452sub cf::object::player::goto_map {
1453 my ($self, $path, $x, $y) = @_;
1454
1455 $self->enter_link;
1456
1457 (Coro::async {
1458 $path = new cf::path $path;
1459
1460 my $map = cf::map::find_map $path->as_string;
1461 $map = $map->customise_for ($self) if $map;
1462
1463 warn "entering ", $map->path, " at ($x, $y)\n"
1464 if $map;
1465
1466 $map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1467
1468 $self->leave_link ($map, $x, $y);
1469 })->prio (1);
1470}
1471
1472=item $player_object->enter_exit ($exit_object)
1473
1474=cut
1475
1476sub parse_random_map_params {
1477 my ($spec) = @_;
1478
1479 my $rmp = { # defaults
1480 xsize => 10,
1481 ysize => 10,
1482 };
1483
1484 for (split /\n/, $spec) {
1485 my ($k, $v) = split /\s+/, $_, 2;
1486
1487 $rmp->{lc $k} = $v if (length $k) && (length $v);
1488 }
1489
1490 $rmp
1491}
1492
1493sub prepare_random_map {
1494 my ($exit) = @_;
1495
1496 # all this does is basically replace the /! path by
1497 # a new random map path (?random/...) with a seed
1498 # that depends on the exit object
1499
1500 my $rmp = parse_random_map_params $exit->msg;
1501
1502 if ($exit->map) {
1503 $rmp->{region} = $exit->map->region_name;
1504 $rmp->{origin_map} = $exit->map->path;
1505 $rmp->{origin_x} = $exit->x;
1506 $rmp->{origin_y} = $exit->y;
1507 }
1508
1509 $rmp->{random_seed} ||= $exit->random_seed;
1510
1511 my $data = cf::to_json $rmp;
1512 my $md5 = Digest::MD5::md5_hex $data;
1513
1514 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1515 aio_write $fh, 0, (length $data), $data, 0;
1516
1517 $exit->slaying ("?random/$md5");
1518 $exit->msg (undef);
1519 }
1520}
1521
1522sub cf::object::player::enter_exit {
1523 my ($self, $exit) = @_;
1524
1525 return unless $self->type == cf::PLAYER;
1526
1527 $self->enter_link;
1528
1529 (Coro::async {
1530 unless (eval {
1531
1532 prepare_random_map $exit
1533 if $exit->slaying eq "/!";
1534
1535 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1536 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1537
1538 1;
1539 }) {
1540 $self->message ("Something went wrong deep within the crossfire server. "
1541 . "I'll try to bring you back to the map you were before. "
1542 . "Please report this to the dungeon master",
1543 cf::NDI_UNIQUE | cf::NDI_RED);
1544
1545 warn "ERROR in enter_exit: $@";
1546 $self->leave_link;
1547 }
1548 })->prio (1);
1549}
1550
1551=head3 cf::client
1552
1553=over 4
1554
1555=item $client->send_drawinfo ($text, $flags)
1556
1557Sends a drawinfo packet to the client. Circumvents output buffering so
1558should not be used under normal circumstances.
1559
1560=cut
1561
1562sub cf::client::send_drawinfo {
1563 my ($self, $text, $flags) = @_;
1564
1565 utf8::encode $text;
1566 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1567}
1568
1569
1570=item $success = $client->query ($flags, "text", \&cb)
1571
1572Queues a query to the client, calling the given callback with
1573the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1574C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1575
1576Queries can fail, so check the return code. Or don't, as queries will become
1577reliable at some point in the future.
1578
1579=cut
1580
1581sub cf::client::query {
1582 my ($self, $flags, $text, $cb) = @_;
1583
1584 return unless $self->state == ST_PLAYING
1585 || $self->state == ST_SETUP
1586 || $self->state == ST_CUSTOM;
1587
1588 $self->state (ST_CUSTOM);
1589
1590 utf8::encode $text;
1591 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1592
1593 $self->send_packet ($self->{query_queue}[0][0])
1594 if @{ $self->{query_queue} } == 1;
1595}
1596
1597cf::client->attach (
1598 on_reply => sub {
1599 my ($ns, $msg) = @_;
1600
1601 # this weird shuffling is so that direct followup queries
1602 # get handled first
1603 my $queue = delete $ns->{query_queue};
1604
1605 (shift @$queue)->[1]->($msg);
1606
1607 push @{ $ns->{query_queue} }, @$queue;
1608
1609 if (@{ $ns->{query_queue} } == @$queue) {
1610 if (@$queue) {
1611 $ns->send_packet ($ns->{query_queue}[0][0]);
1612 } else {
1613 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1614 }
1615 }
1616 },
1617);
1618
1619=item $client->coro (\&cb)
1620
1621Create a new coroutine, running the specified callback. The coroutine will
1622be automatically cancelled when the client gets destroyed (e.g. on logout,
1623or loss of connection).
1624
1625=cut
1626
1627sub cf::client::coro {
1628 my ($self, $cb) = @_;
1629
1630 my $coro; $coro = async {
1631 eval {
1632 $cb->();
1633 };
1634 warn $@ if $@;
1635 };
1636
1637 $coro->on_destroy (sub {
1638 delete $self->{_coro}{$coro+0};
1639 });
1640
1641 $self->{_coro}{$coro+0} = $coro;
1642
1643 $coro
1644}
1645
1646cf::client->attach (
1647 on_destroy => sub {
1648 my ($ns) = @_;
1649
1650 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1651 },
1652);
1653
1654=back
1655
874 1656
875=head2 SAFE SCRIPTING 1657=head2 SAFE SCRIPTING
876 1658
877Functions that provide a safe environment to compile and execute 1659Functions that provide a safe environment to compile and execute
878snippets of perl code without them endangering the safety of the server 1660snippets of perl code without them endangering the safety of the server
1078 $DB->{$_[0]} = $_[1]; 1860 $DB->{$_[0]} = $_[1];
1079 } 1861 }
1080 db_dirty; 1862 db_dirty;
1081 } 1863 }
1082 1864
1083 attach_global 1865 cf::global->attach (
1084 prio => 10000, 1866 prio => 10000,
1085 on_cleanup => sub { 1867 on_cleanup => sub {
1086 db_sync; 1868 db_sync;
1087 }, 1869 },
1088 ; 1870 );
1089} 1871}
1090 1872
1091############################################################################# 1873#############################################################################
1092# the server's main() 1874# the server's main()
1093 1875
1098 local $/; 1880 local $/;
1099 *CFG = YAML::Syck::Load <$fh>; 1881 *CFG = YAML::Syck::Load <$fh>;
1100} 1882}
1101 1883
1102sub main { 1884sub main {
1885 # we must not ever block the main coroutine
1886 local $Coro::idle = sub {
1887 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
1888 (Coro::unblock_sub {
1889 Event::one_event;
1890 })->();
1891 };
1892
1103 cfg_load; 1893 cfg_load;
1104 db_load; 1894 db_load;
1105 load_extensions; 1895 load_extensions;
1106 Event::loop; 1896 Event::loop;
1107} 1897}
1108 1898
1109############################################################################# 1899#############################################################################
1110# initialisation 1900# initialisation
1111 1901
1112sub _perl_reload(&) { 1902sub reload() {
1113 my ($msg) = @_; 1903 # can/must only be called in main
1904 if ($Coro::current != $Coro::main) {
1905 warn "can only reload from main coroutine\n";
1906 return;
1907 }
1114 1908
1115 $msg->("reloading..."); 1909 warn "reloading...";
1910
1911 local $FREEZE = 1;
1912 cf::emergency_save;
1116 1913
1117 eval { 1914 eval {
1915 # if anything goes wrong in here, we should simply crash as we already saved
1916
1118 # cancel all watchers 1917 # cancel all watchers
1119 for (Event::all_watchers) { 1918 for (Event::all_watchers) {
1120 $_->cancel if $_->data & WF_AUTOCANCEL; 1919 $_->cancel if $_->data & WF_AUTOCANCEL;
1121 } 1920 }
1122 1921
1922 # cancel all extension coros
1923 $_->cancel for values %EXT_CORO;
1924 %EXT_CORO = ();
1925
1123 # unload all extensions 1926 # unload all extensions
1124 for (@exts) { 1927 for (@exts) {
1125 $msg->("unloading <$_>"); 1928 warn "unloading <$_>";
1126 unload_extension $_; 1929 unload_extension $_;
1127 } 1930 }
1128 1931
1129 # unload all modules loaded from $LIBDIR 1932 # unload all modules loaded from $LIBDIR
1130 while (my ($k, $v) = each %INC) { 1933 while (my ($k, $v) = each %INC) {
1131 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 1934 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1132 1935
1133 $msg->("removing <$k>"); 1936 warn "removing <$k>";
1134 delete $INC{$k}; 1937 delete $INC{$k};
1135 1938
1136 $k =~ s/\.pm$//; 1939 $k =~ s/\.pm$//;
1137 $k =~ s/\//::/g; 1940 $k =~ s/\//::/g;
1138 1941
1143 Symbol::delete_package $k; 1946 Symbol::delete_package $k;
1144 } 1947 }
1145 1948
1146 # sync database to disk 1949 # sync database to disk
1147 cf::db_sync; 1950 cf::db_sync;
1951 IO::AIO::flush;
1148 1952
1149 # get rid of safe::, as good as possible 1953 # get rid of safe::, as good as possible
1150 Symbol::delete_package "safe::$_" 1954 Symbol::delete_package "safe::$_"
1151 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 1955 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1152 1956
1153 # remove register_script_function callbacks 1957 # remove register_script_function callbacks
1154 # TODO 1958 # TODO
1155 1959
1156 # unload cf.pm "a bit" 1960 # unload cf.pm "a bit"
1159 # don't, removes xs symbols, too, 1963 # don't, removes xs symbols, too,
1160 # and global variables created in xs 1964 # and global variables created in xs
1161 #Symbol::delete_package __PACKAGE__; 1965 #Symbol::delete_package __PACKAGE__;
1162 1966
1163 # reload cf.pm 1967 # reload cf.pm
1164 $msg->("reloading cf.pm"); 1968 warn "reloading cf.pm";
1165 require cf; 1969 require cf;
1970 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1166 1971
1167 # load config and database again 1972 # load config and database again
1168 cf::cfg_load; 1973 cf::cfg_load;
1169 cf::db_load; 1974 cf::db_load;
1170 1975
1171 # load extensions 1976 # load extensions
1172 $msg->("load extensions"); 1977 warn "load extensions";
1173 cf::load_extensions; 1978 cf::load_extensions;
1174 1979
1175 # reattach attachments to objects 1980 # reattach attachments to objects
1176 $msg->("reattach"); 1981 warn "reattach";
1177 _global_reattach; 1982 _global_reattach;
1178 }; 1983 };
1179 $msg->($@) if $@;
1180 1984
1181 $msg->("reloaded"); 1985 if ($@) {
1986 warn $@;
1987 warn "error while reloading, exiting.";
1988 exit 1;
1989 }
1990
1991 warn "reloaded successfully";
1182}; 1992};
1183 1993
1184sub perl_reload() { 1994#############################################################################
1185 _perl_reload { 1995
1186 warn $_[0]; 1996unless ($LINK_MAP) {
1187 print "$_[0]\n"; 1997 $LINK_MAP = cf::map::new;
1188 }; 1998
1999 $LINK_MAP->width (41);
2000 $LINK_MAP->height (41);
2001 $LINK_MAP->alloc;
2002 $LINK_MAP->path ("{link}");
2003 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2004 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2005
2006 # dirty hack because... archetypes are not yet loaded
2007 Event->timer (
2008 after => 2,
2009 cb => sub {
2010 $_[0]->w->cancel;
2011
2012 # provide some exits "home"
2013 my $exit = cf::object::new "exit";
2014
2015 $exit->slaying ($EMERGENCY_POSITION->[0]);
2016 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2017 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2018
2019 $LINK_MAP->insert ($exit->clone, 19, 19);
2020 $LINK_MAP->insert ($exit->clone, 19, 20);
2021 $LINK_MAP->insert ($exit->clone, 19, 21);
2022 $LINK_MAP->insert ($exit->clone, 20, 19);
2023 $LINK_MAP->insert ($exit->clone, 20, 21);
2024 $LINK_MAP->insert ($exit->clone, 21, 19);
2025 $LINK_MAP->insert ($exit->clone, 21, 20);
2026 $LINK_MAP->insert ($exit->clone, 21, 21);
2027
2028 $exit->destroy;
2029 });
2030
2031 $LINK_MAP->{deny_save} = 1;
2032 $LINK_MAP->{deny_reset} = 1;
2033
2034 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1189} 2035}
1190 2036
1191register "<global>", __PACKAGE__; 2037register "<global>", __PACKAGE__;
1192 2038
1193register_command "perl-reload" => sub { 2039register_command "reload" => sub {
1194 my ($who, $arg) = @_; 2040 my ($who, $arg) = @_;
1195 2041
1196 if ($who->flag (FLAG_WIZ)) { 2042 if ($who->flag (FLAG_WIZ)) {
1197 _perl_reload { 2043 $who->message ("start of reload.");
1198 warn $_[0]; 2044 reload;
1199 $who->message ($_[0]); 2045 $who->message ("end of reload.");
1200 };
1201 } 2046 }
1202}; 2047};
1203 2048
1204unshift @INC, $LIBDIR; 2049unshift @INC, $LIBDIR;
1205 2050
1206$TICK_WATCHER = Event->timer ( 2051$TICK_WATCHER = Event->timer (
2052 reentrant => 0,
1207 prio => 0, 2053 prio => 0,
1208 at => $NEXT_TICK || 1, 2054 at => $NEXT_TICK || $TICK,
1209 data => WF_AUTOCANCEL, 2055 data => WF_AUTOCANCEL,
1210 cb => sub { 2056 cb => sub {
2057 unless ($FREEZE) {
1211 cf::server_tick; # one server iteration 2058 cf::server_tick; # one server iteration
2059 $RUNTIME += $TICK;
2060 }
1212 2061
1213 my $NOW = Event::time;
1214 $NEXT_TICK += $TICK; 2062 $NEXT_TICK += $TICK;
1215 2063
1216 # if we are delayed by four ticks or more, skip them all 2064 # if we are delayed by four ticks or more, skip them all
1217 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2065 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1218 2066
1219 $TICK_WATCHER->at ($NEXT_TICK); 2067 $TICK_WATCHER->at ($NEXT_TICK);
1220 $TICK_WATCHER->start; 2068 $TICK_WATCHER->start;
1221 }, 2069 },
1222); 2070);
1223 2071
1224IO::AIO::max_poll_time $TICK * 0.2; 2072IO::AIO::max_poll_time $TICK * 0.2;
1225 2073
2074Event->io (
1226Event->io (fd => IO::AIO::poll_fileno, 2075 fd => IO::AIO::poll_fileno,
1227 poll => 'r', 2076 poll => 'r',
1228 prio => 5, 2077 prio => 5,
1229 data => WF_AUTOCANCEL, 2078 data => WF_AUTOCANCEL,
1230 cb => \&IO::AIO::poll_cb); 2079 cb => \&IO::AIO::poll_cb,
2080);
2081
2082Event->timer (
2083 data => WF_AUTOCANCEL,
2084 after => 0,
2085 interval => 10,
2086 cb => sub {
2087 (Coro::unblock_sub {
2088 write_runtime
2089 or warn "ERROR: unable to write runtime file: $!";
2090 })->();
2091 },
2092);
1231 2093
12321 20941
1233 2095

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines