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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines