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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines