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.113 by root, Mon Jan 1 15:32:40 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 if ($path =~ s{^\?random/}{}) {
295 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
296 $self->{random} = cf::from_json $data;
297 } else {
298 if ($path =~ s{^~([^/]+)?}{}) {
299 $self->{user_rel} = 1;
300
301 if (defined $1) {
302 $self->{user} = $1;
303 } elsif ($base =~ m{^~([^/]+)/}) {
304 $self->{user} = $1;
305 } else {
306 warn "cannot resolve user-relative path without user <$path,$base>\n";
307 }
308 } elsif ($path =~ /^\//) {
309 # already absolute
310 } else {
311 $base =~ s{[^/]+/?$}{};
312 return $class->new ("$base/$path");
313 }
314
315 for ($path) {
316 redo if s{/\.?/}{/};
317 redo if s{/[^/]+/\.\./}{/};
318 }
319 }
320
321 $self->{path} = $path;
322
323 $self
324}
325
326# the name / primary key / in-game path
327sub as_string {
328 my ($self) = @_;
329
330 $self->{user_rel} ? "~$self->{user}$self->{path}"
331 : $self->{random} ? "?random/$self->{path}"
332 : $self->{path}
333}
334
335# the displayed name, this is a one way mapping
336sub visible_name {
337 my ($self) = @_;
338
339# if (my $rmp = $self->{random}) {
340# # todo: be more intelligent about this
341# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
342# } else {
343 $self->as_string
344# }
345}
346
347# escape the /'s in the path
348sub _escaped_path {
349 # ∕ is U+2215
350 (my $path = $_[0]{path}) =~ s/\//∕/g;
351 $path
352}
353
354# the original (read-only) location
355sub load_path {
356 my ($self) = @_;
357
358 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
359}
360
361# the temporary/swap location
362sub save_path {
363 my ($self) = @_;
364
365 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
366 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
367 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
368}
369
370# the unique path, might be eq to save_path
371sub uniq_path {
372 my ($self) = @_;
373
374 $self->{user_rel} || $self->{random}
375 ? undef
376 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
377}
378
379# return random map parameters, or undef
380sub random_map_params {
381 my ($self) = @_;
382
383 $self->{random}
384}
385
386# this is somewhat ugly, but style maps do need special treatment
387sub is_style_map {
388 $_[0]{path} =~ m{^/styles/}
389}
390
391package cf;
392
393#############################################################################
394
395=head2 ATTACHABLE OBJECTS
396
397Many objects in crossfire are so-called attachable objects. That means you can
398attach callbacks/event handlers (a collection of which is called an "attachment")
399to it. All such attachable objects support the following methods.
400
401In the following description, CLASS can be any of C<global>, C<object>
402C<player>, C<client> or C<map> (i.e. the attachable objects in
403crossfire+).
138 404
139=over 4 405=over 4
140 406
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...) 407=item $attachable->attach ($attachment, key => $value...)
160 408
161=item $client->detach ($attachment) 409=item $attachable->detach ($attachment)
162 410
163Attach/detach a pre-registered attachment to a map. 411Attach/detach a pre-registered attachment to a specific object and give it
412the specified key/value pairs as arguments.
164 413
165=item $bool = $object->attached ($name) 414Example, attach a minesweeper attachment to the given object, making it a
41510x10 minesweeper game:
166 416
167=item $bool = $player->attached ($name) 417 $obj->attach (minesweeper => width => 10, height => 10);
168 418
169=item $bool = $client->attached ($name) 419=item $bool = $attachable->attached ($name)
170
171=item $bool = $map->attached ($name)
172 420
173Checks wether the named attachment is currently attached to the object. 421Checks wether the named attachment is currently attached to the object.
174 422
175=item cf::attach_global ... 423=item cf::CLASS->attach ...
176 424
177Attach handlers for global events. 425=item cf::CLASS->detach ...
178 426
179This and all following C<attach_*>-functions expect any number of the 427Define an anonymous attachment and attach it to all objects of the given
180following handler/hook descriptions: 428CLASS. See the next function for an explanation of its arguments.
429
430You can attach to global events by using the C<cf::global> class.
431
432Example, log all player logins:
433
434 cf::player->attach (
435 on_login => sub {
436 my ($pl) = @_;
437 ...
438 },
439 );
440
441Example, attach to the jeweler skill:
442
443 cf::object->attach (
444 type => cf::SKILL,
445 subtype => cf::SK_JEWELER,
446 on_use_skill => sub {
447 my ($sk, $ob, $part, $dir, $msg) = @_;
448 ...
449 },
450 );
451
452=item cf::CLASS::attachment $name, ...
453
454Register an attachment by C<$name> through which attachable objects of the
455given CLASS can refer to this attachment.
456
457Some classes such as crossfire maps and objects can specify attachments
458that are attached at load/instantiate time, thus the need for a name.
459
460These calls expect any number of the following handler/hook descriptions:
181 461
182=over 4 462=over 4
183 463
184=item prio => $number 464=item prio => $number
185 465
187by another C<prio> setting). Lower priority handlers get executed 467by another C<prio> setting). Lower priority handlers get executed
188earlier. The default priority is C<0>, and many built-in handlers are 468earlier. The default priority is C<0>, and many built-in handlers are
189registered at priority C<-1000>, so lower priorities should not be used 469registered at priority C<-1000>, so lower priorities should not be used
190unless you know what you are doing. 470unless you know what you are doing.
191 471
472=item type => $type
473
474(Only for C<< cf::object->attach >> calls), limits the attachment to the
475given type of objects only (the additional parameter C<subtype> can be
476used to further limit to the given subtype).
477
192=item on_I<event> => \&cb 478=item on_I<event> => \&cb
193 479
194Call the given code reference whenever the named event happens (event is 480Call 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 481something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
196handlers are recognised generally depends on the type of object these 482handlers are recognised generally depends on the type of object these
205package and register them. Only handlers for eevents supported by the 491package and register them. Only handlers for eevents supported by the
206object/class are recognised. 492object/class are recognised.
207 493
208=back 494=back
209 495
210=item cf::attach_to_type $object_type, $subtype, ... 496Example, define an attachment called "sockpuppet" that calls the given
497event handler when a monster attacks:
211 498
212Attach handlers for a specific object type (e.g. TRANSPORT) and 499 cf::object::attachment sockpuppet =>
213subtype. If C<$subtype> is zero or undef, matches all objects of the given 500 on_skill_attack => sub {
214type. 501 my ($self, $victim) = @_;
215 502 ...
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 } 503 }
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 504 }
455}
456 505
457=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 506=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 507
485Just because you have a perl object does not mean that the corresponding 508Just 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 509C-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 510valid 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 511can be used to test for existence of the C object part without causing an
489exception. 512exception.
490 513
514=cut
515
516# the following variables are defined in .xs and must not be re-created
517our @CB_GLOBAL = (); # registry for all global events
518our @CB_ATTACHABLE = (); # registry for all attachables
519our @CB_OBJECT = (); # all objects (should not be used except in emergency)
520our @CB_PLAYER = ();
521our @CB_CLIENT = ();
522our @CB_TYPE = (); # registry for type (cf-object class) based events
523our @CB_MAP = ();
524
525my %attachment;
526
527sub _attach_cb($$$$) {
528 my ($registry, $event, $prio, $cb) = @_;
529
530 use sort 'stable';
531
532 $cb = [$prio, $cb];
533
534 @{$registry->[$event]} = sort
535 { $a->[0] cmp $b->[0] }
536 @{$registry->[$event] || []}, $cb;
537}
538
539# hack
540my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
541
542# attach handles attaching event callbacks
543# the only thing the caller has to do is pass the correct
544# registry (== where the callback attaches to).
545sub _attach {
546 my ($registry, $klass, @arg) = @_;
547
548 my $object_type;
549 my $prio = 0;
550 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
551
552 #TODO: get rid of this hack
553 if ($attachable_klass{$klass}) {
554 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
555 }
556
557 while (@arg) {
558 my $type = shift @arg;
559
560 if ($type eq "prio") {
561 $prio = shift @arg;
562
563 } elsif ($type eq "type") {
564 $object_type = shift @arg;
565 $registry = $CB_TYPE[$object_type] ||= [];
566
567 } elsif ($type eq "subtype") {
568 defined $object_type or Carp::croak "subtype specified without type";
569 my $object_subtype = shift @arg;
570 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
571
572 } elsif ($type eq "package") {
573 my $pkg = shift @arg;
574
575 while (my ($name, $id) = each %cb_id) {
576 if (my $cb = $pkg->can ($name)) {
577 _attach_cb $registry, $id, $prio, $cb;
578 }
579 }
580
581 } elsif (exists $cb_id{$type}) {
582 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
583
584 } elsif (ref $type) {
585 warn "attaching objects not supported, ignoring.\n";
586
587 } else {
588 shift @arg;
589 warn "attach argument '$type' not supported, ignoring.\n";
590 }
591 }
592}
593
594sub _object_attach {
595 my ($obj, $name, %arg) = @_;
596
597 return if exists $obj->{_attachment}{$name};
598
599 if (my $attach = $attachment{$name}) {
600 my $registry = $obj->registry;
601
602 for (@$attach) {
603 my ($klass, @attach) = @$_;
604 _attach $registry, $klass, @attach;
605 }
606
607 $obj->{$name} = \%arg;
608 } else {
609 warn "object uses attachment '$name' that is not available, postponing.\n";
610 }
611
612 $obj->{_attachment}{$name} = undef;
613}
614
615sub cf::attachable::attach {
616 if (ref $_[0]) {
617 _object_attach @_;
618 } else {
619 _attach shift->_attach_registry, @_;
620 }
621};
622
623# all those should be optimised
624sub cf::attachable::detach {
625 my ($obj, $name) = @_;
626
627 if (ref $obj) {
628 delete $obj->{_attachment}{$name};
629 reattach ($obj);
630 } else {
631 Carp::croak "cannot, currently, detach class attachments";
632 }
633};
634
635sub cf::attachable::attached {
636 my ($obj, $name) = @_;
637
638 exists $obj->{_attachment}{$name}
639}
640
641for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
642 eval "#line " . __LINE__ . " 'cf.pm'
643 sub cf::\L$klass\E::_attach_registry {
644 (\\\@CB_$klass, KLASS_$klass)
645 }
646
647 sub cf::\L$klass\E::attachment {
648 my \$name = shift;
649
650 \$attachment{\$name} = [[KLASS_$klass, \@_]];
651 }
652 ";
653 die if $@;
654}
655
656our $override;
657our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
658
659sub override {
660 $override = 1;
661 @invoke_results = ();
662}
663
664sub do_invoke {
665 my $event = shift;
666 my $callbacks = shift;
667
668 @invoke_results = ();
669
670 local $override;
671
672 for (@$callbacks) {
673 eval { &{$_->[1]} };
674
675 if ($@) {
676 warn "$@";
677 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
678 override;
679 }
680
681 return 1 if $override;
682 }
683
684 0
685}
686
687=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
688
689=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
690
691Generate an object-specific event with the given arguments.
692
693This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
694removed in future versions), and there is no public API to access override
695results (if you must, access C<@cf::invoke_results> directly).
696
491=back 697=back
492 698
493=cut 699=cut
494
495*cf::object::valid =
496*cf::player::valid =
497*cf::client::valid =
498*cf::map::valid = \&cf::_valid;
499 700
500############################################################################# 701#############################################################################
501# object support 702# object support
502 703
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 { 704sub reattach {
705 # basically do the same as instantiate, without calling instantiate
517 my ($obj) = @_; 706 my ($obj) = @_;
707
518 my $registry = $obj->registry; 708 my $registry = $obj->registry;
519 709
520 @$registry = (); 710 @$registry = ();
521 711
522 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 712 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
523 713
524 for my $name (keys %{ $obj->{_attachment} || {} }) { 714 for my $name (keys %{ $obj->{_attachment} || {} }) {
525 if (my $attach = $attachment{$name}) { 715 if (my $attach = $attachment{$name}) {
526 for (@$attach) { 716 for (@$attach) {
527 my ($klass, @attach) = @$_; 717 my ($klass, @attach) = @$_;
528 _attach @$registry, $klass, @attach; 718 _attach $registry, $klass, @attach;
529 } 719 }
530 } else { 720 } else {
531 warn "object uses attachment '$name' that is not available, postponing.\n"; 721 warn "object uses attachment '$name' that is not available, postponing.\n";
532 } 722 }
533 } 723 }
534} 724}
535 725
536sub object_freezer_save { 726cf::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, 727 prio => -1000000,
728 on_instantiate => sub {
729 my ($obj, $data) = @_;
730
731 $data = from_json $data;
732
733 for (@$data) {
734 my ($name, $args) = @$_;
735
736 $obj->attach ($name, %{$args || {} });
737 }
738 },
739 on_reattach => \&reattach,
596 on_clone => sub { 740 on_clone => sub {
597 my ($src, $dst) = @_; 741 my ($src, $dst) = @_;
598 742
599 @{$dst->registry} = @{$src->registry}; 743 @{$dst->registry} = @{$src->registry};
600 744
601 %$dst = %$src; 745 %$dst = %$src;
602 746
603 %{$dst->{_attachment}} = %{$src->{_attachment}} 747 %{$dst->{_attachment}} = %{$src->{_attachment}}
604 if exists $src->{_attachment}; 748 if exists $src->{_attachment};
605 }, 749 },
606; 750);
751
752sub object_freezer_save {
753 my ($filename, $rdata, $objs) = @_;
754
755 sync_job {
756 if (length $$rdata) {
757 warn sprintf "saving %s (%d,%d)\n",
758 $filename, length $$rdata, scalar @$objs;
759
760 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
761 chmod SAVE_MODE, $fh;
762 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
763 aio_fsync $fh;
764 close $fh;
765
766 if (@$objs) {
767 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
768 chmod SAVE_MODE, $fh;
769 my $data = Storable::nfreeze { version => 1, objs => $objs };
770 aio_write $fh, 0, (length $data), $data, 0;
771 aio_fsync $fh;
772 close $fh;
773 aio_rename "$filename.pst~", "$filename.pst";
774 }
775 } else {
776 aio_unlink "$filename.pst";
777 }
778
779 aio_rename "$filename~", $filename;
780 } else {
781 warn "FATAL: $filename~: $!\n";
782 }
783 } else {
784 aio_unlink $filename;
785 aio_unlink "$filename.pst";
786 }
787 }
788}
789
790sub object_freezer_as_string {
791 my ($rdata, $objs) = @_;
792
793 use Data::Dumper;
794
795 $$rdata . Dumper $objs
796}
797
798sub object_thawer_load {
799 my ($filename) = @_;
800
801 my ($data, $av);
802
803 (aio_load $filename, $data) >= 0
804 or return;
805
806 unless (aio_stat "$filename.pst") {
807 (aio_load "$filename.pst", $av) >= 0
808 or return;
809 $av = eval { (Storable::thaw $av)->{objs} };
810 }
811
812 return ($data, $av);
813}
607 814
608############################################################################# 815#############################################################################
609# command handling &c 816# command handling &c
610 817
611=item cf::register_command $name => \&callback($ob,$args); 818=item cf::register_command $name => \&callback($ob,$args);
640 #warn "registering extcmd '$name' to '$caller'"; 847 #warn "registering extcmd '$name' to '$caller'";
641 848
642 $EXTCMD{$name} = [$cb, $caller]; 849 $EXTCMD{$name} = [$cb, $caller];
643} 850}
644 851
645attach_to_players 852cf::player->attach (
646 on_command => sub { 853 on_command => sub {
647 my ($pl, $name, $params) = @_; 854 my ($pl, $name, $params) = @_;
648 855
649 my $cb = $COMMAND{$name} 856 my $cb = $COMMAND{$name}
650 or return; 857 or return;
670 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 877 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
671 } 878 }
672 879
673 cf::override; 880 cf::override;
674 }, 881 },
675; 882);
676 883
677sub register { 884sub register {
678 my ($base, $pkg) = @_; 885 my ($base, $pkg) = @_;
679 886
680 #TODO 887 #TODO
770 defined $path or return; 977 defined $path or return;
771 978
772 unlink "$path.pst"; 979 unlink "$path.pst";
773}; 980};
774 981
775attach_to_maps prio => -10000, package => cf::mapsupport::; 982cf::map->attach (prio => -10000, package => cf::mapsupport::);
776 983
777############################################################################# 984#############################################################################
778# load/save perl data associated with player->ob objects 985# load/save perl data associated with player->ob objects
779 986
780sub all_objects(@) { 987sub all_objects(@) {
781 @_, map all_objects ($_->inv), @_ 988 @_, map all_objects ($_->inv), @_
782} 989}
783 990
784# TODO: compatibility cruft, remove when no longer needed 991# TODO: compatibility cruft, remove when no longer needed
785attach_to_players 992cf::player->attach (
786 on_load => sub { 993 on_load => sub {
787 my ($pl, $path) = @_; 994 my ($pl, $path) = @_;
788 995
789 for my $o (all_objects $pl->ob) { 996 for my $o (all_objects $pl->ob) {
790 if (my $value = $o->get_ob_key_value ("_perl_data")) { 997 if (my $value = $o->get_ob_key_value ("_perl_data")) {
792 999
793 %$o = %{ Storable::thaw pack "H*", $value }; 1000 %$o = %{ Storable::thaw pack "H*", $value };
794 } 1001 }
795 } 1002 }
796 }, 1003 },
797; 1004);
798 1005
799############################################################################# 1006#############################################################################
800 1007
801=head2 CORE EXTENSIONS 1008=head2 CORE EXTENSIONS
802 1009
803Functions and methods that extend core crossfire objects. 1010Functions and methods that extend core crossfire objects.
1011
1012=head3 cf::player
804 1013
805=over 4 1014=over 4
806 1015
807=item cf::player::exists $login 1016=item cf::player::exists $login
808 1017
813sub cf::player::exists($) { 1022sub cf::player::exists($) {
814 cf::player::find $_[0] 1023 cf::player::find $_[0]
815 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1024 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
816} 1025}
817 1026
1027=item $player->ext_reply ($msgid, $msgtype, %msg)
1028
1029Sends an ext reply to the player.
1030
1031=cut
1032
1033sub cf::player::ext_reply($$$%) {
1034 my ($self, $id, %msg) = @_;
1035
1036 $msg{msgid} = $id;
1037
1038 $self->send ("ext " . to_json \%msg);
1039}
1040
1041=back
1042
1043
1044=head3 cf::map
1045
1046=over 4
1047
1048=cut
1049
1050package cf::map;
1051
1052use Fcntl;
1053use Coro::AIO;
1054
1055our $MAX_RESET = 7200;
1056our $DEFAULT_RESET = 3600;
1057
1058sub generate_random_map {
1059 my ($path, $rmp) = @_;
1060
1061 # mit "rum" bekleckern, nicht
1062 cf::map::_create_random_map
1063 $path,
1064 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1065 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1066 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1067 $rmp->{exit_on_final_map},
1068 $rmp->{xsize}, $rmp->{ysize},
1069 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1070 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1071 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1072 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1073 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1074 (cf::region::find $rmp->{region})
1075}
1076
1077# and all this just because we cannot iterate over
1078# all maps in C++...
1079sub change_all_map_light {
1080 my ($change) = @_;
1081
1082 $_->change_map_light ($change) for values %cf::MAP;
1083}
1084
1085sub try_load_header($) {
1086 my ($path) = @_;
1087
1088 utf8::encode $path;
1089 aio_open $path, O_RDONLY, 0
1090 or return;
1091
1092 my $map = cf::map::new
1093 or return;
1094
1095 $map->load_header ($path)
1096 or return;
1097
1098 $map->{load_path} = $path;
1099
1100 $map
1101}
1102
1103sub find_map {
1104 my ($path, $origin) = @_;
1105
1106 #warn "find_map<$path,$origin>\n";#d#
1107
1108 $path = new cf::path $path, $origin && $origin->path;
1109 my $key = $path->as_string;
1110
1111 $cf::MAP{$key} || do {
1112 # do it the slow way
1113 my $map = try_load_header $path->save_path;
1114
1115 if ($map) {
1116 # safety
1117 $map->{instantiate_time} = $cf::RUNTIME
1118 if $map->{instantiate_time} > $cf::RUNTIME;
1119 } else {
1120 if (my $rmp = $path->random_map_params) {
1121 $map = generate_random_map $key, $rmp;
1122 } else {
1123 $map = try_load_header $path->load_path;
1124 }
1125
1126 $map or return;
1127
1128 $map->{load_original} = 1;
1129 $map->{instantiate_time} = $cf::RUNTIME;
1130 $map->instantiate;
1131
1132 # per-player maps become, after loading, normal maps
1133 $map->per_player (0) if $path->{user_rel};
1134 }
1135
1136 $map->path ($key);
1137 $map->{path} = $path;
1138 $map->last_access ($cf::RUNTIME);
1139
1140 if ($map->should_reset) {
1141 $map->reset;
1142 $map = find_map $path;
1143 }
1144
1145 $cf::MAP{$key} = $map
1146 }
1147}
1148
1149sub load {
1150 my ($self) = @_;
1151
1152 return if $self->in_memory != cf::MAP_SWAPPED;
1153
1154 $self->in_memory (cf::MAP_LOADING);
1155
1156 my $path = $self->{path};
1157
1158 $self->alloc;
1159 $self->load_objects ($self->{load_path}, 1)
1160 or return;
1161
1162 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1163 if delete $self->{load_original};
1164
1165 if (my $uniq = $path->uniq_path) {
1166 utf8::encode $uniq;
1167 if (aio_open $uniq, O_RDONLY, 0) {
1168 $self->clear_unique_items;
1169 $self->load_objects ($uniq, 0);
1170 }
1171 }
1172
1173 # now do the right thing for maps
1174 $self->link_multipart_objects;
1175
1176 if ($self->{path}->is_style_map) {
1177 $self->{deny_save} = 1;
1178 $self->{deny_reset} = 1;
1179 } else {
1180 $self->fix_auto_apply;
1181 $self->decay_objects;
1182 $self->update_buttons;
1183 $self->set_darkness_map;
1184 $self->difficulty ($self->estimate_difficulty)
1185 unless $self->difficulty;
1186 $self->activate;
1187 }
1188
1189 $self->in_memory (cf::MAP_IN_MEMORY);
1190}
1191
1192sub load_map_sync {
1193 my ($path, $origin) = @_;
1194
1195 #warn "load_map_sync<$path, $origin>\n";#d#
1196
1197 cf::sync_job {
1198 my $map = cf::map::find_map $path, $origin
1199 or return;
1200 $map->load;
1201 $map
1202 }
1203}
1204
1205sub save {
1206 my ($self) = @_;
1207
1208 my $save = $self->{path}->save_path; utf8::encode $save;
1209 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1210
1211 $self->{last_save} = $cf::RUNTIME;
1212
1213 return unless $self->dirty;
1214
1215 $self->{load_path} = $save;
1216
1217 return if $self->{deny_save};
1218
1219 if ($uniq) {
1220 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1221 $self->save_objects ($uniq, cf::IO_UNIQUES);
1222 } else {
1223 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1224 }
1225}
1226
1227sub swap_out {
1228 my ($self) = @_;
1229
1230 return if $self->players;
1231 return if $self->in_memory != cf::MAP_IN_MEMORY;
1232 return if $self->{deny_save};
1233
1234 $self->save;
1235 $self->clear;
1236 $self->in_memory (cf::MAP_SWAPPED);
1237}
1238
1239sub reset_at {
1240 my ($self) = @_;
1241
1242 # TODO: safety, remove and allow resettable per-player maps
1243 return 1e100 if $self->{path}{user_rel};
1244 return 1e100 if $self->{deny_reset};
1245
1246 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1247 my $to = $self->reset_timeout || $DEFAULT_RESET;
1248 $to = $MAX_RESET if $to > $MAX_RESET;
1249
1250 $time + $to
1251}
1252
1253sub should_reset {
1254 my ($self) = @_;
1255
1256 $self->reset_at <= $cf::RUNTIME
1257}
1258
1259sub unlink_save {
1260 my ($self) = @_;
1261
1262 utf8::encode (my $save = $self->{path}->save_path);
1263 aioreq_pri 3; IO::AIO::aio_unlink $save;
1264 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1265}
1266
1267sub rename {
1268 my ($self, $new_path) = @_;
1269
1270 $self->unlink_save;
1271
1272 delete $cf::MAP{$self->path};
1273 $self->{path} = new cf::path $new_path;
1274 $self->path ($self->{path}->path);
1275 $cf::MAP{$self->path} = $self;
1276
1277 $self->save;
1278}
1279
1280sub reset {
1281 my ($self) = @_;
1282
1283 return if $self->players;
1284 return if $self->{path}{user_rel};#d#
1285
1286 warn "resetting map ", $self->path;#d#
1287
1288 delete $cf::MAP{$self->path};
1289
1290 $_->clear_links_to ($self) for values %cf::MAP;
1291
1292 $self->unlink_save;
1293 $self->destroy;
1294}
1295
1296sub customise_for {
1297 my ($map, $ob) = @_;
1298
1299 if ($map->per_player) {
1300 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
1301 }
1302
1303 $map
1304}
1305
1306sub emergency_save {
1307 local $cf::FREEZE = 1;
1308
1309 warn "enter emergency map save\n";
1310
1311 cf::sync_job {
1312 warn "begin emergency map save\n";
1313 $_->save for values %cf::MAP;
1314 };
1315
1316 warn "end emergency map save\n";
1317}
1318
1319package cf;
1320
1321=back
1322
1323
1324=head3 cf::object::player
1325
1326=over 4
1327
818=item $player_object->reply ($npc, $msg[, $flags]) 1328=item $player_object->reply ($npc, $msg[, $flags])
819 1329
820Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1330Sends 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 1331can be C<undef>. Does the right thing when the player is currently in a
822dialogue with the given NPC character. 1332dialogue with the given NPC character.
823 1333
824=cut 1334=cut
825 1335
826# rough implementation of a future "reply" method that works 1336# rough implementation of a future "reply" method that works
827# with dialog boxes. 1337# with dialog boxes.
1338#TODO: the first argument must go, split into a $npc->reply_to ( method
828sub cf::object::player::reply($$$;$) { 1339sub cf::object::player::reply($$$;$) {
829 my ($self, $npc, $msg, $flags) = @_; 1340 my ($self, $npc, $msg, $flags) = @_;
830 1341
831 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1342 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
832 1343
836 $msg = $npc->name . " says: $msg" if $npc; 1347 $msg = $npc->name . " says: $msg" if $npc;
837 $self->message ($msg, $flags); 1348 $self->message ($msg, $flags);
838 } 1349 }
839} 1350}
840 1351
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") 1352=item $player_object->may ("access")
856 1353
857Returns wether the given player is authorized to access resource "access" 1354Returns wether the given player is authorized to access resource "access"
858(e.g. "command_wizcast"). 1355(e.g. "command_wizcast").
859 1356
866 (ref $cf::CFG{"may_$access"} 1363 (ref $cf::CFG{"may_$access"}
867 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1364 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
868 : $cf::CFG{"may_$access"}) 1365 : $cf::CFG{"may_$access"})
869} 1366}
870 1367
871=cut 1368sub cf::object::player::enter_link {
1369 my ($self) = @_;
872 1370
873############################################################################# 1371 return if $self->map == $LINK_MAP;
1372
1373 $self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1374 if $self->map;
1375
1376 $self->enter_map ($LINK_MAP, 20, 20);
1377 $self->deactivate_recursive;
1378}
1379
1380sub cf::object::player::leave_link {
1381 my ($self, $map, $x, $y) = @_;
1382
1383 my $link_pos = delete $self->{_link_pos};
1384
1385 unless ($map) {
1386 $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1387
1388 # restore original map position
1389 ($map, $x, $y) = @{ $link_pos || [] };
1390 $map = cf::map::find_map $map;
1391
1392 unless ($map) {
1393 ($map, $x, $y) = @$EMERGENCY_POSITION;
1394 $map = cf::map::find_map $map
1395 or die "FATAL: cannot load emergency map\n";
1396 }
1397 }
1398
1399 ($x, $y) = (-1, -1)
1400 unless (defined $x) && (defined $y);
1401
1402 # use -1 or undef as default coordinates, not 0, 0
1403 ($x, $y) = ($map->enter_x, $map->enter_y)
1404 if $x <=0 && $y <= 0;
1405
1406 $map->load;
1407
1408 $self->activate_recursive;
1409 $self->enter_map ($map, $x, $y);
1410}
1411
1412=item $player_object->goto_map ($map, $x, $y)
1413
1414=cut
1415
1416sub cf::object::player::goto_map {
1417 my ($self, $path, $x, $y) = @_;
1418
1419 $self->enter_link;
1420
1421 (Coro::async {
1422 $path = new cf::path $path;
1423
1424 my $map = cf::map::find_map $path->as_string;
1425 $map = $map->customise_for ($self) if $map;
1426
1427 warn "entering ", $map->path, " at ($x, $y)\n"
1428 if $map;
1429
1430 $self->leave_link ($map, $x, $y);
1431 })->prio (1);
1432}
1433
1434=item $player_object->enter_exit ($exit_object)
1435
1436=cut
1437
1438sub parse_random_map_params {
1439 my ($spec) = @_;
1440
1441 my $rmp = { # defaults
1442 xsize => 10,
1443 ysize => 10,
1444 };
1445
1446 for (split /\n/, $spec) {
1447 my ($k, $v) = split /\s+/, $_, 2;
1448
1449 $rmp->{lc $k} = $v if (length $k) && (length $v);
1450 }
1451
1452 $rmp
1453}
1454
1455sub prepare_random_map {
1456 my ($exit) = @_;
1457
1458 # all this does is basically replace the /! path by
1459 # a new random map path (?random/...) with a seed
1460 # that depends on the exit object
1461
1462 my $rmp = parse_random_map_params $exit->msg;
1463
1464 if ($exit->map) {
1465 $rmp->{region} = $exit->map->region_name;
1466 $rmp->{origin_map} = $exit->map->path;
1467 $rmp->{origin_x} = $exit->x;
1468 $rmp->{origin_y} = $exit->y;
1469 }
1470
1471 $rmp->{random_seed} ||= $exit->random_seed;
1472
1473 my $data = cf::to_json $rmp;
1474 my $md5 = Digest::MD5::md5_hex $data;
1475
1476 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1477 aio_write $fh, 0, (length $data), $data, 0;
1478
1479 $exit->slaying ("?random/$md5");
1480 $exit->msg (undef);
1481 }
1482}
1483
1484sub cf::object::player::enter_exit {
1485 my ($self, $exit) = @_;
1486
1487 return unless $self->type == cf::PLAYER;
1488
1489 $self->enter_link;
1490
1491 (Coro::async {
1492 unless (eval {
1493
1494 prepare_random_map $exit
1495 if $exit->slaying eq "/!";
1496
1497 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1498 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1499
1500 1;
1501 }) {
1502 $self->message ("Something went wrong deep within the crossfire server. "
1503 . "I'll try to bring you back to the map you were before. "
1504 . "Please report this to the dungeon master",
1505 cf::NDI_UNIQUE | cf::NDI_RED);
1506
1507 warn "ERROR in enter_exit: $@";
1508 $self->leave_link;
1509 }
1510 })->prio (1);
1511}
1512
1513=head3 cf::client
1514
1515=over 4
1516
1517=item $client->send_drawinfo ($text, $flags)
1518
1519Sends a drawinfo packet to the client. Circumvents output buffering so
1520should not be used under normal circumstances.
1521
1522=cut
1523
1524sub cf::client::send_drawinfo {
1525 my ($self, $text, $flags) = @_;
1526
1527 utf8::encode $text;
1528 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1529}
1530
1531
1532=item $success = $client->query ($flags, "text", \&cb)
1533
1534Queues a query to the client, calling the given callback with
1535the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1536C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1537
1538Queries can fail, so check the return code. Or don't, as queries will become
1539reliable at some point in the future.
1540
1541=cut
1542
1543sub cf::client::query {
1544 my ($self, $flags, $text, $cb) = @_;
1545
1546 return unless $self->state == ST_PLAYING
1547 || $self->state == ST_SETUP
1548 || $self->state == ST_CUSTOM;
1549
1550 $self->state (ST_CUSTOM);
1551
1552 utf8::encode $text;
1553 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1554
1555 $self->send_packet ($self->{query_queue}[0][0])
1556 if @{ $self->{query_queue} } == 1;
1557}
1558
1559cf::client->attach (
1560 on_reply => sub {
1561 my ($ns, $msg) = @_;
1562
1563 # this weird shuffling is so that direct followup queries
1564 # get handled first
1565 my $queue = delete $ns->{query_queue};
1566
1567 (shift @$queue)->[1]->($msg);
1568
1569 push @{ $ns->{query_queue} }, @$queue;
1570
1571 if (@{ $ns->{query_queue} } == @$queue) {
1572 if (@$queue) {
1573 $ns->send_packet ($ns->{query_queue}[0][0]);
1574 } else {
1575 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1576 }
1577 }
1578 },
1579);
1580
1581=item $client->coro (\&cb)
1582
1583Create a new coroutine, running the specified callback. The coroutine will
1584be automatically cancelled when the client gets destroyed (e.g. on logout,
1585or loss of connection).
1586
1587=cut
1588
1589sub cf::client::coro {
1590 my ($self, $cb) = @_;
1591
1592 my $coro; $coro = async {
1593 eval {
1594 $cb->();
1595 };
1596 warn $@ if $@;
1597 };
1598
1599 $coro->on_destroy (sub {
1600 delete $self->{_coro}{$coro+0};
1601 });
1602
1603 $self->{_coro}{$coro+0} = $coro;
1604
1605 $coro
1606}
1607
1608cf::client->attach (
1609 on_destroy => sub {
1610 my ($ns) = @_;
1611
1612 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1613 },
1614);
1615
1616=back
1617
874 1618
875=head2 SAFE SCRIPTING 1619=head2 SAFE SCRIPTING
876 1620
877Functions that provide a safe environment to compile and execute 1621Functions that provide a safe environment to compile and execute
878snippets of perl code without them endangering the safety of the server 1622snippets of perl code without them endangering the safety of the server
1078 $DB->{$_[0]} = $_[1]; 1822 $DB->{$_[0]} = $_[1];
1079 } 1823 }
1080 db_dirty; 1824 db_dirty;
1081 } 1825 }
1082 1826
1083 attach_global 1827 cf::global->attach (
1084 prio => 10000, 1828 prio => 10000,
1085 on_cleanup => sub { 1829 on_cleanup => sub {
1086 db_sync; 1830 db_sync;
1087 }, 1831 },
1088 ; 1832 );
1089} 1833}
1090 1834
1091############################################################################# 1835#############################################################################
1092# the server's main() 1836# the server's main()
1093 1837
1098 local $/; 1842 local $/;
1099 *CFG = YAML::Syck::Load <$fh>; 1843 *CFG = YAML::Syck::Load <$fh>;
1100} 1844}
1101 1845
1102sub main { 1846sub main {
1847 # we must not ever block the main coroutine
1848 local $Coro::idle = sub {
1849 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
1850 (Coro::unblock_sub {
1851 Event::one_event;
1852 })->();
1853 };
1854
1103 cfg_load; 1855 cfg_load;
1104 db_load; 1856 db_load;
1105 load_extensions; 1857 load_extensions;
1106 Event::loop; 1858 Event::loop;
1107} 1859}
1108 1860
1109############################################################################# 1861#############################################################################
1110# initialisation 1862# initialisation
1111 1863
1112sub _perl_reload(&) { 1864sub reload() {
1113 my ($msg) = @_; 1865 # can/must only be called in main
1866 if ($Coro::current != $Coro::main) {
1867 warn "can only reload from main coroutine\n";
1868 return;
1869 }
1114 1870
1115 $msg->("reloading..."); 1871 warn "reloading...";
1872
1873 local $FREEZE = 1;
1874 cf::emergency_save;
1116 1875
1117 eval { 1876 eval {
1877 # if anything goes wrong in here, we should simply crash as we already saved
1878
1118 # cancel all watchers 1879 # cancel all watchers
1119 for (Event::all_watchers) { 1880 for (Event::all_watchers) {
1120 $_->cancel if $_->data & WF_AUTOCANCEL; 1881 $_->cancel if $_->data & WF_AUTOCANCEL;
1121 } 1882 }
1122 1883
1884 # cancel all extension coros
1885 $_->cancel for values %EXT_CORO;
1886 %EXT_CORO = ();
1887
1123 # unload all extensions 1888 # unload all extensions
1124 for (@exts) { 1889 for (@exts) {
1125 $msg->("unloading <$_>"); 1890 warn "unloading <$_>";
1126 unload_extension $_; 1891 unload_extension $_;
1127 } 1892 }
1128 1893
1129 # unload all modules loaded from $LIBDIR 1894 # unload all modules loaded from $LIBDIR
1130 while (my ($k, $v) = each %INC) { 1895 while (my ($k, $v) = each %INC) {
1131 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 1896 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1132 1897
1133 $msg->("removing <$k>"); 1898 warn "removing <$k>";
1134 delete $INC{$k}; 1899 delete $INC{$k};
1135 1900
1136 $k =~ s/\.pm$//; 1901 $k =~ s/\.pm$//;
1137 $k =~ s/\//::/g; 1902 $k =~ s/\//::/g;
1138 1903
1143 Symbol::delete_package $k; 1908 Symbol::delete_package $k;
1144 } 1909 }
1145 1910
1146 # sync database to disk 1911 # sync database to disk
1147 cf::db_sync; 1912 cf::db_sync;
1913 IO::AIO::flush;
1148 1914
1149 # get rid of safe::, as good as possible 1915 # get rid of safe::, as good as possible
1150 Symbol::delete_package "safe::$_" 1916 Symbol::delete_package "safe::$_"
1151 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 1917 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1152 1918
1153 # remove register_script_function callbacks 1919 # remove register_script_function callbacks
1154 # TODO 1920 # TODO
1155 1921
1156 # unload cf.pm "a bit" 1922 # unload cf.pm "a bit"
1159 # don't, removes xs symbols, too, 1925 # don't, removes xs symbols, too,
1160 # and global variables created in xs 1926 # and global variables created in xs
1161 #Symbol::delete_package __PACKAGE__; 1927 #Symbol::delete_package __PACKAGE__;
1162 1928
1163 # reload cf.pm 1929 # reload cf.pm
1164 $msg->("reloading cf.pm"); 1930 warn "reloading cf.pm";
1165 require cf; 1931 require cf;
1932 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1166 1933
1167 # load config and database again 1934 # load config and database again
1168 cf::cfg_load; 1935 cf::cfg_load;
1169 cf::db_load; 1936 cf::db_load;
1170 1937
1171 # load extensions 1938 # load extensions
1172 $msg->("load extensions"); 1939 warn "load extensions";
1173 cf::load_extensions; 1940 cf::load_extensions;
1174 1941
1175 # reattach attachments to objects 1942 # reattach attachments to objects
1176 $msg->("reattach"); 1943 warn "reattach";
1177 _global_reattach; 1944 _global_reattach;
1178 }; 1945 };
1179 $msg->($@) if $@;
1180 1946
1181 $msg->("reloaded"); 1947 if ($@) {
1948 warn $@;
1949 warn "error while reloading, exiting.";
1950 exit 1;
1951 }
1952
1953 warn "reloaded successfully";
1182}; 1954};
1183 1955
1184sub perl_reload() { 1956#############################################################################
1185 _perl_reload { 1957
1186 warn $_[0]; 1958unless ($LINK_MAP) {
1187 print "$_[0]\n"; 1959 $LINK_MAP = cf::map::new;
1188 }; 1960
1961 $LINK_MAP->width (41);
1962 $LINK_MAP->height (41);
1963 $LINK_MAP->alloc;
1964 $LINK_MAP->path ("{link}");
1965 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1966 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1967
1968 # dirty hack because... archetypes are not yet loaded
1969 Event->timer (
1970 after => 2,
1971 cb => sub {
1972 $_[0]->w->cancel;
1973
1974 # provide some exits "home"
1975 my $exit = cf::object::new "exit";
1976
1977 $exit->slaying ($EMERGENCY_POSITION->[0]);
1978 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
1979 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
1980
1981 $LINK_MAP->insert ($exit->clone, 19, 19);
1982 $LINK_MAP->insert ($exit->clone, 19, 20);
1983 $LINK_MAP->insert ($exit->clone, 19, 21);
1984 $LINK_MAP->insert ($exit->clone, 20, 19);
1985 $LINK_MAP->insert ($exit->clone, 20, 21);
1986 $LINK_MAP->insert ($exit->clone, 21, 19);
1987 $LINK_MAP->insert ($exit->clone, 21, 20);
1988 $LINK_MAP->insert ($exit->clone, 21, 21);
1989
1990 $exit->destroy;
1991 });
1992
1993 $LINK_MAP->{deny_save} = 1;
1994 $LINK_MAP->{deny_reset} = 1;
1995
1996 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1189} 1997}
1190 1998
1191register "<global>", __PACKAGE__; 1999register "<global>", __PACKAGE__;
1192 2000
1193register_command "perl-reload" => sub { 2001register_command "reload" => sub {
1194 my ($who, $arg) = @_; 2002 my ($who, $arg) = @_;
1195 2003
1196 if ($who->flag (FLAG_WIZ)) { 2004 if ($who->flag (FLAG_WIZ)) {
1197 _perl_reload { 2005 $who->message ("start of reload.");
1198 warn $_[0]; 2006 reload;
1199 $who->message ($_[0]); 2007 $who->message ("end of reload.");
1200 };
1201 } 2008 }
1202}; 2009};
1203 2010
1204unshift @INC, $LIBDIR; 2011unshift @INC, $LIBDIR;
1205 2012
1206$TICK_WATCHER = Event->timer ( 2013$TICK_WATCHER = Event->timer (
2014 reentrant => 0,
1207 prio => 0, 2015 prio => 0,
1208 at => $NEXT_TICK || 1, 2016 at => $NEXT_TICK || $TICK,
1209 data => WF_AUTOCANCEL, 2017 data => WF_AUTOCANCEL,
1210 cb => sub { 2018 cb => sub {
2019 unless ($FREEZE) {
1211 cf::server_tick; # one server iteration 2020 cf::server_tick; # one server iteration
2021 $RUNTIME += $TICK;
2022 }
1212 2023
1213 my $NOW = Event::time;
1214 $NEXT_TICK += $TICK; 2024 $NEXT_TICK += $TICK;
1215 2025
1216 # if we are delayed by four ticks or more, skip them all 2026 # if we are delayed by four ticks or more, skip them all
1217 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2027 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1218 2028
1219 $TICK_WATCHER->at ($NEXT_TICK); 2029 $TICK_WATCHER->at ($NEXT_TICK);
1220 $TICK_WATCHER->start; 2030 $TICK_WATCHER->start;
1221 }, 2031 },
1222); 2032);
1223 2033
1224IO::AIO::max_poll_time $TICK * 0.2; 2034IO::AIO::max_poll_time $TICK * 0.2;
1225 2035
2036Event->io (
1226Event->io (fd => IO::AIO::poll_fileno, 2037 fd => IO::AIO::poll_fileno,
1227 poll => 'r', 2038 poll => 'r',
1228 prio => 5, 2039 prio => 5,
1229 data => WF_AUTOCANCEL, 2040 data => WF_AUTOCANCEL,
1230 cb => \&IO::AIO::poll_cb); 2041 cb => \&IO::AIO::poll_cb,
2042);
2043
2044Event->timer (
2045 data => WF_AUTOCANCEL,
2046 after => 0,
2047 interval => 10,
2048 cb => sub {
2049 (Coro::unblock_sub {
2050 write_runtime
2051 or warn "ERROR: unable to write runtime file: $!";
2052 })->();
2053 },
2054);
1231 2055
12321 20561
1233 2057

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines