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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines