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.88 by root, Fri Dec 15 19:29:18 2006 UTC vs.
Revision 1.114 by root, Mon Jan 1 16:00: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_socket 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)) {
89 no strict 'refs'; 144 no strict 'refs';
90 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 145 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
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...) 417=item $attachable->attach ($attachment, key => $value...)
154 418
155=item $map->detach ($attachment) 419=item $attachable->detach ($attachment)
156 420
157Attach/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.
158 423
159=item $bool = $object->attached ($name) 424Example, attach a minesweeper attachment to the given object, making it a
42510x10 minesweeper game:
160 426
161=item $bool = $player->attached ($name) 427 $obj->attach (minesweeper => width => 10, height => 10);
162 428
163=item $bool = $map->attached ($name) 429=item $bool = $attachable->attached ($name)
164 430
165Checks wether the named attachment is currently attached to the object. 431Checks wether the named attachment is currently attached to the object.
166 432
167=item cf::attach_global ... 433=item cf::CLASS->attach ...
168 434
169Attach handlers for global events. 435=item cf::CLASS->detach ...
170 436
171This and all following C<attach_*>-functions expect any number of the 437Define an anonymous attachment and attach it to all objects of the given
172following 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:
173 471
174=over 4 472=over 4
175 473
176=item prio => $number 474=item prio => $number
177 475
179by another C<prio> setting). Lower priority handlers get executed 477by another C<prio> setting). Lower priority handlers get executed
180earlier. 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
181registered at priority C<-1000>, so lower priorities should not be used 479registered at priority C<-1000>, so lower priorities should not be used
182unless you know what you are doing. 480unless you know what you are doing.
183 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
184=item on_I<event> => \&cb 488=item on_I<event> => \&cb
185 489
186Call the given code reference whenever the named event happens (event is 490Call 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 491something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
188handlers are recognised generally depends on the type of object these 492handlers are recognised generally depends on the type of object these
197package and register them. Only handlers for eevents supported by the 501package and register them. Only handlers for eevents supported by the
198object/class are recognised. 502object/class are recognised.
199 503
200=back 504=back
201 505
202=item cf::attach_to_type $object_type, $subtype, ... 506Example, define an attachment called "sockpuppet" that calls the given
507event handler when a monster attacks:
203 508
204Attach handlers for a specific object type (e.g. TRANSPORT) and 509 cf::object::attachment sockpuppet =>
205subtype. If C<$subtype> is zero or undef, matches all objects of the given 510 on_skill_attack => sub {
206type. 511 my ($self, $victim) = @_;
207 512 ...
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 } 513 }
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 514 }
429}
430 515
431=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 516=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 517
457Just 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
458C-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
459valid C counterpart anymore you get an exception at runtime. This method 520valid 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 521can be used to test for existence of the C object part without causing an
461exception. 522exception.
462 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
463=back 707=back
464 708
465=cut 709=cut
466
467*cf::object::valid =
468*cf::player::valid =
469*cf::map::valid = \&cf::_valid;
470 710
471############################################################################# 711#############################################################################
472# object support 712# object support
473 713
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 { 714sub reattach {
715 # basically do the same as instantiate, without calling instantiate
488 my ($obj) = @_; 716 my ($obj) = @_;
717
489 my $registry = $obj->registry; 718 my $registry = $obj->registry;
490 719
491 @$registry = (); 720 @$registry = ();
492 721
493 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 722 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
494 723
495 for my $name (keys %{ $obj->{_attachment} || {} }) { 724 for my $name (keys %{ $obj->{_attachment} || {} }) {
496 if (my $attach = $attachment{$name}) { 725 if (my $attach = $attachment{$name}) {
497 for (@$attach) { 726 for (@$attach) {
498 my ($klass, @attach) = @$_; 727 my ($klass, @attach) = @$_;
499 _attach @$registry, $klass, @attach; 728 _attach $registry, $klass, @attach;
500 } 729 }
501 } else { 730 } else {
502 warn "object uses attachment '$name' that is not available, postponing.\n"; 731 warn "object uses attachment '$name' that is not available, postponing.\n";
503 } 732 }
504 } 733 }
505} 734}
506 735
507sub object_freezer_save { 736cf::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, 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,
567 on_clone => sub { 750 on_clone => sub {
568 my ($src, $dst) = @_; 751 my ($src, $dst) = @_;
569 752
570 @{$dst->registry} = @{$src->registry}; 753 @{$dst->registry} = @{$src->registry};
571 754
572 %$dst = %$src; 755 %$dst = %$src;
573 756
574 %{$dst->{_attachment}} = %{$src->{_attachment}} 757 %{$dst->{_attachment}} = %{$src->{_attachment}}
575 if exists $src->{_attachment}; 758 if exists $src->{_attachment};
576 }, 759 },
577; 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}
578 824
579############################################################################# 825#############################################################################
580# command handling &c 826# command handling &c
581 827
582=item cf::register_command $name => \&callback($ob,$args); 828=item cf::register_command $name => \&callback($ob,$args);
611 #warn "registering extcmd '$name' to '$caller'"; 857 #warn "registering extcmd '$name' to '$caller'";
612 858
613 $EXTCMD{$name} = [$cb, $caller]; 859 $EXTCMD{$name} = [$cb, $caller];
614} 860}
615 861
616attach_to_players 862cf::player->attach (
617 on_command => sub { 863 on_command => sub {
618 my ($pl, $name, $params) = @_; 864 my ($pl, $name, $params) = @_;
619 865
620 my $cb = $COMMAND{$name} 866 my $cb = $COMMAND{$name}
621 or return; 867 or return;
641 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 887 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
642 } 888 }
643 889
644 cf::override; 890 cf::override;
645 }, 891 },
646; 892);
647 893
648sub register { 894sub register {
649 my ($base, $pkg) = @_; 895 my ($base, $pkg) = @_;
650 896
651 #TODO 897 #TODO
741 defined $path or return; 987 defined $path or return;
742 988
743 unlink "$path.pst"; 989 unlink "$path.pst";
744}; 990};
745 991
746attach_to_maps prio => -10000, package => cf::mapsupport::; 992cf::map->attach (prio => -10000, package => cf::mapsupport::);
747 993
748############################################################################# 994#############################################################################
749# load/save perl data associated with player->ob objects 995# load/save perl data associated with player->ob objects
750 996
751sub all_objects(@) { 997sub all_objects(@) {
752 @_, map all_objects ($_->inv), @_ 998 @_, map all_objects ($_->inv), @_
753} 999}
754 1000
755# TODO: compatibility cruft, remove when no longer needed 1001# TODO: compatibility cruft, remove when no longer needed
756attach_to_players 1002cf::player->attach (
757 on_load => sub { 1003 on_load => sub {
758 my ($pl, $path) = @_; 1004 my ($pl, $path) = @_;
759 1005
760 for my $o (all_objects $pl->ob) { 1006 for my $o (all_objects $pl->ob) {
761 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1007 if (my $value = $o->get_ob_key_value ("_perl_data")) {
763 1009
764 %$o = %{ Storable::thaw pack "H*", $value }; 1010 %$o = %{ Storable::thaw pack "H*", $value };
765 } 1011 }
766 } 1012 }
767 }, 1013 },
768; 1014);
769 1015
770############################################################################# 1016#############################################################################
771 1017
772=head2 CORE EXTENSIONS 1018=head2 CORE EXTENSIONS
773 1019
774Functions and methods that extend core crossfire objects. 1020Functions and methods that extend core crossfire objects.
1021
1022=head3 cf::player
775 1023
776=over 4 1024=over 4
777 1025
778=item cf::player::exists $login 1026=item cf::player::exists $login
779 1027
784sub cf::player::exists($) { 1032sub cf::player::exists($) {
785 cf::player::find $_[0] 1033 cf::player::find $_[0]
786 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;
787} 1035}
788 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
789=item $player_object->reply ($npc, $msg[, $flags]) 1348=item $player_object->reply ($npc, $msg[, $flags])
790 1349
791Sends 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>
792can 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
793dialogue with the given NPC character. 1352dialogue with the given NPC character.
794 1353
795=cut 1354=cut
796 1355
797# rough implementation of a future "reply" method that works 1356# rough implementation of a future "reply" method that works
798# with dialog boxes. 1357# with dialog boxes.
1358#TODO: the first argument must go, split into a $npc->reply_to ( method
799sub cf::object::player::reply($$$;$) { 1359sub cf::object::player::reply($$$;$) {
800 my ($self, $npc, $msg, $flags) = @_; 1360 my ($self, $npc, $msg, $flags) = @_;
801 1361
802 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1362 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
803 1363
807 $msg = $npc->name . " says: $msg" if $npc; 1367 $msg = $npc->name . " says: $msg" if $npc;
808 $self->message ($msg, $flags); 1368 $self->message ($msg, $flags);
809 } 1369 }
810} 1370}
811 1371
812=item $player->ext_reply ($msgid, $msgtype, %msg)
813
814Sends an ext reply to the player.
815
816=cut
817
818sub cf::player::ext_reply($$$%) {
819 my ($self, $id, %msg) = @_;
820
821 $msg{msgid} = $id;
822
823 $self->send ("ext " . to_json \%msg);
824}
825
826=item $player_object->may ("access") 1372=item $player_object->may ("access")
827 1373
828Returns wether the given player is authorized to access resource "access" 1374Returns wether the given player is authorized to access resource "access"
829(e.g. "command_wizcast"). 1375(e.g. "command_wizcast").
830 1376
837 (ref $cf::CFG{"may_$access"} 1383 (ref $cf::CFG{"may_$access"}
838 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1384 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839 : $cf::CFG{"may_$access"}) 1385 : $cf::CFG{"may_$access"})
840} 1386}
841 1387
842=cut 1388sub cf::object::player::enter_link {
1389 my ($self) = @_;
843 1390
844############################################################################# 1391 return if $self->map == $LINK_MAP;
1392
1393 $self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1394 if $self->map;
1395
1396 $self->enter_map ($LINK_MAP, 20, 20);
1397 $self->deactivate_recursive;
1398}
1399
1400sub cf::object::player::leave_link {
1401 my ($self, $map, $x, $y) = @_;
1402
1403 my $link_pos = delete $self->{_link_pos};
1404
1405 unless ($map) {
1406 $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1407
1408 # restore original map position
1409 ($map, $x, $y) = @{ $link_pos || [] };
1410 $map = cf::map::find_map $map;
1411
1412 unless ($map) {
1413 ($map, $x, $y) = @$EMERGENCY_POSITION;
1414 $map = cf::map::find_map $map
1415 or die "FATAL: cannot load emergency map\n";
1416 }
1417 }
1418
1419 ($x, $y) = (-1, -1)
1420 unless (defined $x) && (defined $y);
1421
1422 # use -1 or undef as default coordinates, not 0, 0
1423 ($x, $y) = ($map->enter_x, $map->enter_y)
1424 if $x <=0 && $y <= 0;
1425
1426 $map->load;
1427
1428 $self->activate_recursive;
1429 $self->enter_map ($map, $x, $y);
1430}
1431
1432=item $player_object->goto_map ($map, $x, $y)
1433
1434=cut
1435
1436sub cf::object::player::goto_map {
1437 my ($self, $path, $x, $y) = @_;
1438
1439 $self->enter_link;
1440
1441 (Coro::async {
1442 $path = new cf::path $path;
1443
1444 my $map = cf::map::find_map $path->as_string;
1445 $map = $map->customise_for ($self) if $map;
1446
1447 warn "entering ", $map->path, " at ($x, $y)\n"
1448 if $map;
1449
1450 $self->leave_link ($map, $x, $y);
1451 })->prio (1);
1452}
1453
1454=item $player_object->enter_exit ($exit_object)
1455
1456=cut
1457
1458sub parse_random_map_params {
1459 my ($spec) = @_;
1460
1461 my $rmp = { # defaults
1462 xsize => 10,
1463 ysize => 10,
1464 };
1465
1466 for (split /\n/, $spec) {
1467 my ($k, $v) = split /\s+/, $_, 2;
1468
1469 $rmp->{lc $k} = $v if (length $k) && (length $v);
1470 }
1471
1472 $rmp
1473}
1474
1475sub prepare_random_map {
1476 my ($exit) = @_;
1477
1478 # all this does is basically replace the /! path by
1479 # a new random map path (?random/...) with a seed
1480 # that depends on the exit object
1481
1482 my $rmp = parse_random_map_params $exit->msg;
1483
1484 if ($exit->map) {
1485 $rmp->{region} = $exit->map->region_name;
1486 $rmp->{origin_map} = $exit->map->path;
1487 $rmp->{origin_x} = $exit->x;
1488 $rmp->{origin_y} = $exit->y;
1489 }
1490
1491 $rmp->{random_seed} ||= $exit->random_seed;
1492
1493 my $data = cf::to_json $rmp;
1494 my $md5 = Digest::MD5::md5_hex $data;
1495
1496 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1497 aio_write $fh, 0, (length $data), $data, 0;
1498
1499 $exit->slaying ("?random/$md5");
1500 $exit->msg (undef);
1501 }
1502}
1503
1504sub cf::object::player::enter_exit {
1505 my ($self, $exit) = @_;
1506
1507 return unless $self->type == cf::PLAYER;
1508
1509 $self->enter_link;
1510
1511 (Coro::async {
1512 unless (eval {
1513
1514 prepare_random_map $exit
1515 if $exit->slaying eq "/!";
1516
1517 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1518 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1519
1520 1;
1521 }) {
1522 $self->message ("Something went wrong deep within the crossfire server. "
1523 . "I'll try to bring you back to the map you were before. "
1524 . "Please report this to the dungeon master",
1525 cf::NDI_UNIQUE | cf::NDI_RED);
1526
1527 warn "ERROR in enter_exit: $@";
1528 $self->leave_link;
1529 }
1530 })->prio (1);
1531}
1532
1533=head3 cf::client
1534
1535=over 4
1536
1537=item $client->send_drawinfo ($text, $flags)
1538
1539Sends a drawinfo packet to the client. Circumvents output buffering so
1540should not be used under normal circumstances.
1541
1542=cut
1543
1544sub cf::client::send_drawinfo {
1545 my ($self, $text, $flags) = @_;
1546
1547 utf8::encode $text;
1548 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1549}
1550
1551
1552=item $success = $client->query ($flags, "text", \&cb)
1553
1554Queues a query to the client, calling the given callback with
1555the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1556C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1557
1558Queries can fail, so check the return code. Or don't, as queries will become
1559reliable at some point in the future.
1560
1561=cut
1562
1563sub cf::client::query {
1564 my ($self, $flags, $text, $cb) = @_;
1565
1566 return unless $self->state == ST_PLAYING
1567 || $self->state == ST_SETUP
1568 || $self->state == ST_CUSTOM;
1569
1570 $self->state (ST_CUSTOM);
1571
1572 utf8::encode $text;
1573 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1574
1575 $self->send_packet ($self->{query_queue}[0][0])
1576 if @{ $self->{query_queue} } == 1;
1577}
1578
1579cf::client->attach (
1580 on_reply => sub {
1581 my ($ns, $msg) = @_;
1582
1583 # this weird shuffling is so that direct followup queries
1584 # get handled first
1585 my $queue = delete $ns->{query_queue};
1586
1587 (shift @$queue)->[1]->($msg);
1588
1589 push @{ $ns->{query_queue} }, @$queue;
1590
1591 if (@{ $ns->{query_queue} } == @$queue) {
1592 if (@$queue) {
1593 $ns->send_packet ($ns->{query_queue}[0][0]);
1594 } else {
1595 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1596 }
1597 }
1598 },
1599);
1600
1601=item $client->coro (\&cb)
1602
1603Create a new coroutine, running the specified callback. The coroutine will
1604be automatically cancelled when the client gets destroyed (e.g. on logout,
1605or loss of connection).
1606
1607=cut
1608
1609sub cf::client::coro {
1610 my ($self, $cb) = @_;
1611
1612 my $coro; $coro = async {
1613 eval {
1614 $cb->();
1615 };
1616 warn $@ if $@;
1617 };
1618
1619 $coro->on_destroy (sub {
1620 delete $self->{_coro}{$coro+0};
1621 });
1622
1623 $self->{_coro}{$coro+0} = $coro;
1624
1625 $coro
1626}
1627
1628cf::client->attach (
1629 on_destroy => sub {
1630 my ($ns) = @_;
1631
1632 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1633 },
1634);
1635
1636=back
1637
845 1638
846=head2 SAFE SCRIPTING 1639=head2 SAFE SCRIPTING
847 1640
848Functions that provide a safe environment to compile and execute 1641Functions that provide a safe environment to compile and execute
849snippets of perl code without them endangering the safety of the server 1642snippets of perl code without them endangering the safety of the server
864 1657
865=pod 1658=pod
866 1659
867The following fucntions and emthods are available within a safe environment: 1660The following fucntions and emthods are available within a safe environment:
868 1661
869 cf::object contr pay_amount pay_player 1662 cf::object contr pay_amount pay_player map
870 cf::object::player player 1663 cf::object::player player
871 cf::player peaceful 1664 cf::player peaceful
1665 cf::map trigger
872 1666
873=cut 1667=cut
874 1668
875for ( 1669for (
876 ["cf::object" => qw(contr pay_amount pay_player)], 1670 ["cf::object" => qw(contr pay_amount pay_player map)],
877 ["cf::object::player" => qw(player)], 1671 ["cf::object::player" => qw(player)],
878 ["cf::player" => qw(peaceful)], 1672 ["cf::player" => qw(peaceful)],
1673 ["cf::map" => qw(trigger)],
879) { 1674) {
880 no strict 'refs'; 1675 no strict 'refs';
881 my ($pkg, @funs) = @$_; 1676 my ($pkg, @funs) = @$_;
882 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 1677 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883 for @funs; 1678 for @funs;
1047 $DB->{$_[0]} = $_[1]; 1842 $DB->{$_[0]} = $_[1];
1048 } 1843 }
1049 db_dirty; 1844 db_dirty;
1050 } 1845 }
1051 1846
1052 attach_global 1847 cf::global->attach (
1053 prio => 10000, 1848 prio => 10000,
1054 on_cleanup => sub { 1849 on_cleanup => sub {
1055 db_sync; 1850 db_sync;
1056 }, 1851 },
1057 ; 1852 );
1058} 1853}
1059 1854
1060############################################################################# 1855#############################################################################
1061# the server's main() 1856# the server's main()
1062 1857
1067 local $/; 1862 local $/;
1068 *CFG = YAML::Syck::Load <$fh>; 1863 *CFG = YAML::Syck::Load <$fh>;
1069} 1864}
1070 1865
1071sub main { 1866sub main {
1867 # we must not ever block the main coroutine
1868 local $Coro::idle = sub {
1869 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
1870 (Coro::unblock_sub {
1871 Event::one_event;
1872 })->();
1873 };
1874
1072 cfg_load; 1875 cfg_load;
1073 db_load; 1876 db_load;
1074 load_extensions; 1877 load_extensions;
1075 Event::loop; 1878 Event::loop;
1076} 1879}
1077 1880
1078############################################################################# 1881#############################################################################
1079# initialisation 1882# initialisation
1080 1883
1081sub _perl_reload(&) { 1884sub reload() {
1082 my ($msg) = @_; 1885 # can/must only be called in main
1886 if ($Coro::current != $Coro::main) {
1887 warn "can only reload from main coroutine\n";
1888 return;
1889 }
1083 1890
1084 $msg->("reloading..."); 1891 warn "reloading...";
1892
1893 local $FREEZE = 1;
1894 cf::emergency_save;
1085 1895
1086 eval { 1896 eval {
1897 # if anything goes wrong in here, we should simply crash as we already saved
1898
1087 # cancel all watchers 1899 # cancel all watchers
1088 for (Event::all_watchers) { 1900 for (Event::all_watchers) {
1089 $_->cancel if $_->data & WF_AUTOCANCEL; 1901 $_->cancel if $_->data & WF_AUTOCANCEL;
1090 } 1902 }
1091 1903
1904 # cancel all extension coros
1905 $_->cancel for values %EXT_CORO;
1906 %EXT_CORO = ();
1907
1092 # unload all extensions 1908 # unload all extensions
1093 for (@exts) { 1909 for (@exts) {
1094 $msg->("unloading <$_>"); 1910 warn "unloading <$_>";
1095 unload_extension $_; 1911 unload_extension $_;
1096 } 1912 }
1097 1913
1098 # unload all modules loaded from $LIBDIR 1914 # unload all modules loaded from $LIBDIR
1099 while (my ($k, $v) = each %INC) { 1915 while (my ($k, $v) = each %INC) {
1100 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 1916 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101 1917
1102 $msg->("removing <$k>"); 1918 warn "removing <$k>";
1103 delete $INC{$k}; 1919 delete $INC{$k};
1104 1920
1105 $k =~ s/\.pm$//; 1921 $k =~ s/\.pm$//;
1106 $k =~ s/\//::/g; 1922 $k =~ s/\//::/g;
1107 1923
1112 Symbol::delete_package $k; 1928 Symbol::delete_package $k;
1113 } 1929 }
1114 1930
1115 # sync database to disk 1931 # sync database to disk
1116 cf::db_sync; 1932 cf::db_sync;
1933 IO::AIO::flush;
1117 1934
1118 # get rid of safe::, as good as possible 1935 # get rid of safe::, as good as possible
1119 Symbol::delete_package "safe::$_" 1936 Symbol::delete_package "safe::$_"
1120 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 1937 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1121 1938
1122 # remove register_script_function callbacks 1939 # remove register_script_function callbacks
1123 # TODO 1940 # TODO
1124 1941
1125 # unload cf.pm "a bit" 1942 # unload cf.pm "a bit"
1128 # don't, removes xs symbols, too, 1945 # don't, removes xs symbols, too,
1129 # and global variables created in xs 1946 # and global variables created in xs
1130 #Symbol::delete_package __PACKAGE__; 1947 #Symbol::delete_package __PACKAGE__;
1131 1948
1132 # reload cf.pm 1949 # reload cf.pm
1133 $msg->("reloading cf.pm"); 1950 warn "reloading cf.pm";
1134 require cf; 1951 require cf;
1952 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1135 1953
1136 # load config and database again 1954 # load config and database again
1137 cf::cfg_load; 1955 cf::cfg_load;
1138 cf::db_load; 1956 cf::db_load;
1139 1957
1140 # load extensions 1958 # load extensions
1141 $msg->("load extensions"); 1959 warn "load extensions";
1142 cf::load_extensions; 1960 cf::load_extensions;
1143 1961
1144 # reattach attachments to objects 1962 # reattach attachments to objects
1145 $msg->("reattach"); 1963 warn "reattach";
1146 _global_reattach; 1964 _global_reattach;
1147 }; 1965 };
1148 $msg->($@) if $@;
1149 1966
1150 $msg->("reloaded"); 1967 if ($@) {
1968 warn $@;
1969 warn "error while reloading, exiting.";
1970 exit 1;
1971 }
1972
1973 warn "reloaded successfully";
1151}; 1974};
1152 1975
1153sub perl_reload() { 1976#############################################################################
1154 _perl_reload { 1977
1155 warn $_[0]; 1978unless ($LINK_MAP) {
1156 print "$_[0]\n"; 1979 $LINK_MAP = cf::map::new;
1157 }; 1980
1981 $LINK_MAP->width (41);
1982 $LINK_MAP->height (41);
1983 $LINK_MAP->alloc;
1984 $LINK_MAP->path ("{link}");
1985 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1986 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1987
1988 # dirty hack because... archetypes are not yet loaded
1989 Event->timer (
1990 after => 2,
1991 cb => sub {
1992 $_[0]->w->cancel;
1993
1994 # provide some exits "home"
1995 my $exit = cf::object::new "exit";
1996
1997 $exit->slaying ($EMERGENCY_POSITION->[0]);
1998 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
1999 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2000
2001 $LINK_MAP->insert ($exit->clone, 19, 19);
2002 $LINK_MAP->insert ($exit->clone, 19, 20);
2003 $LINK_MAP->insert ($exit->clone, 19, 21);
2004 $LINK_MAP->insert ($exit->clone, 20, 19);
2005 $LINK_MAP->insert ($exit->clone, 20, 21);
2006 $LINK_MAP->insert ($exit->clone, 21, 19);
2007 $LINK_MAP->insert ($exit->clone, 21, 20);
2008 $LINK_MAP->insert ($exit->clone, 21, 21);
2009
2010 $exit->destroy;
2011 });
2012
2013 $LINK_MAP->{deny_save} = 1;
2014 $LINK_MAP->{deny_reset} = 1;
2015
2016 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1158} 2017}
1159 2018
1160register "<global>", __PACKAGE__; 2019register "<global>", __PACKAGE__;
1161 2020
1162register_command "perl-reload" => sub { 2021register_command "reload" => sub {
1163 my ($who, $arg) = @_; 2022 my ($who, $arg) = @_;
1164 2023
1165 if ($who->flag (FLAG_WIZ)) { 2024 if ($who->flag (FLAG_WIZ)) {
1166 _perl_reload { 2025 $who->message ("start of reload.");
1167 warn $_[0]; 2026 reload;
1168 $who->message ($_[0]); 2027 $who->message ("end of reload.");
1169 };
1170 } 2028 }
1171}; 2029};
1172 2030
1173unshift @INC, $LIBDIR; 2031unshift @INC, $LIBDIR;
1174 2032
1175$TICK_WATCHER = Event->timer ( 2033$TICK_WATCHER = Event->timer (
2034 reentrant => 0,
1176 prio => 1, 2035 prio => 0,
1177 async => 1,
1178 at => $NEXT_TICK || 1, 2036 at => $NEXT_TICK || $TICK,
1179 data => WF_AUTOCANCEL, 2037 data => WF_AUTOCANCEL,
1180 cb => sub { 2038 cb => sub {
2039 unless ($FREEZE) {
1181 cf::server_tick; # one server iteration 2040 cf::server_tick; # one server iteration
2041 $RUNTIME += $TICK;
2042 }
1182 2043
1183 my $NOW = Event::time;
1184 $NEXT_TICK += $TICK; 2044 $NEXT_TICK += $TICK;
1185 2045
1186 # if we are delayed by four ticks or more, skip them all 2046 # if we are delayed by four ticks or more, skip them all
1187 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2047 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1188 2048
1189 $TICK_WATCHER->at ($NEXT_TICK); 2049 $TICK_WATCHER->at ($NEXT_TICK);
1190 $TICK_WATCHER->start; 2050 $TICK_WATCHER->start;
1191 }, 2051 },
1192); 2052);
1193 2053
1194IO::AIO::max_poll_time $TICK * 0.2; 2054IO::AIO::max_poll_time $TICK * 0.2;
1195 2055
2056Event->io (
1196Event->io (fd => IO::AIO::poll_fileno, 2057 fd => IO::AIO::poll_fileno,
1197 poll => 'r', 2058 poll => 'r',
1198 prio => 5, 2059 prio => 5,
1199 data => WF_AUTOCANCEL, 2060 data => WF_AUTOCANCEL,
1200 cb => \&IO::AIO::poll_cb); 2061 cb => \&IO::AIO::poll_cb,
2062);
2063
2064Event->timer (
2065 data => WF_AUTOCANCEL,
2066 after => 0,
2067 interval => 10,
2068 cb => sub {
2069 (Coro::unblock_sub {
2070 write_runtime
2071 or warn "ERROR: unable to write runtime file: $!";
2072 })->();
2073 },
2074);
1201 2075
12021 20761
1203 2077

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines