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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines