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

Diff Legend

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