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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines