… | |
… | |
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 | |
16 | _reload_1; |
21 | sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload |
17 | |
22 | |
18 | our %COMMAND = (); |
23 | our %COMMAND = (); |
|
|
24 | our %COMMAND_TIME = (); |
|
|
25 | our %EXTCMD = (); |
|
|
26 | |
|
|
27 | _init_vars; |
|
|
28 | |
19 | our @EVENT; |
29 | our @EVENT; |
20 | our %PROP_TYPE; |
30 | our $LIBDIR = datadir . "/ext"; |
21 | our %PROP_IDX; |
|
|
22 | our $LIBDIR = maps_directory "perl"; |
|
|
23 | |
31 | |
24 | our $TICK = MAX_TIME * 1e-6; |
32 | our $TICK = MAX_TIME * 1e-6; |
25 | our $TICK_WATCHER; |
33 | our $TICK_WATCHER; |
26 | our $NEXT_TICK; |
34 | our $NEXT_TICK; |
|
|
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 |
27 | |
67 | |
28 | BEGIN { |
68 | BEGIN { |
29 | *CORE::GLOBAL::warn = sub { |
69 | *CORE::GLOBAL::warn = sub { |
30 | my $msg = join "", @_; |
70 | my $msg = join "", @_; |
31 | $msg .= "\n" |
71 | $msg .= "\n" |
… | |
… | |
34 | print STDERR "cfperl: $msg"; |
74 | print STDERR "cfperl: $msg"; |
35 | LOG llevError, "cfperl: $msg"; |
75 | LOG llevError, "cfperl: $msg"; |
36 | }; |
76 | }; |
37 | } |
77 | } |
38 | |
78 | |
39 | my %ignore_set = (MAP_PROP_PATH => 1); # I hate the plug-in api. Deeply! |
79 | @safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; |
40 | |
80 | @safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; |
41 | # generate property mutators |
81 | @safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; |
42 | sub prop_gen { |
82 | @safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; |
43 | my ($prefix, $class) = @_; |
83 | @safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; |
44 | |
|
|
45 | no strict 'refs'; |
|
|
46 | |
|
|
47 | for my $prop (keys %PROP_TYPE) { |
|
|
48 | $prop =~ /^\Q$prefix\E_(.*$)/ or next; |
|
|
49 | my $sub = lc $1; |
|
|
50 | |
|
|
51 | my $type = $PROP_TYPE{$prop}; |
|
|
52 | my $idx = $PROP_IDX {$prop}; |
|
|
53 | |
|
|
54 | *{"$class\::get_$sub"} = *{"$class\::$sub"} = sub { |
|
|
55 | $_[0]->get_property ($type, $idx) |
|
|
56 | }; |
|
|
57 | |
|
|
58 | *{"$class\::set_$sub"} = sub { |
|
|
59 | $_[0]->set_property ($type, $idx, $_[1]); |
|
|
60 | } unless $ignore_set{$prop}; |
|
|
61 | } |
|
|
62 | } |
|
|
63 | |
|
|
64 | # auto-generate most of the API |
|
|
65 | |
|
|
66 | prop_gen OBJECT_PROP => "cf::object"; |
|
|
67 | # CFAPI_OBJECT_ANIMATION? |
|
|
68 | prop_gen PLAYER_PROP => "cf::object::player"; |
|
|
69 | |
|
|
70 | prop_gen MAP_PROP => "cf::map"; |
|
|
71 | prop_gen ARCH_PROP => "cf::arch"; |
|
|
72 | |
|
|
73 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
84 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
74 | |
85 | |
75 | # 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 |
76 | # within the Safe compartment. |
87 | # within the Safe compartment. |
77 | for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { |
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 | )) { |
78 | no strict 'refs'; |
95 | no strict 'refs'; |
79 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
96 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
80 | } |
97 | } |
81 | |
98 | |
82 | $Event::DIED = sub { |
99 | $Event::DIED = sub { |
… | |
… | |
84 | }; |
101 | }; |
85 | |
102 | |
86 | my %ext_pkg; |
103 | my %ext_pkg; |
87 | my @exts; |
104 | my @exts; |
88 | my @hook; |
105 | my @hook; |
89 | my %command; |
|
|
90 | my %extcmd; |
|
|
91 | |
106 | |
92 | ############################################################################# |
107 | =head2 UTILITY FUNCTIONS |
93 | # utility functions |
108 | |
|
|
109 | =over 4 |
|
|
110 | |
|
|
111 | =cut |
94 | |
112 | |
95 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
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 |
96 | |
120 | |
97 | sub from_json($) { |
121 | sub from_json($) { |
98 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
122 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
99 | JSON::Syck::Load $_[0] |
123 | JSON::Syck::Load $_[0] |
100 | } |
124 | } |
101 | |
125 | |
|
|
126 | =item $json = cf::to_json $ref |
|
|
127 | |
|
|
128 | Converts a perl data structure into its JSON representation. |
|
|
129 | |
|
|
130 | =cut |
|
|
131 | |
102 | sub to_json($) { |
132 | sub to_json($) { |
103 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
133 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
104 | JSON::Syck::Dump $_[0] |
134 | JSON::Syck::Dump $_[0] |
105 | } |
135 | } |
106 | |
136 | |
|
|
137 | =back |
|
|
138 | |
|
|
139 | =cut |
|
|
140 | |
107 | ############################################################################# |
141 | ############################################################################# |
108 | # "new" plug-in system |
|
|
109 | |
142 | |
110 | =head3 EVENTS AND OBJECT ATTACHMENTS |
143 | =head2 ATTACHABLE OBJECTS |
|
|
144 | |
|
|
145 | Many objects in crossfire are so-called attachable objects. That means you can |
|
|
146 | attach callbacks/event handlers (a collection of which is called an "attachment") |
|
|
147 | to it. All such attachable objects support the following methods. |
|
|
148 | |
|
|
149 | In the following description, CLASS can be any of C<global>, C<object> |
|
|
150 | C<player>, C<client> or C<map> (i.e. the attachable objects in |
|
|
151 | crossfire+). |
111 | |
152 | |
112 | =over 4 |
153 | =over 4 |
113 | |
154 | |
114 | =item $object->attach ($attachment, key => $value...) |
|
|
115 | |
|
|
116 | =item $object->detach ($attachment) |
|
|
117 | |
|
|
118 | Attach/detach a pre-registered attachment to an object. |
|
|
119 | |
|
|
120 | =item $player->attach ($attachment, key => $value...) |
|
|
121 | |
|
|
122 | =item $player->detach ($attachment) |
|
|
123 | |
|
|
124 | Attach/detach a pre-registered attachment to a player. |
|
|
125 | |
|
|
126 | =item $map->attach ($attachment, key => $value...) |
155 | =item $attachable->attach ($attachment, key => $value...) |
127 | |
156 | |
128 | =item $map->detach ($attachment) |
157 | =item $attachable->detach ($attachment) |
129 | |
158 | |
130 | Attach/detach a pre-registered attachment to a map. |
159 | Attach/detach a pre-registered attachment to a specific object and give it |
|
|
160 | the specified key/value pairs as arguments. |
131 | |
161 | |
132 | =item $bool = $object->attached ($name) |
162 | Example, attach a minesweeper attachment to the given object, making it a |
|
|
163 | 10x10 minesweeper game: |
133 | |
164 | |
134 | =item $bool = $player->attached ($name) |
165 | $obj->attach (minesweeper => width => 10, height => 10); |
135 | |
166 | |
136 | =item $bool = $map->attached ($name) |
167 | =item $bool = $attachable->attached ($name) |
137 | |
168 | |
138 | Checks wether the named attachment is currently attached to the object. |
169 | Checks wether the named attachment is currently attached to the object. |
139 | |
170 | |
140 | =item cf::attach_global ... |
171 | =item cf::CLASS->attach ... |
141 | |
172 | |
142 | Attach handlers for global events. |
173 | =item cf::CLASS->detach ... |
143 | |
174 | |
144 | This and all following C<attach_*>-functions expect any number of the |
175 | Define an anonymous attachment and attach it to all objects of the given |
145 | following handler/hook descriptions: |
176 | CLASS. See the next function for an explanation of its arguments. |
|
|
177 | |
|
|
178 | You can attach to global events by using the C<cf::global> class. |
|
|
179 | |
|
|
180 | Example, log all player logins: |
|
|
181 | |
|
|
182 | cf::player->attach ( |
|
|
183 | on_login => sub { |
|
|
184 | my ($pl) = @_; |
|
|
185 | ... |
|
|
186 | }, |
|
|
187 | ); |
|
|
188 | |
|
|
189 | Example, attach to the jeweler skill: |
|
|
190 | |
|
|
191 | cf::object->attach ( |
|
|
192 | type => cf::SKILL, |
|
|
193 | subtype => cf::SK_JEWELER, |
|
|
194 | on_use_skill => sub { |
|
|
195 | my ($sk, $ob, $part, $dir, $msg) = @_; |
|
|
196 | ... |
|
|
197 | }, |
|
|
198 | ); |
|
|
199 | |
|
|
200 | =item cf::CLASS::attachment $name, ... |
|
|
201 | |
|
|
202 | Register an attachment by C<$name> through which attachable objects of the |
|
|
203 | given CLASS can refer to this attachment. |
|
|
204 | |
|
|
205 | Some classes such as crossfire maps and objects can specify attachments |
|
|
206 | that are attached at load/instantiate time, thus the need for a name. |
|
|
207 | |
|
|
208 | These calls expect any number of the following handler/hook descriptions: |
146 | |
209 | |
147 | =over 4 |
210 | =over 4 |
148 | |
211 | |
149 | =item prio => $number |
212 | =item prio => $number |
150 | |
213 | |
… | |
… | |
152 | by another C<prio> setting). Lower priority handlers get executed |
215 | by another C<prio> setting). Lower priority handlers get executed |
153 | earlier. The default priority is C<0>, and many built-in handlers are |
216 | earlier. The default priority is C<0>, and many built-in handlers are |
154 | registered at priority C<-1000>, so lower priorities should not be used |
217 | registered at priority C<-1000>, so lower priorities should not be used |
155 | unless you know what you are doing. |
218 | unless you know what you are doing. |
156 | |
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 | |
157 | =item on_I<event> => \&cb |
226 | =item on_I<event> => \&cb |
158 | |
227 | |
159 | Call the given code reference whenever the named event happens (event is |
228 | Call the given code reference whenever the named event happens (event is |
160 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
229 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
161 | handlers are recognised generally depends on the type of object these |
230 | handlers are recognised generally depends on the type of object these |
… | |
… | |
170 | package and register them. Only handlers for eevents supported by the |
239 | package and register them. Only handlers for eevents supported by the |
171 | object/class are recognised. |
240 | object/class are recognised. |
172 | |
241 | |
173 | =back |
242 | =back |
174 | |
243 | |
175 | =item cf::attach_to_type $object_type, $subtype, ... |
244 | Example, define an attachment called "sockpuppet" that calls the given |
|
|
245 | event handler when a monster attacks: |
176 | |
246 | |
177 | Attach handlers for a specific object type (e.g. TRANSPORT) and |
247 | cf::object::attachment sockpuppet => |
178 | subtype. If C<$subtype> is zero or undef, matches all objects of the given |
248 | on_skill_attack => sub { |
179 | type. |
249 | my ($self, $victim) = @_; |
180 | |
250 | ... |
181 | =item cf::attach_to_objects ... |
251 | } |
182 | |
252 | } |
183 | Attach handlers to all objects. Do not use this except for debugging or |
|
|
184 | very rare events, as handlers are (obviously) called for I<all> objects in |
|
|
185 | the game. |
|
|
186 | |
|
|
187 | =item cf::attach_to_players ... |
|
|
188 | |
|
|
189 | Attach handlers to all players. |
|
|
190 | |
|
|
191 | =item cf::attach_to_maps ... |
|
|
192 | |
|
|
193 | Attach handlers to all maps. |
|
|
194 | |
|
|
195 | =item cf:register_attachment $name, ... |
|
|
196 | |
|
|
197 | Register an attachment by name through which objects can refer to this |
|
|
198 | attachment. |
|
|
199 | |
|
|
200 | =item cf:register_player_attachment $name, ... |
|
|
201 | |
|
|
202 | Register an attachment by name through which players can refer to this |
|
|
203 | attachment. |
|
|
204 | |
|
|
205 | =item cf:register_map_attachment $name, ... |
|
|
206 | |
|
|
207 | Register an attachment by name through which maps can refer to this |
|
|
208 | attachment. |
|
|
209 | |
253 | |
210 | =cut |
254 | =cut |
211 | |
255 | |
212 | # 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 |
213 | our @CB_GLOBAL = (); # registry for all global events |
257 | our @CB_GLOBAL = (); # registry for all global events |
214 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
258 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
215 | our @CB_PLAYER = (); |
259 | our @CB_PLAYER = (); |
|
|
260 | our @CB_CLIENT = (); |
216 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
261 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
217 | our @CB_MAP = (); |
262 | our @CB_MAP = (); |
218 | |
263 | |
219 | my %attachment; |
264 | my %attachment; |
220 | |
265 | |
221 | sub _attach_cb($\%$$$) { |
266 | sub _attach_cb($$$$) { |
222 | my ($registry, $undo, $event, $prio, $cb) = @_; |
267 | my ($registry, $event, $prio, $cb) = @_; |
223 | |
268 | |
224 | use sort 'stable'; |
269 | use sort 'stable'; |
225 | |
270 | |
226 | $cb = [$prio, $cb]; |
271 | $cb = [$prio, $cb]; |
227 | |
272 | |
228 | @{$registry->[$event]} = sort |
273 | @{$registry->[$event]} = sort |
229 | { $a->[0] cmp $b->[0] } |
274 | { $a->[0] cmp $b->[0] } |
230 | @{$registry->[$event] || []}, $cb; |
275 | @{$registry->[$event] || []}, $cb; |
231 | |
|
|
232 | push @{$undo->{cb}}, [$event, $cb]; |
|
|
233 | } |
276 | } |
234 | |
277 | |
235 | # attach handles attaching event callbacks |
278 | # attach handles attaching event callbacks |
236 | # 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 |
237 | # registry (== where the callback attaches to). |
280 | # registry (== where the callback attaches to). |
238 | sub _attach(\@$@) { |
281 | sub _attach { |
239 | my ($registry, $klass, @arg) = @_; |
282 | my ($registry, $klass, @arg) = @_; |
240 | |
283 | |
|
|
284 | my $object_type; |
241 | my $prio = 0; |
285 | my $prio = 0; |
242 | |
|
|
243 | my %undo = ( |
|
|
244 | registry => $registry, |
|
|
245 | cb => [], |
|
|
246 | ); |
|
|
247 | |
|
|
248 | 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; |
249 | |
287 | |
250 | while (@arg) { |
288 | while (@arg) { |
251 | my $type = shift @arg; |
289 | my $type = shift @arg; |
252 | |
290 | |
253 | if ($type eq "prio") { |
291 | if ($type eq "prio") { |
254 | $prio = shift @arg; |
292 | $prio = shift @arg; |
255 | |
293 | |
|
|
294 | } elsif ($type eq "type") { |
|
|
295 | $object_type = shift @arg; |
|
|
296 | $registry = $CB_TYPE[$object_type] ||= []; |
|
|
297 | |
|
|
298 | } elsif ($type eq "subtype") { |
|
|
299 | defined $object_type or Carp::croak "subtype specified without type"; |
|
|
300 | my $object_subtype = shift @arg; |
|
|
301 | $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; |
|
|
302 | |
256 | } elsif ($type eq "package") { |
303 | } elsif ($type eq "package") { |
257 | my $pkg = shift @arg; |
304 | my $pkg = shift @arg; |
258 | |
305 | |
259 | while (my ($name, $id) = each %cb_id) { |
306 | while (my ($name, $id) = each %cb_id) { |
260 | if (my $cb = $pkg->can ($name)) { |
307 | if (my $cb = $pkg->can ($name)) { |
261 | _attach_cb $registry, %undo, $id, $prio, $cb; |
308 | _attach_cb $registry, $id, $prio, $cb; |
262 | } |
309 | } |
263 | } |
310 | } |
264 | |
311 | |
265 | } elsif (exists $cb_id{$type}) { |
312 | } elsif (exists $cb_id{$type}) { |
266 | _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; |
313 | _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; |
267 | |
314 | |
268 | } elsif (ref $type) { |
315 | } elsif (ref $type) { |
269 | warn "attaching objects not supported, ignoring.\n"; |
316 | warn "attaching objects not supported, ignoring.\n"; |
270 | |
317 | |
271 | } else { |
318 | } else { |
272 | shift @arg; |
319 | shift @arg; |
273 | warn "attach argument '$type' not supported, ignoring.\n"; |
320 | warn "attach argument '$type' not supported, ignoring.\n"; |
274 | } |
321 | } |
275 | } |
322 | } |
276 | |
|
|
277 | \%undo |
|
|
278 | } |
323 | } |
279 | |
324 | |
280 | sub _attach_attachment { |
325 | sub _object_attach { |
281 | my ($obj, $name, %arg) = @_; |
326 | my ($obj, $name, %arg) = @_; |
282 | |
327 | |
283 | return if exists $obj->{_attachment}{$name}; |
328 | return if exists $obj->{_attachment}{$name}; |
284 | |
|
|
285 | my $res; |
|
|
286 | |
329 | |
287 | if (my $attach = $attachment{$name}) { |
330 | if (my $attach = $attachment{$name}) { |
288 | my $registry = $obj->registry; |
331 | my $registry = $obj->registry; |
289 | |
332 | |
290 | for (@$attach) { |
333 | for (@$attach) { |
291 | my ($klass, @attach) = @$_; |
334 | my ($klass, @attach) = @$_; |
292 | $res = _attach @$registry, $klass, @attach; |
335 | _attach $registry, $klass, @attach; |
293 | } |
336 | } |
294 | |
337 | |
295 | $obj->{$name} = \%arg; |
338 | $obj->{$name} = \%arg; |
296 | } else { |
339 | } else { |
297 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
340 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
298 | } |
341 | } |
299 | |
342 | |
300 | $obj->{_attachment}{$name} = undef; |
343 | $obj->{_attachment}{$name} = undef; |
301 | |
|
|
302 | $res->{attachment} = $name; |
|
|
303 | $res |
|
|
304 | } |
344 | } |
305 | |
345 | |
306 | *cf::object::attach = |
346 | sub cf::attachable::attach { |
307 | *cf::player::attach = |
347 | if (ref $_[0]) { |
308 | *cf::map::attach = sub { |
348 | _object_attach @_; |
309 | my ($obj, $name, %arg) = @_; |
349 | } else { |
310 | |
350 | _attach shift->_attach_registry, @_; |
311 | _attach_attachment $obj, $name, %arg; |
351 | } |
312 | }; |
352 | }; |
313 | |
353 | |
314 | # all those should be optimised |
354 | # all those should be optimised |
315 | *cf::object::detach = |
355 | sub cf::attachable::detach { |
316 | *cf::player::detach = |
|
|
317 | *cf::map::detach = sub { |
|
|
318 | my ($obj, $name) = @_; |
356 | my ($obj, $name) = @_; |
319 | |
357 | |
|
|
358 | if (ref $obj) { |
320 | delete $obj->{_attachment}{$name}; |
359 | delete $obj->{_attachment}{$name}; |
321 | reattach ($obj); |
360 | reattach ($obj); |
|
|
361 | } else { |
|
|
362 | Carp::croak "cannot, currently, detach class attachments"; |
|
|
363 | } |
322 | }; |
364 | }; |
323 | |
365 | |
324 | *cf::object::attached = |
366 | sub cf::attachable::attached { |
325 | *cf::player::attached = |
|
|
326 | *cf::map::attached = sub { |
|
|
327 | my ($obj, $name) = @_; |
367 | my ($obj, $name) = @_; |
328 | |
368 | |
329 | exists $obj->{_attachment}{$name} |
369 | exists $obj->{_attachment}{$name} |
330 | }; |
|
|
331 | |
|
|
332 | sub attach_global { |
|
|
333 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
|
|
334 | } |
370 | } |
335 | |
371 | |
336 | sub attach_to_type { |
372 | for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) { |
337 | my $type = shift; |
373 | eval "#line " . __LINE__ . " 'cf.pm' |
338 | my $subtype = shift; |
374 | sub cf::\L$klass\E::_attach_registry { |
|
|
375 | (\\\@CB_$klass, KLASS_$klass) |
|
|
376 | } |
339 | |
377 | |
340 | _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ |
378 | sub cf::\L$klass\E::attachment { |
341 | } |
|
|
342 | |
|
|
343 | sub attach_to_objects { |
|
|
344 | _attach @CB_OBJECT, KLASS_OBJECT, @_ |
|
|
345 | } |
|
|
346 | |
|
|
347 | sub attach_to_players { |
|
|
348 | _attach @CB_PLAYER, KLASS_PLAYER, @_ |
|
|
349 | } |
|
|
350 | |
|
|
351 | sub attach_to_maps { |
|
|
352 | _attach @CB_MAP, KLASS_MAP, @_ |
|
|
353 | } |
|
|
354 | |
|
|
355 | sub register_attachment { |
|
|
356 | my $name = shift; |
379 | my \$name = shift; |
357 | |
380 | |
358 | $attachment{$name} = [[KLASS_OBJECT, @_]]; |
|
|
359 | } |
|
|
360 | |
|
|
361 | sub register_player_attachment { |
|
|
362 | my $name = shift; |
|
|
363 | |
|
|
364 | $attachment{$name} = [[KLASS_PLAYER, @_]]; |
|
|
365 | } |
|
|
366 | |
|
|
367 | sub register_map_attachment { |
|
|
368 | my $name = shift; |
|
|
369 | |
|
|
370 | $attachment{$name} = [[KLASS_MAP, @_]]; |
381 | \$attachment{\$name} = [[KLASS_$klass, \@_]]; |
|
|
382 | } |
|
|
383 | "; |
|
|
384 | die if $@; |
371 | } |
385 | } |
372 | |
386 | |
373 | our $override; |
387 | our $override; |
374 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
388 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
375 | |
389 | |
… | |
… | |
389 | for (@$callbacks) { |
403 | for (@$callbacks) { |
390 | eval { &{$_->[1]} }; |
404 | eval { &{$_->[1]} }; |
391 | |
405 | |
392 | if ($@) { |
406 | if ($@) { |
393 | warn "$@"; |
407 | warn "$@"; |
394 | warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; |
408 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
395 | override; |
409 | override; |
396 | } |
410 | } |
397 | |
411 | |
398 | return 1 if $override; |
412 | return 1 if $override; |
399 | } |
413 | } |
… | |
… | |
404 | =item $bool = cf::invoke EVENT_GLOBAL_XXX, ... |
418 | =item $bool = cf::invoke EVENT_GLOBAL_XXX, ... |
405 | |
419 | |
406 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
420 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
407 | |
421 | |
408 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
422 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
|
|
423 | |
|
|
424 | =item $bool = $client->invoke (EVENT_CLIENT_XXX, ...) |
409 | |
425 | |
410 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
426 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
411 | |
427 | |
412 | Generate a global/object/player/map-specific event with the given arguments. |
428 | Generate a global/object/player/map-specific event with the given arguments. |
413 | |
429 | |
… | |
… | |
415 | removed in future versions), and there is no public API to access override |
431 | removed in future versions), and there is no public API to access override |
416 | results (if you must, access C<@cf::invoke_results> directly). |
432 | results (if you must, access C<@cf::invoke_results> directly). |
417 | |
433 | |
418 | =back |
434 | =back |
419 | |
435 | |
420 | =head2 methods valid for all pointers |
436 | =cut |
|
|
437 | |
|
|
438 | ############################################################################# |
|
|
439 | |
|
|
440 | =head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS |
|
|
441 | |
|
|
442 | Attachable objects includes objects, players, clients and maps. |
421 | |
443 | |
422 | =over 4 |
444 | =over 4 |
423 | |
445 | |
424 | =item $object->valid |
446 | =item $object->valid |
425 | |
|
|
426 | =item $player->valid |
|
|
427 | |
|
|
428 | =item $map->valid |
|
|
429 | |
447 | |
430 | Just because you have a perl object does not mean that the corresponding |
448 | Just because you have a perl object does not mean that the corresponding |
431 | C-level object still exists. If you try to access an object that has no |
449 | C-level object still exists. If you try to access an object that has no |
432 | valid C counterpart anymore you get an exception at runtime. This method |
450 | valid C counterpart anymore you get an exception at runtime. This method |
433 | can be used to test for existence of the C object part without causing an |
451 | can be used to test for existence of the C object part without causing an |
… | |
… | |
435 | |
453 | |
436 | =back |
454 | =back |
437 | |
455 | |
438 | =cut |
456 | =cut |
439 | |
457 | |
440 | *cf::object::valid = |
|
|
441 | *cf::player::valid = |
|
|
442 | *cf::map::valid = \&cf::_valid; |
|
|
443 | |
|
|
444 | ############################################################################# |
458 | ############################################################################# |
445 | # object support |
459 | # object support |
446 | |
460 | |
447 | sub instantiate { |
461 | sub instantiate { |
448 | my ($obj, $data) = @_; |
462 | my ($obj, $data) = @_; |
… | |
… | |
467 | |
481 | |
468 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
482 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
469 | if (my $attach = $attachment{$name}) { |
483 | if (my $attach = $attachment{$name}) { |
470 | for (@$attach) { |
484 | for (@$attach) { |
471 | my ($klass, @attach) = @$_; |
485 | my ($klass, @attach) = @$_; |
472 | _attach @$registry, $klass, @attach; |
486 | _attach $registry, $klass, @attach; |
473 | } |
487 | } |
474 | } else { |
488 | } else { |
475 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
489 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
476 | } |
490 | } |
477 | } |
491 | } |
… | |
… | |
506 | unlink $filename; |
520 | unlink $filename; |
507 | unlink "$filename.pst"; |
521 | unlink "$filename.pst"; |
508 | } |
522 | } |
509 | } |
523 | } |
510 | |
524 | |
|
|
525 | sub object_freezer_as_string { |
|
|
526 | my ($rdata, $objs) = @_; |
|
|
527 | |
|
|
528 | use Data::Dumper; |
|
|
529 | |
|
|
530 | $$rdata . Dumper $objs |
|
|
531 | } |
|
|
532 | |
511 | sub object_thawer_load { |
533 | sub object_thawer_load { |
512 | my ($filename) = @_; |
534 | my ($filename) = @_; |
513 | |
535 | |
514 | local $/; |
536 | local $/; |
515 | |
537 | |
… | |
… | |
525 | } |
547 | } |
526 | |
548 | |
527 | () |
549 | () |
528 | } |
550 | } |
529 | |
551 | |
530 | attach_to_objects |
552 | cf::object->attach ( |
531 | prio => -1000000, |
553 | prio => -1000000, |
532 | on_clone => sub { |
554 | on_clone => sub { |
533 | my ($src, $dst) = @_; |
555 | my ($src, $dst) = @_; |
534 | |
556 | |
535 | @{$dst->registry} = @{$src->registry}; |
557 | @{$dst->registry} = @{$src->registry}; |
… | |
… | |
537 | %$dst = %$src; |
559 | %$dst = %$src; |
538 | |
560 | |
539 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
561 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
540 | if exists $src->{_attachment}; |
562 | if exists $src->{_attachment}; |
541 | }, |
563 | }, |
542 | ; |
564 | ); |
543 | |
565 | |
544 | ############################################################################# |
566 | ############################################################################# |
545 | # old plug-in events |
567 | # command handling &c |
546 | |
568 | |
547 | sub inject_event { |
569 | =item cf::register_command $name => \&callback($ob,$args); |
548 | my $extension = shift; |
|
|
549 | my $event_code = shift; |
|
|
550 | |
570 | |
551 | my $cb = $hook[$event_code]{$extension} |
571 | Register a callback for execution when the client sends the user command |
552 | or return; |
572 | $name. |
553 | |
573 | |
554 | &$cb |
574 | =cut |
555 | } |
|
|
556 | |
|
|
557 | sub inject_global_event { |
|
|
558 | my $event = shift; |
|
|
559 | |
|
|
560 | my $cb = $hook[$event] |
|
|
561 | or return; |
|
|
562 | |
|
|
563 | List::Util::max map &$_, values %$cb |
|
|
564 | } |
|
|
565 | |
|
|
566 | sub inject_command { |
|
|
567 | my ($name, $obj, $params) = @_; |
|
|
568 | |
|
|
569 | for my $cmd (@{ $command{$name} }) { |
|
|
570 | $cmd->[1]->($obj, $params); |
|
|
571 | } |
|
|
572 | |
|
|
573 | -1 |
|
|
574 | } |
|
|
575 | |
575 | |
576 | sub register_command { |
576 | sub register_command { |
577 | my ($name, $time, $cb) = @_; |
577 | my ($name, $cb) = @_; |
578 | |
578 | |
579 | my $caller = caller; |
579 | my $caller = caller; |
580 | #warn "registering command '$name/$time' to '$caller'"; |
580 | #warn "registering command '$name/$time' to '$caller'"; |
581 | |
581 | |
582 | push @{ $command{$name} }, [$time, $cb, $caller]; |
582 | push @{ $COMMAND{$name} }, [$caller, $cb]; |
583 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
|
|
584 | } |
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 |
585 | |
593 | |
586 | sub register_extcmd { |
594 | sub register_extcmd { |
587 | my ($name, $cb) = @_; |
595 | my ($name, $cb) = @_; |
588 | |
596 | |
589 | my $caller = caller; |
597 | my $caller = caller; |
590 | #warn "registering extcmd '$name' to '$caller'"; |
598 | #warn "registering extcmd '$name' to '$caller'"; |
591 | |
599 | |
592 | $extcmd{$name} = [$cb, $caller]; |
600 | $EXTCMD{$name} = [$cb, $caller]; |
593 | } |
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 | ); |
594 | |
634 | |
595 | sub register { |
635 | sub register { |
596 | my ($base, $pkg) = @_; |
636 | my ($base, $pkg) = @_; |
597 | |
637 | |
598 | #TODO |
638 | #TODO |
… | |
… | |
617 | . "#line 1 \"$path\"\n{\n" |
657 | . "#line 1 \"$path\"\n{\n" |
618 | . (do { local $/; <$fh> }) |
658 | . (do { local $/; <$fh> }) |
619 | . "\n};\n1"; |
659 | . "\n};\n1"; |
620 | |
660 | |
621 | eval $source |
661 | eval $source |
622 | or die "$path: $@"; |
662 | or die $@ ? "$path: $@\n" |
|
|
663 | : "extension disabled.\n"; |
623 | |
664 | |
624 | push @exts, $pkg; |
665 | push @exts, $pkg; |
625 | $ext_pkg{$base} = $pkg; |
666 | $ext_pkg{$base} = $pkg; |
626 | |
667 | |
627 | # no strict 'refs'; |
668 | # no strict 'refs'; |
… | |
… | |
640 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
681 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
641 | # delete $hook[$idx]{$pkg}; |
682 | # delete $hook[$idx]{$pkg}; |
642 | # } |
683 | # } |
643 | |
684 | |
644 | # remove commands |
685 | # remove commands |
645 | for my $name (keys %command) { |
686 | for my $name (keys %COMMAND) { |
646 | my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; |
687 | my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; |
647 | |
688 | |
648 | if (@cb) { |
689 | if (@cb) { |
649 | $command{$name} = \@cb; |
690 | $COMMAND{$name} = \@cb; |
650 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; |
|
|
651 | } else { |
691 | } else { |
652 | delete $command{$name}; |
|
|
653 | delete $COMMAND{"$name\000"}; |
692 | delete $COMMAND{$name}; |
654 | } |
693 | } |
655 | } |
694 | } |
656 | |
695 | |
657 | # remove extcmds |
696 | # remove extcmds |
658 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
697 | for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { |
659 | delete $extcmd{$name}; |
698 | delete $EXTCMD{$name}; |
660 | } |
699 | } |
661 | |
700 | |
662 | if (my $cb = $pkg->can ("unload")) { |
701 | if (my $cb = $pkg->can ("unload")) { |
663 | eval { |
702 | eval { |
664 | $cb->($pkg); |
703 | $cb->($pkg); |
… | |
… | |
668 | |
707 | |
669 | Symbol::delete_package $pkg; |
708 | Symbol::delete_package $pkg; |
670 | } |
709 | } |
671 | |
710 | |
672 | sub load_extensions { |
711 | sub load_extensions { |
673 | my $LIBDIR = maps_directory "perl"; |
|
|
674 | |
|
|
675 | for my $ext (<$LIBDIR/*.ext>) { |
712 | for my $ext (<$LIBDIR/*.ext>) { |
676 | next unless -r $ext; |
713 | next unless -r $ext; |
677 | eval { |
714 | eval { |
678 | load_extension $ext; |
715 | load_extension $ext; |
679 | 1 |
716 | 1 |
680 | } or warn "$ext not loaded: $@"; |
717 | } or warn "$ext not loaded: $@"; |
681 | } |
718 | } |
682 | } |
719 | } |
683 | |
720 | |
684 | sub _perl_reload(&) { |
|
|
685 | my ($msg) = @_; |
|
|
686 | |
|
|
687 | $msg->("reloading..."); |
|
|
688 | |
|
|
689 | eval { |
|
|
690 | # 1. cancel all watchers |
|
|
691 | $_->cancel for Event::all_watchers; |
|
|
692 | |
|
|
693 | # 2. unload all extensions |
|
|
694 | for (@exts) { |
|
|
695 | $msg->("unloading <$_>"); |
|
|
696 | unload_extension $_; |
|
|
697 | } |
|
|
698 | |
|
|
699 | # 3. unload all modules loaded from $LIBDIR |
|
|
700 | while (my ($k, $v) = each %INC) { |
|
|
701 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
702 | |
|
|
703 | $msg->("removing <$k>"); |
|
|
704 | delete $INC{$k}; |
|
|
705 | |
|
|
706 | $k =~ s/\.pm$//; |
|
|
707 | $k =~ s/\//::/g; |
|
|
708 | |
|
|
709 | if (my $cb = $k->can ("unload_module")) { |
|
|
710 | $cb->(); |
|
|
711 | } |
|
|
712 | |
|
|
713 | Symbol::delete_package $k; |
|
|
714 | } |
|
|
715 | |
|
|
716 | # 4. get rid of safe::, as good as possible |
|
|
717 | Symbol::delete_package "safe::$_" |
|
|
718 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
|
|
719 | |
|
|
720 | # 5. remove register_script_function callbacks |
|
|
721 | # TODO |
|
|
722 | |
|
|
723 | # 6. unload cf.pm "a bit" |
|
|
724 | delete $INC{"cf.pm"}; |
|
|
725 | |
|
|
726 | # don't, removes xs symbols, too, |
|
|
727 | # and global variables created in xs |
|
|
728 | #Symbol::delete_package __PACKAGE__; |
|
|
729 | |
|
|
730 | # 7. reload cf.pm |
|
|
731 | $msg->("reloading cf.pm"); |
|
|
732 | require cf; |
|
|
733 | |
|
|
734 | $msg->("load extensions"); |
|
|
735 | cf::load_extensions; |
|
|
736 | }; |
|
|
737 | $msg->($@) if $@; |
|
|
738 | |
|
|
739 | $msg->("reloaded"); |
|
|
740 | }; |
|
|
741 | |
|
|
742 | sub perl_reload() { |
|
|
743 | _perl_reload { |
|
|
744 | warn $_[0]; |
|
|
745 | print "$_[0]\n"; |
|
|
746 | }; |
|
|
747 | } |
|
|
748 | |
|
|
749 | register_command "perl-reload", 0, sub { |
|
|
750 | my ($who, $arg) = @_; |
|
|
751 | |
|
|
752 | if ($who->flag (FLAG_WIZ)) { |
|
|
753 | _perl_reload { |
|
|
754 | warn $_[0]; |
|
|
755 | $who->message ($_[0]); |
|
|
756 | }; |
|
|
757 | } |
|
|
758 | }; |
|
|
759 | |
|
|
760 | ############################################################################# |
|
|
761 | # extcmd framework, basically convert ext <msg> |
|
|
762 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
763 | |
|
|
764 | attach_to_players |
|
|
765 | on_extcmd => sub { |
|
|
766 | my ($pl, $buf) = @_; |
|
|
767 | |
|
|
768 | my $msg = eval { from_json $buf }; |
|
|
769 | |
|
|
770 | if (ref $msg) { |
|
|
771 | if (my $cb = $extcmd{$msg->{msgtype}}) { |
|
|
772 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
773 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
774 | } |
|
|
775 | } |
|
|
776 | } else { |
|
|
777 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
778 | } |
|
|
779 | |
|
|
780 | cf::override; |
|
|
781 | }, |
|
|
782 | ; |
|
|
783 | |
|
|
784 | ############################################################################# |
721 | ############################################################################# |
785 | # load/save/clean perl data associated with a map |
722 | # load/save/clean perl data associated with a map |
786 | |
723 | |
787 | *cf::mapsupport::on_clean = sub { |
724 | *cf::mapsupport::on_clean = sub { |
788 | my ($map) = @_; |
725 | my ($map) = @_; |
… | |
… | |
791 | defined $path or return; |
728 | defined $path or return; |
792 | |
729 | |
793 | unlink "$path.pst"; |
730 | unlink "$path.pst"; |
794 | }; |
731 | }; |
795 | |
732 | |
796 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
733 | cf::map->attach (prio => -10000, package => cf::mapsupport::); |
797 | |
734 | |
798 | ############################################################################# |
735 | ############################################################################# |
799 | # load/save perl data associated with player->ob objects |
736 | # load/save perl data associated with player->ob objects |
800 | |
737 | |
801 | sub all_objects(@) { |
738 | sub all_objects(@) { |
802 | @_, map all_objects ($_->inv), @_ |
739 | @_, map all_objects ($_->inv), @_ |
803 | } |
740 | } |
804 | |
741 | |
805 | # TODO: compatibility cruft, remove when no longer needed |
742 | # TODO: compatibility cruft, remove when no longer needed |
806 | attach_to_players |
743 | cf::player->attach ( |
807 | on_load => sub { |
744 | on_load => sub { |
808 | my ($pl, $path) = @_; |
745 | my ($pl, $path) = @_; |
809 | |
746 | |
810 | for my $o (all_objects $pl->ob) { |
747 | for my $o (all_objects $pl->ob) { |
811 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
748 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
… | |
… | |
813 | |
750 | |
814 | %$o = %{ Storable::thaw pack "H*", $value }; |
751 | %$o = %{ Storable::thaw pack "H*", $value }; |
815 | } |
752 | } |
816 | } |
753 | } |
817 | }, |
754 | }, |
818 | ; |
755 | ); |
819 | |
756 | |
820 | ############################################################################# |
757 | ############################################################################# |
821 | # 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 |
822 | |
766 | |
823 | =item cf::player::exists $login |
767 | =item cf::player::exists $login |
824 | |
768 | |
825 | Returns true when the given account exists. |
769 | Returns true when the given account exists. |
826 | |
770 | |
… | |
… | |
829 | sub cf::player::exists($) { |
773 | sub cf::player::exists($) { |
830 | cf::player::find $_[0] |
774 | cf::player::find $_[0] |
831 | 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; |
832 | } |
776 | } |
833 | |
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 | |
834 | =item $player->reply ($npc, $msg[, $flags]) |
798 | =item $player_object->reply ($npc, $msg[, $flags]) |
835 | |
799 | |
836 | 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> |
837 | 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 |
838 | dialogue with the given NPC character. |
802 | dialogue with the given NPC character. |
839 | |
803 | |
840 | =cut |
804 | =cut |
841 | |
805 | |
842 | # rough implementation of a future "reply" method that works |
806 | # rough implementation of a future "reply" method that works |
843 | # with dialog boxes. |
807 | # with dialog boxes. |
|
|
808 | #TODO: the first argument must go, split into a $npc->reply_to ( method |
844 | sub cf::object::player::reply($$$;$) { |
809 | sub cf::object::player::reply($$$;$) { |
845 | my ($self, $npc, $msg, $flags) = @_; |
810 | my ($self, $npc, $msg, $flags) = @_; |
846 | |
811 | |
847 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
812 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
848 | |
813 | |
… | |
… | |
852 | $msg = $npc->name . " says: $msg" if $npc; |
817 | $msg = $npc->name . " says: $msg" if $npc; |
853 | $self->message ($msg, $flags); |
818 | $self->message ($msg, $flags); |
854 | } |
819 | } |
855 | } |
820 | } |
856 | |
821 | |
857 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
822 | =item $player_object->may ("access") |
858 | |
823 | |
859 | Sends an ext reply to the player. |
824 | Returns wether the given player is authorized to access resource "access" |
|
|
825 | (e.g. "command_wizcast"). |
860 | |
826 | |
861 | =cut |
827 | =cut |
862 | |
828 | |
863 | sub cf::player::ext_reply($$$%) { |
829 | sub cf::object::player::may { |
864 | my ($self, $id, %msg) = @_; |
830 | my ($self, $access) = @_; |
865 | |
831 | |
866 | $msg{msgid} = $id; |
832 | $self->flag (cf::FLAG_WIZ) || |
867 | |
833 | (ref $cf::CFG{"may_$access"} |
868 | $self->send ("ext " . to_json \%msg); |
834 | ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} |
|
|
835 | : $cf::CFG{"may_$access"}) |
869 | } |
836 | } |
870 | |
837 | |
871 | ############################################################################# |
838 | =head3 cf::client |
872 | # 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 |
873 | |
918 | |
874 | our $safe = new Safe "safe"; |
919 | our $safe = new Safe "safe"; |
875 | our $safe_hole = new Safe::Hole; |
920 | our $safe_hole = new Safe::Hole; |
876 | |
921 | |
877 | $SIG{FPE} = 'IGNORE'; |
922 | $SIG{FPE} = 'IGNORE'; |
878 | |
923 | |
879 | $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)); |
880 | |
925 | |
881 | # here we export the classes and methods available to script code |
926 | # here we export the classes and methods available to script code |
882 | |
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 | |
883 | for ( |
939 | for ( |
884 | ["cf::object" => qw(contr pay_amount pay_player)], |
940 | ["cf::object" => qw(contr pay_amount pay_player map)], |
885 | ["cf::object::player" => qw(player)], |
941 | ["cf::object::player" => qw(player)], |
886 | ["cf::player" => qw(peaceful)], |
942 | ["cf::player" => qw(peaceful)], |
|
|
943 | ["cf::map" => qw(trigger)], |
887 | ) { |
944 | ) { |
888 | no strict 'refs'; |
945 | no strict 'refs'; |
889 | my ($pkg, @funs) = @$_; |
946 | my ($pkg, @funs) = @$_; |
890 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
947 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
891 | for @funs; |
948 | for @funs; |
892 | } |
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 |
893 | |
962 | |
894 | sub safe_eval($;@) { |
963 | sub safe_eval($;@) { |
895 | my ($code, %vars) = @_; |
964 | my ($code, %vars) = @_; |
896 | |
965 | |
897 | my $qcode = $code; |
966 | my $qcode = $code; |
… | |
… | |
920 | } |
989 | } |
921 | |
990 | |
922 | wantarray ? @res : $res[0] |
991 | wantarray ? @res : $res[0] |
923 | } |
992 | } |
924 | |
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 | |
925 | sub register_script_function { |
1009 | sub register_script_function { |
926 | my ($fun, $cb) = @_; |
1010 | my ($fun, $cb) = @_; |
927 | |
1011 | |
928 | no strict 'refs'; |
1012 | no strict 'refs'; |
929 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
1013 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
930 | } |
1014 | } |
931 | |
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 | |
932 | ############################################################################# |
1125 | ############################################################################# |
933 | # the server's main() |
1126 | # the server's main() |
934 | |
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 | |
935 | sub main { |
1136 | sub main { |
|
|
1137 | cfg_load; |
|
|
1138 | db_load; |
936 | load_extensions; |
1139 | load_extensions; |
937 | Event::loop; |
1140 | Event::loop; |
938 | } |
1141 | } |
939 | |
1142 | |
940 | ############################################################################# |
1143 | ############################################################################# |
941 | # initialisation |
1144 | # initialisation |
942 | |
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 | |
943 | register "<global>", __PACKAGE__; |
1225 | register "<global>", __PACKAGE__; |
944 | |
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 | |
945 | unshift @INC, $LIBDIR; |
1238 | unshift @INC, $LIBDIR; |
946 | |
1239 | |
947 | $TICK_WATCHER = Event->timer ( |
1240 | $TICK_WATCHER = Event->timer ( |
948 | prio => 1, |
1241 | prio => 0, |
949 | at => $NEXT_TICK || 1, |
1242 | at => $NEXT_TICK || 1, |
|
|
1243 | data => WF_AUTOCANCEL, |
950 | cb => sub { |
1244 | cb => sub { |
951 | cf::server_tick; # one server iteration |
1245 | cf::server_tick; # one server iteration |
952 | |
1246 | |
953 | my $NOW = Event::time; |
1247 | my $NOW = Event::time; |
954 | $NEXT_TICK += $TICK; |
1248 | $NEXT_TICK += $TICK; |
955 | |
1249 | |
956 | # if we are delayed by four ticks, skip them all |
1250 | # if we are delayed by four ticks or more, skip them all |
957 | $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; |
1251 | $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; |
958 | |
1252 | |
959 | $TICK_WATCHER->at ($NEXT_TICK); |
1253 | $TICK_WATCHER->at ($NEXT_TICK); |
960 | $TICK_WATCHER->start; |
1254 | $TICK_WATCHER->start; |
961 | }, |
1255 | }, |
962 | ); |
1256 | ); |
963 | |
1257 | |
964 | _reload_2; |
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); |
965 | |
1265 | |
966 | 1 |
1266 | 1 |
967 | |
1267 | |