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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines