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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines