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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines