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