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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines