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.111 by root, Mon Jan 1 12:28:47 2007 UTC

1package cf; 1package cf;
2
3use utf8;
4use strict;
2 5
3use Symbol; 6use Symbol;
4use List::Util; 7use List::Util;
5use Storable; 8use Storable;
6use Opcode; 9use Opcode;
7use Safe; 10use Safe;
8use Safe::Hole; 11use Safe::Hole;
9 12
13use Coro 3.3;
14use Coro::Event;
15use Coro::Timer;
16use Coro::Signal;
17use Coro::Semaphore;
18use Coro::AIO;
19
20use Digest::MD5;
21use Fcntl;
10use IO::AIO (); 22use IO::AIO 2.31 ();
11use YAML::Syck (); 23use YAML::Syck ();
12use Time::HiRes; 24use Time::HiRes;
13use Event; 25
14$Event::Eval = 1; # no idea why this is required, but it is 26use Event; $Event::Eval = 1; # no idea why this is required, but it is
15 27
16# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? 28# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17$YAML::Syck::ImplicitUnicode = 1; 29$YAML::Syck::ImplicitUnicode = 1;
18 30
19use strict; 31$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
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 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
124=back 273=back
125 274
126=cut 275=cut
127 276
128############################################################################# 277#############################################################################
129 278
130=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+).
131 398
132=over 4 399=over 4
133 400
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...) 401=item $attachable->attach ($attachment, key => $value...)
147 402
148=item $map->detach ($attachment) 403=item $attachable->detach ($attachment)
149 404
150Attach/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.
151 407
152=item $bool = $object->attached ($name) 408Example, attach a minesweeper attachment to the given object, making it a
40910x10 minesweeper game:
153 410
154=item $bool = $player->attached ($name) 411 $obj->attach (minesweeper => width => 10, height => 10);
155 412
156=item $bool = $map->attached ($name) 413=item $bool = $attachable->attached ($name)
157 414
158Checks wether the named attachment is currently attached to the object. 415Checks wether the named attachment is currently attached to the object.
159 416
160=item cf::attach_global ... 417=item cf::CLASS->attach ...
161 418
162Attach handlers for global events. 419=item cf::CLASS->detach ...
163 420
164This and all following C<attach_*>-functions expect any number of the 421Define an anonymous attachment and attach it to all objects of the given
165following 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:
166 455
167=over 4 456=over 4
168 457
169=item prio => $number 458=item prio => $number
170 459
172by another C<prio> setting). Lower priority handlers get executed 461by another C<prio> setting). Lower priority handlers get executed
173earlier. 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
174registered at priority C<-1000>, so lower priorities should not be used 463registered at priority C<-1000>, so lower priorities should not be used
175unless you know what you are doing. 464unless you know what you are doing.
176 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
177=item on_I<event> => \&cb 472=item on_I<event> => \&cb
178 473
179Call the given code reference whenever the named event happens (event is 474Call 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 475something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
181handlers are recognised generally depends on the type of object these 476handlers are recognised generally depends on the type of object these
190package and register them. Only handlers for eevents supported by the 485package and register them. Only handlers for eevents supported by the
191object/class are recognised. 486object/class are recognised.
192 487
193=back 488=back
194 489
195=item cf::attach_to_type $object_type, $subtype, ... 490Example, define an attachment called "sockpuppet" that calls the given
491event handler when a monster attacks:
196 492
197Attach handlers for a specific object type (e.g. TRANSPORT) and 493 cf::object::attachment sockpuppet =>
198subtype. If C<$subtype> is zero or undef, matches all objects of the given 494 on_skill_attack => sub {
199type. 495 my ($self, $victim) = @_;
200 496 ...
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 } 497 }
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 498 }
422}
423 499
424=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 500=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 501
450Just 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
451C-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
452valid C counterpart anymore you get an exception at runtime. This method 504valid 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 505can be used to test for existence of the C object part without causing an
454exception. 506exception.
455 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
456=back 691=back
457 692
458=cut 693=cut
459
460*cf::object::valid =
461*cf::player::valid =
462*cf::map::valid = \&cf::_valid;
463 694
464############################################################################# 695#############################################################################
465# object support 696# object support
466 697
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 { 698sub reattach {
699 # basically do the same as instantiate, without calling instantiate
481 my ($obj) = @_; 700 my ($obj) = @_;
701
482 my $registry = $obj->registry; 702 my $registry = $obj->registry;
483 703
484 @$registry = (); 704 @$registry = ();
485 705
486 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 706 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
487 707
488 for my $name (keys %{ $obj->{_attachment} || {} }) { 708 for my $name (keys %{ $obj->{_attachment} || {} }) {
489 if (my $attach = $attachment{$name}) { 709 if (my $attach = $attachment{$name}) {
490 for (@$attach) { 710 for (@$attach) {
491 my ($klass, @attach) = @$_; 711 my ($klass, @attach) = @$_;
492 _attach @$registry, $klass, @attach; 712 _attach $registry, $klass, @attach;
493 } 713 }
494 } else { 714 } else {
495 warn "object uses attachment '$name' that is not available, postponing.\n"; 715 warn "object uses attachment '$name' that is not available, postponing.\n";
496 } 716 }
497 } 717 }
498} 718}
499 719
500sub object_freezer_save { 720cf::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, 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,
560 on_clone => sub { 734 on_clone => sub {
561 my ($src, $dst) = @_; 735 my ($src, $dst) = @_;
562 736
563 @{$dst->registry} = @{$src->registry}; 737 @{$dst->registry} = @{$src->registry};
564 738
565 %$dst = %$src; 739 %$dst = %$src;
566 740
567 %{$dst->{_attachment}} = %{$src->{_attachment}} 741 %{$dst->{_attachment}} = %{$src->{_attachment}}
568 if exists $src->{_attachment}; 742 if exists $src->{_attachment};
569 }, 743 },
570; 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}
571 808
572############################################################################# 809#############################################################################
573# command handling &c 810# command handling &c
574 811
575=item cf::register_command $name => \&callback($ob,$args); 812=item cf::register_command $name => \&callback($ob,$args);
604 #warn "registering extcmd '$name' to '$caller'"; 841 #warn "registering extcmd '$name' to '$caller'";
605 842
606 $EXTCMD{$name} = [$cb, $caller]; 843 $EXTCMD{$name} = [$cb, $caller];
607} 844}
608 845
609attach_to_players 846cf::player->attach (
610 on_command => sub { 847 on_command => sub {
611 my ($pl, $name, $params) = @_; 848 my ($pl, $name, $params) = @_;
612 849
613 my $cb = $COMMAND{$name} 850 my $cb = $COMMAND{$name}
614 or return; 851 or return;
634 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; 871 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
635 } 872 }
636 873
637 cf::override; 874 cf::override;
638 }, 875 },
639; 876);
640 877
641sub register { 878sub register {
642 my ($base, $pkg) = @_; 879 my ($base, $pkg) = @_;
643 880
644 #TODO 881 #TODO
713 950
714 Symbol::delete_package $pkg; 951 Symbol::delete_package $pkg;
715} 952}
716 953
717sub load_extensions { 954sub load_extensions {
718 my $LIBDIR = maps_directory "perl";
719
720 for my $ext (<$LIBDIR/*.ext>) { 955 for my $ext (<$LIBDIR/*.ext>) {
721 next unless -r $ext; 956 next unless -r $ext;
722 eval { 957 eval {
723 load_extension $ext; 958 load_extension $ext;
724 1 959 1
736 defined $path or return; 971 defined $path or return;
737 972
738 unlink "$path.pst"; 973 unlink "$path.pst";
739}; 974};
740 975
741attach_to_maps prio => -10000, package => cf::mapsupport::; 976cf::map->attach (prio => -10000, package => cf::mapsupport::);
742 977
743############################################################################# 978#############################################################################
744# load/save perl data associated with player->ob objects 979# load/save perl data associated with player->ob objects
745 980
746sub all_objects(@) { 981sub all_objects(@) {
747 @_, map all_objects ($_->inv), @_ 982 @_, map all_objects ($_->inv), @_
748} 983}
749 984
750# TODO: compatibility cruft, remove when no longer needed 985# TODO: compatibility cruft, remove when no longer needed
751attach_to_players 986cf::player->attach (
752 on_load => sub { 987 on_load => sub {
753 my ($pl, $path) = @_; 988 my ($pl, $path) = @_;
754 989
755 for my $o (all_objects $pl->ob) { 990 for my $o (all_objects $pl->ob) {
756 if (my $value = $o->get_ob_key_value ("_perl_data")) { 991 if (my $value = $o->get_ob_key_value ("_perl_data")) {
758 993
759 %$o = %{ Storable::thaw pack "H*", $value }; 994 %$o = %{ Storable::thaw pack "H*", $value };
760 } 995 }
761 } 996 }
762 }, 997 },
763; 998);
764 999
765############################################################################# 1000#############################################################################
766 1001
767=head2 CORE EXTENSIONS 1002=head2 CORE EXTENSIONS
768 1003
769Functions and methods that extend core crossfire objects. 1004Functions and methods that extend core crossfire objects.
1005
1006=head3 cf::player
770 1007
771=over 4 1008=over 4
772 1009
773=item cf::player::exists $login 1010=item cf::player::exists $login
774 1011
779sub cf::player::exists($) { 1016sub cf::player::exists($) {
780 cf::player::find $_[0] 1017 cf::player::find $_[0]
781 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;
782} 1019}
783 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->{load_original} = 1;
1126 $map->{instantiate_time} = $cf::RUNTIME;
1127 $map->instantiate;
1128
1129 # per-player maps become, after loading, normal maps
1130 $map->per_player (0) if $path->{user_rel};
1131 }
1132
1133 $map->path ($key);
1134 $map->{path} = $path;
1135 $map->last_access ($cf::RUNTIME);
1136
1137 $map->reset if $map->should_reset;
1138
1139 $cf::MAP{$key} = $map
1140 }
1141}
1142
1143sub load {
1144 my ($self) = @_;
1145
1146 return if $self->in_memory != cf::MAP_SWAPPED;
1147
1148 $self->in_memory (cf::MAP_LOADING);
1149
1150 my $path = $self->{path};
1151
1152 $self->alloc;
1153 $self->load_objects ($self->{load_path}, 1)
1154 or return;
1155
1156 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) if delete $self->{load_original};
1157
1158 if (my $uniq = $path->uniq_path) {
1159 utf8::encode $uniq;
1160 if (aio_open $uniq, O_RDONLY, 0) {
1161 $self->clear_unique_items;
1162 $self->load_objects ($uniq, 0);
1163 }
1164 }
1165
1166 # now do the right thing for maps
1167 $self->link_multipart_objects;
1168
1169 if ($self->{path}->is_style_map) {
1170 $self->{deny_save} = 1;
1171 $self->{deny_reset} = 1;
1172 } else {
1173 $self->fix_auto_apply;
1174 $self->decay_objects;
1175 $self->update_buttons;
1176 $self->set_darkness_map;
1177 $self->difficulty ($self->estimate_difficulty)
1178 unless $self->difficulty;
1179 $self->activate;
1180 }
1181
1182 $self->in_memory (cf::MAP_IN_MEMORY);
1183}
1184
1185sub load_map_sync {
1186 my ($path, $origin) = @_;
1187
1188 #warn "load_map_sync<$path, $origin>\n";#d#
1189
1190 cf::sync_job {
1191 my $map = cf::map::find_map $path, $origin
1192 or return;
1193 $map->load;
1194 $map
1195 }
1196}
1197
1198sub save {
1199 my ($self) = @_;
1200
1201 my $save = $self->{path}->save_path; utf8::encode $save;
1202 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1203
1204 $self->{last_save} = $cf::RUNTIME;
1205
1206 return unless $self->dirty;
1207
1208 $self->{load_path} = $save;
1209
1210 return if $self->{deny_save};
1211
1212 warn "saving map ", $self->path;
1213
1214 if ($uniq) {
1215 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1216 $self->save_objects ($uniq, cf::IO_UNIQUES);
1217 } else {
1218 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1219 }
1220}
1221
1222sub swap_out {
1223 my ($self) = @_;
1224
1225 return if $self->players;
1226 return if $self->in_memory != cf::MAP_IN_MEMORY;
1227 return if $self->{deny_save};
1228
1229 $self->save;
1230 $self->clear;
1231 $self->in_memory (cf::MAP_SWAPPED);
1232}
1233
1234sub should_reset {
1235 my ($map) = @_;
1236
1237 # TODO: safety, remove and allow resettable per-player maps
1238 return if $map->{path}{user_rel};#d#
1239 return if $map->{deny_reset};
1240 #return unless $map->reset_timeout;
1241
1242 my $time = $map->fixed_resettime ? $map->{instantiate_time} : $map->last_access;
1243 my $to = $map->reset_timeout || $DEFAULT_RESET;
1244 $to = $MAX_RESET if $to > $MAX_RESET;
1245
1246 $time + $to < $cf::RUNTIME
1247}
1248
1249sub unlink_save {
1250 my ($self) = @_;
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
1257sub reset {
1258 my ($self) = @_;
1259
1260 return if $self->players;
1261 return if $self->{path}{user_rel};#d#
1262
1263 warn "resetting map ", $self->path;#d#
1264
1265 delete $cf::MAP{$self->path};
1266
1267 $_->clear_links_to ($self) for values %cf::MAP;
1268
1269 $self->unlink_save;
1270 $self->destroy;
1271}
1272
1273sub customise_for {
1274 my ($map, $ob) = @_;
1275
1276 if ($map->per_player) {
1277 return cf::map::find_map "~" . $ob->name . "/" . $map->{path}{path};
1278 }
1279
1280 $map
1281}
1282
1283sub emergency_save {
1284 local $cf::FREEZE = 1;
1285
1286 warn "enter emergency map save\n";
1287
1288 cf::sync_job {
1289 warn "begin emergency map save\n";
1290 $_->save for values %cf::MAP;
1291 };
1292
1293 warn "end emergency map save\n";
1294}
1295
1296package cf;
1297
1298=back
1299
1300
1301=head3 cf::object::player
1302
1303=over 4
1304
784=item $player_object->reply ($npc, $msg[, $flags]) 1305=item $player_object->reply ($npc, $msg[, $flags])
785 1306
786Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1307Sends 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 1308can be C<undef>. Does the right thing when the player is currently in a
788dialogue with the given NPC character. 1309dialogue with the given NPC character.
789 1310
790=cut 1311=cut
791 1312
792# rough implementation of a future "reply" method that works 1313# rough implementation of a future "reply" method that works
793# with dialog boxes. 1314# with dialog boxes.
1315#TODO: the first argument must go, split into a $npc->reply_to ( method
794sub cf::object::player::reply($$$;$) { 1316sub cf::object::player::reply($$$;$) {
795 my ($self, $npc, $msg, $flags) = @_; 1317 my ($self, $npc, $msg, $flags) = @_;
796 1318
797 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1319 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
798 1320
802 $msg = $npc->name . " says: $msg" if $npc; 1324 $msg = $npc->name . " says: $msg" if $npc;
803 $self->message ($msg, $flags); 1325 $self->message ($msg, $flags);
804 } 1326 }
805} 1327}
806 1328
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") 1329=item $player_object->may ("access")
822 1330
823Returns wether the given player is authorized to access resource "access" 1331Returns wether the given player is authorized to access resource "access"
824(e.g. "command_wizcast"). 1332(e.g. "command_wizcast").
825 1333
832 (ref $cf::CFG{"may_$access"} 1340 (ref $cf::CFG{"may_$access"}
833 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} 1341 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
834 : $cf::CFG{"may_$access"}) 1342 : $cf::CFG{"may_$access"})
835} 1343}
836 1344
837=cut 1345sub cf::object::player::enter_link {
1346 my ($self) = @_;
838 1347
839############################################################################# 1348 return if $self->map == $LINK_MAP;
1349
1350 $self->{_link_pos} = [$self->map->{path}, $self->x, $self->y]
1351 if $self->map;
1352
1353 $self->enter_map ($LINK_MAP, 20, 20);
1354 $self->deactivate_recursive;
1355}
1356
1357sub cf::object::player::leave_link {
1358 my ($self, $map, $x, $y) = @_;
1359
1360 my $link_pos = delete $self->{_link_pos};
1361
1362 unless ($map) {
1363 $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1364
1365 # restore original map position
1366 ($map, $x, $y) = @{ $link_pos || [] };
1367 $map = cf::map::find_map $map;
1368
1369 unless ($map) {
1370 ($map, $x, $y) = @$EMERGENCY_POSITION;
1371 $map = cf::map::find_map $map
1372 or die "FATAL: cannot load emergency map\n";
1373 }
1374 }
1375
1376 ($x, $y) = (-1, -1)
1377 unless (defined $x) && (defined $y);
1378
1379 # use -1 or undef as default coordinates, not 0, 0
1380 ($x, $y) = ($map->enter_x, $map->enter_y)
1381 if $x <=0 && $y <= 0;
1382
1383 $map->load;
1384
1385 $self->activate_recursive;
1386 $self->enter_map ($map, $x, $y);
1387}
1388
1389=item $player_object->goto_map ($map, $x, $y)
1390
1391=cut
1392
1393sub cf::object::player::goto_map {
1394 my ($self, $path, $x, $y) = @_;
1395
1396 $self->enter_link;
1397
1398 (Coro::async {
1399 $path = new cf::path $path;
1400
1401 my $map = cf::map::find_map $path->as_string;
1402 $map = $map->customise_for ($self) if $map;
1403
1404 warn "entering ", $map->path, " at ($x, $y)\n"
1405 if $map;
1406
1407 $self->leave_link ($map, $x, $y);
1408 })->prio (1);
1409}
1410
1411=item $player_object->enter_exit ($exit_object)
1412
1413=cut
1414
1415sub parse_random_map_params {
1416 my ($spec) = @_;
1417
1418 my $rmp = { # defaults
1419 xsize => 10,
1420 ysize => 10,
1421 };
1422
1423 for (split /\n/, $spec) {
1424 my ($k, $v) = split /\s+/, $_, 2;
1425
1426 $rmp->{lc $k} = $v if (length $k) && (length $v);
1427 }
1428
1429 $rmp
1430}
1431
1432sub prepare_random_map {
1433 my ($exit) = @_;
1434
1435 # all this does is basically replace the /! path by
1436 # a new random map path (?random/...) with a seed
1437 # that depends on the exit object
1438
1439 my $rmp = parse_random_map_params $exit->msg;
1440
1441 if ($exit->map) {
1442 $rmp->{region} = $exit->map->region_name;
1443 $rmp->{origin_map} = $exit->map->path;
1444 $rmp->{origin_x} = $exit->x;
1445 $rmp->{origin_y} = $exit->y;
1446 }
1447
1448 $rmp->{random_seed} ||= $exit->random_seed;
1449
1450 my $data = cf::to_json $rmp;
1451 my $md5 = Digest::MD5::md5_hex $data;
1452
1453 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1454 aio_write $fh, 0, (length $data), $data, 0;
1455
1456 $exit->slaying ("?random/$md5");
1457 $exit->msg (undef);
1458 }
1459}
1460
1461sub cf::object::player::enter_exit {
1462 my ($self, $exit) = @_;
1463
1464 return unless $self->type == cf::PLAYER;
1465
1466 $self->enter_link;
1467
1468 (Coro::async {
1469 unless (eval {
1470
1471 prepare_random_map $exit
1472 if $exit->slaying eq "/!";
1473
1474 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1475 $self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
1476
1477 1;
1478 }) {
1479 $self->message ("Something went wrong deep within the crossfire server. "
1480 . "I'll try to bring you back to the map you were before. "
1481 . "Please report this to the dungeon master",
1482 cf::NDI_UNIQUE | cf::NDI_RED);
1483
1484 warn "ERROR in enter_exit: $@";
1485 $self->leave_link;
1486 }
1487 })->prio (1);
1488}
1489
1490=head3 cf::client
1491
1492=over 4
1493
1494=item $client->send_drawinfo ($text, $flags)
1495
1496Sends a drawinfo packet to the client. Circumvents output buffering so
1497should not be used under normal circumstances.
1498
1499=cut
1500
1501sub cf::client::send_drawinfo {
1502 my ($self, $text, $flags) = @_;
1503
1504 utf8::encode $text;
1505 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1506}
1507
1508
1509=item $success = $client->query ($flags, "text", \&cb)
1510
1511Queues a query to the client, calling the given callback with
1512the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1513C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1514
1515Queries can fail, so check the return code. Or don't, as queries will become
1516reliable at some point in the future.
1517
1518=cut
1519
1520sub cf::client::query {
1521 my ($self, $flags, $text, $cb) = @_;
1522
1523 return unless $self->state == ST_PLAYING
1524 || $self->state == ST_SETUP
1525 || $self->state == ST_CUSTOM;
1526
1527 $self->state (ST_CUSTOM);
1528
1529 utf8::encode $text;
1530 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1531
1532 $self->send_packet ($self->{query_queue}[0][0])
1533 if @{ $self->{query_queue} } == 1;
1534}
1535
1536cf::client->attach (
1537 on_reply => sub {
1538 my ($ns, $msg) = @_;
1539
1540 # this weird shuffling is so that direct followup queries
1541 # get handled first
1542 my $queue = delete $ns->{query_queue};
1543
1544 (shift @$queue)->[1]->($msg);
1545
1546 push @{ $ns->{query_queue} }, @$queue;
1547
1548 if (@{ $ns->{query_queue} } == @$queue) {
1549 if (@$queue) {
1550 $ns->send_packet ($ns->{query_queue}[0][0]);
1551 } else {
1552 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
1553 }
1554 }
1555 },
1556);
1557
1558=item $client->coro (\&cb)
1559
1560Create a new coroutine, running the specified callback. The coroutine will
1561be automatically cancelled when the client gets destroyed (e.g. on logout,
1562or loss of connection).
1563
1564=cut
1565
1566sub cf::client::coro {
1567 my ($self, $cb) = @_;
1568
1569 my $coro; $coro = async {
1570 eval {
1571 $cb->();
1572 };
1573 warn $@ if $@;
1574 };
1575
1576 $coro->on_destroy (sub {
1577 delete $self->{_coro}{$coro+0};
1578 });
1579
1580 $self->{_coro}{$coro+0} = $coro;
1581
1582 $coro
1583}
1584
1585cf::client->attach (
1586 on_destroy => sub {
1587 my ($ns) = @_;
1588
1589 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
1590 },
1591);
1592
1593=back
1594
840 1595
841=head2 SAFE SCRIPTING 1596=head2 SAFE SCRIPTING
842 1597
843Functions that provide a safe environment to compile and execute 1598Functions that provide a safe environment to compile and execute
844snippets of perl code without them endangering the safety of the server 1599snippets of perl code without them endangering the safety of the server
859 1614
860=pod 1615=pod
861 1616
862The following fucntions and emthods are available within a safe environment: 1617The following fucntions and emthods are available within a safe environment:
863 1618
864 cf::object contr pay_amount pay_player 1619 cf::object contr pay_amount pay_player map
865 cf::object::player player 1620 cf::object::player player
866 cf::player peaceful 1621 cf::player peaceful
1622 cf::map trigger
867 1623
868=cut 1624=cut
869 1625
870for ( 1626for (
871 ["cf::object" => qw(contr pay_amount pay_player)], 1627 ["cf::object" => qw(contr pay_amount pay_player map)],
872 ["cf::object::player" => qw(player)], 1628 ["cf::object::player" => qw(player)],
873 ["cf::player" => qw(peaceful)], 1629 ["cf::player" => qw(peaceful)],
1630 ["cf::map" => qw(trigger)],
874) { 1631) {
875 no strict 'refs'; 1632 no strict 'refs';
876 my ($pkg, @funs) = @$_; 1633 my ($pkg, @funs) = @$_;
877 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 1634 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
878 for @funs; 1635 for @funs;
1018 sub db_sync() { 1775 sub db_sync() {
1019 db_save if $dirty; 1776 db_save if $dirty;
1020 undef $dirty; 1777 undef $dirty;
1021 } 1778 }
1022 1779
1023 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { 1780 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
1024 db_sync; 1781 db_sync;
1025 }); 1782 });
1026 1783
1027 sub db_dirty() { 1784 sub db_dirty() {
1028 $dirty = 1; 1785 $dirty = 1;
1042 $DB->{$_[0]} = $_[1]; 1799 $DB->{$_[0]} = $_[1];
1043 } 1800 }
1044 db_dirty; 1801 db_dirty;
1045 } 1802 }
1046 1803
1047 attach_global 1804 cf::global->attach (
1048 prio => 10000, 1805 prio => 10000,
1049 on_cleanup => sub { 1806 on_cleanup => sub {
1050 db_sync; 1807 db_sync;
1051 }, 1808 },
1052 ; 1809 );
1053} 1810}
1054 1811
1055############################################################################# 1812#############################################################################
1056# the server's main() 1813# the server's main()
1057 1814
1062 local $/; 1819 local $/;
1063 *CFG = YAML::Syck::Load <$fh>; 1820 *CFG = YAML::Syck::Load <$fh>;
1064} 1821}
1065 1822
1066sub main { 1823sub main {
1824 # we must not ever block the main coroutine
1825 local $Coro::idle = sub {
1826 Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
1827 (Coro::unblock_sub {
1828 Event::one_event;
1829 })->();
1830 };
1831
1067 cfg_load; 1832 cfg_load;
1068 db_load; 1833 db_load;
1069 load_extensions; 1834 load_extensions;
1070 Event::loop; 1835 Event::loop;
1071} 1836}
1072 1837
1073############################################################################# 1838#############################################################################
1074# initialisation 1839# initialisation
1075 1840
1076sub _perl_reload(&) { 1841sub reload() {
1077 my ($msg) = @_; 1842 # can/must only be called in main
1843 if ($Coro::current != $Coro::main) {
1844 warn "can only reload from main coroutine\n";
1845 return;
1846 }
1078 1847
1079 $msg->("reloading..."); 1848 warn "reloading...";
1849
1850 local $FREEZE = 1;
1851 cf::emergency_save;
1080 1852
1081 eval { 1853 eval {
1854 # if anything goes wrong in here, we should simply crash as we already saved
1855
1082 # cancel all watchers 1856 # cancel all watchers
1083 $_->cancel for Event::all_watchers; 1857 for (Event::all_watchers) {
1858 $_->cancel if $_->data & WF_AUTOCANCEL;
1859 }
1860
1861 # cancel all extension coros
1862 $_->cancel for values %EXT_CORO;
1863 %EXT_CORO = ();
1084 1864
1085 # unload all extensions 1865 # unload all extensions
1086 for (@exts) { 1866 for (@exts) {
1087 $msg->("unloading <$_>"); 1867 warn "unloading <$_>";
1088 unload_extension $_; 1868 unload_extension $_;
1089 } 1869 }
1090 1870
1091 # unload all modules loaded from $LIBDIR 1871 # unload all modules loaded from $LIBDIR
1092 while (my ($k, $v) = each %INC) { 1872 while (my ($k, $v) = each %INC) {
1093 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 1873 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1094 1874
1095 $msg->("removing <$k>"); 1875 warn "removing <$k>";
1096 delete $INC{$k}; 1876 delete $INC{$k};
1097 1877
1098 $k =~ s/\.pm$//; 1878 $k =~ s/\.pm$//;
1099 $k =~ s/\//::/g; 1879 $k =~ s/\//::/g;
1100 1880
1105 Symbol::delete_package $k; 1885 Symbol::delete_package $k;
1106 } 1886 }
1107 1887
1108 # sync database to disk 1888 # sync database to disk
1109 cf::db_sync; 1889 cf::db_sync;
1890 IO::AIO::flush;
1110 1891
1111 # get rid of safe::, as good as possible 1892 # get rid of safe::, as good as possible
1112 Symbol::delete_package "safe::$_" 1893 Symbol::delete_package "safe::$_"
1113 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 1894 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1114 1895
1115 # remove register_script_function callbacks 1896 # remove register_script_function callbacks
1116 # TODO 1897 # TODO
1117 1898
1118 # unload cf.pm "a bit" 1899 # unload cf.pm "a bit"
1121 # don't, removes xs symbols, too, 1902 # don't, removes xs symbols, too,
1122 # and global variables created in xs 1903 # and global variables created in xs
1123 #Symbol::delete_package __PACKAGE__; 1904 #Symbol::delete_package __PACKAGE__;
1124 1905
1125 # reload cf.pm 1906 # reload cf.pm
1126 $msg->("reloading cf.pm"); 1907 warn "reloading cf.pm";
1127 require cf; 1908 require cf;
1909 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1128 1910
1129 # load config and database again 1911 # load config and database again
1130 cf::cfg_load; 1912 cf::cfg_load;
1131 cf::db_load; 1913 cf::db_load;
1132 1914
1133 # load extensions 1915 # load extensions
1134 $msg->("load extensions"); 1916 warn "load extensions";
1135 cf::load_extensions; 1917 cf::load_extensions;
1136 1918
1137 # reattach attachments to objects 1919 # reattach attachments to objects
1138 $msg->("reattach"); 1920 warn "reattach";
1139 _global_reattach; 1921 _global_reattach;
1140 }; 1922 };
1141 $msg->($@) if $@;
1142 1923
1143 $msg->("reloaded"); 1924 if ($@) {
1925 warn $@;
1926 warn "error while reloading, exiting.";
1927 exit 1;
1928 }
1929
1930 warn "reloaded successfully";
1144}; 1931};
1145 1932
1146sub perl_reload() { 1933#############################################################################
1147 _perl_reload { 1934
1148 warn $_[0]; 1935unless ($LINK_MAP) {
1149 print "$_[0]\n"; 1936 $LINK_MAP = cf::map::new;
1150 }; 1937
1938 $LINK_MAP->width (41);
1939 $LINK_MAP->height (41);
1940 $LINK_MAP->alloc;
1941 $LINK_MAP->path ("{link}");
1942 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
1943 $LINK_MAP->in_memory (MAP_IN_MEMORY);
1944
1945 # dirty hack because... archetypes are not yet loaded
1946 Event->timer (
1947 after => 2,
1948 cb => sub {
1949 $_[0]->w->cancel;
1950
1951 # provide some exits "home"
1952 my $exit = cf::object::new "exit";
1953
1954 $exit->slaying ($EMERGENCY_POSITION->[0]);
1955 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
1956 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
1957
1958 $LINK_MAP->insert ($exit->clone, 19, 19);
1959 $LINK_MAP->insert ($exit->clone, 19, 20);
1960 $LINK_MAP->insert ($exit->clone, 19, 21);
1961 $LINK_MAP->insert ($exit->clone, 20, 19);
1962 $LINK_MAP->insert ($exit->clone, 20, 21);
1963 $LINK_MAP->insert ($exit->clone, 21, 19);
1964 $LINK_MAP->insert ($exit->clone, 21, 20);
1965 $LINK_MAP->insert ($exit->clone, 21, 21);
1966
1967 $exit->destroy;
1968 });
1969
1970 $LINK_MAP->{deny_save} = 1;
1971 $LINK_MAP->{deny_reset} = 1;
1972
1973 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
1151} 1974}
1152 1975
1153register "<global>", __PACKAGE__; 1976register "<global>", __PACKAGE__;
1154 1977
1155register_command "perl-reload" => sub { 1978register_command "reload" => sub {
1156 my ($who, $arg) = @_; 1979 my ($who, $arg) = @_;
1157 1980
1158 if ($who->flag (FLAG_WIZ)) { 1981 if ($who->flag (FLAG_WIZ)) {
1159 _perl_reload { 1982 $who->message ("start of reload.");
1160 warn $_[0]; 1983 reload;
1161 $who->message ($_[0]); 1984 $who->message ("end of reload.");
1162 };
1163 } 1985 }
1164}; 1986};
1165 1987
1166unshift @INC, $LIBDIR; 1988unshift @INC, $LIBDIR;
1167 1989
1168$TICK_WATCHER = Event->timer ( 1990$TICK_WATCHER = Event->timer (
1991 reentrant => 0,
1169 prio => 1, 1992 prio => 0,
1170 async => 1,
1171 at => $NEXT_TICK || 1, 1993 at => $NEXT_TICK || $TICK,
1994 data => WF_AUTOCANCEL,
1172 cb => sub { 1995 cb => sub {
1996 unless ($FREEZE) {
1173 cf::server_tick; # one server iteration 1997 cf::server_tick; # one server iteration
1998 $RUNTIME += $TICK;
1999 }
1174 2000
1175 my $NOW = Event::time;
1176 $NEXT_TICK += $TICK; 2001 $NEXT_TICK += $TICK;
1177 2002
1178 # if we are delayed by four ticks or more, skip them all 2003 # if we are delayed by four ticks or more, skip them all
1179 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2004 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1180 2005
1181 $TICK_WATCHER->at ($NEXT_TICK); 2006 $TICK_WATCHER->at ($NEXT_TICK);
1182 $TICK_WATCHER->start; 2007 $TICK_WATCHER->start;
1183 }, 2008 },
1184); 2009);
1185 2010
1186IO::AIO::max_poll_time $TICK * 0.2; 2011IO::AIO::max_poll_time $TICK * 0.2;
1187 2012
2013Event->io (
1188Event->io (fd => IO::AIO::poll_fileno, 2014 fd => IO::AIO::poll_fileno,
1189 poll => 'r', 2015 poll => 'r',
1190 prio => 5, 2016 prio => 5,
2017 data => WF_AUTOCANCEL,
1191 cb => \&IO::AIO::poll_cb); 2018 cb => \&IO::AIO::poll_cb,
2019);
2020
2021Event->timer (
2022 data => WF_AUTOCANCEL,
2023 after => 0,
2024 interval => 10,
2025 cb => sub {
2026 (Coro::unblock_sub {
2027 write_runtime
2028 or warn "ERROR: unable to write runtime file: $!";
2029 })->();
2030 },
2031);
1192 2032
11931 20331
1194 2034

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines