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.71 by root, Sun Oct 1 10:59:30 2006 UTC vs.
Revision 1.158 by root, Wed Jan 10 19:52:43 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 Data::Dumper;
21use Digest::MD5;
22use Fcntl;
23use IO::AIO 2.32 ();
24use YAML::Syck ();
10use Time::HiRes; 25use Time::HiRes;
11use Event; 26
12$Event::Eval = 1; # no idea why this is required, but it is 27use Event; $Event::Eval = 1; # no idea why this is required, but it is
13 28
14use strict; 29sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
15 30
16_init_vars; 31# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
32$YAML::Syck::ImplicitUnicode = 1;
17 33
34$Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority
35
18our %COMMAND = (); 36our %COMMAND = ();
37our %COMMAND_TIME = ();
38our %EXTCMD = ();
39
19our @EVENT; 40our @EVENT;
20our $LIBDIR = maps_directory "perl"; 41our $LIBDIR = datadir . "/ext";
21 42
22our $TICK = MAX_TIME * 1e-6; 43our $TICK = MAX_TIME * 1e-6;
23our $TICK_WATCHER; 44our $TICK_WATCHER;
24our $NEXT_TICK; 45our $NEXT_TICK;
46our $NOW;
25 47
26our %CFG; 48our %CFG;
27 49
50our $UPTIME; $UPTIME ||= time;
51our $RUNTIME;
52
53our %PLAYER; # all users
54our %MAP; # all maps
55our $LINK_MAP; # the special {link} map
56our $RANDOM_MAPS = cf::localdir . "/random";
57our %EXT_CORO; # coroutines bound to extensions
58
59our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal;
60our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal;
61
62binmode STDOUT;
63binmode STDERR;
64
65# read virtual server time, if available
66unless ($RUNTIME || !-e cf::localdir . "/runtime") {
67 open my $fh, "<", cf::localdir . "/runtime"
68 or die "unable to read runtime file: $!";
69 $RUNTIME = <$fh> + 0.;
70}
71
72mkdir cf::localdir;
73mkdir cf::localdir . "/" . cf::playerdir;
74mkdir cf::localdir . "/" . cf::tmpdir;
75mkdir cf::localdir . "/" . cf::uniquedir;
76mkdir $RANDOM_MAPS;
77
78# a special map that is always available
79our $LINK_MAP;
80our $EMERGENCY_POSITION;
81
28############################################################################# 82#############################################################################
29 83
30=head2 GLOBAL VARIABLES 84=head2 GLOBAL VARIABLES
31 85
32=over 4 86=over 4
87
88=item $cf::UPTIME
89
90The timestamp of the server start (so not actually an uptime).
91
92=item $cf::RUNTIME
93
94The time this server has run, starts at 0 and is increased by $cf::TICK on
95every server tick.
33 96
34=item $cf::LIBDIR 97=item $cf::LIBDIR
35 98
36The perl library directory, where extensions and cf-specific modules can 99The perl library directory, where extensions and cf-specific modules can
37be found. It will be added to C<@INC> automatically. 100be found. It will be added to C<@INC> automatically.
38 101
102=item $cf::NOW
103
104The time of the last (current) server tick.
105
39=item $cf::TICK 106=item $cf::TICK
40 107
41The interval between server ticks, in seconds. 108The interval between server ticks, in seconds.
42 109
43=item %cf::CFG 110=item %cf::CFG
44 111
45Configuration for the server, loaded from C</etc/crossfire/config>, or 112Configuration for the server, loaded from C</etc/crossfire/config>, or
46from wherever your confdir points to. 113from wherever your confdir points to.
114
115=item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE
116
117These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK)
118or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick
119processing has been done. Call C<< ->wait >> on them to maximise the
120window of cpu time available, or simply to synchronise to the server tick.
47 121
48=back 122=back
49 123
50=cut 124=cut
51 125
52BEGIN { 126BEGIN {
53 *CORE::GLOBAL::warn = sub { 127 *CORE::GLOBAL::warn = sub {
54 my $msg = join "", @_; 128 my $msg = join "", @_;
129 utf8::encode $msg;
130
55 $msg .= "\n" 131 $msg .= "\n"
56 unless $msg =~ /\n$/; 132 unless $msg =~ /\n$/;
57 133
58 print STDERR "cfperl: $msg";
59 LOG llevError, "cfperl: $msg"; 134 LOG llevError, $msg;
60 }; 135 };
61} 136}
62 137
138@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
139@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
140@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
141@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
142@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
63@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; 143@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
64 144
65# we bless all objects into (empty) derived classes to force a method lookup 145# we bless all objects into (empty) derived classes to force a method lookup
66# within the Safe compartment. 146# within the Safe compartment.
67for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { 147for my $pkg (qw(
148 cf::global cf::attachable
149 cf::object cf::object::player
150 cf::client cf::player
151 cf::arch cf::living
152 cf::map cf::party cf::region
153)) {
68 no strict 'refs'; 154 no strict 'refs';
69 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; 155 @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
70} 156}
71 157
72$Event::DIED = sub { 158$Event::DIED = sub {
74}; 160};
75 161
76my %ext_pkg; 162my %ext_pkg;
77my @exts; 163my @exts;
78my @hook; 164my @hook;
79my %command;
80my %extcmd;
81 165
82=head2 UTILITY FUNCTIONS 166=head2 UTILITY FUNCTIONS
83 167
84=over 4 168=over 4
85 169
170=item dumpval $ref
171
86=cut 172=cut
173
174sub dumpval {
175 eval {
176 local $SIG{__DIE__};
177 my $d;
178 if (1) {
179 $d = new Data::Dumper([$_[0]], ["*var"]);
180 $d->Terse(1);
181 $d->Indent(2);
182 $d->Quotekeys(0);
183 $d->Useqq(1);
184 #$d->Bless(...);
185 $d->Seen($_[1]) if @_ > 1;
186 $d = $d->Dump();
187 }
188 $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge;
189 $d
190 } || "[unable to dump $_[0]: '$@']";
191}
87 192
88use JSON::Syck (); # TODO# replace by JSON::PC once working 193use JSON::Syck (); # TODO# replace by JSON::PC once working
89 194
90=item $ref = cf::from_json $json 195=item $ref = cf::from_json $json
91 196
107sub to_json($) { 212sub to_json($) {
108 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs 213 $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
109 JSON::Syck::Dump $_[0] 214 JSON::Syck::Dump $_[0]
110} 215}
111 216
217=item cf::lock_wait $string
218
219Wait until the given lock is available. See cf::lock_acquire.
220
221=item my $lock = cf::lock_acquire $string
222
223Wait until the given lock is available and then acquires it and returns
224a Coro::guard object. If the guard object gets destroyed (goes out of scope,
225for example when the coroutine gets canceled), the lock is automatically
226returned.
227
228Lock names should begin with a unique identifier (for example, cf::map::find
229uses map_find and cf::map::load uses map_load).
230
231=cut
232
233our %LOCK;
234
235sub lock_wait($) {
236 my ($key) = @_;
237
238 # wait for lock, if any
239 while ($LOCK{$key}) {
240 push @{ $LOCK{$key} }, $Coro::current;
241 Coro::schedule;
242 }
243}
244
245sub lock_acquire($) {
246 my ($key) = @_;
247
248 # wait, to be sure we are not locked
249 lock_wait $key;
250
251 $LOCK{$key} = [];
252
253 Coro::guard {
254 # wake up all waiters, to be on the safe side
255 $_->ready for @{ delete $LOCK{$key} };
256 }
257}
258
259sub freeze_mainloop {
260 return unless $TICK_WATCHER->is_active;
261
262 my $guard = Coro::guard { $TICK_WATCHER->start };
263 $TICK_WATCHER->stop;
264 $guard
265}
266
267=item cf::async { BLOCK }
268
269Currently the same as Coro::async_pool, meaning you cannot use
270C<on_destroy>, C<join> or other gimmicks on these coroutines. The only
271thing you are allowed to do is call C<prio> on it.
272
273=cut
274
275BEGIN { *async = \&Coro::async_pool }
276
277=item cf::sync_job { BLOCK }
278
279The design of crossfire+ requires that the main coro ($Coro::main) is
280always able to handle events or runnable, as crossfire+ is only partly
281reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
282
283If it must be done, put the blocking parts into C<sync_job>. This will run
284the given BLOCK in another coroutine while waiting for the result. The
285server will be frozen during this time, so the block should either finish
286fast or be very important.
287
288=cut
289
290sub sync_job(&) {
291 my ($job) = @_;
292
293 if ($Coro::current == $Coro::main) {
294 # this is the main coro, too bad, we have to block
295 # till the operation succeeds, freezing the server :/
296
297 # TODO: use suspend/resume instead
298 # (but this is cancel-safe)
299 my $freeze_guard = freeze_mainloop;
300
301 my $busy = 1;
302 my @res;
303
304 (async {
305 @res = eval { $job->() };
306 warn $@ if $@;
307 undef $busy;
308 })->prio (Coro::PRIO_MAX);
309
310 while ($busy) {
311 Coro::cede or Event::one_event;
312 }
313
314 wantarray ? @res : $res[0]
315 } else {
316 # we are in another coroutine, how wonderful, everything just works
317
318 $job->()
319 }
320}
321
322=item $coro = cf::async_ext { BLOCK }
323
324Like async, but this coro is automcatially being canceled when the
325extension calling this is being unloaded.
326
327=cut
328
329sub async_ext(&) {
330 my $cb = shift;
331
332 my $coro = &Coro::async ($cb);
333
334 $coro->on_destroy (sub {
335 delete $EXT_CORO{$coro+0};
336 });
337 $EXT_CORO{$coro+0} = $coro;
338
339 $coro
340}
341
342sub write_runtime {
343 my $runtime = cf::localdir . "/runtime";
344
345 my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
346 or return;
347
348 my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
349 (aio_write $fh, 0, (length $value), $value, 0) <= 0
350 and return;
351
352 aio_fsync $fh
353 and return;
354
355 close $fh
356 or return;
357
358 aio_rename "$runtime~", $runtime
359 and return;
360
361 1
362}
363
112=back 364=back
113 365
114=cut 366=cut
115 367
116############################################################################# 368#############################################################################
117 369
118=head2 EVENTS AND OBJECT ATTACHMENTS 370package cf::path;
371
372use overload
373 '""' => \&as_string;
374
375# used to convert map paths into valid unix filenames by repalcing / by ∕
376our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons
377
378sub new {
379 my ($class, $path, $base) = @_;
380
381 $path = $path->as_string if ref $path;
382
383 my $self = bless { }, $class;
384
385 # {... are special paths that are not touched
386 # ?xxx/... are special absolute paths
387 # ?random/... random maps
388 # /! non-realised random map exit
389 # /... normal maps
390 # ~/... per-player maps without a specific player (DO NOT USE)
391 # ~user/... per-player map of a specific user
392
393 $path =~ s/$PATH_SEP/\//go;
394
395 if ($path =~ /^{/) {
396 # fine as it is
397 } elsif ($path =~ s{^\?random/}{}) {
398 Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
399 $self->{random} = cf::from_json $data;
400 } else {
401 if ($path =~ s{^~([^/]+)?}{}) {
402 $self->{user_rel} = 1;
403
404 if (defined $1) {
405 $self->{user} = $1;
406 } elsif ($base =~ m{^~([^/]+)/}) {
407 $self->{user} = $1;
408 } else {
409 warn "cannot resolve user-relative path without user <$path,$base>\n";
410 }
411 } elsif ($path =~ /^\//) {
412 # already absolute
413 } else {
414 $base =~ s{[^/]+/?$}{};
415 return $class->new ("$base/$path");
416 }
417
418 for ($path) {
419 redo if s{/\.?/}{/};
420 redo if s{/[^/]+/\.\./}{/};
421 }
422 }
423
424 $self->{path} = $path;
425
426 $self
427}
428
429# the name / primary key / in-game path
430sub as_string {
431 my ($self) = @_;
432
433 $self->{user_rel} ? "~$self->{user}$self->{path}"
434 : $self->{random} ? "?random/$self->{path}"
435 : $self->{path}
436}
437
438# the displayed name, this is a one way mapping
439sub visible_name {
440 my ($self) = @_;
441
442# if (my $rmp = $self->{random}) {
443# # todo: be more intelligent about this
444# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
445# } else {
446 $self->as_string
447# }
448}
449
450# escape the /'s in the path
451sub _escaped_path {
452 (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g;
453 $path
454}
455
456# the original (read-only) location
457sub load_path {
458 my ($self) = @_;
459
460 sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
461}
462
463# the temporary/swap location
464sub save_path {
465 my ($self) = @_;
466
467 $self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
468 : $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
469 : sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
470}
471
472# the unique path, might be eq to save_path
473sub uniq_path {
474 my ($self) = @_;
475
476 $self->{user_rel} || $self->{random}
477 ? undef
478 : sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
479}
480
481# return random map parameters, or undef
482sub random_map_params {
483 my ($self) = @_;
484
485 $self->{random}
486}
487
488# this is somewhat ugly, but style maps do need special treatment
489sub is_style_map {
490 $_[0]{path} =~ m{^/styles/}
491}
492
493package cf;
494
495#############################################################################
496
497=head2 ATTACHABLE OBJECTS
498
499Many objects in crossfire are so-called attachable objects. That means you can
500attach callbacks/event handlers (a collection of which is called an "attachment")
501to it. All such attachable objects support the following methods.
502
503In the following description, CLASS can be any of C<global>, C<object>
504C<player>, C<client> or C<map> (i.e. the attachable objects in
505crossfire+).
119 506
120=over 4 507=over 4
121 508
122=item $object->attach ($attachment, key => $value...)
123
124=item $object->detach ($attachment)
125
126Attach/detach a pre-registered attachment to an object.
127
128=item $player->attach ($attachment, key => $value...)
129
130=item $player->detach ($attachment)
131
132Attach/detach a pre-registered attachment to a player.
133
134=item $map->attach ($attachment, key => $value...) 509=item $attachable->attach ($attachment, key => $value...)
135 510
136=item $map->detach ($attachment) 511=item $attachable->detach ($attachment)
137 512
138Attach/detach a pre-registered attachment to a map. 513Attach/detach a pre-registered attachment to a specific object and give it
514the specified key/value pairs as arguments.
139 515
140=item $bool = $object->attached ($name) 516Example, attach a minesweeper attachment to the given object, making it a
51710x10 minesweeper game:
141 518
142=item $bool = $player->attached ($name) 519 $obj->attach (minesweeper => width => 10, height => 10);
143 520
144=item $bool = $map->attached ($name) 521=item $bool = $attachable->attached ($name)
145 522
146Checks wether the named attachment is currently attached to the object. 523Checks wether the named attachment is currently attached to the object.
147 524
148=item cf::attach_global ... 525=item cf::CLASS->attach ...
149 526
150Attach handlers for global events. 527=item cf::CLASS->detach ...
151 528
152This and all following C<attach_*>-functions expect any number of the 529Define an anonymous attachment and attach it to all objects of the given
153following handler/hook descriptions: 530CLASS. See the next function for an explanation of its arguments.
531
532You can attach to global events by using the C<cf::global> class.
533
534Example, log all player logins:
535
536 cf::player->attach (
537 on_login => sub {
538 my ($pl) = @_;
539 ...
540 },
541 );
542
543Example, attach to the jeweler skill:
544
545 cf::object->attach (
546 type => cf::SKILL,
547 subtype => cf::SK_JEWELER,
548 on_use_skill => sub {
549 my ($sk, $ob, $part, $dir, $msg) = @_;
550 ...
551 },
552 );
553
554=item cf::CLASS::attachment $name, ...
555
556Register an attachment by C<$name> through which attachable objects of the
557given CLASS can refer to this attachment.
558
559Some classes such as crossfire maps and objects can specify attachments
560that are attached at load/instantiate time, thus the need for a name.
561
562These calls expect any number of the following handler/hook descriptions:
154 563
155=over 4 564=over 4
156 565
157=item prio => $number 566=item prio => $number
158 567
160by another C<prio> setting). Lower priority handlers get executed 569by another C<prio> setting). Lower priority handlers get executed
161earlier. The default priority is C<0>, and many built-in handlers are 570earlier. The default priority is C<0>, and many built-in handlers are
162registered at priority C<-1000>, so lower priorities should not be used 571registered at priority C<-1000>, so lower priorities should not be used
163unless you know what you are doing. 572unless you know what you are doing.
164 573
574=item type => $type
575
576(Only for C<< cf::object->attach >> calls), limits the attachment to the
577given type of objects only (the additional parameter C<subtype> can be
578used to further limit to the given subtype).
579
165=item on_I<event> => \&cb 580=item on_I<event> => \&cb
166 581
167Call the given code reference whenever the named event happens (event is 582Call the given code reference whenever the named event happens (event is
168something like C<instantiate>, C<apply>, C<use_skill> and so on, and which 583something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
169handlers are recognised generally depends on the type of object these 584handlers are recognised generally depends on the type of object these
178package and register them. Only handlers for eevents supported by the 593package and register them. Only handlers for eevents supported by the
179object/class are recognised. 594object/class are recognised.
180 595
181=back 596=back
182 597
183=item cf::attach_to_type $object_type, $subtype, ... 598Example, define an attachment called "sockpuppet" that calls the given
599event handler when a monster attacks:
184 600
185Attach handlers for a specific object type (e.g. TRANSPORT) and 601 cf::object::attachment sockpuppet =>
186subtype. If C<$subtype> is zero or undef, matches all objects of the given 602 on_skill_attack => sub {
187type. 603 my ($self, $victim) = @_;
188 604 ...
189=item cf::attach_to_objects ...
190
191Attach handlers to all objects. Do not use this except for debugging or
192very rare events, as handlers are (obviously) called for I<all> objects in
193the game.
194
195=item cf::attach_to_players ...
196
197Attach handlers to all players.
198
199=item cf::attach_to_maps ...
200
201Attach handlers to all maps.
202
203=item cf:register_attachment $name, ...
204
205Register an attachment by name through which objects can refer to this
206attachment.
207
208=item cf:register_player_attachment $name, ...
209
210Register an attachment by name through which players can refer to this
211attachment.
212
213=item cf:register_map_attachment $name, ...
214
215Register an attachment by name through which maps can refer to this
216attachment.
217
218=cut
219
220# the following variables are defined in .xs and must not be re-created
221our @CB_GLOBAL = (); # registry for all global events
222our @CB_OBJECT = (); # all objects (should not be used except in emergency)
223our @CB_PLAYER = ();
224our @CB_TYPE = (); # registry for type (cf-object class) based events
225our @CB_MAP = ();
226
227my %attachment;
228
229sub _attach_cb($\%$$$) {
230 my ($registry, $undo, $event, $prio, $cb) = @_;
231
232 use sort 'stable';
233
234 $cb = [$prio, $cb];
235
236 @{$registry->[$event]} = sort
237 { $a->[0] cmp $b->[0] }
238 @{$registry->[$event] || []}, $cb;
239
240 push @{$undo->{cb}}, [$event, $cb];
241}
242
243# attach handles attaching event callbacks
244# the only thing the caller has to do is pass the correct
245# registry (== where the callback attaches to).
246sub _attach(\@$@) {
247 my ($registry, $klass, @arg) = @_;
248
249 my $prio = 0;
250
251 my %undo = (
252 registry => $registry,
253 cb => [],
254 );
255
256 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
257
258 while (@arg) {
259 my $type = shift @arg;
260
261 if ($type eq "prio") {
262 $prio = shift @arg;
263
264 } elsif ($type eq "package") {
265 my $pkg = shift @arg;
266
267 while (my ($name, $id) = each %cb_id) {
268 if (my $cb = $pkg->can ($name)) {
269 _attach_cb $registry, %undo, $id, $prio, $cb;
270 }
271 } 605 }
272
273 } elsif (exists $cb_id{$type}) {
274 _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
275
276 } elsif (ref $type) {
277 warn "attaching objects not supported, ignoring.\n";
278
279 } else {
280 shift @arg;
281 warn "attach argument '$type' not supported, ignoring.\n";
282 }
283 }
284
285 \%undo
286}
287
288sub _attach_attachment {
289 my ($obj, $name, %arg) = @_;
290
291 return if exists $obj->{_attachment}{$name};
292
293 my $res;
294
295 if (my $attach = $attachment{$name}) {
296 my $registry = $obj->registry;
297
298 for (@$attach) {
299 my ($klass, @attach) = @$_;
300 $res = _attach @$registry, $klass, @attach;
301 }
302
303 $obj->{$name} = \%arg;
304 } else {
305 warn "object uses attachment '$name' that is not available, postponing.\n";
306 }
307
308 $obj->{_attachment}{$name} = undef;
309
310 $res->{attachment} = $name;
311 $res
312}
313
314*cf::object::attach =
315*cf::player::attach =
316*cf::map::attach = sub {
317 my ($obj, $name, %arg) = @_;
318
319 _attach_attachment $obj, $name, %arg;
320};
321
322# all those should be optimised
323*cf::object::detach =
324*cf::player::detach =
325*cf::map::detach = sub {
326 my ($obj, $name) = @_;
327
328 delete $obj->{_attachment}{$name};
329 reattach ($obj);
330};
331
332*cf::object::attached =
333*cf::player::attached =
334*cf::map::attached = sub {
335 my ($obj, $name) = @_;
336
337 exists $obj->{_attachment}{$name}
338};
339
340sub attach_global {
341 _attach @CB_GLOBAL, KLASS_GLOBAL, @_
342}
343
344sub attach_to_type {
345 my $type = shift;
346 my $subtype = shift;
347
348 _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
349}
350
351sub attach_to_objects {
352 _attach @CB_OBJECT, KLASS_OBJECT, @_
353}
354
355sub attach_to_players {
356 _attach @CB_PLAYER, KLASS_PLAYER, @_
357}
358
359sub attach_to_maps {
360 _attach @CB_MAP, KLASS_MAP, @_
361}
362
363sub register_attachment {
364 my $name = shift;
365
366 $attachment{$name} = [[KLASS_OBJECT, @_]];
367}
368
369sub register_player_attachment {
370 my $name = shift;
371
372 $attachment{$name} = [[KLASS_PLAYER, @_]];
373}
374
375sub register_map_attachment {
376 my $name = shift;
377
378 $attachment{$name} = [[KLASS_MAP, @_]];
379}
380
381our $override;
382our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
383
384sub override {
385 $override = 1;
386 @invoke_results = ();
387}
388
389sub do_invoke {
390 my $event = shift;
391 my $callbacks = shift;
392
393 @invoke_results = ();
394
395 local $override;
396
397 for (@$callbacks) {
398 eval { &{$_->[1]} };
399
400 if ($@) {
401 warn "$@";
402 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
403 override;
404 }
405
406 return 1 if $override;
407 }
408
409 0 606 }
410}
411 607
412=item $bool = cf::invoke EVENT_GLOBAL_XXX, ... 608=item $attachable->valid
413
414=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
415
416=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
417
418=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
419
420Generate a global/object/player/map-specific event with the given arguments.
421
422This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
423removed in future versions), and there is no public API to access override
424results (if you must, access C<@cf::invoke_results> directly).
425
426=back
427
428=cut
429
430#############################################################################
431
432=head2 METHODS VALID FOR ALL CORE OBJECTS
433
434=over 4
435
436=item $object->valid, $player->valid, $map->valid
437 609
438Just because you have a perl object does not mean that the corresponding 610Just because you have a perl object does not mean that the corresponding
439C-level object still exists. If you try to access an object that has no 611C-level object still exists. If you try to access an object that has no
440valid C counterpart anymore you get an exception at runtime. This method 612valid C counterpart anymore you get an exception at runtime. This method
441can be used to test for existence of the C object part without causing an 613can be used to test for existence of the C object part without causing an
442exception. 614exception.
443 615
616=cut
617
618# the following variables are defined in .xs and must not be re-created
619our @CB_GLOBAL = (); # registry for all global events
620our @CB_ATTACHABLE = (); # registry for all attachables
621our @CB_OBJECT = (); # all objects (should not be used except in emergency)
622our @CB_PLAYER = ();
623our @CB_CLIENT = ();
624our @CB_TYPE = (); # registry for type (cf-object class) based events
625our @CB_MAP = ();
626
627my %attachment;
628
629sub _attach_cb($$$$) {
630 my ($registry, $event, $prio, $cb) = @_;
631
632 use sort 'stable';
633
634 $cb = [$prio, $cb];
635
636 @{$registry->[$event]} = sort
637 { $a->[0] cmp $b->[0] }
638 @{$registry->[$event] || []}, $cb;
639}
640
641# hack
642my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
643
644# attach handles attaching event callbacks
645# the only thing the caller has to do is pass the correct
646# registry (== where the callback attaches to).
647sub _attach {
648 my ($registry, $klass, @arg) = @_;
649
650 my $object_type;
651 my $prio = 0;
652 my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
653
654 #TODO: get rid of this hack
655 if ($attachable_klass{$klass}) {
656 %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
657 }
658
659 while (@arg) {
660 my $type = shift @arg;
661
662 if ($type eq "prio") {
663 $prio = shift @arg;
664
665 } elsif ($type eq "type") {
666 $object_type = shift @arg;
667 $registry = $CB_TYPE[$object_type] ||= [];
668
669 } elsif ($type eq "subtype") {
670 defined $object_type or Carp::croak "subtype specified without type";
671 my $object_subtype = shift @arg;
672 $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
673
674 } elsif ($type eq "package") {
675 my $pkg = shift @arg;
676
677 while (my ($name, $id) = each %cb_id) {
678 if (my $cb = $pkg->can ($name)) {
679 _attach_cb $registry, $id, $prio, $cb;
680 }
681 }
682
683 } elsif (exists $cb_id{$type}) {
684 _attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
685
686 } elsif (ref $type) {
687 warn "attaching objects not supported, ignoring.\n";
688
689 } else {
690 shift @arg;
691 warn "attach argument '$type' not supported, ignoring.\n";
692 }
693 }
694}
695
696sub _object_attach {
697 my ($obj, $name, %arg) = @_;
698
699 return if exists $obj->{_attachment}{$name};
700
701 if (my $attach = $attachment{$name}) {
702 my $registry = $obj->registry;
703
704 for (@$attach) {
705 my ($klass, @attach) = @$_;
706 _attach $registry, $klass, @attach;
707 }
708
709 $obj->{$name} = \%arg;
710 } else {
711 warn "object uses attachment '$name' that is not available, postponing.\n";
712 }
713
714 $obj->{_attachment}{$name} = undef;
715}
716
717sub cf::attachable::attach {
718 if (ref $_[0]) {
719 _object_attach @_;
720 } else {
721 _attach shift->_attach_registry, @_;
722 }
723};
724
725# all those should be optimised
726sub cf::attachable::detach {
727 my ($obj, $name) = @_;
728
729 if (ref $obj) {
730 delete $obj->{_attachment}{$name};
731 reattach ($obj);
732 } else {
733 Carp::croak "cannot, currently, detach class attachments";
734 }
735};
736
737sub cf::attachable::attached {
738 my ($obj, $name) = @_;
739
740 exists $obj->{_attachment}{$name}
741}
742
743for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
744 eval "#line " . __LINE__ . " 'cf.pm'
745 sub cf::\L$klass\E::_attach_registry {
746 (\\\@CB_$klass, KLASS_$klass)
747 }
748
749 sub cf::\L$klass\E::attachment {
750 my \$name = shift;
751
752 \$attachment{\$name} = [[KLASS_$klass, \@_]];
753 }
754 ";
755 die if $@;
756}
757
758our $override;
759our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
760
761sub override {
762 $override = 1;
763 @invoke_results = ();
764}
765
766sub do_invoke {
767 my $event = shift;
768 my $callbacks = shift;
769
770 @invoke_results = ();
771
772 local $override;
773
774 for (@$callbacks) {
775 eval { &{$_->[1]} };
776
777 if ($@) {
778 warn "$@";
779 warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
780 override;
781 }
782
783 return 1 if $override;
784 }
785
786 0
787}
788
789=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
790
791=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
792
793Generate an object-specific event with the given arguments.
794
795This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
796removed in future versions), and there is no public API to access override
797results (if you must, access C<@cf::invoke_results> directly).
798
444=back 799=back
445 800
446=cut 801=cut
447
448*cf::object::valid =
449*cf::player::valid =
450*cf::map::valid = \&cf::_valid;
451 802
452############################################################################# 803#############################################################################
453# object support 804# object support
454 805
455sub instantiate {
456 my ($obj, $data) = @_;
457
458 $data = from_json $data;
459
460 for (@$data) {
461 my ($name, $args) = @$_;
462
463 $obj->attach ($name, %{$args || {} });
464 }
465}
466
467# basically do the same as instantiate, without calling instantiate
468sub reattach { 806sub reattach {
807 # basically do the same as instantiate, without calling instantiate
469 my ($obj) = @_; 808 my ($obj) = @_;
809
470 my $registry = $obj->registry; 810 my $registry = $obj->registry;
471 811
472 @$registry = (); 812 @$registry = ();
473 813
474 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; 814 delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
475 815
476 for my $name (keys %{ $obj->{_attachment} || {} }) { 816 for my $name (keys %{ $obj->{_attachment} || {} }) {
477 if (my $attach = $attachment{$name}) { 817 if (my $attach = $attachment{$name}) {
478 for (@$attach) { 818 for (@$attach) {
479 my ($klass, @attach) = @$_; 819 my ($klass, @attach) = @$_;
480 _attach @$registry, $klass, @attach; 820 _attach $registry, $klass, @attach;
481 } 821 }
482 } else { 822 } else {
483 warn "object uses attachment '$name' that is not available, postponing.\n"; 823 warn "object uses attachment '$name' that is not available, postponing.\n";
484 } 824 }
485 } 825 }
486} 826}
487 827
488sub object_freezer_save { 828cf::attachable->attach (
489 my ($filename, $rdata, $objs) = @_;
490
491 if (length $$rdata) {
492 warn sprintf "saving %s (%d,%d)\n",
493 $filename, length $$rdata, scalar @$objs;
494
495 if (open my $fh, ">:raw", "$filename~") {
496 chmod SAVE_MODE, $fh;
497 syswrite $fh, $$rdata;
498 close $fh;
499
500 if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
501 chmod SAVE_MODE, $fh;
502 syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
503 close $fh;
504 rename "$filename.pst~", "$filename.pst";
505 } else {
506 unlink "$filename.pst";
507 }
508
509 rename "$filename~", $filename;
510 } else {
511 warn "FATAL: $filename~: $!\n";
512 }
513 } else {
514 unlink $filename;
515 unlink "$filename.pst";
516 }
517}
518
519sub object_thawer_load {
520 my ($filename) = @_;
521
522 local $/;
523
524 my $av;
525
526 #TODO: use sysread etc.
527 if (open my $data, "<:raw:perlio", $filename) {
528 $data = <$data>;
529 if (open my $pst, "<:raw:perlio", "$filename.pst") {
530 $av = eval { (Storable::thaw <$pst>)->{objs} };
531 }
532 return ($data, $av);
533 }
534
535 ()
536}
537
538attach_to_objects
539 prio => -1000000, 829 prio => -1000000,
830 on_instantiate => sub {
831 my ($obj, $data) = @_;
832
833 $data = from_json $data;
834
835 for (@$data) {
836 my ($name, $args) = @$_;
837
838 $obj->attach ($name, %{$args || {} });
839 }
840 },
841 on_reattach => \&reattach,
540 on_clone => sub { 842 on_clone => sub {
541 my ($src, $dst) = @_; 843 my ($src, $dst) = @_;
542 844
543 @{$dst->registry} = @{$src->registry}; 845 @{$dst->registry} = @{$src->registry};
544 846
545 %$dst = %$src; 847 %$dst = %$src;
546 848
547 %{$dst->{_attachment}} = %{$src->{_attachment}} 849 %{$dst->{_attachment}} = %{$src->{_attachment}}
548 if exists $src->{_attachment}; 850 if exists $src->{_attachment};
549 }, 851 },
550; 852);
853
854sub object_freezer_save {
855 my ($filename, $rdata, $objs) = @_;
856
857 sync_job {
858 if (length $$rdata) {
859 warn sprintf "saving %s (%d,%d)\n",
860 $filename, length $$rdata, scalar @$objs;
861
862 if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
863 chmod SAVE_MODE, $fh;
864 aio_write $fh, 0, (length $$rdata), $$rdata, 0;
865 aio_fsync $fh;
866 close $fh;
867
868 if (@$objs) {
869 if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
870 chmod SAVE_MODE, $fh;
871 my $data = Storable::nfreeze { version => 1, objs => $objs };
872 aio_write $fh, 0, (length $data), $data, 0;
873 aio_fsync $fh;
874 close $fh;
875 aio_rename "$filename.pst~", "$filename.pst";
876 }
877 } else {
878 aio_unlink "$filename.pst";
879 }
880
881 aio_rename "$filename~", $filename;
882 } else {
883 warn "FATAL: $filename~: $!\n";
884 }
885 } else {
886 aio_unlink $filename;
887 aio_unlink "$filename.pst";
888 }
889 }
890}
891
892sub object_freezer_as_string {
893 my ($rdata, $objs) = @_;
894
895 use Data::Dumper;
896
897 $$rdata . Dumper $objs
898}
899
900sub object_thawer_load {
901 my ($filename) = @_;
902
903 my ($data, $av);
904
905 (aio_load $filename, $data) >= 0
906 or return;
907
908 unless (aio_stat "$filename.pst") {
909 (aio_load "$filename.pst", $av) >= 0
910 or return;
911 $av = eval { (Storable::thaw $av)->{objs} };
912 }
913
914 warn sprintf "loading %s (%d)\n",
915 $filename, length $data, scalar @{$av || []};#d#
916 return ($data, $av);
917}
551 918
552############################################################################# 919#############################################################################
553# old plug-in events 920# command handling &c
554 921
555sub inject_event { 922=item cf::register_command $name => \&callback($ob,$args);
556 my $extension = shift;
557 my $event_code = shift;
558 923
559 my $cb = $hook[$event_code]{$extension} 924Register a callback for execution when the client sends the user command
560 or return; 925$name.
561 926
562 &$cb 927=cut
563}
564
565sub inject_global_event {
566 my $event = shift;
567
568 my $cb = $hook[$event]
569 or return;
570
571 List::Util::max map &$_, values %$cb
572}
573
574sub inject_command {
575 my ($name, $obj, $params) = @_;
576
577 for my $cmd (@{ $command{$name} }) {
578 $cmd->[1]->($obj, $params);
579 }
580
581 -1
582}
583 928
584sub register_command { 929sub register_command {
585 my ($name, $time, $cb) = @_; 930 my ($name, $cb) = @_;
586 931
587 my $caller = caller; 932 my $caller = caller;
588 #warn "registering command '$name/$time' to '$caller'"; 933 #warn "registering command '$name/$time' to '$caller'";
589 934
590 push @{ $command{$name} }, [$time, $cb, $caller]; 935 push @{ $COMMAND{$name} }, [$caller, $cb];
591 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
592} 936}
937
938=item cf::register_extcmd $name => \&callback($pl,$packet);
939
940Register a callbackf ro execution when the client sends an extcmd packet.
941
942If the callback returns something, it is sent back as if reply was being
943called.
944
945=cut
593 946
594sub register_extcmd { 947sub register_extcmd {
595 my ($name, $cb) = @_; 948 my ($name, $cb) = @_;
596 949
597 my $caller = caller; 950 my $caller = caller;
598 #warn "registering extcmd '$name' to '$caller'"; 951 #warn "registering extcmd '$name' to '$caller'";
599 952
600 $extcmd{$name} = [$cb, $caller]; 953 $EXTCMD{$name} = [$cb, $caller];
601} 954}
955
956cf::player->attach (
957 on_command => sub {
958 my ($pl, $name, $params) = @_;
959
960 my $cb = $COMMAND{$name}
961 or return;
962
963 for my $cmd (@$cb) {
964 $cmd->[1]->($pl->ob, $params);
965 }
966
967 cf::override;
968 },
969 on_extcmd => sub {
970 my ($pl, $buf) = @_;
971
972 my $msg = eval { from_json $buf };
973
974 if (ref $msg) {
975 if (my $cb = $EXTCMD{$msg->{msgtype}}) {
976 if (my %reply = $cb->[0]->($pl, $msg)) {
977 $pl->ext_reply ($msg->{msgid}, %reply);
978 }
979 }
980 } else {
981 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
982 }
983
984 cf::override;
985 },
986);
602 987
603sub register { 988sub register {
604 my ($base, $pkg) = @_; 989 my ($base, $pkg) = @_;
605 990
606 #TODO 991 #TODO
625 . "#line 1 \"$path\"\n{\n" 1010 . "#line 1 \"$path\"\n{\n"
626 . (do { local $/; <$fh> }) 1011 . (do { local $/; <$fh> })
627 . "\n};\n1"; 1012 . "\n};\n1";
628 1013
629 eval $source 1014 eval $source
630 or die "$path: $@"; 1015 or die $@ ? "$path: $@\n"
1016 : "extension disabled.\n";
631 1017
632 push @exts, $pkg; 1018 push @exts, $pkg;
633 $ext_pkg{$base} = $pkg; 1019 $ext_pkg{$base} = $pkg;
634 1020
635# no strict 'refs'; 1021# no strict 'refs';
648# for my $idx (0 .. $#PLUGIN_EVENT) { 1034# for my $idx (0 .. $#PLUGIN_EVENT) {
649# delete $hook[$idx]{$pkg}; 1035# delete $hook[$idx]{$pkg};
650# } 1036# }
651 1037
652 # remove commands 1038 # remove commands
653 for my $name (keys %command) { 1039 for my $name (keys %COMMAND) {
654 my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; 1040 my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
655 1041
656 if (@cb) { 1042 if (@cb) {
657 $command{$name} = \@cb; 1043 $COMMAND{$name} = \@cb;
658 $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
659 } else { 1044 } else {
660 delete $command{$name};
661 delete $COMMAND{"$name\000"}; 1045 delete $COMMAND{$name};
662 } 1046 }
663 } 1047 }
664 1048
665 # remove extcmds 1049 # remove extcmds
666 for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { 1050 for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
667 delete $extcmd{$name}; 1051 delete $EXTCMD{$name};
668 } 1052 }
669 1053
670 if (my $cb = $pkg->can ("unload")) { 1054 if (my $cb = $pkg->can ("unload")) {
671 eval { 1055 eval {
672 $cb->($pkg); 1056 $cb->($pkg);
676 1060
677 Symbol::delete_package $pkg; 1061 Symbol::delete_package $pkg;
678} 1062}
679 1063
680sub load_extensions { 1064sub load_extensions {
681 my $LIBDIR = maps_directory "perl";
682
683 for my $ext (<$LIBDIR/*.ext>) { 1065 for my $ext (<$LIBDIR/*.ext>) {
684 next unless -r $ext; 1066 next unless -r $ext;
685 eval { 1067 eval {
686 load_extension $ext; 1068 load_extension $ext;
687 1 1069 1
688 } or warn "$ext not loaded: $@"; 1070 } or warn "$ext not loaded: $@";
689 } 1071 }
690} 1072}
691 1073
692############################################################################# 1074#############################################################################
693# extcmd framework, basically convert ext <msg>
694# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
695
696attach_to_players
697 on_extcmd => sub {
698 my ($pl, $buf) = @_;
699
700 my $msg = eval { from_json $buf };
701
702 if (ref $msg) {
703 if (my $cb = $extcmd{$msg->{msgtype}}) {
704 if (my %reply = $cb->[0]->($pl, $msg)) {
705 $pl->ext_reply ($msg->{msgid}, %reply);
706 }
707 }
708 } else {
709 warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
710 }
711
712 cf::override;
713 },
714;
715
716#############################################################################
717# load/save/clean perl data associated with a map 1075# load/save/clean perl data associated with a map
718 1076
719*cf::mapsupport::on_clean = sub { 1077*cf::mapsupport::on_clean = sub {
720 my ($map) = @_; 1078 my ($map) = @_;
721 1079
723 defined $path or return; 1081 defined $path or return;
724 1082
725 unlink "$path.pst"; 1083 unlink "$path.pst";
726}; 1084};
727 1085
728attach_to_maps prio => -10000, package => cf::mapsupport::; 1086cf::map->attach (prio => -10000, package => cf::mapsupport::);
729 1087
730############################################################################# 1088#############################################################################
731# load/save perl data associated with player->ob objects
732 1089
733sub all_objects(@) { 1090=head2 CORE EXTENSIONS
734 @_, map all_objects ($_->inv), @_
735}
736 1091
737# TODO: compatibility cruft, remove when no longer needed 1092Functions and methods that extend core crossfire objects.
738attach_to_players 1093
739 on_load => sub { 1094=cut
1095
1096package cf::player;
1097
1098use Coro::AIO;
1099
1100=head3 cf::player
1101
1102=over 4
1103
1104=item cf::player::find $login
1105
1106Returns the given player object, loading it if necessary (might block).
1107
1108=cut
1109
1110sub playerdir($) {
1111 cf::localdir
1112 . "/"
1113 . cf::playerdir
1114 . "/"
1115 . (ref $_[0] ? $_[0]->ob->name : $_[0])
1116}
1117
1118sub path($) {
1119 my $login = ref $_[0] ? $_[0]->ob->name : $_[0];
1120
1121 (playerdir $login) . "/$login.pl"
1122}
1123
1124sub find_active($) {
1125 $cf::PLAYER{$_[0]}
1126 and $cf::PLAYER{$_[0]}->active
1127 and $cf::PLAYER{$_[0]}
1128}
1129
1130sub exists($) {
1131 my ($login) = @_;
1132
1133 $cf::PLAYER{$login}
1134 or cf::sync_job { !aio_stat $login }
1135}
1136
1137sub find($) {
1138 return $cf::PLAYER{$_[0]} || do {
1139 my $login = $_[0];
1140
1141 my $guard = cf::lock_acquire "user_find:$login";
1142
1143 $cf::PLAYER{$_[0]} || do {
1144 my $pl = load_pl path $login
1145 or return;
1146 $cf::PLAYER{$login} = $pl
1147 }
1148 }
1149}
1150
1151sub save($) {
1152 my ($pl) = @_;
1153
1154 return if $pl->{deny_save};
1155
1156 my $path = path $pl;
1157 my $guard = cf::lock_acquire "user_save:$path";
1158
1159 return if $pl->{deny_save};
1160
1161 aio_mkdir playerdir $pl, 0770;
1162 $pl->{last_save} = $cf::RUNTIME;
1163
1164 $pl->save_pl ($path);
1165 Coro::cede;
1166}
1167
1168sub new($) {
1169 my ($login) = @_;
1170
1171 my $self = create;
1172
1173 $self->ob->name ($login);
1174 $self->{deny_save} = 1;
1175
1176 $cf::PLAYER{$login} = $self;
1177
1178 $self
1179}
1180
1181=item $pl->quit_character
1182
1183Nukes the player without looking back. If logged in, the connection will
1184be destroyed. May block for a long time.
1185
1186=cut
1187
1188sub quit_character {
1189 my ($pl) = @_;
1190
1191 $pl->{deny_save} = 1;
1192 $pl->password ("*"); # this should lock out the player until we nuked the dir
1193
1194 $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active;
1195 $pl->deactivate;
1196 $pl->invoke (cf::EVENT_PLAYER_QUIT);
1197 $pl->ns->destroy if $pl->ns;
1198
1199 my $path = playerdir $pl;
1200 my $temp = "$path~$cf::RUNTIME~deleting~";
1201 aio_rename $path, $temp;
1202 delete $cf::PLAYER{$pl->ob->name};
1203 $pl->destroy;
1204 IO::AIO::aio_rmtree $temp;
1205}
1206
1207=item cf::player::list_logins
1208
1209Returns am arrayref of all valid playernames in the system, can take a
1210while and may block, so not sync_job-capable, ever.
1211
1212=cut
1213
1214sub list_logins {
1215 my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir
1216 or return [];
1217
1218 my @logins;
1219
1220 for my $login (@$dirs) {
1221 my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next;
1222 aio_read $fh, 0, 512, my $buf, 0 or next;
1223 $buf !~ /^password -------------$/m or next; # official not-valid tag
1224
1225 utf8::decode $login;
1226 push @logins, $login;
1227 }
1228
1229 \@logins
1230}
1231
1232=item $player->maps
1233
1234Returns an arrayref of cf::path's of all maps that are private for this
1235player. May block.
1236
1237=cut
1238
1239sub maps($) {
1240 my ($pl) = @_;
1241
1242 my $files = aio_readdir playerdir $pl
1243 or return;
1244
1245 my @paths;
1246
1247 for (@$files) {
1248 utf8::decode $_;
1249 next if /\.(?:pl|pst)$/;
1250 next unless /^$PATH_SEP/o;
1251
1252 push @paths, new cf::path "~" . $pl->ob->name . "/" . $_;
1253 }
1254
1255 \@paths
1256}
1257
1258=item $player->ext_reply ($msgid, $msgtype, %msg)
1259
1260Sends an ext reply to the player.
1261
1262=cut
1263
1264sub ext_reply($$$%) {
1265 my ($self, $id, %msg) = @_;
1266
1267 $msg{msgid} = $id;
1268
1269 $self->send ("ext " . cf::to_json \%msg);
1270}
1271
1272package cf;
1273
1274=back
1275
1276
1277=head3 cf::map
1278
1279=over 4
1280
1281=cut
1282
1283package cf::map;
1284
1285use Fcntl;
1286use Coro::AIO;
1287
1288our $MAX_RESET = 3600;
1289our $DEFAULT_RESET = 3000;
1290
1291sub generate_random_map {
1292 my ($path, $rmp) = @_;
1293
1294 # mit "rum" bekleckern, nicht
1295 cf::map::_create_random_map
1296 $path,
1297 $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
1298 $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
1299 $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
1300 $rmp->{exit_on_final_map},
1301 $rmp->{xsize}, $rmp->{ysize},
1302 $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
1303 $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
1304 $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
1305 $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
1306 $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
1307 (cf::region::find $rmp->{region})
1308}
1309
1310# and all this just because we cannot iterate over
1311# all maps in C++...
1312sub change_all_map_light {
1313 my ($change) = @_;
1314
1315 $_->change_map_light ($change)
1316 for grep $_->outdoor, values %cf::MAP;
1317}
1318
1319sub try_load_header($) {
740 my ($pl, $path) = @_; 1320 my ($path) = @_;
741 1321
742 for my $o (all_objects $pl->ob) { 1322 utf8::encode $path;
743 if (my $value = $o->get_ob_key_value ("_perl_data")) { 1323 aio_open $path, O_RDONLY, 0
744 $o->set_ob_key_value ("_perl_data"); 1324 or return;
745 1325
746 %$o = %{ Storable::thaw pack "H*", $value }; 1326 my $map = cf::map::new
1327 or return;
1328
1329 # for better error messages only, will be overwritten
1330 $map->path ($path);
1331
1332 $map->load_header ($path)
1333 or return;
1334
1335 $map->{load_path} = $path;
1336
1337 $map
1338}
1339
1340sub find;
1341sub find {
1342 my ($path, $origin) = @_;
1343
1344 #warn "find<$path,$origin>\n";#d#
1345
1346 $path = new cf::path $path, $origin && $origin->path;
1347 my $key = $path->as_string;
1348
1349 cf::lock_wait "map_find:$key";
1350
1351 $cf::MAP{$key} || do {
1352 my $guard = cf::lock_acquire "map_find:$key";
1353
1354 # do it the slow way
1355 my $map = try_load_header $path->save_path;
1356
1357 Coro::cede;
1358
1359 if ($map) {
1360 $map->last_access ((delete $map->{last_access})
1361 || $cf::RUNTIME); #d#
1362 # safety
1363 $map->{instantiate_time} = $cf::RUNTIME
1364 if $map->{instantiate_time} > $cf::RUNTIME;
1365 } else {
1366 if (my $rmp = $path->random_map_params) {
1367 $map = generate_random_map $key, $rmp;
1368 } else {
1369 $map = try_load_header $path->load_path;
747 } 1370 }
1371
1372 $map or return;
1373
1374 $map->{load_original} = 1;
1375 $map->{instantiate_time} = $cf::RUNTIME;
1376 $map->last_access ($cf::RUNTIME);
1377 $map->instantiate;
1378
1379 # per-player maps become, after loading, normal maps
1380 $map->per_player (0) if $path->{user_rel};
748 } 1381 }
1382
1383 $map->path ($key);
1384 $map->{path} = $path;
1385 $map->{last_save} = $cf::RUNTIME;
1386
1387 Coro::cede;
1388
1389 if ($map->should_reset) {
1390 $map->reset;
1391 undef $guard;
1392 $map = find $path
1393 or return;
1394 }
1395
1396 $cf::MAP{$key} = $map
749 }, 1397 }
750; 1398}
751 1399
752############################################################################# 1400sub load {
1401 my ($self) = @_;
753 1402
754=head2 CORE EXTENSIONS 1403 my $path = $self->{path};
1404 my $guard = cf::lock_acquire "map_load:" . $path->as_string;
755 1405
756Functions and methods that extend core crossfire objects. 1406 return if $self->in_memory != cf::MAP_SWAPPED;
1407
1408 $self->in_memory (cf::MAP_LOADING);
1409
1410 $self->alloc;
1411 $self->load_objects ($self->{load_path}, 1)
1412 or return;
1413
1414 $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
1415 if delete $self->{load_original};
1416
1417 if (my $uniq = $path->uniq_path) {
1418 utf8::encode $uniq;
1419 if (aio_open $uniq, O_RDONLY, 0) {
1420 $self->clear_unique_items;
1421 $self->load_objects ($uniq, 0);
1422 }
1423 }
1424
1425 Coro::cede;
1426
1427 # now do the right thing for maps
1428 $self->link_multipart_objects;
1429
1430 if ($self->{path}->is_style_map) {
1431 $self->{deny_save} = 1;
1432 $self->{deny_reset} = 1;
1433 } else {
1434 $self->fix_auto_apply;
1435 $self->decay_objects;
1436 $self->update_buttons;
1437 $self->set_darkness_map;
1438 $self->difficulty ($self->estimate_difficulty)
1439 unless $self->difficulty;
1440 $self->activate;
1441 }
1442
1443 Coro::cede;
1444
1445 $self->in_memory (cf::MAP_IN_MEMORY);
1446}
1447
1448# find and load all maps in the 3x3 area around a map
1449sub load_diag {
1450 my ($map) = @_;
1451
1452 my @diag; # diagonal neighbours
1453
1454 for (0 .. 3) {
1455 my $neigh = $map->tile_path ($_)
1456 or next;
1457 $neigh = find $neigh, $map
1458 or next;
1459 $neigh->load;
1460
1461 push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh],
1462 [$neigh->tile_path (($_ + 1) % 4), $neigh];
1463 }
1464
1465 for (@diag) {
1466 my $neigh = find @$_
1467 or next;
1468 $neigh->load;
1469 }
1470}
1471
1472sub find_sync {
1473 my ($path, $origin) = @_;
1474
1475 cf::sync_job { find $path, $origin }
1476}
1477
1478sub do_load_sync {
1479 my ($map) = @_;
1480
1481 cf::sync_job { $map->load };
1482}
1483
1484our %MAP_PREFETCH;
1485our $MAP_PREFETCHER = Coro::async {
1486 while () {
1487 while (%MAP_PREFETCH) {
1488 my $key = each %MAP_PREFETCH
1489 or next;
1490 my $path = delete $MAP_PREFETCH{$key};
1491
1492 my $map = find $path
1493 or next;
1494 $map->load;
1495 }
1496 Coro::schedule;
1497 }
1498};
1499
1500sub find_async {
1501 my ($path, $origin) = @_;
1502
1503 $path = new cf::path $path, $origin && $origin->path;
1504 my $key = $path->as_string;
1505
1506 if (my $map = $cf::MAP{$key}) {
1507 return $map if $map->in_memory == cf::MAP_IN_MEMORY;
1508 }
1509
1510 $MAP_PREFETCH{$key} = $path;
1511 $MAP_PREFETCHER->ready;
1512
1513 ()
1514}
1515
1516sub save {
1517 my ($self) = @_;
1518
1519 my $lock = cf::lock_acquire "map_data:" . $self->path;
1520
1521 $self->{last_save} = $cf::RUNTIME;
1522
1523 return unless $self->dirty;
1524
1525 my $save = $self->{path}->save_path; utf8::encode $save;
1526 my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
1527
1528 $self->{load_path} = $save;
1529
1530 return if $self->{deny_save};
1531
1532 local $self->{last_access} = $self->last_access;#d#
1533
1534 cf::async {
1535 $_->contr->save for $self->players;
1536 };
1537
1538 if ($uniq) {
1539 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
1540 $self->save_objects ($uniq, cf::IO_UNIQUES);
1541 } else {
1542 $self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
1543 }
1544}
1545
1546sub swap_out {
1547 my ($self) = @_;
1548
1549 # save first because save cedes
1550 $self->save;
1551
1552 my $lock = cf::lock_acquire "map_data:" . $self->path;
1553
1554 return if $self->players;
1555 return if $self->in_memory != cf::MAP_IN_MEMORY;
1556 return if $self->{deny_save};
1557
1558 $self->clear;
1559 $self->in_memory (cf::MAP_SWAPPED);
1560}
1561
1562sub reset_at {
1563 my ($self) = @_;
1564
1565 # TODO: safety, remove and allow resettable per-player maps
1566 return 1e99 if $self->{path}{user_rel};
1567 return 1e99 if $self->{deny_reset};
1568
1569 my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
1570 my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
1571
1572 $time + $to
1573}
1574
1575sub should_reset {
1576 my ($self) = @_;
1577
1578 $self->reset_at <= $cf::RUNTIME
1579}
1580
1581sub unlink_save {
1582 my ($self) = @_;
1583
1584 utf8::encode (my $save = $self->{path}->save_path);
1585 aioreq_pri 3; IO::AIO::aio_unlink $save;
1586 aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
1587}
1588
1589sub rename {
1590 my ($self, $new_path) = @_;
1591
1592 $self->unlink_save;
1593
1594 delete $cf::MAP{$self->path};
1595 $self->{path} = new cf::path $new_path;
1596 $self->path ($self->{path}->as_string);
1597 $cf::MAP{$self->path} = $self;
1598
1599 $self->save;
1600}
1601
1602sub reset {
1603 my ($self) = @_;
1604
1605 my $lock = cf::lock_acquire "map_data:" . $self->path;
1606
1607 return if $self->players;
1608 return if $self->{path}{user_rel};#d#
1609
1610 warn "resetting map ", $self->path;#d#
1611
1612 delete $cf::MAP{$self->path};
1613
1614 $_->clear_links_to ($self) for values %cf::MAP;
1615
1616 $self->unlink_save;
1617 $self->destroy;
1618}
1619
1620my $nuke_counter = "aaaa";
1621
1622sub nuke {
1623 my ($self) = @_;
1624
1625 $self->{deny_save} = 1;
1626 $self->reset_timeout (1);
1627 $self->rename ("{nuke}/" . ($nuke_counter++));
1628 $self->reset; # polite request, might not happen
1629}
1630
1631sub customise_for {
1632 my ($map, $ob) = @_;
1633
1634 if ($map->per_player) {
1635 return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
1636 }
1637
1638 $map
1639}
1640
1641=item cf::map::unique_maps
1642
1643Returns an arrayref of cf::path's of all shared maps that have
1644instantiated unique items. May block.
1645
1646=cut
1647
1648sub unique_maps() {
1649 my $files = aio_readdir cf::localdir . "/" . cf::uniquedir
1650 or return;
1651
1652 my @paths;
1653
1654 for (@$files) {
1655 utf8::decode $_;
1656 next if /\.pst$/;
1657 next unless /^$PATH_SEP/o;
1658
1659 push @paths, new cf::path $_;
1660 }
1661
1662 \@paths
1663}
1664
1665package cf;
1666
1667=back
1668
1669=head3 cf::object
1670
1671=cut
1672
1673package cf::object;
757 1674
758=over 4 1675=over 4
759 1676
760=item cf::player::exists $login 1677=item $ob->inv_recursive
761 1678
762Returns true when the given account exists. 1679Returns the inventory of the object _and_ their inventories, recursively.
763 1680
764=cut 1681=cut
765 1682
766sub cf::player::exists($) { 1683sub inv_recursive_;
767 cf::player::find $_[0] 1684sub inv_recursive_ {
768 or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; 1685 map { $_, inv_recursive_ $_->inv } @_
769} 1686}
770 1687
1688sub inv_recursive {
1689 inv_recursive_ inv $_[0]
1690}
1691
1692package cf;
1693
1694=back
1695
1696=head3 cf::object::player
1697
1698=over 4
1699
771=item $player->reply ($npc, $msg[, $flags]) 1700=item $player_object->reply ($npc, $msg[, $flags])
772 1701
773Sends a message to the player, as if the npc C<$npc> replied. C<$npc> 1702Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
774can be C<undef>. Does the right thing when the player is currently in a 1703can be C<undef>. Does the right thing when the player is currently in a
775dialogue with the given NPC character. 1704dialogue with the given NPC character.
776 1705
777=cut 1706=cut
778 1707
779# rough implementation of a future "reply" method that works 1708# rough implementation of a future "reply" method that works
780# with dialog boxes. 1709# with dialog boxes.
1710#TODO: the first argument must go, split into a $npc->reply_to ( method
781sub cf::object::player::reply($$$;$) { 1711sub cf::object::player::reply($$$;$) {
782 my ($self, $npc, $msg, $flags) = @_; 1712 my ($self, $npc, $msg, $flags) = @_;
783 1713
784 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; 1714 $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
785 1715
789 $msg = $npc->name . " says: $msg" if $npc; 1719 $msg = $npc->name . " says: $msg" if $npc;
790 $self->message ($msg, $flags); 1720 $self->message ($msg, $flags);
791 } 1721 }
792} 1722}
793 1723
794=item $player->ext_reply ($msgid, $msgtype, %msg) 1724=item $player_object->may ("access")
795 1725
796Sends an ext reply to the player. 1726Returns wether the given player is authorized to access resource "access"
1727(e.g. "command_wizcast").
797 1728
798=cut 1729=cut
799 1730
800sub cf::player::ext_reply($$$%) { 1731sub cf::object::player::may {
1732 my ($self, $access) = @_;
1733
1734 $self->flag (cf::FLAG_WIZ) ||
1735 (ref $cf::CFG{"may_$access"}
1736 ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
1737 : $cf::CFG{"may_$access"})
1738}
1739
1740=item $player_object->enter_link
1741
1742Freezes the player and moves him/her to a special map (C<{link}>).
1743
1744The player should be reaosnably safe there for short amounts of time. You
1745I<MUST> call C<leave_link> as soon as possible, though.
1746
1747=item $player_object->leave_link ($map, $x, $y)
1748
1749Moves the player out of the specila link map onto the given map. If the
1750map is not valid (or omitted), the player will be moved back to the
1751location he/she was before the call to C<enter_link>, or, if that fails,
1752to the emergency map position.
1753
1754Might block.
1755
1756=cut
1757
1758sub cf::object::player::enter_link {
1759 my ($self) = @_;
1760
1761 $self->deactivate_recursive;
1762
1763 return if $self->map == $LINK_MAP;
1764
1765 $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
1766 if $self->map;
1767
1768 $self->enter_map ($LINK_MAP, 20, 20);
1769}
1770
1771sub cf::object::player::leave_link {
1772 my ($self, $map, $x, $y) = @_;
1773
1774 my $link_pos = delete $self->{_link_pos};
1775
1776 unless ($map) {
1777 # restore original map position
1778 ($map, $x, $y) = @{ $link_pos || [] };
1779 $map = cf::map::find $map;
1780
1781 unless ($map) {
1782 ($map, $x, $y) = @$EMERGENCY_POSITION;
1783 $map = cf::map::find $map
1784 or die "FATAL: cannot load emergency map\n";
1785 }
1786 }
1787
1788 ($x, $y) = (-1, -1)
1789 unless (defined $x) && (defined $y);
1790
1791 # use -1 or undef as default coordinates, not 0, 0
1792 ($x, $y) = ($map->enter_x, $map->enter_y)
1793 if $x <=0 && $y <= 0;
1794
1795 $map->load;
1796 $map->load_diag;
1797
1798 return unless $self->contr->active;
1799 $self->activate_recursive;
1800 $self->enter_map ($map, $x, $y);
1801}
1802
1803cf::player->attach (
1804 on_logout => sub {
1805 my ($pl) = @_;
1806
1807 # abort map switching before logout
1808 if ($pl->ob->{_link_pos}) {
1809 cf::sync_job {
1810 $pl->ob->leave_link
1811 };
1812 }
1813 },
1814 on_login => sub {
1815 my ($pl) = @_;
1816
1817 # try to abort aborted map switching on player login :)
1818 # should happen only on crashes
1819 if ($pl->ob->{_link_pos}) {
1820 $pl->ob->enter_link;
1821 (async {
1822 # we need this sleep as the login has a concurrent enter_exit running
1823 # and this sleep increases chances of the player not ending up in scorn
1824 $pl->ob->reply (undef,
1825 "There was an internal problem at your last logout, "
1826 . "the server will try to bring you to your intended destination in a second.",
1827 cf::NDI_RED);
1828 Coro::Timer::sleep 1;
1829 $pl->ob->leave_link;
1830 })->prio (2);
1831 }
1832 },
1833);
1834
1835=item $player_object->goto ($path, $x, $y)
1836
1837=cut
1838
1839sub cf::object::player::goto {
1840 my ($self, $path, $x, $y) = @_;
1841
1842 $path = new cf::path $path;
1843
1844 $self->enter_link;
1845
1846 (async {
1847 my $map = cf::map::find $path->as_string;
1848 $map = $map->customise_for ($self) if $map;
1849
1850# warn "entering ", $map->path, " at ($x, $y)\n"
1851# if $map;
1852
1853 $map or $self->message ("The exit to '" . ($path->visible_name) . "' is closed", cf::NDI_UNIQUE | cf::NDI_RED);
1854
1855 $self->leave_link ($map, $x, $y);
1856 })->prio (1);
1857}
1858
1859=item $player_object->enter_exit ($exit_object)
1860
1861=cut
1862
1863sub parse_random_map_params {
1864 my ($spec) = @_;
1865
1866 my $rmp = { # defaults
1867 xsize => 10,
1868 ysize => 10,
1869 };
1870
1871 for (split /\n/, $spec) {
1872 my ($k, $v) = split /\s+/, $_, 2;
1873
1874 $rmp->{lc $k} = $v if (length $k) && (length $v);
1875 }
1876
1877 $rmp
1878}
1879
1880sub prepare_random_map {
1881 my ($exit) = @_;
1882
1883 # all this does is basically replace the /! path by
1884 # a new random map path (?random/...) with a seed
1885 # that depends on the exit object
1886
1887 my $rmp = parse_random_map_params $exit->msg;
1888
1889 if ($exit->map) {
1890 $rmp->{region} = $exit->map->region_name;
1891 $rmp->{origin_map} = $exit->map->path;
1892 $rmp->{origin_x} = $exit->x;
1893 $rmp->{origin_y} = $exit->y;
1894 }
1895
1896 $rmp->{random_seed} ||= $exit->random_seed;
1897
1898 my $data = cf::to_json $rmp;
1899 my $md5 = Digest::MD5::md5_hex $data;
1900
1901 if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
1902 aio_write $fh, 0, (length $data), $data, 0;
1903
1904 $exit->slaying ("?random/$md5");
1905 $exit->msg (undef);
1906 }
1907}
1908
1909sub cf::object::player::enter_exit {
801 my ($self, $id, %msg) = @_; 1910 my ($self, $exit) = @_;
802 1911
803 $msg{msgid} = $id; 1912 return unless $self->type == cf::PLAYER;
804 1913
805 $self->send ("ext " . to_json \%msg); 1914 $self->enter_link;
1915
1916 (async {
1917 $self->deactivate_recursive; # just to be sure
1918 unless (eval {
1919 prepare_random_map $exit
1920 if $exit->slaying eq "/!";
1921
1922 my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
1923 $self->goto ($path, $exit->stats->hp, $exit->stats->sp);
1924
1925 1;
1926 }) {
1927 $self->message ("Something went wrong deep within the crossfire server. "
1928 . "I'll try to bring you back to the map you were before. "
1929 . "Please report this to the dungeon master!",
1930 cf::NDI_UNIQUE | cf::NDI_RED);
1931
1932 warn "ERROR in enter_exit: $@";
1933 $self->leave_link;
1934 }
1935 })->prio (1);
806} 1936}
1937
1938=head3 cf::client
1939
1940=over 4
1941
1942=item $client->send_drawinfo ($text, $flags)
1943
1944Sends a drawinfo packet to the client. Circumvents output buffering so
1945should not be used under normal circumstances.
1946
1947=cut
1948
1949sub cf::client::send_drawinfo {
1950 my ($self, $text, $flags) = @_;
1951
1952 utf8::encode $text;
1953 $self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
1954}
1955
1956
1957=item $success = $client->query ($flags, "text", \&cb)
1958
1959Queues a query to the client, calling the given callback with
1960the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
1961C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
1962
1963Queries can fail, so check the return code. Or don't, as queries will become
1964reliable at some point in the future.
1965
1966=cut
1967
1968sub cf::client::query {
1969 my ($self, $flags, $text, $cb) = @_;
1970
1971 return unless $self->state == ST_PLAYING
1972 || $self->state == ST_SETUP
1973 || $self->state == ST_CUSTOM;
1974
1975 $self->state (ST_CUSTOM);
1976
1977 utf8::encode $text;
1978 push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
1979
1980 $self->send_packet ($self->{query_queue}[0][0])
1981 if @{ $self->{query_queue} } == 1;
1982}
1983
1984cf::client->attach (
1985 on_reply => sub {
1986 my ($ns, $msg) = @_;
1987
1988 # this weird shuffling is so that direct followup queries
1989 # get handled first
1990 my $queue = delete $ns->{query_queue}
1991 or return; # be conservative, not sure how that can happen, but we saw a crash here
1992
1993 (shift @$queue)->[1]->($msg);
1994
1995 push @{ $ns->{query_queue} }, @$queue;
1996
1997 if (@{ $ns->{query_queue} } == @$queue) {
1998 if (@$queue) {
1999 $ns->send_packet ($ns->{query_queue}[0][0]);
2000 } else {
2001 $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
2002 }
2003 }
2004 },
2005);
2006
2007=item $client->async (\&cb)
2008
2009Create a new coroutine, running the specified callback. The coroutine will
2010be automatically cancelled when the client gets destroyed (e.g. on logout,
2011or loss of connection).
2012
2013=cut
2014
2015sub cf::client::async {
2016 my ($self, $cb) = @_;
2017
2018 my $coro = &Coro::async ($cb);
2019
2020 $coro->on_destroy (sub {
2021 delete $self->{_coro}{$coro+0};
2022 });
2023
2024 $self->{_coro}{$coro+0} = $coro;
2025
2026 $coro
2027}
2028
2029cf::client->attach (
2030 on_destroy => sub {
2031 my ($ns) = @_;
2032
2033 $_->cancel for values %{ (delete $ns->{_coro}) || {} };
2034 },
2035);
807 2036
808=back 2037=back
809 2038
810=cut
811
812#############################################################################
813 2039
814=head2 SAFE SCRIPTING 2040=head2 SAFE SCRIPTING
815 2041
816Functions that provide a safe environment to compile and execute 2042Functions that provide a safe environment to compile and execute
817snippets of perl code without them endangering the safety of the server 2043snippets of perl code without them endangering the safety of the server
818itself. Looping constructs, I/O operators and other built-in functionality 2044itself. Looping constructs, I/O operators and other built-in functionality
819is not available in the safe scripting environment, and the number of 2045is not available in the safe scripting environment, and the number of
820functions and methods that cna be called is greatly reduced. 2046functions and methods that can be called is greatly reduced.
821 2047
822=cut 2048=cut
823 2049
824our $safe = new Safe "safe"; 2050our $safe = new Safe "safe";
825our $safe_hole = new Safe::Hole; 2051our $safe_hole = new Safe::Hole;
832 2058
833=pod 2059=pod
834 2060
835The following fucntions and emthods are available within a safe environment: 2061The following fucntions and emthods are available within a safe environment:
836 2062
837 cf::object contr pay_amount pay_player 2063 cf::object contr pay_amount pay_player map
838 cf::object::player player 2064 cf::object::player player
839 cf::player peaceful 2065 cf::player peaceful
2066 cf::map trigger
840 2067
841=cut 2068=cut
842 2069
843for ( 2070for (
844 ["cf::object" => qw(contr pay_amount pay_player)], 2071 ["cf::object" => qw(contr pay_amount pay_player map)],
845 ["cf::object::player" => qw(player)], 2072 ["cf::object::player" => qw(player)],
846 ["cf::player" => qw(peaceful)], 2073 ["cf::player" => qw(peaceful)],
2074 ["cf::map" => qw(trigger)],
847) { 2075) {
848 no strict 'refs'; 2076 no strict 'refs';
849 my ($pkg, @funs) = @$_; 2077 my ($pkg, @funs) = @$_;
850 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) 2078 *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
851 for @funs; 2079 for @funs;
961 2189
962Immediately write the database to disk I<if it is dirty>. 2190Immediately write the database to disk I<if it is dirty>.
963 2191
964=cut 2192=cut
965 2193
2194our $DB;
2195
966{ 2196{
967 my $db;
968 my $path = cf::localdir . "/database.pst"; 2197 my $path = cf::localdir . "/database.pst";
969 2198
970 sub db_load() { 2199 sub db_load() {
971 warn "loading database $path\n";#d# remove later
972 $db = stat $path ? Storable::retrieve $path : { }; 2200 $DB = stat $path ? Storable::retrieve $path : { };
973 } 2201 }
974 2202
975 my $pid; 2203 my $pid;
976 2204
977 sub db_save() { 2205 sub db_save() {
978 warn "saving database $path\n";#d# remove later
979 waitpid $pid, 0 if $pid; 2206 waitpid $pid, 0 if $pid;
980 if (0 == ($pid = fork)) { 2207 if (0 == ($pid = fork)) {
981 $db->{_meta}{version} = 1; 2208 $DB->{_meta}{version} = 1;
982 Storable::nstore $db, "$path~"; 2209 Storable::nstore $DB, "$path~";
983 rename "$path~", $path; 2210 rename "$path~", $path;
984 cf::_exit 0 if defined $pid; 2211 cf::_exit 0 if defined $pid;
985 } 2212 }
986 } 2213 }
987 2214
990 sub db_sync() { 2217 sub db_sync() {
991 db_save if $dirty; 2218 db_save if $dirty;
992 undef $dirty; 2219 undef $dirty;
993 } 2220 }
994 2221
995 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { 2222 my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
996 db_sync; 2223 db_sync;
997 }); 2224 });
998 2225
999 sub db_dirty() { 2226 sub db_dirty() {
1000 $dirty = 1; 2227 $dirty = 1;
1001 $idle->start; 2228 $idle->start;
1002 } 2229 }
1003 2230
1004 sub db_get($;$) { 2231 sub db_get($;$) {
1005 @_ >= 2 2232 @_ >= 2
1006 ? $db->{$_[0]}{$_[1]} 2233 ? $DB->{$_[0]}{$_[1]}
1007 : ($db->{$_[0]} ||= { }) 2234 : ($DB->{$_[0]} ||= { })
1008 } 2235 }
1009 2236
1010 sub db_put($$;$) { 2237 sub db_put($$;$) {
1011 if (@_ >= 3) { 2238 if (@_ >= 3) {
1012 $db->{$_[0]}{$_[1]} = $_[2]; 2239 $DB->{$_[0]}{$_[1]} = $_[2];
1013 } else { 2240 } else {
1014 $db->{$_[0]} = $_[1]; 2241 $DB->{$_[0]} = $_[1];
1015 } 2242 }
1016 db_dirty; 2243 db_dirty;
1017 } 2244 }
1018 2245
1019 attach_global 2246 cf::global->attach (
1020 prio => 10000, 2247 prio => 10000,
1021 on_cleanup => sub { 2248 on_cleanup => sub {
1022 db_sync; 2249 db_sync;
1023 }, 2250 },
1024 ; 2251 );
1025} 2252}
1026 2253
1027############################################################################# 2254#############################################################################
1028# the server's main() 2255# the server's main()
1029 2256
2257sub cfg_load {
2258 open my $fh, "<:utf8", cf::confdir . "/config"
2259 or return;
2260
2261 local $/;
2262 *CFG = YAML::Syck::Load <$fh>;
2263
2264 $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
2265
2266 $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset};
2267 $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset};
2268
2269 if (exists $CFG{mlockall}) {
2270 eval {
2271 $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()"
2272 and die "WARNING: m(un)lockall failed: $!\n";
2273 };
2274 warn $@ if $@;
2275 }
2276}
2277
1030sub main { 2278sub main {
2279 # we must not ever block the main coroutine
2280 local $Coro::idle = sub {
2281 Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
2282 async { Event::one_event };
2283 };
2284
2285 cfg_load;
1031 db_load; 2286 db_load;
1032 load_extensions; 2287 load_extensions;
1033 Event::loop; 2288 Event::loop;
1034} 2289}
1035 2290
1036############################################################################# 2291#############################################################################
1037# initialisation 2292# initialisation and cleanup
1038 2293
2294# install some emergency cleanup handlers
2295BEGIN {
2296 for my $signal (qw(INT HUP TERM)) {
2297 Event->signal (
2298 data => WF_AUTOCANCEL,
2299 signal => $signal,
2300 cb => sub {
2301 cf::cleanup "SIG$signal";
2302 },
2303 );
2304 }
2305}
2306
2307sub emergency_save() {
2308 my $freeze_guard = cf::freeze_mainloop;
2309
2310 warn "enter emergency perl save\n";
2311
2312 cf::sync_job {
2313 # use a peculiar iteration method to avoid tripping on perl
2314 # refcount bugs in for. also avoids problems with players
2315 # and maps saved/Destroyed asynchronously.
2316 warn "begin emergency player save\n";
2317 for my $login (keys %cf::PLAYER) {
2318 my $pl = $cf::PLAYER{$login} or next;
2319 $pl->valid or next;
2320 $pl->save;
2321 }
2322 warn "end emergency player save\n";
2323
2324 warn "begin emergency map save\n";
2325 for my $path (keys %cf::MAP) {
2326 my $map = $cf::MAP{$path} or next;
2327 $map->valid or next;
2328 $map->save;
2329 }
2330 warn "end emergency map save\n";
2331 };
2332
2333 warn "leave emergency perl save\n";
2334}
2335
1039sub _perl_reload(&) { 2336sub reload() {
1040 my ($msg) = @_; 2337 # can/must only be called in main
2338 if ($Coro::current != $Coro::main) {
2339 warn "can only reload from main coroutine\n";
2340 return;
2341 }
1041 2342
1042 $msg->("reloading..."); 2343 warn "reloading...";
2344
2345 my $guard = freeze_mainloop;
2346 cf::emergency_save;
1043 2347
1044 eval { 2348 eval {
2349 # if anything goes wrong in here, we should simply crash as we already saved
2350
1045 # cancel all watchers 2351 # cancel all watchers
1046 $_->cancel for Event::all_watchers; 2352 for (Event::all_watchers) {
2353 $_->cancel if $_->data & WF_AUTOCANCEL;
2354 }
2355
2356 # cancel all extension coros
2357 $_->cancel for values %EXT_CORO;
2358 %EXT_CORO = ();
1047 2359
1048 # unload all extensions 2360 # unload all extensions
1049 for (@exts) { 2361 for (@exts) {
1050 $msg->("unloading <$_>"); 2362 warn "unloading <$_>";
1051 unload_extension $_; 2363 unload_extension $_;
1052 } 2364 }
1053 2365
1054 # unload all modules loaded from $LIBDIR 2366 # unload all modules loaded from $LIBDIR
1055 while (my ($k, $v) = each %INC) { 2367 while (my ($k, $v) = each %INC) {
1056 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; 2368 next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1057 2369
1058 $msg->("removing <$k>"); 2370 warn "removing <$k>";
1059 delete $INC{$k}; 2371 delete $INC{$k};
1060 2372
1061 $k =~ s/\.pm$//; 2373 $k =~ s/\.pm$//;
1062 $k =~ s/\//::/g; 2374 $k =~ s/\//::/g;
1063 2375
1068 Symbol::delete_package $k; 2380 Symbol::delete_package $k;
1069 } 2381 }
1070 2382
1071 # sync database to disk 2383 # sync database to disk
1072 cf::db_sync; 2384 cf::db_sync;
2385 IO::AIO::flush;
1073 2386
1074 # get rid of safe::, as good as possible 2387 # get rid of safe::, as good as possible
1075 Symbol::delete_package "safe::$_" 2388 Symbol::delete_package "safe::$_"
1076 for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); 2389 for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1077 2390
1078 # remove register_script_function callbacks 2391 # remove register_script_function callbacks
1079 # TODO 2392 # TODO
1080 2393
1081 # unload cf.pm "a bit" 2394 # unload cf.pm "a bit"
1084 # don't, removes xs symbols, too, 2397 # don't, removes xs symbols, too,
1085 # and global variables created in xs 2398 # and global variables created in xs
1086 #Symbol::delete_package __PACKAGE__; 2399 #Symbol::delete_package __PACKAGE__;
1087 2400
1088 # reload cf.pm 2401 # reload cf.pm
1089 $msg->("reloading cf.pm"); 2402 warn "reloading cf.pm";
1090 require cf; 2403 require cf;
2404 cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1091 2405
1092 # load database again 2406 # load config and database again
2407 cf::cfg_load;
1093 cf::db_load; 2408 cf::db_load;
1094 2409
1095 # load extensions 2410 # load extensions
1096 $msg->("load extensions"); 2411 warn "load extensions";
1097 cf::load_extensions; 2412 cf::load_extensions;
1098 2413
1099 # reattach attachments to objects 2414 # reattach attachments to objects
1100 $msg->("reattach"); 2415 warn "reattach";
1101 _global_reattach; 2416 _global_reattach;
2417 reattach $_ for values %MAP;
1102 }; 2418 };
1103 $msg->($@) if $@;
1104 2419
1105 $msg->("reloaded"); 2420 if ($@) {
2421 warn $@;
2422 warn "error while reloading, exiting.";
2423 exit 1;
2424 }
2425
2426 warn "reloaded successfully";
1106}; 2427};
1107 2428
1108sub perl_reload() { 2429#############################################################################
1109 _perl_reload {
1110 warn $_[0];
1111 print "$_[0]\n";
1112 };
1113}
1114 2430
2431unless ($LINK_MAP) {
2432 $LINK_MAP = cf::map::new;
2433
2434 $LINK_MAP->width (41);
2435 $LINK_MAP->height (41);
2436 $LINK_MAP->alloc;
2437 $LINK_MAP->path ("{link}");
2438 $LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
2439 $LINK_MAP->in_memory (MAP_IN_MEMORY);
2440
2441 # dirty hack because... archetypes are not yet loaded
2442 Event->timer (
2443 after => 10,
2444 cb => sub {
2445 $_[0]->w->cancel;
2446
2447 # provide some exits "home"
2448 my $exit = cf::object::new "exit";
2449
2450 $exit->slaying ($EMERGENCY_POSITION->[0]);
2451 $exit->stats->hp ($EMERGENCY_POSITION->[1]);
2452 $exit->stats->sp ($EMERGENCY_POSITION->[2]);
2453
2454 $LINK_MAP->insert ($exit->clone, 19, 19);
2455 $LINK_MAP->insert ($exit->clone, 19, 20);
2456 $LINK_MAP->insert ($exit->clone, 19, 21);
2457 $LINK_MAP->insert ($exit->clone, 20, 19);
2458 $LINK_MAP->insert ($exit->clone, 20, 21);
2459 $LINK_MAP->insert ($exit->clone, 21, 19);
2460 $LINK_MAP->insert ($exit->clone, 21, 20);
2461 $LINK_MAP->insert ($exit->clone, 21, 21);
2462
2463 $exit->destroy;
2464 });
2465
2466 $LINK_MAP->{deny_save} = 1;
2467 $LINK_MAP->{deny_reset} = 1;
2468
2469 $cf::MAP{$LINK_MAP->path} = $LINK_MAP;
2470}
2471
2472register "<global>", __PACKAGE__;
2473
1115register_command "perl-reload", 0, sub { 2474register_command "reload" => sub {
1116 my ($who, $arg) = @_; 2475 my ($who, $arg) = @_;
1117 2476
1118 if ($who->flag (FLAG_WIZ)) { 2477 if ($who->flag (FLAG_WIZ)) {
1119 _perl_reload { 2478 $who->message ("start of reload.");
1120 warn $_[0]; 2479 reload;
1121 $who->message ($_[0]); 2480 $who->message ("end of reload.");
1122 };
1123 } 2481 }
1124}; 2482};
1125 2483
1126register "<global>", __PACKAGE__;
1127
1128unshift @INC, $LIBDIR; 2484unshift @INC, $LIBDIR;
1129 2485
1130$TICK_WATCHER = Event->timer ( 2486$TICK_WATCHER = Event->timer (
2487 reentrant => 0,
1131 prio => 1, 2488 prio => 0,
1132 at => $NEXT_TICK || 1, 2489 at => $NEXT_TICK || $TICK,
2490 data => WF_AUTOCANCEL,
1133 cb => sub { 2491 cb => sub {
1134 cf::server_tick; # one server iteration 2492 cf::server_tick; # one server iteration
1135 2493 $RUNTIME += $TICK;
1136 my $NOW = Event::time;
1137 $NEXT_TICK += $TICK; 2494 $NEXT_TICK += $TICK;
1138 2495
2496 $WAIT_FOR_TICK->broadcast;
2497 $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited;
2498
1139 # if we are delayed by four ticks, skip them all 2499 # if we are delayed by four ticks or more, skip them all
1140 $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; 2500 $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1141 2501
1142 $TICK_WATCHER->at ($NEXT_TICK); 2502 $TICK_WATCHER->at ($NEXT_TICK);
1143 $TICK_WATCHER->start; 2503 $TICK_WATCHER->start;
1144 }, 2504 },
1145); 2505);
1146 2506
2507IO::AIO::max_poll_time $TICK * 0.2;
2508
2509Event->io (
2510 fd => IO::AIO::poll_fileno,
2511 poll => 'r',
2512 prio => 5,
2513 data => WF_AUTOCANCEL,
2514 cb => \&IO::AIO::poll_cb,
2515);
2516
2517Event->timer (
2518 data => WF_AUTOCANCEL,
2519 after => 0,
2520 interval => 10,
2521 cb => sub {
2522 (Coro::unblock_sub {
2523 write_runtime
2524 or warn "ERROR: unable to write runtime file: $!";
2525 })->();
2526 },
2527);
2528
2529END { cf::emergency_save }
2530
11471 25311
1148 2532

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines