ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.56 by root, Wed Aug 30 08:28:33 2006 UTC vs.
Revision 1.134 by root, Thu Jan 4 17:28:49 2007 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 $RANDOM_MAPS = cf::localdir . "/random";
		55	our %EXT_CORO;
		56
		57	binmode STDOUT;
		58	binmode STDERR;
		59
		60	# read virtual server time, if available
		61	unless ($RUNTIME || !-e cf::localdir . "/runtime") {
		62	open my $fh, "<", cf::localdir . "/runtime"
		63	or die "unable to read runtime file: $!";
		64	$RUNTIME = <$fh> + 0.;
		65	}
		66
		67	mkdir cf::localdir;
		68	mkdir cf::localdir . "/" . cf::playerdir;
		69	mkdir cf::localdir . "/" . cf::tmpdir;
		70	mkdir cf::localdir . "/" . cf::uniquedir;
		71	mkdir $RANDOM_MAPS;
		72
		73	# a special map that is always available
		74	our $LINK_MAP;
		75	our $EMERGENCY_POSITION;
		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 my $guard = cf::guard { BLOCK }
		185
		186	Run the given callback when the guard object gets destroyed (useful for
		187	coroutine cancellations).
		188
		189	You can call C<< ->cancel >> on the guard object to stop the block from
		190	being executed.
		191
		192	=cut
		193
		194	sub guard(&) {
		195	bless \(my $cb = $_[0]), cf::guard::;
		196	}
		197
		198	sub cf::guard::cancel {
		199	${$_[0]} = sub { };
		200	}
		201
		202	sub cf::guard::DESTROY {
		203	${$_[0]}->();
		204	}
		205
		206	=item cf::lock_wait $string
		207
		208	Wait until the given lock is available. See cf::lock_acquire.
		209
		210	=item my $lock = cf::lock_acquire $string
		211
		212	Wait until the given lock is available and then acquires it and returns
		213	a guard object. If the guard object gets destroyed (goes out of scope,
		214	for example when the coroutine gets canceled), the lock is automatically
		215	returned.
		216
		217	Lock names should begin with a unique identifier (for example, cf::map::find
		218	uses map_find and cf::map::load uses map_load).
		219
		220	=cut
		221
		222	our %LOCK;
		223
		224	sub lock_wait($) {
		225	my ($key) = @_;
		226
		227	# wait for lock, if any
		228	while ($LOCK{$key}) {
		229	push @{ $LOCK{$key} }, $Coro::current;
		230	Coro::schedule;
		231	}
		232	}
		233
		234	sub lock_acquire($) {
		235	my ($key) = @_;
		236
		237	# wait, to be sure we are not locked
		238	lock_wait $key;
		239
		240	$LOCK{$key} = [];
		241
		242	cf::guard {
		243	# wake up all waiters, to be on the safe side
		244	$_->ready for @{ delete $LOCK{$key} };
		245	}
		246	}
		247
		248	=item cf::async { BLOCK }
		249
		250	Like C<Coro::async>, but runs the given BLOCK in an eval and only logs the
		251	error instead of exiting the server in case of a problem.
		252
		253	=cut
		254
		255	sub async(&) {
		256	my ($cb) = @_;
		257
		258	Coro::async {
		259	eval { $cb->() };
		260	warn $@ if $@;
		261	}
		262	}
		263
		264	sub freeze_mainloop {
		265	return unless $TICK_WATCHER->is_active;
		266
		267	my $guard = guard { $TICK_WATCHER->start };
		268	$TICK_WATCHER->stop;
		269	$guard
		270	}
		271
		272	=item cf::sync_job { BLOCK }
		273
		274	The design of crossfire+ requires that the main coro ($Coro::main) is
		275	always able to handle events or runnable, as crossfire+ is only partly
		276	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		277
		278	If it must be done, put the blocking parts into C<sync_job>. This will run
		279	the given BLOCK in another coroutine while waiting for the result. The
		280	server will be frozen during this time, so the block should either finish
		281	fast or be very important.
		282
		283	=cut
		284
		285	sub sync_job(&) {
		286	my ($job) = @_;
		287
		288	if ($Coro::current == $Coro::main) {
		289	# this is the main coro, too bad, we have to block
		290	# till the operation succeeds, freezing the server :/
		291
		292	# TODO: use suspend/resume instead
		293	# (but this is cancel-safe)
		294	my $freeze_guard = freeze_mainloop;
		295
		296	my $busy = 1;
		297	my @res;
		298
		299	(Coro::async {
		300	@res = eval { $job->() };
		301	warn $@ if $@;
		302	undef $busy;
		303	})->prio (Coro::PRIO_MAX);
		304
		305	while ($busy) {
		306	Coro::cede_notself;
		307	Event::one_event unless Coro::nready;
		308	}
		309
		310	wantarray ? @res : $res[0]
		311	} else {
		312	# we are in another coroutine, how wonderful, everything just works
		313
		314	$job->()
		315	}
		316	}
		317
		318	=item $coro = cf::coro { BLOCK }
		319
		320	Creates and returns a new coro. This coro is automcatially being canceled
		321	when the extension calling this is being unloaded.
		322
		323	=cut
		324
		325	sub coro(&) {
		326	my $cb = shift;
		327
		328	my $coro = &cf::async ($cb);
		329
		330	$coro->on_destroy (sub {
		331	delete $EXT_CORO{$coro+0};
		332	});
		333	$EXT_CORO{$coro+0} = $coro;
		334
		335	$coro
		336	}
		337
		338	sub write_runtime {
		339	my $runtime = cf::localdir . "/runtime";
		340
		341	my $fh = aio_open "$runtime~", O_WRONLY | O_CREAT, 0644
		342	or return;
		343
		344	my $value = $cf::RUNTIME + 1 + 10; # 10 is the runtime save interval, for a monotonic clock
		345	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		346	and return;
		347
		348	aio_fsync $fh
		349	and return;
		350
		351	close $fh
		352	or return;
		353
		354	aio_rename "$runtime~", $runtime
		355	and return;
		356
		357	1
		358	}
		359
		360	=back
		361
		362	=cut
		363
107	#############################################################################	364	#############################################################################
108	# "new" plug-in system
109		365
110	=head3 EVENTS AND OBJECT ATTACHMENTS	366	package cf::path;
		367
		368	sub new {
		369	my ($class, $path, $base) = @_;
		370
		371	$path = $path->as_string if ref $path;
		372
		373	my $self = bless { }, $class;
		374
		375	# {... are special paths that are not touched
		376	# ?xxx/... are special absolute paths
		377	# ?random/... random maps
		378	# /! non-realised random map exit
		379	# /... normal maps
		380	# ~/... per-player maps without a specific player (DO NOT USE)
		381	# ~user/... per-player map of a specific user
		382
		383	if ($path =~ /^{/) {
		384	# fine as it is
		385	} elsif ($path =~ s{^\?random/}{}) {
		386	Coro::AIO::aio_load "$cf::RANDOM_MAPS/$path.meta", my $data;
		387	$self->{random} = cf::from_json $data;
		388	} else {
		389	if ($path =~ s{^~([^/]+)?}{}) {
		390	$self->{user_rel} = 1;
		391
		392	if (defined $1) {
		393	$self->{user} = $1;
		394	} elsif ($base =~ m{^~([^/]+)/}) {
		395	$self->{user} = $1;
		396	} else {
		397	warn "cannot resolve user-relative path without user <$path,$base>\n";
		398	}
		399	} elsif ($path =~ /^\//) {
		400	# already absolute
		401	} else {
		402	$base =~ s{[^/]+/?$}{};
		403	return $class->new ("$base/$path");
		404	}
		405
		406	for ($path) {
		407	redo if s{/\.?/}{/};
		408	redo if s{/[^/]+/\.\./}{/};
		409	}
		410	}
		411
		412	$self->{path} = $path;
		413
		414	$self
		415	}
		416
		417	# the name / primary key / in-game path
		418	sub as_string {
		419	my ($self) = @_;
		420
		421	$self->{user_rel} ? "~$self->{user}$self->{path}"
		422	: $self->{random} ? "?random/$self->{path}"
		423	: $self->{path}
		424	}
		425
		426	# the displayed name, this is a one way mapping
		427	sub visible_name {
		428	my ($self) = @_;
		429
		430	# if (my $rmp = $self->{random}) {
		431	# # todo: be more intelligent about this
		432	# "?random/$rmp->{origin_map}+$rmp->{origin_x}+$rmp->{origin_y}/$rmp->{dungeon_level}"
		433	# } else {
		434	$self->as_string
		435	# }
		436	}
		437
		438	# escape the /'s in the path
		439	sub _escaped_path {
		440	# ∕ is U+2215
		441	(my $path = $_[0]{path}) =~ s/\//∕/g;
		442	$path
		443	}
		444
		445	# the original (read-only) location
		446	sub load_path {
		447	my ($self) = @_;
		448
		449	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		450	}
		451
		452	# the temporary/swap location
		453	sub save_path {
		454	my ($self) = @_;
		455
		456	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		457	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, $self->{path}
		458	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		459	}
		460
		461	# the unique path, might be eq to save_path
		462	sub uniq_path {
		463	my ($self) = @_;
		464
		465	$self->{user_rel} || $self->{random}
		466	? undef
		467	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		468	}
		469
		470	# return random map parameters, or undef
		471	sub random_map_params {
		472	my ($self) = @_;
		473
		474	$self->{random}
		475	}
		476
		477	# this is somewhat ugly, but style maps do need special treatment
		478	sub is_style_map {
		479	$_[0]{path} =~ m{^/styles/}
		480	}
		481
		482	package cf;
		483
		484	#############################################################################
		485
		486	=head2 ATTACHABLE OBJECTS
		487
		488	Many objects in crossfire are so-called attachable objects. That means you can
		489	attach callbacks/event handlers (a collection of which is called an "attachment")
		490	to it. All such attachable objects support the following methods.
		491
		492	In the following description, CLASS can be any of C<global>, C<object>
		493	C<player>, C<client> or C<map> (i.e. the attachable objects in
		494	crossfire+).
111		495
112	=over 4	496	=over 4
113		497
114	=item $object->attach ($attachment, key => $value...)
115
116	=item $object->detach ($attachment)
117
118	Attach/detach a pre-registered attachment to an object.
119
120	=item $player->attach ($attachment, key => $value...)
121
122	=item $player->detach ($attachment)
123
124	Attach/detach a pre-registered attachment to a player.
125
126	=item $map->attach ($attachment, key => $value...)	498	=item $attachable->attach ($attachment, key => $value...)
127		499
128	=item $map->detach ($attachment)	500	=item $attachable->detach ($attachment)
129		501
130	Attach/detach a pre-registered attachment to a map.	502	Attach/detach a pre-registered attachment to a specific object and give it
		503	the specified key/value pairs as arguments.
131		504
132	=item $bool = $object->attached ($name)	505	Example, attach a minesweeper attachment to the given object, making it a
		506	10x10 minesweeper game:
133		507
134	=item $bool = $player->attached ($name)	508	$obj->attach (minesweeper => width => 10, height => 10);
135		509
136	=item $bool = $map->attached ($name)	510	=item $bool = $attachable->attached ($name)
137		511
138	Checks wether the named attachment is currently attached to the object.	512	Checks wether the named attachment is currently attached to the object.
139		513
140	=item cf::attach_global ...	514	=item cf::CLASS->attach ...
141		515
142	Attach handlers for global events.	516	=item cf::CLASS->detach ...
143		517
144	This and all following C<attach_*>-functions expect any number of the	518	Define an anonymous attachment and attach it to all objects of the given
145	following handler/hook descriptions:	519	CLASS. See the next function for an explanation of its arguments.
		520
		521	You can attach to global events by using the C<cf::global> class.
		522
		523	Example, log all player logins:
		524
		525	cf::player->attach (
		526	on_login => sub {
		527	my ($pl) = @_;
		528	...
		529	},
		530	);
		531
		532	Example, attach to the jeweler skill:
		533
		534	cf::object->attach (
		535	type => cf::SKILL,
		536	subtype => cf::SK_JEWELER,
		537	on_use_skill => sub {
		538	my ($sk, $ob, $part, $dir, $msg) = @_;
		539	...
		540	},
		541	);
		542
		543	=item cf::CLASS::attachment $name, ...
		544
		545	Register an attachment by C<$name> through which attachable objects of the
		546	given CLASS can refer to this attachment.
		547
		548	Some classes such as crossfire maps and objects can specify attachments
		549	that are attached at load/instantiate time, thus the need for a name.
		550
		551	These calls expect any number of the following handler/hook descriptions:
146		552
147	=over 4	553	=over 4
148		554
149	=item prio => $number	555	=item prio => $number
150		556
…		…
152	by another C<prio> setting). Lower priority handlers get executed	558	by another C<prio> setting). Lower priority handlers get executed
153	earlier. The default priority is C<0>, and many built-in handlers are	559	earlier. The default priority is C<0>, and many built-in handlers are
154	registered at priority C<-1000>, so lower priorities should not be used	560	registered at priority C<-1000>, so lower priorities should not be used
155	unless you know what you are doing.	561	unless you know what you are doing.
156		562
		563	=item type => $type
		564
		565	(Only for C<< cf::object->attach >> calls), limits the attachment to the
		566	given type of objects only (the additional parameter C<subtype> can be
		567	used to further limit to the given subtype).
		568
157	=item on_I<event> => \&cb	569	=item on_I<event> => \&cb
158		570
159	Call the given code reference whenever the named event happens (event is	571	Call the given code reference whenever the named event happens (event is
160	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which	572	something like C<instantiate>, C<apply>, C<use_skill> and so on, and which
161	handlers are recognised generally depends on the type of object these	573	handlers are recognised generally depends on the type of object these
…		…
170	package and register them. Only handlers for eevents supported by the	582	package and register them. Only handlers for eevents supported by the
171	object/class are recognised.	583	object/class are recognised.
172		584
173	=back	585	=back
174		586
175	=item cf::attach_to_type $object_type, $subtype, ...	587	Example, define an attachment called "sockpuppet" that calls the given
		588	event handler when a monster attacks:
176		589
177	Attach handlers for a specific object type (e.g. TRANSPORT) and	590	cf::object::attachment sockpuppet =>
178	subtype. If C<$subtype> is zero or undef, matches all objects of the given	591	on_skill_attack => sub {
179	type.	592	my ($self, $victim) = @_;
180		593	...
181	=item cf::attach_to_objects ...
182
183	Attach handlers to all objects. Do not use this except for debugging or
184	very rare events, as handlers are (obviously) called for I<all> objects in
185	the game.
186
187	=item cf::attach_to_players ...
188
189	Attach handlers to all players.
190
191	=item cf::attach_to_maps ...
192
193	Attach handlers to all maps.
194
195	=item cf:register_attachment $name, ...
196
197	Register an attachment by name through which objects can refer to this
198	attachment.
199
200	=item cf:register_player_attachment $name, ...
201
202	Register an attachment by name through which players can refer to this
203	attachment.
204
205	=item cf:register_map_attachment $name, ...
206
207	Register an attachment by name through which maps can refer to this
208	attachment.
209
210	=cut
211
212	# the following variables are defined in .xs and must not be re-created
213	our @CB_GLOBAL = (); # registry for all global events
214	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
215	our @CB_PLAYER = ();
216	our @CB_TYPE = (); # registry for type (cf-object class) based events
217	our @CB_MAP = ();
218
219	my %attachment;
220
221	sub _attach_cb($\%$$$) {
222	my ($registry, $undo, $event, $prio, $cb) = @_;
223
224	use sort 'stable';
225
226	$cb = [$prio, $cb];
227
228	@{$registry->[$event]} = sort
229	{ $a->[0] cmp $b->[0] }
230	@{$registry->[$event] || []}, $cb;
231
232	push @{$undo->{cb}}, [$event, $cb];
233	}
234
235	# attach handles attaching event callbacks
236	# the only thing the caller has to do is pass the correct
237	# registry (== where the callback attaches to).
238	sub _attach(\@$@) {
239	my ($registry, $klass, @arg) = @_;
240
241	my $prio = 0;
242
243	my %undo = (
244	registry => $registry,
245	cb => [],
246	);
247
248	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
249
250	while (@arg) {
251	my $type = shift @arg;
252
253	if ($type eq "prio") {
254	$prio = shift @arg;
255
256	} elsif ($type eq "package") {
257	my $pkg = shift @arg;
258
259	while (my ($name, $id) = each %cb_id) {
260	if (my $cb = $pkg->can ($name)) {
261	_attach_cb $registry, %undo, $id, $prio, $cb;
262	}
263	}	594	}
264
265	} elsif (exists $cb_id{$type}) {
266	_attach_cb $registry, %undo, $cb_id{$type}, $prio, shift @arg;
267
268	} elsif (ref $type) {
269	warn "attaching objects not supported, ignoring.\n";
270
271	} else {
272	shift @arg;
273	warn "attach argument '$type' not supported, ignoring.\n";
274	}
275	}
276
277	\%undo
278	}
279
280	sub _attach_attachment {
281	my ($obj, $name, %arg) = @_;
282
283	return if exists $obj->{_attachment}{$name};
284
285	my $res;
286
287	if (my $attach = $attachment{$name}) {
288	my $registry = $obj->registry;
289
290	for (@$attach) {
291	my ($klass, @attach) = @$_;
292	$res = _attach @$registry, $klass, @attach;
293	}
294
295	$obj->{$name} = \%arg;
296	} else {
297	warn "object uses attachment '$name' that is not available, postponing.\n";
298	}
299
300	$obj->{_attachment}{$name} = undef;
301
302	$res->{attachment} = $name;
303	$res
304	}
305
306	*cf::object::attach =
307	*cf::player::attach =
308	*cf::map::attach = sub {
309	my ($obj, $name, %arg) = @_;
310
311	_attach_attachment $obj, $name, %arg;
312	};
313
314	# all those should be optimised
315	*cf::object::detach =
316	*cf::player::detach =
317	*cf::map::detach = sub {
318	my ($obj, $name) = @_;
319
320	delete $obj->{_attachment}{$name};
321	reattach ($obj);
322	};
323
324	*cf::object::attached =
325	*cf::player::attached =
326	*cf::map::attached = sub {
327	my ($obj, $name) = @_;
328
329	exists $obj->{_attachment}{$name}
330	};
331
332	sub attach_global {
333	_attach @CB_GLOBAL, KLASS_GLOBAL, @_
334	}
335
336	sub attach_to_type {
337	my $type = shift;
338	my $subtype = shift;
339
340	_attach @{$CB_TYPE[$type + $subtype * NUM_SUBTYPES]}, KLASS_OBJECT, @_
341	}
342
343	sub attach_to_objects {
344	_attach @CB_OBJECT, KLASS_OBJECT, @_
345	}
346
347	sub attach_to_players {
348	_attach @CB_PLAYER, KLASS_PLAYER, @_
349	}
350
351	sub attach_to_maps {
352	_attach @CB_MAP, KLASS_MAP, @_
353	}
354
355	sub register_attachment {
356	my $name = shift;
357
358	$attachment{$name} = [[KLASS_OBJECT, @_]];
359	}
360
361	sub register_player_attachment {
362	my $name = shift;
363
364	$attachment{$name} = [[KLASS_PLAYER, @_]];
365	}
366
367	sub register_map_attachment {
368	my $name = shift;
369
370	$attachment{$name} = [[KLASS_MAP, @_]];
371	}
372
373	our $override;
374	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
375
376	sub override {
377	$override = 1;
378	@invoke_results = ();
379	}
380
381	sub do_invoke {
382	my $event = shift;
383	my $callbacks = shift;
384
385	@invoke_results = ();
386
387	local $override;
388
389	for (@$callbacks) {
390	eval { &{$_->[1]} };
391
392	if ($@) {
393	warn "$@";
394	warn "... while processing $EVENT[$event][0] event, skipping processing altogether.\n";
395	override;
396	}
397
398	return 1 if $override;
399	}
400
401	0	595	}
402	}
403		596
404	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	597	=item $attachable->valid
405
406	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
407
408	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
409
410	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
411
412	Generate a global/object/player/map-specific event with the given arguments.
413
414	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be
415	removed in future versions), and there is no public API to access override
416	results (if you must, access C<@cf::invoke_results> directly).
417
418	=back
419
420	=head2 methods valid for all pointers
421
422	=over 4
423
424	=item $object->valid
425
426	=item $player->valid
427
428	=item $map->valid
429		598
430	Just because you have a perl object does not mean that the corresponding	599	Just because you have a perl object does not mean that the corresponding
431	C-level object still exists. If you try to access an object that has no	600	C-level object still exists. If you try to access an object that has no
432	valid C counterpart anymore you get an exception at runtime. This method	601	valid C counterpart anymore you get an exception at runtime. This method
433	can be used to test for existence of the C object part without causing an	602	can be used to test for existence of the C object part without causing an
434	exception.	603	exception.
435		604
		605	=cut
		606
		607	# the following variables are defined in .xs and must not be re-created
		608	our @CB_GLOBAL = (); # registry for all global events
		609	our @CB_ATTACHABLE = (); # registry for all attachables
		610	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
		611	our @CB_PLAYER = ();
		612	our @CB_CLIENT = ();
		613	our @CB_TYPE = (); # registry for type (cf-object class) based events
		614	our @CB_MAP = ();
		615
		616	my %attachment;
		617
		618	sub _attach_cb($$$$) {
		619	my ($registry, $event, $prio, $cb) = @_;
		620
		621	use sort 'stable';
		622
		623	$cb = [$prio, $cb];
		624
		625	@{$registry->[$event]} = sort
		626	{ $a->[0] cmp $b->[0] }
		627	@{$registry->[$event] || []}, $cb;
		628	}
		629
		630	# hack
		631	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
		632
		633	# attach handles attaching event callbacks
		634	# the only thing the caller has to do is pass the correct
		635	# registry (== where the callback attaches to).
		636	sub _attach {
		637	my ($registry, $klass, @arg) = @_;
		638
		639	my $object_type;
		640	my $prio = 0;
		641	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
		642
		643	#TODO: get rid of this hack
		644	if ($attachable_klass{$klass}) {
		645	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		646	}
		647
		648	while (@arg) {
		649	my $type = shift @arg;
		650
		651	if ($type eq "prio") {
		652	$prio = shift @arg;
		653
		654	} elsif ($type eq "type") {
		655	$object_type = shift @arg;
		656	$registry = $CB_TYPE[$object_type] ||= [];
		657
		658	} elsif ($type eq "subtype") {
		659	defined $object_type or Carp::croak "subtype specified without type";
		660	my $object_subtype = shift @arg;
		661	$registry = $CB_TYPE[$object_type + $object_subtype * NUM_SUBTYPES] ||= [];
		662
		663	} elsif ($type eq "package") {
		664	my $pkg = shift @arg;
		665
		666	while (my ($name, $id) = each %cb_id) {
		667	if (my $cb = $pkg->can ($name)) {
		668	_attach_cb $registry, $id, $prio, $cb;
		669	}
		670	}
		671
		672	} elsif (exists $cb_id{$type}) {
		673	_attach_cb $registry, $cb_id{$type}, $prio, shift @arg;
		674
		675	} elsif (ref $type) {
		676	warn "attaching objects not supported, ignoring.\n";
		677
		678	} else {
		679	shift @arg;
		680	warn "attach argument '$type' not supported, ignoring.\n";
		681	}
		682	}
		683	}
		684
		685	sub _object_attach {
		686	my ($obj, $name, %arg) = @_;
		687
		688	return if exists $obj->{_attachment}{$name};
		689
		690	if (my $attach = $attachment{$name}) {
		691	my $registry = $obj->registry;
		692
		693	for (@$attach) {
		694	my ($klass, @attach) = @$_;
		695	_attach $registry, $klass, @attach;
		696	}
		697
		698	$obj->{$name} = \%arg;
		699	} else {
		700	warn "object uses attachment '$name' that is not available, postponing.\n";
		701	}
		702
		703	$obj->{_attachment}{$name} = undef;
		704	}
		705
		706	sub cf::attachable::attach {
		707	if (ref $_[0]) {
		708	_object_attach @_;
		709	} else {
		710	_attach shift->_attach_registry, @_;
		711	}
		712	};
		713
		714	# all those should be optimised
		715	sub cf::attachable::detach {
		716	my ($obj, $name) = @_;
		717
		718	if (ref $obj) {
		719	delete $obj->{_attachment}{$name};
		720	reattach ($obj);
		721	} else {
		722	Carp::croak "cannot, currently, detach class attachments";
		723	}
		724	};
		725
		726	sub cf::attachable::attached {
		727	my ($obj, $name) = @_;
		728
		729	exists $obj->{_attachment}{$name}
		730	}
		731
		732	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
		733	eval "#line " . __LINE__ . " 'cf.pm'
		734	sub cf::\L$klass\E::_attach_registry {
		735	(\\\@CB_$klass, KLASS_$klass)
		736	}
		737
		738	sub cf::\L$klass\E::attachment {
		739	my \$name = shift;
		740
		741	\$attachment{\$name} = [[KLASS_$klass, \@_]];
		742	}
		743	";
		744	die if $@;
		745	}
		746
		747	our $override;
		748	our @invoke_results = (); # referenced from .xs code. TODO: play tricks with reify and mortals?
		749
		750	sub override {
		751	$override = 1;
		752	@invoke_results = ();
		753	}
		754
		755	sub do_invoke {
		756	my $event = shift;
		757	my $callbacks = shift;
		758
		759	@invoke_results = ();
		760
		761	local $override;
		762
		763	for (@$callbacks) {
		764	eval { &{$_->[1]} };
		765
		766	if ($@) {
		767	warn "$@";
		768	warn "... while processing $EVENT[$event][0](@_) event, skipping processing altogether.\n";
		769	override;
		770	}
		771
		772	return 1 if $override;
		773	}
		774
		775	0
		776	}
		777
		778	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
		779
		780	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
		781
		782	Generate an object-specific event with the given arguments.
		783
		784	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
		785	removed in future versions), and there is no public API to access override
		786	results (if you must, access C<@cf::invoke_results> directly).
		787
436	=back	788	=back
437		789
438	=cut	790	=cut
439
440	*cf::object::valid =
441	*cf::player::valid =
442	*cf::map::valid = \&cf::_valid;
443		791
444	#############################################################################	792	#############################################################################
445	# object support	793	# object support
446		794
447	sub instantiate {
448	my ($obj, $data) = @_;
449
450	$data = from_json $data;
451
452	for (@$data) {
453	my ($name, $args) = @$_;
454
455	$obj->attach ($name, %{$args || {} });
456	}
457	}
458
459	# basically do the same as instantiate, without calling instantiate
460	sub reattach {	795	sub reattach {
		796	# basically do the same as instantiate, without calling instantiate
461	my ($obj) = @_;	797	my ($obj) = @_;
		798
462	my $registry = $obj->registry;	799	my $registry = $obj->registry;
463		800
464	@$registry = ();	801	@$registry = ();
465		802
466	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };	803	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} || {} };
467		804
468	for my $name (keys %{ $obj->{_attachment} || {} }) {	805	for my $name (keys %{ $obj->{_attachment} || {} }) {
469	if (my $attach = $attachment{$name}) {	806	if (my $attach = $attachment{$name}) {
470	for (@$attach) {	807	for (@$attach) {
471	my ($klass, @attach) = @$_;	808	my ($klass, @attach) = @$_;
472	_attach @$registry, $klass, @attach;	809	_attach $registry, $klass, @attach;
473	}	810	}
474	} else {	811	} else {
475	warn "object uses attachment '$name' that is not available, postponing.\n";	812	warn "object uses attachment '$name' that is not available, postponing.\n";
476	}	813	}
477	}	814	}
478	}	815	}
479		816
480	sub object_freezer_save {	817	cf::attachable->attach (
481	my ($filename, $objs) = @_;
482
483	if (@$objs) {
484	open my $fh, ">:raw", "$filename.pst~";
485	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
486	close $fh;
487	chmod SAVE_MODE, "$filename.pst~";
488	rename "$filename.pst~", "$filename.pst";
489	} else {
490	unlink "$filename.pst";
491	}
492
493	chmod SAVE_MODE, "$filename~";
494	rename "$filename~", $filename;
495	}
496
497	sub object_thawer_load {
498	my ($filename) = @_;
499
500	open my $fh, "<:raw:perlio", "$filename.pst"
501	or return;
502
503	eval { local $/; (Storable::thaw <$fh>)->{objs} }
504	}
505
506	attach_to_objects
507	prio => -1000000,	818	prio => -1000000,
		819	on_instantiate => sub {
		820	my ($obj, $data) = @_;
		821
		822	$data = from_json $data;
		823
		824	for (@$data) {
		825	my ($name, $args) = @$_;
		826
		827	$obj->attach ($name, %{$args || {} });
		828	}
		829	},
		830	on_reattach => \&reattach,
508	on_clone => sub {	831	on_clone => sub {
509	my ($src, $dst) = @_;	832	my ($src, $dst) = @_;
510		833
511	@{$dst->registry} = @{$src->registry};	834	@{$dst->registry} = @{$src->registry};
512		835
513	%$dst = %$src;	836	%$dst = %$src;
514		837
515	%{$dst->{_attachment}} = %{$src->{_attachment}}	838	%{$dst->{_attachment}} = %{$src->{_attachment}}
516	if exists $src->{_attachment};	839	if exists $src->{_attachment};
517	},	840	},
518	;	841	);
		842
		843	sub object_freezer_save {
		844	my ($filename, $rdata, $objs) = @_;
		845
		846	sync_job {
		847	if (length $$rdata) {
		848	warn sprintf "saving %s (%d,%d)\n",
		849	$filename, length $$rdata, scalar @$objs;
		850
		851	if (my $fh = aio_open "$filename~", O_WRONLY | O_CREAT, 0600) {
		852	chmod SAVE_MODE, $fh;
		853	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		854	aio_fsync $fh;
		855	close $fh;
		856
		857	if (@$objs) {
		858	if (my $fh = aio_open "$filename.pst~", O_WRONLY | O_CREAT, 0600) {
		859	chmod SAVE_MODE, $fh;
		860	my $data = Storable::nfreeze { version => 1, objs => $objs };
		861	aio_write $fh, 0, (length $data), $data, 0;
		862	aio_fsync $fh;
		863	close $fh;
		864	aio_rename "$filename.pst~", "$filename.pst";
		865	}
		866	} else {
		867	aio_unlink "$filename.pst";
		868	}
		869
		870	aio_rename "$filename~", $filename;
		871	} else {
		872	warn "FATAL: $filename~: $!\n";
		873	}
		874	} else {
		875	aio_unlink $filename;
		876	aio_unlink "$filename.pst";
		877	}
		878	}
		879	}
		880
		881	sub object_freezer_as_string {
		882	my ($rdata, $objs) = @_;
		883
		884	use Data::Dumper;
		885
		886	$$rdata . Dumper $objs
		887	}
		888
		889	sub object_thawer_load {
		890	my ($filename) = @_;
		891
		892	my ($data, $av);
		893
		894	(aio_load $filename, $data) >= 0
		895	or return;
		896
		897	unless (aio_stat "$filename.pst") {
		898	(aio_load "$filename.pst", $av) >= 0
		899	or return;
		900	$av = eval { (Storable::thaw $av)->{objs} };
		901	}
		902
		903	warn sprintf "loading %s (%d)\n",
		904	$filename, length $data, scalar @{$av || []};#d#
		905	return ($data, $av);
		906	}
519		907
520	#############################################################################	908	#############################################################################
521	# old plug-in events	909	# command handling &c
522		910
523	sub inject_event {	911	=item cf::register_command $name => \&callback($ob,$args);
524	my $extension = shift;
525	my $event_code = shift;
526		912
527	my $cb = $hook[$event_code]{$extension}	913	Register a callback for execution when the client sends the user command
528	or return;	914	$name.
529		915
530	&$cb	916	=cut
531	}
532
533	sub inject_global_event {
534	my $event = shift;
535
536	my $cb = $hook[$event]
537	or return;
538
539	List::Util::max map &$_, values %$cb
540	}
541
542	sub inject_command {
543	my ($name, $obj, $params) = @_;
544
545	for my $cmd (@{ $command{$name} }) {
546	$cmd->[1]->($obj, $params);
547	}
548
549	-1
550	}
551		917
552	sub register_command {	918	sub register_command {
553	my ($name, $time, $cb) = @_;	919	my ($name, $cb) = @_;
554		920
555	my $caller = caller;	921	my $caller = caller;
556	#warn "registering command '$name/$time' to '$caller'";	922	#warn "registering command '$name/$time' to '$caller'";
557		923
558	push @{ $command{$name} }, [$time, $cb, $caller];	924	push @{ $COMMAND{$name} }, [$caller, $cb];
559	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @{ $command{$name} };
560	}	925	}
		926
		927	=item cf::register_extcmd $name => \&callback($pl,$packet);
		928
		929	Register a callbackf ro execution when the client sends an extcmd packet.
		930
		931	If the callback returns something, it is sent back as if reply was being
		932	called.
		933
		934	=cut
561		935
562	sub register_extcmd {	936	sub register_extcmd {
563	my ($name, $cb) = @_;	937	my ($name, $cb) = @_;
564		938
565	my $caller = caller;	939	my $caller = caller;
566	#warn "registering extcmd '$name' to '$caller'";	940	#warn "registering extcmd '$name' to '$caller'";
567		941
568	$extcmd{$name} = [$cb, $caller];	942	$EXTCMD{$name} = [$cb, $caller];
569	}	943	}
		944
		945	cf::player->attach (
		946	on_command => sub {
		947	my ($pl, $name, $params) = @_;
		948
		949	my $cb = $COMMAND{$name}
		950	or return;
		951
		952	for my $cmd (@$cb) {
		953	$cmd->[1]->($pl->ob, $params);
		954	}
		955
		956	cf::override;
		957	},
		958	on_extcmd => sub {
		959	my ($pl, $buf) = @_;
		960
		961	my $msg = eval { from_json $buf };
		962
		963	if (ref $msg) {
		964	if (my $cb = $EXTCMD{$msg->{msgtype}}) {
		965	if (my %reply = $cb->[0]->($pl, $msg)) {
		966	$pl->ext_reply ($msg->{msgid}, %reply);
		967	}
		968	}
		969	} else {
		970	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
		971	}
		972
		973	cf::override;
		974	},
		975	);
570		976
571	sub register {	977	sub register {
572	my ($base, $pkg) = @_;	978	my ($base, $pkg) = @_;
573		979
574	#TODO	980	#TODO
…		…
593	. "#line 1 \"$path\"\n{\n"	999	. "#line 1 \"$path\"\n{\n"
594	. (do { local $/; <$fh> })	1000	. (do { local $/; <$fh> })
595	. "\n};\n1";	1001	. "\n};\n1";
596		1002
597	eval $source	1003	eval $source
598	or die "$path: $@";	1004	or die $@ ? "$path: $@\n"
		1005	: "extension disabled.\n";
599		1006
600	push @exts, $pkg;	1007	push @exts, $pkg;
601	$ext_pkg{$base} = $pkg;	1008	$ext_pkg{$base} = $pkg;
602		1009
603	# no strict 'refs';	1010	# no strict 'refs';
…		…
616	# for my $idx (0 .. $#PLUGIN_EVENT) {	1023	# for my $idx (0 .. $#PLUGIN_EVENT) {
617	# delete $hook[$idx]{$pkg};	1024	# delete $hook[$idx]{$pkg};
618	# }	1025	# }
619		1026
620	# remove commands	1027	# remove commands
621	for my $name (keys %command) {	1028	for my $name (keys %COMMAND) {
622	my @cb = grep $_->[2] ne $pkg, @{ $command{$name} };	1029	my @cb = grep $_->[0] ne $pkg, @{ $COMMAND{$name} };
623		1030
624	if (@cb) {	1031	if (@cb) {
625	$command{$name} = \@cb;	1032	$COMMAND{$name} = \@cb;
626	$COMMAND{"$name\000"} = List::Util::max map $_->[0], @cb;
627	} else {	1033	} else {
628	delete $command{$name};
629	delete $COMMAND{"$name\000"};	1034	delete $COMMAND{$name};
630	}	1035	}
631	}	1036	}
632		1037
633	# remove extcmds	1038	# remove extcmds
634	for my $name (grep $extcmd{$_}[1] eq $pkg, keys %extcmd) {	1039	for my $name (grep $EXTCMD{$_}[1] eq $pkg, keys %EXTCMD) {
635	delete $extcmd{$name};	1040	delete $EXTCMD{$name};
636	}	1041	}
637		1042
638	if (my $cb = $pkg->can ("unload")) {	1043	if (my $cb = $pkg->can ("unload")) {
639	eval {	1044	eval {
640	$cb->($pkg);	1045	$cb->($pkg);
…		…
644		1049
645	Symbol::delete_package $pkg;	1050	Symbol::delete_package $pkg;
646	}	1051	}
647		1052
648	sub load_extensions {	1053	sub load_extensions {
649	my $LIBDIR = maps_directory "perl";
650
651	for my $ext (<$LIBDIR/*.ext>) {	1054	for my $ext (<$LIBDIR/*.ext>) {
652	next unless -r $ext;	1055	next unless -r $ext;
653	eval {	1056	eval {
654	load_extension $ext;	1057	load_extension $ext;
655	1	1058	1
656	} or warn "$ext not loaded: $@";	1059	} or warn "$ext not loaded: $@";
657	}	1060	}
658	}	1061	}
659		1062
660	sub _perl_reload(&) {
661	my ($msg) = @_;
662
663	$msg->("reloading...");
664
665	eval {
666	# 1. cancel all watchers
667	$_->cancel for Event::all_watchers;
668
669	# 2. unload all extensions
670	for (@exts) {
671	$msg->("unloading <$_>");
672	unload_extension $_;
673	}
674
675	# 3. unload all modules loaded from $LIBDIR
676	while (my ($k, $v) = each %INC) {
677	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
678
679	$msg->("removing <$k>");
680	delete $INC{$k};
681
682	$k =~ s/\.pm$//;
683	$k =~ s/\//::/g;
684
685	if (my $cb = $k->can ("unload_module")) {
686	$cb->();
687	}
688
689	Symbol::delete_package $k;
690	}
691
692	# 4. get rid of safe::, as good as possible
693	Symbol::delete_package "safe::$_"
694	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);
695
696	# 5. remove register_script_function callbacks
697	# TODO
698
699	# 6. unload cf.pm "a bit"
700	delete $INC{"cf.pm"};
701
702	# don't, removes xs symbols, too,
703	# and global variables created in xs
704	#Symbol::delete_package __PACKAGE__;
705
706	# 7. reload cf.pm
707	$msg->("reloading cf.pm");
708	require cf;
709	};
710	$msg->($@) if $@;
711
712	$msg->("reloaded");
713	};
714
715	sub perl_reload() {
716	_perl_reload {
717	warn $_[0];
718	print "$_[0]\n";
719	};
720	}
721
722	register_command "perl-reload", 0, sub {
723	my ($who, $arg) = @_;
724
725	if ($who->flag (FLAG_WIZ)) {
726	_perl_reload {
727	warn $_[0];
728	$who->message ($_[0]);
729	};
730	}
731	};
732
733	#############################################################################
734	# extcmd framework, basically convert ext <msg>
735	# into pkg::->on_extcmd_arg1 (...) while shortcutting a few
736
737	attach_to_players
738	on_extcmd => sub {
739	my ($pl, $buf) = @_;
740
741	my $msg = eval { from_json $buf };
742
743	if (ref $msg) {
744	if (my $cb = $extcmd{$msg->{msgtype}}) {
745	if (my %reply = $cb->[0]->($pl, $msg)) {
746	$pl->ext_reply ($msg->{msgid}, %reply);
747	}
748	}
749	} else {
750	warn "player " . ($pl->ob->name) . " sent unparseable ext message: <$buf>\n";
751	}
752
753	cf::override;
754	},
755	;
756
757	#############################################################################	1063	#############################################################################
758	# load/save/clean perl data associated with a map	1064	# load/save/clean perl data associated with a map
759		1065
760	*cf::mapsupport::on_clean = sub {	1066	*cf::mapsupport::on_clean = sub {
761	my ($map) = @_;	1067	my ($map) = @_;
…		…
764	defined $path or return;	1070	defined $path or return;
765		1071
766	unlink "$path.pst";	1072	unlink "$path.pst";
767	};	1073	};
768		1074
769	# old style persistent data, TODO: remove #d#
770	*cf::mapsupport::on_swapin = sub {
771	my ($map) = @_;
772
773	my $path = $map->tmpname;
774	$path = $map->path unless defined $path;
775
776	warn "$path.cfperl\n";#d#
777
778	open my $fh, "<:raw", "$path.cfperl"
779	or return; # no perl data
780
781	my $data = Storable::thaw do { local $/; <$fh> };
782
783	$data->{version} <= 1
784	or return; # too new
785
786	$map->_set_obs ($data->{obs});
787	$map->invoke (EVENT_MAP_UPGRADE);
788	};
789
790	attach_to_maps prio => -10000, package => cf::mapsupport::;	1075	cf::map->attach (prio => -10000, package => cf::mapsupport::);
791		1076
792	#############################################################################	1077	#############################################################################
793	# load/save perl data associated with player->ob objects	1078	# load/save perl data associated with player->ob objects
794		1079
795	sub all_objects(@) {	1080	sub all_objects(@) {
796	@_, map all_objects ($_->inv), @_	1081	@_, map all_objects ($_->inv), @_
797	}	1082	}
798		1083
799	attach_to_players	1084	# TODO: compatibility cruft, remove when no longer needed
		1085	cf::player->attach (
800	on_load => sub {	1086	on_load => sub {
801	my ($pl, $path) = @_;	1087	my ($pl, $path) = @_;
802		1088
803	for my $o (all_objects $pl->ob) {	1089	for my $o (all_objects $pl->ob) {
804	if (my $value = $o->get_ob_key_value ("_perl_data")) {	1090	if (my $value = $o->get_ob_key_value ("_perl_data")) {
…		…
806		1092
807	%$o = %{ Storable::thaw pack "H*", $value };	1093	%$o = %{ Storable::thaw pack "H*", $value };
808	}	1094	}
809	}	1095	}
810	},	1096	},
811	;	1097	);
812		1098
813	#############################################################################	1099	#############################################################################
814	# core extensions - in perl	1100
		1101	=head2 CORE EXTENSIONS
		1102
		1103	Functions and methods that extend core crossfire objects.
		1104
		1105	=head3 cf::player
		1106
		1107	=over 4
815		1108
816	=item cf::player::exists $login	1109	=item cf::player::exists $login
817		1110
818	Returns true when the given account exists.	1111	Returns true when the given account exists.
819		1112
…		…
822	sub cf::player::exists($) {	1115	sub cf::player::exists($) {
823	cf::player::find $_[0]	1116	cf::player::find $_[0]
824	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1117	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
825	}	1118	}
826		1119
		1120	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1121
		1122	Sends an ext reply to the player.
		1123
		1124	=cut
		1125
		1126	sub cf::player::ext_reply($$$%) {
		1127	my ($self, $id, %msg) = @_;
		1128
		1129	$msg{msgid} = $id;
		1130
		1131	$self->send ("ext " . to_json \%msg);
		1132	}
		1133
		1134	=back
		1135
		1136
		1137	=head3 cf::map
		1138
		1139	=over 4
		1140
		1141	=cut
		1142
		1143	package cf::map;
		1144
		1145	use Fcntl;
		1146	use Coro::AIO;
		1147
		1148	our $MAX_RESET = 3600;
		1149	our $DEFAULT_RESET = 3000;
		1150
		1151	sub generate_random_map {
		1152	my ($path, $rmp) = @_;
		1153
		1154	# mit "rum" bekleckern, nicht
		1155	cf::map::_create_random_map
		1156	$path,
		1157	$rmp->{wallstyle}, $rmp->{wall_name}, $rmp->{floorstyle}, $rmp->{monsterstyle},
		1158	$rmp->{treasurestyle}, $rmp->{layoutstyle}, $rmp->{doorstyle}, $rmp->{decorstyle},
		1159	$rmp->{origin_map}, $rmp->{final_map}, $rmp->{exitstyle}, $rmp->{this_map},
		1160	$rmp->{exit_on_final_map},
		1161	$rmp->{xsize}, $rmp->{ysize},
		1162	$rmp->{expand2x}, $rmp->{layoutoptions1}, $rmp->{layoutoptions2}, $rmp->{layoutoptions3},
		1163	$rmp->{symmetry}, $rmp->{difficulty}, $rmp->{difficulty_given}, $rmp->{difficulty_increase},
		1164	$rmp->{dungeon_level}, $rmp->{dungeon_depth}, $rmp->{decoroptions}, $rmp->{orientation},
		1165	$rmp->{origin_y}, $rmp->{origin_x}, $rmp->{random_seed}, $rmp->{total_map_hp},
		1166	$rmp->{map_layout_style}, $rmp->{treasureoptions}, $rmp->{symmetry_used},
		1167	(cf::region::find $rmp->{region})
		1168	}
		1169
		1170	# and all this just because we cannot iterate over
		1171	# all maps in C++...
		1172	sub change_all_map_light {
		1173	my ($change) = @_;
		1174
		1175	$_->change_map_light ($change)
		1176	for grep $_->outdoor, values %cf::MAP;
		1177	}
		1178
		1179	sub try_load_header($) {
		1180	my ($path) = @_;
		1181
		1182	utf8::encode $path;
		1183	aio_open $path, O_RDONLY, 0
		1184	or return;
		1185
		1186	my $map = cf::map::new
		1187	or return;
		1188
		1189	$map->load_header ($path)
		1190	or return;
		1191
		1192	$map->{load_path} = $path;
		1193
		1194	$map
		1195	}
		1196
		1197	sub find;
		1198	sub find {
		1199	my ($path, $origin) = @_;
		1200
		1201	#warn "find<$path,$origin>\n";#d#
		1202
		1203	$path = new cf::path $path, $origin && $origin->path;
		1204	my $key = $path->as_string;
		1205
		1206	cf::lock_wait "map_find:$key";
		1207
		1208	$cf::MAP{$key} || do {
		1209	my $guard = cf::lock_acquire "map_find:$key";
		1210
		1211	# do it the slow way
		1212	my $map = try_load_header $path->save_path;
		1213
		1214	Coro::cede;
		1215
		1216	if ($map) {
		1217	$map->last_access ((delete $map->{last_access})
		1218	|| $cf::RUNTIME); #d#
		1219	# safety
		1220	$map->{instantiate_time} = $cf::RUNTIME
		1221	if $map->{instantiate_time} > $cf::RUNTIME;
		1222	} else {
		1223	if (my $rmp = $path->random_map_params) {
		1224	$map = generate_random_map $key, $rmp;
		1225	} else {
		1226	$map = try_load_header $path->load_path;
		1227	}
		1228
		1229	$map or return;
		1230
		1231	$map->{load_original} = 1;
		1232	$map->{instantiate_time} = $cf::RUNTIME;
		1233	$map->last_access ($cf::RUNTIME);
		1234	$map->instantiate;
		1235
		1236	# per-player maps become, after loading, normal maps
		1237	$map->per_player (0) if $path->{user_rel};
		1238	}
		1239
		1240	$map->path ($key);
		1241	$map->{path} = $path;
		1242	$map->{last_save} = $cf::RUNTIME;
		1243
		1244	Coro::cede;
		1245
		1246	if ($map->should_reset) {
		1247	$map->reset;
		1248	undef $guard;
		1249	$map = find $path
		1250	or return;
		1251	}
		1252
		1253	$cf::MAP{$key} = $map
		1254	}
		1255	}
		1256
		1257	sub load {
		1258	my ($self) = @_;
		1259
		1260	my $path = $self->{path};
		1261	my $guard = cf::lock_acquire "map_load:" . $path->as_string;
		1262
		1263	return if $self->in_memory != cf::MAP_SWAPPED;
		1264
		1265	$self->in_memory (cf::MAP_LOADING);
		1266
		1267	$self->alloc;
		1268	$self->load_objects ($self->{load_path}, 1)
		1269	or return;
		1270
		1271	$self->set_object_flag (cf::FLAG_OBJ_ORIGINAL, 1)
		1272	if delete $self->{load_original};
		1273
		1274	if (my $uniq = $path->uniq_path) {
		1275	utf8::encode $uniq;
		1276	if (aio_open $uniq, O_RDONLY, 0) {
		1277	$self->clear_unique_items;
		1278	$self->load_objects ($uniq, 0);
		1279	}
		1280	}
		1281
		1282	Coro::cede;
		1283
		1284	# now do the right thing for maps
		1285	$self->link_multipart_objects;
		1286
		1287	if ($self->{path}->is_style_map) {
		1288	$self->{deny_save} = 1;
		1289	$self->{deny_reset} = 1;
		1290	} else {
		1291	$self->fix_auto_apply;
		1292	$self->decay_objects;
		1293	$self->update_buttons;
		1294	$self->set_darkness_map;
		1295	$self->difficulty ($self->estimate_difficulty)
		1296	unless $self->difficulty;
		1297	$self->activate;
		1298	}
		1299
		1300	Coro::cede;
		1301
		1302	$self->in_memory (cf::MAP_IN_MEMORY);
		1303	}
		1304
		1305	sub find_sync {
		1306	my ($path, $origin) = @_;
		1307
		1308	cf::sync_job { cf::map::find $path, $origin }
		1309	}
		1310
		1311	sub do_load_sync {
		1312	my ($map) = @_;
		1313
		1314	cf::sync_job { $map->load };
		1315	}
		1316
		1317	sub save {
		1318	my ($self) = @_;
		1319
		1320	$self->{last_save} = $cf::RUNTIME;
		1321
		1322	return unless $self->dirty;
		1323
		1324	my $save = $self->{path}->save_path; utf8::encode $save;
		1325	my $uniq = $self->{path}->uniq_path; utf8::encode $uniq;
		1326
		1327	$self->{load_path} = $save;
		1328
		1329	return if $self->{deny_save};
		1330
		1331	local $self->{last_access} = $self->last_access;#d#
		1332
		1333	if ($uniq) {
		1334	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS);
		1335	$self->save_objects ($uniq, cf::IO_UNIQUES);
		1336	} else {
		1337	$self->save_objects ($save, cf::IO_HEADER | cf::IO_OBJECTS | cf::IO_UNIQUES);
		1338	}
		1339	}
		1340
		1341	sub swap_out {
		1342	my ($self) = @_;
		1343
		1344	# save first because save cedes
		1345	$self->save;
		1346
		1347	return if $self->players;
		1348	return if $self->in_memory != cf::MAP_IN_MEMORY;
		1349	return if $self->{deny_save};
		1350
		1351	$self->clear;
		1352	$self->in_memory (cf::MAP_SWAPPED);
		1353	}
		1354
		1355	sub reset_at {
		1356	my ($self) = @_;
		1357
		1358	# TODO: safety, remove and allow resettable per-player maps
		1359	return 1e99 if $self->{path}{user_rel};
		1360	return 1e99 if $self->{deny_reset};
		1361
		1362	my $time = $self->fixed_resettime ? $self->{instantiate_time} : $self->last_access;
		1363	my $to = List::Util::min $MAX_RESET, $self->reset_timeout || $DEFAULT_RESET;
		1364
		1365	$time + $to
		1366	}
		1367
		1368	sub should_reset {
		1369	my ($self) = @_;
		1370
		1371	$self->reset_at <= $cf::RUNTIME
		1372	}
		1373
		1374	sub unlink_save {
		1375	my ($self) = @_;
		1376
		1377	utf8::encode (my $save = $self->{path}->save_path);
		1378	aioreq_pri 3; IO::AIO::aio_unlink $save;
		1379	aioreq_pri 3; IO::AIO::aio_unlink "$save.pst";
		1380	}
		1381
		1382	sub rename {
		1383	my ($self, $new_path) = @_;
		1384
		1385	$self->unlink_save;
		1386
		1387	delete $cf::MAP{$self->path};
		1388	$self->{path} = new cf::path $new_path;
		1389	$self->path ($self->{path}->as_string);
		1390	$cf::MAP{$self->path} = $self;
		1391
		1392	$self->save;
		1393	}
		1394
		1395	sub reset {
		1396	my ($self) = @_;
		1397
		1398	return if $self->players;
		1399	return if $self->{path}{user_rel};#d#
		1400
		1401	warn "resetting map ", $self->path;#d#
		1402
		1403	delete $cf::MAP{$self->path};
		1404
		1405	$_->clear_links_to ($self) for values %cf::MAP;
		1406
		1407	$self->unlink_save;
		1408	$self->destroy;
		1409	}
		1410
		1411	my $nuke_counter = "aaaa";
		1412
		1413	sub nuke {
		1414	my ($self) = @_;
		1415
		1416	$self->{deny_save} = 1;
		1417	$self->reset_timeout (1);
		1418	$self->rename ("{nuke}/" . ($nuke_counter++));
		1419	$self->reset; # polite request, might not happen
		1420	}
		1421
		1422	sub customise_for {
		1423	my ($map, $ob) = @_;
		1424
		1425	if ($map->per_player) {
		1426	return cf::map::find "~" . $ob->name . "/" . $map->{path}{path};
		1427	}
		1428
		1429	$map
		1430	}
		1431
		1432	sub emergency_save {
		1433	my $freeze_guard = cf::freeze_mainloop;
		1434
		1435	warn "enter emergency map save\n";
		1436
		1437	cf::sync_job {
		1438	warn "begin emergency map save\n";
		1439	$_->save for values %cf::MAP;
		1440	};
		1441
		1442	warn "end emergency map save\n";
		1443	}
		1444
		1445	package cf;
		1446
		1447	=back
		1448
		1449
		1450	=head3 cf::object::player
		1451
		1452	=over 4
		1453
827	=item $player->reply ($npc, $msg[, $flags])	1454	=item $player_object->reply ($npc, $msg[, $flags])
828		1455
829	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1456	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
830	can be C<undef>. Does the right thing when the player is currently in a	1457	can be C<undef>. Does the right thing when the player is currently in a
831	dialogue with the given NPC character.	1458	dialogue with the given NPC character.
832		1459
833	=cut	1460	=cut
834		1461
835	# rough implementation of a future "reply" method that works	1462	# rough implementation of a future "reply" method that works
836	# with dialog boxes.	1463	# with dialog boxes.
		1464	#TODO: the first argument must go, split into a $npc->reply_to ( method
837	sub cf::object::player::reply($$$;$) {	1465	sub cf::object::player::reply($$$;$) {
838	my ($self, $npc, $msg, $flags) = @_;	1466	my ($self, $npc, $msg, $flags) = @_;
839		1467
840	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;	1468	$flags = cf::NDI_BROWN | cf::NDI_UNIQUE unless @_ >= 4;
841		1469
…		…
845	$msg = $npc->name . " says: $msg" if $npc;	1473	$msg = $npc->name . " says: $msg" if $npc;
846	$self->message ($msg, $flags);	1474	$self->message ($msg, $flags);
847	}	1475	}
848	}	1476	}
849		1477
850	=item $player->ext_reply ($msgid, $msgtype, %msg)	1478	=item $player_object->may ("access")
851		1479
852	Sends an ext reply to the player.	1480	Returns wether the given player is authorized to access resource "access"
		1481	(e.g. "command_wizcast").
853		1482
854	=cut	1483	=cut
855		1484
856	sub cf::player::ext_reply($$$%) {	1485	sub cf::object::player::may {
		1486	my ($self, $access) = @_;
		1487
		1488	$self->flag (cf::FLAG_WIZ) ||
		1489	(ref $cf::CFG{"may_$access"}
		1490	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
		1491	: $cf::CFG{"may_$access"})
		1492	}
		1493
		1494	=item $player_object->enter_link
		1495
		1496	Freezes the player and moves him/her to a special map (C<{link}>).
		1497
		1498	The player should be reaosnably safe there for short amounts of time. You
		1499	I<MUST> call C<leave_link> as soon as possible, though.
		1500
		1501	=item $player_object->leave_link ($map, $x, $y)
		1502
		1503	Moves the player out of the specila link map onto the given map. If the
		1504	map is not valid (or omitted), the player will be moved back to the
		1505	location he/she was before the call to C<enter_link>, or, if that fails,
		1506	to the emergency map position.
		1507
		1508	Might block.
		1509
		1510	=cut
		1511
		1512	sub cf::object::player::enter_link {
		1513	my ($self) = @_;
		1514
		1515	$self->deactivate_recursive;
		1516
		1517	return if $self->map == $LINK_MAP;
		1518
		1519	$self->{_link_pos} ||= [$self->map->{path}, $self->x, $self->y]
		1520	if $self->map;
		1521
		1522	$self->enter_map ($LINK_MAP, 20, 20);
		1523	}
		1524
		1525	sub cf::object::player::leave_link {
		1526	my ($self, $map, $x, $y) = @_;
		1527
		1528	my $link_pos = delete $self->{_link_pos};
		1529
		1530	unless ($map) {
		1531	# restore original map position
		1532	($map, $x, $y) = @{ $link_pos || [] };
		1533	$map = cf::map::find $map;
		1534
		1535	unless ($map) {
		1536	($map, $x, $y) = @$EMERGENCY_POSITION;
		1537	$map = cf::map::find $map
		1538	or die "FATAL: cannot load emergency map\n";
		1539	}
		1540	}
		1541
		1542	($x, $y) = (-1, -1)
		1543	unless (defined $x) && (defined $y);
		1544
		1545	# use -1 or undef as default coordinates, not 0, 0
		1546	($x, $y) = ($map->enter_x, $map->enter_y)
		1547	if $x <=0 && $y <= 0;
		1548
		1549	$map->load;
		1550
		1551	$self->activate_recursive;
		1552	$self->enter_map ($map, $x, $y);
		1553	}
		1554
		1555	cf::player->attach (
		1556	on_logout => sub {
		1557	my ($pl) = @_;
		1558
		1559	# abort map switching before logout
		1560	if ($pl->ob->{_link_pos}) {
		1561	cf::sync_job {
		1562	$pl->ob->leave_link
		1563	};
		1564	}
		1565	},
		1566	on_login => sub {
		1567	my ($pl) = @_;
		1568
		1569	# try to abort aborted map switching on player login :)
		1570	# should happen only on crashes
		1571	if ($pl->ob->{_link_pos}) {
		1572	$pl->ob->enter_link;
		1573	cf::async {
		1574	# we need this sleep as the login has a concurrent enter_exit running
		1575	# and this sleep increases chances of the player not ending up in scorn
		1576	Coro::Timer::sleep 1;
		1577	$pl->ob->leave_link;
		1578	};
		1579	}
		1580	},
		1581	);
		1582
		1583	=item $player_object->goto_map ($path, $x, $y)
		1584
		1585	=cut
		1586
		1587	sub cf::object::player::goto_map {
		1588	my ($self, $path, $x, $y) = @_;
		1589
		1590	$self->enter_link;
		1591
		1592	(cf::async {
		1593	$path = new cf::path $path;
		1594
		1595	my $map = cf::map::find $path->as_string;
		1596	$map = $map->customise_for ($self) if $map;
		1597
		1598	# warn "entering ", $map->path, " at ($x, $y)\n"
		1599	# if $map;
		1600
		1601	$map or $self->message ("The exit is closed", cf::NDI_UNIQUE | cf::NDI_RED);
		1602
		1603	$self->leave_link ($map, $x, $y);
		1604	})->prio (1);
		1605	}
		1606
		1607	=item $player_object->enter_exit ($exit_object)
		1608
		1609	=cut
		1610
		1611	sub parse_random_map_params {
		1612	my ($spec) = @_;
		1613
		1614	my $rmp = { # defaults
		1615	xsize => 10,
		1616	ysize => 10,
		1617	};
		1618
		1619	for (split /\n/, $spec) {
		1620	my ($k, $v) = split /\s+/, $_, 2;
		1621
		1622	$rmp->{lc $k} = $v if (length $k) && (length $v);
		1623	}
		1624
		1625	$rmp
		1626	}
		1627
		1628	sub prepare_random_map {
		1629	my ($exit) = @_;
		1630
		1631	# all this does is basically replace the /! path by
		1632	# a new random map path (?random/...) with a seed
		1633	# that depends on the exit object
		1634
		1635	my $rmp = parse_random_map_params $exit->msg;
		1636
		1637	if ($exit->map) {
		1638	$rmp->{region} = $exit->map->region_name;
		1639	$rmp->{origin_map} = $exit->map->path;
		1640	$rmp->{origin_x} = $exit->x;
		1641	$rmp->{origin_y} = $exit->y;
		1642	}
		1643
		1644	$rmp->{random_seed} ||= $exit->random_seed;
		1645
		1646	my $data = cf::to_json $rmp;
		1647	my $md5 = Digest::MD5::md5_hex $data;
		1648
		1649	if (my $fh = aio_open "$cf::RANDOM_MAPS/$md5.meta", O_WRONLY | O_CREAT, 0666) {
		1650	aio_write $fh, 0, (length $data), $data, 0;
		1651
		1652	$exit->slaying ("?random/$md5");
		1653	$exit->msg (undef);
		1654	}
		1655	}
		1656
		1657	sub cf::object::player::enter_exit {
857	my ($self, $id, %msg) = @_;	1658	my ($self, $exit) = @_;
858		1659
859	$msg{msgid} = $id;	1660	return unless $self->type == cf::PLAYER;
860		1661
861	$self->send ("ext " . to_json \%msg);	1662	$self->enter_link;
862	}
863		1663
864	#############################################################################	1664	(cf::async {
865	# map scripting support	1665	$self->deactivate_recursive; # just to be sure
		1666	unless (eval {
		1667	prepare_random_map $exit
		1668	if $exit->slaying eq "/!";
		1669
		1670	my $path = new cf::path $exit->slaying, $exit->map && $exit->map->path;
		1671	$self->goto_map ($path, $exit->stats->hp, $exit->stats->sp);
		1672
		1673	1;
		1674	}) {
		1675	$self->message ("Something went wrong deep within the crossfire server. "
		1676	. "I'll try to bring you back to the map you were before. "
		1677	. "Please report this to the dungeon master",
		1678	cf::NDI_UNIQUE | cf::NDI_RED);
		1679
		1680	warn "ERROR in enter_exit: $@";
		1681	$self->leave_link;
		1682	}
		1683	})->prio (1);
		1684	}
		1685
		1686	=head3 cf::client
		1687
		1688	=over 4
		1689
		1690	=item $client->send_drawinfo ($text, $flags)
		1691
		1692	Sends a drawinfo packet to the client. Circumvents output buffering so
		1693	should not be used under normal circumstances.
		1694
		1695	=cut
		1696
		1697	sub cf::client::send_drawinfo {
		1698	my ($self, $text, $flags) = @_;
		1699
		1700	utf8::encode $text;
		1701	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1702	}
		1703
		1704
		1705	=item $success = $client->query ($flags, "text", \&cb)
		1706
		1707	Queues a query to the client, calling the given callback with
		1708	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1709	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1710
		1711	Queries can fail, so check the return code. Or don't, as queries will become
		1712	reliable at some point in the future.
		1713
		1714	=cut
		1715
		1716	sub cf::client::query {
		1717	my ($self, $flags, $text, $cb) = @_;
		1718
		1719	return unless $self->state == ST_PLAYING
		1720	|| $self->state == ST_SETUP
		1721	|| $self->state == ST_CUSTOM;
		1722
		1723	$self->state (ST_CUSTOM);
		1724
		1725	utf8::encode $text;
		1726	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1727
		1728	$self->send_packet ($self->{query_queue}[0][0])
		1729	if @{ $self->{query_queue} } == 1;
		1730	}
		1731
		1732	cf::client->attach (
		1733	on_reply => sub {
		1734	my ($ns, $msg) = @_;
		1735
		1736	# this weird shuffling is so that direct followup queries
		1737	# get handled first
		1738	my $queue = delete $ns->{query_queue}
		1739	or return; # be conservative, not sure how that can happen, but we saw a crash here
		1740
		1741	(shift @$queue)->[1]->($msg);
		1742
		1743	push @{ $ns->{query_queue} }, @$queue;
		1744
		1745	if (@{ $ns->{query_queue} } == @$queue) {
		1746	if (@$queue) {
		1747	$ns->send_packet ($ns->{query_queue}[0][0]);
		1748	} else {
		1749	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1750	}
		1751	}
		1752	},
		1753	);
		1754
		1755	=item $client->coro (\&cb)
		1756
		1757	Create a new coroutine, running the specified callback. The coroutine will
		1758	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1759	or loss of connection).
		1760
		1761	=cut
		1762
		1763	sub cf::client::coro {
		1764	my ($self, $cb) = @_;
		1765
		1766	my $coro = &cf::async ($cb);
		1767
		1768	$coro->on_destroy (sub {
		1769	delete $self->{_coro}{$coro+0};
		1770	});
		1771
		1772	$self->{_coro}{$coro+0} = $coro;
		1773
		1774	$coro
		1775	}
		1776
		1777	cf::client->attach (
		1778	on_destroy => sub {
		1779	my ($ns) = @_;
		1780
		1781	$_->cancel for values %{ (delete $ns->{_coro}) || {} };
		1782	},
		1783	);
		1784
		1785	=back
		1786
		1787
		1788	=head2 SAFE SCRIPTING
		1789
		1790	Functions that provide a safe environment to compile and execute
		1791	snippets of perl code without them endangering the safety of the server
		1792	itself. Looping constructs, I/O operators and other built-in functionality
		1793	is not available in the safe scripting environment, and the number of
		1794	functions and methods that can be called is greatly reduced.
		1795
		1796	=cut
866		1797
867	our $safe = new Safe "safe";	1798	our $safe = new Safe "safe";
868	our $safe_hole = new Safe::Hole;	1799	our $safe_hole = new Safe::Hole;
869		1800
870	$SIG{FPE} = 'IGNORE';	1801	$SIG{FPE} = 'IGNORE';
871		1802
872	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));	1803	$safe->permit_only (Opcode::opset qw(:base_core :base_mem :base_orig :base_math sort time));
873		1804
874	# here we export the classes and methods available to script code	1805	# here we export the classes and methods available to script code
875		1806
		1807	=pod
		1808
		1809	The following fucntions and emthods are available within a safe environment:
		1810
		1811	cf::object contr pay_amount pay_player map
		1812	cf::object::player player
		1813	cf::player peaceful
		1814	cf::map trigger
		1815
		1816	=cut
		1817
876	for (	1818	for (
877	["cf::object" => qw(contr pay_amount pay_player)],	1819	["cf::object" => qw(contr pay_amount pay_player map)],
878	["cf::object::player" => qw(player)],	1820	["cf::object::player" => qw(player)],
879	["cf::player" => qw(peaceful)],	1821	["cf::player" => qw(peaceful)],
		1822	["cf::map" => qw(trigger)],
880	) {	1823	) {
881	no strict 'refs';	1824	no strict 'refs';
882	my ($pkg, @funs) = @$_;	1825	my ($pkg, @funs) = @$_;
883	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})	1826	*{"safe::$pkg\::$_"} = $safe_hole->wrap (\&{"$pkg\::$_"})
884	for @funs;	1827	for @funs;
885	}	1828	}
		1829
		1830	=over 4
		1831
		1832	=item @retval = safe_eval $code, [var => value, ...]
		1833
		1834	Compiled and executes the given perl code snippet. additional var/value
		1835	pairs result in temporary local (my) scalar variables of the given name
		1836	that are available in the code snippet. Example:
		1837
		1838	my $five = safe_eval '$first + $second', first => 1, second => 4;
		1839
		1840	=cut
886		1841
887	sub safe_eval($;@) {	1842	sub safe_eval($;@) {
888	my ($code, %vars) = @_;	1843	my ($code, %vars) = @_;
889		1844
890	my $qcode = $code;	1845	my $qcode = $code;
…		…
913	}	1868	}
914		1869
915	wantarray ? @res : $res[0]	1870	wantarray ? @res : $res[0]
916	}	1871	}
917		1872
		1873	=item cf::register_script_function $function => $cb
		1874
		1875	Register a function that can be called from within map/npc scripts. The
		1876	function should be reasonably secure and should be put into a package name
		1877	like the extension.
		1878
		1879	Example: register a function that gets called whenever a map script calls
		1880	C<rent::overview>, as used by the C<rent> extension.
		1881
		1882	cf::register_script_function "rent::overview" => sub {
		1883	...
		1884	};
		1885
		1886	=cut
		1887
918	sub register_script_function {	1888	sub register_script_function {
919	my ($fun, $cb) = @_;	1889	my ($fun, $cb) = @_;
920		1890
921	no strict 'refs';	1891	no strict 'refs';
922	*{"safe::$fun"} = $safe_hole->wrap ($cb);	1892	*{"safe::$fun"} = $safe_hole->wrap ($cb);
923	}	1893	}
924		1894
		1895	=back
		1896
		1897	=cut
		1898
		1899	#############################################################################
		1900
		1901	=head2 EXTENSION DATABASE SUPPORT
		1902
		1903	Crossfire maintains a very simple database for extension use. It can
		1904	currently store anything that can be serialised using Storable, which
		1905	excludes objects.
		1906
		1907	The parameter C<$family> should best start with the name of the extension
		1908	using it, it should be unique.
		1909
		1910	=over 4
		1911
		1912	=item $hashref = cf::db_get $family
		1913
		1914	Return a hashref for use by the extension C<$family>, which can be
		1915	modified. After modifications, you have to call C<cf::db_dirty> or
		1916	C<cf::db_sync>.
		1917
		1918	=item $value = cf::db_get $family => $key
		1919
		1920	Returns a single value from the database
		1921
		1922	=item cf::db_put $family => $hashref
		1923
		1924	Stores the given family hashref into the database. Updates are delayed, if
		1925	you want the data to be synced to disk immediately, use C<cf::db_sync>.
		1926
		1927	=item cf::db_put $family => $key => $value
		1928
		1929	Stores the given C<$value> in the family hash. Updates are delayed, if you
		1930	want the data to be synced to disk immediately, use C<cf::db_sync>.
		1931
		1932	=item cf::db_dirty
		1933
		1934	Marks the database as dirty, to be updated at a later time.
		1935
		1936	=item cf::db_sync
		1937
		1938	Immediately write the database to disk I<if it is dirty>.
		1939
		1940	=cut
		1941
		1942	our $DB;
		1943
		1944	{
		1945	my $path = cf::localdir . "/database.pst";
		1946
		1947	sub db_load() {
		1948	$DB = stat $path ? Storable::retrieve $path : { };
		1949	}
		1950
		1951	my $pid;
		1952
		1953	sub db_save() {
		1954	waitpid $pid, 0 if $pid;
		1955	if (0 == ($pid = fork)) {
		1956	$DB->{_meta}{version} = 1;
		1957	Storable::nstore $DB, "$path~";
		1958	rename "$path~", $path;
		1959	cf::_exit 0 if defined $pid;
		1960	}
		1961	}
		1962
		1963	my $dirty;
		1964
		1965	sub db_sync() {
		1966	db_save if $dirty;
		1967	undef $dirty;
		1968	}
		1969
		1970	my $idle = Event->idle (min => $TICK * 2.8, max => 10, repeat => 0, data => WF_AUTOCANCEL, cb => sub {
		1971	db_sync;
		1972	});
		1973
		1974	sub db_dirty() {
		1975	$dirty = 1;
		1976	$idle->start;
		1977	}
		1978
		1979	sub db_get($;$) {
		1980	@_ >= 2
		1981	? $DB->{$_[0]}{$_[1]}
		1982	: ($DB->{$_[0]} ||= { })
		1983	}
		1984
		1985	sub db_put($$;$) {
		1986	if (@_ >= 3) {
		1987	$DB->{$_[0]}{$_[1]} = $_[2];
		1988	} else {
		1989	$DB->{$_[0]} = $_[1];
		1990	}
		1991	db_dirty;
		1992	}
		1993
		1994	cf::global->attach (
		1995	prio => 10000,
		1996	on_cleanup => sub {
		1997	db_sync;
		1998	},
		1999	);
		2000	}
		2001
925	#############################################################################	2002	#############################################################################
926	# the server's main()	2003	# the server's main()
927		2004
		2005	sub cfg_load {
		2006	open my $fh, "<:utf8", cf::confdir . "/config"
		2007	or return;
		2008
		2009	local $/;
		2010	*CFG = YAML::Syck::Load <$fh>;
		2011
		2012	$EMERGENCY_POSITION = $CFG{emergency_position} || ["/world/world_105_115", 5, 37];
		2013
		2014	if (exists $CFG{mlockall}) {
		2015	eval {
		2016	$CFG{mlockall} ? &mlockall : &munlockall
		2017	and die "WARNING: m(un)lockall failed: $!\n";
		2018	};
		2019	warn $@ if $@;
		2020	}
		2021	}
		2022
928	sub main {	2023	sub main {
		2024	# we must not ever block the main coroutine
		2025	local $Coro::idle = sub {
		2026	Carp::cluck "FATAL: Coro::idle was called, major BUG, use cf::sync_job!\n";#d#
		2027	(Coro::unblock_sub {
		2028	Event::one_event;
		2029	})->();
		2030	};
		2031
		2032	cfg_load;
		2033	db_load;
		2034	load_extensions;
929	Event::loop;	2035	Event::loop;
930	}	2036	}
931		2037
932	#############################################################################	2038	#############################################################################
933	# initialisation	2039	# initialisation
934		2040
		2041	sub reload() {
		2042	# can/must only be called in main
		2043	if ($Coro::current != $Coro::main) {
		2044	warn "can only reload from main coroutine\n";
		2045	return;
		2046	}
		2047
		2048	warn "reloading...";
		2049
		2050	my $guard = freeze_mainloop;
		2051	cf::emergency_save;
		2052
		2053	eval {
		2054	# if anything goes wrong in here, we should simply crash as we already saved
		2055
		2056	# cancel all watchers
		2057	for (Event::all_watchers) {
		2058	$_->cancel if $_->data & WF_AUTOCANCEL;
		2059	}
		2060
		2061	# cancel all extension coros
		2062	$_->cancel for values %EXT_CORO;
		2063	%EXT_CORO = ();
		2064
		2065	# unload all extensions
		2066	for (@exts) {
		2067	warn "unloading <$_>";
		2068	unload_extension $_;
		2069	}
		2070
		2071	# unload all modules loaded from $LIBDIR
		2072	while (my ($k, $v) = each %INC) {
		2073	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
		2074
		2075	warn "removing <$k>";
		2076	delete $INC{$k};
		2077
		2078	$k =~ s/\.pm$//;
		2079	$k =~ s/\//::/g;
		2080
		2081	if (my $cb = $k->can ("unload_module")) {
		2082	$cb->();
		2083	}
		2084
		2085	Symbol::delete_package $k;
		2086	}
		2087
		2088	# sync database to disk
		2089	cf::db_sync;
		2090	IO::AIO::flush;
		2091
		2092	# get rid of safe::, as good as possible
		2093	Symbol::delete_package "safe::$_"
		2094	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
		2095
		2096	# remove register_script_function callbacks
		2097	# TODO
		2098
		2099	# unload cf.pm "a bit"
		2100	delete $INC{"cf.pm"};
		2101
		2102	# don't, removes xs symbols, too,
		2103	# and global variables created in xs
		2104	#Symbol::delete_package __PACKAGE__;
		2105
		2106	# reload cf.pm
		2107	warn "reloading cf.pm";
		2108	require cf;
		2109	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
		2110
		2111	# load config and database again
		2112	cf::cfg_load;
		2113	cf::db_load;
		2114
		2115	# load extensions
		2116	warn "load extensions";
		2117	cf::load_extensions;
		2118
		2119	# reattach attachments to objects
		2120	warn "reattach";
		2121	_global_reattach;
		2122	};
		2123
		2124	if ($@) {
		2125	warn $@;
		2126	warn "error while reloading, exiting.";
		2127	exit 1;
		2128	}
		2129
		2130	warn "reloaded successfully";
		2131	};
		2132
		2133	#############################################################################
		2134
		2135	unless ($LINK_MAP) {
		2136	$LINK_MAP = cf::map::new;
		2137
		2138	$LINK_MAP->width (41);
		2139	$LINK_MAP->height (41);
		2140	$LINK_MAP->alloc;
		2141	$LINK_MAP->path ("{link}");
		2142	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		2143	$LINK_MAP->in_memory (MAP_IN_MEMORY);
		2144
		2145	# dirty hack because... archetypes are not yet loaded
		2146	Event->timer (
		2147	after => 2,
		2148	cb => sub {
		2149	$_[0]->w->cancel;
		2150
		2151	# provide some exits "home"
		2152	my $exit = cf::object::new "exit";
		2153
		2154	$exit->slaying ($EMERGENCY_POSITION->[0]);
		2155	$exit->stats->hp ($EMERGENCY_POSITION->[1]);
		2156	$exit->stats->sp ($EMERGENCY_POSITION->[2]);
		2157
		2158	$LINK_MAP->insert ($exit->clone, 19, 19);
		2159	$LINK_MAP->insert ($exit->clone, 19, 20);
		2160	$LINK_MAP->insert ($exit->clone, 19, 21);
		2161	$LINK_MAP->insert ($exit->clone, 20, 19);
		2162	$LINK_MAP->insert ($exit->clone, 20, 21);
		2163	$LINK_MAP->insert ($exit->clone, 21, 19);
		2164	$LINK_MAP->insert ($exit->clone, 21, 20);
		2165	$LINK_MAP->insert ($exit->clone, 21, 21);
		2166
		2167	$exit->destroy;
		2168	});
		2169
		2170	$LINK_MAP->{deny_save} = 1;
		2171	$LINK_MAP->{deny_reset} = 1;
		2172
		2173	$cf::MAP{$LINK_MAP->path} = $LINK_MAP;
		2174	}
		2175
935	register "<global>", __PACKAGE__;	2176	register "<global>", __PACKAGE__;
936		2177
		2178	register_command "reload" => sub {
		2179	my ($who, $arg) = @_;
		2180
		2181	if ($who->flag (FLAG_WIZ)) {
		2182	$who->message ("start of reload.");
		2183	reload;
		2184	$who->message ("end of reload.");
		2185	}
		2186	};
		2187
937	unshift @INC, $LIBDIR;	2188	unshift @INC, $LIBDIR;
938		2189
939	load_extensions;
940
941	$TICK_WATCHER = Event->timer (	2190	$TICK_WATCHER = Event->timer (
		2191	reentrant => 0,
942	prio => 1,	2192	prio => 0,
943	at => $NEXT_TICK || 1,	2193	at => $NEXT_TICK || $TICK,
		2194	data => WF_AUTOCANCEL,
944	cb => sub {	2195	cb => sub {
945	cf::server_tick; # one server iteration	2196	cf::server_tick; # one server iteration
946		2197	$RUNTIME += $TICK;
947	my $NOW = Event::time;
948	$NEXT_TICK += $TICK;	2198	$NEXT_TICK += $TICK;
949		2199
950	# if we are delayed by four ticks, skip them all	2200	# if we are delayed by four ticks or more, skip them all
951	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	2201	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
952		2202
953	$TICK_WATCHER->at ($NEXT_TICK);	2203	$TICK_WATCHER->at ($NEXT_TICK);
954	$TICK_WATCHER->start;	2204	$TICK_WATCHER->start;
955	},	2205	},
956	);	2206	);
957		2207
958	_reload_2;	2208	IO::AIO::max_poll_time $TICK * 0.2;
		2209
		2210	Event->io (
		2211	fd => IO::AIO::poll_fileno,
		2212	poll => 'r',
		2213	prio => 5,
		2214	data => WF_AUTOCANCEL,
		2215	cb => \&IO::AIO::poll_cb,
		2216	);
		2217
		2218	Event->timer (
		2219	data => WF_AUTOCANCEL,
		2220	after => 0,
		2221	interval => 10,
		2222	cb => sub {
		2223	(Coro::unblock_sub {
		2224	write_runtime
		2225	or warn "ERROR: unable to write runtime file: $!";
		2226	})->();
		2227	},
		2228	);
		2229
		2230	END { cf::emergency_save }
959		2231
960	1	2232	1
961		2233

Diff Legend

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