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.119 by root, Tue Jan 2 08:26:42 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines