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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.52 by root, Mon Aug 28 16:52:51 2006 UTC vs.
Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC

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

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.52 by root, Mon Aug 28 16:52:51 2006 UTC vs. Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.52 by root, Mon Aug 28 16:52:51 2006 UTC vs.
Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC