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