[ViewVC] Diff of: cvs/deliantra/server/lib/cf.pm

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.45 by root, Sat Aug 26 23:36:32 2006 UTC vs. Revision 1.103 by root, Sat Dec 30 10:16:11 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.45 by root, Sat Aug 26 23:36:32 2006 UTC vs.
Revision 1.103 by root, Sat Dec 30 10:16:11 2006 UTC