… | |
… | |
16 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
16 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
17 | $YAML::Syck::ImplicitUnicode = 1; |
17 | $YAML::Syck::ImplicitUnicode = 1; |
18 | |
18 | |
19 | use strict; |
19 | use strict; |
20 | |
20 | |
|
|
21 | sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload |
|
|
22 | |
|
|
23 | our %COMMAND = (); |
|
|
24 | our %COMMAND_TIME = (); |
|
|
25 | our %EXTCMD = (); |
|
|
26 | |
21 | _init_vars; |
27 | _init_vars; |
22 | |
28 | |
23 | our %COMMAND = (); |
|
|
24 | our @EVENT; |
29 | our @EVENT; |
25 | our $LIBDIR = maps_directory "perl"; |
30 | our $LIBDIR = datadir . "/ext"; |
26 | |
31 | |
27 | our $TICK = MAX_TIME * 1e-6; |
32 | our $TICK = MAX_TIME * 1e-6; |
28 | our $TICK_WATCHER; |
33 | our $TICK_WATCHER; |
29 | our $NEXT_TICK; |
34 | our $NEXT_TICK; |
30 | |
35 | |
31 | our %CFG; |
36 | our %CFG; |
32 | |
37 | |
33 | our $uptime; |
38 | our $UPTIME; $UPTIME ||= time; |
34 | |
|
|
35 | $uptime ||= time; |
|
|
36 | |
39 | |
37 | ############################################################################# |
40 | ############################################################################# |
38 | |
41 | |
39 | =head2 GLOBAL VARIABLES |
42 | =head2 GLOBAL VARIABLES |
40 | |
43 | |
41 | =over 4 |
44 | =over 4 |
|
|
45 | |
|
|
46 | =item $cf::UPTIME |
|
|
47 | |
|
|
48 | The timestamp of the server start (so not actually an uptime). |
42 | |
49 | |
43 | =item $cf::LIBDIR |
50 | =item $cf::LIBDIR |
44 | |
51 | |
45 | The perl library directory, where extensions and cf-specific modules can |
52 | The perl library directory, where extensions and cf-specific modules can |
46 | be found. It will be added to C<@INC> automatically. |
53 | be found. It will be added to C<@INC> automatically. |
… | |
… | |
67 | print STDERR "cfperl: $msg"; |
74 | print STDERR "cfperl: $msg"; |
68 | LOG llevError, "cfperl: $msg"; |
75 | LOG llevError, "cfperl: $msg"; |
69 | }; |
76 | }; |
70 | } |
77 | } |
71 | |
78 | |
|
|
79 | @safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; |
|
|
80 | @safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; |
|
|
81 | @safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; |
|
|
82 | @safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; |
|
|
83 | @safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; |
72 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
84 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
73 | |
85 | |
74 | # 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 |
75 | # within the Safe compartment. |
87 | # within the Safe compartment. |
76 | for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { |
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 | )) { |
77 | no strict 'refs'; |
95 | no strict 'refs'; |
78 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
96 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
79 | } |
97 | } |
80 | |
98 | |
81 | $Event::DIED = sub { |
99 | $Event::DIED = sub { |
… | |
… | |
83 | }; |
101 | }; |
84 | |
102 | |
85 | my %ext_pkg; |
103 | my %ext_pkg; |
86 | my @exts; |
104 | my @exts; |
87 | my @hook; |
105 | my @hook; |
88 | my %command; |
|
|
89 | my %extcmd; |
|
|
90 | |
106 | |
91 | =head2 UTILITY FUNCTIONS |
107 | =head2 UTILITY FUNCTIONS |
92 | |
108 | |
93 | =over 4 |
109 | =over 4 |
94 | |
110 | |
… | |
… | |
122 | |
138 | |
123 | =cut |
139 | =cut |
124 | |
140 | |
125 | ############################################################################# |
141 | ############################################################################# |
126 | |
142 | |
127 | =head2 EVENTS AND OBJECT ATTACHMENTS |
143 | =head2 ATTACHABLE OBJECTS |
|
|
144 | |
|
|
145 | Many objects in crossfire are so-called attachable objects. That means you can |
|
|
146 | attach callbacks/event handlers (a collection of which is called an "attachment") |
|
|
147 | to it. All such attachable objects support the following methods. |
|
|
148 | |
|
|
149 | In the following description, CLASS can be any of C<global>, C<object> |
|
|
150 | C<player>, C<client> or C<map> (i.e. the attachable objects in |
|
|
151 | crossfire+). |
128 | |
152 | |
129 | =over 4 |
153 | =over 4 |
130 | |
154 | |
131 | =item $object->attach ($attachment, key => $value...) |
|
|
132 | |
|
|
133 | =item $object->detach ($attachment) |
|
|
134 | |
|
|
135 | Attach/detach a pre-registered attachment to an object. |
|
|
136 | |
|
|
137 | =item $player->attach ($attachment, key => $value...) |
|
|
138 | |
|
|
139 | =item $player->detach ($attachment) |
|
|
140 | |
|
|
141 | Attach/detach a pre-registered attachment to a player. |
|
|
142 | |
|
|
143 | =item $map->attach ($attachment, key => $value...) |
155 | =item $attachable->attach ($attachment, key => $value...) |
144 | |
156 | |
145 | =item $map->detach ($attachment) |
157 | =item $attachable->detach ($attachment) |
146 | |
158 | |
147 | Attach/detach a pre-registered attachment to a map. |
159 | Attach/detach a pre-registered attachment to a specific object and give it |
|
|
160 | the specified key/value pairs as arguments. |
148 | |
161 | |
149 | =item $bool = $object->attached ($name) |
162 | Example, attach a minesweeper attachment to the given object, making it a |
|
|
163 | 10x10 minesweeper game: |
150 | |
164 | |
151 | =item $bool = $player->attached ($name) |
165 | $obj->attach (minesweeper => width => 10, height => 10); |
152 | |
166 | |
153 | =item $bool = $map->attached ($name) |
167 | =item $bool = $attachable->attached ($name) |
154 | |
168 | |
155 | Checks wether the named attachment is currently attached to the object. |
169 | Checks wether the named attachment is currently attached to the object. |
156 | |
170 | |
157 | =item cf::attach_global ... |
171 | =item cf::CLASS->attach ... |
158 | |
172 | |
159 | Attach handlers for global events. |
173 | =item cf::CLASS->detach ... |
160 | |
174 | |
161 | This and all following C<attach_*>-functions expect any number of the |
175 | Define an anonymous attachment and attach it to all objects of the given |
162 | following handler/hook descriptions: |
176 | CLASS. See the next function for an explanation of its arguments. |
|
|
177 | |
|
|
178 | You can attach to global events by using the C<cf::global> class. |
|
|
179 | |
|
|
180 | Example, log all player logins: |
|
|
181 | |
|
|
182 | cf::player->attach ( |
|
|
183 | on_login => sub { |
|
|
184 | my ($pl) = @_; |
|
|
185 | ... |
|
|
186 | }, |
|
|
187 | ); |
|
|
188 | |
|
|
189 | Example, attach to the jeweler skill: |
|
|
190 | |
|
|
191 | cf::object->attach ( |
|
|
192 | type => cf::SKILL, |
|
|
193 | subtype => cf::SK_JEWELER, |
|
|
194 | on_use_skill => sub { |
|
|
195 | my ($sk, $ob, $part, $dir, $msg) = @_; |
|
|
196 | ... |
|
|
197 | }, |
|
|
198 | ); |
|
|
199 | |
|
|
200 | =item cf::CLASS::attachment $name, ... |
|
|
201 | |
|
|
202 | Register an attachment by C<$name> through which attachable objects of the |
|
|
203 | given CLASS can refer to this attachment. |
|
|
204 | |
|
|
205 | Some classes such as crossfire maps and objects can specify attachments |
|
|
206 | that are attached at load/instantiate time, thus the need for a name. |
|
|
207 | |
|
|
208 | These calls expect any number of the following handler/hook descriptions: |
163 | |
209 | |
164 | =over 4 |
210 | =over 4 |
165 | |
211 | |
166 | =item prio => $number |
212 | =item prio => $number |
167 | |
213 | |
… | |
… | |
169 | by another C<prio> setting). Lower priority handlers get executed |
215 | by another C<prio> setting). Lower priority handlers get executed |
170 | earlier. The default priority is C<0>, and many built-in handlers are |
216 | earlier. The default priority is C<0>, and many built-in handlers are |
171 | registered at priority C<-1000>, so lower priorities should not be used |
217 | registered at priority C<-1000>, so lower priorities should not be used |
172 | unless you know what you are doing. |
218 | unless you know what you are doing. |
173 | |
219 | |
|
|
220 | =item type => $type |
|
|
221 | |
|
|
222 | (Only for C<< cf::object->attach >> calls), limits the attachment to the |
|
|
223 | given type of objects only (the additional parameter C<subtype> can be |
|
|
224 | used to further limit to the given subtype). |
|
|
225 | |
174 | =item on_I<event> => \&cb |
226 | =item on_I<event> => \&cb |
175 | |
227 | |
176 | Call the given code reference whenever the named event happens (event is |
228 | Call the given code reference whenever the named event happens (event is |
177 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
229 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
178 | handlers are recognised generally depends on the type of object these |
230 | handlers are recognised generally depends on the type of object these |
… | |
… | |
187 | package and register them. Only handlers for eevents supported by the |
239 | package and register them. Only handlers for eevents supported by the |
188 | object/class are recognised. |
240 | object/class are recognised. |
189 | |
241 | |
190 | =back |
242 | =back |
191 | |
243 | |
192 | =item cf::attach_to_type $object_type, $subtype, ... |
244 | Example, define an attachment called "sockpuppet" that calls the given |
|
|
245 | event handler when a monster attacks: |
193 | |
246 | |
194 | Attach handlers for a specific object type (e.g. TRANSPORT) and |
247 | cf::object::attachment sockpuppet => |
195 | subtype. If C<$subtype> is zero or undef, matches all objects of the given |
248 | on_skill_attack => sub { |
196 | type. |
249 | my ($self, $victim) = @_; |
197 | |
250 | ... |
198 | =item cf::attach_to_objects ... |
251 | } |
199 | |
252 | } |
200 | Attach handlers to all objects. Do not use this except for debugging or |
|
|
201 | very rare events, as handlers are (obviously) called for I<all> objects in |
|
|
202 | the game. |
|
|
203 | |
|
|
204 | =item cf::attach_to_players ... |
|
|
205 | |
|
|
206 | Attach handlers to all players. |
|
|
207 | |
|
|
208 | =item cf::attach_to_maps ... |
|
|
209 | |
|
|
210 | Attach handlers to all maps. |
|
|
211 | |
|
|
212 | =item cf:register_attachment $name, ... |
|
|
213 | |
|
|
214 | Register an attachment by name through which objects can refer to this |
|
|
215 | attachment. |
|
|
216 | |
|
|
217 | =item cf:register_player_attachment $name, ... |
|
|
218 | |
|
|
219 | Register an attachment by name through which players can refer to this |
|
|
220 | attachment. |
|
|
221 | |
|
|
222 | =item cf:register_map_attachment $name, ... |
|
|
223 | |
|
|
224 | Register an attachment by name through which maps can refer to this |
|
|
225 | attachment. |
|
|
226 | |
253 | |
227 | =cut |
254 | =cut |
228 | |
255 | |
229 | # the following variables are defined in .xs and must not be re-created |
256 | # the following variables are defined in .xs and must not be re-created |
230 | our @CB_GLOBAL = (); # registry for all global events |
257 | our @CB_GLOBAL = (); # registry for all global events |
231 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
258 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
232 | our @CB_PLAYER = (); |
259 | our @CB_PLAYER = (); |
|
|
260 | our @CB_CLIENT = (); |
233 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
261 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
234 | our @CB_MAP = (); |
262 | our @CB_MAP = (); |
235 | |
263 | |
236 | my %attachment; |
264 | my %attachment; |
237 | |
265 | |
238 | sub _attach_cb($\%$$$) { |
266 | sub _attach_cb($$$$) { |
239 | my ($registry, $undo, $event, $prio, $cb) = @_; |
267 | my ($registry, $event, $prio, $cb) = @_; |
240 | |
268 | |
241 | use sort 'stable'; |
269 | use sort 'stable'; |
242 | |
270 | |
243 | $cb = [$prio, $cb]; |
271 | $cb = [$prio, $cb]; |
244 | |
272 | |
245 | @{$registry->[$event]} = sort |
273 | @{$registry->[$event]} = sort |
246 | { $a->[0] cmp $b->[0] } |
274 | { $a->[0] cmp $b->[0] } |
247 | @{$registry->[$event] || []}, $cb; |
275 | @{$registry->[$event] || []}, $cb; |
248 | |
|
|
249 | push @{$undo->{cb}}, [$event, $cb]; |
|
|
250 | } |
276 | } |
251 | |
277 | |
252 | # attach handles attaching event callbacks |
278 | # attach handles attaching event callbacks |
253 | # the only thing the caller has to do is pass the correct |
279 | # the only thing the caller has to do is pass the correct |
254 | # registry (== where the callback attaches to). |
280 | # registry (== where the callback attaches to). |
255 | sub _attach(\@$@) { |
281 | sub _attach { |
256 | my ($registry, $klass, @arg) = @_; |
282 | my ($registry, $klass, @arg) = @_; |
257 | |
283 | |
|
|
284 | my $object_type; |
258 | my $prio = 0; |
285 | my $prio = 0; |
259 | |
|
|
260 | my %undo = ( |
|
|
261 | registry => $registry, |
|
|
262 | cb => [], |
|
|
263 | ); |
|
|
264 | |
|
|
265 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
286 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
266 | |
287 | |
267 | while (@arg) { |
288 | while (@arg) { |
268 | my $type = shift @arg; |
289 | my $type = shift @arg; |
269 | |
290 | |
270 | if ($type eq "prio") { |
291 | if ($type eq "prio") { |
271 | $prio = shift @arg; |
292 | $prio = shift @arg; |
272 | |
293 | |
|
|
294 | } elsif ($type eq "type") { |
|
|
295 | $object_type = shift @arg; |
|
|
296 | $registry = $CB_TYPE[$object_type] ||= []; |
|
|
297 | |
|
|
298 | } elsif ($type eq "subtype") { |
|
|
299 | defined $object_type or Carp::croak "subtype specified without type"; |
|
|
300 | my $object_subtype = shift @arg; |
|
|
301 | $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; |
|
|
302 | |
273 | } elsif ($type eq "package") { |
303 | } elsif ($type eq "package") { |
274 | my $pkg = shift @arg; |
304 | my $pkg = shift @arg; |
275 | |
305 | |
276 | while (my ($name, $id) = each %cb_id) { |
306 | while (my ($name, $id) = each %cb_id) { |
277 | if (my $cb = $pkg->can ($name)) { |
307 | if (my $cb = $pkg->can ($name)) { |
278 | _attach_cb $registry, %undo, $id, $prio, $cb; |
308 | _attach_cb $registry, $id, $prio, $cb; |
279 | } |
309 | } |
280 | } |
310 | } |
281 | |
311 | |
282 | } elsif (exists $cb_id{$type}) { |
312 | } elsif (exists $cb_id{$type}) { |
283 | _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; |
313 | _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; |
284 | |
314 | |
285 | } elsif (ref $type) { |
315 | } elsif (ref $type) { |
286 | warn "attaching objects not supported, ignoring.\n"; |
316 | warn "attaching objects not supported, ignoring.\n"; |
287 | |
317 | |
288 | } else { |
318 | } else { |
289 | shift @arg; |
319 | shift @arg; |
290 | warn "attach argument '$type' not supported, ignoring.\n"; |
320 | warn "attach argument '$type' not supported, ignoring.\n"; |
291 | } |
321 | } |
292 | } |
322 | } |
293 | |
|
|
294 | \%undo |
|
|
295 | } |
323 | } |
296 | |
324 | |
297 | sub _attach_attachment { |
325 | sub _object_attach { |
298 | my ($obj, $name, %arg) = @_; |
326 | my ($obj, $name, %arg) = @_; |
299 | |
327 | |
300 | return if exists $obj->{_attachment}{$name}; |
328 | return if exists $obj->{_attachment}{$name}; |
301 | |
|
|
302 | my $res; |
|
|
303 | |
329 | |
304 | if (my $attach = $attachment{$name}) { |
330 | if (my $attach = $attachment{$name}) { |
305 | my $registry = $obj->registry; |
331 | my $registry = $obj->registry; |
306 | |
332 | |
307 | for (@$attach) { |
333 | for (@$attach) { |
308 | my ($klass, @attach) = @$_; |
334 | my ($klass, @attach) = @$_; |
309 | $res = _attach @$registry, $klass, @attach; |
335 | _attach $registry, $klass, @attach; |
310 | } |
336 | } |
311 | |
337 | |
312 | $obj->{$name} = \%arg; |
338 | $obj->{$name} = \%arg; |
313 | } else { |
339 | } else { |
314 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
340 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
315 | } |
341 | } |
316 | |
342 | |
317 | $obj->{_attachment}{$name} = undef; |
343 | $obj->{_attachment}{$name} = undef; |
318 | |
|
|
319 | $res->{attachment} = $name; |
|
|
320 | $res |
|
|
321 | } |
344 | } |
322 | |
345 | |
323 | *cf::object::attach = |
346 | sub cf::attachable::attach { |
324 | *cf::player::attach = |
347 | if (ref $_[0]) { |
325 | *cf::map::attach = sub { |
348 | _object_attach @_; |
326 | my ($obj, $name, %arg) = @_; |
349 | } else { |
327 | |
350 | _attach shift->_attach_registry, @_; |
328 | _attach_attachment $obj, $name, %arg; |
351 | } |
329 | }; |
352 | }; |
330 | |
353 | |
331 | # all those should be optimised |
354 | # all those should be optimised |
332 | *cf::object::detach = |
355 | sub cf::attachable::detach { |
333 | *cf::player::detach = |
|
|
334 | *cf::map::detach = sub { |
|
|
335 | my ($obj, $name) = @_; |
356 | my ($obj, $name) = @_; |
336 | |
357 | |
|
|
358 | if (ref $obj) { |
337 | delete $obj->{_attachment}{$name}; |
359 | delete $obj->{_attachment}{$name}; |
338 | reattach ($obj); |
360 | reattach ($obj); |
|
|
361 | } else { |
|
|
362 | Carp::croak "cannot, currently, detach class attachments"; |
|
|
363 | } |
339 | }; |
364 | }; |
340 | |
365 | |
341 | *cf::object::attached = |
366 | sub cf::attachable::attached { |
342 | *cf::player::attached = |
|
|
343 | *cf::map::attached = sub { |
|
|
344 | my ($obj, $name) = @_; |
367 | my ($obj, $name) = @_; |
345 | |
368 | |
346 | exists $obj->{_attachment}{$name} |
369 | exists $obj->{_attachment}{$name} |
347 | }; |
|
|
348 | |
|
|
349 | sub attach_global { |
|
|
350 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
|
|
351 | } |
370 | } |
352 | |
371 | |
353 | sub attach_to_type { |
372 | for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { |
354 | my $type = shift; |
373 | eval "#line " . __LINE__ . " 'cf.pm' |
355 | my $subtype = shift; |
374 | sub cf::\L$klass\E::_attach_registry { |
|
|
375 | (\\\@CB_$klass, KLASS_$klass) |
|
|
376 | } |
356 | |
377 | |
357 | _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ |
378 | sub cf::\L$klass\E::attachment { |
358 | } |
|
|
359 | |
|
|
360 | sub attach_to_objects { |
|
|
361 | _attach @CB_OBJECT, KLASS_OBJECT, @_ |
|
|
362 | } |
|
|
363 | |
|
|
364 | sub attach_to_players { |
|
|
365 | _attach @CB_PLAYER, KLASS_PLAYER, @_ |
|
|
366 | } |
|
|
367 | |
|
|
368 | sub attach_to_maps { |
|
|
369 | _attach @CB_MAP, KLASS_MAP, @_ |
|
|
370 | } |
|
|
371 | |
|
|
372 | sub register_attachment { |
|
|
373 | my $name = shift; |
379 | my \$name = shift; |
374 | |
380 | |
375 | $attachment{$name} = [[KLASS_OBJECT, @_]]; |
|
|
376 | } |
|
|
377 | |
|
|
378 | sub register_player_attachment { |
|
|
379 | my $name = shift; |
|
|
380 | |
|
|
381 | $attachment{$name} = [[KLASS_PLAYER, @_]]; |
|
|
382 | } |
|
|
383 | |
|
|
384 | sub register_map_attachment { |
|
|
385 | my $name = shift; |
|
|
386 | |
|
|
387 | $attachment{$name} = [[KLASS_MAP, @_]]; |
381 | \$attachment{\$name} = [[KLASS_$klass, \@_]]; |
|
|
382 | } |
|
|
383 | "; |
|
|
384 | die if $@; |
388 | } |
385 | } |
389 | |
386 | |
390 | our $override; |
387 | our $override; |
391 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
388 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
392 | |
389 | |
… | |
… | |
422 | |
419 | |
423 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
420 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
424 | |
421 | |
425 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
422 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
426 | |
423 | |
|
|
424 | =item $bool = $client->invoke (EVENT_CLIENT_XXX, ...) |
|
|
425 | |
427 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
426 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
428 | |
427 | |
429 | Generate a global/object/player/map-specific event with the given arguments. |
428 | Generate a global/object/player/map-specific event with the given arguments. |
430 | |
429 | |
431 | This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be |
430 | This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be |
… | |
… | |
436 | |
435 | |
437 | =cut |
436 | =cut |
438 | |
437 | |
439 | ############################################################################# |
438 | ############################################################################# |
440 | |
439 | |
441 | =head2 METHODS VALID FOR ALL CORE OBJECTS |
440 | =head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS |
|
|
441 | |
|
|
442 | Attachable objects includes objects, players, clients and maps. |
442 | |
443 | |
443 | =over 4 |
444 | =over 4 |
444 | |
445 | |
445 | =item $object->valid, $player->valid, $map->valid |
446 | =item $object->valid |
446 | |
447 | |
447 | Just because you have a perl object does not mean that the corresponding |
448 | Just because you have a perl object does not mean that the corresponding |
448 | C-level object still exists. If you try to access an object that has no |
449 | C-level object still exists. If you try to access an object that has no |
449 | valid C counterpart anymore you get an exception at runtime. This method |
450 | valid C counterpart anymore you get an exception at runtime. This method |
450 | can be used to test for existence of the C object part without causing an |
451 | can be used to test for existence of the C object part without causing an |
… | |
… | |
452 | |
453 | |
453 | =back |
454 | =back |
454 | |
455 | |
455 | =cut |
456 | =cut |
456 | |
457 | |
457 | *cf::object::valid = |
|
|
458 | *cf::player::valid = |
|
|
459 | *cf::map::valid = \&cf::_valid; |
|
|
460 | |
|
|
461 | ############################################################################# |
458 | ############################################################################# |
462 | # object support |
459 | # object support |
463 | |
460 | |
464 | sub instantiate { |
461 | sub instantiate { |
465 | my ($obj, $data) = @_; |
462 | my ($obj, $data) = @_; |
… | |
… | |
484 | |
481 | |
485 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
482 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
486 | if (my $attach = $attachment{$name}) { |
483 | if (my $attach = $attachment{$name}) { |
487 | for (@$attach) { |
484 | for (@$attach) { |
488 | my ($klass, @attach) = @$_; |
485 | my ($klass, @attach) = @$_; |
489 | _attach @$registry, $klass, @attach; |
486 | _attach $registry, $klass, @attach; |
490 | } |
487 | } |
491 | } else { |
488 | } else { |
492 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
489 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
493 | } |
490 | } |
494 | } |
491 | } |
… | |
… | |
550 | } |
547 | } |
551 | |
548 | |
552 | () |
549 | () |
553 | } |
550 | } |
554 | |
551 | |
555 | attach_to_objects |
552 | cf::object->attach ( |
556 | prio => -1000000, |
553 | prio => -1000000, |
557 | on_clone => sub { |
554 | on_clone => sub { |
558 | my ($src, $dst) = @_; |
555 | my ($src, $dst) = @_; |
559 | |
556 | |
560 | @{$dst->registry} = @{$src->registry}; |
557 | @{$dst->registry} = @{$src->registry}; |
… | |
… | |
562 | %$dst = %$src; |
559 | %$dst = %$src; |
563 | |
560 | |
564 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
561 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
565 | if exists $src->{_attachment}; |
562 | if exists $src->{_attachment}; |
566 | }, |
563 | }, |
567 | ; |
564 | ); |
568 | |
565 | |
569 | ############################################################################# |
566 | ############################################################################# |
570 | # old plug-in events |
567 | # command handling &c |
571 | |
568 | |
572 | sub inject_event { |
569 | =item cf::register_command $name => \&callback($ob,$args); |
573 | my $extension = shift; |
|
|
574 | my $event_code = shift; |
|
|
575 | |
570 | |
576 | my $cb = $hook[$event_code]{$extension} |
571 | Register a callback for execution when the client sends the user command |
577 | or return; |
572 | $name. |
578 | |
573 | |
579 | &$cb |
574 | =cut |
580 | } |
|
|
581 | |
|
|
582 | sub inject_global_event { |
|
|
583 | my $event = shift; |
|
|
584 | |
|
|
585 | my $cb = $hook[$event] |
|
|
586 | or return; |
|
|
587 | |
|
|
588 | List::Util::max map &$_, values %$cb |
|
|
589 | } |
|
|
590 | |
|
|
591 | sub inject_command { |
|
|
592 | my ($name, $obj, $params) = @_; |
|
|
593 | |
|
|
594 | for my $cmd (@{ $command{$name} }) { |
|
|
595 | $cmd->[1]->($obj, $params); |
|
|
596 | } |
|
|
597 | |
|
|
598 | -1 |
|
|
599 | } |
|
|
600 | |
575 | |
601 | sub register_command { |
576 | sub register_command { |
602 | my ($name, $time, $cb) = @_; |
577 | my ($name, $cb) = @_; |
603 | |
578 | |
604 | my $caller = caller; |
579 | my $caller = caller; |
605 | #warn "registering command '$name/$time' to '$caller'"; |
580 | #warn "registering command '$name/$time' to '$caller'"; |
606 | |
581 | |
607 | push @{ $command{$name} }, [$time, $cb, $caller]; |
582 | push @{ $COMMAND{$name} }, [$caller, $cb]; |
608 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
|
|
609 | } |
583 | } |
|
|
584 | |
|
|
585 | =item cf::register_extcmd $name => \&callback($pl,$packet); |
|
|
586 | |
|
|
587 | Register a callbackf ro execution when the client sends an extcmd packet. |
|
|
588 | |
|
|
589 | If the callback returns something, it is sent back as if reply was being |
|
|
590 | called. |
|
|
591 | |
|
|
592 | =cut |
610 | |
593 | |
611 | sub register_extcmd { |
594 | sub register_extcmd { |
612 | my ($name, $cb) = @_; |
595 | my ($name, $cb) = @_; |
613 | |
596 | |
614 | my $caller = caller; |
597 | my $caller = caller; |
615 | #warn "registering extcmd '$name' to '$caller'"; |
598 | #warn "registering extcmd '$name' to '$caller'"; |
616 | |
599 | |
617 | $extcmd{$name} = [$cb, $caller]; |
600 | $EXTCMD{$name} = [$cb, $caller]; |
618 | } |
601 | } |
|
|
602 | |
|
|
603 | cf::player->attach ( |
|
|
604 | on_command => sub { |
|
|
605 | my ($pl, $name, $params) = @_; |
|
|
606 | |
|
|
607 | my $cb = $COMMAND{$name} |
|
|
608 | or return; |
|
|
609 | |
|
|
610 | for my $cmd (@$cb) { |
|
|
611 | $cmd->[1]->($pl->ob, $params); |
|
|
612 | } |
|
|
613 | |
|
|
614 | cf::override; |
|
|
615 | }, |
|
|
616 | on_extcmd => sub { |
|
|
617 | my ($pl, $buf) = @_; |
|
|
618 | |
|
|
619 | my $msg = eval { from_json $buf }; |
|
|
620 | |
|
|
621 | if (ref $msg) { |
|
|
622 | if (my $cb = $EXTCMD{$msg->{msgtype}}) { |
|
|
623 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
624 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
625 | } |
|
|
626 | } |
|
|
627 | } else { |
|
|
628 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
629 | } |
|
|
630 | |
|
|
631 | cf::override; |
|
|
632 | }, |
|
|
633 | ); |
619 | |
634 | |
620 | sub register { |
635 | sub register { |
621 | my ($base, $pkg) = @_; |
636 | my ($base, $pkg) = @_; |
622 | |
637 | |
623 | #TODO |
638 | #TODO |
… | |
… | |
642 | . "#line 1 \"$path\"\n{\n" |
657 | . "#line 1 \"$path\"\n{\n" |
643 | . (do { local $/; <$fh> }) |
658 | . (do { local $/; <$fh> }) |
644 | . "\n};\n1"; |
659 | . "\n};\n1"; |
645 | |
660 | |
646 | eval $source |
661 | eval $source |
647 | or die "$path: $@"; |
662 | or die $@ ? "$path: $@\n" |
|
|
663 | : "extension disabled.\n"; |
648 | |
664 | |
649 | push @exts, $pkg; |
665 | push @exts, $pkg; |
650 | $ext_pkg{$base} = $pkg; |
666 | $ext_pkg{$base} = $pkg; |
651 | |
667 | |
652 | # no strict 'refs'; |
668 | # no strict 'refs'; |
… | |
… | |
665 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
681 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
666 | # delete $hook[$idx]{$pkg}; |
682 | # delete $hook[$idx]{$pkg}; |
667 | # } |
683 | # } |
668 | |
684 | |
669 | # remove commands |
685 | # remove commands |
670 | for my $name (keys %command) { |
686 | for my $name (keys %COMMAND) { |
671 | my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; |
687 | my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; |
672 | |
688 | |
673 | if (@cb) { |
689 | if (@cb) { |
674 | $command{$name} = \@cb; |
690 | $COMMAND{$name} = \@cb; |
675 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; |
|
|
676 | } else { |
691 | } else { |
677 | delete $command{$name}; |
|
|
678 | delete $COMMAND{"$name\000"}; |
692 | delete $COMMAND{$name}; |
679 | } |
693 | } |
680 | } |
694 | } |
681 | |
695 | |
682 | # remove extcmds |
696 | # remove extcmds |
683 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
697 | for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { |
684 | delete $extcmd{$name}; |
698 | delete $EXTCMD{$name}; |
685 | } |
699 | } |
686 | |
700 | |
687 | if (my $cb = $pkg->can ("unload")) { |
701 | if (my $cb = $pkg->can ("unload")) { |
688 | eval { |
702 | eval { |
689 | $cb->($pkg); |
703 | $cb->($pkg); |
… | |
… | |
693 | |
707 | |
694 | Symbol::delete_package $pkg; |
708 | Symbol::delete_package $pkg; |
695 | } |
709 | } |
696 | |
710 | |
697 | sub load_extensions { |
711 | sub load_extensions { |
698 | my $LIBDIR = maps_directory "perl"; |
|
|
699 | |
|
|
700 | for my $ext (<$LIBDIR/*.ext>) { |
712 | for my $ext (<$LIBDIR/*.ext>) { |
701 | next unless -r $ext; |
713 | next unless -r $ext; |
702 | eval { |
714 | eval { |
703 | load_extension $ext; |
715 | load_extension $ext; |
704 | 1 |
716 | 1 |
705 | } or warn "$ext not loaded: $@"; |
717 | } or warn "$ext not loaded: $@"; |
706 | } |
718 | } |
707 | } |
719 | } |
708 | |
720 | |
709 | ############################################################################# |
721 | ############################################################################# |
710 | # extcmd framework, basically convert ext <msg> |
|
|
711 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
712 | |
|
|
713 | attach_to_players |
|
|
714 | on_extcmd => sub { |
|
|
715 | my ($pl, $buf) = @_; |
|
|
716 | |
|
|
717 | my $msg = eval { from_json $buf }; |
|
|
718 | |
|
|
719 | if (ref $msg) { |
|
|
720 | if (my $cb = $extcmd{$msg->{msgtype}}) { |
|
|
721 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
722 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
723 | } |
|
|
724 | } |
|
|
725 | } else { |
|
|
726 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
727 | } |
|
|
728 | |
|
|
729 | cf::override; |
|
|
730 | }, |
|
|
731 | ; |
|
|
732 | |
|
|
733 | ############################################################################# |
|
|
734 | # load/save/clean perl data associated with a map |
722 | # load/save/clean perl data associated with a map |
735 | |
723 | |
736 | *cf::mapsupport::on_clean = sub { |
724 | *cf::mapsupport::on_clean = sub { |
737 | my ($map) = @_; |
725 | my ($map) = @_; |
738 | |
726 | |
… | |
… | |
740 | defined $path or return; |
728 | defined $path or return; |
741 | |
729 | |
742 | unlink "$path.pst"; |
730 | unlink "$path.pst"; |
743 | }; |
731 | }; |
744 | |
732 | |
745 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
733 | cf::map->attach (prio => -10000, package => cf::mapsupport::); |
746 | |
734 | |
747 | ############################################################################# |
735 | ############################################################################# |
748 | # load/save perl data associated with player->ob objects |
736 | # load/save perl data associated with player->ob objects |
749 | |
737 | |
750 | sub all_objects(@) { |
738 | sub all_objects(@) { |
751 | @_, map all_objects ($_->inv), @_ |
739 | @_, map all_objects ($_->inv), @_ |
752 | } |
740 | } |
753 | |
741 | |
754 | # TODO: compatibility cruft, remove when no longer needed |
742 | # TODO: compatibility cruft, remove when no longer needed |
755 | attach_to_players |
743 | cf::player->attach ( |
756 | on_load => sub { |
744 | on_load => sub { |
757 | my ($pl, $path) = @_; |
745 | my ($pl, $path) = @_; |
758 | |
746 | |
759 | for my $o (all_objects $pl->ob) { |
747 | for my $o (all_objects $pl->ob) { |
760 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
748 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
… | |
… | |
762 | |
750 | |
763 | %$o = %{ Storable::thaw pack "H*", $value }; |
751 | %$o = %{ Storable::thaw pack "H*", $value }; |
764 | } |
752 | } |
765 | } |
753 | } |
766 | }, |
754 | }, |
767 | ; |
755 | ); |
768 | |
756 | |
769 | ############################################################################# |
757 | ############################################################################# |
770 | |
758 | |
771 | =head2 CORE EXTENSIONS |
759 | =head2 CORE EXTENSIONS |
772 | |
760 | |
… | |
… | |
863 | |
851 | |
864 | =pod |
852 | =pod |
865 | |
853 | |
866 | The following fucntions and emthods are available within a safe environment: |
854 | The following fucntions and emthods are available within a safe environment: |
867 | |
855 | |
868 | cf::object contr pay_amount pay_player |
856 | cf::object contr pay_amount pay_player map |
869 | cf::object::player player |
857 | cf::object::player player |
870 | cf::player peaceful |
858 | cf::player peaceful |
|
|
859 | cf::map trigger |
871 | |
860 | |
872 | =cut |
861 | =cut |
873 | |
862 | |
874 | for ( |
863 | for ( |
875 | ["cf::object" => qw(contr pay_amount pay_player)], |
864 | ["cf::object" => qw(contr pay_amount pay_player map)], |
876 | ["cf::object::player" => qw(player)], |
865 | ["cf::object::player" => qw(player)], |
877 | ["cf::player" => qw(peaceful)], |
866 | ["cf::player" => qw(peaceful)], |
|
|
867 | ["cf::map" => qw(trigger)], |
878 | ) { |
868 | ) { |
879 | no strict 'refs'; |
869 | no strict 'refs'; |
880 | my ($pkg, @funs) = @$_; |
870 | my ($pkg, @funs) = @$_; |
881 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
871 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
882 | for @funs; |
872 | for @funs; |
… | |
… | |
1022 | sub db_sync() { |
1012 | sub db_sync() { |
1023 | db_save if $dirty; |
1013 | db_save if $dirty; |
1024 | undef $dirty; |
1014 | undef $dirty; |
1025 | } |
1015 | } |
1026 | |
1016 | |
1027 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { |
1017 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { |
1028 | db_sync; |
1018 | db_sync; |
1029 | }); |
1019 | }); |
1030 | |
1020 | |
1031 | sub db_dirty() { |
1021 | sub db_dirty() { |
1032 | $dirty = 1; |
1022 | $dirty = 1; |
… | |
… | |
1046 | $DB->{$_[0]} = $_[1]; |
1036 | $DB->{$_[0]} = $_[1]; |
1047 | } |
1037 | } |
1048 | db_dirty; |
1038 | db_dirty; |
1049 | } |
1039 | } |
1050 | |
1040 | |
1051 | attach_global |
1041 | cf::global->attach ( |
1052 | prio => 10000, |
1042 | prio => 10000, |
1053 | on_cleanup => sub { |
1043 | on_cleanup => sub { |
1054 | db_sync; |
1044 | db_sync; |
1055 | }, |
1045 | }, |
1056 | ; |
1046 | ); |
1057 | } |
1047 | } |
1058 | |
1048 | |
1059 | ############################################################################# |
1049 | ############################################################################# |
1060 | # the server's main() |
1050 | # the server's main() |
1061 | |
1051 | |
… | |
… | |
1082 | |
1072 | |
1083 | $msg->("reloading..."); |
1073 | $msg->("reloading..."); |
1084 | |
1074 | |
1085 | eval { |
1075 | eval { |
1086 | # cancel all watchers |
1076 | # cancel all watchers |
1087 | $_->cancel for Event::all_watchers; |
1077 | for (Event::all_watchers) { |
|
|
1078 | $_->cancel if $_->data & WF_AUTOCANCEL; |
|
|
1079 | } |
1088 | |
1080 | |
1089 | # unload all extensions |
1081 | # unload all extensions |
1090 | for (@exts) { |
1082 | for (@exts) { |
1091 | $msg->("unloading <$_>"); |
1083 | $msg->("unloading <$_>"); |
1092 | unload_extension $_; |
1084 | unload_extension $_; |
… | |
… | |
1152 | warn $_[0]; |
1144 | warn $_[0]; |
1153 | print "$_[0]\n"; |
1145 | print "$_[0]\n"; |
1154 | }; |
1146 | }; |
1155 | } |
1147 | } |
1156 | |
1148 | |
|
|
1149 | register "<global>", __PACKAGE__; |
|
|
1150 | |
1157 | register_command "perl-reload", 0, sub { |
1151 | register_command "perl-reload" => sub { |
1158 | my ($who, $arg) = @_; |
1152 | my ($who, $arg) = @_; |
1159 | |
1153 | |
1160 | if ($who->flag (FLAG_WIZ)) { |
1154 | if ($who->flag (FLAG_WIZ)) { |
1161 | _perl_reload { |
1155 | _perl_reload { |
1162 | warn $_[0]; |
1156 | warn $_[0]; |
1163 | $who->message ($_[0]); |
1157 | $who->message ($_[0]); |
1164 | }; |
1158 | }; |
1165 | } |
1159 | } |
1166 | }; |
1160 | }; |
1167 | |
1161 | |
1168 | register "<global>", __PACKAGE__; |
|
|
1169 | |
|
|
1170 | unshift @INC, $LIBDIR; |
1162 | unshift @INC, $LIBDIR; |
1171 | |
1163 | |
1172 | $TICK_WATCHER = Event->timer ( |
1164 | $TICK_WATCHER = Event->timer ( |
1173 | prio => 1, |
1165 | prio => 0, |
1174 | async => 1, |
|
|
1175 | at => $NEXT_TICK || 1, |
1166 | at => $NEXT_TICK || 1, |
|
|
1167 | data => WF_AUTOCANCEL, |
1176 | cb => sub { |
1168 | cb => sub { |
1177 | cf::server_tick; # one server iteration |
1169 | cf::server_tick; # one server iteration |
1178 | |
1170 | |
1179 | my $NOW = Event::time; |
1171 | my $NOW = Event::time; |
1180 | $NEXT_TICK += $TICK; |
1172 | $NEXT_TICK += $TICK; |
… | |
… | |
1190 | IO::AIO::max_poll_time $TICK * 0.2; |
1182 | IO::AIO::max_poll_time $TICK * 0.2; |
1191 | |
1183 | |
1192 | Event->io (fd => IO::AIO::poll_fileno, |
1184 | Event->io (fd => IO::AIO::poll_fileno, |
1193 | poll => 'r', |
1185 | poll => 'r', |
1194 | prio => 5, |
1186 | prio => 5, |
|
|
1187 | data => WF_AUTOCANCEL, |
1195 | cb => \&IO::AIO::poll_cb); |
1188 | cb => \&IO::AIO::poll_cb); |
1196 | |
1189 | |
1197 | 1 |
1190 | 1 |
1198 | |
1191 | |