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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines