… | |
… | |
5 | use Storable; |
5 | use Storable; |
6 | use Opcode; |
6 | use Opcode; |
7 | use Safe; |
7 | use Safe; |
8 | use Safe::Hole; |
8 | use Safe::Hole; |
9 | |
9 | |
|
|
10 | use IO::AIO (); |
|
|
11 | use YAML::Syck (); |
10 | use Time::HiRes; |
12 | use Time::HiRes; |
11 | use Event; |
13 | use Event; |
12 | $Event::Eval = 1; # no idea why this is required, but it is |
14 | $Event::Eval = 1; # no idea why this is required, but it is |
13 | |
15 | |
|
|
16 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
|
|
17 | $YAML::Syck::ImplicitUnicode = 1; |
|
|
18 | |
14 | use strict; |
19 | use strict; |
15 | |
20 | |
|
|
21 | sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload |
|
|
22 | |
16 | our %COMMAND = (); |
23 | our %COMMAND = (); |
|
|
24 | our %COMMAND_TIME = (); |
|
|
25 | our %EXTCMD = (); |
|
|
26 | |
|
|
27 | _init_vars; |
|
|
28 | |
17 | our @EVENT; |
29 | our @EVENT; |
18 | our @PLUGIN_EVENT; |
30 | our $LIBDIR = datadir . "/ext"; |
19 | our %PROP_TYPE; |
|
|
20 | our %PROP_IDX; |
|
|
21 | our $LIBDIR = maps_directory "perl"; |
|
|
22 | |
31 | |
23 | our $TICK = MAX_TIME * 1e-6; |
32 | our $TICK = MAX_TIME * 1e-6; |
24 | our $TICK_WATCHER; |
33 | our $TICK_WATCHER; |
25 | our $NEXT_TICK; |
34 | our $NEXT_TICK; |
26 | |
35 | |
|
|
36 | our %CFG; |
|
|
37 | |
|
|
38 | our $UPTIME; $UPTIME ||= time; |
|
|
39 | |
|
|
40 | ############################################################################# |
|
|
41 | |
|
|
42 | =head2 GLOBAL VARIABLES |
|
|
43 | |
|
|
44 | =over 4 |
|
|
45 | |
|
|
46 | =item $cf::UPTIME |
|
|
47 | |
|
|
48 | The timestamp of the server start (so not actually an uptime). |
|
|
49 | |
|
|
50 | =item $cf::LIBDIR |
|
|
51 | |
|
|
52 | The perl library directory, where extensions and cf-specific modules can |
|
|
53 | be found. It will be added to C<@INC> automatically. |
|
|
54 | |
|
|
55 | =item $cf::TICK |
|
|
56 | |
|
|
57 | The interval between server ticks, in seconds. |
|
|
58 | |
|
|
59 | =item %cf::CFG |
|
|
60 | |
|
|
61 | Configuration for the server, loaded from C</etc/crossfire/config>, or |
|
|
62 | from wherever your confdir points to. |
|
|
63 | |
|
|
64 | =back |
|
|
65 | |
|
|
66 | =cut |
|
|
67 | |
27 | BEGIN { |
68 | BEGIN { |
28 | @PLUGIN_EVENT = map lc, @PLUGIN_EVENT; |
|
|
29 | |
|
|
30 | *CORE::GLOBAL::warn = sub { |
69 | *CORE::GLOBAL::warn = sub { |
31 | my $msg = join "", @_; |
70 | my $msg = join "", @_; |
32 | $msg .= "\n" |
71 | $msg .= "\n" |
33 | unless $msg =~ /\n$/; |
72 | unless $msg =~ /\n$/; |
34 | |
73 | |
35 | print STDERR "cfperl: $msg"; |
74 | print STDERR "cfperl: $msg"; |
36 | LOG llevError, "cfperl: $msg"; |
75 | LOG llevError, "cfperl: $msg"; |
37 | }; |
76 | }; |
38 | } |
77 | } |
39 | |
78 | |
40 | my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! |
79 | @safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; |
41 | |
80 | @safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; |
42 | # generate property mutators |
81 | @safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; |
43 | sub prop_gen { |
82 | @safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; |
44 | my ($prefix, $class) = @_; |
83 | @safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; |
45 | |
|
|
46 | no strict 'refs'; |
|
|
47 | |
|
|
48 | for my $prop (keys %PROP_TYPE) { |
|
|
49 | $prop =~ /^\Q$prefix\E_(.*$)/ or next; |
|
|
50 | my $sub = lc $1; |
|
|
51 | |
|
|
52 | my $type = $PROP_TYPE{$prop}; |
|
|
53 | my $idx = $PROP_IDX {$prop}; |
|
|
54 | |
|
|
55 | *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub { |
|
|
56 | $_[0]->get_property ($type, $idx) |
|
|
57 | }; |
|
|
58 | |
|
|
59 | *{"$class\::set_$sub"} = sub { |
|
|
60 | $_[0]->set_property ($type, $idx, $_[1]); |
|
|
61 | } unless $ignore_set{$prop}; |
|
|
62 | } |
|
|
63 | } |
|
|
64 | |
|
|
65 | # auto-generate most of the API |
|
|
66 | |
|
|
67 | prop_gen OBJECT_PROP => "cf::object"; |
|
|
68 | # CFAPI_OBJECT_ANIMATION? |
|
|
69 | prop_gen PLAYER_PROP => "cf::object::player"; |
|
|
70 | |
|
|
71 | prop_gen MAP_PROP => "cf::map"; |
|
|
72 | prop_gen ARCH_PROP => "cf::arch"; |
|
|
73 | |
|
|
74 | # guessed hierarchies |
|
|
75 | |
|
|
76 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
84 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
77 | @safe::cf::object::map::ISA = @cf::object::map::ISA = 'cf::object'; |
|
|
78 | |
85 | |
79 | # we bless all objects into (empty) derived classes to force a method lookup |
86 | # we bless all objects into (empty) derived classes to force a method lookup |
80 | # within the Safe compartment. |
87 | # within the Safe compartment. |
81 | for my $pkg (qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region cf::arch)) { |
88 | for my $pkg (qw( |
|
|
89 | cf::global |
|
|
90 | cf::object cf::object::player |
|
|
91 | cf::client cf::player |
|
|
92 | cf::arch cf::living |
|
|
93 | cf::map cf::party cf::region |
|
|
94 | )) { |
82 | no strict 'refs'; |
95 | no strict 'refs'; |
83 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
96 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
84 | } |
97 | } |
85 | |
98 | |
86 | $Event::DIED = sub { |
99 | $Event::DIED = sub { |
… | |
… | |
88 | }; |
101 | }; |
89 | |
102 | |
90 | my %ext_pkg; |
103 | my %ext_pkg; |
91 | my @exts; |
104 | my @exts; |
92 | my @hook; |
105 | my @hook; |
93 | my %command; |
106 | |
94 | my %extcmd; |
107 | =head2 UTILITY FUNCTIONS |
|
|
108 | |
|
|
109 | =over 4 |
|
|
110 | |
|
|
111 | =cut |
|
|
112 | |
|
|
113 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
|
|
114 | |
|
|
115 | =item $ref = cf::from_json $json |
|
|
116 | |
|
|
117 | Converts a JSON string into the corresponding perl data structure. |
|
|
118 | |
|
|
119 | =cut |
|
|
120 | |
|
|
121 | sub from_json($) { |
|
|
122 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
|
|
123 | JSON::Syck::Load $_[0] |
|
|
124 | } |
|
|
125 | |
|
|
126 | =item $json = cf::to_json $ref |
|
|
127 | |
|
|
128 | Converts a perl data structure into its JSON representation. |
|
|
129 | |
|
|
130 | =cut |
|
|
131 | |
|
|
132 | sub to_json($) { |
|
|
133 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
|
|
134 | JSON::Syck::Dump $_[0] |
|
|
135 | } |
|
|
136 | |
|
|
137 | =back |
|
|
138 | |
|
|
139 | =cut |
95 | |
140 | |
96 | ############################################################################# |
141 | ############################################################################# |
97 | # "new" plug-in system |
|
|
98 | |
142 | |
99 | =item cf::object::attach ... # NYI |
143 | =head2 ATTACHABLE OBJECTS |
100 | |
144 | |
101 | =item cf::attach_global ... |
145 | You can define and attach attachments to each "attachable" object in |
|
|
146 | crossfire+ (objects, players, clients, maps and the special "global" |
|
|
147 | class). In the following description, CLASS can be any of C<global>, |
|
|
148 | C<object> C<player>, C<client> or C<map>. |
102 | |
149 | |
103 | =item cf::attach_to_type ... |
150 | =over 4 |
104 | |
151 | |
105 | =item cf::attach_to_objects ... |
152 | =item cf::CLASS::attachment $name, ... |
106 | |
153 | |
107 | =item cf::attach_to_players ... |
154 | Register an attachment by name through which attachable objects can refer |
|
|
155 | to this attachment. |
108 | |
156 | |
109 | =item cf::attach_to_maps ... |
157 | =item $bool = $attachable->attached ($name) |
110 | |
158 | |
111 | prio => $number, # lower is earlier |
159 | Checks wether the named attachment is currently attached to the object. |
112 | on_xxx => \&cb, |
160 | |
|
|
161 | =item $attachable->attach ($attachment, key => $value...) |
|
|
162 | |
|
|
163 | =item $attachable->detach ($attachment) |
|
|
164 | |
|
|
165 | Attach/detach a pre-registered attachment either to a specific object |
|
|
166 | (C<$attachable>) or all objects of the given class (if C<$attachable> is a |
|
|
167 | class in a static method call). |
|
|
168 | |
|
|
169 | You can attach to global events by using the C<cf::global> class. |
|
|
170 | |
|
|
171 | These method calls expect any number of the following handler/hook |
|
|
172 | descriptions: |
|
|
173 | |
|
|
174 | =over 4 |
|
|
175 | |
|
|
176 | =item prio => $number |
|
|
177 | |
|
|
178 | Set the priority for all following handlers/hooks (unless overwritten |
|
|
179 | by another C<prio> setting). Lower priority handlers get executed |
|
|
180 | earlier. The default priority is C<0>, and many built-in handlers are |
|
|
181 | registered at priority C<-1000>, so lower priorities should not be used |
|
|
182 | unless you know what you are doing. |
|
|
183 | |
|
|
184 | =item type => $type |
|
|
185 | |
|
|
186 | (Only for C<< cf::object->attach >> calls), limits the attachment to the |
|
|
187 | given type of objects only (the additional parameter C<subtype> can be |
|
|
188 | used to further limit to the given subtype). |
|
|
189 | |
|
|
190 | =item on_I<event> => \&cb |
|
|
191 | |
|
|
192 | Call the given code reference whenever the named event happens (event is |
|
|
193 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
|
|
194 | handlers are recognised generally depends on the type of object these |
|
|
195 | handlers attach to). |
|
|
196 | |
|
|
197 | See F<include/eventinc.h> for the full list of events supported, and their |
|
|
198 | class. |
|
|
199 | |
113 | package => package::, |
200 | =item package => package:: |
|
|
201 | |
|
|
202 | Look for sub functions of the name C<< on_I<event> >> in the given |
|
|
203 | package and register them. Only handlers for eevents supported by the |
|
|
204 | object/class are recognised. |
|
|
205 | |
|
|
206 | =back |
114 | |
207 | |
115 | =cut |
208 | =cut |
116 | |
209 | |
117 | # the following variables are defined in .xs and must not be re-created |
210 | # the following variables are defined in .xs and must not be re-created |
118 | our @CB_GLOBAL = (); # registry for all global events |
211 | our @CB_GLOBAL = (); # registry for all global events |
119 | our @CB_OBJECT = (); |
212 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
120 | our @CB_PLAYER = (); |
213 | our @CB_PLAYER = (); |
|
|
214 | our @CB_CLIENT = (); |
121 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
215 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
122 | our @CB_MAP = (); |
216 | our @CB_MAP = (); |
123 | |
217 | |
|
|
218 | my %attachment; |
|
|
219 | |
124 | sub _attach_cb($\%$$$) { |
220 | sub _attach_cb($$$$) { |
125 | my ($registry, $undo, $event, $prio, $cb) = @_; |
221 | my ($registry, $event, $prio, $cb) = @_; |
126 | |
222 | |
127 | use sort 'stable'; |
223 | use sort 'stable'; |
128 | |
224 | |
129 | $cb = [$prio, $cb]; |
225 | $cb = [$prio, $cb]; |
130 | |
226 | |
131 | @{$registry->[$event]} = sort |
227 | @{$registry->[$event]} = sort |
132 | { $a->[0] cmp $b->[0] } |
228 | { $a->[0] cmp $b->[0] } |
133 | @{$registry->[$event] || []}, $cb; |
229 | @{$registry->[$event] || []}, $cb; |
134 | |
|
|
135 | push @{$undo->{cb}}, [$event, $cb]; |
|
|
136 | } |
230 | } |
137 | |
231 | |
138 | # attach handles attaching event callbacks |
232 | # attach handles attaching event callbacks |
139 | # the only thing the caller has to do is pass the correct |
233 | # the only thing the caller has to do is pass the correct |
140 | # registry (== where the callback attaches to). |
234 | # registry (== where the callback attaches to). |
141 | sub _attach(\@$\@) { |
235 | sub _attach { |
142 | my ($registry, $klass, $arg) = @_; |
236 | my ($registry, $klass, @arg) = @_; |
143 | |
237 | |
|
|
238 | my $object_type; |
144 | my $prio = 0; |
239 | my $prio = 0; |
145 | |
|
|
146 | my %undo = ( |
|
|
147 | registry => $registry, |
|
|
148 | cb => [], |
|
|
149 | ); |
|
|
150 | |
|
|
151 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
240 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
152 | |
241 | |
153 | while (@$arg) { |
242 | while (@arg) { |
154 | my $type = shift @$arg; |
243 | my $type = shift @arg; |
155 | |
244 | |
156 | if ($type eq "prio") { |
245 | if ($type eq "prio") { |
157 | $prio = shift @$arg; |
246 | $prio = shift @arg; |
|
|
247 | |
|
|
248 | } elsif ($type eq "type") { |
|
|
249 | $object_type = shift @arg; |
|
|
250 | $registry = $CB_TYPE[$object_type] ||= []; |
|
|
251 | |
|
|
252 | } elsif ($type eq "subtype") { |
|
|
253 | defined $object_type or Carp::croak "subtype specified without type"; |
|
|
254 | my $object_subtype = shift @arg; |
|
|
255 | $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; |
158 | |
256 | |
159 | } elsif ($type eq "package") { |
257 | } elsif ($type eq "package") { |
160 | my $pkg = shift @$arg; |
258 | my $pkg = shift @arg; |
161 | |
259 | |
162 | while (my ($name, $id) = each %cb_id) { |
260 | while (my ($name, $id) = each %cb_id) { |
163 | if (my $cb = $pkg->can ($name)) { |
261 | if (my $cb = $pkg->can ($name)) { |
164 | _attach_cb $registry, %undo, $id, $prio, $cb; |
262 | _attach_cb $registry, $id, $prio, $cb; |
165 | } |
263 | } |
166 | } |
264 | } |
167 | |
265 | |
168 | } elsif (exists $cb_id{$type}) { |
266 | } elsif (exists $cb_id{$type}) { |
169 | _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @$arg; |
267 | _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; |
170 | |
268 | |
171 | } elsif (ref $type) { |
269 | } elsif (ref $type) { |
172 | warn "attaching objects not supported, ignoring.\n"; |
270 | warn "attaching objects not supported, ignoring.\n"; |
173 | |
271 | |
174 | } else { |
272 | } else { |
175 | shift @$arg; |
273 | shift @arg; |
176 | warn "attach argument '$type' not supported, ignoring.\n"; |
274 | warn "attach argument '$type' not supported, ignoring.\n"; |
177 | } |
275 | } |
178 | } |
276 | } |
179 | |
|
|
180 | \%undo |
|
|
181 | } |
277 | } |
182 | |
278 | |
183 | sub cf::object::attach { |
279 | sub _object_attach { |
184 | die; |
280 | my ($obj, $name, %arg) = @_; |
185 | } |
|
|
186 | |
281 | |
187 | sub attach_global { |
282 | return if exists $obj->{_attachment}{$name}; |
188 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
|
|
189 | } |
|
|
190 | |
283 | |
191 | sub attach_to_type { |
284 | if (my $attach = $attachment{$name}) { |
192 | my $type = shift; |
285 | my $registry = $obj->registry; |
193 | _attach @{$CB_TYPE[$type]}, KLASS_OBJECT, @_ |
|
|
194 | } |
|
|
195 | |
286 | |
196 | sub attach_to_objects { |
287 | for (@$attach) { |
197 | _attach @CB_OBJECT, KLASS_OBJECT, @_ |
288 | my ($klass, @attach) = @$_; |
198 | } |
289 | _attach $registry, $klass, @attach; |
|
|
290 | } |
199 | |
291 | |
200 | sub attach_to_players { |
292 | $obj->{$name} = \%arg; |
201 | _attach @CB_PLAYER, KLASS_PLAYER, @_ |
293 | } else { |
202 | } |
294 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
295 | } |
203 | |
296 | |
204 | sub attach_to_maps { |
297 | $obj->{_attachment}{$name} = undef; |
205 | _attach @CB_MAP, KLASS_MAP, @_ |
298 | } |
|
|
299 | |
|
|
300 | sub cf::attachable::attach { |
|
|
301 | if (ref $_[0]) { |
|
|
302 | _object_attach @_; |
|
|
303 | } else { |
|
|
304 | _attach shift->_attach_registry, @_; |
|
|
305 | } |
|
|
306 | }; |
|
|
307 | |
|
|
308 | # all those should be optimised |
|
|
309 | sub cf::attachable::detach { |
|
|
310 | my ($obj, $name) = @_; |
|
|
311 | |
|
|
312 | if (ref $obj) { |
|
|
313 | delete $obj->{_attachment}{$name}; |
|
|
314 | reattach ($obj); |
|
|
315 | } else { |
|
|
316 | Carp::croak "cannot, currently, detach class attachments"; |
|
|
317 | } |
|
|
318 | }; |
|
|
319 | |
|
|
320 | sub cf::attachable::attached { |
|
|
321 | my ($obj, $name) = @_; |
|
|
322 | |
|
|
323 | exists $obj->{_attachment}{$name} |
|
|
324 | } |
|
|
325 | |
|
|
326 | for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { |
|
|
327 | eval "#line " . __LINE__ . " 'cf.pm' |
|
|
328 | sub cf::\L$klass\E::_attach_registry { |
|
|
329 | (\\\@CB_$klass, KLASS_$klass) |
|
|
330 | } |
|
|
331 | |
|
|
332 | sub cf::\L$klass\E::attachment { |
|
|
333 | my \$name = shift; |
|
|
334 | |
|
|
335 | \$attachment{\$name} = [[KLASS_$klass, \@_]]; |
|
|
336 | } |
|
|
337 | "; |
|
|
338 | die if $@; |
206 | } |
339 | } |
207 | |
340 | |
208 | our $override; |
341 | our $override; |
|
|
342 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
209 | |
343 | |
210 | sub override() { |
344 | sub override { |
211 | $override = 1 |
345 | $override = 1; |
|
|
346 | @invoke_results = (); |
212 | } |
347 | } |
213 | |
348 | |
214 | sub invoke { |
349 | sub do_invoke { |
215 | my $event = shift; |
350 | my $event = shift; |
216 | my $callbacks = shift; |
351 | my $callbacks = shift; |
217 | |
352 | |
|
|
353 | @invoke_results = (); |
|
|
354 | |
218 | local $override; |
355 | local $override; |
219 | |
356 | |
220 | for (@$callbacks) { |
357 | for (@$callbacks) { |
221 | eval { &{$_->[1]} }; |
358 | eval { &{$_->[1]} }; |
222 | |
359 | |
223 | if ($@) { |
360 | if ($@) { |
224 | warn "$@"; |
361 | warn "$@"; |
225 | warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; |
362 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
226 | override; |
363 | override; |
227 | } |
364 | } |
228 | |
365 | |
229 | return 1 if $override; |
366 | return 1 if $override; |
230 | } |
367 | } |
231 | |
368 | |
232 | 0 |
369 | 0 |
233 | } |
370 | } |
234 | |
371 | |
|
|
372 | =item $bool = cf::invoke EVENT_GLOBAL_XXX, ... |
|
|
373 | |
|
|
374 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
|
|
375 | |
|
|
376 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
|
|
377 | |
|
|
378 | =item $bool = $client->invoke (EVENT_CLIENT_XXX, ...) |
|
|
379 | |
|
|
380 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
|
|
381 | |
|
|
382 | Generate a global/object/player/map-specific event with the given arguments. |
|
|
383 | |
|
|
384 | This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be |
|
|
385 | removed in future versions), and there is no public API to access override |
|
|
386 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
387 | |
|
|
388 | =back |
|
|
389 | |
|
|
390 | =cut |
|
|
391 | |
235 | ############################################################################# |
392 | ############################################################################# |
236 | # old plug-in events |
|
|
237 | |
393 | |
238 | sub inject_event { |
394 | =head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS |
239 | my $extension = shift; |
|
|
240 | my $event_code = shift; |
|
|
241 | |
395 | |
242 | my $cb = $hook[$event_code]{$extension} |
396 | Attachable objects includes objects, players, clients and maps. |
243 | or return; |
|
|
244 | |
397 | |
245 | &$cb |
398 | =over 4 |
246 | } |
|
|
247 | |
399 | |
248 | sub inject_global_event { |
400 | =item $object->valid |
249 | my $event = shift; |
|
|
250 | |
401 | |
251 | my $cb = $hook[$event] |
402 | Just because you have a perl object does not mean that the corresponding |
252 | or return; |
403 | C-level object still exists. If you try to access an object that has no |
|
|
404 | valid C counterpart anymore you get an exception at runtime. This method |
|
|
405 | can be used to test for existence of the C object part without causing an |
|
|
406 | exception. |
253 | |
407 | |
254 | List::Util::max map &$_, values %$cb |
408 | =back |
255 | } |
|
|
256 | |
409 | |
257 | sub inject_command { |
410 | =cut |
|
|
411 | |
|
|
412 | ############################################################################# |
|
|
413 | # object support |
|
|
414 | |
|
|
415 | sub instantiate { |
|
|
416 | my ($obj, $data) = @_; |
|
|
417 | |
|
|
418 | $data = from_json $data; |
|
|
419 | |
|
|
420 | for (@$data) { |
258 | my ($name, $obj, $params) = @_; |
421 | my ($name, $args) = @$_; |
259 | |
422 | |
260 | for my $cmd (@{ $command{$name} }) { |
423 | $obj->attach ($name, %{$args || {} }); |
261 | $cmd->[1]->($obj, $params); |
424 | } |
|
|
425 | } |
|
|
426 | |
|
|
427 | # basically do the same as instantiate, without calling instantiate |
|
|
428 | sub reattach { |
|
|
429 | my ($obj) = @_; |
|
|
430 | my $registry = $obj->registry; |
|
|
431 | |
|
|
432 | @$registry = (); |
|
|
433 | |
|
|
434 | delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
|
|
435 | |
|
|
436 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
|
|
437 | if (my $attach = $attachment{$name}) { |
|
|
438 | for (@$attach) { |
|
|
439 | my ($klass, @attach) = @$_; |
|
|
440 | _attach $registry, $klass, @attach; |
|
|
441 | } |
|
|
442 | } else { |
|
|
443 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
444 | } |
|
|
445 | } |
|
|
446 | } |
|
|
447 | |
|
|
448 | sub object_freezer_save { |
|
|
449 | my ($filename, $rdata, $objs) = @_; |
|
|
450 | |
|
|
451 | if (length $$rdata) { |
|
|
452 | warn sprintf "saving %s (%d,%d)\n", |
|
|
453 | $filename, length $$rdata, scalar @$objs; |
|
|
454 | |
|
|
455 | if (open my $fh, ">:raw", "$filename~") { |
|
|
456 | chmod SAVE_MODE, $fh; |
|
|
457 | syswrite $fh, $$rdata; |
|
|
458 | close $fh; |
|
|
459 | |
|
|
460 | if (@$objs && open my $fh, ">:raw", "$filename.pst~") { |
|
|
461 | chmod SAVE_MODE, $fh; |
|
|
462 | syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; |
|
|
463 | close $fh; |
|
|
464 | rename "$filename.pst~", "$filename.pst"; |
|
|
465 | } else { |
|
|
466 | unlink "$filename.pst"; |
|
|
467 | } |
|
|
468 | |
|
|
469 | rename "$filename~", $filename; |
|
|
470 | } else { |
|
|
471 | warn "FATAL: $filename~: $!\n"; |
|
|
472 | } |
|
|
473 | } else { |
|
|
474 | unlink $filename; |
|
|
475 | unlink "$filename.pst"; |
|
|
476 | } |
|
|
477 | } |
|
|
478 | |
|
|
479 | sub object_freezer_as_string { |
|
|
480 | my ($rdata, $objs) = @_; |
|
|
481 | |
|
|
482 | use Data::Dumper; |
|
|
483 | |
|
|
484 | $$rdata . Dumper $objs |
|
|
485 | } |
|
|
486 | |
|
|
487 | sub object_thawer_load { |
|
|
488 | my ($filename) = @_; |
|
|
489 | |
|
|
490 | local $/; |
|
|
491 | |
|
|
492 | my $av; |
|
|
493 | |
|
|
494 | #TODO: use sysread etc. |
|
|
495 | if (open my $data, "<:raw:perlio", $filename) { |
|
|
496 | $data = <$data>; |
|
|
497 | if (open my $pst, "<:raw:perlio", "$filename.pst") { |
|
|
498 | $av = eval { (Storable::thaw <$pst>)->{objs} }; |
|
|
499 | } |
|
|
500 | return ($data, $av); |
|
|
501 | } |
|
|
502 | |
|
|
503 | () |
|
|
504 | } |
|
|
505 | |
|
|
506 | cf::object->attach ( |
|
|
507 | prio => -1000000, |
|
|
508 | on_clone => sub { |
|
|
509 | my ($src, $dst) = @_; |
|
|
510 | |
|
|
511 | @{$dst->registry} = @{$src->registry}; |
|
|
512 | |
|
|
513 | %$dst = %$src; |
|
|
514 | |
|
|
515 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
|
|
516 | if exists $src->{_attachment}; |
262 | } |
517 | }, |
|
|
518 | ); |
263 | |
519 | |
264 | -1 |
520 | ############################################################################# |
265 | } |
521 | # command handling &c |
|
|
522 | |
|
|
523 | =item cf::register_command $name => \&callback($ob,$args); |
|
|
524 | |
|
|
525 | Register a callback for execution when the client sends the user command |
|
|
526 | $name. |
|
|
527 | |
|
|
528 | =cut |
266 | |
529 | |
267 | sub register_command { |
530 | sub register_command { |
268 | my ($name, $time, $cb) = @_; |
531 | my ($name, $cb) = @_; |
269 | |
532 | |
270 | my $caller = caller; |
533 | my $caller = caller; |
271 | #warn "registering command '$name/$time' to '$caller'"; |
534 | #warn "registering command '$name/$time' to '$caller'"; |
272 | |
535 | |
273 | push @{ $command{$name} }, [$time, $cb, $caller]; |
536 | push @{ $COMMAND{$name} }, [$caller, $cb]; |
274 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
|
|
275 | } |
537 | } |
|
|
538 | |
|
|
539 | =item cf::register_extcmd $name => \&callback($pl,$packet); |
|
|
540 | |
|
|
541 | Register a callbackf ro execution when the client sends an extcmd packet. |
|
|
542 | |
|
|
543 | If the callback returns something, it is sent back as if reply was being |
|
|
544 | called. |
|
|
545 | |
|
|
546 | =cut |
276 | |
547 | |
277 | sub register_extcmd { |
548 | sub register_extcmd { |
278 | my ($name, $cb) = @_; |
549 | my ($name, $cb) = @_; |
279 | |
550 | |
280 | my $caller = caller; |
551 | my $caller = caller; |
281 | #warn "registering extcmd '$name' to '$caller'"; |
552 | #warn "registering extcmd '$name' to '$caller'"; |
282 | |
553 | |
283 | $extcmd{$name} = [$cb, $caller]; |
554 | $EXTCMD{$name} = [$cb, $caller]; |
284 | } |
555 | } |
|
|
556 | |
|
|
557 | cf::player->attach ( |
|
|
558 | on_command => sub { |
|
|
559 | my ($pl, $name, $params) = @_; |
|
|
560 | |
|
|
561 | my $cb = $COMMAND{$name} |
|
|
562 | or return; |
|
|
563 | |
|
|
564 | for my $cmd (@$cb) { |
|
|
565 | $cmd->[1]->($pl->ob, $params); |
|
|
566 | } |
|
|
567 | |
|
|
568 | cf::override; |
|
|
569 | }, |
|
|
570 | on_extcmd => sub { |
|
|
571 | my ($pl, $buf) = @_; |
|
|
572 | |
|
|
573 | my $msg = eval { from_json $buf }; |
|
|
574 | |
|
|
575 | if (ref $msg) { |
|
|
576 | if (my $cb = $EXTCMD{$msg->{msgtype}}) { |
|
|
577 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
578 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
579 | } |
|
|
580 | } |
|
|
581 | } else { |
|
|
582 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
583 | } |
|
|
584 | |
|
|
585 | cf::override; |
|
|
586 | }, |
|
|
587 | ); |
285 | |
588 | |
286 | sub register { |
589 | sub register { |
287 | my ($base, $pkg) = @_; |
590 | my ($base, $pkg) = @_; |
288 | |
591 | |
289 | for my $idx (0 .. $#PLUGIN_EVENT) { |
592 | #TODO |
290 | if (my $ref = $pkg->can ("on_$PLUGIN_EVENT[$idx]")) { |
|
|
291 | #warn "registering $PLUGIN_EVENT[$idx] hook to '$pkg'\n"; |
|
|
292 | $hook[$idx]{$base} = $ref; |
|
|
293 | } |
|
|
294 | } |
|
|
295 | } |
593 | } |
296 | |
594 | |
297 | sub load_extension { |
595 | sub load_extension { |
298 | my ($path) = @_; |
596 | my ($path) = @_; |
299 | |
597 | |
… | |
… | |
313 | . "#line 1 \"$path\"\n{\n" |
611 | . "#line 1 \"$path\"\n{\n" |
314 | . (do { local $/; <$fh> }) |
612 | . (do { local $/; <$fh> }) |
315 | . "\n};\n1"; |
613 | . "\n};\n1"; |
316 | |
614 | |
317 | eval $source |
615 | eval $source |
318 | or die "$path: $@"; |
616 | or die $@ ? "$path: $@\n" |
|
|
617 | : "extension disabled.\n"; |
319 | |
618 | |
320 | push @exts, $pkg; |
619 | push @exts, $pkg; |
321 | $ext_pkg{$base} = $pkg; |
620 | $ext_pkg{$base} = $pkg; |
322 | |
621 | |
323 | # no strict 'refs'; |
622 | # no strict 'refs'; |
… | |
… | |
330 | my ($pkg) = @_; |
629 | my ($pkg) = @_; |
331 | |
630 | |
332 | warn "removing extension $pkg\n"; |
631 | warn "removing extension $pkg\n"; |
333 | |
632 | |
334 | # remove hooks |
633 | # remove hooks |
|
|
634 | #TODO |
335 | for my $idx (0 .. $#PLUGIN_EVENT) { |
635 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
336 | delete $hook[$idx]{$pkg}; |
636 | # delete $hook[$idx]{$pkg}; |
337 | } |
637 | # } |
338 | |
638 | |
339 | # remove commands |
639 | # remove commands |
340 | for my $name (keys %command) { |
640 | for my $name (keys %COMMAND) { |
341 | my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; |
641 | my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; |
342 | |
642 | |
343 | if (@cb) { |
643 | if (@cb) { |
344 | $command{$name} = \@cb; |
644 | $COMMAND{$name} = \@cb; |
345 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; |
|
|
346 | } else { |
645 | } else { |
347 | delete $command{$name}; |
|
|
348 | delete $COMMAND{"$name\000"}; |
646 | delete $COMMAND{$name}; |
349 | } |
647 | } |
350 | } |
648 | } |
351 | |
649 | |
352 | # remove extcmds |
650 | # remove extcmds |
353 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
651 | for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { |
354 | delete $extcmd{$name}; |
652 | delete $EXTCMD{$name}; |
355 | } |
653 | } |
356 | |
654 | |
357 | if (my $cb = $pkg->can ("on_unload")) { |
655 | if (my $cb = $pkg->can ("unload")) { |
358 | eval { |
656 | eval { |
359 | $cb->($pkg); |
657 | $cb->($pkg); |
360 | 1 |
658 | 1 |
361 | } or warn "$pkg unloaded, but with errors: $@"; |
659 | } or warn "$pkg unloaded, but with errors: $@"; |
362 | } |
660 | } |
363 | |
661 | |
364 | Symbol::delete_package $pkg; |
662 | Symbol::delete_package $pkg; |
365 | } |
663 | } |
366 | |
664 | |
367 | sub load_extensions { |
665 | sub load_extensions { |
368 | my $LIBDIR = maps_directory "perl"; |
|
|
369 | |
|
|
370 | for my $ext (<$LIBDIR/*.ext>) { |
666 | for my $ext (<$LIBDIR/*.ext>) { |
371 | next unless -r $ext; |
667 | next unless -r $ext; |
372 | eval { |
668 | eval { |
373 | load_extension $ext; |
669 | load_extension $ext; |
374 | 1 |
670 | 1 |
375 | } or warn "$ext not loaded: $@"; |
671 | } or warn "$ext not loaded: $@"; |
376 | } |
672 | } |
377 | } |
673 | } |
378 | |
674 | |
379 | sub _perl_reload(&) { |
|
|
380 | my ($msg) = @_; |
|
|
381 | |
|
|
382 | $msg->("reloading..."); |
|
|
383 | |
|
|
384 | eval { |
|
|
385 | # 1. cancel all watchers |
|
|
386 | $_->cancel for Event::all_watchers; |
|
|
387 | |
|
|
388 | # 2. unload all extensions |
|
|
389 | for (@exts) { |
|
|
390 | $msg->("unloading <$_>"); |
|
|
391 | unload_extension $_; |
|
|
392 | } |
|
|
393 | |
|
|
394 | # 3. unload all modules loaded from $LIBDIR |
|
|
395 | while (my ($k, $v) = each %INC) { |
|
|
396 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
397 | |
|
|
398 | $msg->("removing <$k>"); |
|
|
399 | delete $INC{$k}; |
|
|
400 | |
|
|
401 | $k =~ s/\.pm$//; |
|
|
402 | $k =~ s/\//::/g; |
|
|
403 | |
|
|
404 | if (my $cb = $k->can ("unload_module")) { |
|
|
405 | $cb->(); |
|
|
406 | } |
|
|
407 | |
|
|
408 | Symbol::delete_package $k; |
|
|
409 | } |
|
|
410 | |
|
|
411 | # 4. get rid of safe::, as good as possible |
|
|
412 | Symbol::delete_package "safe::$_" |
|
|
413 | for qw(cf::object cf::object::map cf::object::player cf::player cf::map cf::party cf::region); |
|
|
414 | |
|
|
415 | # 5. remove register_script_function callbacks |
|
|
416 | # TODO |
|
|
417 | |
|
|
418 | # 6. unload cf.pm "a bit" |
|
|
419 | delete $INC{"cf.pm"}; |
|
|
420 | |
|
|
421 | # don't, removes xs symbols, too, |
|
|
422 | # and global variables created in xs |
|
|
423 | #Symbol::delete_package __PACKAGE__; |
|
|
424 | |
|
|
425 | # 7. reload cf.pm |
|
|
426 | $msg->("reloading cf.pm"); |
|
|
427 | require cf; |
|
|
428 | }; |
|
|
429 | $msg->($@) if $@; |
|
|
430 | |
|
|
431 | $msg->("reloaded"); |
|
|
432 | }; |
|
|
433 | |
|
|
434 | sub perl_reload() { |
|
|
435 | _perl_reload { |
|
|
436 | warn $_[0]; |
|
|
437 | print "$_[0]\n"; |
|
|
438 | }; |
|
|
439 | } |
|
|
440 | |
|
|
441 | register_command "perl-reload", 0, sub { |
|
|
442 | my ($who, $arg) = @_; |
|
|
443 | |
|
|
444 | if ($who->flag (FLAG_WIZ)) { |
|
|
445 | _perl_reload { |
|
|
446 | warn $_[0]; |
|
|
447 | $who->message ($_[0]); |
|
|
448 | }; |
|
|
449 | } |
|
|
450 | }; |
|
|
451 | |
|
|
452 | ############################################################################# |
|
|
453 | # utility functions |
|
|
454 | |
|
|
455 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
|
|
456 | |
|
|
457 | sub from_json($) { |
|
|
458 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
|
|
459 | JSON::Syck::Load $_[0] |
|
|
460 | } |
|
|
461 | |
|
|
462 | sub to_json($) { |
|
|
463 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
|
|
464 | JSON::Syck::Dump $_[0] |
|
|
465 | } |
|
|
466 | |
|
|
467 | ############################################################################# |
|
|
468 | # extcmd framework, basically convert ext <msg> |
|
|
469 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
470 | |
|
|
471 | sub on_extcmd { |
|
|
472 | my ($pl, $buf) = @_; |
|
|
473 | |
|
|
474 | my $msg = eval { from_json $buf }; |
|
|
475 | |
|
|
476 | if (ref $msg) { |
|
|
477 | if (my $cb = $extcmd{$msg->{msgtype}}) { |
|
|
478 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
479 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
480 | } |
|
|
481 | } |
|
|
482 | } else { |
|
|
483 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
484 | } |
|
|
485 | |
|
|
486 | 1 |
|
|
487 | } |
|
|
488 | |
|
|
489 | ############################################################################# |
675 | ############################################################################# |
490 | # load/save/clean perl data associated with a map |
676 | # load/save/clean perl data associated with a map |
491 | |
677 | |
492 | *cf::mapsupport::on_clean = sub { |
678 | *cf::mapsupport::on_clean = sub { |
493 | my ($map) = @_; |
679 | my ($map) = @_; |
494 | |
680 | |
495 | my $path = $map->tmpname; |
681 | my $path = $map->tmpname; |
496 | defined $path or return; |
682 | defined $path or return; |
497 | |
683 | |
498 | unlink "$path.cfperl"; |
684 | unlink "$path.pst"; |
499 | }; |
685 | }; |
500 | |
686 | |
501 | *cf::mapsupport::on_swapin = |
|
|
502 | *cf::mapsupport::on_load = sub { |
|
|
503 | my ($map) = @_; |
|
|
504 | |
|
|
505 | my $path = $map->tmpname; |
|
|
506 | $path = $map->path unless defined $path; |
|
|
507 | |
|
|
508 | open my $fh, "<:raw", "$path.cfperl" |
|
|
509 | or return; # no perl data |
|
|
510 | |
|
|
511 | my $data = Storable::thaw do { local $/; <$fh> }; |
|
|
512 | |
|
|
513 | $data->{version} <= 1 |
|
|
514 | or return; # too new |
|
|
515 | |
|
|
516 | $map->_set_obs ($data->{obs}); |
|
|
517 | }; |
|
|
518 | |
|
|
519 | *cf::mapsupport::on_swapout = sub { |
|
|
520 | my ($map) = @_; |
|
|
521 | |
|
|
522 | my $path = $map->tmpname; |
|
|
523 | $path = $map->path unless defined $path; |
|
|
524 | |
|
|
525 | my $obs = $map->_get_obs; |
|
|
526 | |
|
|
527 | if (defined $obs) { |
|
|
528 | open my $fh, ">:raw", "$path.cfperl" |
|
|
529 | or die "$path.cfperl: $!"; |
|
|
530 | |
|
|
531 | stat $path; |
|
|
532 | |
|
|
533 | print $fh Storable::nfreeze { |
|
|
534 | size => (stat _)[7], |
|
|
535 | time => (stat _)[9], |
|
|
536 | version => 1, |
|
|
537 | obs => $obs, |
|
|
538 | }; |
|
|
539 | |
|
|
540 | chmod SAVE_MODE, "$path.cfperl"; # very racy, but cf-compatible *g* |
|
|
541 | } else { |
|
|
542 | unlink "$path.cfperl"; |
|
|
543 | } |
|
|
544 | }; |
|
|
545 | |
|
|
546 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
687 | cf::map->attach (prio => -10000, package => cf::mapsupport::); |
547 | |
688 | |
548 | ############################################################################# |
689 | ############################################################################# |
549 | # load/save perl data associated with player->ob objects |
690 | # load/save perl data associated with player->ob objects |
550 | |
691 | |
551 | sub all_objects(@) { |
692 | sub all_objects(@) { |
552 | @_, map all_objects ($_->inv), @_ |
693 | @_, map all_objects ($_->inv), @_ |
553 | } |
694 | } |
554 | |
695 | |
555 | attach_to_players |
696 | # TODO: compatibility cruft, remove when no longer needed |
|
|
697 | cf::player->attach ( |
556 | on_load => sub { |
698 | on_load => sub { |
557 | my ($pl, $path) = @_; |
699 | my ($pl, $path) = @_; |
558 | |
700 | |
559 | for my $o (all_objects $pl->ob) { |
701 | for my $o (all_objects $pl->ob) { |
560 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
702 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
… | |
… | |
562 | |
704 | |
563 | %$o = %{ Storable::thaw pack "H*", $value }; |
705 | %$o = %{ Storable::thaw pack "H*", $value }; |
564 | } |
706 | } |
565 | } |
707 | } |
566 | }, |
708 | }, |
567 | on_save => sub { |
709 | ); |
568 | my ($pl, $path) = @_; |
|
|
569 | |
|
|
570 | $_->set_ob_key_value (_perl_data => unpack "H*", Storable::nfreeze $_) |
|
|
571 | for grep %$_, all_objects $pl->ob; |
|
|
572 | }, |
|
|
573 | ; |
|
|
574 | |
710 | |
575 | ############################################################################# |
711 | ############################################################################# |
576 | # core extensions - in perl |
712 | |
|
|
713 | =head2 CORE EXTENSIONS |
|
|
714 | |
|
|
715 | Functions and methods that extend core crossfire objects. |
|
|
716 | |
|
|
717 | =over 4 |
577 | |
718 | |
578 | =item cf::player::exists $login |
719 | =item cf::player::exists $login |
579 | |
720 | |
580 | Returns true when the given account exists. |
721 | Returns true when the given account exists. |
581 | |
722 | |
… | |
… | |
584 | sub cf::player::exists($) { |
725 | sub cf::player::exists($) { |
585 | cf::player::find $_[0] |
726 | cf::player::find $_[0] |
586 | or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
727 | or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
587 | } |
728 | } |
588 | |
729 | |
589 | =item $player->reply ($npc, $msg[, $flags]) |
730 | =item $player_object->reply ($npc, $msg[, $flags]) |
590 | |
731 | |
591 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
732 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
592 | can be C<undef>. Does the right thing when the player is currently in a |
733 | can be C<undef>. Does the right thing when the player is currently in a |
593 | dialogue with the given NPC character. |
734 | dialogue with the given NPC character. |
594 | |
735 | |
… | |
… | |
621 | $msg{msgid} = $id; |
762 | $msg{msgid} = $id; |
622 | |
763 | |
623 | $self->send ("ext " . to_json \%msg); |
764 | $self->send ("ext " . to_json \%msg); |
624 | } |
765 | } |
625 | |
766 | |
|
|
767 | =item $player_object->may ("access") |
|
|
768 | |
|
|
769 | Returns wether the given player is authorized to access resource "access" |
|
|
770 | (e.g. "command_wizcast"). |
|
|
771 | |
|
|
772 | =cut |
|
|
773 | |
|
|
774 | sub cf::object::player::may { |
|
|
775 | my ($self, $access) = @_; |
|
|
776 | |
|
|
777 | $self->flag (cf::FLAG_WIZ) || |
|
|
778 | (ref $cf::CFG{"may_$access"} |
|
|
779 | ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} |
|
|
780 | : $cf::CFG{"may_$access"}) |
|
|
781 | } |
|
|
782 | |
|
|
783 | =cut |
|
|
784 | |
626 | ############################################################################# |
785 | ############################################################################# |
627 | # map scripting support |
|
|
628 | |
786 | |
|
|
787 | =head2 SAFE SCRIPTING |
|
|
788 | |
|
|
789 | Functions that provide a safe environment to compile and execute |
|
|
790 | snippets of perl code without them endangering the safety of the server |
|
|
791 | itself. Looping constructs, I/O operators and other built-in functionality |
|
|
792 | is not available in the safe scripting environment, and the number of |
|
|
793 | functions and methods that can be called is greatly reduced. |
|
|
794 | |
|
|
795 | =cut |
|
|
796 | |
629 | our $safe = new Safe "ext"; |
797 | our $safe = new Safe "safe"; |
630 | our $safe_hole = new Safe::Hole; |
798 | our $safe_hole = new Safe::Hole; |
631 | |
799 | |
632 | $SIG{FPE} = 'IGNORE'; |
800 | $SIG{FPE} = 'IGNORE'; |
633 | |
801 | |
634 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
802 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
635 | |
803 | |
636 | # here we export the classes and methods available to script code |
804 | # here we export the classes and methods available to script code |
637 | |
805 | |
|
|
806 | =pod |
|
|
807 | |
|
|
808 | The following fucntions and emthods are available within a safe environment: |
|
|
809 | |
|
|
810 | cf::object contr pay_amount pay_player map |
|
|
811 | cf::object::player player |
|
|
812 | cf::player peaceful |
|
|
813 | cf::map trigger |
|
|
814 | |
|
|
815 | =cut |
|
|
816 | |
638 | for ( |
817 | for ( |
639 | ["cf::object" => qw(contr pay_amount pay_player)], |
818 | ["cf::object" => qw(contr pay_amount pay_player map)], |
640 | ["cf::object::player" => qw(player)], |
819 | ["cf::object::player" => qw(player)], |
641 | ["cf::player" => qw(peaceful)], |
820 | ["cf::player" => qw(peaceful)], |
|
|
821 | ["cf::map" => qw(trigger)], |
642 | ) { |
822 | ) { |
643 | no strict 'refs'; |
823 | no strict 'refs'; |
644 | my ($pkg, @funs) = @$_; |
824 | my ($pkg, @funs) = @$_; |
645 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
825 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
646 | for @funs; |
826 | for @funs; |
647 | } |
827 | } |
648 | |
828 | |
|
|
829 | =over 4 |
|
|
830 | |
|
|
831 | =item @retval = safe_eval $code, [var => value, ...] |
|
|
832 | |
|
|
833 | Compiled and executes the given perl code snippet. additional var/value |
|
|
834 | pairs result in temporary local (my) scalar variables of the given name |
|
|
835 | that are available in the code snippet. Example: |
|
|
836 | |
|
|
837 | my $five = safe_eval '$first + $second', first => 1, second => 4; |
|
|
838 | |
|
|
839 | =cut |
|
|
840 | |
649 | sub safe_eval($;@) { |
841 | sub safe_eval($;@) { |
650 | my ($code, %vars) = @_; |
842 | my ($code, %vars) = @_; |
651 | |
843 | |
652 | my $qcode = $code; |
844 | my $qcode = $code; |
653 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
845 | $qcode =~ s/"/‟/g; # not allowed in #line filenames |
654 | $qcode =~ s/\n/\\n/g; |
846 | $qcode =~ s/\n/\\n/g; |
655 | |
847 | |
656 | local $_; |
848 | local $_; |
657 | local @safe::cf::_safe_eval_args = values %vars; |
849 | local @safe::cf::_safe_eval_args = values %vars; |
658 | |
850 | |
659 | $code = |
851 | my $eval = |
660 | "do {\n" |
852 | "do {\n" |
661 | . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" |
853 | . "my (" . (join ",", map "\$$_", keys %vars) . ") = \@cf::_safe_eval_args;\n" |
662 | . "#line 0 \"{$qcode}\"\n" |
854 | . "#line 0 \"{$qcode}\"\n" |
663 | . $code |
855 | . $code |
664 | . "\n}" |
856 | . "\n}" |
665 | ; |
857 | ; |
666 | |
858 | |
667 | sub_generation_inc; |
859 | sub_generation_inc; |
668 | my @res = wantarray ? $safe->reval ($code) : scalar $safe->reval ($code); |
860 | my @res = wantarray ? $safe->reval ($eval) : scalar $safe->reval ($eval); |
669 | sub_generation_inc; |
861 | sub_generation_inc; |
670 | |
862 | |
|
|
863 | if ($@) { |
|
|
864 | warn "$@"; |
|
|
865 | warn "while executing safe code '$code'\n"; |
|
|
866 | warn "with arguments " . (join " ", %vars) . "\n"; |
|
|
867 | } |
|
|
868 | |
671 | wantarray ? @res : $res[0] |
869 | wantarray ? @res : $res[0] |
672 | } |
870 | } |
|
|
871 | |
|
|
872 | =item cf::register_script_function $function => $cb |
|
|
873 | |
|
|
874 | Register a function that can be called from within map/npc scripts. The |
|
|
875 | function should be reasonably secure and should be put into a package name |
|
|
876 | like the extension. |
|
|
877 | |
|
|
878 | Example: register a function that gets called whenever a map script calls |
|
|
879 | C<rent::overview>, as used by the C<rent> extension. |
|
|
880 | |
|
|
881 | cf::register_script_function "rent::overview" => sub { |
|
|
882 | ... |
|
|
883 | }; |
|
|
884 | |
|
|
885 | =cut |
673 | |
886 | |
674 | sub register_script_function { |
887 | sub register_script_function { |
675 | my ($fun, $cb) = @_; |
888 | my ($fun, $cb) = @_; |
676 | |
889 | |
677 | no strict 'refs'; |
890 | no strict 'refs'; |
678 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
891 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
679 | } |
892 | } |
680 | |
893 | |
|
|
894 | =back |
|
|
895 | |
|
|
896 | =cut |
|
|
897 | |
|
|
898 | ############################################################################# |
|
|
899 | |
|
|
900 | =head2 EXTENSION DATABASE SUPPORT |
|
|
901 | |
|
|
902 | Crossfire maintains a very simple database for extension use. It can |
|
|
903 | currently store anything that can be serialised using Storable, which |
|
|
904 | excludes objects. |
|
|
905 | |
|
|
906 | The parameter C<$family> should best start with the name of the extension |
|
|
907 | using it, it should be unique. |
|
|
908 | |
|
|
909 | =over 4 |
|
|
910 | |
|
|
911 | =item $hashref = cf::db_get $family |
|
|
912 | |
|
|
913 | Return a hashref for use by the extension C<$family>, which can be |
|
|
914 | modified. After modifications, you have to call C<cf::db_dirty> or |
|
|
915 | C<cf::db_sync>. |
|
|
916 | |
|
|
917 | =item $value = cf::db_get $family => $key |
|
|
918 | |
|
|
919 | Returns a single value from the database |
|
|
920 | |
|
|
921 | =item cf::db_put $family => $hashref |
|
|
922 | |
|
|
923 | Stores the given family hashref into the database. Updates are delayed, if |
|
|
924 | you want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
925 | |
|
|
926 | =item cf::db_put $family => $key => $value |
|
|
927 | |
|
|
928 | Stores the given C<$value> in the family hash. Updates are delayed, if you |
|
|
929 | want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
930 | |
|
|
931 | =item cf::db_dirty |
|
|
932 | |
|
|
933 | Marks the database as dirty, to be updated at a later time. |
|
|
934 | |
|
|
935 | =item cf::db_sync |
|
|
936 | |
|
|
937 | Immediately write the database to disk I<if it is dirty>. |
|
|
938 | |
|
|
939 | =cut |
|
|
940 | |
|
|
941 | our $DB; |
|
|
942 | |
|
|
943 | { |
|
|
944 | my $path = cf::localdir . "/database.pst"; |
|
|
945 | |
|
|
946 | sub db_load() { |
|
|
947 | warn "loading database $path\n";#d# remove later |
|
|
948 | $DB = stat $path ? Storable::retrieve $path : { }; |
|
|
949 | } |
|
|
950 | |
|
|
951 | my $pid; |
|
|
952 | |
|
|
953 | sub db_save() { |
|
|
954 | warn "saving database $path\n";#d# remove later |
|
|
955 | waitpid $pid, 0 if $pid; |
|
|
956 | if (0 == ($pid = fork)) { |
|
|
957 | $DB->{_meta}{version} = 1; |
|
|
958 | Storable::nstore $DB, "$path~"; |
|
|
959 | rename "$path~", $path; |
|
|
960 | cf::_exit 0 if defined $pid; |
|
|
961 | } |
|
|
962 | } |
|
|
963 | |
|
|
964 | my $dirty; |
|
|
965 | |
|
|
966 | sub db_sync() { |
|
|
967 | db_save if $dirty; |
|
|
968 | undef $dirty; |
|
|
969 | } |
|
|
970 | |
|
|
971 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { |
|
|
972 | db_sync; |
|
|
973 | }); |
|
|
974 | |
|
|
975 | sub db_dirty() { |
|
|
976 | $dirty = 1; |
|
|
977 | $idle->start; |
|
|
978 | } |
|
|
979 | |
|
|
980 | sub db_get($;$) { |
|
|
981 | @_ >= 2 |
|
|
982 | ? $DB->{$_[0]}{$_[1]} |
|
|
983 | : ($DB->{$_[0]} ||= { }) |
|
|
984 | } |
|
|
985 | |
|
|
986 | sub db_put($$;$) { |
|
|
987 | if (@_ >= 3) { |
|
|
988 | $DB->{$_[0]}{$_[1]} = $_[2]; |
|
|
989 | } else { |
|
|
990 | $DB->{$_[0]} = $_[1]; |
|
|
991 | } |
|
|
992 | db_dirty; |
|
|
993 | } |
|
|
994 | |
|
|
995 | cf::global->attach ( |
|
|
996 | prio => 10000, |
|
|
997 | on_cleanup => sub { |
|
|
998 | db_sync; |
|
|
999 | }, |
|
|
1000 | ); |
|
|
1001 | } |
|
|
1002 | |
681 | ############################################################################# |
1003 | ############################################################################# |
682 | # the server's main() |
1004 | # the server's main() |
683 | |
1005 | |
|
|
1006 | sub cfg_load { |
|
|
1007 | open my $fh, "<:utf8", cf::confdir . "/config" |
|
|
1008 | or return; |
|
|
1009 | |
|
|
1010 | local $/; |
|
|
1011 | *CFG = YAML::Syck::Load <$fh>; |
|
|
1012 | } |
|
|
1013 | |
684 | sub main { |
1014 | sub main { |
|
|
1015 | cfg_load; |
|
|
1016 | db_load; |
|
|
1017 | load_extensions; |
685 | Event::loop; |
1018 | Event::loop; |
686 | } |
1019 | } |
687 | |
1020 | |
688 | ############################################################################# |
1021 | ############################################################################# |
689 | # initialisation |
1022 | # initialisation |
690 | |
1023 | |
|
|
1024 | sub _perl_reload(&) { |
|
|
1025 | my ($msg) = @_; |
|
|
1026 | |
|
|
1027 | $msg->("reloading..."); |
|
|
1028 | |
|
|
1029 | eval { |
|
|
1030 | # cancel all watchers |
|
|
1031 | for (Event::all_watchers) { |
|
|
1032 | $_->cancel if $_->data & WF_AUTOCANCEL; |
|
|
1033 | } |
|
|
1034 | |
|
|
1035 | # unload all extensions |
|
|
1036 | for (@exts) { |
|
|
1037 | $msg->("unloading <$_>"); |
|
|
1038 | unload_extension $_; |
|
|
1039 | } |
|
|
1040 | |
|
|
1041 | # unload all modules loaded from $LIBDIR |
|
|
1042 | while (my ($k, $v) = each %INC) { |
|
|
1043 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
1044 | |
|
|
1045 | $msg->("removing <$k>"); |
|
|
1046 | delete $INC{$k}; |
|
|
1047 | |
|
|
1048 | $k =~ s/\.pm$//; |
|
|
1049 | $k =~ s/\//::/g; |
|
|
1050 | |
|
|
1051 | if (my $cb = $k->can ("unload_module")) { |
|
|
1052 | $cb->(); |
|
|
1053 | } |
|
|
1054 | |
|
|
1055 | Symbol::delete_package $k; |
|
|
1056 | } |
|
|
1057 | |
|
|
1058 | # sync database to disk |
|
|
1059 | cf::db_sync; |
|
|
1060 | |
|
|
1061 | # get rid of safe::, as good as possible |
|
|
1062 | Symbol::delete_package "safe::$_" |
|
|
1063 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
|
|
1064 | |
|
|
1065 | # remove register_script_function callbacks |
|
|
1066 | # TODO |
|
|
1067 | |
|
|
1068 | # unload cf.pm "a bit" |
|
|
1069 | delete $INC{"cf.pm"}; |
|
|
1070 | |
|
|
1071 | # don't, removes xs symbols, too, |
|
|
1072 | # and global variables created in xs |
|
|
1073 | #Symbol::delete_package __PACKAGE__; |
|
|
1074 | |
|
|
1075 | # reload cf.pm |
|
|
1076 | $msg->("reloading cf.pm"); |
|
|
1077 | require cf; |
|
|
1078 | |
|
|
1079 | # load config and database again |
|
|
1080 | cf::cfg_load; |
|
|
1081 | cf::db_load; |
|
|
1082 | |
|
|
1083 | # load extensions |
|
|
1084 | $msg->("load extensions"); |
|
|
1085 | cf::load_extensions; |
|
|
1086 | |
|
|
1087 | # reattach attachments to objects |
|
|
1088 | $msg->("reattach"); |
|
|
1089 | _global_reattach; |
|
|
1090 | }; |
|
|
1091 | $msg->($@) if $@; |
|
|
1092 | |
|
|
1093 | $msg->("reloaded"); |
|
|
1094 | }; |
|
|
1095 | |
|
|
1096 | sub perl_reload() { |
|
|
1097 | _perl_reload { |
|
|
1098 | warn $_[0]; |
|
|
1099 | print "$_[0]\n"; |
|
|
1100 | }; |
|
|
1101 | } |
|
|
1102 | |
691 | register "<global>", __PACKAGE__; |
1103 | register "<global>", __PACKAGE__; |
692 | |
1104 | |
|
|
1105 | register_command "perl-reload" => sub { |
|
|
1106 | my ($who, $arg) = @_; |
|
|
1107 | |
|
|
1108 | if ($who->flag (FLAG_WIZ)) { |
|
|
1109 | _perl_reload { |
|
|
1110 | warn $_[0]; |
|
|
1111 | $who->message ($_[0]); |
|
|
1112 | }; |
|
|
1113 | } |
|
|
1114 | }; |
|
|
1115 | |
693 | unshift @INC, $LIBDIR; |
1116 | unshift @INC, $LIBDIR; |
694 | |
1117 | |
695 | load_extensions; |
|
|
696 | |
|
|
697 | $TICK_WATCHER = Event->timer ( |
1118 | $TICK_WATCHER = Event->timer ( |
698 | prio => 1, |
1119 | prio => 0, |
699 | at => $NEXT_TICK || 1, |
1120 | at => $NEXT_TICK || 1, |
|
|
1121 | data => WF_AUTOCANCEL, |
700 | cb => sub { |
1122 | cb => sub { |
701 | cf::server_tick; # one server iteration |
1123 | cf::server_tick; # one server iteration |
702 | |
1124 | |
703 | my $NOW = Event::time; |
1125 | my $NOW = Event::time; |
704 | $NEXT_TICK += $TICK; |
1126 | $NEXT_TICK += $TICK; |
705 | |
1127 | |
706 | # if we are delayed by four ticks, skip them all |
1128 | # if we are delayed by four ticks or more, skip them all |
707 | $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; |
1129 | $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; |
708 | |
1130 | |
709 | $TICK_WATCHER->at ($NEXT_TICK); |
1131 | $TICK_WATCHER->at ($NEXT_TICK); |
710 | $TICK_WATCHER->start; |
1132 | $TICK_WATCHER->start; |
711 | }, |
1133 | }, |
712 | ); |
1134 | ); |
713 | |
1135 | |
|
|
1136 | IO::AIO::max_poll_time $TICK * 0.2; |
|
|
1137 | |
|
|
1138 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
1139 | poll => 'r', |
|
|
1140 | prio => 5, |
|
|
1141 | data => WF_AUTOCANCEL, |
|
|
1142 | cb => \&IO::AIO::poll_cb); |
|
|
1143 | |
714 | 1 |
1144 | 1 |
715 | |
1145 | |