ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines