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 | |
10 | use IO::AIO (); |
19 | use IO::AIO 2.3; |
11 | use YAML::Syck (); |
20 | use YAML::Syck (); |
12 | use Time::HiRes; |
21 | use Time::HiRes; |
13 | use Event; |
22 | |
14 | $Event::Eval = 1; # no idea why this is required, but it is |
23 | use Event; $Event::Eval = 1; # no idea why this is required, but it is |
15 | |
24 | |
16 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
25 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
17 | $YAML::Syck::ImplicitUnicode = 1; |
26 | $YAML::Syck::ImplicitUnicode = 1; |
18 | |
27 | |
19 | use strict; |
28 | $Coro::main->prio (2); # run main coroutine ("the server") with very high priority |
20 | |
29 | |
21 | _init_vars; |
30 | sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload |
22 | |
31 | |
23 | our %COMMAND = (); |
32 | our %COMMAND = (); |
|
|
33 | our %COMMAND_TIME = (); |
|
|
34 | our %EXTCMD = (); |
|
|
35 | |
24 | our @EVENT; |
36 | our @EVENT; |
25 | our $LIBDIR = maps_directory "perl"; |
37 | our $LIBDIR = datadir . "/ext"; |
26 | |
38 | |
27 | our $TICK = MAX_TIME * 1e-6; |
39 | our $TICK = MAX_TIME * 1e-6; |
28 | our $TICK_WATCHER; |
40 | our $TICK_WATCHER; |
29 | our $NEXT_TICK; |
41 | our $NEXT_TICK; |
|
|
42 | our $NOW; |
30 | |
43 | |
31 | our %CFG; |
44 | our %CFG; |
32 | |
45 | |
33 | our $uptime;#d# |
46 | our $UPTIME; $UPTIME ||= time; |
34 | our $UPTIME; |
47 | our $RUNTIME; |
35 | $UPTIME ||= $uptime;#d# |
48 | |
36 | $UPTIME ||= time; |
49 | our %MAP; # all maps |
|
|
50 | our $LINK_MAP; # the special {link} map |
|
|
51 | our $FREEZE; |
|
|
52 | |
|
|
53 | binmode STDOUT; |
|
|
54 | binmode STDERR; |
|
|
55 | |
|
|
56 | # read virtual server time, if available |
|
|
57 | unless ($RUNTIME || !-e cf::localdir . "/runtime") { |
|
|
58 | open my $fh, "<", cf::localdir . "/runtime" |
|
|
59 | or die "unable to read runtime file: $!"; |
|
|
60 | $RUNTIME = <$fh> + 0.; |
|
|
61 | } |
|
|
62 | |
|
|
63 | mkdir cf::localdir; |
|
|
64 | mkdir cf::localdir . "/" . cf::playerdir; |
|
|
65 | mkdir cf::localdir . "/" . cf::tmpdir; |
|
|
66 | mkdir cf::localdir . "/" . cf::uniquedir; |
|
|
67 | |
|
|
68 | our %EXT_CORO; |
37 | |
69 | |
38 | ############################################################################# |
70 | ############################################################################# |
39 | |
71 | |
40 | =head2 GLOBAL VARIABLES |
72 | =head2 GLOBAL VARIABLES |
41 | |
73 | |
42 | =over 4 |
74 | =over 4 |
43 | |
75 | |
44 | =item $cf::UPTIME |
76 | =item $cf::UPTIME |
45 | |
77 | |
46 | The timestamp of the server start (so not actually an uptime). |
78 | The timestamp of the server start (so not actually an uptime). |
|
|
79 | |
|
|
80 | =item $cf::RUNTIME |
|
|
81 | |
|
|
82 | The time this server has run, starts at 0 and is increased by $cf::TICK on |
|
|
83 | every server tick. |
47 | |
84 | |
48 | =item $cf::LIBDIR |
85 | =item $cf::LIBDIR |
49 | |
86 | |
50 | The perl library directory, where extensions and cf-specific modules can |
87 | The perl library directory, where extensions and cf-specific modules can |
51 | be found. It will be added to C<@INC> automatically. |
88 | be found. It will be added to C<@INC> automatically. |
|
|
89 | |
|
|
90 | =item $cf::NOW |
|
|
91 | |
|
|
92 | The time of the last (current) server tick. |
52 | |
93 | |
53 | =item $cf::TICK |
94 | =item $cf::TICK |
54 | |
95 | |
55 | The interval between server ticks, in seconds. |
96 | The interval between server ticks, in seconds. |
56 | |
97 | |
… | |
… | |
64 | =cut |
105 | =cut |
65 | |
106 | |
66 | BEGIN { |
107 | BEGIN { |
67 | *CORE::GLOBAL::warn = sub { |
108 | *CORE::GLOBAL::warn = sub { |
68 | my $msg = join "", @_; |
109 | my $msg = join "", @_; |
|
|
110 | utf8::encode $msg; |
|
|
111 | |
69 | $msg .= "\n" |
112 | $msg .= "\n" |
70 | unless $msg =~ /\n$/; |
113 | unless $msg =~ /\n$/; |
71 | |
114 | |
72 | print STDERR "cfperl: $msg"; |
|
|
73 | LOG llevError, "cfperl: $msg"; |
115 | LOG llevError, "cfperl: $msg"; |
74 | }; |
116 | }; |
75 | } |
117 | } |
76 | |
118 | |
|
|
119 | @safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; |
|
|
120 | @safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; |
|
|
121 | @safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; |
|
|
122 | @safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; |
|
|
123 | @safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; |
77 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
124 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
78 | |
125 | |
79 | # we bless all objects into (empty) derived classes to force a method lookup |
126 | # we bless all objects into (empty) derived classes to force a method lookup |
80 | # within the Safe compartment. |
127 | # within the Safe compartment. |
81 | for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { |
128 | for my $pkg (qw( |
|
|
129 | cf::global cf::attachable |
|
|
130 | cf::object cf::object::player |
|
|
131 | cf::client cf::player |
|
|
132 | cf::arch cf::living |
|
|
133 | cf::map cf::party cf::region |
|
|
134 | )) { |
82 | no strict 'refs'; |
135 | no strict 'refs'; |
83 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
136 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
84 | } |
137 | } |
85 | |
138 | |
86 | $Event::DIED = sub { |
139 | $Event::DIED = sub { |
… | |
… | |
88 | }; |
141 | }; |
89 | |
142 | |
90 | my %ext_pkg; |
143 | my %ext_pkg; |
91 | my @exts; |
144 | my @exts; |
92 | my @hook; |
145 | my @hook; |
93 | my %command; |
|
|
94 | my %extcmd; |
|
|
95 | |
146 | |
96 | =head2 UTILITY FUNCTIONS |
147 | =head2 UTILITY FUNCTIONS |
97 | |
148 | |
98 | =over 4 |
149 | =over 4 |
99 | |
150 | |
… | |
… | |
121 | sub to_json($) { |
172 | sub to_json($) { |
122 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
173 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
123 | JSON::Syck::Dump $_[0] |
174 | JSON::Syck::Dump $_[0] |
124 | } |
175 | } |
125 | |
176 | |
|
|
177 | =item $coro = cf::coro { BLOCK } |
|
|
178 | |
|
|
179 | Creates and returns a new coro. This coro is automcatially being canceled |
|
|
180 | when the extension calling this is being unloaded. |
|
|
181 | |
|
|
182 | =cut |
|
|
183 | |
|
|
184 | sub coro(&) { |
|
|
185 | my $cb = shift; |
|
|
186 | |
|
|
187 | my $coro; $coro = async { |
|
|
188 | eval { |
|
|
189 | $cb->(); |
|
|
190 | }; |
|
|
191 | warn $@ if $@; |
|
|
192 | }; |
|
|
193 | |
|
|
194 | $coro->on_destroy (sub { |
|
|
195 | delete $EXT_CORO{$coro+0}; |
|
|
196 | }); |
|
|
197 | $EXT_CORO{$coro+0} = $coro; |
|
|
198 | |
|
|
199 | $coro |
|
|
200 | } |
|
|
201 | |
126 | =back |
202 | =back |
127 | |
203 | |
128 | =cut |
204 | =cut |
129 | |
205 | |
130 | ############################################################################# |
206 | ############################################################################# |
131 | |
207 | |
132 | =head2 EVENTS AND OBJECT ATTACHMENTS |
208 | =head2 ATTACHABLE OBJECTS |
|
|
209 | |
|
|
210 | Many objects in crossfire are so-called attachable objects. That means you can |
|
|
211 | attach callbacks/event handlers (a collection of which is called an "attachment") |
|
|
212 | to it. All such attachable objects support the following methods. |
|
|
213 | |
|
|
214 | In the following description, CLASS can be any of C<global>, C<object> |
|
|
215 | C<player>, C<client> or C<map> (i.e. the attachable objects in |
|
|
216 | crossfire+). |
133 | |
217 | |
134 | =over 4 |
218 | =over 4 |
135 | |
219 | |
136 | =item $object->attach ($attachment, key => $value...) |
|
|
137 | |
|
|
138 | =item $object->detach ($attachment) |
|
|
139 | |
|
|
140 | Attach/detach a pre-registered attachment to an object. |
|
|
141 | |
|
|
142 | =item $player->attach ($attachment, key => $value...) |
|
|
143 | |
|
|
144 | =item $player->detach ($attachment) |
|
|
145 | |
|
|
146 | Attach/detach a pre-registered attachment to a player. |
|
|
147 | |
|
|
148 | =item $map->attach ($attachment, key => $value...) |
220 | =item $attachable->attach ($attachment, key => $value...) |
149 | |
221 | |
150 | =item $map->detach ($attachment) |
222 | =item $attachable->detach ($attachment) |
151 | |
223 | |
152 | Attach/detach a pre-registered attachment to a map. |
224 | Attach/detach a pre-registered attachment to a specific object and give it |
|
|
225 | the specified key/value pairs as arguments. |
153 | |
226 | |
154 | =item $bool = $object->attached ($name) |
227 | Example, attach a minesweeper attachment to the given object, making it a |
|
|
228 | 10x10 minesweeper game: |
155 | |
229 | |
156 | =item $bool = $player->attached ($name) |
230 | $obj->attach (minesweeper => width => 10, height => 10); |
157 | |
231 | |
158 | =item $bool = $map->attached ($name) |
232 | =item $bool = $attachable->attached ($name) |
159 | |
233 | |
160 | Checks wether the named attachment is currently attached to the object. |
234 | Checks wether the named attachment is currently attached to the object. |
161 | |
235 | |
162 | =item cf::attach_global ... |
236 | =item cf::CLASS->attach ... |
163 | |
237 | |
164 | Attach handlers for global events. |
238 | =item cf::CLASS->detach ... |
165 | |
239 | |
166 | This and all following C<attach_*>-functions expect any number of the |
240 | Define an anonymous attachment and attach it to all objects of the given |
167 | following handler/hook descriptions: |
241 | CLASS. See the next function for an explanation of its arguments. |
|
|
242 | |
|
|
243 | You can attach to global events by using the C<cf::global> class. |
|
|
244 | |
|
|
245 | Example, log all player logins: |
|
|
246 | |
|
|
247 | cf::player->attach ( |
|
|
248 | on_login => sub { |
|
|
249 | my ($pl) = @_; |
|
|
250 | ... |
|
|
251 | }, |
|
|
252 | ); |
|
|
253 | |
|
|
254 | Example, attach to the jeweler skill: |
|
|
255 | |
|
|
256 | cf::object->attach ( |
|
|
257 | type => cf::SKILL, |
|
|
258 | subtype => cf::SK_JEWELER, |
|
|
259 | on_use_skill => sub { |
|
|
260 | my ($sk, $ob, $part, $dir, $msg) = @_; |
|
|
261 | ... |
|
|
262 | }, |
|
|
263 | ); |
|
|
264 | |
|
|
265 | =item cf::CLASS::attachment $name, ... |
|
|
266 | |
|
|
267 | Register an attachment by C<$name> through which attachable objects of the |
|
|
268 | given CLASS can refer to this attachment. |
|
|
269 | |
|
|
270 | Some classes such as crossfire maps and objects can specify attachments |
|
|
271 | that are attached at load/instantiate time, thus the need for a name. |
|
|
272 | |
|
|
273 | These calls expect any number of the following handler/hook descriptions: |
168 | |
274 | |
169 | =over 4 |
275 | =over 4 |
170 | |
276 | |
171 | =item prio => $number |
277 | =item prio => $number |
172 | |
278 | |
… | |
… | |
174 | by another C<prio> setting). Lower priority handlers get executed |
280 | by another C<prio> setting). Lower priority handlers get executed |
175 | earlier. The default priority is C<0>, and many built-in handlers are |
281 | earlier. The default priority is C<0>, and many built-in handlers are |
176 | registered at priority C<-1000>, so lower priorities should not be used |
282 | registered at priority C<-1000>, so lower priorities should not be used |
177 | unless you know what you are doing. |
283 | unless you know what you are doing. |
178 | |
284 | |
|
|
285 | =item type => $type |
|
|
286 | |
|
|
287 | (Only for C<< cf::object->attach >> calls), limits the attachment to the |
|
|
288 | given type of objects only (the additional parameter C<subtype> can be |
|
|
289 | used to further limit to the given subtype). |
|
|
290 | |
179 | =item on_I<event> => \&cb |
291 | =item on_I<event> => \&cb |
180 | |
292 | |
181 | Call the given code reference whenever the named event happens (event is |
293 | Call the given code reference whenever the named event happens (event is |
182 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
294 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
183 | handlers are recognised generally depends on the type of object these |
295 | handlers are recognised generally depends on the type of object these |
… | |
… | |
192 | package and register them. Only handlers for eevents supported by the |
304 | package and register them. Only handlers for eevents supported by the |
193 | object/class are recognised. |
305 | object/class are recognised. |
194 | |
306 | |
195 | =back |
307 | =back |
196 | |
308 | |
197 | =item cf::attach_to_type $object_type, $subtype, ... |
309 | Example, define an attachment called "sockpuppet" that calls the given |
|
|
310 | event handler when a monster attacks: |
198 | |
311 | |
199 | Attach handlers for a specific object type (e.g. TRANSPORT) and |
312 | cf::object::attachment sockpuppet => |
200 | subtype. If C<$subtype> is zero or undef, matches all objects of the given |
313 | on_skill_attack => sub { |
201 | type. |
314 | my ($self, $victim) = @_; |
202 | |
315 | ... |
203 | =item cf::attach_to_objects ... |
|
|
204 | |
|
|
205 | Attach handlers to all objects. Do not use this except for debugging or |
|
|
206 | very rare events, as handlers are (obviously) called for I<all> objects in |
|
|
207 | the game. |
|
|
208 | |
|
|
209 | =item cf::attach_to_players ... |
|
|
210 | |
|
|
211 | Attach handlers to all players. |
|
|
212 | |
|
|
213 | =item cf::attach_to_maps ... |
|
|
214 | |
|
|
215 | Attach handlers to all maps. |
|
|
216 | |
|
|
217 | =item cf:register_attachment $name, ... |
|
|
218 | |
|
|
219 | Register an attachment by name through which objects can refer to this |
|
|
220 | attachment. |
|
|
221 | |
|
|
222 | =item cf:register_player_attachment $name, ... |
|
|
223 | |
|
|
224 | Register an attachment by name through which players can refer to this |
|
|
225 | attachment. |
|
|
226 | |
|
|
227 | =item cf:register_map_attachment $name, ... |
|
|
228 | |
|
|
229 | Register an attachment by name through which maps can refer to this |
|
|
230 | attachment. |
|
|
231 | |
|
|
232 | =cut |
|
|
233 | |
|
|
234 | # the following variables are defined in .xs and must not be re-created |
|
|
235 | our @CB_GLOBAL = (); # registry for all global events |
|
|
236 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
|
|
237 | our @CB_PLAYER = (); |
|
|
238 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
|
|
239 | our @CB_MAP = (); |
|
|
240 | |
|
|
241 | my %attachment; |
|
|
242 | |
|
|
243 | sub _attach_cb($\%$$$) { |
|
|
244 | my ($registry, $undo, $event, $prio, $cb) = @_; |
|
|
245 | |
|
|
246 | use sort 'stable'; |
|
|
247 | |
|
|
248 | $cb = [$prio, $cb]; |
|
|
249 | |
|
|
250 | @{$registry->[$event]} = sort |
|
|
251 | { $a->[0] cmp $b->[0] } |
|
|
252 | @{$registry->[$event] || []}, $cb; |
|
|
253 | |
|
|
254 | push @{$undo->{cb}}, [$event, $cb]; |
|
|
255 | } |
|
|
256 | |
|
|
257 | # attach handles attaching event callbacks |
|
|
258 | # the only thing the caller has to do is pass the correct |
|
|
259 | # registry (== where the callback attaches to). |
|
|
260 | sub _attach(\@$@) { |
|
|
261 | my ($registry, $klass, @arg) = @_; |
|
|
262 | |
|
|
263 | my $prio = 0; |
|
|
264 | |
|
|
265 | my %undo = ( |
|
|
266 | registry => $registry, |
|
|
267 | cb => [], |
|
|
268 | ); |
|
|
269 | |
|
|
270 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
|
|
271 | |
|
|
272 | while (@arg) { |
|
|
273 | my $type = shift @arg; |
|
|
274 | |
|
|
275 | if ($type eq "prio") { |
|
|
276 | $prio = shift @arg; |
|
|
277 | |
|
|
278 | } elsif ($type eq "package") { |
|
|
279 | my $pkg = shift @arg; |
|
|
280 | |
|
|
281 | while (my ($name, $id) = each %cb_id) { |
|
|
282 | if (my $cb = $pkg->can ($name)) { |
|
|
283 | _attach_cb $registry, %undo, $id, $prio, $cb; |
|
|
284 | } |
|
|
285 | } |
316 | } |
286 | |
|
|
287 | } elsif (exists $cb_id{$type}) { |
|
|
288 | _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; |
|
|
289 | |
|
|
290 | } elsif (ref $type) { |
|
|
291 | warn "attaching objects not supported, ignoring.\n"; |
|
|
292 | |
|
|
293 | } else { |
|
|
294 | shift @arg; |
|
|
295 | warn "attach argument '$type' not supported, ignoring.\n"; |
|
|
296 | } |
|
|
297 | } |
|
|
298 | |
|
|
299 | \%undo |
|
|
300 | } |
|
|
301 | |
|
|
302 | sub _attach_attachment { |
|
|
303 | my ($obj, $name, %arg) = @_; |
|
|
304 | |
|
|
305 | return if exists $obj->{_attachment}{$name}; |
|
|
306 | |
|
|
307 | my $res; |
|
|
308 | |
|
|
309 | if (my $attach = $attachment{$name}) { |
|
|
310 | my $registry = $obj->registry; |
|
|
311 | |
|
|
312 | for (@$attach) { |
|
|
313 | my ($klass, @attach) = @$_; |
|
|
314 | $res = _attach @$registry, $klass, @attach; |
|
|
315 | } |
|
|
316 | |
|
|
317 | $obj->{$name} = \%arg; |
|
|
318 | } else { |
|
|
319 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
320 | } |
|
|
321 | |
|
|
322 | $obj->{_attachment}{$name} = undef; |
|
|
323 | |
|
|
324 | $res->{attachment} = $name; |
|
|
325 | $res |
|
|
326 | } |
|
|
327 | |
|
|
328 | *cf::object::attach = |
|
|
329 | *cf::player::attach = |
|
|
330 | *cf::map::attach = sub { |
|
|
331 | my ($obj, $name, %arg) = @_; |
|
|
332 | |
|
|
333 | _attach_attachment $obj, $name, %arg; |
|
|
334 | }; |
|
|
335 | |
|
|
336 | # all those should be optimised |
|
|
337 | *cf::object::detach = |
|
|
338 | *cf::player::detach = |
|
|
339 | *cf::map::detach = sub { |
|
|
340 | my ($obj, $name) = @_; |
|
|
341 | |
|
|
342 | delete $obj->{_attachment}{$name}; |
|
|
343 | reattach ($obj); |
|
|
344 | }; |
|
|
345 | |
|
|
346 | *cf::object::attached = |
|
|
347 | *cf::player::attached = |
|
|
348 | *cf::map::attached = sub { |
|
|
349 | my ($obj, $name) = @_; |
|
|
350 | |
|
|
351 | exists $obj->{_attachment}{$name} |
|
|
352 | }; |
|
|
353 | |
|
|
354 | sub attach_global { |
|
|
355 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
|
|
356 | } |
|
|
357 | |
|
|
358 | sub attach_to_type { |
|
|
359 | my $type = shift; |
|
|
360 | my $subtype = shift; |
|
|
361 | |
|
|
362 | _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ |
|
|
363 | } |
|
|
364 | |
|
|
365 | sub attach_to_objects { |
|
|
366 | _attach @CB_OBJECT, KLASS_OBJECT, @_ |
|
|
367 | } |
|
|
368 | |
|
|
369 | sub attach_to_players { |
|
|
370 | _attach @CB_PLAYER, KLASS_PLAYER, @_ |
|
|
371 | } |
|
|
372 | |
|
|
373 | sub attach_to_maps { |
|
|
374 | _attach @CB_MAP, KLASS_MAP, @_ |
|
|
375 | } |
|
|
376 | |
|
|
377 | sub register_attachment { |
|
|
378 | my $name = shift; |
|
|
379 | |
|
|
380 | $attachment{$name} = [[KLASS_OBJECT, @_]]; |
|
|
381 | } |
|
|
382 | |
|
|
383 | sub register_player_attachment { |
|
|
384 | my $name = shift; |
|
|
385 | |
|
|
386 | $attachment{$name} = [[KLASS_PLAYER, @_]]; |
|
|
387 | } |
|
|
388 | |
|
|
389 | sub register_map_attachment { |
|
|
390 | my $name = shift; |
|
|
391 | |
|
|
392 | $attachment{$name} = [[KLASS_MAP, @_]]; |
|
|
393 | } |
|
|
394 | |
|
|
395 | our $override; |
|
|
396 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
|
|
397 | |
|
|
398 | sub override { |
|
|
399 | $override = 1; |
|
|
400 | @invoke_results = (); |
|
|
401 | } |
|
|
402 | |
|
|
403 | sub do_invoke { |
|
|
404 | my $event = shift; |
|
|
405 | my $callbacks = shift; |
|
|
406 | |
|
|
407 | @invoke_results = (); |
|
|
408 | |
|
|
409 | local $override; |
|
|
410 | |
|
|
411 | for (@$callbacks) { |
|
|
412 | eval { &{$_->[1]} }; |
|
|
413 | |
|
|
414 | if ($@) { |
|
|
415 | warn "$@"; |
|
|
416 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
|
|
417 | override; |
|
|
418 | } |
|
|
419 | |
|
|
420 | return 1 if $override; |
|
|
421 | } |
|
|
422 | |
|
|
423 | 0 |
317 | } |
424 | } |
|
|
425 | |
318 | |
426 | =item $bool = cf::invoke EVENT_GLOBAL_XXX, ... |
319 | =item $attachable->valid |
427 | |
|
|
428 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
|
|
429 | |
|
|
430 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
|
|
431 | |
|
|
432 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
|
|
433 | |
|
|
434 | Generate a global/object/player/map-specific event with the given arguments. |
|
|
435 | |
|
|
436 | This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be |
|
|
437 | removed in future versions), and there is no public API to access override |
|
|
438 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
439 | |
|
|
440 | =back |
|
|
441 | |
|
|
442 | =cut |
|
|
443 | |
|
|
444 | ############################################################################# |
|
|
445 | |
|
|
446 | =head2 METHODS VALID FOR ALL CORE OBJECTS |
|
|
447 | |
|
|
448 | =over 4 |
|
|
449 | |
|
|
450 | =item $object->valid, $player->valid, $map->valid |
|
|
451 | |
320 | |
452 | Just because you have a perl object does not mean that the corresponding |
321 | Just because you have a perl object does not mean that the corresponding |
453 | C-level object still exists. If you try to access an object that has no |
322 | C-level object still exists. If you try to access an object that has no |
454 | valid C counterpart anymore you get an exception at runtime. This method |
323 | valid C counterpart anymore you get an exception at runtime. This method |
455 | can be used to test for existence of the C object part without causing an |
324 | can be used to test for existence of the C object part without causing an |
456 | exception. |
325 | exception. |
457 | |
326 | |
|
|
327 | =cut |
|
|
328 | |
|
|
329 | # the following variables are defined in .xs and must not be re-created |
|
|
330 | our @CB_GLOBAL = (); # registry for all global events |
|
|
331 | our @CB_ATTACHABLE = (); # registry for all attachables |
|
|
332 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
|
|
333 | our @CB_PLAYER = (); |
|
|
334 | our @CB_CLIENT = (); |
|
|
335 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
|
|
336 | our @CB_MAP = (); |
|
|
337 | |
|
|
338 | my %attachment; |
|
|
339 | |
|
|
340 | sub _attach_cb($$$$) { |
|
|
341 | my ($registry, $event, $prio, $cb) = @_; |
|
|
342 | |
|
|
343 | use sort 'stable'; |
|
|
344 | |
|
|
345 | $cb = [$prio, $cb]; |
|
|
346 | |
|
|
347 | @{$registry->[$event]} = sort |
|
|
348 | { $a->[0] cmp $b->[0] } |
|
|
349 | @{$registry->[$event] || []}, $cb; |
|
|
350 | } |
|
|
351 | |
|
|
352 | # hack |
|
|
353 | my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP; |
|
|
354 | |
|
|
355 | # attach handles attaching event callbacks |
|
|
356 | # the only thing the caller has to do is pass the correct |
|
|
357 | # registry (== where the callback attaches to). |
|
|
358 | sub _attach { |
|
|
359 | my ($registry, $klass, @arg) = @_; |
|
|
360 | |
|
|
361 | my $object_type; |
|
|
362 | my $prio = 0; |
|
|
363 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
|
|
364 | |
|
|
365 | #TODO: get rid of this hack |
|
|
366 | if ($attachable_klass{$klass}) { |
|
|
367 | %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT); |
|
|
368 | } |
|
|
369 | |
|
|
370 | while (@arg) { |
|
|
371 | my $type = shift @arg; |
|
|
372 | |
|
|
373 | if ($type eq "prio") { |
|
|
374 | $prio = shift @arg; |
|
|
375 | |
|
|
376 | } elsif ($type eq "type") { |
|
|
377 | $object_type = shift @arg; |
|
|
378 | $registry = $CB_TYPE[$object_type] ||= []; |
|
|
379 | |
|
|
380 | } elsif ($type eq "subtype") { |
|
|
381 | defined $object_type or Carp::croak "subtype specified without type"; |
|
|
382 | my $object_subtype = shift @arg; |
|
|
383 | $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; |
|
|
384 | |
|
|
385 | } elsif ($type eq "package") { |
|
|
386 | my $pkg = shift @arg; |
|
|
387 | |
|
|
388 | while (my ($name, $id) = each %cb_id) { |
|
|
389 | if (my $cb = $pkg->can ($name)) { |
|
|
390 | _attach_cb $registry, $id, $prio, $cb; |
|
|
391 | } |
|
|
392 | } |
|
|
393 | |
|
|
394 | } elsif (exists $cb_id{$type}) { |
|
|
395 | _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; |
|
|
396 | |
|
|
397 | } elsif (ref $type) { |
|
|
398 | warn "attaching objects not supported, ignoring.\n"; |
|
|
399 | |
|
|
400 | } else { |
|
|
401 | shift @arg; |
|
|
402 | warn "attach argument '$type' not supported, ignoring.\n"; |
|
|
403 | } |
|
|
404 | } |
|
|
405 | } |
|
|
406 | |
|
|
407 | sub _object_attach { |
|
|
408 | my ($obj, $name, %arg) = @_; |
|
|
409 | |
|
|
410 | return if exists $obj->{_attachment}{$name}; |
|
|
411 | |
|
|
412 | if (my $attach = $attachment{$name}) { |
|
|
413 | my $registry = $obj->registry; |
|
|
414 | |
|
|
415 | for (@$attach) { |
|
|
416 | my ($klass, @attach) = @$_; |
|
|
417 | _attach $registry, $klass, @attach; |
|
|
418 | } |
|
|
419 | |
|
|
420 | $obj->{$name} = \%arg; |
|
|
421 | } else { |
|
|
422 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
423 | } |
|
|
424 | |
|
|
425 | $obj->{_attachment}{$name} = undef; |
|
|
426 | } |
|
|
427 | |
|
|
428 | sub cf::attachable::attach { |
|
|
429 | if (ref $_[0]) { |
|
|
430 | _object_attach @_; |
|
|
431 | } else { |
|
|
432 | _attach shift->_attach_registry, @_; |
|
|
433 | } |
|
|
434 | }; |
|
|
435 | |
|
|
436 | # all those should be optimised |
|
|
437 | sub cf::attachable::detach { |
|
|
438 | my ($obj, $name) = @_; |
|
|
439 | |
|
|
440 | if (ref $obj) { |
|
|
441 | delete $obj->{_attachment}{$name}; |
|
|
442 | reattach ($obj); |
|
|
443 | } else { |
|
|
444 | Carp::croak "cannot, currently, detach class attachments"; |
|
|
445 | } |
|
|
446 | }; |
|
|
447 | |
|
|
448 | sub cf::attachable::attached { |
|
|
449 | my ($obj, $name) = @_; |
|
|
450 | |
|
|
451 | exists $obj->{_attachment}{$name} |
|
|
452 | } |
|
|
453 | |
|
|
454 | for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) { |
|
|
455 | eval "#line " . __LINE__ . " 'cf.pm' |
|
|
456 | sub cf::\L$klass\E::_attach_registry { |
|
|
457 | (\\\@CB_$klass, KLASS_$klass) |
|
|
458 | } |
|
|
459 | |
|
|
460 | sub cf::\L$klass\E::attachment { |
|
|
461 | my \$name = shift; |
|
|
462 | |
|
|
463 | \$attachment{\$name} = [[KLASS_$klass, \@_]]; |
|
|
464 | } |
|
|
465 | "; |
|
|
466 | die if $@; |
|
|
467 | } |
|
|
468 | |
|
|
469 | our $override; |
|
|
470 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
|
|
471 | |
|
|
472 | sub override { |
|
|
473 | $override = 1; |
|
|
474 | @invoke_results = (); |
|
|
475 | } |
|
|
476 | |
|
|
477 | sub do_invoke { |
|
|
478 | my $event = shift; |
|
|
479 | my $callbacks = shift; |
|
|
480 | |
|
|
481 | @invoke_results = (); |
|
|
482 | |
|
|
483 | local $override; |
|
|
484 | |
|
|
485 | for (@$callbacks) { |
|
|
486 | eval { &{$_->[1]} }; |
|
|
487 | |
|
|
488 | if ($@) { |
|
|
489 | warn "$@"; |
|
|
490 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
|
|
491 | override; |
|
|
492 | } |
|
|
493 | |
|
|
494 | return 1 if $override; |
|
|
495 | } |
|
|
496 | |
|
|
497 | 0 |
|
|
498 | } |
|
|
499 | |
|
|
500 | =item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) |
|
|
501 | |
|
|
502 | =item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) |
|
|
503 | |
|
|
504 | Generate an object-specific event with the given arguments. |
|
|
505 | |
|
|
506 | This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be |
|
|
507 | removed in future versions), and there is no public API to access override |
|
|
508 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
509 | |
458 | =back |
510 | =back |
459 | |
511 | |
460 | =cut |
512 | =cut |
461 | |
|
|
462 | *cf::object::valid = |
|
|
463 | *cf::player::valid = |
|
|
464 | *cf::map::valid = \&cf::_valid; |
|
|
465 | |
513 | |
466 | ############################################################################# |
514 | ############################################################################# |
467 | # object support |
515 | # object support |
468 | |
516 | |
469 | sub instantiate { |
|
|
470 | my ($obj, $data) = @_; |
|
|
471 | |
|
|
472 | $data = from_json $data; |
|
|
473 | |
|
|
474 | for (@$data) { |
|
|
475 | my ($name, $args) = @$_; |
|
|
476 | |
|
|
477 | $obj->attach ($name, %{$args || {} }); |
|
|
478 | } |
|
|
479 | } |
|
|
480 | |
|
|
481 | # basically do the same as instantiate, without calling instantiate |
|
|
482 | sub reattach { |
517 | sub reattach { |
|
|
518 | # basically do the same as instantiate, without calling instantiate |
483 | my ($obj) = @_; |
519 | my ($obj) = @_; |
|
|
520 | |
484 | my $registry = $obj->registry; |
521 | my $registry = $obj->registry; |
485 | |
522 | |
486 | @$registry = (); |
523 | @$registry = (); |
487 | |
524 | |
488 | delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
525 | delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
489 | |
526 | |
490 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
527 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
491 | if (my $attach = $attachment{$name}) { |
528 | if (my $attach = $attachment{$name}) { |
492 | for (@$attach) { |
529 | for (@$attach) { |
493 | my ($klass, @attach) = @$_; |
530 | my ($klass, @attach) = @$_; |
494 | _attach @$registry, $klass, @attach; |
531 | _attach $registry, $klass, @attach; |
495 | } |
532 | } |
496 | } else { |
533 | } else { |
497 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
534 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
498 | } |
535 | } |
499 | } |
536 | } |
500 | } |
537 | } |
|
|
538 | |
|
|
539 | cf::attachable->attach ( |
|
|
540 | prio => -1000000, |
|
|
541 | on_instantiate => sub { |
|
|
542 | my ($obj, $data) = @_; |
|
|
543 | |
|
|
544 | $data = from_json $data; |
|
|
545 | |
|
|
546 | for (@$data) { |
|
|
547 | my ($name, $args) = @$_; |
|
|
548 | |
|
|
549 | $obj->attach ($name, %{$args || {} }); |
|
|
550 | } |
|
|
551 | }, |
|
|
552 | on_reattach => \&reattach, |
|
|
553 | on_clone => sub { |
|
|
554 | my ($src, $dst) = @_; |
|
|
555 | |
|
|
556 | @{$dst->registry} = @{$src->registry}; |
|
|
557 | |
|
|
558 | %$dst = %$src; |
|
|
559 | |
|
|
560 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
|
|
561 | if exists $src->{_attachment}; |
|
|
562 | }, |
|
|
563 | ); |
501 | |
564 | |
502 | sub object_freezer_save { |
565 | sub object_freezer_save { |
503 | my ($filename, $rdata, $objs) = @_; |
566 | my ($filename, $rdata, $objs) = @_; |
504 | |
567 | |
505 | if (length $$rdata) { |
568 | if (length $$rdata) { |
… | |
… | |
555 | } |
618 | } |
556 | |
619 | |
557 | () |
620 | () |
558 | } |
621 | } |
559 | |
622 | |
560 | attach_to_objects |
|
|
561 | prio => -1000000, |
|
|
562 | on_clone => sub { |
|
|
563 | my ($src, $dst) = @_; |
|
|
564 | |
|
|
565 | @{$dst->registry} = @{$src->registry}; |
|
|
566 | |
|
|
567 | %$dst = %$src; |
|
|
568 | |
|
|
569 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
|
|
570 | if exists $src->{_attachment}; |
|
|
571 | }, |
|
|
572 | ; |
|
|
573 | |
|
|
574 | ############################################################################# |
623 | ############################################################################# |
575 | # old plug-in events |
624 | # command handling &c |
576 | |
625 | |
577 | sub inject_event { |
626 | =item cf::register_command $name => \&callback($ob,$args); |
578 | my $extension = shift; |
|
|
579 | my $event_code = shift; |
|
|
580 | |
627 | |
581 | my $cb = $hook[$event_code]{$extension} |
628 | Register a callback for execution when the client sends the user command |
582 | or return; |
629 | $name. |
583 | |
630 | |
584 | &$cb |
631 | =cut |
585 | } |
|
|
586 | |
|
|
587 | sub inject_global_event { |
|
|
588 | my $event = shift; |
|
|
589 | |
|
|
590 | my $cb = $hook[$event] |
|
|
591 | or return; |
|
|
592 | |
|
|
593 | List::Util::max map &$_, values %$cb |
|
|
594 | } |
|
|
595 | |
|
|
596 | sub inject_command { |
|
|
597 | my ($name, $obj, $params) = @_; |
|
|
598 | |
|
|
599 | for my $cmd (@{ $command{$name} }) { |
|
|
600 | $cmd->[1]->($obj, $params); |
|
|
601 | } |
|
|
602 | |
|
|
603 | -1 |
|
|
604 | } |
|
|
605 | |
632 | |
606 | sub register_command { |
633 | sub register_command { |
607 | my ($name, $time, $cb) = @_; |
634 | my ($name, $cb) = @_; |
608 | |
635 | |
609 | my $caller = caller; |
636 | my $caller = caller; |
610 | #warn "registering command '$name/$time' to '$caller'"; |
637 | #warn "registering command '$name/$time' to '$caller'"; |
611 | |
638 | |
612 | push @{ $command{$name} }, [$time, $cb, $caller]; |
639 | push @{ $COMMAND{$name} }, [$caller, $cb]; |
613 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
|
|
614 | } |
640 | } |
|
|
641 | |
|
|
642 | =item cf::register_extcmd $name => \&callback($pl,$packet); |
|
|
643 | |
|
|
644 | Register a callbackf ro execution when the client sends an extcmd packet. |
|
|
645 | |
|
|
646 | If the callback returns something, it is sent back as if reply was being |
|
|
647 | called. |
|
|
648 | |
|
|
649 | =cut |
615 | |
650 | |
616 | sub register_extcmd { |
651 | sub register_extcmd { |
617 | my ($name, $cb) = @_; |
652 | my ($name, $cb) = @_; |
618 | |
653 | |
619 | my $caller = caller; |
654 | my $caller = caller; |
620 | #warn "registering extcmd '$name' to '$caller'"; |
655 | #warn "registering extcmd '$name' to '$caller'"; |
621 | |
656 | |
622 | $extcmd{$name} = [$cb, $caller]; |
657 | $EXTCMD{$name} = [$cb, $caller]; |
623 | } |
658 | } |
|
|
659 | |
|
|
660 | cf::player->attach ( |
|
|
661 | on_command => sub { |
|
|
662 | my ($pl, $name, $params) = @_; |
|
|
663 | |
|
|
664 | my $cb = $COMMAND{$name} |
|
|
665 | or return; |
|
|
666 | |
|
|
667 | for my $cmd (@$cb) { |
|
|
668 | $cmd->[1]->($pl->ob, $params); |
|
|
669 | } |
|
|
670 | |
|
|
671 | cf::override; |
|
|
672 | }, |
|
|
673 | on_extcmd => sub { |
|
|
674 | my ($pl, $buf) = @_; |
|
|
675 | |
|
|
676 | my $msg = eval { from_json $buf }; |
|
|
677 | |
|
|
678 | if (ref $msg) { |
|
|
679 | if (my $cb = $EXTCMD{$msg->{msgtype}}) { |
|
|
680 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
681 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
682 | } |
|
|
683 | } |
|
|
684 | } else { |
|
|
685 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
686 | } |
|
|
687 | |
|
|
688 | cf::override; |
|
|
689 | }, |
|
|
690 | ); |
624 | |
691 | |
625 | sub register { |
692 | sub register { |
626 | my ($base, $pkg) = @_; |
693 | my ($base, $pkg) = @_; |
627 | |
694 | |
628 | #TODO |
695 | #TODO |
… | |
… | |
671 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
738 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
672 | # delete $hook[$idx]{$pkg}; |
739 | # delete $hook[$idx]{$pkg}; |
673 | # } |
740 | # } |
674 | |
741 | |
675 | # remove commands |
742 | # remove commands |
676 | for my $name (keys %command) { |
743 | for my $name (keys %COMMAND) { |
677 | my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; |
744 | my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; |
678 | |
745 | |
679 | if (@cb) { |
746 | if (@cb) { |
680 | $command{$name} = \@cb; |
747 | $COMMAND{$name} = \@cb; |
681 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; |
|
|
682 | } else { |
748 | } else { |
683 | delete $command{$name}; |
|
|
684 | delete $COMMAND{"$name\000"}; |
749 | delete $COMMAND{$name}; |
685 | } |
750 | } |
686 | } |
751 | } |
687 | |
752 | |
688 | # remove extcmds |
753 | # remove extcmds |
689 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
754 | for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { |
690 | delete $extcmd{$name}; |
755 | delete $EXTCMD{$name}; |
691 | } |
756 | } |
692 | |
757 | |
693 | if (my $cb = $pkg->can ("unload")) { |
758 | if (my $cb = $pkg->can ("unload")) { |
694 | eval { |
759 | eval { |
695 | $cb->($pkg); |
760 | $cb->($pkg); |
… | |
… | |
699 | |
764 | |
700 | Symbol::delete_package $pkg; |
765 | Symbol::delete_package $pkg; |
701 | } |
766 | } |
702 | |
767 | |
703 | sub load_extensions { |
768 | sub load_extensions { |
704 | my $LIBDIR = maps_directory "perl"; |
|
|
705 | |
|
|
706 | for my $ext (<$LIBDIR/*.ext>) { |
769 | for my $ext (<$LIBDIR/*.ext>) { |
707 | next unless -r $ext; |
770 | next unless -r $ext; |
708 | eval { |
771 | eval { |
709 | load_extension $ext; |
772 | load_extension $ext; |
710 | 1 |
773 | 1 |
711 | } or warn "$ext not loaded: $@"; |
774 | } or warn "$ext not loaded: $@"; |
712 | } |
775 | } |
713 | } |
776 | } |
714 | |
777 | |
715 | ############################################################################# |
778 | ############################################################################# |
716 | # extcmd framework, basically convert ext <msg> |
|
|
717 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
718 | |
|
|
719 | attach_to_players |
|
|
720 | on_extcmd => sub { |
|
|
721 | my ($pl, $buf) = @_; |
|
|
722 | |
|
|
723 | my $msg = eval { from_json $buf }; |
|
|
724 | |
|
|
725 | if (ref $msg) { |
|
|
726 | if (my $cb = $extcmd{$msg->{msgtype}}) { |
|
|
727 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
728 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
729 | } |
|
|
730 | } |
|
|
731 | } else { |
|
|
732 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
733 | } |
|
|
734 | |
|
|
735 | cf::override; |
|
|
736 | }, |
|
|
737 | ; |
|
|
738 | |
|
|
739 | ############################################################################# |
|
|
740 | # load/save/clean perl data associated with a map |
779 | # load/save/clean perl data associated with a map |
741 | |
780 | |
742 | *cf::mapsupport::on_clean = sub { |
781 | *cf::mapsupport::on_clean = sub { |
743 | my ($map) = @_; |
782 | my ($map) = @_; |
744 | |
783 | |
… | |
… | |
746 | defined $path or return; |
785 | defined $path or return; |
747 | |
786 | |
748 | unlink "$path.pst"; |
787 | unlink "$path.pst"; |
749 | }; |
788 | }; |
750 | |
789 | |
751 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
790 | cf::map->attach (prio => -10000, package => cf::mapsupport::); |
752 | |
791 | |
753 | ############################################################################# |
792 | ############################################################################# |
754 | # load/save perl data associated with player->ob objects |
793 | # load/save perl data associated with player->ob objects |
755 | |
794 | |
756 | sub all_objects(@) { |
795 | sub all_objects(@) { |
757 | @_, map all_objects ($_->inv), @_ |
796 | @_, map all_objects ($_->inv), @_ |
758 | } |
797 | } |
759 | |
798 | |
760 | # TODO: compatibility cruft, remove when no longer needed |
799 | # TODO: compatibility cruft, remove when no longer needed |
761 | attach_to_players |
800 | cf::player->attach ( |
762 | on_load => sub { |
801 | on_load => sub { |
763 | my ($pl, $path) = @_; |
802 | my ($pl, $path) = @_; |
764 | |
803 | |
765 | for my $o (all_objects $pl->ob) { |
804 | for my $o (all_objects $pl->ob) { |
766 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
805 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
… | |
… | |
768 | |
807 | |
769 | %$o = %{ Storable::thaw pack "H*", $value }; |
808 | %$o = %{ Storable::thaw pack "H*", $value }; |
770 | } |
809 | } |
771 | } |
810 | } |
772 | }, |
811 | }, |
773 | ; |
812 | ); |
774 | |
813 | |
775 | ############################################################################# |
814 | ############################################################################# |
776 | |
815 | |
777 | =head2 CORE EXTENSIONS |
816 | =head2 CORE EXTENSIONS |
778 | |
817 | |
779 | Functions and methods that extend core crossfire objects. |
818 | Functions and methods that extend core crossfire objects. |
|
|
819 | |
|
|
820 | =head3 cf::player |
780 | |
821 | |
781 | =over 4 |
822 | =over 4 |
782 | |
823 | |
783 | =item cf::player::exists $login |
824 | =item cf::player::exists $login |
784 | |
825 | |
… | |
… | |
789 | sub cf::player::exists($) { |
830 | sub cf::player::exists($) { |
790 | cf::player::find $_[0] |
831 | cf::player::find $_[0] |
791 | or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
832 | or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
792 | } |
833 | } |
793 | |
834 | |
|
|
835 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
|
|
836 | |
|
|
837 | Sends an ext reply to the player. |
|
|
838 | |
|
|
839 | =cut |
|
|
840 | |
|
|
841 | sub cf::player::ext_reply($$$%) { |
|
|
842 | my ($self, $id, %msg) = @_; |
|
|
843 | |
|
|
844 | $msg{msgid} = $id; |
|
|
845 | |
|
|
846 | $self->send ("ext " . to_json \%msg); |
|
|
847 | } |
|
|
848 | |
|
|
849 | =back |
|
|
850 | |
|
|
851 | =head3 cf::object::player |
|
|
852 | |
|
|
853 | =over 4 |
|
|
854 | |
794 | =item $player_object->reply ($npc, $msg[, $flags]) |
855 | =item $player_object->reply ($npc, $msg[, $flags]) |
795 | |
856 | |
796 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
857 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
797 | can be C<undef>. Does the right thing when the player is currently in a |
858 | can be C<undef>. Does the right thing when the player is currently in a |
798 | dialogue with the given NPC character. |
859 | dialogue with the given NPC character. |
799 | |
860 | |
800 | =cut |
861 | =cut |
801 | |
862 | |
802 | # rough implementation of a future "reply" method that works |
863 | # rough implementation of a future "reply" method that works |
803 | # with dialog boxes. |
864 | # with dialog boxes. |
|
|
865 | #TODO: the first argument must go, split into a $npc->reply_to ( method |
804 | sub cf::object::player::reply($$$;$) { |
866 | sub cf::object::player::reply($$$;$) { |
805 | my ($self, $npc, $msg, $flags) = @_; |
867 | my ($self, $npc, $msg, $flags) = @_; |
806 | |
868 | |
807 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
869 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
808 | |
870 | |
… | |
… | |
812 | $msg = $npc->name . " says: $msg" if $npc; |
874 | $msg = $npc->name . " says: $msg" if $npc; |
813 | $self->message ($msg, $flags); |
875 | $self->message ($msg, $flags); |
814 | } |
876 | } |
815 | } |
877 | } |
816 | |
878 | |
817 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
|
|
818 | |
|
|
819 | Sends an ext reply to the player. |
|
|
820 | |
|
|
821 | =cut |
|
|
822 | |
|
|
823 | sub cf::player::ext_reply($$$%) { |
|
|
824 | my ($self, $id, %msg) = @_; |
|
|
825 | |
|
|
826 | $msg{msgid} = $id; |
|
|
827 | |
|
|
828 | $self->send ("ext " . to_json \%msg); |
|
|
829 | } |
|
|
830 | |
|
|
831 | =item $player_object->may ("access") |
879 | =item $player_object->may ("access") |
832 | |
880 | |
833 | Returns wether the given player is authorized to access resource "access" |
881 | Returns wether the given player is authorized to access resource "access" |
834 | (e.g. "command_wizcast"). |
882 | (e.g. "command_wizcast"). |
835 | |
883 | |
… | |
… | |
842 | (ref $cf::CFG{"may_$access"} |
890 | (ref $cf::CFG{"may_$access"} |
843 | ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} |
891 | ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} |
844 | : $cf::CFG{"may_$access"}) |
892 | : $cf::CFG{"may_$access"}) |
845 | } |
893 | } |
846 | |
894 | |
847 | =cut |
895 | =head3 cf::client |
848 | |
896 | |
849 | ############################################################################# |
897 | =over 4 |
|
|
898 | |
|
|
899 | =item $client->send_drawinfo ($text, $flags) |
|
|
900 | |
|
|
901 | Sends a drawinfo packet to the client. Circumvents output buffering so |
|
|
902 | should not be used under normal circumstances. |
|
|
903 | |
|
|
904 | =cut |
|
|
905 | |
|
|
906 | sub cf::client::send_drawinfo { |
|
|
907 | my ($self, $text, $flags) = @_; |
|
|
908 | |
|
|
909 | utf8::encode $text; |
|
|
910 | $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); |
|
|
911 | } |
|
|
912 | |
|
|
913 | |
|
|
914 | =item $success = $client->query ($flags, "text", \&cb) |
|
|
915 | |
|
|
916 | Queues a query to the client, calling the given callback with |
|
|
917 | the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, |
|
|
918 | C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. |
|
|
919 | |
|
|
920 | Queries can fail, so check the return code. Or don't, as queries will become |
|
|
921 | reliable at some point in the future. |
|
|
922 | |
|
|
923 | =cut |
|
|
924 | |
|
|
925 | sub cf::client::query { |
|
|
926 | my ($self, $flags, $text, $cb) = @_; |
|
|
927 | |
|
|
928 | return unless $self->state == ST_PLAYING |
|
|
929 | || $self->state == ST_SETUP |
|
|
930 | || $self->state == ST_CUSTOM; |
|
|
931 | |
|
|
932 | $self->state (ST_CUSTOM); |
|
|
933 | |
|
|
934 | utf8::encode $text; |
|
|
935 | push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; |
|
|
936 | |
|
|
937 | $self->send_packet ($self->{query_queue}[0][0]) |
|
|
938 | if @{ $self->{query_queue} } == 1; |
|
|
939 | } |
|
|
940 | |
|
|
941 | cf::client->attach ( |
|
|
942 | on_reply => sub { |
|
|
943 | my ($ns, $msg) = @_; |
|
|
944 | |
|
|
945 | # this weird shuffling is so that direct followup queries |
|
|
946 | # get handled first |
|
|
947 | my $queue = delete $ns->{query_queue}; |
|
|
948 | |
|
|
949 | (shift @$queue)->[1]->($msg); |
|
|
950 | |
|
|
951 | push @{ $ns->{query_queue} }, @$queue; |
|
|
952 | |
|
|
953 | if (@{ $ns->{query_queue} } == @$queue) { |
|
|
954 | if (@$queue) { |
|
|
955 | $ns->send_packet ($ns->{query_queue}[0][0]); |
|
|
956 | } else { |
|
|
957 | $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; |
|
|
958 | } |
|
|
959 | } |
|
|
960 | }, |
|
|
961 | ); |
|
|
962 | |
|
|
963 | =item $client->coro (\&cb) |
|
|
964 | |
|
|
965 | Create a new coroutine, running the specified callback. The coroutine will |
|
|
966 | be automatically cancelled when the client gets destroyed (e.g. on logout, |
|
|
967 | or loss of connection). |
|
|
968 | |
|
|
969 | =cut |
|
|
970 | |
|
|
971 | sub cf::client::coro { |
|
|
972 | my ($self, $cb) = @_; |
|
|
973 | |
|
|
974 | my $coro; $coro = async { |
|
|
975 | eval { |
|
|
976 | $cb->(); |
|
|
977 | }; |
|
|
978 | warn $@ if $@; |
|
|
979 | }; |
|
|
980 | |
|
|
981 | $coro->on_destroy (sub { |
|
|
982 | delete $self->{_coro}{$coro+0}; |
|
|
983 | }); |
|
|
984 | |
|
|
985 | $self->{_coro}{$coro+0} = $coro; |
|
|
986 | |
|
|
987 | $coro |
|
|
988 | } |
|
|
989 | |
|
|
990 | cf::client->attach ( |
|
|
991 | on_destroy => sub { |
|
|
992 | my ($ns) = @_; |
|
|
993 | |
|
|
994 | $_->cancel for values %{ (delete $ns->{_coro}) || {} }; |
|
|
995 | }, |
|
|
996 | ); |
|
|
997 | |
|
|
998 | =back |
|
|
999 | |
850 | |
1000 | |
851 | =head2 SAFE SCRIPTING |
1001 | =head2 SAFE SCRIPTING |
852 | |
1002 | |
853 | Functions that provide a safe environment to compile and execute |
1003 | Functions that provide a safe environment to compile and execute |
854 | snippets of perl code without them endangering the safety of the server |
1004 | snippets of perl code without them endangering the safety of the server |
… | |
… | |
869 | |
1019 | |
870 | =pod |
1020 | =pod |
871 | |
1021 | |
872 | The following fucntions and emthods are available within a safe environment: |
1022 | The following fucntions and emthods are available within a safe environment: |
873 | |
1023 | |
874 | cf::object contr pay_amount pay_player |
1024 | cf::object contr pay_amount pay_player map |
875 | cf::object::player player |
1025 | cf::object::player player |
876 | cf::player peaceful |
1026 | cf::player peaceful |
|
|
1027 | cf::map trigger |
877 | |
1028 | |
878 | =cut |
1029 | =cut |
879 | |
1030 | |
880 | for ( |
1031 | for ( |
881 | ["cf::object" => qw(contr pay_amount pay_player)], |
1032 | ["cf::object" => qw(contr pay_amount pay_player map)], |
882 | ["cf::object::player" => qw(player)], |
1033 | ["cf::object::player" => qw(player)], |
883 | ["cf::player" => qw(peaceful)], |
1034 | ["cf::player" => qw(peaceful)], |
|
|
1035 | ["cf::map" => qw(trigger)], |
884 | ) { |
1036 | ) { |
885 | no strict 'refs'; |
1037 | no strict 'refs'; |
886 | my ($pkg, @funs) = @$_; |
1038 | my ($pkg, @funs) = @$_; |
887 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
1039 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
888 | for @funs; |
1040 | for @funs; |
… | |
… | |
1028 | sub db_sync() { |
1180 | sub db_sync() { |
1029 | db_save if $dirty; |
1181 | db_save if $dirty; |
1030 | undef $dirty; |
1182 | undef $dirty; |
1031 | } |
1183 | } |
1032 | |
1184 | |
1033 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { |
1185 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { |
1034 | db_sync; |
1186 | db_sync; |
1035 | }); |
1187 | }); |
1036 | |
1188 | |
1037 | sub db_dirty() { |
1189 | sub db_dirty() { |
1038 | $dirty = 1; |
1190 | $dirty = 1; |
… | |
… | |
1052 | $DB->{$_[0]} = $_[1]; |
1204 | $DB->{$_[0]} = $_[1]; |
1053 | } |
1205 | } |
1054 | db_dirty; |
1206 | db_dirty; |
1055 | } |
1207 | } |
1056 | |
1208 | |
1057 | attach_global |
1209 | cf::global->attach ( |
1058 | prio => 10000, |
1210 | prio => 10000, |
1059 | on_cleanup => sub { |
1211 | on_cleanup => sub { |
1060 | db_sync; |
1212 | db_sync; |
1061 | }, |
1213 | }, |
1062 | ; |
1214 | ); |
1063 | } |
1215 | } |
1064 | |
1216 | |
1065 | ############################################################################# |
1217 | ############################################################################# |
1066 | # the server's main() |
1218 | # the server's main() |
1067 | |
1219 | |
… | |
… | |
1081 | } |
1233 | } |
1082 | |
1234 | |
1083 | ############################################################################# |
1235 | ############################################################################# |
1084 | # initialisation |
1236 | # initialisation |
1085 | |
1237 | |
1086 | sub _perl_reload(&) { |
1238 | sub _perl_reload() { |
1087 | my ($msg) = @_; |
1239 | warn "reloading..."; |
1088 | |
|
|
1089 | $msg->("reloading..."); |
|
|
1090 | |
1240 | |
1091 | eval { |
1241 | eval { |
|
|
1242 | local $FREEZE = 1; |
|
|
1243 | |
|
|
1244 | cf::emergency_save; |
|
|
1245 | |
1092 | # cancel all watchers |
1246 | # cancel all watchers |
1093 | $_->cancel for Event::all_watchers; |
1247 | for (Event::all_watchers) { |
|
|
1248 | $_->cancel if $_->data & WF_AUTOCANCEL; |
|
|
1249 | } |
|
|
1250 | |
|
|
1251 | # cancel all extension coros |
|
|
1252 | $_->cancel for values %EXT_CORO; |
|
|
1253 | %EXT_CORO = (); |
1094 | |
1254 | |
1095 | # unload all extensions |
1255 | # unload all extensions |
1096 | for (@exts) { |
1256 | for (@exts) { |
1097 | $msg->("unloading <$_>"); |
1257 | warn "unloading <$_>"; |
1098 | unload_extension $_; |
1258 | unload_extension $_; |
1099 | } |
1259 | } |
1100 | |
1260 | |
1101 | # unload all modules loaded from $LIBDIR |
1261 | # unload all modules loaded from $LIBDIR |
1102 | while (my ($k, $v) = each %INC) { |
1262 | while (my ($k, $v) = each %INC) { |
1103 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
1263 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
1104 | |
1264 | |
1105 | $msg->("removing <$k>"); |
1265 | warn "removing <$k>"; |
1106 | delete $INC{$k}; |
1266 | delete $INC{$k}; |
1107 | |
1267 | |
1108 | $k =~ s/\.pm$//; |
1268 | $k =~ s/\.pm$//; |
1109 | $k =~ s/\//::/g; |
1269 | $k =~ s/\//::/g; |
1110 | |
1270 | |
… | |
… | |
1115 | Symbol::delete_package $k; |
1275 | Symbol::delete_package $k; |
1116 | } |
1276 | } |
1117 | |
1277 | |
1118 | # sync database to disk |
1278 | # sync database to disk |
1119 | cf::db_sync; |
1279 | cf::db_sync; |
|
|
1280 | IO::AIO::flush; |
1120 | |
1281 | |
1121 | # get rid of safe::, as good as possible |
1282 | # get rid of safe::, as good as possible |
1122 | Symbol::delete_package "safe::$_" |
1283 | Symbol::delete_package "safe::$_" |
1123 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
1284 | for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); |
1124 | |
1285 | |
1125 | # remove register_script_function callbacks |
1286 | # remove register_script_function callbacks |
1126 | # TODO |
1287 | # TODO |
1127 | |
1288 | |
1128 | # unload cf.pm "a bit" |
1289 | # unload cf.pm "a bit" |
… | |
… | |
1131 | # don't, removes xs symbols, too, |
1292 | # don't, removes xs symbols, too, |
1132 | # and global variables created in xs |
1293 | # and global variables created in xs |
1133 | #Symbol::delete_package __PACKAGE__; |
1294 | #Symbol::delete_package __PACKAGE__; |
1134 | |
1295 | |
1135 | # reload cf.pm |
1296 | # reload cf.pm |
1136 | $msg->("reloading cf.pm"); |
1297 | warn "reloading cf.pm"; |
1137 | require cf; |
1298 | require cf; |
|
|
1299 | cf::_connect_to_perl; # nominally unnecessary, but cannot hurt |
1138 | |
1300 | |
1139 | # load config and database again |
1301 | # load config and database again |
1140 | cf::cfg_load; |
1302 | cf::cfg_load; |
1141 | cf::db_load; |
1303 | cf::db_load; |
1142 | |
1304 | |
1143 | # load extensions |
1305 | # load extensions |
1144 | $msg->("load extensions"); |
1306 | warn "load extensions"; |
1145 | cf::load_extensions; |
1307 | cf::load_extensions; |
1146 | |
1308 | |
1147 | # reattach attachments to objects |
1309 | # reattach attachments to objects |
1148 | $msg->("reattach"); |
1310 | warn "reattach"; |
1149 | _global_reattach; |
1311 | _global_reattach; |
1150 | }; |
1312 | }; |
1151 | $msg->($@) if $@; |
1313 | warn $@ if $@; |
1152 | |
1314 | |
1153 | $msg->("reloaded"); |
1315 | warn "reloaded"; |
1154 | }; |
1316 | }; |
1155 | |
1317 | |
1156 | sub perl_reload() { |
1318 | sub perl_reload() { |
1157 | _perl_reload { |
1319 | _perl_reload; |
1158 | warn $_[0]; |
|
|
1159 | print "$_[0]\n"; |
|
|
1160 | }; |
|
|
1161 | } |
1320 | } |
1162 | |
1321 | |
|
|
1322 | register "<global>", __PACKAGE__; |
|
|
1323 | |
1163 | register_command "perl-reload", 0, sub { |
1324 | register_command "perl-reload" => sub { |
1164 | my ($who, $arg) = @_; |
1325 | my ($who, $arg) = @_; |
1165 | |
1326 | |
1166 | if ($who->flag (FLAG_WIZ)) { |
1327 | if ($who->flag (FLAG_WIZ)) { |
|
|
1328 | $who->message ("reloading..."); |
1167 | _perl_reload { |
1329 | _perl_reload; |
1168 | warn $_[0]; |
|
|
1169 | $who->message ($_[0]); |
|
|
1170 | }; |
|
|
1171 | } |
1330 | } |
1172 | }; |
1331 | }; |
1173 | |
1332 | |
1174 | register "<global>", __PACKAGE__; |
|
|
1175 | |
|
|
1176 | unshift @INC, $LIBDIR; |
1333 | unshift @INC, $LIBDIR; |
1177 | |
1334 | |
1178 | $TICK_WATCHER = Event->timer ( |
1335 | $TICK_WATCHER = Event->timer ( |
|
|
1336 | reentrant => 0, |
1179 | prio => 1, |
1337 | prio => 0, |
1180 | async => 1, |
|
|
1181 | at => $NEXT_TICK || 1, |
1338 | at => $NEXT_TICK || $TICK, |
|
|
1339 | data => WF_AUTOCANCEL, |
1182 | cb => sub { |
1340 | cb => sub { |
|
|
1341 | unless ($FREEZE) { |
1183 | cf::server_tick; # one server iteration |
1342 | cf::server_tick; # one server iteration |
|
|
1343 | $RUNTIME += $TICK; |
|
|
1344 | } |
1184 | |
1345 | |
1185 | my $NOW = Event::time; |
|
|
1186 | $NEXT_TICK += $TICK; |
1346 | $NEXT_TICK += $TICK; |
1187 | |
1347 | |
1188 | # if we are delayed by four ticks or more, skip them all |
1348 | # if we are delayed by four ticks or more, skip them all |
1189 | $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; |
1349 | $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; |
1190 | |
1350 | |
1191 | $TICK_WATCHER->at ($NEXT_TICK); |
1351 | $TICK_WATCHER->at ($NEXT_TICK); |
1192 | $TICK_WATCHER->start; |
1352 | $TICK_WATCHER->start; |
1193 | }, |
1353 | }, |
1194 | ); |
1354 | ); |
… | |
… | |
1196 | IO::AIO::max_poll_time $TICK * 0.2; |
1356 | IO::AIO::max_poll_time $TICK * 0.2; |
1197 | |
1357 | |
1198 | Event->io (fd => IO::AIO::poll_fileno, |
1358 | Event->io (fd => IO::AIO::poll_fileno, |
1199 | poll => 'r', |
1359 | poll => 'r', |
1200 | prio => 5, |
1360 | prio => 5, |
|
|
1361 | data => WF_AUTOCANCEL, |
1201 | cb => \&IO::AIO::poll_cb); |
1362 | cb => \&IO::AIO::poll_cb); |
1202 | |
1363 | |
|
|
1364 | # we must not ever block the main coroutine |
|
|
1365 | $Coro::idle = sub { |
|
|
1366 | #Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d# |
|
|
1367 | warn "FATAL: Coro::idle was called, major BUG\n"; |
|
|
1368 | (Coro::unblock_sub { |
|
|
1369 | Event::one_event; |
|
|
1370 | })->(); |
|
|
1371 | }; |
|
|
1372 | |
1203 | 1 |
1373 | 1 |
1204 | |
1374 | |