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; |
|
|
21 | use IO::AIO 2.31 (); |
|
|
22 | use YAML::Syck (); |
10 | use Time::HiRes; |
23 | use Time::HiRes; |
11 | use Event; |
24 | |
12 | $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 |
13 | |
26 | |
14 | use strict; |
27 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
|
|
28 | $YAML::Syck::ImplicitUnicode = 1; |
15 | |
29 | |
16 | _reload_1; |
30 | $Coro::main->prio (2); # run main coroutine ("the server") with very high priority |
17 | |
31 | |
|
|
32 | sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload |
|
|
33 | |
18 | our %COMMAND = (); |
34 | our %COMMAND = (); |
|
|
35 | our %COMMAND_TIME = (); |
|
|
36 | our %EXTCMD = (); |
|
|
37 | |
19 | our @EVENT; |
38 | our @EVENT; |
20 | our $LIBDIR = maps_directory "perl"; |
39 | our $LIBDIR = datadir . "/ext"; |
21 | |
40 | |
22 | our $TICK = MAX_TIME * 1e-6; |
41 | our $TICK = MAX_TIME * 1e-6; |
23 | our $TICK_WATCHER; |
42 | our $TICK_WATCHER; |
24 | our $NEXT_TICK; |
43 | our $NEXT_TICK; |
|
|
44 | our $NOW; |
|
|
45 | |
|
|
46 | our %CFG; |
|
|
47 | |
|
|
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; |
|
|
71 | |
|
|
72 | ############################################################################# |
|
|
73 | |
|
|
74 | =head2 GLOBAL VARIABLES |
|
|
75 | |
|
|
76 | =over 4 |
|
|
77 | |
|
|
78 | =item $cf::UPTIME |
|
|
79 | |
|
|
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. |
|
|
86 | |
|
|
87 | =item $cf::LIBDIR |
|
|
88 | |
|
|
89 | The perl library directory, where extensions and cf-specific modules can |
|
|
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. |
|
|
95 | |
|
|
96 | =item $cf::TICK |
|
|
97 | |
|
|
98 | The interval between server ticks, in seconds. |
|
|
99 | |
|
|
100 | =item %cf::CFG |
|
|
101 | |
|
|
102 | Configuration for the server, loaded from C</etc/crossfire/config>, or |
|
|
103 | from wherever your confdir points to. |
|
|
104 | |
|
|
105 | =back |
|
|
106 | |
|
|
107 | =cut |
25 | |
108 | |
26 | BEGIN { |
109 | BEGIN { |
27 | *CORE::GLOBAL::warn = sub { |
110 | *CORE::GLOBAL::warn = sub { |
28 | my $msg = join "", @_; |
111 | my $msg = join "", @_; |
|
|
112 | utf8::encode $msg; |
|
|
113 | |
29 | $msg .= "\n" |
114 | $msg .= "\n" |
30 | unless $msg =~ /\n$/; |
115 | unless $msg =~ /\n$/; |
31 | |
116 | |
32 | print STDERR "cfperl: $msg"; |
|
|
33 | LOG llevError, "cfperl: $msg"; |
117 | LOG llevError, "cfperl: $msg"; |
34 | }; |
118 | }; |
35 | } |
119 | } |
36 | |
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'; |
37 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
126 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
38 | |
127 | |
39 | # 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 |
40 | # within the Safe compartment. |
129 | # within the Safe compartment. |
41 | for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { |
130 | for my $pkg (qw( |
|
|
131 | cf::global cf::attachable |
|
|
132 | cf::object cf::object::player |
|
|
133 | cf::client cf::player |
|
|
134 | cf::arch cf::living |
|
|
135 | cf::map cf::party cf::region |
|
|
136 | )) { |
42 | no strict 'refs'; |
137 | no strict 'refs'; |
43 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
138 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
44 | } |
139 | } |
45 | |
140 | |
46 | $Event::DIED = sub { |
141 | $Event::DIED = sub { |
… | |
… | |
48 | }; |
143 | }; |
49 | |
144 | |
50 | my %ext_pkg; |
145 | my %ext_pkg; |
51 | my @exts; |
146 | my @exts; |
52 | my @hook; |
147 | my @hook; |
53 | my %command; |
|
|
54 | my %extcmd; |
|
|
55 | |
148 | |
56 | ############################################################################# |
149 | =head2 UTILITY FUNCTIONS |
57 | # utility functions |
150 | |
|
|
151 | =over 4 |
|
|
152 | |
|
|
153 | =cut |
58 | |
154 | |
59 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
155 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
|
|
156 | |
|
|
157 | =item $ref = cf::from_json $json |
|
|
158 | |
|
|
159 | Converts a JSON string into the corresponding perl data structure. |
|
|
160 | |
|
|
161 | =cut |
60 | |
162 | |
61 | sub from_json($) { |
163 | sub from_json($) { |
62 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
164 | $JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs |
63 | JSON::Syck::Load $_[0] |
165 | JSON::Syck::Load $_[0] |
64 | } |
166 | } |
65 | |
167 | |
|
|
168 | =item $json = cf::to_json $ref |
|
|
169 | |
|
|
170 | Converts a perl data structure into its JSON representation. |
|
|
171 | |
|
|
172 | =cut |
|
|
173 | |
66 | sub to_json($) { |
174 | sub to_json($) { |
67 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
175 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
68 | JSON::Syck::Dump $_[0] |
176 | JSON::Syck::Dump $_[0] |
69 | } |
177 | } |
70 | |
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 | |
|
|
234 | =back |
|
|
235 | |
|
|
236 | =cut |
|
|
237 | |
71 | ############################################################################# |
238 | ############################################################################# |
72 | # "new" plug-in system |
|
|
73 | |
239 | |
74 | =head3 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+). |
75 | |
249 | |
76 | =over 4 |
250 | =over 4 |
77 | |
251 | |
78 | =item $object->attach ($attachment, key => $value...) |
|
|
79 | |
|
|
80 | =item $object->detach ($attachment) |
|
|
81 | |
|
|
82 | Attach/detach a pre-registered attachment to an object. |
|
|
83 | |
|
|
84 | =item $player->attach ($attachment, key => $value...) |
|
|
85 | |
|
|
86 | =item $player->detach ($attachment) |
|
|
87 | |
|
|
88 | Attach/detach a pre-registered attachment to a player. |
|
|
89 | |
|
|
90 | =item $map->attach ($attachment, key => $value...) |
252 | =item $attachable->attach ($attachment, key => $value...) |
91 | |
253 | |
92 | =item $map->detach ($attachment) |
254 | =item $attachable->detach ($attachment) |
93 | |
255 | |
94 | 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. |
95 | |
258 | |
96 | =item $bool = $object->attached ($name) |
259 | Example, attach a minesweeper attachment to the given object, making it a |
|
|
260 | 10x10 minesweeper game: |
97 | |
261 | |
98 | =item $bool = $player->attached ($name) |
262 | $obj->attach (minesweeper => width => 10, height => 10); |
99 | |
263 | |
100 | =item $bool = $map->attached ($name) |
264 | =item $bool = $attachable->attached ($name) |
101 | |
265 | |
102 | Checks wether the named attachment is currently attached to the object. |
266 | Checks wether the named attachment is currently attached to the object. |
103 | |
267 | |
104 | =item cf::attach_global ... |
268 | =item cf::CLASS->attach ... |
105 | |
269 | |
106 | Attach handlers for global events. |
270 | =item cf::CLASS->detach ... |
107 | |
271 | |
108 | 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 |
109 | 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: |
110 | |
306 | |
111 | =over 4 |
307 | =over 4 |
112 | |
308 | |
113 | =item prio => $number |
309 | =item prio => $number |
114 | |
310 | |
… | |
… | |
116 | by another C<prio> setting). Lower priority handlers get executed |
312 | by another C<prio> setting). Lower priority handlers get executed |
117 | 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 |
118 | 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 |
119 | unless you know what you are doing. |
315 | unless you know what you are doing. |
120 | |
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 | |
121 | =item on_I<event> => \&cb |
323 | =item on_I<event> => \&cb |
122 | |
324 | |
123 | 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 |
124 | 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 |
125 | handlers are recognised generally depends on the type of object these |
327 | handlers are recognised generally depends on the type of object these |
… | |
… | |
134 | package and register them. Only handlers for eevents supported by the |
336 | package and register them. Only handlers for eevents supported by the |
135 | object/class are recognised. |
337 | object/class are recognised. |
136 | |
338 | |
137 | =back |
339 | =back |
138 | |
340 | |
139 | =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: |
140 | |
343 | |
141 | Attach handlers for a specific object type (e.g. TRANSPORT) and |
344 | cf::object::attachment sockpuppet => |
142 | subtype. If C<$subtype> is zero or undef, matches all objects of the given |
345 | on_skill_attack => sub { |
143 | type. |
346 | my ($self, $victim) = @_; |
144 | |
347 | ... |
145 | =item cf::attach_to_objects ... |
|
|
146 | |
|
|
147 | Attach handlers to all objects. Do not use this except for debugging or |
|
|
148 | very rare events, as handlers are (obviously) called for I<all> objects in |
|
|
149 | the game. |
|
|
150 | |
|
|
151 | =item cf::attach_to_players ... |
|
|
152 | |
|
|
153 | Attach handlers to all players. |
|
|
154 | |
|
|
155 | =item cf::attach_to_maps ... |
|
|
156 | |
|
|
157 | Attach handlers to all maps. |
|
|
158 | |
|
|
159 | =item cf:register_attachment $name, ... |
|
|
160 | |
|
|
161 | Register an attachment by name through which objects can refer to this |
|
|
162 | attachment. |
|
|
163 | |
|
|
164 | =item cf:register_player_attachment $name, ... |
|
|
165 | |
|
|
166 | Register an attachment by name through which players can refer to this |
|
|
167 | attachment. |
|
|
168 | |
|
|
169 | =item cf:register_map_attachment $name, ... |
|
|
170 | |
|
|
171 | Register an attachment by name through which maps can refer to this |
|
|
172 | attachment. |
|
|
173 | |
|
|
174 | =cut |
|
|
175 | |
|
|
176 | # the following variables are defined in .xs and must not be re-created |
|
|
177 | our @CB_GLOBAL = (); # registry for all global events |
|
|
178 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
|
|
179 | our @CB_PLAYER = (); |
|
|
180 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
|
|
181 | our @CB_MAP = (); |
|
|
182 | |
|
|
183 | my %attachment; |
|
|
184 | |
|
|
185 | sub _attach_cb($\%$$$) { |
|
|
186 | my ($registry, $undo, $event, $prio, $cb) = @_; |
|
|
187 | |
|
|
188 | use sort 'stable'; |
|
|
189 | |
|
|
190 | $cb = [$prio, $cb]; |
|
|
191 | |
|
|
192 | @{$registry->[$event]} = sort |
|
|
193 | { $a->[0] cmp $b->[0] } |
|
|
194 | @{$registry->[$event] || []}, $cb; |
|
|
195 | |
|
|
196 | push @{$undo->{cb}}, [$event, $cb]; |
|
|
197 | } |
|
|
198 | |
|
|
199 | # attach handles attaching event callbacks |
|
|
200 | # the only thing the caller has to do is pass the correct |
|
|
201 | # registry (== where the callback attaches to). |
|
|
202 | sub _attach(\@$@) { |
|
|
203 | my ($registry, $klass, @arg) = @_; |
|
|
204 | |
|
|
205 | my $prio = 0; |
|
|
206 | |
|
|
207 | my %undo = ( |
|
|
208 | registry => $registry, |
|
|
209 | cb => [], |
|
|
210 | ); |
|
|
211 | |
|
|
212 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
|
|
213 | |
|
|
214 | while (@arg) { |
|
|
215 | my $type = shift @arg; |
|
|
216 | |
|
|
217 | if ($type eq "prio") { |
|
|
218 | $prio = shift @arg; |
|
|
219 | |
|
|
220 | } elsif ($type eq "package") { |
|
|
221 | my $pkg = shift @arg; |
|
|
222 | |
|
|
223 | while (my ($name, $id) = each %cb_id) { |
|
|
224 | if (my $cb = $pkg->can ($name)) { |
|
|
225 | _attach_cb $registry, %undo, $id, $prio, $cb; |
|
|
226 | } |
|
|
227 | } |
348 | } |
228 | |
|
|
229 | } elsif (exists $cb_id{$type}) { |
|
|
230 | _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; |
|
|
231 | |
|
|
232 | } elsif (ref $type) { |
|
|
233 | warn "attaching objects not supported, ignoring.\n"; |
|
|
234 | |
|
|
235 | } else { |
|
|
236 | shift @arg; |
|
|
237 | warn "attach argument '$type' not supported, ignoring.\n"; |
|
|
238 | } |
|
|
239 | } |
|
|
240 | |
|
|
241 | \%undo |
|
|
242 | } |
|
|
243 | |
|
|
244 | sub _attach_attachment { |
|
|
245 | my ($obj, $name, %arg) = @_; |
|
|
246 | |
|
|
247 | return if exists $obj->{_attachment}{$name}; |
|
|
248 | |
|
|
249 | my $res; |
|
|
250 | |
|
|
251 | if (my $attach = $attachment{$name}) { |
|
|
252 | my $registry = $obj->registry; |
|
|
253 | |
|
|
254 | for (@$attach) { |
|
|
255 | my ($klass, @attach) = @$_; |
|
|
256 | $res = _attach @$registry, $klass, @attach; |
|
|
257 | } |
|
|
258 | |
|
|
259 | $obj->{$name} = \%arg; |
|
|
260 | } else { |
|
|
261 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
262 | } |
|
|
263 | |
|
|
264 | $obj->{_attachment}{$name} = undef; |
|
|
265 | |
|
|
266 | $res->{attachment} = $name; |
|
|
267 | $res |
|
|
268 | } |
|
|
269 | |
|
|
270 | *cf::object::attach = |
|
|
271 | *cf::player::attach = |
|
|
272 | *cf::map::attach = sub { |
|
|
273 | my ($obj, $name, %arg) = @_; |
|
|
274 | |
|
|
275 | _attach_attachment $obj, $name, %arg; |
|
|
276 | }; |
|
|
277 | |
|
|
278 | # all those should be optimised |
|
|
279 | *cf::object::detach = |
|
|
280 | *cf::player::detach = |
|
|
281 | *cf::map::detach = sub { |
|
|
282 | my ($obj, $name) = @_; |
|
|
283 | |
|
|
284 | delete $obj->{_attachment}{$name}; |
|
|
285 | reattach ($obj); |
|
|
286 | }; |
|
|
287 | |
|
|
288 | *cf::object::attached = |
|
|
289 | *cf::player::attached = |
|
|
290 | *cf::map::attached = sub { |
|
|
291 | my ($obj, $name) = @_; |
|
|
292 | |
|
|
293 | exists $obj->{_attachment}{$name} |
|
|
294 | }; |
|
|
295 | |
|
|
296 | sub attach_global { |
|
|
297 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
|
|
298 | } |
|
|
299 | |
|
|
300 | sub attach_to_type { |
|
|
301 | my $type = shift; |
|
|
302 | my $subtype = shift; |
|
|
303 | |
|
|
304 | _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ |
|
|
305 | } |
|
|
306 | |
|
|
307 | sub attach_to_objects { |
|
|
308 | _attach @CB_OBJECT, KLASS_OBJECT, @_ |
|
|
309 | } |
|
|
310 | |
|
|
311 | sub attach_to_players { |
|
|
312 | _attach @CB_PLAYER, KLASS_PLAYER, @_ |
|
|
313 | } |
|
|
314 | |
|
|
315 | sub attach_to_maps { |
|
|
316 | _attach @CB_MAP, KLASS_MAP, @_ |
|
|
317 | } |
|
|
318 | |
|
|
319 | sub register_attachment { |
|
|
320 | my $name = shift; |
|
|
321 | |
|
|
322 | $attachment{$name} = [[KLASS_OBJECT, @_]]; |
|
|
323 | } |
|
|
324 | |
|
|
325 | sub register_player_attachment { |
|
|
326 | my $name = shift; |
|
|
327 | |
|
|
328 | $attachment{$name} = [[KLASS_PLAYER, @_]]; |
|
|
329 | } |
|
|
330 | |
|
|
331 | sub register_map_attachment { |
|
|
332 | my $name = shift; |
|
|
333 | |
|
|
334 | $attachment{$name} = [[KLASS_MAP, @_]]; |
|
|
335 | } |
|
|
336 | |
|
|
337 | our $override; |
|
|
338 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
|
|
339 | |
|
|
340 | sub override { |
|
|
341 | $override = 1; |
|
|
342 | @invoke_results = (); |
|
|
343 | } |
|
|
344 | |
|
|
345 | sub do_invoke { |
|
|
346 | my $event = shift; |
|
|
347 | my $callbacks = shift; |
|
|
348 | |
|
|
349 | @invoke_results = (); |
|
|
350 | |
|
|
351 | local $override; |
|
|
352 | |
|
|
353 | for (@$callbacks) { |
|
|
354 | eval { &{$_->[1]} }; |
|
|
355 | |
|
|
356 | if ($@) { |
|
|
357 | warn "$@"; |
|
|
358 | warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n"; |
|
|
359 | override; |
|
|
360 | } |
|
|
361 | |
|
|
362 | return 1 if $override; |
|
|
363 | } |
|
|
364 | |
|
|
365 | 0 |
349 | } |
366 | } |
|
|
367 | |
350 | |
368 | =item $bool = cf::invoke EVENT_GLOBAL_XXX, ... |
351 | =item $attachable->valid |
369 | |
|
|
370 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
|
|
371 | |
|
|
372 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
|
|
373 | |
|
|
374 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
|
|
375 | |
|
|
376 | Generate a global/object/player/map-specific event with the given arguments. |
|
|
377 | |
|
|
378 | This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be |
|
|
379 | removed in future versions), and there is no public API to access override |
|
|
380 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
381 | |
|
|
382 | =back |
|
|
383 | |
|
|
384 | =head2 methods valid for all pointers |
|
|
385 | |
|
|
386 | =over 4 |
|
|
387 | |
|
|
388 | =item $object->valid |
|
|
389 | |
|
|
390 | =item $player->valid |
|
|
391 | |
|
|
392 | =item $map->valid |
|
|
393 | |
352 | |
394 | 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 |
395 | 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 |
396 | 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 |
397 | 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 |
398 | exception. |
357 | exception. |
399 | |
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 | |
400 | =back |
542 | =back |
401 | |
543 | |
402 | =cut |
544 | =cut |
403 | |
|
|
404 | *cf::object::valid = |
|
|
405 | *cf::player::valid = |
|
|
406 | *cf::map::valid = \&cf::_valid; |
|
|
407 | |
545 | |
408 | ############################################################################# |
546 | ############################################################################# |
409 | # object support |
547 | # object support |
410 | |
548 | |
411 | sub instantiate { |
|
|
412 | my ($obj, $data) = @_; |
|
|
413 | |
|
|
414 | $data = from_json $data; |
|
|
415 | |
|
|
416 | for (@$data) { |
|
|
417 | my ($name, $args) = @$_; |
|
|
418 | |
|
|
419 | $obj->attach ($name, %{$args || {} }); |
|
|
420 | } |
|
|
421 | } |
|
|
422 | |
|
|
423 | # basically do the same as instantiate, without calling instantiate |
|
|
424 | sub reattach { |
549 | sub reattach { |
|
|
550 | # basically do the same as instantiate, without calling instantiate |
425 | my ($obj) = @_; |
551 | my ($obj) = @_; |
|
|
552 | |
426 | my $registry = $obj->registry; |
553 | my $registry = $obj->registry; |
427 | |
554 | |
428 | @$registry = (); |
555 | @$registry = (); |
429 | |
556 | |
430 | delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
557 | delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
431 | |
558 | |
432 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
559 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
433 | if (my $attach = $attachment{$name}) { |
560 | if (my $attach = $attachment{$name}) { |
434 | for (@$attach) { |
561 | for (@$attach) { |
435 | my ($klass, @attach) = @$_; |
562 | my ($klass, @attach) = @$_; |
436 | _attach @$registry, $klass, @attach; |
563 | _attach $registry, $klass, @attach; |
437 | } |
564 | } |
438 | } else { |
565 | } else { |
439 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
566 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
440 | } |
567 | } |
441 | } |
568 | } |
442 | } |
569 | } |
443 | |
570 | |
444 | sub object_freezer_save { |
571 | cf::attachable->attach ( |
445 | my ($filename, $rdata, $objs) = @_; |
|
|
446 | |
|
|
447 | if (length $$rdata) { |
|
|
448 | warn sprintf "saving %s (%d,%d)\n", |
|
|
449 | $filename, length $$rdata, scalar @$objs; |
|
|
450 | |
|
|
451 | if (open my $fh, ">:raw", "$filename~") { |
|
|
452 | chmod SAVE_MODE, $fh; |
|
|
453 | syswrite $fh, $$rdata; |
|
|
454 | close $fh; |
|
|
455 | |
|
|
456 | if (@$objs && open my $fh, ">:raw", "$filename.pst~") { |
|
|
457 | chmod SAVE_MODE, $fh; |
|
|
458 | syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; |
|
|
459 | close $fh; |
|
|
460 | rename "$filename.pst~", "$filename.pst"; |
|
|
461 | } else { |
|
|
462 | unlink "$filename.pst"; |
|
|
463 | } |
|
|
464 | |
|
|
465 | rename "$filename~", $filename; |
|
|
466 | } else { |
|
|
467 | warn "FATAL: $filename~: $!\n"; |
|
|
468 | } |
|
|
469 | } else { |
|
|
470 | unlink $filename; |
|
|
471 | unlink "$filename.pst"; |
|
|
472 | } |
|
|
473 | } |
|
|
474 | |
|
|
475 | sub object_thawer_load { |
|
|
476 | my ($filename) = @_; |
|
|
477 | |
|
|
478 | local $/; |
|
|
479 | |
|
|
480 | my $av; |
|
|
481 | |
|
|
482 | #TODO: use sysread etc. |
|
|
483 | if (open my $data, "<:raw:perlio", $filename) { |
|
|
484 | $data = <$data>; |
|
|
485 | if (open my $pst, "<:raw:perlio", "$filename.pst") { |
|
|
486 | $av = eval { (Storable::thaw <$pst>)->{objs} }; |
|
|
487 | } |
|
|
488 | return ($data, $av); |
|
|
489 | } |
|
|
490 | |
|
|
491 | () |
|
|
492 | } |
|
|
493 | |
|
|
494 | attach_to_objects |
|
|
495 | 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, |
496 | on_clone => sub { |
585 | on_clone => sub { |
497 | my ($src, $dst) = @_; |
586 | my ($src, $dst) = @_; |
498 | |
587 | |
499 | @{$dst->registry} = @{$src->registry}; |
588 | @{$dst->registry} = @{$src->registry}; |
500 | |
589 | |
501 | %$dst = %$src; |
590 | %$dst = %$src; |
502 | |
591 | |
503 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
592 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
504 | if exists $src->{_attachment}; |
593 | if exists $src->{_attachment}; |
505 | }, |
594 | }, |
506 | ; |
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 | } |
507 | |
659 | |
508 | ############################################################################# |
660 | ############################################################################# |
509 | # old plug-in events |
661 | # command handling &c |
510 | |
662 | |
511 | sub inject_event { |
663 | =item cf::register_command $name => \&callback($ob,$args); |
512 | my $extension = shift; |
|
|
513 | my $event_code = shift; |
|
|
514 | |
664 | |
515 | my $cb = $hook[$event_code]{$extension} |
665 | Register a callback for execution when the client sends the user command |
516 | or return; |
666 | $name. |
517 | |
667 | |
518 | &$cb |
668 | =cut |
519 | } |
|
|
520 | |
|
|
521 | sub inject_global_event { |
|
|
522 | my $event = shift; |
|
|
523 | |
|
|
524 | my $cb = $hook[$event] |
|
|
525 | or return; |
|
|
526 | |
|
|
527 | List::Util::max map &$_, values %$cb |
|
|
528 | } |
|
|
529 | |
|
|
530 | sub inject_command { |
|
|
531 | my ($name, $obj, $params) = @_; |
|
|
532 | |
|
|
533 | for my $cmd (@{ $command{$name} }) { |
|
|
534 | $cmd->[1]->($obj, $params); |
|
|
535 | } |
|
|
536 | |
|
|
537 | -1 |
|
|
538 | } |
|
|
539 | |
669 | |
540 | sub register_command { |
670 | sub register_command { |
541 | my ($name, $time, $cb) = @_; |
671 | my ($name, $cb) = @_; |
542 | |
672 | |
543 | my $caller = caller; |
673 | my $caller = caller; |
544 | #warn "registering command '$name/$time' to '$caller'"; |
674 | #warn "registering command '$name/$time' to '$caller'"; |
545 | |
675 | |
546 | push @{ $command{$name} }, [$time, $cb, $caller]; |
676 | push @{ $COMMAND{$name} }, [$caller, $cb]; |
547 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
|
|
548 | } |
677 | } |
|
|
678 | |
|
|
679 | =item cf::register_extcmd $name => \&callback($pl,$packet); |
|
|
680 | |
|
|
681 | Register a callbackf ro execution when the client sends an extcmd packet. |
|
|
682 | |
|
|
683 | If the callback returns something, it is sent back as if reply was being |
|
|
684 | called. |
|
|
685 | |
|
|
686 | =cut |
549 | |
687 | |
550 | sub register_extcmd { |
688 | sub register_extcmd { |
551 | my ($name, $cb) = @_; |
689 | my ($name, $cb) = @_; |
552 | |
690 | |
553 | my $caller = caller; |
691 | my $caller = caller; |
554 | #warn "registering extcmd '$name' to '$caller'"; |
692 | #warn "registering extcmd '$name' to '$caller'"; |
555 | |
693 | |
556 | $extcmd{$name} = [$cb, $caller]; |
694 | $EXTCMD{$name} = [$cb, $caller]; |
557 | } |
695 | } |
|
|
696 | |
|
|
697 | cf::player->attach ( |
|
|
698 | on_command => sub { |
|
|
699 | my ($pl, $name, $params) = @_; |
|
|
700 | |
|
|
701 | my $cb = $COMMAND{$name} |
|
|
702 | or return; |
|
|
703 | |
|
|
704 | for my $cmd (@$cb) { |
|
|
705 | $cmd->[1]->($pl->ob, $params); |
|
|
706 | } |
|
|
707 | |
|
|
708 | cf::override; |
|
|
709 | }, |
|
|
710 | on_extcmd => sub { |
|
|
711 | my ($pl, $buf) = @_; |
|
|
712 | |
|
|
713 | my $msg = eval { from_json $buf }; |
|
|
714 | |
|
|
715 | if (ref $msg) { |
|
|
716 | if (my $cb = $EXTCMD{$msg->{msgtype}}) { |
|
|
717 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
718 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
719 | } |
|
|
720 | } |
|
|
721 | } else { |
|
|
722 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
723 | } |
|
|
724 | |
|
|
725 | cf::override; |
|
|
726 | }, |
|
|
727 | ); |
558 | |
728 | |
559 | sub register { |
729 | sub register { |
560 | my ($base, $pkg) = @_; |
730 | my ($base, $pkg) = @_; |
561 | |
731 | |
562 | #TODO |
732 | #TODO |
… | |
… | |
581 | . "#line 1 \"$path\"\n{\n" |
751 | . "#line 1 \"$path\"\n{\n" |
582 | . (do { local $/; <$fh> }) |
752 | . (do { local $/; <$fh> }) |
583 | . "\n};\n1"; |
753 | . "\n};\n1"; |
584 | |
754 | |
585 | eval $source |
755 | eval $source |
586 | or die "$path: $@"; |
756 | or die $@ ? "$path: $@\n" |
|
|
757 | : "extension disabled.\n"; |
587 | |
758 | |
588 | push @exts, $pkg; |
759 | push @exts, $pkg; |
589 | $ext_pkg{$base} = $pkg; |
760 | $ext_pkg{$base} = $pkg; |
590 | |
761 | |
591 | # no strict 'refs'; |
762 | # no strict 'refs'; |
… | |
… | |
604 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
775 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
605 | # delete $hook[$idx]{$pkg}; |
776 | # delete $hook[$idx]{$pkg}; |
606 | # } |
777 | # } |
607 | |
778 | |
608 | # remove commands |
779 | # remove commands |
609 | for my $name (keys %command) { |
780 | for my $name (keys %COMMAND) { |
610 | my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; |
781 | my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} }; |
611 | |
782 | |
612 | if (@cb) { |
783 | if (@cb) { |
613 | $command{$name} = \@cb; |
784 | $COMMAND{$name} = \@cb; |
614 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; |
|
|
615 | } else { |
785 | } else { |
616 | delete $command{$name}; |
|
|
617 | delete $COMMAND{"$name\000"}; |
786 | delete $COMMAND{$name}; |
618 | } |
787 | } |
619 | } |
788 | } |
620 | |
789 | |
621 | # remove extcmds |
790 | # remove extcmds |
622 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
791 | for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) { |
623 | delete $extcmd{$name}; |
792 | delete $EXTCMD{$name}; |
624 | } |
793 | } |
625 | |
794 | |
626 | if (my $cb = $pkg->can ("unload")) { |
795 | if (my $cb = $pkg->can ("unload")) { |
627 | eval { |
796 | eval { |
628 | $cb->($pkg); |
797 | $cb->($pkg); |
… | |
… | |
632 | |
801 | |
633 | Symbol::delete_package $pkg; |
802 | Symbol::delete_package $pkg; |
634 | } |
803 | } |
635 | |
804 | |
636 | sub load_extensions { |
805 | sub load_extensions { |
637 | my $LIBDIR = maps_directory "perl"; |
|
|
638 | |
|
|
639 | for my $ext (<$LIBDIR/*.ext>) { |
806 | for my $ext (<$LIBDIR/*.ext>) { |
640 | next unless -r $ext; |
807 | next unless -r $ext; |
641 | eval { |
808 | eval { |
642 | load_extension $ext; |
809 | load_extension $ext; |
643 | 1 |
810 | 1 |
644 | } or warn "$ext not loaded: $@"; |
811 | } or warn "$ext not loaded: $@"; |
645 | } |
812 | } |
646 | } |
813 | } |
647 | |
814 | |
648 | sub _perl_reload(&) { |
|
|
649 | my ($msg) = @_; |
|
|
650 | |
|
|
651 | $msg->("reloading..."); |
|
|
652 | |
|
|
653 | eval { |
|
|
654 | # 1. cancel all watchers |
|
|
655 | $_->cancel for Event::all_watchers; |
|
|
656 | |
|
|
657 | # 2. unload all extensions |
|
|
658 | for (@exts) { |
|
|
659 | $msg->("unloading <$_>"); |
|
|
660 | unload_extension $_; |
|
|
661 | } |
|
|
662 | |
|
|
663 | # 3. unload all modules loaded from $LIBDIR |
|
|
664 | while (my ($k, $v) = each %INC) { |
|
|
665 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
666 | |
|
|
667 | $msg->("removing <$k>"); |
|
|
668 | delete $INC{$k}; |
|
|
669 | |
|
|
670 | $k =~ s/\.pm$//; |
|
|
671 | $k =~ s/\//::/g; |
|
|
672 | |
|
|
673 | if (my $cb = $k->can ("unload_module")) { |
|
|
674 | $cb->(); |
|
|
675 | } |
|
|
676 | |
|
|
677 | Symbol::delete_package $k; |
|
|
678 | } |
|
|
679 | |
|
|
680 | # 4. get rid of safe::, as good as possible |
|
|
681 | Symbol::delete_package "safe::$_" |
|
|
682 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
|
|
683 | |
|
|
684 | # 5. remove register_script_function callbacks |
|
|
685 | # TODO |
|
|
686 | |
|
|
687 | # 6. unload cf.pm "a bit" |
|
|
688 | delete $INC{"cf.pm"}; |
|
|
689 | |
|
|
690 | # don't, removes xs symbols, too, |
|
|
691 | # and global variables created in xs |
|
|
692 | #Symbol::delete_package __PACKAGE__; |
|
|
693 | |
|
|
694 | # 7. reload cf.pm |
|
|
695 | $msg->("reloading cf.pm"); |
|
|
696 | require cf; |
|
|
697 | |
|
|
698 | $msg->("load extensions"); |
|
|
699 | cf::load_extensions; |
|
|
700 | }; |
|
|
701 | $msg->($@) if $@; |
|
|
702 | |
|
|
703 | $msg->("reloaded"); |
|
|
704 | }; |
|
|
705 | |
|
|
706 | sub perl_reload() { |
|
|
707 | _perl_reload { |
|
|
708 | warn $_[0]; |
|
|
709 | print "$_[0]\n"; |
|
|
710 | }; |
|
|
711 | } |
|
|
712 | |
|
|
713 | register_command "perl-reload", 0, sub { |
|
|
714 | my ($who, $arg) = @_; |
|
|
715 | |
|
|
716 | if ($who->flag (FLAG_WIZ)) { |
|
|
717 | _perl_reload { |
|
|
718 | warn $_[0]; |
|
|
719 | $who->message ($_[0]); |
|
|
720 | }; |
|
|
721 | } |
|
|
722 | }; |
|
|
723 | |
|
|
724 | ############################################################################# |
|
|
725 | # extcmd framework, basically convert ext <msg> |
|
|
726 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
727 | |
|
|
728 | attach_to_players |
|
|
729 | on_extcmd => sub { |
|
|
730 | my ($pl, $buf) = @_; |
|
|
731 | |
|
|
732 | my $msg = eval { from_json $buf }; |
|
|
733 | |
|
|
734 | if (ref $msg) { |
|
|
735 | if (my $cb = $extcmd{$msg->{msgtype}}) { |
|
|
736 | if (my %reply = $cb->[0]->($pl, $msg)) { |
|
|
737 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
738 | } |
|
|
739 | } |
|
|
740 | } else { |
|
|
741 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
742 | } |
|
|
743 | |
|
|
744 | cf::override; |
|
|
745 | }, |
|
|
746 | ; |
|
|
747 | |
|
|
748 | ############################################################################# |
815 | ############################################################################# |
749 | # load/save/clean perl data associated with a map |
816 | # load/save/clean perl data associated with a map |
750 | |
817 | |
751 | *cf::mapsupport::on_clean = sub { |
818 | *cf::mapsupport::on_clean = sub { |
752 | my ($map) = @_; |
819 | my ($map) = @_; |
… | |
… | |
755 | defined $path or return; |
822 | defined $path or return; |
756 | |
823 | |
757 | unlink "$path.pst"; |
824 | unlink "$path.pst"; |
758 | }; |
825 | }; |
759 | |
826 | |
760 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
827 | cf::map->attach (prio => -10000, package => cf::mapsupport::); |
761 | |
828 | |
762 | ############################################################################# |
829 | ############################################################################# |
763 | # load/save perl data associated with player->ob objects |
830 | # load/save perl data associated with player->ob objects |
764 | |
831 | |
765 | sub all_objects(@) { |
832 | sub all_objects(@) { |
766 | @_, map all_objects ($_->inv), @_ |
833 | @_, map all_objects ($_->inv), @_ |
767 | } |
834 | } |
768 | |
835 | |
769 | # TODO: compatibility cruft, remove when no longer needed |
836 | # TODO: compatibility cruft, remove when no longer needed |
770 | attach_to_players |
837 | cf::player->attach ( |
771 | on_load => sub { |
838 | on_load => sub { |
772 | my ($pl, $path) = @_; |
839 | my ($pl, $path) = @_; |
773 | |
840 | |
774 | for my $o (all_objects $pl->ob) { |
841 | for my $o (all_objects $pl->ob) { |
775 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
842 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
… | |
… | |
777 | |
844 | |
778 | %$o = %{ Storable::thaw pack "H*", $value }; |
845 | %$o = %{ Storable::thaw pack "H*", $value }; |
779 | } |
846 | } |
780 | } |
847 | } |
781 | }, |
848 | }, |
782 | ; |
849 | ); |
783 | |
850 | |
784 | ############################################################################# |
851 | ############################################################################# |
785 | # core extensions - in perl |
852 | |
|
|
853 | =head2 CORE EXTENSIONS |
|
|
854 | |
|
|
855 | Functions and methods that extend core crossfire objects. |
|
|
856 | |
|
|
857 | =head3 cf::player |
|
|
858 | |
|
|
859 | =over 4 |
786 | |
860 | |
787 | =item cf::player::exists $login |
861 | =item cf::player::exists $login |
788 | |
862 | |
789 | Returns true when the given account exists. |
863 | Returns true when the given account exists. |
790 | |
864 | |
… | |
… | |
793 | sub cf::player::exists($) { |
867 | sub cf::player::exists($) { |
794 | cf::player::find $_[0] |
868 | cf::player::find $_[0] |
795 | 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; |
796 | } |
870 | } |
797 | |
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 | |
798 | =item $player->reply ($npc, $msg[, $flags]) |
892 | =item $player_object->reply ($npc, $msg[, $flags]) |
799 | |
893 | |
800 | 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> |
801 | 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 |
802 | dialogue with the given NPC character. |
896 | dialogue with the given NPC character. |
803 | |
897 | |
804 | =cut |
898 | =cut |
805 | |
899 | |
806 | # rough implementation of a future "reply" method that works |
900 | # rough implementation of a future "reply" method that works |
807 | # with dialog boxes. |
901 | # with dialog boxes. |
|
|
902 | #TODO: the first argument must go, split into a $npc->reply_to ( method |
808 | sub cf::object::player::reply($$$;$) { |
903 | sub cf::object::player::reply($$$;$) { |
809 | my ($self, $npc, $msg, $flags) = @_; |
904 | my ($self, $npc, $msg, $flags) = @_; |
810 | |
905 | |
811 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
906 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
812 | |
907 | |
… | |
… | |
816 | $msg = $npc->name . " says: $msg" if $npc; |
911 | $msg = $npc->name . " says: $msg" if $npc; |
817 | $self->message ($msg, $flags); |
912 | $self->message ($msg, $flags); |
818 | } |
913 | } |
819 | } |
914 | } |
820 | |
915 | |
821 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
916 | =item $player_object->may ("access") |
822 | |
917 | |
823 | Sends an ext reply to the player. |
918 | Returns wether the given player is authorized to access resource "access" |
|
|
919 | (e.g. "command_wizcast"). |
824 | |
920 | |
825 | =cut |
921 | =cut |
826 | |
922 | |
827 | sub cf::player::ext_reply($$$%) { |
923 | sub cf::object::player::may { |
|
|
924 | my ($self, $access) = @_; |
|
|
925 | |
|
|
926 | $self->flag (cf::FLAG_WIZ) || |
|
|
927 | (ref $cf::CFG{"may_$access"} |
|
|
928 | ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} |
|
|
929 | : $cf::CFG{"may_$access"}) |
|
|
930 | } |
|
|
931 | |
|
|
932 | =head3 cf::client |
|
|
933 | |
|
|
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 { |
828 | my ($self, $id, %msg) = @_; |
1009 | my ($self, $cb) = @_; |
829 | |
1010 | |
830 | $msg{msgid} = $id; |
1011 | my $coro; $coro = async { |
|
|
1012 | eval { |
|
|
1013 | $cb->(); |
|
|
1014 | }; |
|
|
1015 | warn $@ if $@; |
|
|
1016 | }; |
831 | |
1017 | |
832 | $self->send ("ext " . to_json \%msg); |
1018 | $coro->on_destroy (sub { |
833 | } |
1019 | delete $self->{_coro}{$coro+0}; |
|
|
1020 | }); |
834 | |
1021 | |
835 | ############################################################################# |
1022 | $self->{_coro}{$coro+0} = $coro; |
836 | # map scripting support |
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 | |
|
|
1037 | |
|
|
1038 | =head2 SAFE SCRIPTING |
|
|
1039 | |
|
|
1040 | Functions that provide a safe environment to compile and execute |
|
|
1041 | snippets of perl code without them endangering the safety of the server |
|
|
1042 | itself. Looping constructs, I/O operators and other built-in functionality |
|
|
1043 | is not available in the safe scripting environment, and the number of |
|
|
1044 | functions and methods that can be called is greatly reduced. |
|
|
1045 | |
|
|
1046 | =cut |
837 | |
1047 | |
838 | our $safe = new Safe "safe"; |
1048 | our $safe = new Safe "safe"; |
839 | our $safe_hole = new Safe::Hole; |
1049 | our $safe_hole = new Safe::Hole; |
840 | |
1050 | |
841 | $SIG{FPE} = 'IGNORE'; |
1051 | $SIG{FPE} = 'IGNORE'; |
842 | |
1052 | |
843 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
1053 | $safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time)); |
844 | |
1054 | |
845 | # here we export the classes and methods available to script code |
1055 | # here we export the classes and methods available to script code |
846 | |
1056 | |
|
|
1057 | =pod |
|
|
1058 | |
|
|
1059 | The following fucntions and emthods are available within a safe environment: |
|
|
1060 | |
|
|
1061 | cf::object contr pay_amount pay_player map |
|
|
1062 | cf::object::player player |
|
|
1063 | cf::player peaceful |
|
|
1064 | cf::map trigger |
|
|
1065 | |
|
|
1066 | =cut |
|
|
1067 | |
847 | for ( |
1068 | for ( |
848 | ["cf::object" => qw(contr pay_amount pay_player)], |
1069 | ["cf::object" => qw(contr pay_amount pay_player map)], |
849 | ["cf::object::player" => qw(player)], |
1070 | ["cf::object::player" => qw(player)], |
850 | ["cf::player" => qw(peaceful)], |
1071 | ["cf::player" => qw(peaceful)], |
|
|
1072 | ["cf::map" => qw(trigger)], |
851 | ) { |
1073 | ) { |
852 | no strict 'refs'; |
1074 | no strict 'refs'; |
853 | my ($pkg, @funs) = @$_; |
1075 | my ($pkg, @funs) = @$_; |
854 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
1076 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
855 | for @funs; |
1077 | for @funs; |
856 | } |
1078 | } |
|
|
1079 | |
|
|
1080 | =over 4 |
|
|
1081 | |
|
|
1082 | =item @retval = safe_eval $code, [var => value, ...] |
|
|
1083 | |
|
|
1084 | Compiled and executes the given perl code snippet. additional var/value |
|
|
1085 | pairs result in temporary local (my) scalar variables of the given name |
|
|
1086 | that are available in the code snippet. Example: |
|
|
1087 | |
|
|
1088 | my $five = safe_eval '$first + $second', first => 1, second => 4; |
|
|
1089 | |
|
|
1090 | =cut |
857 | |
1091 | |
858 | sub safe_eval($;@) { |
1092 | sub safe_eval($;@) { |
859 | my ($code, %vars) = @_; |
1093 | my ($code, %vars) = @_; |
860 | |
1094 | |
861 | my $qcode = $code; |
1095 | my $qcode = $code; |
… | |
… | |
884 | } |
1118 | } |
885 | |
1119 | |
886 | wantarray ? @res : $res[0] |
1120 | wantarray ? @res : $res[0] |
887 | } |
1121 | } |
888 | |
1122 | |
|
|
1123 | =item cf::register_script_function $function => $cb |
|
|
1124 | |
|
|
1125 | Register a function that can be called from within map/npc scripts. The |
|
|
1126 | function should be reasonably secure and should be put into a package name |
|
|
1127 | like the extension. |
|
|
1128 | |
|
|
1129 | Example: register a function that gets called whenever a map script calls |
|
|
1130 | C<rent::overview>, as used by the C<rent> extension. |
|
|
1131 | |
|
|
1132 | cf::register_script_function "rent::overview" => sub { |
|
|
1133 | ... |
|
|
1134 | }; |
|
|
1135 | |
|
|
1136 | =cut |
|
|
1137 | |
889 | sub register_script_function { |
1138 | sub register_script_function { |
890 | my ($fun, $cb) = @_; |
1139 | my ($fun, $cb) = @_; |
891 | |
1140 | |
892 | no strict 'refs'; |
1141 | no strict 'refs'; |
893 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
1142 | *{"safe::$fun"} = $safe_hole->wrap ($cb); |
894 | } |
1143 | } |
895 | |
1144 | |
|
|
1145 | =back |
|
|
1146 | |
|
|
1147 | =cut |
|
|
1148 | |
|
|
1149 | ############################################################################# |
|
|
1150 | |
|
|
1151 | =head2 EXTENSION DATABASE SUPPORT |
|
|
1152 | |
|
|
1153 | Crossfire maintains a very simple database for extension use. It can |
|
|
1154 | currently store anything that can be serialised using Storable, which |
|
|
1155 | excludes objects. |
|
|
1156 | |
|
|
1157 | The parameter C<$family> should best start with the name of the extension |
|
|
1158 | using it, it should be unique. |
|
|
1159 | |
|
|
1160 | =over 4 |
|
|
1161 | |
|
|
1162 | =item $hashref = cf::db_get $family |
|
|
1163 | |
|
|
1164 | Return a hashref for use by the extension C<$family>, which can be |
|
|
1165 | modified. After modifications, you have to call C<cf::db_dirty> or |
|
|
1166 | C<cf::db_sync>. |
|
|
1167 | |
|
|
1168 | =item $value = cf::db_get $family => $key |
|
|
1169 | |
|
|
1170 | Returns a single value from the database |
|
|
1171 | |
|
|
1172 | =item cf::db_put $family => $hashref |
|
|
1173 | |
|
|
1174 | Stores the given family hashref into the database. Updates are delayed, if |
|
|
1175 | you want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
1176 | |
|
|
1177 | =item cf::db_put $family => $key => $value |
|
|
1178 | |
|
|
1179 | Stores the given C<$value> in the family hash. Updates are delayed, if you |
|
|
1180 | want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
1181 | |
|
|
1182 | =item cf::db_dirty |
|
|
1183 | |
|
|
1184 | Marks the database as dirty, to be updated at a later time. |
|
|
1185 | |
|
|
1186 | =item cf::db_sync |
|
|
1187 | |
|
|
1188 | Immediately write the database to disk I<if it is dirty>. |
|
|
1189 | |
|
|
1190 | =cut |
|
|
1191 | |
|
|
1192 | our $DB; |
|
|
1193 | |
|
|
1194 | { |
|
|
1195 | my $path = cf::localdir . "/database.pst"; |
|
|
1196 | |
|
|
1197 | sub db_load() { |
|
|
1198 | warn "loading database $path\n";#d# remove later |
|
|
1199 | $DB = stat $path ? Storable::retrieve $path : { }; |
|
|
1200 | } |
|
|
1201 | |
|
|
1202 | my $pid; |
|
|
1203 | |
|
|
1204 | sub db_save() { |
|
|
1205 | warn "saving database $path\n";#d# remove later |
|
|
1206 | waitpid $pid, 0 if $pid; |
|
|
1207 | if (0 == ($pid = fork)) { |
|
|
1208 | $DB->{_meta}{version} = 1; |
|
|
1209 | Storable::nstore $DB, "$path~"; |
|
|
1210 | rename "$path~", $path; |
|
|
1211 | cf::_exit 0 if defined $pid; |
|
|
1212 | } |
|
|
1213 | } |
|
|
1214 | |
|
|
1215 | my $dirty; |
|
|
1216 | |
|
|
1217 | sub db_sync() { |
|
|
1218 | db_save if $dirty; |
|
|
1219 | undef $dirty; |
|
|
1220 | } |
|
|
1221 | |
|
|
1222 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub { |
|
|
1223 | db_sync; |
|
|
1224 | }); |
|
|
1225 | |
|
|
1226 | sub db_dirty() { |
|
|
1227 | $dirty = 1; |
|
|
1228 | $idle->start; |
|
|
1229 | } |
|
|
1230 | |
|
|
1231 | sub db_get($;$) { |
|
|
1232 | @_ >= 2 |
|
|
1233 | ? $DB->{$_[0]}{$_[1]} |
|
|
1234 | : ($DB->{$_[0]} ||= { }) |
|
|
1235 | } |
|
|
1236 | |
|
|
1237 | sub db_put($$;$) { |
|
|
1238 | if (@_ >= 3) { |
|
|
1239 | $DB->{$_[0]}{$_[1]} = $_[2]; |
|
|
1240 | } else { |
|
|
1241 | $DB->{$_[0]} = $_[1]; |
|
|
1242 | } |
|
|
1243 | db_dirty; |
|
|
1244 | } |
|
|
1245 | |
|
|
1246 | cf::global->attach ( |
|
|
1247 | prio => 10000, |
|
|
1248 | on_cleanup => sub { |
|
|
1249 | db_sync; |
|
|
1250 | }, |
|
|
1251 | ); |
|
|
1252 | } |
|
|
1253 | |
896 | ############################################################################# |
1254 | ############################################################################# |
897 | # the server's main() |
1255 | # the server's main() |
898 | |
1256 | |
|
|
1257 | sub cfg_load { |
|
|
1258 | open my $fh, "<:utf8", cf::confdir . "/config" |
|
|
1259 | or return; |
|
|
1260 | |
|
|
1261 | local $/; |
|
|
1262 | *CFG = YAML::Syck::Load <$fh>; |
|
|
1263 | } |
|
|
1264 | |
899 | sub main { |
1265 | sub main { |
|
|
1266 | cfg_load; |
|
|
1267 | db_load; |
900 | load_extensions; |
1268 | load_extensions; |
901 | Event::loop; |
1269 | Event::loop; |
902 | } |
1270 | } |
903 | |
1271 | |
904 | ############################################################################# |
1272 | ############################################################################# |
905 | # initialisation |
1273 | # initialisation |
906 | |
1274 | |
|
|
1275 | sub _perl_reload() { |
|
|
1276 | warn "reloading..."; |
|
|
1277 | |
|
|
1278 | eval { |
|
|
1279 | local $FREEZE = 1; |
|
|
1280 | |
|
|
1281 | cf::emergency_save; |
|
|
1282 | |
|
|
1283 | # cancel all watchers |
|
|
1284 | for (Event::all_watchers) { |
|
|
1285 | $_->cancel if $_->data & WF_AUTOCANCEL; |
|
|
1286 | } |
|
|
1287 | |
|
|
1288 | # cancel all extension coros |
|
|
1289 | $_->cancel for values %EXT_CORO; |
|
|
1290 | %EXT_CORO = (); |
|
|
1291 | |
|
|
1292 | # unload all extensions |
|
|
1293 | for (@exts) { |
|
|
1294 | warn "unloading <$_>"; |
|
|
1295 | unload_extension $_; |
|
|
1296 | } |
|
|
1297 | |
|
|
1298 | # unload all modules loaded from $LIBDIR |
|
|
1299 | while (my ($k, $v) = each %INC) { |
|
|
1300 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
|
|
1301 | |
|
|
1302 | warn "removing <$k>"; |
|
|
1303 | delete $INC{$k}; |
|
|
1304 | |
|
|
1305 | $k =~ s/\.pm$//; |
|
|
1306 | $k =~ s/\//::/g; |
|
|
1307 | |
|
|
1308 | if (my $cb = $k->can ("unload_module")) { |
|
|
1309 | $cb->(); |
|
|
1310 | } |
|
|
1311 | |
|
|
1312 | Symbol::delete_package $k; |
|
|
1313 | } |
|
|
1314 | |
|
|
1315 | # sync database to disk |
|
|
1316 | cf::db_sync; |
|
|
1317 | IO::AIO::flush; |
|
|
1318 | |
|
|
1319 | # get rid of safe::, as good as possible |
|
|
1320 | Symbol::delete_package "safe::$_" |
|
|
1321 | for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); |
|
|
1322 | |
|
|
1323 | # remove register_script_function callbacks |
|
|
1324 | # TODO |
|
|
1325 | |
|
|
1326 | # unload cf.pm "a bit" |
|
|
1327 | delete $INC{"cf.pm"}; |
|
|
1328 | |
|
|
1329 | # don't, removes xs symbols, too, |
|
|
1330 | # and global variables created in xs |
|
|
1331 | #Symbol::delete_package __PACKAGE__; |
|
|
1332 | |
|
|
1333 | # reload cf.pm |
|
|
1334 | warn "reloading cf.pm"; |
|
|
1335 | require cf; |
|
|
1336 | cf::_connect_to_perl; # nominally unnecessary, but cannot hurt |
|
|
1337 | |
|
|
1338 | # load config and database again |
|
|
1339 | cf::cfg_load; |
|
|
1340 | cf::db_load; |
|
|
1341 | |
|
|
1342 | # load extensions |
|
|
1343 | warn "load extensions"; |
|
|
1344 | cf::load_extensions; |
|
|
1345 | |
|
|
1346 | # reattach attachments to objects |
|
|
1347 | warn "reattach"; |
|
|
1348 | _global_reattach; |
|
|
1349 | }; |
|
|
1350 | warn $@ if $@; |
|
|
1351 | |
|
|
1352 | warn "reloaded"; |
|
|
1353 | }; |
|
|
1354 | |
|
|
1355 | sub perl_reload() { |
|
|
1356 | _perl_reload; |
|
|
1357 | } |
|
|
1358 | |
907 | register "<global>", __PACKAGE__; |
1359 | register "<global>", __PACKAGE__; |
908 | |
1360 | |
|
|
1361 | register_command "perl-reload" => sub { |
|
|
1362 | my ($who, $arg) = @_; |
|
|
1363 | |
|
|
1364 | if ($who->flag (FLAG_WIZ)) { |
|
|
1365 | $who->message ("reloading..."); |
|
|
1366 | _perl_reload; |
|
|
1367 | } |
|
|
1368 | }; |
|
|
1369 | |
909 | unshift @INC, $LIBDIR; |
1370 | unshift @INC, $LIBDIR; |
910 | |
1371 | |
911 | $TICK_WATCHER = Event->timer ( |
1372 | $TICK_WATCHER = Event->timer ( |
|
|
1373 | reentrant => 0, |
912 | prio => 1, |
1374 | prio => 0, |
913 | at => $NEXT_TICK || 1, |
1375 | at => $NEXT_TICK || $TICK, |
|
|
1376 | data => WF_AUTOCANCEL, |
914 | cb => sub { |
1377 | cb => sub { |
|
|
1378 | unless ($FREEZE) { |
915 | cf::server_tick; # one server iteration |
1379 | cf::server_tick; # one server iteration |
|
|
1380 | $RUNTIME += $TICK; |
|
|
1381 | } |
916 | |
1382 | |
917 | my $NOW = Event::time; |
|
|
918 | $NEXT_TICK += $TICK; |
1383 | $NEXT_TICK += $TICK; |
919 | |
1384 | |
920 | # if we are delayed by four ticks, skip them all |
1385 | # if we are delayed by four ticks or more, skip them all |
921 | $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; |
1386 | $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; |
922 | |
1387 | |
923 | $TICK_WATCHER->at ($NEXT_TICK); |
1388 | $TICK_WATCHER->at ($NEXT_TICK); |
924 | $TICK_WATCHER->start; |
1389 | $TICK_WATCHER->start; |
925 | }, |
1390 | }, |
926 | ); |
1391 | ); |
927 | |
1392 | |
928 | _reload_2; |
1393 | IO::AIO::max_poll_time $TICK * 0.2; |
|
|
1394 | |
|
|
1395 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
1396 | poll => 'r', |
|
|
1397 | prio => 5, |
|
|
1398 | data => WF_AUTOCANCEL, |
|
|
1399 | cb => \&IO::AIO::poll_cb); |
|
|
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 | }; |
929 | |
1409 | |
930 | 1 |
1410 | 1 |
931 | |
1411 | |