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.89 by root, Fri Dec 15 19:59:20 2006 UTC vs.
Revision 1.112 by root, Mon Jan 1 13:31:47 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...) 407=item $attachable->attach ($attachment, key => $value...)
154 408
155=item $map->detach ($attachment) 409=item $attachable->detach ($attachment)
156 410
157Attach/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.
158 413
159=item $bool = $object->attached ($name) 414Example, attach a minesweeper attachment to the given object, making it a
41510x10 minesweeper game:
160 416
161=item $bool = $player->attached ($name) 417 $obj->attach (minesweeper => width => 10, height => 10);
162 418
163=item $bool = $map->attached ($name) 419=item $bool = $attachable->attached ($name)
164 420
165Checks wether the named attachment is currently attached to the object. 421Checks wether the named attachment is currently attached to the object.
166 422
167=item cf::attach_global ... 423=item cf::CLASS->attach ...
168 424
169Attach handlers for global events. 425=item cf::CLASS->detach ...
170 426
171This and all following C<attach_*>-functions expect any number of the 427Define an anonymous attachment and attach it to all objects of the given
172following 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:
173 461
174=over 4 462=over 4
175 463
176=item prio => $number 464=item prio => $number
177 465
179by another C<prio> setting). Lower priority handlers get executed 467by another C<prio> setting). Lower priority handlers get executed
180earlier. 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
181registered at priority C<-1000>, so lower priorities should not be used 469registered at priority C<-1000>, so lower priorities should not be used
182unless you know what you are doing. 470unless you know what you are doing.
183 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
184=item on_I<event> => \&cb 478=item on_I<event> => \&cb
185 479
186Call the given code reference whenever the named event happens (event is 480Call the given code reference whenever the named event happens (event is
187something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 481something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
188handlers are recognised generally depends on the type of object these 482handlers are recognised generally depends on the type of object these
197package and register them. Only handlers for eevents supported by the 491package and register them. Only handlers for eevents supported by the
198object/class are recognised. 492object/class are recognised.
199 493
200=back 494=back
201 495
202=item cf::attach_to_type $object_type, $subtype, ... 496Example, define an attachment called "sockpuppet" that calls the given
497event handler when a monster attacks:
203 498
204Attach handlers for a specific object type (e.g. TRANSPORT) and 499 cf::object::attachment sockpuppet =>
205subtype. If C<$subtype> is zero or undef, matches all objects of the given 500 on_skill_attack => sub {
206type. 501 my ($self, $victim) = @_;
207 502 ...
208=item cf::attach_to_objects ...
209
210Attach handlers to all objects. Do not use this except for debugging or
211very rare events, as handlers are (obviously) called for I<all> objects in
212the game.
213
214=item cf::attach_to_players ...
215
216Attach handlers to all players.
217
218=item cf::attach_to_maps ...
219
220Attach handlers to all maps.
221
222=item cf:register_attachment $name, ...
223
224Register an attachment by name through which objects can refer to this
225attachment.
226
227=item cf:register_player_attachment $name, ...
228
229Register an attachment by name through which players can refer to this
230attachment.
231
232=item cf:register_map_attachment $name, ...
233
234Register an attachment by name through which maps can refer to this
235attachment.
236
237=cut
238
239# the following variables are defined in .xs and must not be re-created
240our @CB_GLOBAL = (); # registry for all global events
241our @CB_OBJECT = (); # all objects (should not be used except in emergency)
242our @CB_PLAYER = ();
243our @CB_TYPE = (); # registry for type (cf-object class) based events
244our @CB_MAP = ();
245
246my %attachment;
247
248sub _attach_cb($\%$$$) {
249 my ($registry, $undo, $event, $prio, $cb) = @_;
250
251 use sort 'stable';
252
253 $cb = [$prio, $cb];
254
255 @{$registry->[$event]} = sort
256 { $a->[0] cmp $b->[0] }
257 @{$registry->[$event] || []}, $cb;
258
259 push @{$undo->{cb}}, [$event, $cb];
260}
261
262# attach handles attaching event callbacks
263# the only thing the caller has to do is pass the correct
264# registry (== where the callback attaches to).
265sub _attach(\@$@) {
266 my ($registry, $klass, @arg) = @_;
267
268 my $prio = 0;
269
270 my %undo = (
271 registry => $registry,
272 cb => [],
273 );
274
275 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
276
277 while (@arg) {
278 my $type = shift @arg;
279
280 if ($type eq "prio") {
281 $prio = shift @arg;
282
283 } elsif ($type eq "package") {
284 my $pkg = shift @arg;
285
286 while (my ($name, $id) = each %cb_id) {
287 if (my $cb = $pkg->can ($name)) {
288 _attach_cb $registry, %undo, $id, $prio, $cb;
289 }
290 } 503 }
291
292 } elsif (exists $cb_id{$type}) {
293 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
294
295 } elsif (ref $type) {
296 warn "attaching objects not supported, ignoring.\n";
297
298 } else {
299 shift @arg;
300 warn "attach argument '$type' not supported, ignoring.\n";
301 }
302 }
303
304 \%undo
305}
306
307sub _attach_attachment {
308 my ($obj, $name, %arg) = @_;
309
310 return if exists $obj->{_attachment}{$name};
311
312 my $res;
313
314 if (my $attach = $attachment{$name}) {
315 my $registry = $obj->registry;
316
317 for (@$attach) {
318 my ($klass, @attach) = @$_;
319 $res = _attach @$registry, $klass, @attach;
320 }
321
322 $obj->{$name} = \%arg;
323 } else {
324 warn "object uses attachment '$name' that is not available, postponing.\n";
325 }
326
327 $obj->{_attachment}{$name} = undef;
328
329 $res->{attachment} = $name;
330 $res
331}
332
333*cf::object::attach =
334*cf::player::attach =
335*cf::map::attach = sub {
336 my ($obj, $name, %arg) = @_;
337
338 _attach_attachment $obj, $name, %arg;
339};
340
341# all those should be optimised
342*cf::object::detach =
343*cf::player::detach =
344*cf::map::detach = sub {
345 my ($obj, $name) = @_;
346
347 delete $obj->{_attachment}{$name};
348 reattach ($obj);
349};
350
351*cf::object::attached =
352*cf::player::attached =
353*cf::map::attached = sub {
354 my ($obj, $name) = @_;
355
356 exists $obj->{_attachment}{$name}
357};
358
359sub attach_global {
360 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
361}
362
363sub attach_to_type {
364 my $type = shift;
365 my $subtype = shift;
366
367 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
368}
369
370sub attach_to_objects {
371 _attach @CB_OBJECT, KLASS_OBJECT, @_
372}
373
374sub attach_to_players {
375 _attach @CB_PLAYER, KLASS_PLAYER, @_
376}
377
378sub attach_to_maps {
379 _attach @CB_MAP, KLASS_MAP, @_
380}
381
382sub register_attachment {
383 my $name = shift;
384
385 $attachment{$name} = [[KLASS_OBJECT, @_]];
386}
387
388sub register_player_attachment {
389 my $name = shift;
390
391 $attachment{$name} = [[KLASS_PLAYER, @_]];
392}
393
394sub register_map_attachment {
395 my $name = shift;
396
397 $attachment{$name} = [[KLASS_MAP, @_]];
398}
399
400our $override;
401our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
402
403sub override {
404 $override = 1;
405 @invoke_results = ();
406}
407
408sub do_invoke {
409 my $event = shift;
410 my $callbacks = shift;
411
412 @invoke_results = ();
413
414 local $override;
415
416 for (@$callbacks) {
417 eval { &{$_->[1]} };
418
419 if ($@) {
420 warn "$@";
421 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
422 override;
423 }
424
425 return 1 if $override;
426 }
427
428 0 504 }
429}
430 505
431=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 506=item $attachable->valid
432
433=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
434
435=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
436
437=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
438
439Generate a global/object/player/map-specific event with the given arguments.
440
441This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
442removed in future versions), and there is no public API to access override
443results (if you must, access C<@cf::invoke_results> directly).
444
445=back
446
447=cut
448
449#############################################################################
450
451=head2 METHODS VALID FOR ALL CORE OBJECTS
452
453=over 4
454
455=item $object->valid, $player->valid, $map->valid
456 507
457Just 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
458C-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
459valid C counterpart anymore you get an exception at runtime. This method 510valid C counterpart anymore you get an exception at runtime. This method
460can be used to test for existence of the C object part without causing an 511can be used to test for existence of the C object part without causing an
461exception. 512exception.
462 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
463=back 697=back
464 698
465=cut 699=cut
466
467*cf::object::valid =
468*cf::player::valid =
469*cf::map::valid = \&cf::_valid;
470 700
471############################################################################# 701#############################################################################
472# object support 702# object support
473 703
474sub instantiate {
475 my ($obj, $data) = @_;
476
477 $data = from_json $data;
478
479 for (@$data) {
480 my ($name, $args) = @$_;
481
482 $obj->attach ($name, %{$args || {} });
483 }
484}
485
486# basically do the same as instantiate, without calling instantiate
487sub reattach { 704sub reattach {
705 # basically do the same as instantiate, without calling instantiate
488 my ($obj) = @_; 706 my ($obj) = @_;
707
489 my $registry = $obj->registry; 708 my $registry = $obj->registry;
490 709
491 @$registry = (); 710 @$registry = ();
492 711
493 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 712 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
494 713
495 for my $name (keys %{ $obj->{_attachment} || {} }) { 714 for my $name (keys %{ $obj->{_attachment} || {} }) {
496 if (my $attach = $attachment{$name}) { 715 if (my $attach = $attachment{$name}) {
497 for (@$attach) { 716 for (@$attach) {
498 my ($klass, @attach) = @$_; 717 my ($klass, @attach) = @$_;
499 _attach @$registry, $klass, @attach; 718 _attach $registry, $klass, @attach;
500 } 719 }
501 } else { 720 } else {
502 warn "object uses attachment '$name' that is not available, postponing.\n"; 721 warn "object uses attachment '$name' that is not available, postponing.\n";
503 } 722 }
504 } 723 }
505} 724}
506 725
507sub object_freezer_save { 726cf::attachable->attach (
508 my ($filename, $rdata, $objs) = @_;
509
510 if (length $$rdata) {
511 warn sprintf "saving %s (%d,%d)\n",
512 $filename, length $$rdata, scalar @$objs;
513
514 if (open my $fh, ">:raw", "$filename~") {
515 chmod SAVE_MODE, $fh;
516 syswrite $fh, $$rdata;
517 close $fh;
518
519 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
520 chmod SAVE_MODE, $fh;
521 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
522 close $fh;
523 rename "$filename.pst~", "$filename.pst";
524 } else {
525 unlink "$filename.pst";
526 }
527
528 rename "$filename~", $filename;
529 } else {
530 warn "FATAL: $filename~: $!\n";
531 }
532 } else {
533 unlink $filename;
534 unlink "$filename.pst";
535 }
536}
537
538sub object_freezer_as_string {
539 my ($rdata, $objs) = @_;
540
541 use Data::Dumper;
542
543 $$rdata . Dumper $objs
544}
545
546sub object_thawer_load {
547 my ($filename) = @_;
548
549 local $/;
550
551 my $av;
552
553 #TODO: use sysread etc.
554 if (open my $data, "<:raw:perlio", $filename) {
555 $data = <$data>;
556 if (open my $pst, "<:raw:perlio", "$filename.pst") {
557 $av = eval { (Storable::thaw <$pst>)->{objs} };
558 }
559 return ($data, $av);
560 }
561
562 ()
563}
564
565attach_to_objects
566 prio => -1000000, 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,
567 on_clone => sub { 740 on_clone => sub {
568 my ($src, $dst) = @_; 741 my ($src, $dst) = @_;
569 742
570 @{$dst->registry} = @{$src->registry}; 743 @{$dst->registry} = @{$src->registry};
571 744
572 %$dst = %$src; 745 %$dst = %$src;
573 746
574 %{$dst->{_attachment}} = %{$src->{_attachment}} 747 %{$dst->{_attachment}} = %{$src->{_attachment}}
575 if exists $src->{_attachment}; 748 if exists $src->{_attachment};
576 }, 749 },
577; 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}
578 814
579############################################################################# 815#############################################################################
580# command handling &c 816# command handling &c
581 817
582=item cf::register_command $name => \&callback($ob,$args); 818=item cf::register_command $name => \&callback($ob,$args);
611 #warn "registering extcmd '$name' to '$caller'"; 847 #warn "registering extcmd '$name' to '$caller'";
612 848
613 $EXTCMD{$name} = [$cb, $caller]; 849 $EXTCMD{$name} = [$cb, $caller];
614} 850}
615 851
616attach_to_players 852cf::player->attach (
617 on_command => sub { 853 on_command => sub {
618 my ($pl, $name, $params) = @_; 854 my ($pl, $name, $params) = @_;
619 855
620 my $cb = $COMMAND{$name} 856 my $cb = $COMMAND{$name}
621 or return; 857 or return;
641 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 877 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
642 } 878 }
643 879
644 cf::override; 880 cf::override;
645 }, 881 },
646; 882);
647 883
648sub register { 884sub register {
649 my ($base, $pkg) = @_; 885 my ($base, $pkg) = @_;
650 886
651 #TODO 887 #TODO
741 defined $path or return; 977 defined $path or return;
742 978
743 unlink "$path.pst"; 979 unlink "$path.pst";
744}; 980};
745 981
746attach_to_maps prio => -10000, package => cf::mapsupport::; 982cf::map->attach (prio => -10000, package => cf::mapsupport::);
747 983
748############################################################################# 984#############################################################################
749# load/save perl data associated with player->ob objects 985# load/save perl data associated with player->ob objects
750 986
751sub all_objects(@) { 987sub all_objects(@) {
752 @_, map all_objects ($_->inv), @_ 988 @_, map all_objects ($_->inv), @_
753} 989}
754 990
755# TODO: compatibility cruft, remove when no longer needed 991# TODO: compatibility cruft, remove when no longer needed
756attach_to_players 992cf::player->attach (
757 on_load => sub { 993 on_load => sub {
758 my ($pl, $path) = @_; 994 my ($pl, $path) = @_;
759 995
760 for my $o (all_objects $pl->ob) { 996 for my $o (all_objects $pl->ob) {
761 if (my $value = $o->get_ob_key_value ("_perl_data")) { 997 if (my $value = $o->get_ob_key_value ("_perl_data")) {
763 999
764 %$o = %{ Storable::thaw pack "H*", $value }; 1000 %$o = %{ Storable::thaw pack "H*", $value };
765 } 1001 }
766 } 1002 }
767 }, 1003 },
768; 1004);
769 1005
770############################################################################# 1006#############################################################################
771 1007
772=head2 CORE EXTENSIONS 1008=head2 CORE EXTENSIONS
773 1009
774Functions and methods that extend core crossfire objects. 1010Functions and methods that extend core crossfire objects.
1011
1012=head3 cf::player
775 1013
776=over 4 1014=over 4
777 1015
778=item cf::player::exists $login 1016=item cf::player::exists $login
779 1017
784sub cf::player::exists($) { 1022sub cf::player::exists($) {
785 cf::player::find $_[0] 1023 cf::player::find $_[0]
786 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;
787} 1025}
788 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 reset {
1268 my ($self) = @_;
1269
1270 return if $self->players;
1271 return if $self->{path}{user_rel};#d#
1272
1273 warn "resetting map ", $self->path;#d#
1274
1275 delete $cf::MAP{$self->path};
1276
1277 $_->clear_links_to ($self) for values %cf::MAP;
1278
1279 $self->unlink_save;
1280 $self->destroy;
1281}
1282
1283sub customise_for {
1284 my ($map, $ob) = @_;
1285
1286 if ($map->per_player) {
1287 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
1288 }
1289
1290 $map
1291}
1292
1293sub emergency_save {
1294 local $cf::FREEZE = 1;
1295
1296 warn "enter emergency map save\n";
1297
1298 cf::sync_job {
1299 warn "begin emergency map save\n";
1300 $_->save for values %cf::MAP;
1301 };
1302
1303 warn "end emergency map save\n";
1304}
1305
1306package cf;
1307
1308=back
1309
1310
1311=head3 cf::object::player
1312
1313=over 4
1314
789=item $player_object->reply ($npc, $msg[, $flags]) 1315=item $player_object->reply ($npc, $msg[, $flags])
790 1316
791Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1317Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
792can be C<undef>. Does the right thing when the player is currently in a 1318can be C<undef>. Does the right thing when the player is currently in a
793dialogue with the given NPC character. 1319dialogue with the given NPC character.
794 1320
795=cut 1321=cut
796 1322
797# rough implementation of a future "reply" method that works 1323# rough implementation of a future "reply" method that works
798# with dialog boxes. 1324# with dialog boxes.
1325#TODO: the first argument must go, split into a $npc->reply_to ( method
799sub cf::object::player::reply($$$;$) { 1326sub cf::object::player::reply($$$;$) {
800 my ($self, $npc, $msg, $flags) = @_; 1327 my ($self, $npc, $msg, $flags) = @_;
801 1328
802 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1329 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
803 1330
807 $msg = $npc->name . " says: $msg" if $npc; 1334 $msg = $npc->name . " says: $msg" if $npc;
808 $self->message ($msg, $flags); 1335 $self->message ($msg, $flags);
809 } 1336 }
810} 1337}
811 1338
812=item $player->ext_reply ($msgid, $msgtype, %msg)
813
814Sends an ext reply to the player.
815
816=cut
817
818sub cf::player::ext_reply($$$%) {
819 my ($self, $id, %msg) = @_;
820
821 $msg{msgid} = $id;
822
823 $self->send ("ext " . to_json \%msg);
824}
825
826=item $player_object->may ("access") 1339=item $player_object->may ("access")
827 1340
828Returns wether the given player is authorized to access resource "access" 1341Returns wether the given player is authorized to access resource "access"
829(e.g. "command_wizcast"). 1342(e.g. "command_wizcast").
830 1343
837 (ref $cf::CFG{"may_$access"} 1350 (ref $cf::CFG{"may_$access"}
838 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1351 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
839 : $cf::CFG{"may_$access"}) 1352 : $cf::CFG{"may_$access"})
840} 1353}
841 1354
842=cut 1355sub cf::object::player::enter_link {
1356 my ($self) = @_;
843 1357
844############################################################################# 1358 return if $self->map == $LINK_MAP;
1359
1360 $self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1361 if $self->map;
1362
1363 $self->enter_map ($LINK_MAP, 20, 20);
1364 $self->deactivate_recursive;
1365}
1366
1367sub cf::object::player::leave_link {
1368 my ($self, $map, $x, $y) = @_;
1369
1370 my $link_pos = delete $self->{_link_pos};
1371
1372 unless ($map) {
1373 $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1374
1375 # restore original map position
1376 ($map, $x, $y) = @{ $link_pos || [] };
1377 $map = cf::map::find_map $map;
1378
1379 unless ($map) {
1380 ($map, $x, $y) = @$EMERGENCY_POSITION;
1381 $map = cf::map::find_map $map
1382 or die "FATAL: cannot load emergency map\n";
1383 }
1384 }
1385
1386 ($x, $y) = (-1, -1)
1387 unless (defined $x) && (defined $y);
1388
1389 # use -1 or undef as default coordinates, not 0, 0
1390 ($x, $y) = ($map->enter_x, $map->enter_y)
1391 if $x <=0 && $y <= 0;
1392
1393 $map->load;
1394
1395 $self->activate_recursive;
1396 $self->enter_map ($map, $x, $y);
1397}
1398
1399=item $player_object->goto_map ($map, $x, $y)
1400
1401=cut
1402
1403sub cf::object::player::goto_map {
1404 my ($self, $path, $x, $y) = @_;
1405
1406 $self->enter_link;
1407
1408 (Coro::async {
1409 $path = new cf::path $path;
1410
1411 my $map = cf::map::find_map $path->as_string;
1412 $map = $map->customise_for ($self) if $map;
1413
1414 warn "entering ", $map->path, " at ($x, $y)\n"
1415 if $map;
1416
1417 $self->leave_link ($map, $x, $y);
1418 })->prio (1);
1419}
1420
1421=item $player_object->enter_exit ($exit_object)
1422
1423=cut
1424
1425sub parse_random_map_params {
1426 my ($spec) = @_;
1427
1428 my $rmp = { # defaults
1429 xsize => 10,
1430 ysize => 10,
1431 };
1432
1433 for (split /\n/, $spec) {
1434 my ($k, $v) = split /\s+/, $_, 2;
1435
1436 $rmp->{lc $k} = $v if (length $k) && (length $v);
1437 }
1438
1439 $rmp
1440}
1441
1442sub prepare_random_map {
1443 my ($exit) = @_;
1444
1445 # all this does is basically replace the /! path by
1446 # a new random map path (?random/...) with a seed
1447 # that depends on the exit object
1448
1449 my $rmp = parse_random_map_params $exit->msg;
1450
1451 if ($exit->map) {
1452 $rmp->{region} = $exit->map->region_name;
1453 $rmp->{origin_map} = $exit->map->path;
1454 $rmp->{origin_x} = $exit->x;
1455 $rmp->{origin_y} = $exit->y;
1456 }
1457
1458 $rmp->{random_seed} ||= $exit->random_seed;
1459
1460 my $data = cf::to_json $rmp;
1461 my $md5 = Digest::MD5::md5_hex $data;
1462
1463 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1464 aio_write $fh, 0, (length $data), $data, 0;
1465
1466 $exit->slaying ("?random/$md5");
1467 $exit->msg (undef);
1468 }
1469}
1470
1471sub cf::object::player::enter_exit {
1472 my ($self, $exit) = @_;
1473
1474 return unless $self->type == cf::PLAYER;
1475
1476 $self->enter_link;
1477
1478 (Coro::async {
1479 unless (eval {
1480
1481 prepare_random_map $exit
1482 if $exit->slaying eq "/!";
1483
1484 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1485 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1486
1487 1;
1488 }) {
1489 $self->message ("Something went wrong deep within the crossfire server. "
1490 . "I'll try to bring you back to the map you were before. "
1491 . "Please report this to the dungeon master",
1492 cf::NDI_UNIQUE | cf::NDI_RED);
1493
1494 warn "ERROR in enter_exit: $@";
1495 $self->leave_link;
1496 }
1497 })->prio (1);
1498}
1499
1500=head3 cf::client
1501
1502=over 4
1503
1504=item $client->send_drawinfo ($text, $flags)
1505
1506Sends a drawinfo packet to the client. Circumvents output buffering so
1507should not be used under normal circumstances.
1508
1509=cut
1510
1511sub cf::client::send_drawinfo {
1512 my ($self, $text, $flags) = @_;
1513
1514 utf8::encode $text;
1515 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1516}
1517
1518
1519=item $success = $client->query ($flags, "text", \&cb)
1520
1521Queues a query to the client, calling the given callback with
1522the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1523C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1524
1525Queries can fail, so check the return code. Or don't, as queries will become
1526reliable at some point in the future.
1527
1528=cut
1529
1530sub cf::client::query {
1531 my ($self, $flags, $text, $cb) = @_;
1532
1533 return unless $self->state == ST_PLAYING
1534 || $self->state == ST_SETUP
1535 || $self->state == ST_CUSTOM;
1536
1537 $self->state (ST_CUSTOM);
1538
1539 utf8::encode $text;
1540 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1541
1542 $self->send_packet ($self->{query_queue}[0][0])
1543 if @{ $self->{query_queue} } == 1;
1544}
1545
1546cf::client->attach (
1547 on_reply => sub {
1548 my ($ns, $msg) = @_;
1549
1550 # this weird shuffling is so that direct followup queries
1551 # get handled first
1552 my $queue = delete $ns->{query_queue};
1553
1554 (shift @$queue)->[1]->($msg);
1555
1556 push @{ $ns->{query_queue} }, @$queue;
1557
1558 if (@{ $ns->{query_queue} } == @$queue) {
1559 if (@$queue) {
1560 $ns->send_packet ($ns->{query_queue}[0][0]);
1561 } else {
1562 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1563 }
1564 }
1565 },
1566);
1567
1568=item $client->coro (\&cb)
1569
1570Create a new coroutine, running the specified callback. The coroutine will
1571be automatically cancelled when the client gets destroyed (e.g. on logout,
1572or loss of connection).
1573
1574=cut
1575
1576sub cf::client::coro {
1577 my ($self, $cb) = @_;
1578
1579 my $coro; $coro = async {
1580 eval {
1581 $cb->();
1582 };
1583 warn $@ if $@;
1584 };
1585
1586 $coro->on_destroy (sub {
1587 delete $self->{_coro}{$coro+0};
1588 });
1589
1590 $self->{_coro}{$coro+0} = $coro;
1591
1592 $coro
1593}
1594
1595cf::client->attach (
1596 on_destroy => sub {
1597 my ($ns) = @_;
1598
1599 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1600 },
1601);
1602
1603=back
1604
845 1605
846=head2 SAFE SCRIPTING 1606=head2 SAFE SCRIPTING
847 1607
848Functions that provide a safe environment to compile and execute 1608Functions that provide a safe environment to compile and execute
849snippets of perl code without them endangering the safety of the server 1609snippets of perl code without them endangering the safety of the server
864 1624
865=pod 1625=pod
866 1626
867The following fucntions and emthods are available within a safe environment: 1627The following fucntions and emthods are available within a safe environment:
868 1628
869 cf::object contr pay_amount pay_player 1629 cf::object contr pay_amount pay_player map
870 cf::object::player player 1630 cf::object::player player
871 cf::player peaceful 1631 cf::player peaceful
1632 cf::map trigger
872 1633
873=cut 1634=cut
874 1635
875for ( 1636for (
876 ["cf::object" => qw(contr pay_amount pay_player)], 1637 ["cf::object" => qw(contr pay_amount pay_player map)],
877 ["cf::object::player" => qw(player)], 1638 ["cf::object::player" => qw(player)],
878 ["cf::player" => qw(peaceful)], 1639 ["cf::player" => qw(peaceful)],
1640 ["cf::map" => qw(trigger)],
879) { 1641) {
880 no strict 'refs'; 1642 no strict 'refs';
881 my ($pkg, @funs) = @$_; 1643 my ($pkg, @funs) = @$_;
882 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 1644 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
883 for @funs; 1645 for @funs;
1047 $DB->{$_[0]} = $_[1]; 1809 $DB->{$_[0]} = $_[1];
1048 } 1810 }
1049 db_dirty; 1811 db_dirty;
1050 } 1812 }
1051 1813
1052 attach_global 1814 cf::global->attach (
1053 prio => 10000, 1815 prio => 10000,
1054 on_cleanup => sub { 1816 on_cleanup => sub {
1055 db_sync; 1817 db_sync;
1056 }, 1818 },
1057 ; 1819 );
1058} 1820}
1059 1821
1060############################################################################# 1822#############################################################################
1061# the server's main() 1823# the server's main()
1062 1824
1067 local $/; 1829 local $/;
1068 *CFG = YAML::Syck::Load <$fh>; 1830 *CFG = YAML::Syck::Load <$fh>;
1069} 1831}
1070 1832
1071sub main { 1833sub main {
1834 # we must not ever block the main coroutine
1835 local $Coro::idle = sub {
1836 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
1837 (Coro::unblock_sub {
1838 Event::one_event;
1839 })->();
1840 };
1841
1072 cfg_load; 1842 cfg_load;
1073 db_load; 1843 db_load;
1074 load_extensions; 1844 load_extensions;
1075 Event::loop; 1845 Event::loop;
1076} 1846}
1077 1847
1078############################################################################# 1848#############################################################################
1079# initialisation 1849# initialisation
1080 1850
1081sub _perl_reload(&) { 1851sub reload() {
1082 my ($msg) = @_; 1852 # can/must only be called in main
1853 if ($Coro::current != $Coro::main) {
1854 warn "can only reload from main coroutine\n";
1855 return;
1856 }
1083 1857
1084 $msg->("reloading..."); 1858 warn "reloading...";
1859
1860 local $FREEZE = 1;
1861 cf::emergency_save;
1085 1862
1086 eval { 1863 eval {
1864 # if anything goes wrong in here, we should simply crash as we already saved
1865
1087 # cancel all watchers 1866 # cancel all watchers
1088 for (Event::all_watchers) { 1867 for (Event::all_watchers) {
1089 $_->cancel if $_->data & WF_AUTOCANCEL; 1868 $_->cancel if $_->data & WF_AUTOCANCEL;
1090 } 1869 }
1091 1870
1871 # cancel all extension coros
1872 $_->cancel for values %EXT_CORO;
1873 %EXT_CORO = ();
1874
1092 # unload all extensions 1875 # unload all extensions
1093 for (@exts) { 1876 for (@exts) {
1094 $msg->("unloading <$_>"); 1877 warn "unloading <$_>";
1095 unload_extension $_; 1878 unload_extension $_;
1096 } 1879 }
1097 1880
1098 # unload all modules loaded from $LIBDIR 1881 # unload all modules loaded from $LIBDIR
1099 while (my ($k, $v) = each %INC) { 1882 while (my ($k, $v) = each %INC) {
1100 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 1883 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1101 1884
1102 $msg->("removing <$k>"); 1885 warn "removing <$k>";
1103 delete $INC{$k}; 1886 delete $INC{$k};
1104 1887
1105 $k =~ s/\.pm$//; 1888 $k =~ s/\.pm$//;
1106 $k =~ s/\//::/g; 1889 $k =~ s/\//::/g;
1107 1890
1112 Symbol::delete_package $k; 1895 Symbol::delete_package $k;
1113 } 1896 }
1114 1897
1115 # sync database to disk 1898 # sync database to disk
1116 cf::db_sync; 1899 cf::db_sync;
1900 IO::AIO::flush;
1117 1901
1118 # get rid of safe::, as good as possible 1902 # get rid of safe::, as good as possible
1119 Symbol::delete_package "safe::$_" 1903 Symbol::delete_package "safe::$_"
1120 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 1904 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1121 1905
1122 # remove register_script_function callbacks 1906 # remove register_script_function callbacks
1123 # TODO 1907 # TODO
1124 1908
1125 # unload cf.pm "a bit" 1909 # unload cf.pm "a bit"
1128 # don't, removes xs symbols, too, 1912 # don't, removes xs symbols, too,
1129 # and global variables created in xs 1913 # and global variables created in xs
1130 #Symbol::delete_package __PACKAGE__; 1914 #Symbol::delete_package __PACKAGE__;
1131 1915
1132 # reload cf.pm 1916 # reload cf.pm
1133 $msg->("reloading cf.pm"); 1917 warn "reloading cf.pm";
1134 require cf; 1918 require cf;
1919 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1135 1920
1136 # load config and database again 1921 # load config and database again
1137 cf::cfg_load; 1922 cf::cfg_load;
1138 cf::db_load; 1923 cf::db_load;
1139 1924
1140 # load extensions 1925 # load extensions
1141 $msg->("load extensions"); 1926 warn "load extensions";
1142 cf::load_extensions; 1927 cf::load_extensions;
1143 1928
1144 # reattach attachments to objects 1929 # reattach attachments to objects
1145 $msg->("reattach"); 1930 warn "reattach";
1146 _global_reattach; 1931 _global_reattach;
1147 }; 1932 };
1148 $msg->($@) if $@;
1149 1933
1150 $msg->("reloaded"); 1934 if ($@) {
1935 warn $@;
1936 warn "error while reloading, exiting.";
1937 exit 1;
1938 }
1939
1940 warn "reloaded successfully";
1151}; 1941};
1152 1942
1153sub perl_reload() { 1943#############################################################################
1154 _perl_reload { 1944
1155 warn $_[0]; 1945unless ($LINK_MAP) {
1156 print "$_[0]\n"; 1946 $LINK_MAP = cf::map::new;
1157 }; 1947
1948 $LINK_MAP->width (41);
1949 $LINK_MAP->height (41);
1950 $LINK_MAP->alloc;
1951 $LINK_MAP->path ("{link}");
1952 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1953 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1954
1955 # dirty hack because... archetypes are not yet loaded
1956 Event->timer (
1957 after => 2,
1958 cb => sub {
1959 $_[0]->w->cancel;
1960
1961 # provide some exits "home"
1962 my $exit = cf::object::new "exit";
1963
1964 $exit->slaying ($EMERGENCY_POSITION->[0]);
1965 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
1966 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
1967
1968 $LINK_MAP->insert ($exit->clone, 19, 19);
1969 $LINK_MAP->insert ($exit->clone, 19, 20);
1970 $LINK_MAP->insert ($exit->clone, 19, 21);
1971 $LINK_MAP->insert ($exit->clone, 20, 19);
1972 $LINK_MAP->insert ($exit->clone, 20, 21);
1973 $LINK_MAP->insert ($exit->clone, 21, 19);
1974 $LINK_MAP->insert ($exit->clone, 21, 20);
1975 $LINK_MAP->insert ($exit->clone, 21, 21);
1976
1977 $exit->destroy;
1978 });
1979
1980 $LINK_MAP->{deny_save} = 1;
1981 $LINK_MAP->{deny_reset} = 1;
1982
1983 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1158} 1984}
1159 1985
1160register "<global>", __PACKAGE__; 1986register "<global>", __PACKAGE__;
1161 1987
1162register_command "perl-reload" => sub { 1988register_command "reload" => sub {
1163 my ($who, $arg) = @_; 1989 my ($who, $arg) = @_;
1164 1990
1165 if ($who->flag (FLAG_WIZ)) { 1991 if ($who->flag (FLAG_WIZ)) {
1166 _perl_reload { 1992 $who->message ("start of reload.");
1167 warn $_[0]; 1993 reload;
1168 $who->message ($_[0]); 1994 $who->message ("end of reload.");
1169 };
1170 } 1995 }
1171}; 1996};
1172 1997
1173unshift @INC, $LIBDIR; 1998unshift @INC, $LIBDIR;
1174 1999
1175$TICK_WATCHER = Event->timer ( 2000$TICK_WATCHER = Event->timer (
2001 reentrant => 0,
1176 prio => 1, 2002 prio => 0,
1177 async => 1,
1178 at => $NEXT_TICK || 1, 2003 at => $NEXT_TICK || $TICK,
1179 data => WF_AUTOCANCEL, 2004 data => WF_AUTOCANCEL,
1180 cb => sub { 2005 cb => sub {
2006 unless ($FREEZE) {
1181 cf::server_tick; # one server iteration 2007 cf::server_tick; # one server iteration
2008 $RUNTIME += $TICK;
2009 }
1182 2010
1183 my $NOW = Event::time;
1184 $NEXT_TICK += $TICK; 2011 $NEXT_TICK += $TICK;
1185 2012
1186 # if we are delayed by four ticks or more, skip them all 2013 # if we are delayed by four ticks or more, skip them all
1187 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2014 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1188 2015
1189 $TICK_WATCHER->at ($NEXT_TICK); 2016 $TICK_WATCHER->at ($NEXT_TICK);
1190 $TICK_WATCHER->start; 2017 $TICK_WATCHER->start;
1191 }, 2018 },
1192); 2019);
1193 2020
1194IO::AIO::max_poll_time $TICK * 0.2; 2021IO::AIO::max_poll_time $TICK * 0.2;
1195 2022
2023Event->io (
1196Event->io (fd => IO::AIO::poll_fileno, 2024 fd => IO::AIO::poll_fileno,
1197 poll => 'r', 2025 poll => 'r',
1198 prio => 5, 2026 prio => 5,
1199 data => WF_AUTOCANCEL, 2027 data => WF_AUTOCANCEL,
1200 cb => \&IO::AIO::poll_cb); 2028 cb => \&IO::AIO::poll_cb,
2029);
2030
2031Event->timer (
2032 data => WF_AUTOCANCEL,
2033 after => 0,
2034 interval => 10,
2035 cb => sub {
2036 (Coro::unblock_sub {
2037 write_runtime
2038 or warn "ERROR: unable to write runtime file: $!";
2039 })->();
2040 },
2041);
1201 2042
12021 20431
1203 2044

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines