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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines