ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/deliantra/server/lib/cf.pm

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.68 by root, Tue Sep 12 23:45:16 2006 UTC vs.
Revision 1.109 by root, Sun Dec 31 22:23:12 2006 UTC

1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3;
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Digest::MD5;
		21	use Fcntl;
		22	use IO::AIO 2.31 ();
		23	use YAML::Syck ();
10	use Time::HiRes;	24	use Time::HiRes;
11	use Event;	25
12	$Event::Eval = 1; # no idea why this is required, but it is	26	use Event; $Event::Eval = 1; # no idea why this is required, but it is
13		27
14	use strict;	28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
		29	$YAML::Syck::ImplicitUnicode = 1;
15		30
16	_init_vars;	31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
17		32
		33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
		34
18	our %COMMAND = ();	35	our %COMMAND = ();
		36	our %COMMAND_TIME = ();
		37	our %EXTCMD = ();
		38
19	our @EVENT;	39	our @EVENT;
20	our $LIBDIR = maps_directory "perl";	40	our $LIBDIR = datadir . "/ext";
21		41
22	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
23	our $TICK_WATCHER;	43	our $TICK_WATCHER;
24	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
		46
		47	our %CFG;
		48
		49	our $UPTIME; $UPTIME ||= time;
		50	our $RUNTIME;
		51
		52	our %MAP; # all maps
		53	our $LINK_MAP; # the special {link} map
		54	our $FREEZE;
		55	our $RANDOM_MAPS = cf::localdir . "/random";
		56	our %EXT_CORO;
		57
		58	binmode STDOUT;
		59	binmode STDERR;
		60
		61	# read virtual server time, if available
		62	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		63	open my $fh, "<", cf::localdir . "/runtime"
		64	or die "unable to read runtime file: $!";
		65	$RUNTIME = <$fh> + 0.;
		66	}
		67
		68	mkdir cf::localdir;
		69	mkdir cf::localdir . "/" . cf::playerdir;
		70	mkdir cf::localdir . "/" . cf::tmpdir;
		71	mkdir cf::localdir . "/" . cf::uniquedir;
		72	mkdir $RANDOM_MAPS;
		73
		74	# a special map that is always available
		75	our $LINK_MAP;
		76
		77	#############################################################################
		78
		79	=head2 GLOBAL VARIABLES
		80
		81	=over 4
		82
		83	=item $cf::UPTIME
		84
		85	The timestamp of the server start (so not actually an uptime).
		86
		87	=item $cf::RUNTIME
		88
		89	The time this server has run, starts at 0 and is increased by $cf::TICK on
		90	every server tick.
		91
		92	=item $cf::LIBDIR
		93
		94	The perl library directory, where extensions and cf-specific modules can
		95	be found. It will be added to C<@INC> automatically.
		96
		97	=item $cf::NOW
		98
		99	The time of the last (current) server tick.
		100
		101	=item $cf::TICK
		102
		103	The interval between server ticks, in seconds.
		104
		105	=item %cf::CFG
		106
		107	Configuration for the server, loaded from C</etc/crossfire/config>, or
		108	from wherever your confdir points to.
		109
		110	=back
		111
		112	=cut
25		113
26	BEGIN {	114	BEGIN {
27	*CORE::GLOBAL::warn = sub {	115	*CORE::GLOBAL::warn = sub {
28	my $msg = join "", @_;	116	my $msg = join "", @_;
		117	utf8::encode $msg;
		118
29	$msg .= "\n"	119	$msg .= "\n"
30	unless $msg =~ /\n$/;	120	unless $msg =~ /\n$/;
31		121
32	print STDERR "cfperl: $msg";
33	LOG llevError, "cfperl: $msg";	122	LOG llevError, "cfperl: $msg";
34	};	123	};
35	}	124	}
36		125
		126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
		127	@safe::cf::object::ISA = @cf::object::ISA = 'cf::attachable';
		128	@safe::cf::player::ISA = @cf::player::ISA = 'cf::attachable';
		129	@safe::cf::client::ISA = @cf::client::ISA = 'cf::attachable';
		130	@safe::cf::map::ISA = @cf::map::ISA = 'cf::attachable';
37	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	131	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
38		132
39	# we bless all objects into (empty) derived classes to force a method lookup	133	# we bless all objects into (empty) derived classes to force a method lookup
40	# within the Safe compartment.	134	# within the Safe compartment.
41	for my $pkg (qw(cf::object cf::object::player cf::player cf::map cf::party cf::region cf::arch cf::living)) {	135	for my $pkg (qw(
		136	cf::global cf::attachable
		137	cf::object cf::object::player
		138	cf::client cf::player
		139	cf::arch cf::living
		140	cf::map cf::party cf::region
		141	)) {
42	no strict 'refs';	142	no strict 'refs';
43	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;	143	@{"safe::$pkg\::wrap::ISA"} = @{"$pkg\::wrap::ISA"} = $pkg;
44	}	144	}
45		145
46	$Event::DIED = sub {	146	$Event::DIED = sub {
…		…
48	};	148	};
49		149
50	my %ext_pkg;	150	my %ext_pkg;
51	my @exts;	151	my @exts;
52	my @hook;	152	my @hook;
53	my %command;
54	my %extcmd;
55		153
56	#############################################################################	154	=head2 UTILITY FUNCTIONS
57	# utility functions	155
		156	=over 4
		157
		158	=cut
58		159
59	use JSON::Syck (); # TODO# replace by JSON::PC once working	160	use JSON::Syck (); # TODO# replace by JSON::PC once working
		161
		162	=item $ref = cf::from_json $json
		163
		164	Converts a JSON string into the corresponding perl data structure.
		165
		166	=cut
60		167
61	sub from_json($) {	168	sub from_json($) {
62	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs	169	$JSON::Syck::ImplicitUnicode = 1; # work around JSON::Syck bugs
63	JSON::Syck::Load $_[0]	170	JSON::Syck::Load $_[0]
64	}	171	}
65		172
		173	=item $json = cf::to_json $ref
		174
		175	Converts a perl data structure into its JSON representation.
		176
		177	=cut
		178
66	sub to_json($) {	179	sub to_json($) {
67	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
68	JSON::Syck::Dump $_[0]	181	JSON::Syck::Dump $_[0]
69	}	182	}
70		183
		184	=item cf::sync_job { BLOCK }
		185
		186	The design of crossfire+ requires that the main coro ($Coro::main) is
		187	always able to handle events or runnable, as crossfire+ is only partly
		188	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		189
		190	If it must be done, put the blocking parts into C<sync_job>. This will run
		191	the given BLOCK in another coroutine while waiting for the result. The
		192	server will be frozen during this time, so the block should either finish
		193	fast or be very important.
		194
		195	=cut
		196
		197	sub sync_job(&) {
		198	my ($job) = @_;
		199
		200	my $busy = 1;
		201	my @res;
		202
		203	# TODO: use suspend/resume instead
		204	local $FREEZE = 1;
		205
		206	my $coro = Coro::async {
		207	@res = eval { $job->() };
		208	warn $@ if $@;
		209	undef $busy;
		210	};
		211
		212	if ($Coro::current == $Coro::main) {
		213	$coro->prio (Coro::PRIO_MAX);
		214	while ($busy) {
		215	Coro::cede_notself;
		216	Event::one_event unless Coro::nready;
		217	}
		218	} else {
		219	$coro->join;
		220	}
		221
		222	wantarray ? @res : $res[0]
		223	}
		224
		225	=item $coro = cf::coro { BLOCK }
		226
		227	Creates and returns a new coro. This coro is automcatially being canceled
		228	when the extension calling this is being unloaded.
		229
		230	=cut
		231
		232	sub coro(&) {
		233	my $cb = shift;
		234
		235	my $coro; $coro = async {
		236	eval {
		237	$cb->();
		238	};
		239	warn $@ if $@;
		240	};
		241
		242	$coro->on_destroy (sub {
		243	delete $EXT_CORO{$coro+0};
		244	});
		245	$EXT_CORO{$coro+0} = $coro;
		246
		247	$coro
		248	}
		249
		250	sub write_runtime {
		251	my $runtime = cf::localdir . "/runtime";
		252
		253	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		254	or return;
		255
		256	my $value = $cf::RUNTIME;
		257	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		258	and return;
		259
		260	aio_fsync $fh
		261	and return;
		262
		263	close $fh
		264	or return;
		265
		266	aio_rename "$runtime~", $runtime
		267	and return;
		268
		269	1
		270	}
		271
		272	=back
		273
		274	=cut
		275
71	#############################################################################	276	#############################################################################
72	# "new" plug-in system
73		277
74	=head3 EVENTS AND OBJECT ATTACHMENTS	278	package cf::path;
		279
		280	sub new {
		281	my ($class, $path, $base) = @_;
		282
		283	my $self = bless { }, $class;
		284
		285	if ($path =~ s{^\?random/}{}) {
		286	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		287	$self->{random} = cf::from_json $data;
		288	} else {
		289	if ($path =~ s{^~([^/]+)?}{}) {
		290	$self->{user_rel} = 1;
		291
		292	if (defined $1) {
		293	$self->{user} = $1;
		294	} elsif ($base =~ m{^~([^/]+)/}) {
		295	$self->{user} = $1;
		296	} else {
		297	warn "cannot resolve user-relative path without user <$path,$base>\n";
		298	}
		299	} elsif ($path =~ /^\//) {
		300	# already absolute
		301	} else {
		302	$base =~ s{[^/]+/?$}{};
		303	return $class->new ("$base/$path");
		304	}
		305
		306	for ($path) {
		307	redo if s{/\.?/}{/};
		308	redo if s{/[^/]+/\.\./}{/};
		309	}
		310	}
		311
		312	$self->{path} = $path;
		313
		314	$self
		315	}
		316
		317	# the name / primary key / in-game path
		318	sub as_string {
		319	my ($self) = @_;
		320
		321	$self->{user_rel} ? "~$self->{user}$self->{path}"
		322	: $self->{random} ? "?random/$self->{path}"
		323	: $self->{path}
		324	}
		325
		326	# the displayed name, this is a one way mapping
		327	sub visible_name {
		328	my ($self) = @_;
		329
		330	# if (my $rmp = $self->{random}) {
		331	# # todo: be more intelligent about this
		332	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		333	# } else {
		334	$self->as_string
		335	# }
		336	}
		337
		338	# escape the /'s in the path
		339	sub _escaped_path {
		340	# ∕ is U+2215
		341	(my $path = $_[0]{path}) =~ s/\//∕/g;
		342	$path
		343	}
		344
		345	# the original (read-only) location
		346	sub load_path {
		347	my ($self) = @_;
		348
		349	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		350	}
		351
		352	# the temporary/swap location
		353	sub save_path {
		354	my ($self) = @_;
		355
		356	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		357	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		358	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		359	}
		360
		361	# the unique path, might be eq to save_path
		362	sub uniq_path {
		363	my ($self) = @_;
		364
		365	$self->{user_rel} || $self->{random}
		366	? undef
		367	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		368	}
		369
		370	# return random map parameters, or undef
		371	sub random_map_params {
		372	my ($self) = @_;
		373
		374	$self->{random}
		375	}
		376
		377	# this is somewhat ugly, but style maps do need special treatment
		378	sub is_style_map {
		379	$_[0]{path} =~ m{^/styles/}
		380	}
		381
		382	package cf;
		383
		384	#############################################################################
		385
		386	=head2 ATTACHABLE OBJECTS
		387
		388	Many objects in crossfire are so-called attachable objects. That means you can
		389	attach callbacks/event handlers (a collection of which is called an "attachment")
		390	to it. All such attachable objects support the following methods.
		391
		392	In the following description, CLASS can be any of C<global>, C<object>
		393	C<player>, C<client> or C<map> (i.e. the attachable objects in
		394	crossfire+).
75		395
76	=over 4	396	=over 4
77		397
78	=item $object->attach ($attachment, key => $value...)
79
80	=item $object->detach ($attachment)
81
82	Attach/detach a pre-registered attachment to an object.
83
84	=item $player->attach ($attachment, key => $value...)
85
86	=item $player->detach ($attachment)
87
88	Attach/detach a pre-registered attachment to a player.
89
90	=item $map->attach ($attachment, key => $value...)	398	=item $attachable->attach ($attachment, key => $value...)
91		399
92	=item $map->detach ($attachment)	400	=item $attachable->detach ($attachment)
93		401
94	Attach/detach a pre-registered attachment to a map.	402	Attach/detach a pre-registered attachment to a specific object and give it
		403	the specified key/value pairs as arguments.
95		404
96	=item $bool = $object->attached ($name)	405	Example, attach a minesweeper attachment to the given object, making it a
		406	10x10 minesweeper game:
97		407
98	=item $bool = $player->attached ($name)	408	$obj->attach (minesweeper => width => 10, height => 10);
99		409
100	=item $bool = $map->attached ($name)	410	=item $bool = $attachable->attached ($name)
101		411
102	Checks wether the named attachment is currently attached to the object.	412	Checks wether the named attachment is currently attached to the object.
103		413
104	=item cf::attach_global ...	414	=item cf::CLASS->attach ...
105		415
106	Attach handlers for global events.	416	=item cf::CLASS->detach ...
107		417
108	This and all following C<attach_*>-functions expect any number of the	418	Define an anonymous attachment and attach it to all objects of the given
109	following handler/hook descriptions:	419	CLASS. See the next function for an explanation of its arguments.
		420
		421	You can attach to global events by using the C<cf::global> class.
		422
		423	Example, log all player logins:
		424
		425	cf::player->attach (
		426	on_login => sub {
		427	my ($pl) = @_;
		428	...
		429	},
		430	);
		431
		432	Example, attach to the jeweler skill:
		433
		434	cf::object->attach (
		435	type => cf::SKILL,
		436	subtype => cf::SK_JEWELER,
		437	on_use_skill => sub {
		438	my ($sk, $ob, $part, $dir, $msg) = @_;
		439	...
		440	},
		441	);
		442
		443	=item cf::CLASS::attachment $name, ...
		444
		445	Register an attachment by C<$name> through which attachable objects of the
		446	given CLASS can refer to this attachment.
		447
		448	Some classes such as crossfire maps and objects can specify attachments
		449	that are attached at load/instantiate time, thus the need for a name.
		450
		451	These calls expect any number of the following handler/hook descriptions:
110		452
111	=over 4	453	=over 4
112		454
113	=item prio => $number	455	=item prio => $number
114		456
…		…
116	by another C<prio> setting). Lower priority handlers get executed	458	by another C<prio> setting). Lower priority handlers get executed
117	earlier. The default priority is C<0>, and many built-in handlers are	459	earlier. The default priority is C<0>, and many built-in handlers are
118	registered at priority C<-1000>, so lower priorities should not be used	460	registered at priority C<-1000>, so lower priorities should not be used
119	unless you know what you are doing.	461	unless you know what you are doing.
120		462
		463	=item type => $type
		464
		465	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		466	given type of objects only (the additional parameter C<subtype> can be
		467	used to further limit to the given subtype).
		468
121	=item on_I<event> => \&cb	469	=item on_I<event> => \&cb
122		470
123	Call the given code reference whenever the named event happens (event is	471	Call the given code reference whenever the named event happens (event is
124	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	472	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
125	handlers are recognised generally depends on the type of object these	473	handlers are recognised generally depends on the type of object these
…		…
134	package and register them. Only handlers for eevents supported by the	482	package and register them. Only handlers for eevents supported by the
135	object/class are recognised.	483	object/class are recognised.
136		484
137	=back	485	=back
138		486
139	=item cf::attach_to_type $object_type, $subtype, ...	487	Example, define an attachment called "sockpuppet" that calls the given
		488	event handler when a monster attacks:
140		489
141	Attach handlers for a specific object type (e.g. TRANSPORT) and	490	cf::object::attachment sockpuppet =>
142	subtype. If C<$subtype> is zero or undef, matches all objects of the given	491	on_skill_attack => sub {
143	type.	492	my ($self, $victim) = @_;
144		493	...
145	=item cf::attach_to_objects ...
146
147	Attach handlers to all objects. Do not use this except for debugging or
148	very rare events, as handlers are (obviously) called for I<all> objects in
149	the game.
150
151	=item cf::attach_to_players ...
152
153	Attach handlers to all players.
154
155	=item cf::attach_to_maps ...
156
157	Attach handlers to all maps.
158
159	=item cf:register_attachment $name, ...
160
161	Register an attachment by name through which objects can refer to this
162	attachment.
163
164	=item cf:register_player_attachment $name, ...
165
166	Register an attachment by name through which players can refer to this
167	attachment.
168
169	=item cf:register_map_attachment $name, ...
170
171	Register an attachment by name through which maps can refer to this
172	attachment.
173
174	=cut
175
176	# the following variables are defined in .xs and must not be re-created
177	our @CB_GLOBAL = (); # registry for all global events
178	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
179	our @CB_PLAYER = ();
180	our @CB_TYPE = (); # registry for type (cf-object class) based events
181	our @CB_MAP = ();
182
183	my %attachment;
184
185	sub _attach_cb($\%$$$) {
186	my ($registry, $undo, $event, $prio, $cb) = @_;
187
188	use sort 'stable';
189
190	$cb = [$prio, $cb];
191
192	@{$registry->[$event]} = sort
193	{ $a->[0] cmp $b->[0] }
194	@{$registry->[$event] || []}, $cb;
195
196	push @{$undo->{cb}}, [$event, $cb];
197	}
198
199	# attach handles attaching event callbacks
200	# the only thing the caller has to do is pass the correct
201	# registry (== where the callback attaches to).
202	sub _attach(\@$@) {
203	my ($registry, $klass, @arg) = @_;
204
205	my $prio = 0;
206
207	my %undo = (
208	registry => $registry,
209	cb => [],
210	);
211
212	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
213
214	while (@arg) {
215	my $type = shift @arg;
216
217	if ($type eq "prio") {
218	$prio = shift @arg;
219
220	} elsif ($type eq "package") {
221	my $pkg = shift @arg;
222
223	while (my ($name, $id) = each %cb_id) {
224	if (my $cb = $pkg->can ($name)) {
225	_attach_cb $registry, %undo, $id, $prio, $cb;
226	}
227	}	494	}
228
229	} elsif (exists $cb_id{$type}) {
230	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
231
232	} elsif (ref $type) {
233	warn "attaching objects not supported, ignoring.\n";
234
235	} else {
236	shift @arg;
237	warn "attach argument '$type' not supported, ignoring.\n";
238	}
239	}
240
241	\%undo
242	}
243
244	sub _attach_attachment {
245	my ($obj, $name, %arg) = @_;
246
247	return if exists $obj->{_attachment}{$name};
248
249	my $res;
250
251	if (my $attach = $attachment{$name}) {
252	my $registry = $obj->registry;
253
254	for (@$attach) {
255	my ($klass, @attach) = @$_;
256	$res = _attach @$registry, $klass, @attach;
257	}
258
259	$obj->{$name} = \%arg;
260	} else {
261	warn "object uses attachment '$name' that is not available, postponing.\n";
262	}
263
264	$obj->{_attachment}{$name} = undef;
265
266	$res->{attachment} = $name;
267	$res
268	}
269
270	*cf::object::attach =
271	*cf::player::attach =
272	*cf::map::attach = sub {
273	my ($obj, $name, %arg) = @_;
274
275	_attach_attachment $obj, $name, %arg;
276	};
277
278	# all those should be optimised
279	*cf::object::detach =
280	*cf::player::detach =
281	*cf::map::detach = sub {
282	my ($obj, $name) = @_;
283
284	delete $obj->{_attachment}{$name};
285	reattach ($obj);
286	};
287
288	*cf::object::attached =
289	*cf::player::attached =
290	*cf::map::attached = sub {
291	my ($obj, $name) = @_;
292
293	exists $obj->{_attachment}{$name}
294	};
295
296	sub attach_global {
297	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
298	}
299
300	sub attach_to_type {
301	my $type = shift;
302	my $subtype = shift;
303
304	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
305	}
306
307	sub attach_to_objects {
308	_attach @CB_OBJECT, KLASS_OBJECT, @_
309	}
310
311	sub attach_to_players {
312	_attach @CB_PLAYER, KLASS_PLAYER, @_
313	}
314
315	sub attach_to_maps {
316	_attach @CB_MAP, KLASS_MAP, @_
317	}
318
319	sub register_attachment {
320	my $name = shift;
321
322	$attachment{$name} = [[KLASS_OBJECT, @_]];
323	}
324
325	sub register_player_attachment {
326	my $name = shift;
327
328	$attachment{$name} = [[KLASS_PLAYER, @_]];
329	}
330
331	sub register_map_attachment {
332	my $name = shift;
333
334	$attachment{$name} = [[KLASS_MAP, @_]];
335	}
336
337	our $override;
338	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
339
340	sub override {
341	$override = 1;
342	@invoke_results = ();
343	}
344
345	sub do_invoke {
346	my $event = shift;
347	my $callbacks = shift;
348
349	@invoke_results = ();
350
351	local $override;
352
353	for (@$callbacks) {
354	eval { &{$_->[1]} };
355
356	if ($@) {
357	warn "$@";
358	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
359	override;
360	}
361
362	return 1 if $override;
363	}
364
365	0	495	}
366	}
367		496
368	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	497	=item $attachable->valid
369
370	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
371
372	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
373
374	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
375
376	Generate a global/object/player/map-specific event with the given arguments.
377
378	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
379	removed in future versions), and there is no public API to access override
380	results (if you must, access C<@cf::invoke_results> directly).
381
382	=back
383
384	=head2 methods valid for all pointers
385
386	=over 4
387
388	=item $object->valid
389
390	=item $player->valid
391
392	=item $map->valid
393		498
394	Just because you have a perl object does not mean that the corresponding	499	Just because you have a perl object does not mean that the corresponding
395	C-level object still exists. If you try to access an object that has no	500	C-level object still exists. If you try to access an object that has no
396	valid C counterpart anymore you get an exception at runtime. This method	501	valid C counterpart anymore you get an exception at runtime. This method
397	can be used to test for existence of the C object part without causing an	502	can be used to test for existence of the C object part without causing an
398	exception.	503	exception.
399		504
		505	=cut
		506
		507	# the following variables are defined in .xs and must not be re-created
		508	our @CB_GLOBAL = (); # registry for all global events
		509	our @CB_ATTACHABLE = (); # registry for all attachables
		510	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		511	our @CB_PLAYER = ();
		512	our @CB_CLIENT = ();
		513	our @CB_TYPE = (); # registry for type (cf-object class) based events
		514	our @CB_MAP = ();
		515
		516	my %attachment;
		517
		518	sub _attach_cb($$$$) {
		519	my ($registry, $event, $prio, $cb) = @_;
		520
		521	use sort 'stable';
		522
		523	$cb = [$prio, $cb];
		524
		525	@{$registry->[$event]} = sort
		526	{ $a->[0] cmp $b->[0] }
		527	@{$registry->[$event] || []}, $cb;
		528	}
		529
		530	# hack
		531	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		532
		533	# attach handles attaching event callbacks
		534	# the only thing the caller has to do is pass the correct
		535	# registry (== where the callback attaches to).
		536	sub _attach {
		537	my ($registry, $klass, @arg) = @_;
		538
		539	my $object_type;
		540	my $prio = 0;
		541	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		542
		543	#TODO: get rid of this hack
		544	if ($attachable_klass{$klass}) {
		545	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		546	}
		547
		548	while (@arg) {
		549	my $type = shift @arg;
		550
		551	if ($type eq "prio") {
		552	$prio = shift @arg;
		553
		554	} elsif ($type eq "type") {
		555	$object_type = shift @arg;
		556	$registry = $CB_TYPE[$object_type] ||= [];
		557
		558	} elsif ($type eq "subtype") {
		559	defined $object_type or Carp::croak "subtype specified without type";
		560	my $object_subtype = shift @arg;
		561	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		562
		563	} elsif ($type eq "package") {
		564	my $pkg = shift @arg;
		565
		566	while (my ($name, $id) = each %cb_id) {
		567	if (my $cb = $pkg->can ($name)) {
		568	_attach_cb $registry, $id, $prio, $cb;
		569	}
		570	}
		571
		572	} elsif (exists $cb_id{$type}) {
		573	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		574
		575	} elsif (ref $type) {
		576	warn "attaching objects not supported, ignoring.\n";
		577
		578	} else {
		579	shift @arg;
		580	warn "attach argument '$type' not supported, ignoring.\n";
		581	}
		582	}
		583	}
		584
		585	sub _object_attach {
		586	my ($obj, $name, %arg) = @_;
		587
		588	return if exists $obj->{_attachment}{$name};
		589
		590	if (my $attach = $attachment{$name}) {
		591	my $registry = $obj->registry;
		592
		593	for (@$attach) {
		594	my ($klass, @attach) = @$_;
		595	_attach $registry, $klass, @attach;
		596	}
		597
		598	$obj->{$name} = \%arg;
		599	} else {
		600	warn "object uses attachment '$name' that is not available, postponing.\n";
		601	}
		602
		603	$obj->{_attachment}{$name} = undef;
		604	}
		605
		606	sub cf::attachable::attach {
		607	if (ref $_[0]) {
		608	_object_attach @_;
		609	} else {
		610	_attach shift->_attach_registry, @_;
		611	}
		612	};
		613
		614	# all those should be optimised
		615	sub cf::attachable::detach {
		616	my ($obj, $name) = @_;
		617
		618	if (ref $obj) {
		619	delete $obj->{_attachment}{$name};
		620	reattach ($obj);
		621	} else {
		622	Carp::croak "cannot, currently, detach class attachments";
		623	}
		624	};
		625
		626	sub cf::attachable::attached {
		627	my ($obj, $name) = @_;
		628
		629	exists $obj->{_attachment}{$name}
		630	}
		631
		632	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		633	eval "#line " . __LINE__ . " 'cf.pm'
		634	sub cf::\L$klass\E::_attach_registry {
		635	(\\\@CB_$klass, KLASS_$klass)
		636	}
		637
		638	sub cf::\L$klass\E::attachment {
		639	my \$name = shift;
		640
		641	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		642	}
		643	";
		644	die if $@;
		645	}
		646
		647	our $override;
		648	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		649
		650	sub override {
		651	$override = 1;
		652	@invoke_results = ();
		653	}
		654
		655	sub do_invoke {
		656	my $event = shift;
		657	my $callbacks = shift;
		658
		659	@invoke_results = ();
		660
		661	local $override;
		662
		663	for (@$callbacks) {
		664	eval { &{$_->[1]} };
		665
		666	if ($@) {
		667	warn "$@";
		668	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		669	override;
		670	}
		671
		672	return 1 if $override;
		673	}
		674
		675	0
		676	}
		677
		678	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		679
		680	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		681
		682	Generate an object-specific event with the given arguments.
		683
		684	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		685	removed in future versions), and there is no public API to access override
		686	results (if you must, access C<@cf::invoke_results> directly).
		687
400	=back	688	=back
401		689
402	=cut	690	=cut
403
404	*cf::object::valid =
405	*cf::player::valid =
406	*cf::map::valid = \&cf::_valid;
407		691
408	#############################################################################	692	#############################################################################
409	# object support	693	# object support
410		694
411	sub instantiate {
412	my ($obj, $data) = @_;
413
414	$data = from_json $data;
415
416	for (@$data) {
417	my ($name, $args) = @$_;
418
419	$obj->attach ($name, %{$args || {} });
420	}
421	}
422
423	# basically do the same as instantiate, without calling instantiate
424	sub reattach {	695	sub reattach {
		696	# basically do the same as instantiate, without calling instantiate
425	my ($obj) = @_;	697	my ($obj) = @_;
		698
426	my $registry = $obj->registry;	699	my $registry = $obj->registry;
427		700
428	@$registry = ();	701	@$registry = ();
429		702
430	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	703	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
431		704
432	for my $name (keys %{ $obj->{_attachment} || {} }) {	705	for my $name (keys %{ $obj->{_attachment} || {} }) {
433	if (my $attach = $attachment{$name}) {	706	if (my $attach = $attachment{$name}) {
434	for (@$attach) {	707	for (@$attach) {
435	my ($klass, @attach) = @$_;	708	my ($klass, @attach) = @$_;
436	_attach @$registry, $klass, @attach;	709	_attach $registry, $klass, @attach;
437	}	710	}
438	} else {	711	} else {
439	warn "object uses attachment '$name' that is not available, postponing.\n";	712	warn "object uses attachment '$name' that is not available, postponing.\n";
440	}	713	}
441	}	714	}
442	}	715	}
443		716
444	sub object_freezer_save {	717	cf::attachable->attach (
445	my ($filename, $rdata, $objs) = @_;
446
447	if (length $$rdata) {
448	warn sprintf "saving %s (%d,%d)\n",
449	$filename, length $$rdata, scalar @$objs;
450
451	if (open my $fh, ">:raw", "$filename~") {
452	chmod SAVE_MODE, $fh;
453	syswrite $fh, $$rdata;
454	close $fh;
455
456	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
457	chmod SAVE_MODE, $fh;
458	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
459	close $fh;
460	rename "$filename.pst~", "$filename.pst";
461	} else {
462	unlink "$filename.pst";
463	}
464
465	rename "$filename~", $filename;
466	} else {
467	warn "FATAL: $filename~: $!\n";
468	}
469	} else {
470	unlink $filename;
471	unlink "$filename.pst";
472	}
473	}
474
475	sub object_thawer_load {
476	my ($filename) = @_;
477
478	local $/;
479
480	my $av;
481
482	#TODO: use sysread etc.
483	if (open my $data, "<:raw:perlio", $filename) {
484	$data = <$data>;
485	if (open my $pst, "<:raw:perlio", "$filename.pst") {
486	$av = eval { (Storable::thaw <$pst>)->{objs} };
487	}
488	return ($data, $av);
489	}
490
491	()
492	}
493
494	attach_to_objects
495	prio => -1000000,	718	prio => -1000000,
		719	on_instantiate => sub {
		720	my ($obj, $data) = @_;
		721
		722	$data = from_json $data;
		723
		724	for (@$data) {
		725	my ($name, $args) = @$_;
		726
		727	$obj->attach ($name, %{$args || {} });
		728	}
		729	},
		730	on_reattach => \&reattach,
496	on_clone => sub {	731	on_clone => sub {
497	my ($src, $dst) = @_;	732	my ($src, $dst) = @_;
498		733
499	@{$dst->registry} = @{$src->registry};	734	@{$dst->registry} = @{$src->registry};
500		735
501	%$dst = %$src;	736	%$dst = %$src;
502		737
503	%{$dst->{_attachment}} = %{$src->{_attachment}}	738	%{$dst->{_attachment}} = %{$src->{_attachment}}
504	if exists $src->{_attachment};	739	if exists $src->{_attachment};
505	},	740	},
506	;	741	);
		742
		743	sub object_freezer_save {
		744	my ($filename, $rdata, $objs) = @_;
		745
		746	sync_job {
		747	if (length $$rdata) {
		748	warn sprintf "saving %s (%d,%d)\n",
		749	$filename, length $$rdata, scalar @$objs;
		750
		751	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		752	chmod SAVE_MODE, $fh;
		753	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		754	aio_fsync $fh;
		755	close $fh;
		756
		757	if (@$objs) {
		758	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		759	chmod SAVE_MODE, $fh;
		760	my $data = Storable::nfreeze { version => 1, objs => $objs };
		761	aio_write $fh, 0, (length $data), $data, 0;
		762	aio_fsync $fh;
		763	close $fh;
		764	aio_rename "$filename.pst~", "$filename.pst";
		765	}
		766	} else {
		767	aio_unlink "$filename.pst";
		768	}
		769
		770	aio_rename "$filename~", $filename;
		771	} else {
		772	warn "FATAL: $filename~: $!\n";
		773	}
		774	} else {
		775	aio_unlink $filename;
		776	aio_unlink "$filename.pst";
		777	}
		778	}
		779	}
		780
		781	sub object_freezer_as_string {
		782	my ($rdata, $objs) = @_;
		783
		784	use Data::Dumper;
		785
		786	$$rdata . Dumper $objs
		787	}
		788
		789	sub object_thawer_load {
		790	my ($filename) = @_;
		791
		792	my ($data, $av);
		793
		794	(aio_load $filename, $data) >= 0
		795	or return;
		796
		797	unless (aio_stat "$filename.pst") {
		798	(aio_load "$filename.pst", $av) >= 0
		799	or return;
		800	$av = eval { (Storable::thaw <$av>)->{objs} };
		801	}
		802
		803	return ($data, $av);
		804	}
507		805
508	#############################################################################	806	#############################################################################
509	# old plug-in events	807	# command handling &c
510		808
511	sub inject_event {	809	=item cf::register_command $name => \&callback($ob,$args);
512	my $extension = shift;
513	my $event_code = shift;
514		810
515	my $cb = $hook[$event_code]{$extension}	811	Register a callback for execution when the client sends the user command
516	or return;	812	$name.
517		813
518	&$cb	814	=cut
519	}
520
521	sub inject_global_event {
522	my $event = shift;
523
524	my $cb = $hook[$event]
525	or return;
526
527	List::Util::max map &$_, values %$cb
528	}
529
530	sub inject_command {
531	my ($name, $obj, $params) = @_;
532
533	for my $cmd (@{ $command{$name} }) {
534	$cmd->[1]->($obj, $params);
535	}
536
537	-1
538	}
539		815
540	sub register_command {	816	sub register_command {
541	my ($name, $time, $cb) = @_;	817	my ($name, $cb) = @_;
542		818
543	my $caller = caller;	819	my $caller = caller;
544	#warn "registering command '$name/$time' to '$caller'";	820	#warn "registering command '$name/$time' to '$caller'";
545		821
546	push @{ $command{$name} }, [$time, $cb, $caller];	822	push @{ $COMMAND{$name} }, [$caller, $cb];
547	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
548	}	823	}
		824
		825	=item cf::register_extcmd $name => \&callback($pl,$packet);
		826
		827	Register a callbackf ro execution when the client sends an extcmd packet.
		828
		829	If the callback returns something, it is sent back as if reply was being
		830	called.
		831
		832	=cut
549		833
550	sub register_extcmd {	834	sub register_extcmd {
551	my ($name, $cb) = @_;	835	my ($name, $cb) = @_;
552		836
553	my $caller = caller;	837	my $caller = caller;
554	#warn "registering extcmd '$name' to '$caller'";	838	#warn "registering extcmd '$name' to '$caller'";
555		839
556	$extcmd{$name} = [$cb, $caller];	840	$EXTCMD{$name} = [$cb, $caller];
557	}	841	}
		842
		843	cf::player->attach (
		844	on_command => sub {
		845	my ($pl, $name, $params) = @_;
		846
		847	my $cb = $COMMAND{$name}
		848	or return;
		849
		850	for my $cmd (@$cb) {
		851	$cmd->[1]->($pl->ob, $params);
		852	}
		853
		854	cf::override;
		855	},
		856	on_extcmd => sub {
		857	my ($pl, $buf) = @_;
		858
		859	my $msg = eval { from_json $buf };
		860
		861	if (ref $msg) {
		862	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		863	if (my %reply = $cb->[0]->($pl, $msg)) {
		864	$pl->ext_reply ($msg->{msgid}, %reply);
		865	}
		866	}
		867	} else {
		868	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		869	}
		870
		871	cf::override;
		872	},
		873	);
558		874
559	sub register {	875	sub register {
560	my ($base, $pkg) = @_;	876	my ($base, $pkg) = @_;
561		877
562	#TODO	878	#TODO
…		…
581	. "#line 1 \"$path\"\n{\n"	897	. "#line 1 \"$path\"\n{\n"
582	. (do { local $/; <$fh> })	898	. (do { local $/; <$fh> })
583	. "\n};\n1";	899	. "\n};\n1";
584		900
585	eval $source	901	eval $source
586	or die "$path: $@";	902	or die $@ ? "$path: $@\n"
		903	: "extension disabled.\n";
587		904
588	push @exts, $pkg;	905	push @exts, $pkg;
589	$ext_pkg{$base} = $pkg;	906	$ext_pkg{$base} = $pkg;
590		907
591	# no strict 'refs';	908	# no strict 'refs';
…		…
604	# for my $idx (0 .. $#PLUGIN_EVENT) {	921	# for my $idx (0 .. $#PLUGIN_EVENT) {
605	# delete $hook[$idx]{$pkg};	922	# delete $hook[$idx]{$pkg};
606	# }	923	# }
607		924
608	# remove commands	925	# remove commands
609	for my $name (keys %command) {	926	for my $name (keys %COMMAND) {
610	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	927	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
611		928
612	if (@cb) {	929	if (@cb) {
613	$command{$name} = \@cb;	930	$COMMAND{$name} = \@cb;
614	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
615	} else {	931	} else {
616	delete $command{$name};
617	delete $COMMAND{"$name\000"};	932	delete $COMMAND{$name};
618	}	933	}
619	}	934	}
620		935
621	# remove extcmds	936	# remove extcmds
622	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	937	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
623	delete $extcmd{$name};	938	delete $EXTCMD{$name};
624	}	939	}
625		940
626	if (my $cb = $pkg->can ("unload")) {	941	if (my $cb = $pkg->can ("unload")) {
627	eval {	942	eval {
628	$cb->($pkg);	943	$cb->($pkg);
…		…
632		947
633	Symbol::delete_package $pkg;	948	Symbol::delete_package $pkg;
634	}	949	}
635		950
636	sub load_extensions {	951	sub load_extensions {
637	my $LIBDIR = maps_directory "perl";
638
639	for my $ext (<$LIBDIR/*.ext>) {	952	for my $ext (<$LIBDIR/*.ext>) {
640	next unless -r $ext;	953	next unless -r $ext;
641	eval {	954	eval {
642	load_extension $ext;	955	load_extension $ext;
643	1	956	1
644	} or warn "$ext not loaded: $@";	957	} or warn "$ext not loaded: $@";
645	}	958	}
646	}	959	}
647		960
648	#############################################################################	961	#############################################################################
649	# extcmd framework, basically convert ext <msg>
650	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
651
652	attach_to_players
653	on_extcmd => sub {
654	my ($pl, $buf) = @_;
655
656	my $msg = eval { from_json $buf };
657
658	if (ref $msg) {
659	if (my $cb = $extcmd{$msg->{msgtype}}) {
660	if (my %reply = $cb->[0]->($pl, $msg)) {
661	$pl->ext_reply ($msg->{msgid}, %reply);
662	}
663	}
664	} else {
665	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
666	}
667
668	cf::override;
669	},
670	;
671
672	#############################################################################
673	# load/save/clean perl data associated with a map	962	# load/save/clean perl data associated with a map
674		963
675	*cf::mapsupport::on_clean = sub {	964	*cf::mapsupport::on_clean = sub {
676	my ($map) = @_;	965	my ($map) = @_;
677		966
…		…
679	defined $path or return;	968	defined $path or return;
680		969
681	unlink "$path.pst";	970	unlink "$path.pst";
682	};	971	};
683		972
684	attach_to_maps prio => -10000, package => cf::mapsupport::;	973	cf::map->attach (prio => -10000, package => cf::mapsupport::);
685		974
686	#############################################################################	975	#############################################################################
687	# load/save perl data associated with player->ob objects	976	# load/save perl data associated with player->ob objects
688		977
689	sub all_objects(@) {	978	sub all_objects(@) {
690	@_, map all_objects ($_->inv), @_	979	@_, map all_objects ($_->inv), @_
691	}	980	}
692		981
693	# TODO: compatibility cruft, remove when no longer needed	982	# TODO: compatibility cruft, remove when no longer needed
694	attach_to_players	983	cf::player->attach (
695	on_load => sub {	984	on_load => sub {
696	my ($pl, $path) = @_;	985	my ($pl, $path) = @_;
697		986
698	for my $o (all_objects $pl->ob) {	987	for my $o (all_objects $pl->ob) {
699	if (my $value = $o->get_ob_key_value ("_perl_data")) {	988	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
701		990
702	%$o = %{ Storable::thaw pack "H*", $value };	991	%$o = %{ Storable::thaw pack "H*", $value };
703	}	992	}
704	}	993	}
705	},	994	},
706	;	995	);
707		996
708	#############################################################################	997	#############################################################################
709	# core extensions - in perl	998
		999	=head2 CORE EXTENSIONS
		1000
		1001	Functions and methods that extend core crossfire objects.
		1002
		1003	=head3 cf::player
		1004
		1005	=over 4
710		1006
711	=item cf::player::exists $login	1007	=item cf::player::exists $login
712		1008
713	Returns true when the given account exists.	1009	Returns true when the given account exists.
714		1010
…		…
717	sub cf::player::exists($) {	1013	sub cf::player::exists($) {
718	cf::player::find $_[0]	1014	cf::player::find $_[0]
719	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1015	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
720	}	1016	}
721		1017
		1018	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1019
		1020	Sends an ext reply to the player.
		1021
		1022	=cut
		1023
		1024	sub cf::player::ext_reply($$$%) {
		1025	my ($self, $id, %msg) = @_;
		1026
		1027	$msg{msgid} = $id;
		1028
		1029	$self->send ("ext " . to_json \%msg);
		1030	}
		1031
		1032	=back
		1033
		1034	=head3 cf::object::player
		1035
		1036	=over 4
		1037
722	=item $player->reply ($npc, $msg[, $flags])	1038	=item $player_object->reply ($npc, $msg[, $flags])
723		1039
724	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1040	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
725	can be C<undef>. Does the right thing when the player is currently in a	1041	can be C<undef>. Does the right thing when the player is currently in a
726	dialogue with the given NPC character.	1042	dialogue with the given NPC character.
727		1043
728	=cut	1044	=cut
729		1045
730	# rough implementation of a future "reply" method that works	1046	# rough implementation of a future "reply" method that works
731	# with dialog boxes.	1047	# with dialog boxes.
		1048	#TODO: the first argument must go, split into a $npc->reply_to ( method
732	sub cf::object::player::reply($$$;$) {	1049	sub cf::object::player::reply($$$;$) {
733	my ($self, $npc, $msg, $flags) = @_;	1050	my ($self, $npc, $msg, $flags) = @_;
734		1051
735	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1052	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
736		1053
…		…
740	$msg = $npc->name . " says: $msg" if $npc;	1057	$msg = $npc->name . " says: $msg" if $npc;
741	$self->message ($msg, $flags);	1058	$self->message ($msg, $flags);
742	}	1059	}
743	}	1060	}
744		1061
745	=item $player->ext_reply ($msgid, $msgtype, %msg)	1062	=item $player_object->may ("access")
746		1063
747	Sends an ext reply to the player.	1064	Returns wether the given player is authorized to access resource "access"
		1065	(e.g. "command_wizcast").
748		1066
749	=cut	1067	=cut
750		1068
751	sub cf::player::ext_reply($$$%) {	1069	sub cf::object::player::may {
		1070	my ($self, $access) = @_;
		1071
		1072	$self->flag (cf::FLAG_WIZ) ||
		1073	(ref $cf::CFG{"may_$access"}
		1074	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1075	: $cf::CFG{"may_$access"})
		1076	}
		1077
		1078	=head3 cf::client
		1079
		1080	=over 4
		1081
		1082	=item $client->send_drawinfo ($text, $flags)
		1083
		1084	Sends a drawinfo packet to the client. Circumvents output buffering so
		1085	should not be used under normal circumstances.
		1086
		1087	=cut
		1088
		1089	sub cf::client::send_drawinfo {
		1090	my ($self, $text, $flags) = @_;
		1091
		1092	utf8::encode $text;
		1093	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1094	}
		1095
		1096
		1097	=item $success = $client->query ($flags, "text", \&cb)
		1098
		1099	Queues a query to the client, calling the given callback with
		1100	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1101	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1102
		1103	Queries can fail, so check the return code. Or don't, as queries will become
		1104	reliable at some point in the future.
		1105
		1106	=cut
		1107
		1108	sub cf::client::query {
		1109	my ($self, $flags, $text, $cb) = @_;
		1110
		1111	return unless $self->state == ST_PLAYING
		1112	|| $self->state == ST_SETUP
		1113	|| $self->state == ST_CUSTOM;
		1114
		1115	$self->state (ST_CUSTOM);
		1116
		1117	utf8::encode $text;
		1118	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1119
		1120	$self->send_packet ($self->{query_queue}[0][0])
		1121	if @{ $self->{query_queue} } == 1;
		1122	}
		1123
		1124	cf::client->attach (
		1125	on_reply => sub {
		1126	my ($ns, $msg) = @_;
		1127
		1128	# this weird shuffling is so that direct followup queries
		1129	# get handled first
		1130	my $queue = delete $ns->{query_queue};
		1131
		1132	(shift @$queue)->[1]->($msg);
		1133
		1134	push @{ $ns->{query_queue} }, @$queue;
		1135
		1136	if (@{ $ns->{query_queue} } == @$queue) {
		1137	if (@$queue) {
		1138	$ns->send_packet ($ns->{query_queue}[0][0]);
		1139	} else {
		1140	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1141	}
		1142	}
		1143	},
		1144	);
		1145
		1146	=item $client->coro (\&cb)
		1147
		1148	Create a new coroutine, running the specified callback. The coroutine will
		1149	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1150	or loss of connection).
		1151
		1152	=cut
		1153
		1154	sub cf::client::coro {
752	my ($self, $id, %msg) = @_;	1155	my ($self, $cb) = @_;
753		1156
754	$msg{msgid} = $id;	1157	my $coro; $coro = async {
		1158	eval {
		1159	$cb->();
		1160	};
		1161	warn $@ if $@;
		1162	};
755		1163
756	$self->send ("ext " . to_json \%msg);	1164	$coro->on_destroy (sub {
757	}	1165	delete $self->{_coro}{$coro+0};
		1166	});
758		1167
759	#############################################################################	1168	$self->{_coro}{$coro+0} = $coro;
760	# map scripting support	1169
		1170	$coro
		1171	}
		1172
		1173	cf::client->attach (
		1174	on_destroy => sub {
		1175	my ($ns) = @_;
		1176
		1177	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1178	},
		1179	);
		1180
		1181	=back
		1182
		1183
		1184	=head2 SAFE SCRIPTING
		1185
		1186	Functions that provide a safe environment to compile and execute
		1187	snippets of perl code without them endangering the safety of the server
		1188	itself. Looping constructs, I/O operators and other built-in functionality
		1189	is not available in the safe scripting environment, and the number of
		1190	functions and methods that can be called is greatly reduced.
		1191
		1192	=cut
761		1193
762	our $safe = new Safe "safe";	1194	our $safe = new Safe "safe";
763	our $safe_hole = new Safe::Hole;	1195	our $safe_hole = new Safe::Hole;
764		1196
765	$SIG{FPE} = 'IGNORE';	1197	$SIG{FPE} = 'IGNORE';
766		1198
767	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	1199	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
768		1200
769	# here we export the classes and methods available to script code	1201	# here we export the classes and methods available to script code
770		1202
		1203	=pod
		1204
		1205	The following fucntions and emthods are available within a safe environment:
		1206
		1207	cf::object contr pay_amount pay_player map
		1208	cf::object::player player
		1209	cf::player peaceful
		1210	cf::map trigger
		1211
		1212	=cut
		1213
771	for (	1214	for (
772	["cf::object" => qw(contr pay_amount pay_player)],	1215	["cf::object" => qw(contr pay_amount pay_player map)],
773	["cf::object::player" => qw(player)],	1216	["cf::object::player" => qw(player)],
774	["cf::player" => qw(peaceful)],	1217	["cf::player" => qw(peaceful)],
		1218	["cf::map" => qw(trigger)],
775	) {	1219	) {
776	no strict 'refs';	1220	no strict 'refs';
777	my ($pkg, @funs) = @$_;	1221	my ($pkg, @funs) = @$_;
778	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1222	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
779	for @funs;	1223	for @funs;
780	}	1224	}
		1225
		1226	=over 4
		1227
		1228	=item @retval = safe_eval $code, [var => value, ...]
		1229
		1230	Compiled and executes the given perl code snippet. additional var/value
		1231	pairs result in temporary local (my) scalar variables of the given name
		1232	that are available in the code snippet. Example:
		1233
		1234	my $five = safe_eval '$first + $second', first => 1, second => 4;
		1235
		1236	=cut
781		1237
782	sub safe_eval($;@) {	1238	sub safe_eval($;@) {
783	my ($code, %vars) = @_;	1239	my ($code, %vars) = @_;
784		1240
785	my $qcode = $code;	1241	my $qcode = $code;
…		…
808	}	1264	}
809		1265
810	wantarray ? @res : $res[0]	1266	wantarray ? @res : $res[0]
811	}	1267	}
812		1268
		1269	=item cf::register_script_function $function => $cb
		1270
		1271	Register a function that can be called from within map/npc scripts. The
		1272	function should be reasonably secure and should be put into a package name
		1273	like the extension.
		1274
		1275	Example: register a function that gets called whenever a map script calls
		1276	C<rent::overview>, as used by the C<rent> extension.
		1277
		1278	cf::register_script_function "rent::overview" => sub {
		1279	...
		1280	};
		1281
		1282	=cut
		1283
813	sub register_script_function {	1284	sub register_script_function {
814	my ($fun, $cb) = @_;	1285	my ($fun, $cb) = @_;
815		1286
816	no strict 'refs';	1287	no strict 'refs';
817	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1288	*{"safe::$fun"} = $safe_hole->wrap ($cb);
818	}	1289	}
		1290
		1291	=back
		1292
		1293	=cut
819		1294
820	#############################################################################	1295	#############################################################################
821		1296
822	=head2 EXTENSION DATABASE SUPPORT	1297	=head2 EXTENSION DATABASE SUPPORT
823		1298
…		…
858		1333
859	Immediately write the database to disk I<if it is dirty>.	1334	Immediately write the database to disk I<if it is dirty>.
860		1335
861	=cut	1336	=cut
862		1337
		1338	our $DB;
		1339
863	{	1340	{
864	my $db;
865	my $path = cf::localdir . "/database.pst";	1341	my $path = cf::localdir . "/database.pst";
866		1342
867	sub db_load() {	1343	sub db_load() {
868	warn "loading database $path\n";#d# remove later	1344	warn "loading database $path\n";#d# remove later
869	$db = stat $path ? Storable::retrieve $path : { };	1345	$DB = stat $path ? Storable::retrieve $path : { };
870	}	1346	}
871		1347
872	my $pid;	1348	my $pid;
873		1349
874	sub db_save() {	1350	sub db_save() {
875	warn "saving database $path\n";#d# remove later	1351	warn "saving database $path\n";#d# remove later
876	waitpid $pid, 0 if $pid;	1352	waitpid $pid, 0 if $pid;
877	if (0 == ($pid = fork)) {	1353	if (0 == ($pid = fork)) {
878	$db->{_meta}{version} = 1;	1354	$DB->{_meta}{version} = 1;
879	Storable::nstore $db, "$path~";	1355	Storable::nstore $DB, "$path~";
880	rename "$path~", $path;	1356	rename "$path~", $path;
881	cf::_exit 0 if defined $pid;	1357	cf::_exit 0 if defined $pid;
882	}	1358	}
883	}	1359	}
884		1360
…		…
887	sub db_sync() {	1363	sub db_sync() {
888	db_save if $dirty;	1364	db_save if $dirty;
889	undef $dirty;	1365	undef $dirty;
890	}	1366	}
891		1367
892	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, cb => sub {	1368	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
893	db_sync;	1369	db_sync;
894	});	1370	});
895		1371
896	sub db_dirty() {	1372	sub db_dirty() {
897	$dirty = 1;	1373	$dirty = 1;
898	$idle->start;	1374	$idle->start;
899	}	1375	}
900		1376
901	sub db_get($;$) {	1377	sub db_get($;$) {
902	@_ >= 2	1378	@_ >= 2
903	? $db->{$_[0]}{$_[1]}	1379	? $DB->{$_[0]}{$_[1]}
904	: ($db->{$_[0]} ||= { })	1380	: ($DB->{$_[0]} ||= { })
905	}	1381	}
906		1382
907	sub db_put($$;$) {	1383	sub db_put($$;$) {
908	if (@_ >= 3) {	1384	if (@_ >= 3) {
909	$db->{$_[0]}{$_[1]} = $_[2];	1385	$DB->{$_[0]}{$_[1]} = $_[2];
910	} else {	1386	} else {
911	$db->{$_[0]} = $_[1];	1387	$DB->{$_[0]} = $_[1];
912	}	1388	}
913	db_dirty;	1389	db_dirty;
914	}	1390	}
915		1391
916	attach_global	1392	cf::global->attach (
917	prio => 10000,	1393	prio => 10000,
918	on_cleanup => sub {	1394	on_cleanup => sub {
919	db_sync;	1395	db_sync;
920	},	1396	},
921	;	1397	);
922	}	1398	}
923		1399
924	#############################################################################	1400	#############################################################################
925	# the server's main()	1401	# the server's main()
926		1402
		1403	sub cfg_load {
		1404	open my $fh, "<:utf8", cf::confdir . "/config"
		1405	or return;
		1406
		1407	local $/;
		1408	*CFG = YAML::Syck::Load <$fh>;
		1409	}
		1410
927	sub main {	1411	sub main {
		1412	# we must not ever block the main coroutine
		1413	local $Coro::idle = sub {
		1414	Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1415	(Coro::unblock_sub {
		1416	Event::one_event;
		1417	})->();
		1418	};
		1419
		1420	cfg_load;
928	db_load;	1421	db_load;
929	load_extensions;	1422	load_extensions;
930	Event::loop;	1423	Event::loop;
931	}	1424	}
932		1425
933	#############################################################################	1426	#############################################################################
934	# initialisation	1427	# initialisation
935		1428
936	sub _perl_reload(&) {	1429	sub perl_reload() {
937	my ($msg) = @_;	1430	# can/must only be called in main
		1431	if ($Coro::current != $Coro::main) {
		1432	warn "can only reload from main coroutine\n";
		1433	return;
		1434	}
938		1435
939	$msg->("reloading...");	1436	warn "reloading...";
		1437
		1438	local $FREEZE = 1;
		1439	cf::emergency_save;
940		1440
941	eval {	1441	eval {
		1442	# if anything goes wrong in here, we should simply crash as we already saved
		1443
942	# cancel all watchers	1444	# cancel all watchers
943	$_->cancel for Event::all_watchers;	1445	for (Event::all_watchers) {
		1446	$_->cancel if $_->data & WF_AUTOCANCEL;
		1447	}
		1448
		1449	# cancel all extension coros
		1450	$_->cancel for values %EXT_CORO;
		1451	%EXT_CORO = ();
944		1452
945	# unload all extensions	1453	# unload all extensions
946	for (@exts) {	1454	for (@exts) {
947	$msg->("unloading <$_>");	1455	warn "unloading <$_>";
948	unload_extension $_;	1456	unload_extension $_;
949	}	1457	}
950		1458
951	# unload all modules loaded from $LIBDIR	1459	# unload all modules loaded from $LIBDIR
952	while (my ($k, $v) = each %INC) {	1460	while (my ($k, $v) = each %INC) {
953	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1461	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
954		1462
955	$msg->("removing <$k>");	1463	warn "removing <$k>";
956	delete $INC{$k};	1464	delete $INC{$k};
957		1465
958	$k =~ s/\.pm$//;	1466	$k =~ s/\.pm$//;
959	$k =~ s/\//::/g;	1467	$k =~ s/\//::/g;
960		1468
…		…
965	Symbol::delete_package $k;	1473	Symbol::delete_package $k;
966	}	1474	}
967		1475
968	# sync database to disk	1476	# sync database to disk
969	cf::db_sync;	1477	cf::db_sync;
		1478	IO::AIO::flush;
970		1479
971	# get rid of safe::, as good as possible	1480	# get rid of safe::, as good as possible
972	Symbol::delete_package "safe::$_"	1481	Symbol::delete_package "safe::$_"
973	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	1482	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
974		1483
975	# remove register_script_function callbacks	1484	# remove register_script_function callbacks
976	# TODO	1485	# TODO
977		1486
978	# unload cf.pm "a bit"	1487	# unload cf.pm "a bit"
…		…
981	# don't, removes xs symbols, too,	1490	# don't, removes xs symbols, too,
982	# and global variables created in xs	1491	# and global variables created in xs
983	#Symbol::delete_package __PACKAGE__;	1492	#Symbol::delete_package __PACKAGE__;
984		1493
985	# reload cf.pm	1494	# reload cf.pm
986	$msg->("reloading cf.pm");	1495	warn "reloading cf.pm";
987	require cf;	1496	require cf;
		1497	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
988		1498
989	# load database again	1499	# load config and database again
		1500	cf::cfg_load;
990	cf::db_load;	1501	cf::db_load;
991		1502
992	# load extensions	1503	# load extensions
993	$msg->("load extensions");	1504	warn "load extensions";
994	cf::load_extensions;	1505	cf::load_extensions;
995		1506
996	# reattach attachments to objects	1507	# reattach attachments to objects
997	$msg->("reattach");	1508	warn "reattach";
998	_global_reattach;	1509	_global_reattach;
999	};	1510	};
1000	$msg->($@) if $@;
1001		1511
1002	$msg->("reloaded");	1512	if ($@) {
		1513	warn $@;
		1514	warn "error while reloading, exiting.";
		1515	exit 1;
		1516	}
		1517
		1518	warn "reloaded successfully";
1003	};	1519	};
1004		1520
1005	sub perl_reload() {	1521	#############################################################################
1006	_perl_reload {
1007	warn $_[0];
1008	print "$_[0]\n";
1009	};
1010	}
1011		1522
		1523	unless ($LINK_MAP) {
		1524	$LINK_MAP = cf::map::new;
		1525
		1526	$LINK_MAP->width (41);
		1527	$LINK_MAP->height (41);
		1528	$LINK_MAP->alloc;
		1529	$LINK_MAP->path ("{link}");
		1530	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		1531	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		1532	}
		1533
		1534	register "<global>", __PACKAGE__;
		1535
1012	register_command "perl-reload", 0, sub {	1536	register_command "perl-reload" => sub {
1013	my ($who, $arg) = @_;	1537	my ($who, $arg) = @_;
1014		1538
1015	if ($who->flag (FLAG_WIZ)) {	1539	if ($who->flag (FLAG_WIZ)) {
		1540	$who->message ("start of reload.");
1016	_perl_reload {	1541	perl_reload;
1017	warn $_[0];	1542	$who->message ("end of reload.");
1018	$who->message ($_[0]);
1019	};
1020	}	1543	}
1021	};	1544	};
1022		1545
1023	register "<global>", __PACKAGE__;
1024
1025	unshift @INC, $LIBDIR;	1546	unshift @INC, $LIBDIR;
1026		1547
1027	$TICK_WATCHER = Event->timer (	1548	$TICK_WATCHER = Event->timer (
		1549	reentrant => 0,
1028	prio => 1,	1550	prio => 0,
1029	at => $NEXT_TICK || 1,	1551	at => $NEXT_TICK || $TICK,
		1552	data => WF_AUTOCANCEL,
1030	cb => sub {	1553	cb => sub {
		1554	unless ($FREEZE) {
1031	cf::server_tick; # one server iteration	1555	cf::server_tick; # one server iteration
		1556	$RUNTIME += $TICK;
		1557	}
1032		1558
1033	my $NOW = Event::time;
1034	$NEXT_TICK += $TICK;	1559	$NEXT_TICK += $TICK;
1035		1560
1036	# if we are delayed by four ticks, skip them all	1561	# if we are delayed by four ticks or more, skip them all
1037	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1562	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1038		1563
1039	$TICK_WATCHER->at ($NEXT_TICK);	1564	$TICK_WATCHER->at ($NEXT_TICK);
1040	$TICK_WATCHER->start;	1565	$TICK_WATCHER->start;
1041	},	1566	},
1042	);	1567	);
1043		1568
		1569	IO::AIO::max_poll_time $TICK * 0.2;
		1570
		1571	Event->io (
		1572	fd => IO::AIO::poll_fileno,
		1573	poll => 'r',
		1574	prio => 5,
		1575	data => WF_AUTOCANCEL,
		1576	cb => \&IO::AIO::poll_cb,
		1577	);
		1578
		1579	Event->timer (
		1580	data => WF_AUTOCANCEL,
		1581	after => 0,
		1582	interval => 10,
		1583	cb => sub {
		1584	(Coro::unblock_sub {
		1585	write_runtime
		1586	or warn "ERROR: unable to write runtime file: $!";
		1587	})->();
		1588	},
		1589	);
		1590
1044	1	1591	1
1045		1592

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines