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

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.93 by root, Thu Dec 21 22:41:35 2006 UTC vs.
Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC

…		…
1	package cf;	1	package cf;
		2
		3	use utf8;
		4	use strict;
2		5
3	use Symbol;	6	use Symbol;
4	use List::Util;	7	use List::Util;
5	use Storable;	8	use Storable;
6	use Opcode;	9	use Opcode;
7	use Safe;	10	use Safe;
8	use Safe::Hole;	11	use Safe::Hole;
9		12
		13	use Coro 3.3;
		14	use Coro::Event;
		15	use Coro::Timer;
		16	use Coro::Signal;
		17	use Coro::Semaphore;
		18	use Coro::AIO;
		19
		20	use Digest::MD5;
		21	use Fcntl;
10	use IO::AIO ();	22	use IO::AIO 2.31 ();
11	use YAML::Syck ();	23	use YAML::Syck ();
12	use Time::HiRes;	24	use Time::HiRes;
13	use Event;	25
14	$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
15		27
16	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?	28	# work around bug in YAML::Syck - bad news for perl6, will it be as broken wrt. unicode?
17	$YAML::Syck::ImplicitUnicode = 1;	29	$YAML::Syck::ImplicitUnicode = 1;
18		30
19	use strict;	31	$Coro::main->prio (2); # run main coroutine ("the server") with very high priority
20		32
21	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload	33	sub WF_AUTOCANCEL () { 1 } # automatically cancel this watcher on reload
22		34
23	our %COMMAND = ();	35	our %COMMAND = ();
24	our %COMMAND_TIME = ();	36	our %COMMAND_TIME = ();
25	our %EXTCMD = ();	37	our %EXTCMD = ();
26		38
27	_init_vars;
28
29	our @EVENT;	39	our @EVENT;
30	our $LIBDIR = datadir . "/ext";	40	our $LIBDIR = datadir . "/ext";
31		41
32	our $TICK = MAX_TIME * 1e-6;	42	our $TICK = MAX_TIME * 1e-6;
33	our $TICK_WATCHER;	43	our $TICK_WATCHER;
34	our $NEXT_TICK;	44	our $NEXT_TICK;
		45	our $NOW;
35		46
36	our %CFG;	47	our %CFG;
37		48
38	our $UPTIME; $UPTIME \|\|= time;	49	our $UPTIME; $UPTIME \|\|= time;
		50	our $RUNTIME;
		51
		52	our %MAP; # all maps
		53	our $LINK_MAP; # the special {link} map
		54	our $FREEZE;
		55	our $RANDOM_MAPS = cf::localdir . "/random";
		56	our %EXT_CORO;
		57
		58	binmode STDOUT;
		59	binmode STDERR;
		60
		61	# read virtual server time, if available
		62	unless ($RUNTIME \|\| !-e cf::localdir . "/runtime") {
		63	open my $fh, "<", cf::localdir . "/runtime"
		64	or die "unable to read runtime file: $!";
		65	$RUNTIME = <$fh> + 0.;
		66	}
		67
		68	mkdir cf::localdir;
		69	mkdir cf::localdir . "/" . cf::playerdir;
		70	mkdir cf::localdir . "/" . cf::tmpdir;
		71	mkdir cf::localdir . "/" . cf::uniquedir;
		72	mkdir $RANDOM_MAPS;
		73
		74	# a special map that is always available
		75	our $LINK_MAP;
39		76
40	#############################################################################	77	#############################################################################
41		78
42	=head2 GLOBAL VARIABLES	79	=head2 GLOBAL VARIABLES
43		80
44	=over 4	81	=over 4
45		82
46	=item $cf::UPTIME	83	=item $cf::UPTIME
47		84
48	The timestamp of the server start (so not actually an uptime).	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.
49		91
50	=item $cf::LIBDIR	92	=item $cf::LIBDIR
51		93
52	The perl library directory, where extensions and cf-specific modules can	94	The perl library directory, where extensions and cf-specific modules can
53	be found. It will be added to C<@INC> automatically.	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.
54		100
55	=item $cf::TICK	101	=item $cf::TICK
56		102
57	The interval between server ticks, in seconds.	103	The interval between server ticks, in seconds.
58		104
66	=cut	112	=cut
67		113
68	BEGIN {	114	BEGIN {
69	*CORE::GLOBAL::warn = sub {	115	*CORE::GLOBAL::warn = sub {
70	my $msg = join "", @_;	116	my $msg = join "", @_;
		117	utf8::encode $msg;
		118
71	$msg .= "\n"	119	$msg .= "\n"
72	unless $msg =~ /\n$/;	120	unless $msg =~ /\n$/;
73		121
74	print STDERR "cfperl: $msg";
75	LOG llevError, "cfperl: $msg";	122	LOG llevError, "cfperl: $msg";
76	};	123	};
77	}	124	}
78		125
79	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';	126	@safe::cf::global::ISA = @cf::global::ISA = 'cf::attachable';
…		…
84	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';	131	@safe::cf::object::player::ISA = @cf::object::player::ISA = 'cf::object';
85		132
86	# 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
87	# within the Safe compartment.	134	# within the Safe compartment.
88	for my $pkg (qw(	135	for my $pkg (qw(
89	cf::global	136	cf::global cf::attachable
90	cf::object cf::object::player	137	cf::object cf::object::player
91	cf::client cf::player	138	cf::client cf::player
92	cf::arch cf::living	139	cf::arch cf::living
93	cf::map cf::party cf::region	140	cf::map cf::party cf::region
94	)) {	141	)) {
…		…
132	sub to_json($) {	179	sub to_json($) {
133	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs	180	$JSON::Syck::ImplicitUnicode = 0; # work around JSON::Syck bugs
134	JSON::Syck::Dump $_[0]	181	JSON::Syck::Dump $_[0]
135	}	182	}
136		183
		184	=item cf::sync_job { BLOCK }
		185
		186	The design of crossfire+ requires that the main coro ($Coro::main) is
		187	always able to handle events or runnable, as crossfire+ is only partly
		188	reentrant. Thus "blocking" it by e.g. waiting for I/O is not acceptable.
		189
		190	If it must be done, put the blocking parts into C<sync_job>. This will run
		191	the given BLOCK in another coroutine while waiting for the result. The
		192	server will be frozen during this time, so the block should either finish
		193	fast or be very important.
		194
		195	=cut
		196
		197	sub sync_job(&) {
		198	my ($job) = @_;
		199
		200	my $busy = 1;
		201	my @res;
		202
		203	# TODO: use suspend/resume instead
		204	local $FREEZE = 1;
		205
		206	my $coro = Coro::async {
		207	@res = eval { $job->() };
		208	warn $@ if $@;
		209	undef $busy;
		210	};
		211
		212	if ($Coro::current == $Coro::main) {
		213	$coro->prio (Coro::PRIO_MAX);
		214	while ($busy) {
		215	Coro::cede_notself;
		216	Event::one_event unless Coro::nready;
		217	}
		218	} else {
		219	$coro->join;
		220	}
		221
		222	wantarray ? @res : $res[0]
		223	}
		224
		225	=item $coro = cf::coro { BLOCK }
		226
		227	Creates and returns a new coro. This coro is automcatially being canceled
		228	when the extension calling this is being unloaded.
		229
		230	=cut
		231
		232	sub coro(&) {
		233	my $cb = shift;
		234
		235	my $coro; $coro = async {
		236	eval {
		237	$cb->();
		238	};
		239	warn $@ if $@;
		240	};
		241
		242	$coro->on_destroy (sub {
		243	delete $EXT_CORO{$coro+0};
		244	});
		245	$EXT_CORO{$coro+0} = $coro;
		246
		247	$coro
		248	}
		249
		250	sub write_runtime {
		251	my $runtime = cf::localdir . "/runtime";
		252
		253	my $fh = aio_open "$runtime~", O_WRONLY \| O_CREAT, 0644
		254	or return;
		255
		256	my $value = $cf::RUNTIME;
		257	(aio_write $fh, 0, (length $value), $value, 0) <= 0
		258	and return;
		259
		260	aio_fsync $fh
		261	and return;
		262
		263	close $fh
		264	or return;
		265
		266	aio_rename "$runtime~", $runtime
		267	and return;
		268
		269	1
		270	}
		271
137	=back	272	=back
138		273
139	=cut	274	=cut
140		275
141	#############################################################################	276	#############################################################################
142		277
		278	package cf::path;
		279
		280	sub new {
		281	my ($class, $path, $base) = @_;
		282
		283	my $self = bless { }, $class;
		284
		285	if ($path =~ s{^\?random/}{}) {
		286	$self->{random} = cf::from_json $path;
		287	} else {
		288	if ($path =~ s{^~([^/]+)?}{}) {
		289	$self->{user_rel} = 1;
		290
		291	if (defined $1) {
		292	$self->{user} = $1;
		293	} elsif ($base =~ m{^~([^/]+)/}) {
		294	$self->{user} = $1;
		295	} else {
		296	warn "cannot resolve user-relative path without user <$path,$base>\n";
		297	}
		298	} elsif ($path =~ /^\//) {
		299	# already absolute
		300	} else {
		301	$base =~ s{[^/]+/?$}{};
		302	return $class->new ("$base/$path");
		303	}
		304
		305	for ($path) {
		306	redo if s{/\.?/}{/};
		307	redo if s{/[^/]+/\.\./}{/};
		308	}
		309	}
		310
		311	$self->{path} = $path;
		312
		313	$self
		314	}
		315
		316	# the name / primary key / in-game path
		317	sub as_string {
		318	my ($self) = @_;
		319
		320	$self->{user_rel} ? "~$self->{user}$self->{path}"
		321	: $self->{random} ? "?random/$self->{path}"
		322	: $self->{path}
		323	}
		324
		325	# the displayed name, this is a one way mapping
		326	sub visible_name {
		327	my ($self) = @_;
		328
		329	$self->{random} ? "?random/$self->{random}{origin_map}+$self->{random}{origin_x}+$self->{random}{origin_y}/$self->{random}{dungeon_level}"
		330	: $self->as_string
		331	}
		332
		333	# escape the /'s in the path
		334	sub _escaped_path {
		335	# ∕ is U+2215
		336	(my $path = $_[0]{path}) =~ s/\//∕/g;
		337	$path
		338	}
		339
		340	# the original (read-only) location
		341	sub load_path {
		342	my ($self) = @_;
		343
		344	sprintf "%s/%s/%s", cf::datadir, cf::mapdir, $self->{path}
		345	}
		346
		347	# the temporary/swap location
		348	sub save_path {
		349	my ($self) = @_;
		350
		351	$self->{user_rel} ? sprintf "%s/%s/%s/%s", cf::localdir, cf::playerdir, $self->{user}, $self->_escaped_path
		352	: $self->{random} ? sprintf "%s/%s", $RANDOM_MAPS, Digest::MD5::md5_hex $self->{path}
		353	: sprintf "%s/%s/%s", cf::localdir, cf::tmpdir, $self->_escaped_path
		354	}
		355
		356	# the unique path, might be eq to save_path
		357	sub uniq_path {
		358	my ($self) = @_;
		359
		360	$self->{user_rel} \|\| $self->{random}
		361	? undef
		362	: sprintf "%s/%s/%s", cf::localdir, cf::uniquedir, $self->_escaped_path
		363	}
		364
		365	# return random map parameters, or undef
		366	sub random_map_params {
		367	my ($self) = @_;
		368
		369	$self->{random}
		370	}
		371
		372	# this is somewhat ugly, but style maps do need special treatment
		373	sub is_style_map {
		374	$_[0]{path} =~ m{^/styles/}
		375	}
		376
		377	package cf;
		378
		379	#############################################################################
		380
143	=head2 ATTACHABLE OBJECTS	381	=head2 ATTACHABLE OBJECTS
144		382
145	You can define and attach attachments to each "attachable" object in	383	Many objects in crossfire are so-called attachable objects. That means you can
146	crossfire+ (objects, players, clients, maps and the special "global"	384	attach callbacks/event handlers (a collection of which is called an "attachment")
		385	to it. All such attachable objects support the following methods.
		386
147	class). In the following description, CLASS can be any of C<global>,	387	In the following description, CLASS can be any of C<global>, C<object>
148	C<object> C<player>, C<client> or C<map>.	388	C<player>, C<client> or C<map> (i.e. the attachable objects in
		389	crossfire+).
149		390
150	=over 4	391	=over 4
151		392
		393	=item $attachable->attach ($attachment, key => $value...)
		394
		395	=item $attachable->detach ($attachment)
		396
		397	Attach/detach a pre-registered attachment to a specific object and give it
		398	the specified key/value pairs as arguments.
		399
		400	Example, attach a minesweeper attachment to the given object, making it a
		401	10x10 minesweeper game:
		402
		403	$obj->attach (minesweeper => width => 10, height => 10);
		404
		405	=item $bool = $attachable->attached ($name)
		406
		407	Checks wether the named attachment is currently attached to the object.
		408
		409	=item cf::CLASS->attach ...
		410
		411	=item cf::CLASS->detach ...
		412
		413	Define an anonymous attachment and attach it to all objects of the given
		414	CLASS. See the next function for an explanation of its arguments.
		415
		416	You can attach to global events by using the C<cf::global> class.
		417
		418	Example, log all player logins:
		419
		420	cf::player->attach (
		421	on_login => sub {
		422	my ($pl) = @_;
		423	...
		424	},
		425	);
		426
		427	Example, attach to the jeweler skill:
		428
		429	cf::object->attach (
		430	type => cf::SKILL,
		431	subtype => cf::SK_JEWELER,
		432	on_use_skill => sub {
		433	my ($sk, $ob, $part, $dir, $msg) = @_;
		434	...
		435	},
		436	);
		437
152	=item cf::CLASS::attachment $name, ...	438	=item cf::CLASS::attachment $name, ...
153		439
154	Register an attachment by name through which attachable objects can refer	440	Register an attachment by C<$name> through which attachable objects of the
155	to this attachment.	441	given CLASS can refer to this attachment.
156		442
157	=item $bool = $attachable->attached ($name)	443	Some classes such as crossfire maps and objects can specify attachments
		444	that are attached at load/instantiate time, thus the need for a name.
158		445
159	Checks wether the named attachment is currently attached to the object.
160
161	=item $attachable->attach ($attachment, key => $value...)
162
163	=item $attachable->detach ($attachment)
164
165	Attach/detach a pre-registered attachment either to a specific object
166	(C<$attachable>) or all objects of the given class (if C<$attachable> is a
167	class in a static method call).
168
169	You can attach to global events by using the C<cf::global> class.
170
171	These method calls expect any number of the following handler/hook	446	These calls expect any number of the following handler/hook descriptions:
172	descriptions:
173		447
174	=over 4	448	=over 4
175		449
176	=item prio => $number	450	=item prio => $number
177		451
…		…
203	package and register them. Only handlers for eevents supported by the	477	package and register them. Only handlers for eevents supported by the
204	object/class are recognised.	478	object/class are recognised.
205		479
206	=back	480	=back
207		481
		482	Example, define an attachment called "sockpuppet" that calls the given
		483	event handler when a monster attacks:
		484
		485	cf::object::attachment sockpuppet =>
		486	on_skill_attack => sub {
		487	my ($self, $victim) = @_;
		488	...
		489	}
		490	}
		491
		492	=item $attachable->valid
		493
		494	Just because you have a perl object does not mean that the corresponding
		495	C-level object still exists. If you try to access an object that has no
		496	valid C counterpart anymore you get an exception at runtime. This method
		497	can be used to test for existence of the C object part without causing an
		498	exception.
		499
208	=cut	500	=cut
209		501
210	# the following variables are defined in .xs and must not be re-created	502	# the following variables are defined in .xs and must not be re-created
211	our @CB_GLOBAL = (); # registry for all global events	503	our @CB_GLOBAL = (); # registry for all global events
		504	our @CB_ATTACHABLE = (); # registry for all attachables
212	our @CB_OBJECT = (); # all objects (should not be used except in emergency)	505	our @CB_OBJECT = (); # all objects (should not be used except in emergency)
213	our @CB_PLAYER = ();	506	our @CB_PLAYER = ();
214	our @CB_CLIENT = ();	507	our @CB_CLIENT = ();
215	our @CB_TYPE = (); # registry for type (cf-object class) based events	508	our @CB_TYPE = (); # registry for type (cf-object class) based events
216	our @CB_MAP = ();	509	our @CB_MAP = ();
217		510
218	my %attachment;	511	my %attachment;
219		512
220	sub _attach_cb($$$$) {	513	sub _attach_cb($$$$) {
221	my ($registry, $event, $prio, $cb) = @_;	514	my ($registry, $event, $prio, $cb) = @_;
…		…
226		519
227	@{$registry->[$event]} = sort	520	@{$registry->[$event]} = sort
228	{ $a->[0] cmp $b->[0] }	521	{ $a->[0] cmp $b->[0] }
229	@{$registry->[$event] \|\| []}, $cb;	522	@{$registry->[$event] \|\| []}, $cb;
230	}	523	}
		524
		525	# hack
		526	my %attachable_klass = map +($_ => 1), KLASS_OBJECT, KLASS_CLIENT, KLASS_PLAYER, KLASS_MAP;
231		527
232	# attach handles attaching event callbacks	528	# attach handles attaching event callbacks
233	# the only thing the caller has to do is pass the correct	529	# the only thing the caller has to do is pass the correct
234	# registry (== where the callback attaches to).	530	# registry (== where the callback attaches to).
235	sub _attach {	531	sub _attach {
…		…
237		533
238	my $object_type;	534	my $object_type;
239	my $prio = 0;	535	my $prio = 0;
240	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;	536	my %cb_id = map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == $klass, 0 .. $#EVENT;
241		537
		538	#TODO: get rid of this hack
		539	if ($attachable_klass{$klass}) {
		540	%cb_id = (%cb_id, map +("on_" . lc $EVENT[$_][0], $_) , grep $EVENT[$_][1] == KLASS_ATTACHABLE, 0 .. $#EVENT);
		541	}
		542
242	while (@arg) {	543	while (@arg) {
243	my $type = shift @arg;	544	my $type = shift @arg;
244		545
245	if ($type eq "prio") {	546	if ($type eq "prio") {
246	$prio = shift @arg;	547	$prio = shift @arg;
…		…
321	my ($obj, $name) = @_;	622	my ($obj, $name) = @_;
322		623
323	exists $obj->{_attachment}{$name}	624	exists $obj->{_attachment}{$name}
324	}	625	}
325		626
326	for my $klass (qw(GLOBAL OBJECT PLAYER CLIENT MAP)) {	627	for my $klass (qw(ATTACHABLE GLOBAL OBJECT PLAYER CLIENT MAP)) {
327	eval "#line " . __LINE__ . " 'cf.pm'	628	eval "#line " . __LINE__ . " 'cf.pm'
328	sub cf::\L$klass\E::_attach_registry {	629	sub cf::\L$klass\E::_attach_registry {
329	(\\\@CB_$klass, KLASS_$klass)	630	(\\\@CB_$klass, KLASS_$klass)
330	}	631	}
331		632
…		…
367	}	668	}
368		669
369	0	670	0
370	}	671	}
371		672
372	=item $bool = cf::invoke EVENT_GLOBAL_XXX, ...	673	=item $bool = cf::global::invoke (EVENT_CLASS_XXX, ...)
373		674
374	=item $bool = $object->invoke (EVENT_OBJECT_XXX, ...)
375
376	=item $bool = $player->invoke (EVENT_PLAYER_XXX, ...)
377
378	=item $bool = $client->invoke (EVENT_CLIENT_XXX, ...)	675	=item $bool = $attachable->invoke (EVENT_CLASS_XXX, ...)
379		676
380	=item $bool = $map->invoke (EVENT_MAP_XXX, ...)
381
382	Generate a global/object/player/map-specific event with the given arguments.	677	Generate an object-specific event with the given arguments.
383		678
384	This API is preliminary (most likely, the EVENT_KLASS_xxx prefix will be	679	This API is preliminary (most likely, the EVENT_CLASS_xxx prefix will be
385	removed in future versions), and there is no public API to access override	680	removed in future versions), and there is no public API to access override
386	results (if you must, access C<@cf::invoke_results> directly).	681	results (if you must, access C<@cf::invoke_results> directly).
387		682
388	=back	683	=back
389		684
390	=cut	685	=cut
391		686
392	#############################################################################	687	#############################################################################
393
394	=head2 METHODS VALID FOR ALL ATTACHABLE OBJECTS
395
396	Attachable objects includes objects, players, clients and maps.
397
398	=over 4
399
400	=item $object->valid
401
402	Just because you have a perl object does not mean that the corresponding
403	C-level object still exists. If you try to access an object that has no
404	valid C counterpart anymore you get an exception at runtime. This method
405	can be used to test for existence of the C object part without causing an
406	exception.
407
408	=back
409
410	=cut
411
412	#############################################################################
413	# object support	688	# object support
414		689
415	sub instantiate {
416	my ($obj, $data) = @_;
417
418	$data = from_json $data;
419
420	for (@$data) {
421	my ($name, $args) = @$_;
422
423	$obj->attach ($name, %{$args \|\| {} });
424	}
425	}
426
427	# basically do the same as instantiate, without calling instantiate
428	sub reattach {	690	sub reattach {
		691	# basically do the same as instantiate, without calling instantiate
429	my ($obj) = @_;	692	my ($obj) = @_;
		693
430	my $registry = $obj->registry;	694	my $registry = $obj->registry;
431		695
432	@$registry = ();	696	@$registry = ();
433		697
434	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };	698	delete $obj->{_attachment} unless scalar keys %{ $obj->{_attachment} \|\| {} };
…		…
443	warn "object uses attachment '$name' that is not available, postponing.\n";	707	warn "object uses attachment '$name' that is not available, postponing.\n";
444	}	708	}
445	}	709	}
446	}	710	}
447		711
448	sub object_freezer_save {	712	cf::attachable->attach (
449	my ($filename, $rdata, $objs) = @_;
450
451	if (length $$rdata) {
452	warn sprintf "saving %s (%d,%d)\n",
453	$filename, length $$rdata, scalar @$objs;
454
455	if (open my $fh, ">:raw", "$filename~") {
456	chmod SAVE_MODE, $fh;
457	syswrite $fh, $$rdata;
458	close $fh;
459
460	if (@$objs && open my $fh, ">:raw", "$filename.pst~") {
461	chmod SAVE_MODE, $fh;
462	syswrite $fh, Storable::nfreeze { version => 1, objs => $objs };
463	close $fh;
464	rename "$filename.pst~", "$filename.pst";
465	} else {
466	unlink "$filename.pst";
467	}
468
469	rename "$filename~", $filename;
470	} else {
471	warn "FATAL: $filename~: $!\n";
472	}
473	} else {
474	unlink $filename;
475	unlink "$filename.pst";
476	}
477	}
478
479	sub object_freezer_as_string {
480	my ($rdata, $objs) = @_;
481
482	use Data::Dumper;
483
484	$$rdata . Dumper $objs
485	}
486
487	sub object_thawer_load {
488	my ($filename) = @_;
489
490	local $/;
491
492	my $av;
493
494	#TODO: use sysread etc.
495	if (open my $data, "<:raw:perlio", $filename) {
496	$data = <$data>;
497	if (open my $pst, "<:raw:perlio", "$filename.pst") {
498	$av = eval { (Storable::thaw <$pst>)->{objs} };
499	}
500	return ($data, $av);
501	}
502
503	()
504	}
505
506	cf::object->attach (
507	prio => -1000000,	713	prio => -1000000,
		714	on_instantiate => sub {
		715	my ($obj, $data) = @_;
		716
		717	$data = from_json $data;
		718
		719	for (@$data) {
		720	my ($name, $args) = @$_;
		721
		722	$obj->attach ($name, %{$args \|\| {} });
		723	}
		724	},
		725	on_reattach => \&reattach,
508	on_clone => sub {	726	on_clone => sub {
509	my ($src, $dst) = @_;	727	my ($src, $dst) = @_;
510		728
511	@{$dst->registry} = @{$src->registry};	729	@{$dst->registry} = @{$src->registry};
512		730
…		…
514		732
515	%{$dst->{_attachment}} = %{$src->{_attachment}}	733	%{$dst->{_attachment}} = %{$src->{_attachment}}
516	if exists $src->{_attachment};	734	if exists $src->{_attachment};
517	},	735	},
518	);	736	);
		737
		738	sub object_freezer_save {
		739	my ($filename, $rdata, $objs) = @_;
		740
		741	sync_job {
		742	if (length $$rdata) {
		743	warn sprintf "saving %s (%d,%d)\n",
		744	$filename, length $$rdata, scalar @$objs;
		745
		746	if (my $fh = aio_open "$filename~", O_WRONLY \| O_CREAT, 0600) {
		747	chmod SAVE_MODE, $fh;
		748	aio_write $fh, 0, (length $$rdata), $$rdata, 0;
		749	aio_fsync $fh;
		750	close $fh;
		751
		752	if (@$objs) {
		753	if (my $fh = aio_open "$filename.pst~", O_WRONLY \| O_CREAT, 0600) {
		754	chmod SAVE_MODE, $fh;
		755	my $data = Storable::nfreeze { version => 1, objs => $objs };
		756	aio_write $fh, 0, (length $data), $data, 0;
		757	aio_fsync $fh;
		758	close $fh;
		759	aio_rename "$filename.pst~", "$filename.pst";
		760	}
		761	} else {
		762	aio_unlink "$filename.pst";
		763	}
		764
		765	aio_rename "$filename~", $filename;
		766	} else {
		767	warn "FATAL: $filename~: $!\n";
		768	}
		769	} else {
		770	aio_unlink $filename;
		771	aio_unlink "$filename.pst";
		772	}
		773	}
		774	}
		775
		776	sub object_freezer_as_string {
		777	my ($rdata, $objs) = @_;
		778
		779	use Data::Dumper;
		780
		781	$$rdata . Dumper $objs
		782	}
		783
		784	sub object_thawer_load {
		785	my ($filename) = @_;
		786
		787	my ($data, $av);
		788
		789	(aio_load $filename, $data) >= 0
		790	or return;
		791
		792	unless (aio_stat "$filename.pst") {
		793	(aio_load "$filename.pst", $av) >= 0
		794	or return;
		795	$av = eval { (Storable::thaw <$av>)->{objs} };
		796	}
		797
		798	return ($data, $av);
		799	}
519		800
520	#############################################################################	801	#############################################################################
521	# command handling &c	802	# command handling &c
522		803
523	=item cf::register_command $name => \&callback($ob,$args);	804	=item cf::register_command $name => \&callback($ob,$args);
…		…
712		993
713	=head2 CORE EXTENSIONS	994	=head2 CORE EXTENSIONS
714		995
715	Functions and methods that extend core crossfire objects.	996	Functions and methods that extend core crossfire objects.
716		997
		998	=head3 cf::player
		999
717	=over 4	1000	=over 4
718		1001
719	=item cf::player::exists $login	1002	=item cf::player::exists $login
720		1003
721	Returns true when the given account exists.	1004	Returns true when the given account exists.
…		…
725	sub cf::player::exists($) {	1008	sub cf::player::exists($) {
726	cf::player::find $_[0]	1009	cf::player::find $_[0]
727	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;	1010	or -f sprintf "%s/%s/%s/%s.pl", cf::localdir, cf::playerdir, ($_[0]) x 2;
728	}	1011	}
729		1012
		1013	=item $player->ext_reply ($msgid, $msgtype, %msg)
		1014
		1015	Sends an ext reply to the player.
		1016
		1017	=cut
		1018
		1019	sub cf::player::ext_reply($$$%) {
		1020	my ($self, $id, %msg) = @_;
		1021
		1022	$msg{msgid} = $id;
		1023
		1024	$self->send ("ext " . to_json \%msg);
		1025	}
		1026
		1027	=back
		1028
		1029	=head3 cf::object::player
		1030
		1031	=over 4
		1032
730	=item $player_object->reply ($npc, $msg[, $flags])	1033	=item $player_object->reply ($npc, $msg[, $flags])
731		1034
732	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>	1035	Sends a message to the player, as if the npc C<$npc> replied. C<$npc>
733	can be C<undef>. Does the right thing when the player is currently in a	1036	can be C<undef>. Does the right thing when the player is currently in a
734	dialogue with the given NPC character.	1037	dialogue with the given NPC character.
735		1038
736	=cut	1039	=cut
737		1040
738	# rough implementation of a future "reply" method that works	1041	# rough implementation of a future "reply" method that works
739	# with dialog boxes.	1042	# with dialog boxes.
		1043	#TODO: the first argument must go, split into a $npc->reply_to ( method
740	sub cf::object::player::reply($$$;$) {	1044	sub cf::object::player::reply($$$;$) {
741	my ($self, $npc, $msg, $flags) = @_;	1045	my ($self, $npc, $msg, $flags) = @_;
742		1046
743	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;	1047	$flags = cf::NDI_BROWN \| cf::NDI_UNIQUE unless @_ >= 4;
744		1048
…		…
748	$msg = $npc->name . " says: $msg" if $npc;	1052	$msg = $npc->name . " says: $msg" if $npc;
749	$self->message ($msg, $flags);	1053	$self->message ($msg, $flags);
750	}	1054	}
751	}	1055	}
752		1056
753	=item $player->ext_reply ($msgid, $msgtype, %msg)
754
755	Sends an ext reply to the player.
756
757	=cut
758
759	sub cf::player::ext_reply($$$%) {
760	my ($self, $id, %msg) = @_;
761
762	$msg{msgid} = $id;
763
764	$self->send ("ext " . to_json \%msg);
765	}
766
767	=item $player_object->may ("access")	1057	=item $player_object->may ("access")
768		1058
769	Returns wether the given player is authorized to access resource "access"	1059	Returns wether the given player is authorized to access resource "access"
770	(e.g. "command_wizcast").	1060	(e.g. "command_wizcast").
771		1061
…		…
778	(ref $cf::CFG{"may_$access"}	1068	(ref $cf::CFG{"may_$access"}
779	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}	1069	? scalar grep $self->name eq $_, @{$cf::CFG{"may_$access"}}
780	: $cf::CFG{"may_$access"})	1070	: $cf::CFG{"may_$access"})
781	}	1071	}
782		1072
783	=cut	1073	=head3 cf::client
784		1074
785	#############################################################################	1075	=over 4
		1076
		1077	=item $client->send_drawinfo ($text, $flags)
		1078
		1079	Sends a drawinfo packet to the client. Circumvents output buffering so
		1080	should not be used under normal circumstances.
		1081
		1082	=cut
		1083
		1084	sub cf::client::send_drawinfo {
		1085	my ($self, $text, $flags) = @_;
		1086
		1087	utf8::encode $text;
		1088	$self->send_packet (sprintf "drawinfo %d %s", $flags, $text);
		1089	}
		1090
		1091
		1092	=item $success = $client->query ($flags, "text", \&cb)
		1093
		1094	Queues a query to the client, calling the given callback with
		1095	the reply text on a reply. flags can be C<cf::CS_QUERY_YESNO>,
		1096	C<cf::CS_QUERY_SINGLECHAR> or C<cf::CS_QUERY_HIDEINPUT> or C<0>.
		1097
		1098	Queries can fail, so check the return code. Or don't, as queries will become
		1099	reliable at some point in the future.
		1100
		1101	=cut
		1102
		1103	sub cf::client::query {
		1104	my ($self, $flags, $text, $cb) = @_;
		1105
		1106	return unless $self->state == ST_PLAYING
		1107	\|\| $self->state == ST_SETUP
		1108	\|\| $self->state == ST_CUSTOM;
		1109
		1110	$self->state (ST_CUSTOM);
		1111
		1112	utf8::encode $text;
		1113	push @{ $self->{query_queue} }, [(sprintf "query %d %s", $flags, $text), $cb];
		1114
		1115	$self->send_packet ($self->{query_queue}[0][0])
		1116	if @{ $self->{query_queue} } == 1;
		1117	}
		1118
		1119	cf::client->attach (
		1120	on_reply => sub {
		1121	my ($ns, $msg) = @_;
		1122
		1123	# this weird shuffling is so that direct followup queries
		1124	# get handled first
		1125	my $queue = delete $ns->{query_queue};
		1126
		1127	(shift @$queue)->[1]->($msg);
		1128
		1129	push @{ $ns->{query_queue} }, @$queue;
		1130
		1131	if (@{ $ns->{query_queue} } == @$queue) {
		1132	if (@$queue) {
		1133	$ns->send_packet ($ns->{query_queue}[0][0]);
		1134	} else {
		1135	$ns->state (ST_PLAYING) if $ns->state == ST_CUSTOM;
		1136	}
		1137	}
		1138	},
		1139	);
		1140
		1141	=item $client->coro (\&cb)
		1142
		1143	Create a new coroutine, running the specified callback. The coroutine will
		1144	be automatically cancelled when the client gets destroyed (e.g. on logout,
		1145	or loss of connection).
		1146
		1147	=cut
		1148
		1149	sub cf::client::coro {
		1150	my ($self, $cb) = @_;
		1151
		1152	my $coro; $coro = async {
		1153	eval {
		1154	$cb->();
		1155	};
		1156	warn $@ if $@;
		1157	};
		1158
		1159	$coro->on_destroy (sub {
		1160	delete $self->{_coro}{$coro+0};
		1161	});
		1162
		1163	$self->{_coro}{$coro+0} = $coro;
		1164
		1165	$coro
		1166	}
		1167
		1168	cf::client->attach (
		1169	on_destroy => sub {
		1170	my ($ns) = @_;
		1171
		1172	$_->cancel for values %{ (delete $ns->{_coro}) \|\| {} };
		1173	},
		1174	);
		1175
		1176	=back
		1177
786		1178
787	=head2 SAFE SCRIPTING	1179	=head2 SAFE SCRIPTING
788		1180
789	Functions that provide a safe environment to compile and execute	1181	Functions that provide a safe environment to compile and execute
790	snippets of perl code without them endangering the safety of the server	1182	snippets of perl code without them endangering the safety of the server
…		…
1010	local $/;	1402	local $/;
1011	*CFG = YAML::Syck::Load <$fh>;	1403	*CFG = YAML::Syck::Load <$fh>;
1012	}	1404	}
1013		1405
1014	sub main {	1406	sub main {
		1407	# we must not ever block the main coroutine
		1408	local $Coro::idle = sub {
		1409	Carp::cluck "FATAL: Coro::idle was called, major BUG\n";#d#
		1410	(Coro::unblock_sub {
		1411	Event::one_event;
		1412	})->();
		1413	};
		1414
1015	cfg_load;	1415	cfg_load;
1016	db_load;	1416	db_load;
1017	load_extensions;	1417	load_extensions;
1018	Event::loop;	1418	Event::loop;
1019	}	1419	}
1020		1420
1021	#############################################################################	1421	#############################################################################
1022	# initialisation	1422	# initialisation
1023		1423
1024	sub _perl_reload(&) {	1424	sub perl_reload() {
1025	my ($msg) = @_;	1425	# can/must only be called in main
		1426	if ($Coro::current != $Coro::main) {
		1427	warn "can only reload from main coroutine\n";
		1428	return;
		1429	}
1026		1430
1027	$msg->("reloading...");	1431	warn "reloading...";
		1432
		1433	local $FREEZE = 1;
		1434	cf::emergency_save;
1028		1435
1029	eval {	1436	eval {
		1437	# if anything goes wrong in here, we should simply crash as we already saved
		1438
1030	# cancel all watchers	1439	# cancel all watchers
1031	for (Event::all_watchers) {	1440	for (Event::all_watchers) {
1032	$_->cancel if $_->data & WF_AUTOCANCEL;	1441	$_->cancel if $_->data & WF_AUTOCANCEL;
1033	}	1442	}
1034		1443
		1444	# cancel all extension coros
		1445	$_->cancel for values %EXT_CORO;
		1446	%EXT_CORO = ();
		1447
1035	# unload all extensions	1448	# unload all extensions
1036	for (@exts) {	1449	for (@exts) {
1037	$msg->("unloading <$_>");	1450	warn "unloading <$_>";
1038	unload_extension $_;	1451	unload_extension $_;
1039	}	1452	}
1040		1453
1041	# unload all modules loaded from $LIBDIR	1454	# unload all modules loaded from $LIBDIR
1042	while (my ($k, $v) = each %INC) {	1455	while (my ($k, $v) = each %INC) {
1043	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;	1456	next unless $v =~ /^\Q$LIBDIR\E\/.*\.pm$/;
1044		1457
1045	$msg->("removing <$k>");	1458	warn "removing <$k>";
1046	delete $INC{$k};	1459	delete $INC{$k};
1047		1460
1048	$k =~ s/\.pm$//;	1461	$k =~ s/\.pm$//;
1049	$k =~ s/\//::/g;	1462	$k =~ s/\//::/g;
1050		1463
…		…
1055	Symbol::delete_package $k;	1468	Symbol::delete_package $k;
1056	}	1469	}
1057		1470
1058	# sync database to disk	1471	# sync database to disk
1059	cf::db_sync;	1472	cf::db_sync;
		1473	IO::AIO::flush;
1060		1474
1061	# get rid of safe::, as good as possible	1475	# get rid of safe::, as good as possible
1062	Symbol::delete_package "safe::$_"	1476	Symbol::delete_package "safe::$_"
1063	for qw(cf::object cf::object::player cf::player cf::map cf::party cf::region);	1477	for qw(cf::attachable cf::object cf::object::player cf::client cf::player cf::map cf::party cf::region);
1064		1478
1065	# remove register_script_function callbacks	1479	# remove register_script_function callbacks
1066	# TODO	1480	# TODO
1067		1481
1068	# unload cf.pm "a bit"	1482	# unload cf.pm "a bit"
…		…
1071	# don't, removes xs symbols, too,	1485	# don't, removes xs symbols, too,
1072	# and global variables created in xs	1486	# and global variables created in xs
1073	#Symbol::delete_package __PACKAGE__;	1487	#Symbol::delete_package __PACKAGE__;
1074		1488
1075	# reload cf.pm	1489	# reload cf.pm
1076	$msg->("reloading cf.pm");	1490	warn "reloading cf.pm";
1077	require cf;	1491	require cf;
		1492	cf::_connect_to_perl; # nominally unnecessary, but cannot hurt
1078		1493
1079	# load config and database again	1494	# load config and database again
1080	cf::cfg_load;	1495	cf::cfg_load;
1081	cf::db_load;	1496	cf::db_load;
1082		1497
1083	# load extensions	1498	# load extensions
1084	$msg->("load extensions");	1499	warn "load extensions";
1085	cf::load_extensions;	1500	cf::load_extensions;
1086		1501
1087	# reattach attachments to objects	1502	# reattach attachments to objects
1088	$msg->("reattach");	1503	warn "reattach";
1089	_global_reattach;	1504	_global_reattach;
1090	};	1505	};
1091	$msg->($@) if $@;
1092		1506
1093	$msg->("reloaded");	1507	if ($@) {
		1508	warn $@;
		1509	warn "error while reloading, exiting.";
		1510	exit 1;
		1511	}
		1512
		1513	warn "reloaded successfully";
1094	};	1514	};
1095		1515
1096	sub perl_reload() {	1516	#############################################################################
1097	_perl_reload {	1517
1098	warn $_[0];	1518	unless ($LINK_MAP) {
1099	print "$_[0]\n";	1519	$LINK_MAP = cf::map::new;
1100	};	1520
		1521	$LINK_MAP->width (41);
		1522	$LINK_MAP->height (41);
		1523	$LINK_MAP->alloc;
		1524	$LINK_MAP->path ("{link}");
		1525	$LINK_MAP->{path} = bless { path => "{link}" }, "cf::path";
		1526	$LINK_MAP->in_memory (MAP_IN_MEMORY);
1101	}	1527	}
1102		1528
1103	register "<global>", __PACKAGE__;	1529	register "<global>", __PACKAGE__;
1104		1530
1105	register_command "perl-reload" => sub {	1531	register_command "perl-reload" => sub {
1106	my ($who, $arg) = @_;	1532	my ($who, $arg) = @_;
1107		1533
1108	if ($who->flag (FLAG_WIZ)) {	1534	if ($who->flag (FLAG_WIZ)) {
		1535	$who->message ("start of reload.");
1109	_perl_reload {	1536	perl_reload;
1110	warn $_[0];	1537	$who->message ("end of reload.");
1111	$who->message ($_[0]);
1112	};
1113	}	1538	}
1114	};	1539	};
1115		1540
1116	unshift @INC, $LIBDIR;	1541	unshift @INC, $LIBDIR;
1117		1542
1118	$TICK_WATCHER = Event->timer (	1543	$TICK_WATCHER = Event->timer (
		1544	reentrant => 0,
1119	prio => 0,	1545	prio => 0,
1120	at => $NEXT_TICK \|\| 1,	1546	at => $NEXT_TICK \|\| $TICK,
1121	data => WF_AUTOCANCEL,	1547	data => WF_AUTOCANCEL,
1122	cb => sub {	1548	cb => sub {
		1549	unless ($FREEZE) {
1123	cf::server_tick; # one server iteration	1550	cf::server_tick; # one server iteration
		1551	$RUNTIME += $TICK;
		1552	}
1124		1553
1125	my $NOW = Event::time;
1126	$NEXT_TICK += $TICK;	1554	$NEXT_TICK += $TICK;
1127		1555
1128	# if we are delayed by four ticks or more, skip them all	1556	# if we are delayed by four ticks or more, skip them all
1129	$NEXT_TICK = $NOW if $NOW >= $NEXT_TICK + $TICK * 4;	1557	$NEXT_TICK = Event::time if Event::time >= $NEXT_TICK + $TICK * 4;
1130		1558
1131	$TICK_WATCHER->at ($NEXT_TICK);	1559	$TICK_WATCHER->at ($NEXT_TICK);
1132	$TICK_WATCHER->start;	1560	$TICK_WATCHER->start;
1133	},	1561	},
1134	);	1562	);
1135		1563
1136	IO::AIO::max_poll_time $TICK * 0.2;	1564	IO::AIO::max_poll_time $TICK * 0.2;
1137		1565
		1566	Event->io (
1138	Event->io (fd => IO::AIO::poll_fileno,	1567	fd => IO::AIO::poll_fileno,
1139	poll => 'r',	1568	poll => 'r',
1140	prio => 5,	1569	prio => 5,
1141	data => WF_AUTOCANCEL,	1570	data => WF_AUTOCANCEL,
1142	cb => \&IO::AIO::poll_cb);	1571	cb => \&IO::AIO::poll_cb,
		1572	);
		1573
		1574	Event->timer (
		1575	data => WF_AUTOCANCEL,
		1576	after => 0,
		1577	interval => 10,
		1578	cb => sub {
		1579	(Coro::unblock_sub {
		1580	write_runtime
		1581	or warn "ERROR: unable to write runtime file: $!";
		1582	})->();
		1583	},
		1584	);
1143		1585
1144	1	1586	1
1145		1587

Diff Legend

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

Comparing deliantra/server/lib/cf.pm (file contents): Revision 1.93 by root, Thu Dec 21 22:41:35 2006 UTC vs. Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC

Diff Legend

Comparing deliantra/server/lib/cf.pm (file contents):
Revision 1.93 by root, Thu Dec 21 22:41:35 2006 UTC vs.
Revision 1.108 by root, Sun Dec 31 21:02:05 2006 UTC