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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines