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.5 (); |
|
|
14 | use Coro::Event; |
|
|
15 | use Coro::Timer; |
|
|
16 | use Coro::Signal; |
|
|
17 | use Coro::Semaphore; |
|
|
18 | use Coro::AIO; |
|
|
19 | |
|
|
20 | use BDB (); |
|
|
21 | use Data::Dumper; |
|
|
22 | use Digest::MD5; |
|
|
23 | use Fcntl; |
|
|
24 | use IO::AIO 2.32 (); |
10 | use YAML::Syck (); |
25 | use YAML::Syck (); |
11 | use Time::HiRes; |
26 | use Time::HiRes; |
12 | use Event; |
27 | use Compress::LZF; |
|
|
28 | |
|
|
29 | Compress::LZF::sfreeze_cr { }; # prime Compress::LZF so it does not use require later |
|
|
30 | |
13 | $Event::Eval = 1; # no idea why this is required, but it is |
31 | use Event; $Event::Eval = 1; # no idea why this is required, but it is |
|
|
32 | |
|
|
33 | sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload |
14 | |
34 | |
15 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
35 | # work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode? |
16 | $YAML::Syck::ImplicitUnicode = 1; |
36 | $YAML::Syck::ImplicitUnicode = 1; |
17 | |
37 | |
18 | use strict; |
38 | $Coro::main->prio (Coro::PRIO_MAX); # run main coroutine ("the server") with very high priority |
19 | |
39 | |
20 | _init_vars; |
|
|
21 | |
|
|
22 | our %COMMAND = (); |
40 | our %COMMAND = (); |
|
|
41 | our %COMMAND_TIME = (); |
|
|
42 | |
|
|
43 | our @EXTS = (); # list of extension package names |
|
|
44 | our %EXTCMD = (); |
|
|
45 | our %EXT_CORO = (); # coroutines bound to extensions |
|
|
46 | our %EXT_MAP = (); # pluggable maps |
|
|
47 | |
23 | our @EVENT; |
48 | our @EVENT; |
24 | our $LIBDIR = maps_directory "perl"; |
49 | our $LIBDIR = datadir . "/ext"; |
25 | |
50 | |
26 | our $TICK = MAX_TIME * 1e-6; |
51 | our $TICK = MAX_TIME * 1e-6; |
27 | our $TICK_WATCHER; |
52 | our $TICK_WATCHER; |
|
|
53 | our $AIO_POLL_WATCHER; |
|
|
54 | our $NEXT_RUNTIME_WRITE; # when should the runtime file be written |
28 | our $NEXT_TICK; |
55 | our $NEXT_TICK; |
|
|
56 | our $NOW; |
|
|
57 | our $USE_FSYNC = 1; # use fsync to write maps - default off |
|
|
58 | |
|
|
59 | our $BDB_POLL_WATCHER; |
|
|
60 | our $DB_ENV; |
29 | |
61 | |
30 | our %CFG; |
62 | our %CFG; |
31 | |
63 | |
|
|
64 | our $UPTIME; $UPTIME ||= time; |
|
|
65 | our $RUNTIME; |
|
|
66 | |
|
|
67 | our %PLAYER; # all users |
|
|
68 | our %MAP; # all maps |
|
|
69 | our $LINK_MAP; # the special {link} map, which is always available |
|
|
70 | our $RANDOM_MAPS = cf::localdir . "/random"; |
|
|
71 | our $BDB_ENV_DIR = cf::localdir . "/db"; |
|
|
72 | |
|
|
73 | our $WAIT_FOR_TICK; $WAIT_FOR_TICK ||= new Coro::Signal; |
|
|
74 | our $WAIT_FOR_TICK_ONE; $WAIT_FOR_TICK_ONE ||= new Coro::Signal; |
|
|
75 | |
|
|
76 | # used to convert map paths into valid unix filenames by replacing / by ∕ |
|
|
77 | our $PATH_SEP = "∕"; # U+2215, chosen purely for visual reasons |
|
|
78 | |
|
|
79 | binmode STDOUT; |
|
|
80 | binmode STDERR; |
|
|
81 | |
|
|
82 | # read virtual server time, if available |
|
|
83 | unless ($RUNTIME || !-e cf::localdir . "/runtime") { |
|
|
84 | open my $fh, "<", cf::localdir . "/runtime" |
|
|
85 | or die "unable to read runtime file: $!"; |
|
|
86 | $RUNTIME = <$fh> + 0.; |
|
|
87 | } |
|
|
88 | |
|
|
89 | mkdir cf::localdir; |
|
|
90 | mkdir cf::localdir . "/" . cf::playerdir; |
|
|
91 | mkdir cf::localdir . "/" . cf::tmpdir; |
|
|
92 | mkdir cf::localdir . "/" . cf::uniquedir; |
|
|
93 | mkdir $RANDOM_MAPS; |
|
|
94 | mkdir $BDB_ENV_DIR; |
|
|
95 | |
|
|
96 | our $EMERGENCY_POSITION; |
|
|
97 | |
|
|
98 | sub cf::map::normalise; |
|
|
99 | |
32 | ############################################################################# |
100 | ############################################################################# |
33 | |
101 | |
34 | =head2 GLOBAL VARIABLES |
102 | =head2 GLOBAL VARIABLES |
35 | |
103 | |
36 | =over 4 |
104 | =over 4 |
|
|
105 | |
|
|
106 | =item $cf::UPTIME |
|
|
107 | |
|
|
108 | The timestamp of the server start (so not actually an uptime). |
|
|
109 | |
|
|
110 | =item $cf::RUNTIME |
|
|
111 | |
|
|
112 | The time this server has run, starts at 0 and is increased by $cf::TICK on |
|
|
113 | every server tick. |
37 | |
114 | |
38 | =item $cf::LIBDIR |
115 | =item $cf::LIBDIR |
39 | |
116 | |
40 | The perl library directory, where extensions and cf-specific modules can |
117 | The perl library directory, where extensions and cf-specific modules can |
41 | be found. It will be added to C<@INC> automatically. |
118 | be found. It will be added to C<@INC> automatically. |
42 | |
119 | |
|
|
120 | =item $cf::NOW |
|
|
121 | |
|
|
122 | The time of the last (current) server tick. |
|
|
123 | |
43 | =item $cf::TICK |
124 | =item $cf::TICK |
44 | |
125 | |
45 | The interval between server ticks, in seconds. |
126 | The interval between server ticks, in seconds. |
46 | |
127 | |
47 | =item %cf::CFG |
128 | =item %cf::CFG |
48 | |
129 | |
49 | Configuration for the server, loaded from C</etc/crossfire/config>, or |
130 | Configuration for the server, loaded from C</etc/crossfire/config>, or |
50 | from wherever your confdir points to. |
131 | from wherever your confdir points to. |
|
|
132 | |
|
|
133 | =item $cf::WAIT_FOR_TICK, $cf::WAIT_FOR_TICK_ONE |
|
|
134 | |
|
|
135 | These are Coro::Signal objects that are C<< ->broadcast >> (WAIT_FOR_TICK) |
|
|
136 | or C<< ->send >> (WAIT_FOR_TICK_ONE) on after normal server tick |
|
|
137 | processing has been done. Call C<< ->wait >> on them to maximise the |
|
|
138 | window of cpu time available, or simply to synchronise to the server tick. |
51 | |
139 | |
52 | =back |
140 | =back |
53 | |
141 | |
54 | =cut |
142 | =cut |
55 | |
143 | |
56 | BEGIN { |
144 | BEGIN { |
57 | *CORE::GLOBAL::warn = sub { |
145 | *CORE::GLOBAL::warn = sub { |
58 | my $msg = join "", @_; |
146 | my $msg = join "", @_; |
|
|
147 | utf8::encode $msg; |
|
|
148 | |
59 | $msg .= "\n" |
149 | $msg .= "\n" |
60 | unless $msg =~ /\n$/; |
150 | unless $msg =~ /\n$/; |
61 | |
151 | |
62 | print STDERR "cfperl: $msg"; |
|
|
63 | LOG llevError, "cfperl: $msg"; |
152 | LOG llevError, $msg; |
64 | }; |
153 | }; |
65 | } |
154 | } |
66 | |
155 | |
|
|
156 | @safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable'; |
|
|
157 | @safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable'; |
|
|
158 | @safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable'; |
|
|
159 | @safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable'; |
|
|
160 | @safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable'; |
67 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
161 | @safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object'; |
68 | |
162 | |
69 | # we bless all objects into (empty) derived classes to force a method lookup |
163 | # we bless all objects into (empty) derived classes to force a method lookup |
70 | # within the Safe compartment. |
164 | # within the Safe compartment. |
71 | for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) { |
165 | for my $pkg (qw( |
|
|
166 | cf::global cf::attachable |
|
|
167 | cf::object cf::object::player |
|
|
168 | cf::client cf::player |
|
|
169 | cf::arch cf::living |
|
|
170 | cf::map cf::party cf::region |
|
|
171 | )) { |
72 | no strict 'refs'; |
172 | no strict 'refs'; |
73 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
173 | @{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg; |
74 | } |
174 | } |
75 | |
175 | |
76 | $Event::DIED = sub { |
176 | $Event::DIED = sub { |
77 | warn "error in event callback: @_"; |
177 | warn "error in event callback: @_"; |
78 | }; |
178 | }; |
79 | |
179 | |
80 | my %ext_pkg; |
|
|
81 | my @exts; |
|
|
82 | my @hook; |
|
|
83 | my %command; |
|
|
84 | my %extcmd; |
|
|
85 | |
|
|
86 | =head2 UTILITY FUNCTIONS |
180 | =head2 UTILITY FUNCTIONS |
87 | |
181 | |
88 | =over 4 |
182 | =over 4 |
89 | |
183 | |
|
|
184 | =item dumpval $ref |
|
|
185 | |
90 | =cut |
186 | =cut |
|
|
187 | |
|
|
188 | sub dumpval { |
|
|
189 | eval { |
|
|
190 | local $SIG{__DIE__}; |
|
|
191 | my $d; |
|
|
192 | if (1) { |
|
|
193 | $d = new Data::Dumper([$_[0]], ["*var"]); |
|
|
194 | $d->Terse(1); |
|
|
195 | $d->Indent(2); |
|
|
196 | $d->Quotekeys(0); |
|
|
197 | $d->Useqq(1); |
|
|
198 | #$d->Bless(...); |
|
|
199 | $d->Seen($_[1]) if @_ > 1; |
|
|
200 | $d = $d->Dump(); |
|
|
201 | } |
|
|
202 | $d =~ s/([\x00-\x07\x09\x0b\x0c\x0e-\x1f])/sprintf "\\x%02x", ord($1)/ge; |
|
|
203 | $d |
|
|
204 | } || "[unable to dump $_[0]: '$@']"; |
|
|
205 | } |
91 | |
206 | |
92 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
207 | use JSON::Syck (); # TODO# replace by JSON::PC once working |
93 | |
208 | |
94 | =item $ref = cf::from_json $json |
209 | =item $ref = cf::from_json $json |
95 | |
210 | |
… | |
… | |
111 | sub to_json($) { |
226 | sub to_json($) { |
112 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
227 | $JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs |
113 | JSON::Syck::Dump $_[0] |
228 | JSON::Syck::Dump $_[0] |
114 | } |
229 | } |
115 | |
230 | |
|
|
231 | =item cf::lock_wait $string |
|
|
232 | |
|
|
233 | Wait until the given lock is available. See cf::lock_acquire. |
|
|
234 | |
|
|
235 | =item my $lock = cf::lock_acquire $string |
|
|
236 | |
|
|
237 | Wait until the given lock is available and then acquires it and returns |
|
|
238 | a Coro::guard object. If the guard object gets destroyed (goes out of scope, |
|
|
239 | for example when the coroutine gets canceled), the lock is automatically |
|
|
240 | returned. |
|
|
241 | |
|
|
242 | Lock names should begin with a unique identifier (for example, cf::map::find |
|
|
243 | uses map_find and cf::map::load uses map_load). |
|
|
244 | |
|
|
245 | =cut |
|
|
246 | |
|
|
247 | our %LOCK; |
|
|
248 | |
|
|
249 | sub lock_wait($) { |
|
|
250 | my ($key) = @_; |
|
|
251 | |
|
|
252 | # wait for lock, if any |
|
|
253 | while ($LOCK{$key}) { |
|
|
254 | push @{ $LOCK{$key} }, $Coro::current; |
|
|
255 | Coro::schedule; |
|
|
256 | } |
|
|
257 | } |
|
|
258 | |
|
|
259 | sub lock_acquire($) { |
|
|
260 | my ($key) = @_; |
|
|
261 | |
|
|
262 | # wait, to be sure we are not locked |
|
|
263 | lock_wait $key; |
|
|
264 | |
|
|
265 | $LOCK{$key} = []; |
|
|
266 | |
|
|
267 | Coro::guard { |
|
|
268 | # wake up all waiters, to be on the safe side |
|
|
269 | $_->ready for @{ delete $LOCK{$key} }; |
|
|
270 | } |
|
|
271 | } |
|
|
272 | |
|
|
273 | sub freeze_mainloop { |
|
|
274 | return unless $TICK_WATCHER->is_active; |
|
|
275 | |
|
|
276 | my $guard = Coro::guard { |
|
|
277 | $TICK_WATCHER->start; |
|
|
278 | }; |
|
|
279 | $TICK_WATCHER->stop; |
|
|
280 | $guard |
|
|
281 | } |
|
|
282 | |
|
|
283 | =item cf::async { BLOCK } |
|
|
284 | |
|
|
285 | Currently the same as Coro::async_pool, meaning you cannot use |
|
|
286 | C<on_destroy>, C<join> or other gimmicks on these coroutines. The only |
|
|
287 | thing you are allowed to do is call C<prio> on it. |
|
|
288 | |
|
|
289 | =cut |
|
|
290 | |
|
|
291 | BEGIN { *async = \&Coro::async_pool } |
|
|
292 | |
|
|
293 | =item cf::sync_job { BLOCK } |
|
|
294 | |
|
|
295 | The design of crossfire+ requires that the main coro ($Coro::main) is |
|
|
296 | always able to handle events or runnable, as crossfire+ is only partly |
|
|
297 | reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable. |
|
|
298 | |
|
|
299 | If it must be done, put the blocking parts into C<sync_job>. This will run |
|
|
300 | the given BLOCK in another coroutine while waiting for the result. The |
|
|
301 | server will be frozen during this time, so the block should either finish |
|
|
302 | fast or be very important. |
|
|
303 | |
|
|
304 | =cut |
|
|
305 | |
|
|
306 | sub sync_job(&) { |
|
|
307 | my ($job) = @_; |
|
|
308 | |
|
|
309 | if ($Coro::current == $Coro::main) { |
|
|
310 | # this is the main coro, too bad, we have to block |
|
|
311 | # till the operation succeeds, freezing the server :/ |
|
|
312 | |
|
|
313 | # TODO: use suspend/resume instead |
|
|
314 | # (but this is cancel-safe) |
|
|
315 | my $freeze_guard = freeze_mainloop; |
|
|
316 | |
|
|
317 | my $busy = 1; |
|
|
318 | my @res; |
|
|
319 | |
|
|
320 | (async { |
|
|
321 | @res = eval { $job->() }; |
|
|
322 | warn $@ if $@; |
|
|
323 | undef $busy; |
|
|
324 | })->prio (Coro::PRIO_MAX); |
|
|
325 | |
|
|
326 | while ($busy) { |
|
|
327 | Coro::cede or Event::one_event; |
|
|
328 | } |
|
|
329 | |
|
|
330 | wantarray ? @res : $res[0] |
|
|
331 | } else { |
|
|
332 | # we are in another coroutine, how wonderful, everything just works |
|
|
333 | |
|
|
334 | $job->() |
|
|
335 | } |
|
|
336 | } |
|
|
337 | |
|
|
338 | =item $coro = cf::async_ext { BLOCK } |
|
|
339 | |
|
|
340 | Like async, but this coro is automatically being canceled when the |
|
|
341 | extension calling this is being unloaded. |
|
|
342 | |
|
|
343 | =cut |
|
|
344 | |
|
|
345 | sub async_ext(&) { |
|
|
346 | my $cb = shift; |
|
|
347 | |
|
|
348 | my $coro = &Coro::async ($cb); |
|
|
349 | |
|
|
350 | $coro->on_destroy (sub { |
|
|
351 | delete $EXT_CORO{$coro+0}; |
|
|
352 | }); |
|
|
353 | $EXT_CORO{$coro+0} = $coro; |
|
|
354 | |
|
|
355 | $coro |
|
|
356 | } |
|
|
357 | |
|
|
358 | sub write_runtime { |
|
|
359 | my $runtime = cf::localdir . "/runtime"; |
|
|
360 | |
|
|
361 | my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644 |
|
|
362 | or return; |
|
|
363 | |
|
|
364 | my $value = $cf::RUNTIME + 90 + 10; |
|
|
365 | # 10 is the runtime save interval, for a monotonic clock |
|
|
366 | # 60 allows for the watchdog to kill the server. |
|
|
367 | |
|
|
368 | (aio_write $fh, 0, (length $value), $value, 0) <= 0 |
|
|
369 | and return; |
|
|
370 | |
|
|
371 | # always fsync - this file is important |
|
|
372 | aio_fsync $fh |
|
|
373 | and return; |
|
|
374 | |
|
|
375 | close $fh |
|
|
376 | or return; |
|
|
377 | |
|
|
378 | aio_rename "$runtime~", $runtime |
|
|
379 | and return; |
|
|
380 | |
|
|
381 | 1 |
|
|
382 | } |
|
|
383 | |
116 | =back |
384 | =back |
117 | |
385 | |
118 | =cut |
386 | =cut |
119 | |
387 | |
120 | ############################################################################# |
388 | ############################################################################# |
121 | |
389 | |
122 | =head2 EVENTS AND OBJECT ATTACHMENTS |
390 | =head2 ATTACHABLE OBJECTS |
|
|
391 | |
|
|
392 | Many objects in crossfire are so-called attachable objects. That means you can |
|
|
393 | attach callbacks/event handlers (a collection of which is called an "attachment") |
|
|
394 | to it. All such attachable objects support the following methods. |
|
|
395 | |
|
|
396 | In the following description, CLASS can be any of C<global>, C<object> |
|
|
397 | C<player>, C<client> or C<map> (i.e. the attachable objects in |
|
|
398 | crossfire+). |
123 | |
399 | |
124 | =over 4 |
400 | =over 4 |
125 | |
401 | |
126 | =item $object->attach ($attachment, key => $value...) |
|
|
127 | |
|
|
128 | =item $object->detach ($attachment) |
|
|
129 | |
|
|
130 | Attach/detach a pre-registered attachment to an object. |
|
|
131 | |
|
|
132 | =item $player->attach ($attachment, key => $value...) |
|
|
133 | |
|
|
134 | =item $player->detach ($attachment) |
|
|
135 | |
|
|
136 | Attach/detach a pre-registered attachment to a player. |
|
|
137 | |
|
|
138 | =item $map->attach ($attachment, key => $value...) |
402 | =item $attachable->attach ($attachment, key => $value...) |
139 | |
403 | |
140 | =item $map->detach ($attachment) |
404 | =item $attachable->detach ($attachment) |
141 | |
405 | |
142 | Attach/detach a pre-registered attachment to a map. |
406 | Attach/detach a pre-registered attachment to a specific object and give it |
|
|
407 | the specified key/value pairs as arguments. |
143 | |
408 | |
144 | =item $bool = $object->attached ($name) |
409 | Example, attach a minesweeper attachment to the given object, making it a |
|
|
410 | 10x10 minesweeper game: |
145 | |
411 | |
146 | =item $bool = $player->attached ($name) |
412 | $obj->attach (minesweeper => width => 10, height => 10); |
147 | |
413 | |
148 | =item $bool = $map->attached ($name) |
414 | =item $bool = $attachable->attached ($name) |
149 | |
415 | |
150 | Checks wether the named attachment is currently attached to the object. |
416 | Checks wether the named attachment is currently attached to the object. |
151 | |
417 | |
152 | =item cf::attach_global ... |
418 | =item cf::CLASS->attach ... |
153 | |
419 | |
154 | Attach handlers for global events. |
420 | =item cf::CLASS->detach ... |
155 | |
421 | |
156 | This and all following C<attach_*>-functions expect any number of the |
422 | Define an anonymous attachment and attach it to all objects of the given |
157 | following handler/hook descriptions: |
423 | CLASS. See the next function for an explanation of its arguments. |
|
|
424 | |
|
|
425 | You can attach to global events by using the C<cf::global> class. |
|
|
426 | |
|
|
427 | Example, log all player logins: |
|
|
428 | |
|
|
429 | cf::player->attach ( |
|
|
430 | on_login => sub { |
|
|
431 | my ($pl) = @_; |
|
|
432 | ... |
|
|
433 | }, |
|
|
434 | ); |
|
|
435 | |
|
|
436 | Example, attach to the jeweler skill: |
|
|
437 | |
|
|
438 | cf::object->attach ( |
|
|
439 | type => cf::SKILL, |
|
|
440 | subtype => cf::SK_JEWELER, |
|
|
441 | on_use_skill => sub { |
|
|
442 | my ($sk, $ob, $part, $dir, $msg) = @_; |
|
|
443 | ... |
|
|
444 | }, |
|
|
445 | ); |
|
|
446 | |
|
|
447 | =item cf::CLASS::attachment $name, ... |
|
|
448 | |
|
|
449 | Register an attachment by C<$name> through which attachable objects of the |
|
|
450 | given CLASS can refer to this attachment. |
|
|
451 | |
|
|
452 | Some classes such as crossfire maps and objects can specify attachments |
|
|
453 | that are attached at load/instantiate time, thus the need for a name. |
|
|
454 | |
|
|
455 | These calls expect any number of the following handler/hook descriptions: |
158 | |
456 | |
159 | =over 4 |
457 | =over 4 |
160 | |
458 | |
161 | =item prio => $number |
459 | =item prio => $number |
162 | |
460 | |
… | |
… | |
164 | by another C<prio> setting). Lower priority handlers get executed |
462 | by another C<prio> setting). Lower priority handlers get executed |
165 | earlier. The default priority is C<0>, and many built-in handlers are |
463 | earlier. The default priority is C<0>, and many built-in handlers are |
166 | registered at priority C<-1000>, so lower priorities should not be used |
464 | registered at priority C<-1000>, so lower priorities should not be used |
167 | unless you know what you are doing. |
465 | unless you know what you are doing. |
168 | |
466 | |
|
|
467 | =item type => $type |
|
|
468 | |
|
|
469 | (Only for C<< cf::object->attach >> calls), limits the attachment to the |
|
|
470 | given type of objects only (the additional parameter C<subtype> can be |
|
|
471 | used to further limit to the given subtype). |
|
|
472 | |
169 | =item on_I<event> => \&cb |
473 | =item on_I<event> => \&cb |
170 | |
474 | |
171 | Call the given code reference whenever the named event happens (event is |
475 | Call the given code reference whenever the named event happens (event is |
172 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
476 | something like C<instantiate>, C<apply>, C<use_skill> and so on, and which |
173 | handlers are recognised generally depends on the type of object these |
477 | handlers are recognised generally depends on the type of object these |
… | |
… | |
182 | package and register them. Only handlers for eevents supported by the |
486 | package and register them. Only handlers for eevents supported by the |
183 | object/class are recognised. |
487 | object/class are recognised. |
184 | |
488 | |
185 | =back |
489 | =back |
186 | |
490 | |
187 | =item cf::attach_to_type $object_type, $subtype, ... |
491 | Example, define an attachment called "sockpuppet" that calls the given |
|
|
492 | event handler when a monster attacks: |
188 | |
493 | |
189 | Attach handlers for a specific object type (e.g. TRANSPORT) and |
494 | cf::object::attachment sockpuppet => |
190 | subtype. If C<$subtype> is zero or undef, matches all objects of the given |
495 | on_skill_attack => sub { |
191 | type. |
496 | my ($self, $victim) = @_; |
192 | |
497 | ... |
193 | =item cf::attach_to_objects ... |
|
|
194 | |
|
|
195 | Attach handlers to all objects. Do not use this except for debugging or |
|
|
196 | very rare events, as handlers are (obviously) called for I<all> objects in |
|
|
197 | the game. |
|
|
198 | |
|
|
199 | =item cf::attach_to_players ... |
|
|
200 | |
|
|
201 | Attach handlers to all players. |
|
|
202 | |
|
|
203 | =item cf::attach_to_maps ... |
|
|
204 | |
|
|
205 | Attach handlers to all maps. |
|
|
206 | |
|
|
207 | =item cf:register_attachment $name, ... |
|
|
208 | |
|
|
209 | Register an attachment by name through which objects can refer to this |
|
|
210 | attachment. |
|
|
211 | |
|
|
212 | =item cf:register_player_attachment $name, ... |
|
|
213 | |
|
|
214 | Register an attachment by name through which players can refer to this |
|
|
215 | attachment. |
|
|
216 | |
|
|
217 | =item cf:register_map_attachment $name, ... |
|
|
218 | |
|
|
219 | Register an attachment by name through which maps can refer to this |
|
|
220 | attachment. |
|
|
221 | |
|
|
222 | =cut |
|
|
223 | |
|
|
224 | # the following variables are defined in .xs and must not be re-created |
|
|
225 | our @CB_GLOBAL = (); # registry for all global events |
|
|
226 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
|
|
227 | our @CB_PLAYER = (); |
|
|
228 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
|
|
229 | our @CB_MAP = (); |
|
|
230 | |
|
|
231 | my %attachment; |
|
|
232 | |
|
|
233 | sub _attach_cb($\%$$$) { |
|
|
234 | my ($registry, $undo, $event, $prio, $cb) = @_; |
|
|
235 | |
|
|
236 | use sort 'stable'; |
|
|
237 | |
|
|
238 | $cb = [$prio, $cb]; |
|
|
239 | |
|
|
240 | @{$registry->[$event]} = sort |
|
|
241 | { $a->[0] cmp $b->[0] } |
|
|
242 | @{$registry->[$event] || []}, $cb; |
|
|
243 | |
|
|
244 | push @{$undo->{cb}}, [$event, $cb]; |
|
|
245 | } |
|
|
246 | |
|
|
247 | # attach handles attaching event callbacks |
|
|
248 | # the only thing the caller has to do is pass the correct |
|
|
249 | # registry (== where the callback attaches to). |
|
|
250 | sub _attach(\@$@) { |
|
|
251 | my ($registry, $klass, @arg) = @_; |
|
|
252 | |
|
|
253 | my $prio = 0; |
|
|
254 | |
|
|
255 | my %undo = ( |
|
|
256 | registry => $registry, |
|
|
257 | cb => [], |
|
|
258 | ); |
|
|
259 | |
|
|
260 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
|
|
261 | |
|
|
262 | while (@arg) { |
|
|
263 | my $type = shift @arg; |
|
|
264 | |
|
|
265 | if ($type eq "prio") { |
|
|
266 | $prio = shift @arg; |
|
|
267 | |
|
|
268 | } elsif ($type eq "package") { |
|
|
269 | my $pkg = shift @arg; |
|
|
270 | |
|
|
271 | while (my ($name, $id) = each %cb_id) { |
|
|
272 | if (my $cb = $pkg->can ($name)) { |
|
|
273 | _attach_cb $registry, %undo, $id, $prio, $cb; |
|
|
274 | } |
|
|
275 | } |
498 | } |
276 | |
|
|
277 | } elsif (exists $cb_id{$type}) { |
|
|
278 | _attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg; |
|
|
279 | |
|
|
280 | } elsif (ref $type) { |
|
|
281 | warn "attaching objects not supported, ignoring.\n"; |
|
|
282 | |
|
|
283 | } else { |
|
|
284 | shift @arg; |
|
|
285 | warn "attach argument '$type' not supported, ignoring.\n"; |
|
|
286 | } |
|
|
287 | } |
|
|
288 | |
|
|
289 | \%undo |
|
|
290 | } |
|
|
291 | |
|
|
292 | sub _attach_attachment { |
|
|
293 | my ($obj, $name, %arg) = @_; |
|
|
294 | |
|
|
295 | return if exists $obj->{_attachment}{$name}; |
|
|
296 | |
|
|
297 | my $res; |
|
|
298 | |
|
|
299 | if (my $attach = $attachment{$name}) { |
|
|
300 | my $registry = $obj->registry; |
|
|
301 | |
|
|
302 | for (@$attach) { |
|
|
303 | my ($klass, @attach) = @$_; |
|
|
304 | $res = _attach @$registry, $klass, @attach; |
|
|
305 | } |
|
|
306 | |
|
|
307 | $obj->{$name} = \%arg; |
|
|
308 | } else { |
|
|
309 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
310 | } |
|
|
311 | |
|
|
312 | $obj->{_attachment}{$name} = undef; |
|
|
313 | |
|
|
314 | $res->{attachment} = $name; |
|
|
315 | $res |
|
|
316 | } |
|
|
317 | |
|
|
318 | *cf::object::attach = |
|
|
319 | *cf::player::attach = |
|
|
320 | *cf::map::attach = sub { |
|
|
321 | my ($obj, $name, %arg) = @_; |
|
|
322 | |
|
|
323 | _attach_attachment $obj, $name, %arg; |
|
|
324 | }; |
|
|
325 | |
|
|
326 | # all those should be optimised |
|
|
327 | *cf::object::detach = |
|
|
328 | *cf::player::detach = |
|
|
329 | *cf::map::detach = sub { |
|
|
330 | my ($obj, $name) = @_; |
|
|
331 | |
|
|
332 | delete $obj->{_attachment}{$name}; |
|
|
333 | reattach ($obj); |
|
|
334 | }; |
|
|
335 | |
|
|
336 | *cf::object::attached = |
|
|
337 | *cf::player::attached = |
|
|
338 | *cf::map::attached = sub { |
|
|
339 | my ($obj, $name) = @_; |
|
|
340 | |
|
|
341 | exists $obj->{_attachment}{$name} |
|
|
342 | }; |
|
|
343 | |
|
|
344 | sub attach_global { |
|
|
345 | _attach @CB_GLOBAL, KLASS_GLOBAL, @_ |
|
|
346 | } |
|
|
347 | |
|
|
348 | sub attach_to_type { |
|
|
349 | my $type = shift; |
|
|
350 | my $subtype = shift; |
|
|
351 | |
|
|
352 | _attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_ |
|
|
353 | } |
|
|
354 | |
|
|
355 | sub attach_to_objects { |
|
|
356 | _attach @CB_OBJECT, KLASS_OBJECT, @_ |
|
|
357 | } |
|
|
358 | |
|
|
359 | sub attach_to_players { |
|
|
360 | _attach @CB_PLAYER, KLASS_PLAYER, @_ |
|
|
361 | } |
|
|
362 | |
|
|
363 | sub attach_to_maps { |
|
|
364 | _attach @CB_MAP, KLASS_MAP, @_ |
|
|
365 | } |
|
|
366 | |
|
|
367 | sub register_attachment { |
|
|
368 | my $name = shift; |
|
|
369 | |
|
|
370 | $attachment{$name} = [[KLASS_OBJECT, @_]]; |
|
|
371 | } |
|
|
372 | |
|
|
373 | sub register_player_attachment { |
|
|
374 | my $name = shift; |
|
|
375 | |
|
|
376 | $attachment{$name} = [[KLASS_PLAYER, @_]]; |
|
|
377 | } |
|
|
378 | |
|
|
379 | sub register_map_attachment { |
|
|
380 | my $name = shift; |
|
|
381 | |
|
|
382 | $attachment{$name} = [[KLASS_MAP, @_]]; |
|
|
383 | } |
|
|
384 | |
|
|
385 | our $override; |
|
|
386 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
|
|
387 | |
|
|
388 | sub override { |
|
|
389 | $override = 1; |
|
|
390 | @invoke_results = (); |
|
|
391 | } |
|
|
392 | |
|
|
393 | sub do_invoke { |
|
|
394 | my $event = shift; |
|
|
395 | my $callbacks = shift; |
|
|
396 | |
|
|
397 | @invoke_results = (); |
|
|
398 | |
|
|
399 | local $override; |
|
|
400 | |
|
|
401 | for (@$callbacks) { |
|
|
402 | eval { &{$_->[1]} }; |
|
|
403 | |
|
|
404 | if ($@) { |
|
|
405 | warn "$@"; |
|
|
406 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
|
|
407 | override; |
|
|
408 | } |
|
|
409 | |
|
|
410 | return 1 if $override; |
|
|
411 | } |
|
|
412 | |
|
|
413 | 0 |
499 | } |
414 | } |
|
|
415 | |
500 | |
416 | =item $bool = cf::invoke EVENT_GLOBAL_XXX, ... |
501 | =item $attachable->valid |
417 | |
|
|
418 | =item $bool = $object->invoke (EVENT_OBJECT_XXX, ...) |
|
|
419 | |
|
|
420 | =item $bool = $player->invoke (EVENT_PLAYER_XXX, ...) |
|
|
421 | |
|
|
422 | =item $bool = $map->invoke (EVENT_MAP_XXX, ...) |
|
|
423 | |
|
|
424 | Generate a global/object/player/map-specific event with the given arguments. |
|
|
425 | |
|
|
426 | This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be |
|
|
427 | removed in future versions), and there is no public API to access override |
|
|
428 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
429 | |
|
|
430 | =back |
|
|
431 | |
|
|
432 | =cut |
|
|
433 | |
|
|
434 | ############################################################################# |
|
|
435 | |
|
|
436 | =head2 METHODS VALID FOR ALL CORE OBJECTS |
|
|
437 | |
|
|
438 | =over 4 |
|
|
439 | |
|
|
440 | =item $object->valid, $player->valid, $map->valid |
|
|
441 | |
502 | |
442 | Just because you have a perl object does not mean that the corresponding |
503 | Just because you have a perl object does not mean that the corresponding |
443 | C-level object still exists. If you try to access an object that has no |
504 | C-level object still exists. If you try to access an object that has no |
444 | valid C counterpart anymore you get an exception at runtime. This method |
505 | valid C counterpart anymore you get an exception at runtime. This method |
445 | can be used to test for existence of the C object part without causing an |
506 | can be used to test for existence of the C object part without causing an |
446 | exception. |
507 | exception. |
447 | |
508 | |
|
|
509 | =cut |
|
|
510 | |
|
|
511 | # the following variables are defined in .xs and must not be re-created |
|
|
512 | our @CB_GLOBAL = (); # registry for all global events |
|
|
513 | our @CB_ATTACHABLE = (); # registry for all attachables |
|
|
514 | our @CB_OBJECT = (); # all objects (should not be used except in emergency) |
|
|
515 | our @CB_PLAYER = (); |
|
|
516 | our @CB_CLIENT = (); |
|
|
517 | our @CB_TYPE = (); # registry for type (cf-object class) based events |
|
|
518 | our @CB_MAP = (); |
|
|
519 | |
|
|
520 | my %attachment; |
|
|
521 | |
|
|
522 | sub cf::attachable::thawer_merge { |
|
|
523 | # simply override everything except _meta |
|
|
524 | local $_[0]{_meta}; |
|
|
525 | %{$_[0]} = %{$_[1]}; |
|
|
526 | } |
|
|
527 | |
|
|
528 | sub _attach_cb($$$$) { |
|
|
529 | my ($registry, $event, $prio, $cb) = @_; |
|
|
530 | |
|
|
531 | use sort 'stable'; |
|
|
532 | |
|
|
533 | $cb = [$prio, $cb]; |
|
|
534 | |
|
|
535 | @{$registry->[$event]} = sort |
|
|
536 | { $a->[0] cmp $b->[0] } |
|
|
537 | @{$registry->[$event] || []}, $cb; |
|
|
538 | } |
|
|
539 | |
|
|
540 | # hack |
|
|
541 | my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP; |
|
|
542 | |
|
|
543 | # attach handles attaching event callbacks |
|
|
544 | # the only thing the caller has to do is pass the correct |
|
|
545 | # registry (== where the callback attaches to). |
|
|
546 | sub _attach { |
|
|
547 | my ($registry, $klass, @arg) = @_; |
|
|
548 | |
|
|
549 | my $object_type; |
|
|
550 | my $prio = 0; |
|
|
551 | my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT; |
|
|
552 | |
|
|
553 | #TODO: get rid of this hack |
|
|
554 | if ($attachable_klass{$klass}) { |
|
|
555 | %cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT); |
|
|
556 | } |
|
|
557 | |
|
|
558 | while (@arg) { |
|
|
559 | my $type = shift @arg; |
|
|
560 | |
|
|
561 | if ($type eq "prio") { |
|
|
562 | $prio = shift @arg; |
|
|
563 | |
|
|
564 | } elsif ($type eq "type") { |
|
|
565 | $object_type = shift @arg; |
|
|
566 | $registry = $CB_TYPE[$object_type] ||= []; |
|
|
567 | |
|
|
568 | } elsif ($type eq "subtype") { |
|
|
569 | defined $object_type or Carp::croak "subtype specified without type"; |
|
|
570 | my $object_subtype = shift @arg; |
|
|
571 | $registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= []; |
|
|
572 | |
|
|
573 | } elsif ($type eq "package") { |
|
|
574 | my $pkg = shift @arg; |
|
|
575 | |
|
|
576 | while (my ($name, $id) = each %cb_id) { |
|
|
577 | if (my $cb = $pkg->can ($name)) { |
|
|
578 | _attach_cb $registry, $id, $prio, $cb; |
|
|
579 | } |
|
|
580 | } |
|
|
581 | |
|
|
582 | } elsif (exists $cb_id{$type}) { |
|
|
583 | _attach_cb $registry, $cb_id{$type}, $prio, shift @arg; |
|
|
584 | |
|
|
585 | } elsif (ref $type) { |
|
|
586 | warn "attaching objects not supported, ignoring.\n"; |
|
|
587 | |
|
|
588 | } else { |
|
|
589 | shift @arg; |
|
|
590 | warn "attach argument '$type' not supported, ignoring.\n"; |
|
|
591 | } |
|
|
592 | } |
|
|
593 | } |
|
|
594 | |
|
|
595 | sub _object_attach { |
|
|
596 | my ($obj, $name, %arg) = @_; |
|
|
597 | |
|
|
598 | return if exists $obj->{_attachment}{$name}; |
|
|
599 | |
|
|
600 | if (my $attach = $attachment{$name}) { |
|
|
601 | my $registry = $obj->registry; |
|
|
602 | |
|
|
603 | for (@$attach) { |
|
|
604 | my ($klass, @attach) = @$_; |
|
|
605 | _attach $registry, $klass, @attach; |
|
|
606 | } |
|
|
607 | |
|
|
608 | $obj->{$name} = \%arg; |
|
|
609 | } else { |
|
|
610 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
|
|
611 | } |
|
|
612 | |
|
|
613 | $obj->{_attachment}{$name} = undef; |
|
|
614 | } |
|
|
615 | |
|
|
616 | sub cf::attachable::attach { |
|
|
617 | if (ref $_[0]) { |
|
|
618 | _object_attach @_; |
|
|
619 | } else { |
|
|
620 | _attach shift->_attach_registry, @_; |
|
|
621 | } |
|
|
622 | }; |
|
|
623 | |
|
|
624 | # all those should be optimised |
|
|
625 | sub cf::attachable::detach { |
|
|
626 | my ($obj, $name) = @_; |
|
|
627 | |
|
|
628 | if (ref $obj) { |
|
|
629 | delete $obj->{_attachment}{$name}; |
|
|
630 | reattach ($obj); |
|
|
631 | } else { |
|
|
632 | Carp::croak "cannot, currently, detach class attachments"; |
|
|
633 | } |
|
|
634 | }; |
|
|
635 | |
|
|
636 | sub cf::attachable::attached { |
|
|
637 | my ($obj, $name) = @_; |
|
|
638 | |
|
|
639 | exists $obj->{_attachment}{$name} |
|
|
640 | } |
|
|
641 | |
|
|
642 | for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) { |
|
|
643 | eval "#line " . __LINE__ . " 'cf.pm' |
|
|
644 | sub cf::\L$klass\E::_attach_registry { |
|
|
645 | (\\\@CB_$klass, KLASS_$klass) |
|
|
646 | } |
|
|
647 | |
|
|
648 | sub cf::\L$klass\E::attachment { |
|
|
649 | my \$name = shift; |
|
|
650 | |
|
|
651 | \$attachment{\$name} = [[KLASS_$klass, \@_]]; |
|
|
652 | } |
|
|
653 | "; |
|
|
654 | die if $@; |
|
|
655 | } |
|
|
656 | |
|
|
657 | our $override; |
|
|
658 | our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals? |
|
|
659 | |
|
|
660 | sub override { |
|
|
661 | $override = 1; |
|
|
662 | @invoke_results = (); |
|
|
663 | } |
|
|
664 | |
|
|
665 | sub do_invoke { |
|
|
666 | my $event = shift; |
|
|
667 | my $callbacks = shift; |
|
|
668 | |
|
|
669 | @invoke_results = (); |
|
|
670 | |
|
|
671 | local $override; |
|
|
672 | |
|
|
673 | for (@$callbacks) { |
|
|
674 | eval { &{$_->[1]} }; |
|
|
675 | |
|
|
676 | if ($@) { |
|
|
677 | warn "$@"; |
|
|
678 | warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n"; |
|
|
679 | override; |
|
|
680 | } |
|
|
681 | |
|
|
682 | return 1 if $override; |
|
|
683 | } |
|
|
684 | |
|
|
685 | 0 |
|
|
686 | } |
|
|
687 | |
|
|
688 | =item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...) |
|
|
689 | |
|
|
690 | =item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...) |
|
|
691 | |
|
|
692 | Generate an object-specific event with the given arguments. |
|
|
693 | |
|
|
694 | This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be |
|
|
695 | removed in future versions), and there is no public API to access override |
|
|
696 | results (if you must, access C<@cf::invoke_results> directly). |
|
|
697 | |
448 | =back |
698 | =back |
449 | |
699 | |
450 | =cut |
700 | =cut |
451 | |
|
|
452 | *cf::object::valid = |
|
|
453 | *cf::player::valid = |
|
|
454 | *cf::map::valid = \&cf::_valid; |
|
|
455 | |
701 | |
456 | ############################################################################# |
702 | ############################################################################# |
457 | # object support |
703 | # object support |
458 | |
704 | |
459 | sub instantiate { |
|
|
460 | my ($obj, $data) = @_; |
|
|
461 | |
|
|
462 | $data = from_json $data; |
|
|
463 | |
|
|
464 | for (@$data) { |
|
|
465 | my ($name, $args) = @$_; |
|
|
466 | |
|
|
467 | $obj->attach ($name, %{$args || {} }); |
|
|
468 | } |
|
|
469 | } |
|
|
470 | |
|
|
471 | # basically do the same as instantiate, without calling instantiate |
|
|
472 | sub reattach { |
705 | sub reattach { |
|
|
706 | # basically do the same as instantiate, without calling instantiate |
473 | my ($obj) = @_; |
707 | my ($obj) = @_; |
|
|
708 | |
|
|
709 | bless $obj, ref $obj; # re-bless in case extensions have been reloaded |
|
|
710 | |
474 | my $registry = $obj->registry; |
711 | my $registry = $obj->registry; |
475 | |
712 | |
476 | @$registry = (); |
713 | @$registry = (); |
477 | |
714 | |
478 | delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
715 | delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} }; |
479 | |
716 | |
480 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
717 | for my $name (keys %{ $obj->{_attachment} || {} }) { |
481 | if (my $attach = $attachment{$name}) { |
718 | if (my $attach = $attachment{$name}) { |
482 | for (@$attach) { |
719 | for (@$attach) { |
483 | my ($klass, @attach) = @$_; |
720 | my ($klass, @attach) = @$_; |
484 | _attach @$registry, $klass, @attach; |
721 | _attach $registry, $klass, @attach; |
485 | } |
722 | } |
486 | } else { |
723 | } else { |
487 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
724 | warn "object uses attachment '$name' that is not available, postponing.\n"; |
488 | } |
725 | } |
489 | } |
726 | } |
490 | } |
727 | } |
491 | |
728 | |
492 | sub object_freezer_save { |
729 | cf::attachable->attach ( |
493 | my ($filename, $rdata, $objs) = @_; |
|
|
494 | |
|
|
495 | if (length $$rdata) { |
|
|
496 | warn sprintf "saving %s (%d,%d)\n", |
|
|
497 | $filename, length $$rdata, scalar @$objs; |
|
|
498 | |
|
|
499 | if (open my $fh, ">:raw", "$filename~") { |
|
|
500 | chmod SAVE_MODE, $fh; |
|
|
501 | syswrite $fh, $$rdata; |
|
|
502 | close $fh; |
|
|
503 | |
|
|
504 | if (@$objs && open my $fh, ">:raw", "$filename.pst~") { |
|
|
505 | chmod SAVE_MODE, $fh; |
|
|
506 | syswrite $fh, Storable::nfreeze { version => 1, objs => $objs }; |
|
|
507 | close $fh; |
|
|
508 | rename "$filename.pst~", "$filename.pst"; |
|
|
509 | } else { |
|
|
510 | unlink "$filename.pst"; |
|
|
511 | } |
|
|
512 | |
|
|
513 | rename "$filename~", $filename; |
|
|
514 | } else { |
|
|
515 | warn "FATAL: $filename~: $!\n"; |
|
|
516 | } |
|
|
517 | } else { |
|
|
518 | unlink $filename; |
|
|
519 | unlink "$filename.pst"; |
|
|
520 | } |
|
|
521 | } |
|
|
522 | |
|
|
523 | sub object_thawer_load { |
|
|
524 | my ($filename) = @_; |
|
|
525 | |
|
|
526 | local $/; |
|
|
527 | |
|
|
528 | my $av; |
|
|
529 | |
|
|
530 | #TODO: use sysread etc. |
|
|
531 | if (open my $data, "<:raw:perlio", $filename) { |
|
|
532 | $data = <$data>; |
|
|
533 | if (open my $pst, "<:raw:perlio", "$filename.pst") { |
|
|
534 | $av = eval { (Storable::thaw <$pst>)->{objs} }; |
|
|
535 | } |
|
|
536 | return ($data, $av); |
|
|
537 | } |
|
|
538 | |
|
|
539 | () |
|
|
540 | } |
|
|
541 | |
|
|
542 | attach_to_objects |
|
|
543 | prio => -1000000, |
730 | prio => -1000000, |
|
|
731 | on_instantiate => sub { |
|
|
732 | my ($obj, $data) = @_; |
|
|
733 | |
|
|
734 | $data = from_json $data; |
|
|
735 | |
|
|
736 | for (@$data) { |
|
|
737 | my ($name, $args) = @$_; |
|
|
738 | |
|
|
739 | $obj->attach ($name, %{$args || {} }); |
|
|
740 | } |
|
|
741 | }, |
|
|
742 | on_reattach => \&reattach, |
544 | on_clone => sub { |
743 | on_clone => sub { |
545 | my ($src, $dst) = @_; |
744 | my ($src, $dst) = @_; |
546 | |
745 | |
547 | @{$dst->registry} = @{$src->registry}; |
746 | @{$dst->registry} = @{$src->registry}; |
548 | |
747 | |
549 | %$dst = %$src; |
748 | %$dst = %$src; |
550 | |
749 | |
551 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
750 | %{$dst->{_attachment}} = %{$src->{_attachment}} |
552 | if exists $src->{_attachment}; |
751 | if exists $src->{_attachment}; |
553 | }, |
752 | }, |
554 | ; |
753 | ); |
|
|
754 | |
|
|
755 | sub object_freezer_save { |
|
|
756 | my ($filename, $rdata, $objs) = @_; |
|
|
757 | |
|
|
758 | sync_job { |
|
|
759 | if (length $$rdata) { |
|
|
760 | warn sprintf "saving %s (%d,%d)\n", |
|
|
761 | $filename, length $$rdata, scalar @$objs; |
|
|
762 | |
|
|
763 | if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) { |
|
|
764 | chmod SAVE_MODE, $fh; |
|
|
765 | aio_write $fh, 0, (length $$rdata), $$rdata, 0; |
|
|
766 | aio_fsync $fh if $cf::USE_FSYNC; |
|
|
767 | close $fh; |
|
|
768 | |
|
|
769 | if (@$objs) { |
|
|
770 | if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) { |
|
|
771 | chmod SAVE_MODE, $fh; |
|
|
772 | my $data = Storable::nfreeze { version => 1, objs => $objs }; |
|
|
773 | aio_write $fh, 0, (length $data), $data, 0; |
|
|
774 | aio_fsync $fh if $cf::USE_FSYNC; |
|
|
775 | close $fh; |
|
|
776 | aio_rename "$filename.pst~", "$filename.pst"; |
|
|
777 | } |
|
|
778 | } else { |
|
|
779 | aio_unlink "$filename.pst"; |
|
|
780 | } |
|
|
781 | |
|
|
782 | aio_rename "$filename~", $filename; |
|
|
783 | } else { |
|
|
784 | warn "FATAL: $filename~: $!\n"; |
|
|
785 | } |
|
|
786 | } else { |
|
|
787 | aio_unlink $filename; |
|
|
788 | aio_unlink "$filename.pst"; |
|
|
789 | } |
|
|
790 | } |
|
|
791 | } |
|
|
792 | |
|
|
793 | sub object_freezer_as_string { |
|
|
794 | my ($rdata, $objs) = @_; |
|
|
795 | |
|
|
796 | use Data::Dumper; |
|
|
797 | |
|
|
798 | $$rdata . Dumper $objs |
|
|
799 | } |
|
|
800 | |
|
|
801 | sub object_thawer_load { |
|
|
802 | my ($filename) = @_; |
|
|
803 | |
|
|
804 | my ($data, $av); |
|
|
805 | |
|
|
806 | (aio_load $filename, $data) >= 0 |
|
|
807 | or return; |
|
|
808 | |
|
|
809 | unless (aio_stat "$filename.pst") { |
|
|
810 | (aio_load "$filename.pst", $av) >= 0 |
|
|
811 | or return; |
|
|
812 | $av = eval { (Storable::thaw $av)->{objs} }; |
|
|
813 | } |
|
|
814 | |
|
|
815 | warn sprintf "loading %s (%d)\n", |
|
|
816 | $filename, length $data, scalar @{$av || []};#d# |
|
|
817 | return ($data, $av); |
|
|
818 | } |
555 | |
819 | |
556 | ############################################################################# |
820 | ############################################################################# |
557 | # old plug-in events |
821 | # command handling &c |
558 | |
822 | |
559 | sub inject_event { |
823 | =item cf::register_command $name => \&callback($ob,$args); |
560 | my $extension = shift; |
|
|
561 | my $event_code = shift; |
|
|
562 | |
824 | |
563 | my $cb = $hook[$event_code]{$extension} |
825 | Register a callback for execution when the client sends the user command |
564 | or return; |
826 | $name. |
565 | |
827 | |
566 | &$cb |
828 | =cut |
567 | } |
|
|
568 | |
|
|
569 | sub inject_global_event { |
|
|
570 | my $event = shift; |
|
|
571 | |
|
|
572 | my $cb = $hook[$event] |
|
|
573 | or return; |
|
|
574 | |
|
|
575 | List::Util::max map &$_, values %$cb |
|
|
576 | } |
|
|
577 | |
|
|
578 | sub inject_command { |
|
|
579 | my ($name, $obj, $params) = @_; |
|
|
580 | |
|
|
581 | for my $cmd (@{ $command{$name} }) { |
|
|
582 | $cmd->[1]->($obj, $params); |
|
|
583 | } |
|
|
584 | |
|
|
585 | -1 |
|
|
586 | } |
|
|
587 | |
829 | |
588 | sub register_command { |
830 | sub register_command { |
589 | my ($name, $time, $cb) = @_; |
831 | my ($name, $cb) = @_; |
590 | |
832 | |
591 | my $caller = caller; |
833 | my $caller = caller; |
592 | #warn "registering command '$name/$time' to '$caller'"; |
834 | #warn "registering command '$name/$time' to '$caller'"; |
593 | |
835 | |
594 | push @{ $command{$name} }, [$time, $cb, $caller]; |
836 | push @{ $COMMAND{$name} }, [$caller, $cb]; |
595 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} }; |
|
|
596 | } |
837 | } |
|
|
838 | |
|
|
839 | =item cf::register_extcmd $name => \&callback($pl,$packet); |
|
|
840 | |
|
|
841 | Register a callbackf ro execution when the client sends an extcmd packet. |
|
|
842 | |
|
|
843 | If the callback returns something, it is sent back as if reply was being |
|
|
844 | called. |
|
|
845 | |
|
|
846 | =cut |
597 | |
847 | |
598 | sub register_extcmd { |
848 | sub register_extcmd { |
599 | my ($name, $cb) = @_; |
849 | my ($name, $cb) = @_; |
600 | |
850 | |
601 | my $caller = caller; |
851 | $EXTCMD{$name} = $cb; |
602 | #warn "registering extcmd '$name' to '$caller'"; |
|
|
603 | |
|
|
604 | $extcmd{$name} = [$cb, $caller]; |
|
|
605 | } |
852 | } |
606 | |
853 | |
607 | sub register { |
854 | cf::player->attach ( |
608 | my ($base, $pkg) = @_; |
855 | on_command => sub { |
|
|
856 | my ($pl, $name, $params) = @_; |
609 | |
857 | |
610 | #TODO |
858 | my $cb = $COMMAND{$name} |
611 | } |
859 | or return; |
|
|
860 | |
|
|
861 | for my $cmd (@$cb) { |
|
|
862 | $cmd->[1]->($pl->ob, $params); |
|
|
863 | } |
|
|
864 | |
|
|
865 | cf::override; |
|
|
866 | }, |
|
|
867 | on_extcmd => sub { |
|
|
868 | my ($pl, $buf) = @_; |
|
|
869 | |
|
|
870 | my $msg = eval { from_json $buf }; |
|
|
871 | |
|
|
872 | if (ref $msg) { |
|
|
873 | if (my $cb = $EXTCMD{$msg->{msgtype}}) { |
|
|
874 | if (my %reply = $cb->($pl, $msg)) { |
|
|
875 | $pl->ext_reply ($msg->{msgid}, %reply); |
|
|
876 | } |
|
|
877 | } |
|
|
878 | } else { |
|
|
879 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
|
|
880 | } |
|
|
881 | |
|
|
882 | cf::override; |
|
|
883 | }, |
|
|
884 | ); |
612 | |
885 | |
613 | sub load_extension { |
886 | sub load_extension { |
614 | my ($path) = @_; |
887 | my ($path) = @_; |
615 | |
888 | |
616 | $path =~ /([^\/\\]+)\.ext$/ or die "$path"; |
889 | $path =~ /([^\/\\]+)\.ext$/ or die "$path"; |
617 | my $base = $1; |
890 | my $base = $1; |
618 | my $pkg = $1; |
891 | my $pkg = $1; |
619 | $pkg =~ s/[^[:word:]]/_/g; |
892 | $pkg =~ s/[^[:word:]]/_/g; |
620 | $pkg = "ext::$pkg"; |
893 | $pkg = "ext::$pkg"; |
621 | |
894 | |
622 | warn "loading '$path' into '$pkg'\n"; |
895 | warn "... loading '$path' into '$pkg'\n"; |
623 | |
896 | |
624 | open my $fh, "<:utf8", $path |
897 | open my $fh, "<:utf8", $path |
625 | or die "$path: $!"; |
898 | or die "$path: $!"; |
626 | |
899 | |
627 | my $source = |
900 | my $source = |
628 | "package $pkg; use strict; use utf8;\n" |
901 | "package $pkg; use strict; use utf8;\n" |
629 | . "#line 1 \"$path\"\n{\n" |
902 | . "#line 1 \"$path\"\n{\n" |
630 | . (do { local $/; <$fh> }) |
903 | . (do { local $/; <$fh> }) |
631 | . "\n};\n1"; |
904 | . "\n};\n1"; |
632 | |
905 | |
633 | eval $source |
906 | unless (eval $source) { |
634 | or die "$path: $@"; |
907 | my $msg = $@ ? "$path: $@\n" |
635 | |
908 | : "extension disabled.\n"; |
636 | push @exts, $pkg; |
909 | if ($source =~ /^#!.*perl.*#.*MANDATORY/m) { # ugly match |
637 | $ext_pkg{$base} = $pkg; |
910 | warn $@; |
638 | |
911 | warn "mandatory extension failed to load, exiting.\n"; |
639 | # no strict 'refs'; |
912 | exit 1; |
640 | # @{"$pkg\::ISA"} = ext::; |
913 | } |
641 | |
914 | die $@; |
642 | register $base, $pkg; |
|
|
643 | } |
|
|
644 | |
|
|
645 | sub unload_extension { |
|
|
646 | my ($pkg) = @_; |
|
|
647 | |
|
|
648 | warn "removing extension $pkg\n"; |
|
|
649 | |
|
|
650 | # remove hooks |
|
|
651 | #TODO |
|
|
652 | # for my $idx (0 .. $#PLUGIN_EVENT) { |
|
|
653 | # delete $hook[$idx]{$pkg}; |
|
|
654 | # } |
915 | } |
655 | |
916 | |
656 | # remove commands |
917 | push @EXTS, $pkg; |
657 | for my $name (keys %command) { |
|
|
658 | my @cb = grep $_->[2] ne $pkg, @{ $command{$name} }; |
|
|
659 | |
|
|
660 | if (@cb) { |
|
|
661 | $command{$name} = \@cb; |
|
|
662 | $COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb; |
|
|
663 | } else { |
|
|
664 | delete $command{$name}; |
|
|
665 | delete $COMMAND{"$name\000"}; |
|
|
666 | } |
|
|
667 | } |
|
|
668 | |
|
|
669 | # remove extcmds |
|
|
670 | for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) { |
|
|
671 | delete $extcmd{$name}; |
|
|
672 | } |
|
|
673 | |
|
|
674 | if (my $cb = $pkg->can ("unload")) { |
|
|
675 | eval { |
|
|
676 | $cb->($pkg); |
|
|
677 | 1 |
|
|
678 | } or warn "$pkg unloaded, but with errors: $@"; |
|
|
679 | } |
|
|
680 | |
|
|
681 | Symbol::delete_package $pkg; |
|
|
682 | } |
918 | } |
683 | |
919 | |
684 | sub load_extensions { |
920 | sub load_extensions { |
685 | my $LIBDIR = maps_directory "perl"; |
|
|
686 | |
|
|
687 | for my $ext (<$LIBDIR/*.ext>) { |
921 | for my $ext (<$LIBDIR/*.ext>) { |
688 | next unless -r $ext; |
922 | next unless -r $ext; |
689 | eval { |
923 | eval { |
690 | load_extension $ext; |
924 | load_extension $ext; |
691 | 1 |
925 | 1 |
692 | } or warn "$ext not loaded: $@"; |
926 | } or warn "$ext not loaded: $@"; |
693 | } |
927 | } |
694 | } |
928 | } |
695 | |
929 | |
696 | ############################################################################# |
930 | ############################################################################# |
697 | # extcmd framework, basically convert ext <msg> |
|
|
698 | # into pkg::->on_extcmd_arg1 (...) while shortcutting a few |
|
|
699 | |
931 | |
700 | attach_to_players |
932 | =head2 CORE EXTENSIONS |
701 | on_extcmd => sub { |
933 | |
|
|
934 | Functions and methods that extend core crossfire objects. |
|
|
935 | |
|
|
936 | =cut |
|
|
937 | |
|
|
938 | package cf::player; |
|
|
939 | |
|
|
940 | use Coro::AIO; |
|
|
941 | |
|
|
942 | =head3 cf::player |
|
|
943 | |
|
|
944 | =over 4 |
|
|
945 | |
|
|
946 | =item cf::player::find $login |
|
|
947 | |
|
|
948 | Returns the given player object, loading it if necessary (might block). |
|
|
949 | |
|
|
950 | =cut |
|
|
951 | |
|
|
952 | sub playerdir($) { |
|
|
953 | cf::localdir |
|
|
954 | . "/" |
|
|
955 | . cf::playerdir |
|
|
956 | . "/" |
|
|
957 | . (ref $_[0] ? $_[0]->ob->name : $_[0]) |
|
|
958 | } |
|
|
959 | |
|
|
960 | sub path($) { |
|
|
961 | my $login = ref $_[0] ? $_[0]->ob->name : $_[0]; |
|
|
962 | |
|
|
963 | (playerdir $login) . "/$login.pl" |
|
|
964 | } |
|
|
965 | |
|
|
966 | sub find_active($) { |
|
|
967 | $cf::PLAYER{$_[0]} |
|
|
968 | and $cf::PLAYER{$_[0]}->active |
|
|
969 | and $cf::PLAYER{$_[0]} |
|
|
970 | } |
|
|
971 | |
|
|
972 | sub exists($) { |
|
|
973 | my ($login) = @_; |
|
|
974 | |
|
|
975 | $cf::PLAYER{$login} |
|
|
976 | or cf::sync_job { !aio_stat path $login } |
|
|
977 | } |
|
|
978 | |
|
|
979 | sub find($) { |
|
|
980 | return $cf::PLAYER{$_[0]} || do { |
|
|
981 | my $login = $_[0]; |
|
|
982 | |
|
|
983 | my $guard = cf::lock_acquire "user_find:$login"; |
|
|
984 | |
|
|
985 | $cf::PLAYER{$_[0]} || do { |
|
|
986 | my $pl = load_pl path $login |
|
|
987 | or return; |
|
|
988 | $cf::PLAYER{$login} = $pl |
|
|
989 | } |
|
|
990 | } |
|
|
991 | } |
|
|
992 | |
|
|
993 | sub save($) { |
|
|
994 | my ($pl) = @_; |
|
|
995 | |
|
|
996 | return if $pl->{deny_save}; |
|
|
997 | |
|
|
998 | my $path = path $pl; |
|
|
999 | my $guard = cf::lock_acquire "user_save:$path"; |
|
|
1000 | |
|
|
1001 | return if $pl->{deny_save}; |
|
|
1002 | |
|
|
1003 | aio_mkdir playerdir $pl, 0770; |
|
|
1004 | $pl->{last_save} = $cf::RUNTIME; |
|
|
1005 | |
|
|
1006 | $pl->save_pl ($path); |
|
|
1007 | Coro::cede; |
|
|
1008 | } |
|
|
1009 | |
|
|
1010 | sub new($) { |
|
|
1011 | my ($login) = @_; |
|
|
1012 | |
|
|
1013 | my $self = create; |
|
|
1014 | |
|
|
1015 | $self->ob->name ($login); |
|
|
1016 | $self->{deny_save} = 1; |
|
|
1017 | |
|
|
1018 | $cf::PLAYER{$login} = $self; |
|
|
1019 | |
|
|
1020 | $self |
|
|
1021 | } |
|
|
1022 | |
|
|
1023 | =item $pl->quit_character |
|
|
1024 | |
|
|
1025 | Nukes the player without looking back. If logged in, the connection will |
|
|
1026 | be destroyed. May block for a long time. |
|
|
1027 | |
|
|
1028 | =cut |
|
|
1029 | |
|
|
1030 | sub quit_character { |
|
|
1031 | my ($pl) = @_; |
|
|
1032 | |
|
|
1033 | $pl->{deny_save} = 1; |
|
|
1034 | $pl->password ("*"); # this should lock out the player until we nuked the dir |
|
|
1035 | |
|
|
1036 | $pl->invoke (cf::EVENT_PLAYER_LOGOUT, 1) if $pl->active; |
|
|
1037 | $pl->deactivate; |
|
|
1038 | $pl->invoke (cf::EVENT_PLAYER_QUIT); |
|
|
1039 | $pl->ns->destroy if $pl->ns; |
|
|
1040 | |
|
|
1041 | my $path = playerdir $pl; |
|
|
1042 | my $temp = "$path~$cf::RUNTIME~deleting~"; |
|
|
1043 | aio_rename $path, $temp; |
|
|
1044 | delete $cf::PLAYER{$pl->ob->name}; |
|
|
1045 | $pl->destroy; |
|
|
1046 | IO::AIO::aio_rmtree $temp; |
|
|
1047 | } |
|
|
1048 | |
|
|
1049 | =item cf::player::list_logins |
|
|
1050 | |
|
|
1051 | Returns am arrayref of all valid playernames in the system, can take a |
|
|
1052 | while and may block, so not sync_job-capable, ever. |
|
|
1053 | |
|
|
1054 | =cut |
|
|
1055 | |
|
|
1056 | sub list_logins { |
|
|
1057 | my $dirs = aio_readdir cf::localdir . "/" . cf::playerdir |
|
|
1058 | or return []; |
|
|
1059 | |
|
|
1060 | my @logins; |
|
|
1061 | |
|
|
1062 | for my $login (@$dirs) { |
|
|
1063 | my $fh = aio_open path $login, Fcntl::O_RDONLY, 0 or next; |
|
|
1064 | aio_read $fh, 0, 512, my $buf, 0 or next; |
|
|
1065 | $buf !~ /^password -------------$/m or next; # official not-valid tag |
|
|
1066 | |
|
|
1067 | utf8::decode $login; |
|
|
1068 | push @logins, $login; |
|
|
1069 | } |
|
|
1070 | |
|
|
1071 | \@logins |
|
|
1072 | } |
|
|
1073 | |
|
|
1074 | =item $player->maps |
|
|
1075 | |
|
|
1076 | Returns an arrayref of map paths that are private for this |
|
|
1077 | player. May block. |
|
|
1078 | |
|
|
1079 | =cut |
|
|
1080 | |
|
|
1081 | sub maps($) { |
|
|
1082 | my ($pl) = @_; |
|
|
1083 | |
|
|
1084 | $pl = ref $pl ? $pl->ob->name : $pl; |
|
|
1085 | |
|
|
1086 | my $files = aio_readdir playerdir $pl |
|
|
1087 | or return; |
|
|
1088 | |
|
|
1089 | my @paths; |
|
|
1090 | |
|
|
1091 | for (@$files) { |
|
|
1092 | utf8::decode $_; |
|
|
1093 | next if /\.(?:pl|pst)$/; |
|
|
1094 | next unless /^$PATH_SEP/o; |
|
|
1095 | |
|
|
1096 | push @paths, cf::map::normalise "~$pl/$_"; |
|
|
1097 | } |
|
|
1098 | |
|
|
1099 | \@paths |
|
|
1100 | } |
|
|
1101 | |
|
|
1102 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
|
|
1103 | |
|
|
1104 | Sends an ext reply to the player. |
|
|
1105 | |
|
|
1106 | =cut |
|
|
1107 | |
|
|
1108 | sub ext_reply($$$%) { |
|
|
1109 | my ($self, $id, %msg) = @_; |
|
|
1110 | |
|
|
1111 | $msg{msgid} = $id; |
|
|
1112 | |
|
|
1113 | $self->send ("ext " . cf::to_json \%msg); |
|
|
1114 | } |
|
|
1115 | |
|
|
1116 | package cf; |
|
|
1117 | |
|
|
1118 | =back |
|
|
1119 | |
|
|
1120 | |
|
|
1121 | =head3 cf::map |
|
|
1122 | |
|
|
1123 | =over 4 |
|
|
1124 | |
|
|
1125 | =cut |
|
|
1126 | |
|
|
1127 | package cf::map; |
|
|
1128 | |
|
|
1129 | use Fcntl; |
|
|
1130 | use Coro::AIO; |
|
|
1131 | |
|
|
1132 | use overload |
|
|
1133 | '""' => \&as_string, |
|
|
1134 | fallback => 1; |
|
|
1135 | |
|
|
1136 | our $MAX_RESET = 3600; |
|
|
1137 | our $DEFAULT_RESET = 3000; |
|
|
1138 | |
|
|
1139 | sub generate_random_map { |
|
|
1140 | my ($self, $rmp) = @_; |
|
|
1141 | # mit "rum" bekleckern, nicht |
|
|
1142 | $self->_create_random_map ( |
|
|
1143 | $rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle}, |
|
|
1144 | $rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle}, |
|
|
1145 | $rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map}, |
|
|
1146 | $rmp->{exit_on_final_map}, |
|
|
1147 | $rmp->{xsize}, $rmp->{ysize}, |
|
|
1148 | $rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3}, |
|
|
1149 | $rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase}, |
|
|
1150 | $rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation}, |
|
|
1151 | $rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp}, |
|
|
1152 | $rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used}, |
|
|
1153 | (cf::region::find $rmp->{region}), $rmp->{custom} |
|
|
1154 | ) |
|
|
1155 | } |
|
|
1156 | |
|
|
1157 | =item cf::map->register ($regex, $prio) |
|
|
1158 | |
|
|
1159 | Register a handler for the map path matching the given regex at the |
|
|
1160 | givne priority (higher is better, built-in handlers have priority 0, the |
|
|
1161 | default). |
|
|
1162 | |
|
|
1163 | =cut |
|
|
1164 | |
|
|
1165 | sub register { |
|
|
1166 | my (undef, $regex, $prio) = @_; |
|
|
1167 | my $pkg = caller; |
|
|
1168 | |
|
|
1169 | no strict; |
|
|
1170 | push @{"$pkg\::ISA"}, __PACKAGE__; |
|
|
1171 | |
|
|
1172 | $EXT_MAP{$pkg} = [$prio, qr<$regex>]; |
|
|
1173 | } |
|
|
1174 | |
|
|
1175 | # also paths starting with '/' |
|
|
1176 | $EXT_MAP{"cf::map"} = [0, qr{^(?=/)}]; |
|
|
1177 | |
|
|
1178 | sub thawer_merge { |
|
|
1179 | my ($self, $merge) = @_; |
|
|
1180 | |
|
|
1181 | # we have to keep some variables in memory intact |
|
|
1182 | local $self->{path}; |
|
|
1183 | local $self->{load_path}; |
|
|
1184 | local $self->{deny_save}; |
|
|
1185 | local $self->{deny_reset}; |
|
|
1186 | |
|
|
1187 | $self->SUPER::thawer_merge ($merge); |
|
|
1188 | } |
|
|
1189 | |
|
|
1190 | sub normalise { |
|
|
1191 | my ($path, $base) = @_; |
|
|
1192 | |
|
|
1193 | $path = "$path"; # make sure its a string |
|
|
1194 | |
|
|
1195 | $path =~ s/\.map$//; |
|
|
1196 | |
|
|
1197 | # map plan: |
|
|
1198 | # |
|
|
1199 | # /! non-realised random map exit (special hack!) |
|
|
1200 | # {... are special paths that are not being touched |
|
|
1201 | # ?xxx/... are special absolute paths |
|
|
1202 | # ?random/... random maps |
|
|
1203 | # /... normal maps |
|
|
1204 | # ~user/... per-player map of a specific user |
|
|
1205 | |
|
|
1206 | $path =~ s/$PATH_SEP/\//go; |
|
|
1207 | |
|
|
1208 | # treat it as relative path if it starts with |
|
|
1209 | # something that looks reasonable |
|
|
1210 | if ($path =~ m{^(?:\./|\.\./|\w)}) { |
|
|
1211 | $base or Carp::carp "normalise called with relative path and no base: '$path'"; |
|
|
1212 | |
|
|
1213 | $base =~ s{[^/]+/?$}{}; |
|
|
1214 | $path = "$base/$path"; |
|
|
1215 | } |
|
|
1216 | |
|
|
1217 | for ($path) { |
|
|
1218 | redo if s{//}{/}; |
|
|
1219 | redo if s{/\.?/}{/}; |
|
|
1220 | redo if s{/[^/]+/\.\./}{/}; |
|
|
1221 | } |
|
|
1222 | |
|
|
1223 | $path |
|
|
1224 | } |
|
|
1225 | |
|
|
1226 | sub new_from_path { |
|
|
1227 | my (undef, $path, $base) = @_; |
|
|
1228 | |
|
|
1229 | return $path if UNIVERSAL::isa $path, "cf::map"; # already a map object |
|
|
1230 | |
|
|
1231 | $path = normalise $path, $base; |
|
|
1232 | |
|
|
1233 | for my $pkg (sort { $EXT_MAP{$b}[0] <=> $EXT_MAP{$a}[0] } keys %EXT_MAP) { |
|
|
1234 | if ($path =~ $EXT_MAP{$pkg}[1]) { |
|
|
1235 | my $self = bless cf::map::new, $pkg; |
|
|
1236 | $self->{path} = $path; $self->path ($path); |
|
|
1237 | $self->init; # pass $1 etc. |
|
|
1238 | return $self; |
|
|
1239 | } |
|
|
1240 | } |
|
|
1241 | |
|
|
1242 | Carp::carp "unable to resolve path '$path' (base '$base')."; |
|
|
1243 | () |
|
|
1244 | } |
|
|
1245 | |
|
|
1246 | sub init { |
|
|
1247 | my ($self) = @_; |
|
|
1248 | |
|
|
1249 | $self |
|
|
1250 | } |
|
|
1251 | |
|
|
1252 | sub as_string { |
|
|
1253 | my ($self) = @_; |
|
|
1254 | |
|
|
1255 | "$self->{path}" |
|
|
1256 | } |
|
|
1257 | |
|
|
1258 | # the displayed name, this is a one way mapping |
|
|
1259 | sub visible_name { |
|
|
1260 | &as_string |
|
|
1261 | } |
|
|
1262 | |
|
|
1263 | # the original (read-only) location |
|
|
1264 | sub load_path { |
|
|
1265 | my ($self) = @_; |
|
|
1266 | |
|
|
1267 | sprintf "%s/%s/%s.map", cf::datadir, cf::mapdir, $self->{path} |
|
|
1268 | } |
|
|
1269 | |
|
|
1270 | # the temporary/swap location |
|
|
1271 | sub save_path { |
|
|
1272 | my ($self) = @_; |
|
|
1273 | |
|
|
1274 | (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; |
|
|
1275 | sprintf "%s/%s/%s.map", cf::localdir, cf::tmpdir, $path |
|
|
1276 | } |
|
|
1277 | |
|
|
1278 | # the unique path, undef == no special unique path |
|
|
1279 | sub uniq_path { |
|
|
1280 | my ($self) = @_; |
|
|
1281 | |
|
|
1282 | (my $path = $_[0]{path}) =~ s/\//$PATH_SEP/g; |
|
|
1283 | sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $path |
|
|
1284 | } |
|
|
1285 | |
|
|
1286 | # and all this just because we cannot iterate over |
|
|
1287 | # all maps in C++... |
|
|
1288 | sub change_all_map_light { |
|
|
1289 | my ($change) = @_; |
|
|
1290 | |
|
|
1291 | $_->change_map_light ($change) |
|
|
1292 | for grep $_->outdoor, values %cf::MAP; |
|
|
1293 | } |
|
|
1294 | |
|
|
1295 | sub unlink_save { |
|
|
1296 | my ($self) = @_; |
|
|
1297 | |
|
|
1298 | utf8::encode (my $save = $self->save_path); |
|
|
1299 | IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink $save; |
|
|
1300 | IO::AIO::aioreq_pri 4; Coro::AIO::aio_unlink "$save.pst"; |
|
|
1301 | } |
|
|
1302 | |
|
|
1303 | sub load_header_from($) { |
|
|
1304 | my ($self, $path) = @_; |
|
|
1305 | |
|
|
1306 | utf8::encode $path; |
|
|
1307 | #aio_open $path, O_RDONLY, 0 |
|
|
1308 | # or return; |
|
|
1309 | |
|
|
1310 | $self->_load_header ($path) |
|
|
1311 | or return; |
|
|
1312 | |
|
|
1313 | $self->{load_path} = $path; |
|
|
1314 | |
|
|
1315 | 1 |
|
|
1316 | } |
|
|
1317 | |
|
|
1318 | sub load_header_orig { |
|
|
1319 | my ($self) = @_; |
|
|
1320 | |
|
|
1321 | $self->load_header_from ($self->load_path) |
|
|
1322 | } |
|
|
1323 | |
|
|
1324 | sub load_header_temp { |
|
|
1325 | my ($self) = @_; |
|
|
1326 | |
|
|
1327 | $self->load_header_from ($self->save_path) |
|
|
1328 | } |
|
|
1329 | |
|
|
1330 | sub prepare_temp { |
|
|
1331 | my ($self) = @_; |
|
|
1332 | |
|
|
1333 | $self->last_access ((delete $self->{last_access}) |
|
|
1334 | || $cf::RUNTIME); #d# |
|
|
1335 | # safety |
|
|
1336 | $self->{instantiate_time} = $cf::RUNTIME |
|
|
1337 | if $self->{instantiate_time} > $cf::RUNTIME; |
|
|
1338 | } |
|
|
1339 | |
|
|
1340 | sub prepare_orig { |
|
|
1341 | my ($self) = @_; |
|
|
1342 | |
|
|
1343 | $self->{load_original} = 1; |
|
|
1344 | $self->{instantiate_time} = $cf::RUNTIME; |
|
|
1345 | $self->last_access ($cf::RUNTIME); |
|
|
1346 | $self->instantiate; |
|
|
1347 | } |
|
|
1348 | |
|
|
1349 | sub load_header { |
|
|
1350 | my ($self) = @_; |
|
|
1351 | |
|
|
1352 | if ($self->load_header_temp) { |
|
|
1353 | $self->prepare_temp; |
|
|
1354 | } else { |
|
|
1355 | $self->load_header_orig |
|
|
1356 | or return; |
|
|
1357 | $self->prepare_orig; |
|
|
1358 | } |
|
|
1359 | |
|
|
1360 | 1 |
|
|
1361 | } |
|
|
1362 | |
|
|
1363 | sub find; |
|
|
1364 | sub find { |
|
|
1365 | my ($path, $origin) = @_; |
|
|
1366 | |
|
|
1367 | $path = normalise $path, $origin && $origin->path; |
|
|
1368 | |
|
|
1369 | cf::lock_wait "map_find:$path"; |
|
|
1370 | |
|
|
1371 | $cf::MAP{$path} || do { |
|
|
1372 | my $guard = cf::lock_acquire "map_find:$path"; |
|
|
1373 | my $map = new_from_path cf::map $path |
|
|
1374 | or return; |
|
|
1375 | |
|
|
1376 | $map->{last_save} = $cf::RUNTIME; |
|
|
1377 | |
|
|
1378 | $map->load_header |
|
|
1379 | or return; |
|
|
1380 | |
|
|
1381 | if ($map->should_reset && 0) {#d#TODO# disabled, crashy (locking issue?) |
|
|
1382 | # doing this can freeze the server in a sync job, obviously |
|
|
1383 | #$cf::WAIT_FOR_TICK->wait; |
|
|
1384 | $map->reset; |
|
|
1385 | undef $guard; |
|
|
1386 | return find $path; |
|
|
1387 | } |
|
|
1388 | |
|
|
1389 | $cf::MAP{$path} = $map |
|
|
1390 | } |
|
|
1391 | } |
|
|
1392 | |
|
|
1393 | sub pre_load { } |
|
|
1394 | sub post_load { } |
|
|
1395 | |
|
|
1396 | sub load { |
|
|
1397 | my ($self) = @_; |
|
|
1398 | |
|
|
1399 | local $self->{deny_reset} = 1; # loading can take a long time |
|
|
1400 | |
|
|
1401 | my $path = $self->{path}; |
|
|
1402 | my $guard = cf::lock_acquire "map_load:$path"; |
|
|
1403 | |
|
|
1404 | return if $self->in_memory != cf::MAP_SWAPPED; |
|
|
1405 | |
|
|
1406 | $self->in_memory (cf::MAP_LOADING); |
|
|
1407 | |
|
|
1408 | $self->alloc; |
|
|
1409 | |
|
|
1410 | $self->pre_load; |
|
|
1411 | |
|
|
1412 | $self->_load_objects ($self->{load_path}, 1) |
|
|
1413 | or return; |
|
|
1414 | |
|
|
1415 | $self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1) |
|
|
1416 | if delete $self->{load_original}; |
|
|
1417 | |
|
|
1418 | if (my $uniq = $self->uniq_path) { |
|
|
1419 | utf8::encode $uniq; |
|
|
1420 | if (aio_open $uniq, O_RDONLY, 0) { |
|
|
1421 | $self->clear_unique_items; |
|
|
1422 | $self->_load_objects ($uniq, 0); |
|
|
1423 | } |
|
|
1424 | } |
|
|
1425 | |
|
|
1426 | Coro::cede; |
|
|
1427 | |
|
|
1428 | # now do the right thing for maps |
|
|
1429 | $self->link_multipart_objects; |
|
|
1430 | |
|
|
1431 | unless ($self->{deny_activate}) { |
|
|
1432 | $self->decay_objects; |
|
|
1433 | $self->fix_auto_apply; |
|
|
1434 | $self->update_buttons; |
|
|
1435 | Coro::cede; |
|
|
1436 | $self->set_darkness_map; |
|
|
1437 | $self->difficulty ($self->estimate_difficulty) |
|
|
1438 | unless $self->difficulty; |
|
|
1439 | Coro::cede; |
|
|
1440 | $self->activate; |
|
|
1441 | } |
|
|
1442 | |
|
|
1443 | $self->post_load; |
|
|
1444 | |
|
|
1445 | $self->in_memory (cf::MAP_IN_MEMORY); |
|
|
1446 | } |
|
|
1447 | |
|
|
1448 | sub customise_for { |
702 | my ($pl, $buf) = @_; |
1449 | my ($self, $ob) = @_; |
703 | |
1450 | |
704 | my $msg = eval { from_json $buf }; |
1451 | return find "~" . $ob->name . "/" . $self->{path} |
|
|
1452 | if $self->per_player; |
705 | |
1453 | |
706 | if (ref $msg) { |
1454 | $self |
707 | if (my $cb = $extcmd{$msg->{msgtype}}) { |
1455 | } |
708 | if (my %reply = $cb->[0]->($pl, $msg)) { |
1456 | |
709 | $pl->ext_reply ($msg->{msgid}, %reply); |
1457 | # find and load all maps in the 3x3 area around a map |
710 | } |
1458 | sub load_diag { |
|
|
1459 | my ($map) = @_; |
|
|
1460 | |
|
|
1461 | my @diag; # diagonal neighbours |
|
|
1462 | |
|
|
1463 | for (0 .. 3) { |
|
|
1464 | my $neigh = $map->tile_path ($_) |
|
|
1465 | or next; |
|
|
1466 | $neigh = find $neigh, $map |
|
|
1467 | or next; |
|
|
1468 | $neigh->load; |
|
|
1469 | |
|
|
1470 | push @diag, [$neigh->tile_path (($_ + 3) % 4), $neigh], |
|
|
1471 | [$neigh->tile_path (($_ + 1) % 4), $neigh]; |
|
|
1472 | } |
|
|
1473 | |
|
|
1474 | for (@diag) { |
|
|
1475 | my $neigh = find @$_ |
|
|
1476 | or next; |
|
|
1477 | $neigh->load; |
|
|
1478 | } |
|
|
1479 | } |
|
|
1480 | |
|
|
1481 | sub find_sync { |
|
|
1482 | my ($path, $origin) = @_; |
|
|
1483 | |
|
|
1484 | cf::sync_job { find $path, $origin } |
|
|
1485 | } |
|
|
1486 | |
|
|
1487 | sub do_load_sync { |
|
|
1488 | my ($map) = @_; |
|
|
1489 | |
|
|
1490 | cf::sync_job { $map->load }; |
|
|
1491 | } |
|
|
1492 | |
|
|
1493 | our %MAP_PREFETCH; |
|
|
1494 | our $MAP_PREFETCHER = undef; |
|
|
1495 | |
|
|
1496 | sub find_async { |
|
|
1497 | my ($path, $origin) = @_; |
|
|
1498 | |
|
|
1499 | $path = normalise $path, $origin && $origin->{path}; |
|
|
1500 | |
|
|
1501 | if (my $map = $cf::MAP{$path}) { |
|
|
1502 | return $map if $map->in_memory == cf::MAP_IN_MEMORY; |
|
|
1503 | } |
|
|
1504 | |
|
|
1505 | undef $MAP_PREFETCH{$path}; |
|
|
1506 | $MAP_PREFETCHER ||= cf::async { |
|
|
1507 | while (%MAP_PREFETCH) { |
|
|
1508 | for my $path (keys %MAP_PREFETCH) { |
|
|
1509 | my $map = find $path |
|
|
1510 | or next; |
|
|
1511 | $map->load; |
|
|
1512 | |
|
|
1513 | delete $MAP_PREFETCH{$path}; |
711 | } |
1514 | } |
|
|
1515 | } |
|
|
1516 | undef $MAP_PREFETCHER; |
|
|
1517 | }; |
|
|
1518 | $MAP_PREFETCHER->prio (6); |
|
|
1519 | |
|
|
1520 | () |
|
|
1521 | } |
|
|
1522 | |
|
|
1523 | sub save { |
|
|
1524 | my ($self) = @_; |
|
|
1525 | |
|
|
1526 | my $lock = cf::lock_acquire "map_data:" . $self->path; |
|
|
1527 | |
|
|
1528 | $self->{last_save} = $cf::RUNTIME; |
|
|
1529 | |
|
|
1530 | return unless $self->dirty; |
|
|
1531 | |
|
|
1532 | my $save = $self->save_path; utf8::encode $save; |
|
|
1533 | my $uniq = $self->uniq_path; utf8::encode $uniq; |
|
|
1534 | |
|
|
1535 | $self->{load_path} = $save; |
|
|
1536 | |
|
|
1537 | return if $self->{deny_save}; |
|
|
1538 | |
|
|
1539 | local $self->{last_access} = $self->last_access;#d# |
|
|
1540 | |
|
|
1541 | cf::async { |
|
|
1542 | $_->contr->save for $self->players; |
|
|
1543 | }; |
|
|
1544 | |
|
|
1545 | if ($uniq) { |
|
|
1546 | $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS); |
|
|
1547 | $self->_save_objects ($uniq, cf::IO_UNIQUES); |
712 | } else { |
1548 | } else { |
713 | warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n"; |
1549 | $self->_save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES); |
714 | } |
|
|
715 | |
|
|
716 | cf::override; |
|
|
717 | }, |
1550 | } |
718 | ; |
1551 | } |
719 | |
1552 | |
720 | ############################################################################# |
1553 | sub swap_out { |
721 | # load/save/clean perl data associated with a map |
|
|
722 | |
|
|
723 | *cf::mapsupport::on_clean = sub { |
|
|
724 | my ($map) = @_; |
1554 | my ($self) = @_; |
725 | |
1555 | |
726 | my $path = $map->tmpname; |
1556 | # save first because save cedes |
727 | defined $path or return; |
1557 | $self->save; |
728 | |
1558 | |
729 | unlink "$path.pst"; |
1559 | my $lock = cf::lock_acquire "map_data:" . $self->path; |
730 | }; |
|
|
731 | |
1560 | |
732 | attach_to_maps prio => -10000, package => cf::mapsupport::; |
1561 | return if $self->players; |
|
|
1562 | return if $self->in_memory != cf::MAP_IN_MEMORY; |
|
|
1563 | return if $self->{deny_save}; |
733 | |
1564 | |
734 | ############################################################################# |
1565 | $self->clear; |
735 | # load/save perl data associated with player->ob objects |
1566 | $self->in_memory (cf::MAP_SWAPPED); |
736 | |
|
|
737 | sub all_objects(@) { |
|
|
738 | @_, map all_objects ($_->inv), @_ |
|
|
739 | } |
1567 | } |
740 | |
1568 | |
741 | # TODO: compatibility cruft, remove when no longer needed |
1569 | sub reset_at { |
742 | attach_to_players |
1570 | my ($self) = @_; |
743 | on_load => sub { |
|
|
744 | my ($pl, $path) = @_; |
|
|
745 | |
1571 | |
746 | for my $o (all_objects $pl->ob) { |
1572 | # TODO: safety, remove and allow resettable per-player maps |
747 | if (my $value = $o->get_ob_key_value ("_perl_data")) { |
1573 | return 1e99 if $self->isa ("ext::map_per_player");#d# |
748 | $o->set_ob_key_value ("_perl_data"); |
1574 | return 1e99 if $self->{deny_reset}; |
749 | |
1575 | |
750 | %$o = %{ Storable::thaw pack "H*", $value }; |
1576 | my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access; |
751 | } |
1577 | my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET; |
752 | } |
1578 | |
|
|
1579 | $time + $to |
|
|
1580 | } |
|
|
1581 | |
|
|
1582 | sub should_reset { |
|
|
1583 | my ($self) = @_; |
|
|
1584 | |
|
|
1585 | $self->reset_at <= $cf::RUNTIME |
|
|
1586 | } |
|
|
1587 | |
|
|
1588 | sub reset { |
|
|
1589 | my ($self) = @_; |
|
|
1590 | |
|
|
1591 | my $lock = cf::lock_acquire "map_data:$self->{path}"; |
|
|
1592 | |
|
|
1593 | return if $self->players; |
|
|
1594 | return if $self->isa ("ext::map_per_player");#d# |
|
|
1595 | |
|
|
1596 | warn "resetting map ", $self->path;#d# |
|
|
1597 | |
|
|
1598 | $self->in_memory (cf::MAP_SWAPPED); |
|
|
1599 | |
|
|
1600 | # need to save uniques path |
|
|
1601 | unless ($self->{deny_save}) { |
|
|
1602 | my $uniq = $self->uniq_path; utf8::encode $uniq; |
|
|
1603 | |
|
|
1604 | $self->_save_objects ($uniq, cf::IO_UNIQUES) |
|
|
1605 | if $uniq; |
753 | }, |
1606 | } |
754 | ; |
|
|
755 | |
1607 | |
756 | ############################################################################# |
1608 | delete $cf::MAP{$self->path}; |
757 | |
1609 | |
758 | =head2 CORE EXTENSIONS |
1610 | $self->clear; |
759 | |
1611 | |
760 | Functions and methods that extend core crossfire objects. |
1612 | $_->clear_links_to ($self) for values %cf::MAP; |
|
|
1613 | |
|
|
1614 | $self->unlink_save; |
|
|
1615 | $self->destroy; |
|
|
1616 | } |
|
|
1617 | |
|
|
1618 | my $nuke_counter = "aaaa"; |
|
|
1619 | |
|
|
1620 | sub nuke { |
|
|
1621 | my ($self) = @_; |
|
|
1622 | |
|
|
1623 | delete $cf::MAP{$self->path}; |
|
|
1624 | |
|
|
1625 | $self->unlink_save; |
|
|
1626 | |
|
|
1627 | bless $self, "cf::map"; |
|
|
1628 | delete $self->{deny_reset}; |
|
|
1629 | $self->{deny_save} = 1; |
|
|
1630 | $self->reset_timeout (1); |
|
|
1631 | $self->path ($self->{path} = "{nuke}/" . ($nuke_counter++)); |
|
|
1632 | |
|
|
1633 | $cf::MAP{$self->path} = $self; |
|
|
1634 | |
|
|
1635 | $self->reset; # polite request, might not happen |
|
|
1636 | } |
|
|
1637 | |
|
|
1638 | =item cf::map::unique_maps |
|
|
1639 | |
|
|
1640 | Returns an arrayref of paths of all shared maps that have |
|
|
1641 | instantiated unique items. May block. |
|
|
1642 | |
|
|
1643 | =cut |
|
|
1644 | |
|
|
1645 | sub unique_maps() { |
|
|
1646 | my $files = aio_readdir cf::localdir . "/" . cf::uniquedir |
|
|
1647 | or return; |
|
|
1648 | |
|
|
1649 | my @paths; |
|
|
1650 | |
|
|
1651 | for (@$files) { |
|
|
1652 | utf8::decode $_; |
|
|
1653 | next if /\.pst$/; |
|
|
1654 | next unless /^$PATH_SEP/o; |
|
|
1655 | |
|
|
1656 | push @paths, cf::map::normalise $_; |
|
|
1657 | } |
|
|
1658 | |
|
|
1659 | \@paths |
|
|
1660 | } |
|
|
1661 | |
|
|
1662 | package cf; |
|
|
1663 | |
|
|
1664 | =back |
|
|
1665 | |
|
|
1666 | =head3 cf::object |
|
|
1667 | |
|
|
1668 | =cut |
|
|
1669 | |
|
|
1670 | package cf::object; |
761 | |
1671 | |
762 | =over 4 |
1672 | =over 4 |
763 | |
1673 | |
764 | =item cf::player::exists $login |
1674 | =item $ob->inv_recursive |
765 | |
1675 | |
766 | Returns true when the given account exists. |
1676 | Returns the inventory of the object _and_ their inventories, recursively. |
767 | |
1677 | |
768 | =cut |
1678 | =cut |
769 | |
1679 | |
770 | sub cf::player::exists($) { |
1680 | sub inv_recursive_; |
771 | cf::player::find $_[0] |
1681 | sub inv_recursive_ { |
772 | or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2; |
1682 | map { $_, inv_recursive_ $_->inv } @_ |
773 | } |
1683 | } |
774 | |
1684 | |
|
|
1685 | sub inv_recursive { |
|
|
1686 | inv_recursive_ inv $_[0] |
|
|
1687 | } |
|
|
1688 | |
|
|
1689 | package cf; |
|
|
1690 | |
|
|
1691 | =back |
|
|
1692 | |
|
|
1693 | =head3 cf::object::player |
|
|
1694 | |
|
|
1695 | =over 4 |
|
|
1696 | |
775 | =item $player->reply ($npc, $msg[, $flags]) |
1697 | =item $player_object->reply ($npc, $msg[, $flags]) |
776 | |
1698 | |
777 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
1699 | Sends a message to the player, as if the npc C<$npc> replied. C<$npc> |
778 | can be C<undef>. Does the right thing when the player is currently in a |
1700 | can be C<undef>. Does the right thing when the player is currently in a |
779 | dialogue with the given NPC character. |
1701 | dialogue with the given NPC character. |
780 | |
1702 | |
781 | =cut |
1703 | =cut |
782 | |
1704 | |
783 | # rough implementation of a future "reply" method that works |
1705 | # rough implementation of a future "reply" method that works |
784 | # with dialog boxes. |
1706 | # with dialog boxes. |
|
|
1707 | #TODO: the first argument must go, split into a $npc->reply_to ( method |
785 | sub cf::object::player::reply($$$;$) { |
1708 | sub cf::object::player::reply($$$;$) { |
786 | my ($self, $npc, $msg, $flags) = @_; |
1709 | my ($self, $npc, $msg, $flags) = @_; |
787 | |
1710 | |
788 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
1711 | $flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4; |
789 | |
1712 | |
… | |
… | |
793 | $msg = $npc->name . " says: $msg" if $npc; |
1716 | $msg = $npc->name . " says: $msg" if $npc; |
794 | $self->message ($msg, $flags); |
1717 | $self->message ($msg, $flags); |
795 | } |
1718 | } |
796 | } |
1719 | } |
797 | |
1720 | |
798 | =item $player->ext_reply ($msgid, $msgtype, %msg) |
1721 | =item $player_object->may ("access") |
799 | |
1722 | |
800 | Sends an ext reply to the player. |
1723 | Returns wether the given player is authorized to access resource "access" |
|
|
1724 | (e.g. "command_wizcast"). |
801 | |
1725 | |
802 | =cut |
1726 | =cut |
803 | |
1727 | |
804 | sub cf::player::ext_reply($$$%) { |
1728 | sub cf::object::player::may { |
|
|
1729 | my ($self, $access) = @_; |
|
|
1730 | |
|
|
1731 | $self->flag (cf::FLAG_WIZ) || |
|
|
1732 | (ref $cf::CFG{"may_$access"} |
|
|
1733 | ? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}} |
|
|
1734 | : $cf::CFG{"may_$access"}) |
|
|
1735 | } |
|
|
1736 | |
|
|
1737 | =item $player_object->enter_link |
|
|
1738 | |
|
|
1739 | Freezes the player and moves him/her to a special map (C<{link}>). |
|
|
1740 | |
|
|
1741 | The player should be reasonably safe there for short amounts of time. You |
|
|
1742 | I<MUST> call C<leave_link> as soon as possible, though. |
|
|
1743 | |
|
|
1744 | Will never block. |
|
|
1745 | |
|
|
1746 | =item $player_object->leave_link ($map, $x, $y) |
|
|
1747 | |
|
|
1748 | Moves the player out of the special C<{link}> map onto the specified |
|
|
1749 | map. If the map is not valid (or omitted), the player will be moved back |
|
|
1750 | to the location he/she was before the call to C<enter_link>, or, if that |
|
|
1751 | fails, to the emergency map position. |
|
|
1752 | |
|
|
1753 | Might block. |
|
|
1754 | |
|
|
1755 | =cut |
|
|
1756 | |
|
|
1757 | sub link_map { |
|
|
1758 | unless ($LINK_MAP) { |
|
|
1759 | $LINK_MAP = cf::map::find "{link}" |
|
|
1760 | or cf::cleanup "FATAL: unable to provide {link} map, exiting."; |
|
|
1761 | $LINK_MAP->load; |
|
|
1762 | } |
|
|
1763 | |
|
|
1764 | $LINK_MAP |
|
|
1765 | } |
|
|
1766 | |
|
|
1767 | sub cf::object::player::enter_link { |
|
|
1768 | my ($self) = @_; |
|
|
1769 | |
|
|
1770 | $self->deactivate_recursive; |
|
|
1771 | |
|
|
1772 | return if UNIVERSAL::isa $self->map, "ext::map_link"; |
|
|
1773 | |
|
|
1774 | $self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y] |
|
|
1775 | if $self->map; |
|
|
1776 | |
|
|
1777 | $self->enter_map ($LINK_MAP || link_map, 10, 10); |
|
|
1778 | } |
|
|
1779 | |
|
|
1780 | sub cf::object::player::leave_link { |
|
|
1781 | my ($self, $map, $x, $y) = @_; |
|
|
1782 | |
|
|
1783 | my $link_pos = delete $self->{_link_pos}; |
|
|
1784 | |
|
|
1785 | unless ($map) { |
|
|
1786 | # restore original map position |
|
|
1787 | ($map, $x, $y) = @{ $link_pos || [] }; |
|
|
1788 | $map = cf::map::find $map; |
|
|
1789 | |
|
|
1790 | unless ($map) { |
|
|
1791 | ($map, $x, $y) = @$EMERGENCY_POSITION; |
|
|
1792 | $map = cf::map::find $map |
|
|
1793 | or die "FATAL: cannot load emergency map\n"; |
|
|
1794 | } |
|
|
1795 | } |
|
|
1796 | |
|
|
1797 | ($x, $y) = (-1, -1) |
|
|
1798 | unless (defined $x) && (defined $y); |
|
|
1799 | |
|
|
1800 | # use -1 or undef as default coordinates, not 0, 0 |
|
|
1801 | ($x, $y) = ($map->enter_x, $map->enter_y) |
|
|
1802 | if $x <=0 && $y <= 0; |
|
|
1803 | |
|
|
1804 | $map->load; |
|
|
1805 | $map->load_diag; |
|
|
1806 | |
|
|
1807 | return unless $self->contr->active; |
|
|
1808 | $self->activate_recursive; |
|
|
1809 | |
|
|
1810 | local $self->{_prev_pos} = $link_pos; # ugly hack for rent.ext |
|
|
1811 | $self->enter_map ($map, $x, $y); |
|
|
1812 | } |
|
|
1813 | |
|
|
1814 | cf::player->attach ( |
|
|
1815 | on_logout => sub { |
|
|
1816 | my ($pl) = @_; |
|
|
1817 | |
|
|
1818 | # abort map switching before logout |
|
|
1819 | if ($pl->ob->{_link_pos}) { |
|
|
1820 | cf::sync_job { |
|
|
1821 | $pl->ob->leave_link |
|
|
1822 | }; |
|
|
1823 | } |
|
|
1824 | }, |
|
|
1825 | on_login => sub { |
|
|
1826 | my ($pl) = @_; |
|
|
1827 | |
|
|
1828 | # try to abort aborted map switching on player login :) |
|
|
1829 | # should happen only on crashes |
|
|
1830 | if ($pl->ob->{_link_pos}) { |
|
|
1831 | $pl->ob->enter_link; |
|
|
1832 | (async { |
|
|
1833 | $pl->ob->reply (undef, |
|
|
1834 | "There was an internal problem at your last logout, " |
|
|
1835 | . "the server will try to bring you to your intended destination in a second.", |
|
|
1836 | cf::NDI_RED); |
|
|
1837 | # we need this sleep as the login has a concurrent enter_exit running |
|
|
1838 | # and this sleep increases chances of the player not ending up in scorn |
|
|
1839 | Coro::Timer::sleep 1; |
|
|
1840 | $pl->ob->leave_link; |
|
|
1841 | })->prio (2); |
|
|
1842 | } |
|
|
1843 | }, |
|
|
1844 | ); |
|
|
1845 | |
|
|
1846 | =item $player_object->goto ($path, $x, $y) |
|
|
1847 | |
|
|
1848 | =cut |
|
|
1849 | |
|
|
1850 | sub cf::object::player::goto { |
|
|
1851 | my ($self, $path, $x, $y) = @_; |
|
|
1852 | |
|
|
1853 | $self->enter_link; |
|
|
1854 | |
|
|
1855 | (async { |
|
|
1856 | my $map = eval { |
|
|
1857 | my $map = cf::map::find $path; |
|
|
1858 | $map = $map->customise_for ($self) if $map; |
|
|
1859 | $map |
|
|
1860 | } or |
|
|
1861 | $self->message ("The exit to '$path' is closed", cf::NDI_UNIQUE | cf::NDI_RED); |
|
|
1862 | |
|
|
1863 | $self->leave_link ($map, $x, $y); |
|
|
1864 | })->prio (1); |
|
|
1865 | } |
|
|
1866 | |
|
|
1867 | =item $player_object->enter_exit ($exit_object) |
|
|
1868 | |
|
|
1869 | =cut |
|
|
1870 | |
|
|
1871 | sub parse_random_map_params { |
|
|
1872 | my ($spec) = @_; |
|
|
1873 | |
|
|
1874 | my $rmp = { # defaults |
|
|
1875 | xsize => (cf::rndm 15, 40), |
|
|
1876 | ysize => (cf::rndm 15, 40), |
|
|
1877 | symmetry => (cf::rndm 1, cf::SYMMETRY_XY), |
|
|
1878 | #layout => string, |
|
|
1879 | }; |
|
|
1880 | |
|
|
1881 | for (split /\n/, $spec) { |
|
|
1882 | my ($k, $v) = split /\s+/, $_, 2; |
|
|
1883 | |
|
|
1884 | $rmp->{lc $k} = $v if (length $k) && (length $v); |
|
|
1885 | } |
|
|
1886 | |
|
|
1887 | $rmp |
|
|
1888 | } |
|
|
1889 | |
|
|
1890 | sub prepare_random_map { |
|
|
1891 | my ($exit) = @_; |
|
|
1892 | |
|
|
1893 | my $guard = cf::lock_acquire "exit_prepare:$exit"; |
|
|
1894 | |
|
|
1895 | # all this does is basically replace the /! path by |
|
|
1896 | # a new random map path (?random/...) with a seed |
|
|
1897 | # that depends on the exit object |
|
|
1898 | |
|
|
1899 | my $rmp = parse_random_map_params $exit->msg; |
|
|
1900 | |
|
|
1901 | if ($exit->map) { |
|
|
1902 | $rmp->{region} = $exit->region->name; |
|
|
1903 | $rmp->{origin_map} = $exit->map->path; |
|
|
1904 | $rmp->{origin_x} = $exit->x; |
|
|
1905 | $rmp->{origin_y} = $exit->y; |
|
|
1906 | } |
|
|
1907 | |
|
|
1908 | $rmp->{random_seed} ||= $exit->random_seed; |
|
|
1909 | |
|
|
1910 | my $data = cf::to_json $rmp; |
|
|
1911 | my $md5 = Digest::MD5::md5_hex $data; |
|
|
1912 | my $meta = "$cf::RANDOM_MAPS/$md5.meta"; |
|
|
1913 | |
|
|
1914 | if (my $fh = aio_open "$meta~", O_WRONLY | O_CREAT, 0666) { |
|
|
1915 | aio_write $fh, 0, (length $data), $data, 0; |
|
|
1916 | undef $fh; |
|
|
1917 | aio_rename "$meta~", $meta; |
|
|
1918 | |
|
|
1919 | $exit->slaying ("?random/$md5"); |
|
|
1920 | $exit->msg (undef); |
|
|
1921 | } |
|
|
1922 | } |
|
|
1923 | |
|
|
1924 | sub cf::object::player::enter_exit { |
805 | my ($self, $id, %msg) = @_; |
1925 | my ($self, $exit) = @_; |
806 | |
1926 | |
807 | $msg{msgid} = $id; |
1927 | return unless $self->type == cf::PLAYER; |
808 | |
1928 | |
809 | $self->send ("ext " . to_json \%msg); |
1929 | if ($exit->slaying eq "/!") { |
|
|
1930 | #TODO: this should de-fi-ni-te-ly not be a sync-job |
|
|
1931 | cf::sync_job { prepare_random_map $exit }; |
|
|
1932 | } |
|
|
1933 | |
|
|
1934 | my $slaying = cf::map::normalise $exit->slaying, $exit->map && $exit->map->path; |
|
|
1935 | my $hp = $exit->stats->hp; |
|
|
1936 | my $sp = $exit->stats->sp; |
|
|
1937 | |
|
|
1938 | $self->enter_link; |
|
|
1939 | |
|
|
1940 | (async { |
|
|
1941 | $self->deactivate_recursive; # just to be sure |
|
|
1942 | unless (eval { |
|
|
1943 | $self->goto ($slaying, $hp, $sp); |
|
|
1944 | |
|
|
1945 | 1; |
|
|
1946 | }) { |
|
|
1947 | $self->message ("Something went wrong deep within the crossfire server. " |
|
|
1948 | . "I'll try to bring you back to the map you were before. " |
|
|
1949 | . "Please report this to the dungeon master!", |
|
|
1950 | cf::NDI_UNIQUE | cf::NDI_RED); |
|
|
1951 | |
|
|
1952 | warn "ERROR in enter_exit: $@"; |
|
|
1953 | $self->leave_link; |
|
|
1954 | } |
|
|
1955 | })->prio (1); |
810 | } |
1956 | } |
|
|
1957 | |
|
|
1958 | =head3 cf::client |
|
|
1959 | |
|
|
1960 | =over 4 |
|
|
1961 | |
|
|
1962 | =item $client->send_drawinfo ($text, $flags) |
|
|
1963 | |
|
|
1964 | Sends a drawinfo packet to the client. Circumvents output buffering so |
|
|
1965 | should not be used under normal circumstances. |
|
|
1966 | |
|
|
1967 | =cut |
|
|
1968 | |
|
|
1969 | sub cf::client::send_drawinfo { |
|
|
1970 | my ($self, $text, $flags) = @_; |
|
|
1971 | |
|
|
1972 | utf8::encode $text; |
|
|
1973 | $self->send_packet (sprintf "drawinfo %d %s", $flags, $text); |
|
|
1974 | } |
|
|
1975 | |
|
|
1976 | |
|
|
1977 | =item $success = $client->query ($flags, "text", \&cb) |
|
|
1978 | |
|
|
1979 | Queues a query to the client, calling the given callback with |
|
|
1980 | the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>, |
|
|
1981 | C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>. |
|
|
1982 | |
|
|
1983 | Queries can fail, so check the return code. Or don't, as queries will become |
|
|
1984 | reliable at some point in the future. |
|
|
1985 | |
|
|
1986 | =cut |
|
|
1987 | |
|
|
1988 | sub cf::client::query { |
|
|
1989 | my ($self, $flags, $text, $cb) = @_; |
|
|
1990 | |
|
|
1991 | return unless $self->state == ST_PLAYING |
|
|
1992 | || $self->state == ST_SETUP |
|
|
1993 | || $self->state == ST_CUSTOM; |
|
|
1994 | |
|
|
1995 | $self->state (ST_CUSTOM); |
|
|
1996 | |
|
|
1997 | utf8::encode $text; |
|
|
1998 | push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb]; |
|
|
1999 | |
|
|
2000 | $self->send_packet ($self->{query_queue}[0][0]) |
|
|
2001 | if @{ $self->{query_queue} } == 1; |
|
|
2002 | } |
|
|
2003 | |
|
|
2004 | cf::client->attach ( |
|
|
2005 | on_reply => sub { |
|
|
2006 | my ($ns, $msg) = @_; |
|
|
2007 | |
|
|
2008 | # this weird shuffling is so that direct followup queries |
|
|
2009 | # get handled first |
|
|
2010 | my $queue = delete $ns->{query_queue} |
|
|
2011 | or return; # be conservative, not sure how that can happen, but we saw a crash here |
|
|
2012 | |
|
|
2013 | (shift @$queue)->[1]->($msg); |
|
|
2014 | return unless $ns->valid; # temporary(?) workaround for callback destroying socket |
|
|
2015 | |
|
|
2016 | push @{ $ns->{query_queue} }, @$queue; |
|
|
2017 | |
|
|
2018 | if (@{ $ns->{query_queue} } == @$queue) { |
|
|
2019 | if (@$queue) { |
|
|
2020 | $ns->send_packet ($ns->{query_queue}[0][0]); |
|
|
2021 | } else { |
|
|
2022 | $ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM; |
|
|
2023 | } |
|
|
2024 | } |
|
|
2025 | }, |
|
|
2026 | ); |
|
|
2027 | |
|
|
2028 | =item $client->async (\&cb) |
|
|
2029 | |
|
|
2030 | Create a new coroutine, running the specified callback. The coroutine will |
|
|
2031 | be automatically cancelled when the client gets destroyed (e.g. on logout, |
|
|
2032 | or loss of connection). |
|
|
2033 | |
|
|
2034 | =cut |
|
|
2035 | |
|
|
2036 | sub cf::client::async { |
|
|
2037 | my ($self, $cb) = @_; |
|
|
2038 | |
|
|
2039 | my $coro = &Coro::async ($cb); |
|
|
2040 | |
|
|
2041 | $coro->on_destroy (sub { |
|
|
2042 | delete $self->{_coro}{$coro+0}; |
|
|
2043 | }); |
|
|
2044 | |
|
|
2045 | $self->{_coro}{$coro+0} = $coro; |
|
|
2046 | |
|
|
2047 | $coro |
|
|
2048 | } |
|
|
2049 | |
|
|
2050 | cf::client->attach ( |
|
|
2051 | on_destroy => sub { |
|
|
2052 | my ($ns) = @_; |
|
|
2053 | |
|
|
2054 | $_->cancel for values %{ (delete $ns->{_coro}) || {} }; |
|
|
2055 | }, |
|
|
2056 | ); |
811 | |
2057 | |
812 | =back |
2058 | =back |
813 | |
2059 | |
814 | =cut |
|
|
815 | |
|
|
816 | ############################################################################# |
|
|
817 | |
2060 | |
818 | =head2 SAFE SCRIPTING |
2061 | =head2 SAFE SCRIPTING |
819 | |
2062 | |
820 | Functions that provide a safe environment to compile and execute |
2063 | Functions that provide a safe environment to compile and execute |
821 | snippets of perl code without them endangering the safety of the server |
2064 | snippets of perl code without them endangering the safety of the server |
822 | itself. Looping constructs, I/O operators and other built-in functionality |
2065 | itself. Looping constructs, I/O operators and other built-in functionality |
823 | is not available in the safe scripting environment, and the number of |
2066 | is not available in the safe scripting environment, and the number of |
824 | functions and methods that cna be called is greatly reduced. |
2067 | functions and methods that can be called is greatly reduced. |
825 | |
2068 | |
826 | =cut |
2069 | =cut |
827 | |
2070 | |
828 | our $safe = new Safe "safe"; |
2071 | our $safe = new Safe "safe"; |
829 | our $safe_hole = new Safe::Hole; |
2072 | our $safe_hole = new Safe::Hole; |
… | |
… | |
836 | |
2079 | |
837 | =pod |
2080 | =pod |
838 | |
2081 | |
839 | The following fucntions and emthods are available within a safe environment: |
2082 | The following fucntions and emthods are available within a safe environment: |
840 | |
2083 | |
841 | cf::object contr pay_amount pay_player |
2084 | cf::object contr pay_amount pay_player map |
842 | cf::object::player player |
2085 | cf::object::player player |
843 | cf::player peaceful |
2086 | cf::player peaceful |
|
|
2087 | cf::map trigger |
844 | |
2088 | |
845 | =cut |
2089 | =cut |
846 | |
2090 | |
847 | for ( |
2091 | for ( |
848 | ["cf::object" => qw(contr pay_amount pay_player)], |
2092 | ["cf::object" => qw(contr pay_amount pay_player map)], |
849 | ["cf::object::player" => qw(player)], |
2093 | ["cf::object::player" => qw(player)], |
850 | ["cf::player" => qw(peaceful)], |
2094 | ["cf::player" => qw(peaceful)], |
|
|
2095 | ["cf::map" => qw(trigger)], |
851 | ) { |
2096 | ) { |
852 | no strict 'refs'; |
2097 | no strict 'refs'; |
853 | my ($pkg, @funs) = @$_; |
2098 | my ($pkg, @funs) = @$_; |
854 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
2099 | *{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"}) |
855 | for @funs; |
2100 | for @funs; |
… | |
… | |
935 | The parameter C<$family> should best start with the name of the extension |
2180 | The parameter C<$family> should best start with the name of the extension |
936 | using it, it should be unique. |
2181 | using it, it should be unique. |
937 | |
2182 | |
938 | =over 4 |
2183 | =over 4 |
939 | |
2184 | |
940 | =item $hashref = cf::db_get $family |
|
|
941 | |
|
|
942 | Return a hashref for use by the extension C<$family>, which can be |
|
|
943 | modified. After modifications, you have to call C<cf::db_dirty> or |
|
|
944 | C<cf::db_sync>. |
|
|
945 | |
|
|
946 | =item $value = cf::db_get $family => $key |
2185 | =item $value = cf::db_get $family => $key |
947 | |
2186 | |
948 | Returns a single value from the database |
2187 | Returns a single value from the database. |
949 | |
|
|
950 | =item cf::db_put $family => $hashref |
|
|
951 | |
|
|
952 | Stores the given family hashref into the database. Updates are delayed, if |
|
|
953 | you want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
954 | |
2188 | |
955 | =item cf::db_put $family => $key => $value |
2189 | =item cf::db_put $family => $key => $value |
956 | |
2190 | |
957 | Stores the given C<$value> in the family hash. Updates are delayed, if you |
2191 | Stores the given C<$value> in the family. |
958 | want the data to be synced to disk immediately, use C<cf::db_sync>. |
|
|
959 | |
2192 | |
960 | =item cf::db_dirty |
|
|
961 | |
|
|
962 | Marks the database as dirty, to be updated at a later time. |
|
|
963 | |
|
|
964 | =item cf::db_sync |
|
|
965 | |
|
|
966 | Immediately write the database to disk I<if it is dirty>. |
|
|
967 | |
|
|
968 | =cut |
2193 | =cut |
969 | |
2194 | |
970 | { |
2195 | our $DB; |
971 | my $db; |
2196 | |
|
|
2197 | sub db_init { |
|
|
2198 | unless ($DB) { |
|
|
2199 | $DB = BDB::db_create $DB_ENV; |
|
|
2200 | |
|
|
2201 | cf::sync_job { |
|
|
2202 | eval { |
|
|
2203 | $DB->set_flags (BDB::CHKSUM); |
|
|
2204 | |
|
|
2205 | BDB::db_open $DB, undef, "db", undef, BDB::BTREE, |
|
|
2206 | BDB::CREATE | BDB::AUTO_COMMIT, 0666; |
|
|
2207 | cf::cleanup "db_open(db): $!" if $!; |
|
|
2208 | }; |
|
|
2209 | cf::cleanup "db_open(db): $@" if $@; |
|
|
2210 | }; |
|
|
2211 | |
972 | my $path = cf::localdir . "/database.pst"; |
2212 | my $path = cf::localdir . "/database.pst"; |
|
|
2213 | if (stat $path) { |
|
|
2214 | cf::sync_job { |
|
|
2215 | my $pst = Storable::retrieve $path; |
973 | |
2216 | |
974 | sub db_load() { |
2217 | cf::db_put (board => data => $pst->{board}); |
975 | warn "loading database $path\n";#d# remove later |
2218 | cf::db_put (guildrules => data => $pst->{guildrules}); |
976 | $db = stat $path ? Storable::retrieve $path : { }; |
2219 | cf::db_put (rent => balance => $pst->{rent}{balance}); |
977 | } |
2220 | BDB::db_env_txn_checkpoint $DB_ENV; |
978 | |
2221 | |
979 | my $pid; |
2222 | unlink $path; |
980 | |
|
|
981 | sub db_save() { |
|
|
982 | warn "saving database $path\n";#d# remove later |
|
|
983 | waitpid $pid, 0 if $pid; |
|
|
984 | if (0 == ($pid = fork)) { |
|
|
985 | $db->{_meta}{version} = 1; |
|
|
986 | Storable::nstore $db, "$path~"; |
|
|
987 | rename "$path~", $path; |
|
|
988 | cf::_exit 0 if defined $pid; |
|
|
989 | } |
2223 | }; |
990 | } |
|
|
991 | |
|
|
992 | my $dirty; |
|
|
993 | |
|
|
994 | sub db_sync() { |
|
|
995 | db_save if $dirty; |
|
|
996 | undef $dirty; |
|
|
997 | } |
|
|
998 | |
|
|
999 | my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub { |
|
|
1000 | db_sync; |
|
|
1001 | }); |
|
|
1002 | |
|
|
1003 | sub db_dirty() { |
|
|
1004 | $dirty = 1; |
|
|
1005 | $idle->start; |
|
|
1006 | } |
|
|
1007 | |
|
|
1008 | sub db_get($;$) { |
|
|
1009 | @_ >= 2 |
|
|
1010 | ? $db->{$_[0]}{$_[1]} |
|
|
1011 | : ($db->{$_[0]} ||= { }) |
|
|
1012 | } |
|
|
1013 | |
|
|
1014 | sub db_put($$;$) { |
|
|
1015 | if (@_ >= 3) { |
|
|
1016 | $db->{$_[0]}{$_[1]} = $_[2]; |
|
|
1017 | } else { |
|
|
1018 | $db->{$_[0]} = $_[1]; |
|
|
1019 | } |
|
|
1020 | db_dirty; |
|
|
1021 | } |
|
|
1022 | |
|
|
1023 | attach_global |
|
|
1024 | prio => 10000, |
|
|
1025 | on_cleanup => sub { |
|
|
1026 | db_sync; |
|
|
1027 | }, |
2224 | } |
1028 | ; |
2225 | } |
|
|
2226 | } |
|
|
2227 | |
|
|
2228 | sub db_get($$) { |
|
|
2229 | my $key = "$_[0]/$_[1]"; |
|
|
2230 | |
|
|
2231 | cf::sync_job { |
|
|
2232 | BDB::db_get $DB, undef, $key, my $data; |
|
|
2233 | |
|
|
2234 | $! ? () |
|
|
2235 | : Compress::LZF::sthaw $data |
|
|
2236 | } |
|
|
2237 | } |
|
|
2238 | |
|
|
2239 | sub db_put($$$) { |
|
|
2240 | BDB::dbreq_pri 4; |
|
|
2241 | BDB::db_put $DB, undef, "$_[0]/$_[1]", Compress::LZF::sfreeze_cr $_[2], 0, sub { }; |
1029 | } |
2242 | } |
1030 | |
2243 | |
1031 | ############################################################################# |
2244 | ############################################################################# |
1032 | # the server's main() |
2245 | # the server's init and main functions |
1033 | |
2246 | |
1034 | sub load_cfg { |
2247 | sub init_resources { |
|
|
2248 | load_resource_file sprintf "%s/%s/regions", cf::datadir, cf::mapdir |
|
|
2249 | or die "unable to load regions file\n";#d# |
|
|
2250 | } |
|
|
2251 | |
|
|
2252 | sub cfg_load { |
1035 | open my $fh, "<:utf8", cf::confdir . "/config" |
2253 | open my $fh, "<:utf8", cf::confdir . "/config" |
1036 | or return; |
2254 | or return; |
1037 | |
2255 | |
1038 | local $/; |
2256 | local $/; |
1039 | *CFG = YAML::Syck::Load <$fh>; |
2257 | *CFG = YAML::Syck::Load <$fh>; |
1040 | |
2258 | |
1041 | use Data::Dumper; warn Dumper \%CFG; |
2259 | $EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37]; |
|
|
2260 | |
|
|
2261 | $cf::map::MAX_RESET = $CFG{map_max_reset} if exists $CFG{map_max_reset}; |
|
|
2262 | $cf::map::DEFAULT_RESET = $CFG{map_default_reset} if exists $CFG{map_default_reset}; |
|
|
2263 | |
|
|
2264 | if (exists $CFG{mlockall}) { |
|
|
2265 | eval { |
|
|
2266 | $CFG{mlockall} ? eval "mlockall()" : eval "munlockall()" |
|
|
2267 | and die "WARNING: m(un)lockall failed: $!\n"; |
|
|
2268 | }; |
|
|
2269 | warn $@ if $@; |
|
|
2270 | } |
|
|
2271 | } |
|
|
2272 | |
|
|
2273 | sub init { |
|
|
2274 | init_resources; |
1042 | } |
2275 | } |
1043 | |
2276 | |
1044 | sub main { |
2277 | sub main { |
1045 | load_cfg; |
2278 | # we must not ever block the main coroutine |
|
|
2279 | local $Coro::idle = sub { |
|
|
2280 | Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d# |
|
|
2281 | (async { |
|
|
2282 | Event::one_event; |
|
|
2283 | })->prio (Coro::PRIO_MAX); |
|
|
2284 | }; |
|
|
2285 | |
1046 | db_load; |
2286 | cfg_load; |
|
|
2287 | db_init; |
1047 | load_extensions; |
2288 | load_extensions; |
|
|
2289 | |
|
|
2290 | $TICK_WATCHER->start; |
1048 | Event::loop; |
2291 | Event::loop; |
1049 | } |
2292 | } |
1050 | |
2293 | |
1051 | ############################################################################# |
2294 | ############################################################################# |
1052 | # initialisation |
2295 | # initialisation and cleanup |
1053 | |
2296 | |
|
|
2297 | # install some emergency cleanup handlers |
|
|
2298 | BEGIN { |
|
|
2299 | for my $signal (qw(INT HUP TERM)) { |
|
|
2300 | Event->signal ( |
|
|
2301 | reentrant => 0, |
|
|
2302 | data => WF_AUTOCANCEL, |
|
|
2303 | signal => $signal, |
|
|
2304 | prio => 0, |
|
|
2305 | cb => sub { |
|
|
2306 | cf::cleanup "SIG$signal"; |
|
|
2307 | }, |
|
|
2308 | ); |
|
|
2309 | } |
|
|
2310 | } |
|
|
2311 | |
|
|
2312 | sub emergency_save() { |
|
|
2313 | my $freeze_guard = cf::freeze_mainloop; |
|
|
2314 | |
|
|
2315 | warn "enter emergency perl save\n"; |
|
|
2316 | |
|
|
2317 | cf::sync_job { |
|
|
2318 | # use a peculiar iteration method to avoid tripping on perl |
|
|
2319 | # refcount bugs in for. also avoids problems with players |
|
|
2320 | # and maps saved/destroyed asynchronously. |
|
|
2321 | warn "begin emergency player save\n"; |
|
|
2322 | for my $login (keys %cf::PLAYER) { |
|
|
2323 | my $pl = $cf::PLAYER{$login} or next; |
|
|
2324 | $pl->valid or next; |
|
|
2325 | $pl->save; |
|
|
2326 | } |
|
|
2327 | warn "end emergency player save\n"; |
|
|
2328 | |
|
|
2329 | warn "begin emergency map save\n"; |
|
|
2330 | for my $path (keys %cf::MAP) { |
|
|
2331 | my $map = $cf::MAP{$path} or next; |
|
|
2332 | $map->valid or next; |
|
|
2333 | $map->save; |
|
|
2334 | } |
|
|
2335 | warn "end emergency map save\n"; |
|
|
2336 | |
|
|
2337 | warn "begin emergency database checkpoint\n"; |
|
|
2338 | BDB::db_env_txn_checkpoint $DB_ENV; |
|
|
2339 | warn "end emergency database checkpoint\n"; |
|
|
2340 | }; |
|
|
2341 | |
|
|
2342 | warn "leave emergency perl save\n"; |
|
|
2343 | } |
|
|
2344 | |
|
|
2345 | sub post_cleanup { |
|
|
2346 | my ($make_core) = @_; |
|
|
2347 | |
|
|
2348 | warn Carp::longmess "post_cleanup backtrace" |
|
|
2349 | if $make_core; |
|
|
2350 | } |
|
|
2351 | |
1054 | sub _perl_reload(&) { |
2352 | sub reload() { |
1055 | my ($msg) = @_; |
2353 | # can/must only be called in main |
|
|
2354 | if ($Coro::current != $Coro::main) { |
|
|
2355 | warn "can only reload from main coroutine"; |
|
|
2356 | return; |
|
|
2357 | } |
1056 | |
2358 | |
1057 | $msg->("reloading..."); |
2359 | warn "reloading..."; |
1058 | |
2360 | |
1059 | eval { |
2361 | warn "entering sync_job"; |
1060 | # cancel all watchers |
2362 | |
|
|
2363 | cf::sync_job { |
|
|
2364 | cf::write_runtime; # external watchdog should not bark |
|
|
2365 | cf::emergency_save; |
|
|
2366 | cf::write_runtime; # external watchdog should not bark |
|
|
2367 | |
|
|
2368 | warn "syncing database to disk"; |
|
|
2369 | BDB::db_env_txn_checkpoint $DB_ENV; |
|
|
2370 | |
|
|
2371 | # if anything goes wrong in here, we should simply crash as we already saved |
|
|
2372 | |
|
|
2373 | warn "cancelling all WF_AUTOCANCEL watchers"; |
1061 | $_->cancel for Event::all_watchers; |
2374 | for (Event::all_watchers) { |
|
|
2375 | $_->cancel if $_->data & WF_AUTOCANCEL; |
|
|
2376 | } |
1062 | |
2377 | |
1063 | # unload all extensions |
2378 | warn "flushing outstanding aio requests"; |
1064 | for (@exts) { |
2379 | for (;;) { |
1065 | $msg->("unloading <$_>"); |
2380 | BDB::flush; |
1066 | unload_extension $_; |
2381 | IO::AIO::flush; |
|
|
2382 | Coro::cede; |
|
|
2383 | last unless IO::AIO::nreqs || BDB::nreqs; |
|
|
2384 | warn "iterate..."; |
|
|
2385 | } |
|
|
2386 | |
|
|
2387 | warn "cancelling all extension coros"; |
|
|
2388 | $_->cancel for values %EXT_CORO; |
|
|
2389 | %EXT_CORO = (); |
|
|
2390 | |
|
|
2391 | warn "removing commands"; |
|
|
2392 | %COMMAND = (); |
|
|
2393 | |
|
|
2394 | warn "removing ext commands"; |
|
|
2395 | %EXTCMD = (); |
|
|
2396 | |
|
|
2397 | warn "unloading/nuking all extensions"; |
|
|
2398 | for my $pkg (@EXTS) { |
|
|
2399 | warn "... unloading $pkg"; |
|
|
2400 | |
|
|
2401 | if (my $cb = $pkg->can ("unload")) { |
|
|
2402 | eval { |
|
|
2403 | $cb->($pkg); |
|
|
2404 | 1 |
|
|
2405 | } or warn "$pkg unloaded, but with errors: $@"; |
1067 | } |
2406 | } |
1068 | |
2407 | |
|
|
2408 | warn "... nuking $pkg"; |
|
|
2409 | Symbol::delete_package $pkg; |
|
|
2410 | } |
|
|
2411 | |
1069 | # unload all modules loaded from $LIBDIR |
2412 | warn "unloading all perl modules loaded from $LIBDIR"; |
1070 | while (my ($k, $v) = each %INC) { |
2413 | while (my ($k, $v) = each %INC) { |
1071 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
2414 | next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/; |
1072 | |
2415 | |
1073 | $msg->("removing <$k>"); |
2416 | warn "... unloading $k"; |
1074 | delete $INC{$k}; |
2417 | delete $INC{$k}; |
1075 | |
2418 | |
1076 | $k =~ s/\.pm$//; |
2419 | $k =~ s/\.pm$//; |
1077 | $k =~ s/\//::/g; |
2420 | $k =~ s/\//::/g; |
1078 | |
2421 | |
… | |
… | |
1081 | } |
2424 | } |
1082 | |
2425 | |
1083 | Symbol::delete_package $k; |
2426 | Symbol::delete_package $k; |
1084 | } |
2427 | } |
1085 | |
2428 | |
1086 | # sync database to disk |
|
|
1087 | cf::db_sync; |
|
|
1088 | |
|
|
1089 | # get rid of safe::, as good as possible |
2429 | warn "getting rid of safe::, as good as possible"; |
1090 | Symbol::delete_package "safe::$_" |
2430 | Symbol::delete_package "safe::$_" |
1091 | for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region); |
2431 | for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region); |
1092 | |
2432 | |
1093 | # remove register_script_function callbacks |
|
|
1094 | # TODO |
|
|
1095 | |
|
|
1096 | # unload cf.pm "a bit" |
2433 | warn "unloading cf.pm \"a bit\""; |
1097 | delete $INC{"cf.pm"}; |
2434 | delete $INC{"cf.pm"}; |
1098 | |
2435 | |
1099 | # don't, removes xs symbols, too, |
2436 | # don't, removes xs symbols, too, |
1100 | # and global variables created in xs |
2437 | # and global variables created in xs |
1101 | #Symbol::delete_package __PACKAGE__; |
2438 | #Symbol::delete_package __PACKAGE__; |
1102 | |
2439 | |
1103 | # reload cf.pm |
2440 | warn "unload completed, starting to reload now"; |
|
|
2441 | |
1104 | $msg->("reloading cf.pm"); |
2442 | warn "reloading cf.pm"; |
1105 | require cf; |
2443 | require cf; |
|
|
2444 | cf::_connect_to_perl; # nominally unnecessary, but cannot hurt |
1106 | |
2445 | |
1107 | # load database again |
2446 | warn "loading config and database again"; |
1108 | cf::db_load; |
2447 | cf::cfg_load; |
1109 | |
2448 | |
1110 | # load extensions |
2449 | warn "loading extensions"; |
1111 | $msg->("load extensions"); |
|
|
1112 | cf::load_extensions; |
2450 | cf::load_extensions; |
1113 | |
2451 | |
1114 | # reattach attachments to objects |
2452 | warn "reattaching attachments to objects/players"; |
1115 | $msg->("reattach"); |
|
|
1116 | _global_reattach; |
2453 | _global_reattach; |
|
|
2454 | warn "reattaching attachments to maps"; |
|
|
2455 | reattach $_ for values %MAP; |
|
|
2456 | |
|
|
2457 | warn "loading reloadable resources"; |
|
|
2458 | init_resources; |
|
|
2459 | |
|
|
2460 | warn "leaving sync_job"; |
|
|
2461 | |
|
|
2462 | 1 |
|
|
2463 | } or do { |
|
|
2464 | warn $@; |
|
|
2465 | warn "error while reloading, exiting."; |
|
|
2466 | exit 1; |
1117 | }; |
2467 | }; |
1118 | $msg->($@) if $@; |
|
|
1119 | |
2468 | |
1120 | $msg->("reloaded"); |
2469 | warn "reloaded"; |
1121 | }; |
2470 | }; |
1122 | |
2471 | |
1123 | sub perl_reload() { |
2472 | our $RELOAD_WATCHER; # used only during reload |
1124 | _perl_reload { |
|
|
1125 | warn $_[0]; |
|
|
1126 | print "$_[0]\n"; |
|
|
1127 | }; |
|
|
1128 | } |
|
|
1129 | |
2473 | |
1130 | register_command "perl-reload", 0, sub { |
2474 | register_command "reload" => sub { |
1131 | my ($who, $arg) = @_; |
2475 | my ($who, $arg) = @_; |
1132 | |
2476 | |
1133 | if ($who->flag (FLAG_WIZ)) { |
2477 | if ($who->flag (FLAG_WIZ)) { |
1134 | _perl_reload { |
2478 | $who->message ("reloading server."); |
1135 | warn $_[0]; |
2479 | |
1136 | $who->message ($_[0]); |
2480 | # doing reload synchronously and two reloads happen back-to-back, |
|
|
2481 | # coro crashes during coro_state_free->destroy here. |
|
|
2482 | |
|
|
2483 | $RELOAD_WATCHER ||= Event->timer ( |
|
|
2484 | reentrant => 0, |
|
|
2485 | after => 0, |
|
|
2486 | data => WF_AUTOCANCEL, |
|
|
2487 | cb => sub { |
|
|
2488 | reload; |
|
|
2489 | undef $RELOAD_WATCHER; |
|
|
2490 | }, |
1137 | }; |
2491 | ); |
1138 | } |
2492 | } |
1139 | }; |
2493 | }; |
1140 | |
2494 | |
1141 | register "<global>", __PACKAGE__; |
|
|
1142 | |
|
|
1143 | unshift @INC, $LIBDIR; |
2495 | unshift @INC, $LIBDIR; |
1144 | |
2496 | |
|
|
2497 | my $bug_warning = 0; |
|
|
2498 | |
1145 | $TICK_WATCHER = Event->timer ( |
2499 | $TICK_WATCHER = Event->timer ( |
|
|
2500 | reentrant => 0, |
|
|
2501 | parked => 1, |
1146 | prio => 1, |
2502 | prio => 0, |
1147 | at => $NEXT_TICK || 1, |
2503 | at => $NEXT_TICK || $TICK, |
|
|
2504 | data => WF_AUTOCANCEL, |
1148 | cb => sub { |
2505 | cb => sub { |
|
|
2506 | if ($Coro::current != $Coro::main) { |
|
|
2507 | Carp::cluck "major BUG: server tick called outside of main coro, skipping it" |
|
|
2508 | unless ++$bug_warning > 10; |
|
|
2509 | return; |
|
|
2510 | } |
|
|
2511 | |
|
|
2512 | $NOW = Event::time; |
|
|
2513 | |
1149 | cf::server_tick; # one server iteration |
2514 | cf::server_tick; # one server iteration |
1150 | |
2515 | $RUNTIME += $TICK; |
1151 | my $NOW = Event::time; |
|
|
1152 | $NEXT_TICK += $TICK; |
2516 | $NEXT_TICK += $TICK; |
1153 | |
2517 | |
|
|
2518 | if ($NOW >= $NEXT_RUNTIME_WRITE) { |
|
|
2519 | $NEXT_RUNTIME_WRITE = $NOW + 10; |
|
|
2520 | Coro::async_pool { |
|
|
2521 | write_runtime |
|
|
2522 | or warn "ERROR: unable to write runtime file: $!"; |
|
|
2523 | }; |
|
|
2524 | } |
|
|
2525 | |
|
|
2526 | |
|
|
2527 | $WAIT_FOR_TICK->broadcast; |
|
|
2528 | $WAIT_FOR_TICK_ONE->send if $WAIT_FOR_TICK_ONE->awaited; |
|
|
2529 | |
|
|
2530 | # my $AFTER = Event::time; |
|
|
2531 | # warn $AFTER - $NOW;#d# |
|
|
2532 | |
1154 | # if we are delayed by four ticks, skip them all |
2533 | # if we are delayed by four ticks or more, skip them all |
1155 | $NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4; |
2534 | $NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4; |
1156 | |
2535 | |
1157 | $TICK_WATCHER->at ($NEXT_TICK); |
2536 | $TICK_WATCHER->at ($NEXT_TICK); |
1158 | $TICK_WATCHER->start; |
2537 | $TICK_WATCHER->start; |
1159 | }, |
2538 | }, |
1160 | ); |
2539 | ); |
1161 | |
2540 | |
|
|
2541 | { |
|
|
2542 | BDB::max_poll_time $TICK * 0.1; |
|
|
2543 | $BDB_POLL_WATCHER = Event->io ( |
|
|
2544 | reentrant => 0, |
|
|
2545 | fd => BDB::poll_fileno, |
|
|
2546 | poll => 'r', |
|
|
2547 | prio => 0, |
|
|
2548 | data => WF_AUTOCANCEL, |
|
|
2549 | cb => \&BDB::poll_cb, |
|
|
2550 | ); |
|
|
2551 | BDB::min_parallel 8; |
|
|
2552 | |
|
|
2553 | BDB::set_sync_prepare { |
|
|
2554 | my $status; |
|
|
2555 | my $current = $Coro::current; |
|
|
2556 | ( |
|
|
2557 | sub { |
|
|
2558 | $status = $!; |
|
|
2559 | $current->ready; undef $current; |
|
|
2560 | }, |
|
|
2561 | sub { |
|
|
2562 | Coro::schedule while defined $current; |
|
|
2563 | $! = $status; |
|
|
2564 | }, |
|
|
2565 | ) |
|
|
2566 | }; |
|
|
2567 | |
|
|
2568 | unless ($DB_ENV) { |
|
|
2569 | $DB_ENV = BDB::db_env_create; |
|
|
2570 | |
|
|
2571 | cf::sync_job { |
|
|
2572 | eval { |
|
|
2573 | BDB::db_env_open |
|
|
2574 | $DB_ENV, |
|
|
2575 | $BDB_ENV_DIR, |
|
|
2576 | BDB::INIT_LOCK | BDB::INIT_LOG | BDB::INIT_MPOOL | BDB::INIT_TXN |
|
|
2577 | | BDB::RECOVER | BDB::REGISTER | BDB::USE_ENVIRON | BDB::CREATE, |
|
|
2578 | 0666; |
|
|
2579 | |
|
|
2580 | cf::cleanup "db_env_open($BDB_ENV_DIR): $!" if $!; |
|
|
2581 | |
|
|
2582 | $DB_ENV->set_flags (BDB::AUTO_COMMIT | BDB::REGION_INIT | BDB::TXN_NOSYNC, 1); |
|
|
2583 | $DB_ENV->set_lk_detect; |
|
|
2584 | }; |
|
|
2585 | |
|
|
2586 | cf::cleanup "db_env_open(db): $@" if $@; |
|
|
2587 | }; |
|
|
2588 | } |
|
|
2589 | } |
|
|
2590 | |
|
|
2591 | { |
|
|
2592 | IO::AIO::min_parallel 8; |
|
|
2593 | |
|
|
2594 | undef $Coro::AIO::WATCHER; |
|
|
2595 | IO::AIO::max_poll_time $TICK * 0.1; |
|
|
2596 | $AIO_POLL_WATCHER = Event->io ( |
|
|
2597 | reentrant => 0, |
|
|
2598 | data => WF_AUTOCANCEL, |
|
|
2599 | fd => IO::AIO::poll_fileno, |
|
|
2600 | poll => 'r', |
|
|
2601 | prio => 6, |
|
|
2602 | cb => \&IO::AIO::poll_cb, |
|
|
2603 | ); |
|
|
2604 | } |
|
|
2605 | |
|
|
2606 | END { cf::emergency_save } |
|
|
2607 | |
1162 | 1 |
2608 | 1 |
1163 | |
2609 | |