ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/lib/cf.pm
(Generate patch)

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines