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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines