ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/cf.schmorp.de/server/lib/cf.pm

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

Diff Legend

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