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