--- trunk/PlusPlus.pm	2004/12/03 15:23:23	3
+++ trunk/PlusPlus.pm	2004/12/05 15:35:53	14
@@ -4,9 +4,11 @@
 use strict;
 use warnings;
 
-our $VERSION = '0.02';
+our $VERSION = '0.06';
 
 use Carp;
+use File::Temp qw/ tempdir /;
+#use YAML;
 
 =head1 NAME
 
@@ -29,17 +31,20 @@
 
 =head1 METHODS
 
-=head2 open
+=head2 new
 
 Create new indexing object.
 
-  my $i = SWISH::PlusPlus->open(
+  my $i = SWISH::PlusPlus->new(
   	index_dir => '/path/to/index',
 	index => 'index++',
 	search => 'search++',
+	debug => 1,
+	meta_in_body => 1,
+	use_stopwords => 1,
   );
 
-Options to open are following:
+Options to new are following:
 
 =over 5
 
@@ -57,11 +62,26 @@
 
 Full or partial path to SWISH++ search executable. By default, it's B<search>.
 
+=item C<debug>
+
+This option (off by default) will produce a lot of debugging output on
+C<STDERR> prefixed by C<##>.
+
+=item C<meta_in_body>
+
+This option (off by default) enables to search content of meta fields
+without specifing them (like they are in body of document). This will
+somewhat increate index size.
+
+=item C<use_stopwords>
+
+Use built-in SWISH++ stop words. By default, they are disabled.
+
 =back
 
 =cut
 
-sub open {
+sub new {
         my $class = shift;
         my $self = {@_};
 	bless($self, $class);
@@ -70,21 +90,35 @@
 		croak "need $_" unless $self->{$_};
 	}
 
-	if (! -e $self->{'index_dir'}) {
-		mkdir $self->{'index_dir'} || confess "can't create index ",$self->{'index'},": $!";
+	my $index_dir = $self->{'index_dir'};
+
+	my $cwd;
+	chomp($cwd = `pwd`);
+	$self->{'cwd'} = $cwd || carp "can't get cwd!";
+	
+	if ($index_dir !~ m#^/#) {
+		$index_dir = "$cwd/$index_dir";
+		print STDERR "## full path to index_dir: $index_dir\n" if ($self->{'debug'});
+		$self->{'index_dir'} = $index_dir;
+	}
+
+	if (! -e $index_dir) {
+		mkdir $index_dir || confess "can't create index ",$self->{'index'},": $!";
 	}
 
 	# default executables
 	$self->{'index'} ||= 'index';
 	$self->{'search'} ||= 'search';
 
+	print STDERR "## new index_dir: ",$index_dir," index: ",$self->{'index'}, " search: ",$self->{'search'},"\n" if ($self->{'debug'});
+
 	$self ? return $self : return undef;
 }
 
 
 =head2 check_bin
 
-Check if swish++ binaries specified in L<open> are available and verify
+Check if swish++ binaries specified in L<new> are available and verify
 version signature.
 
   if ($i->check_bin) {
@@ -112,6 +146,7 @@
 	confess $self->{'search'}," binary is not SWISH++" unless ($s =~ m/^SWISH\+\+/);
 
 	if ($i eq $s) {
+		$i =~ s/^SWISH\+\+\s+// || confess "can't strip SWISH++ from version";
 		$self->{'version'} = $i;
 		return 1;
 	} else  {
@@ -121,6 +156,252 @@
 
 }
 
+=head2 index_document
+
+Quick way to add simple data to index.
+
+  $i->index_document($key, $data);
+  $i->index_document( 42 => 'meaning of life' );
+
+=cut
+
+sub index_document {
+	my $self = shift;
+
+	my %doc = @_;
+
+	foreach my $id (keys %doc) {
+		$self->_create_doc(
+			path => $id,
+			body => $doc{$id},
+		);
+	}
+
+	return 1;
+}
+
+=head2 add
+
+Add document with metadata to index.
+
+  $i->add(
+  	path => 'path/to/document',
+	title => 'this is result title',
+  	meta => {
+		description => 'this is description meta tag',
+		date => '2004-11-04',
+		author => 'Dobrica Pavlinusic',
+	}
+	body => 'this is text without meta data',
+  );
+
+This is thin wrapper round L<_create_doc>.
+
+=cut
+
+sub add {
+	my $self = shift;
+
+	$self->_create_doc(@_);
+
+	return 1;
+}
+=head2 search
+
+Search your index.
+
+  my @results = $i->search("swhish query");
+
+Returns array with result IDs.
+
+=cut
+
+sub search {
+	my $self = shift;
+
+	my $query = shift || return;
+
+	$self->finish_update;
+
+	my @results;
+
+	# escape double quotes in query for shell
+	$query =~ s/"/\\"/g;
+
+	my $open_cmd = $self->{'search'}." -i ".$self->{'index_dir'}.'/index "'.$query.'" |';
+	print STDERR "## search $open_cmd\n" if ($self->{'debug'});
+
+	open(SEARCH, $open_cmd) || confess "can't start $open_cmd: $!";
+	while(<SEARCH>) {
+		next if (/^#/);
+		chomp;
+		print STDERR "## $_\n" if ($self->{'debug'});
+		my ($rank,$path,$size,$title) = split(/ /,$_,4);
+		push @results, {
+			rank => $rank,
+			path => $path,
+			size => $size,
+			title => $title,
+		}
+	}
+
+	close(SEARCH) || confess "can't close search";
+
+	#print STDERR "## results: ",Dump(@results),"\n" if ($self->{'debug'});
+
+	return @results;
+}
+
+=head2 finish_update
+
+This method will close index.
+
+  $i->finish_update;
+
+It will be called on DESTROY when $i goes out of scope.
+
+=cut
+
+sub finish_update {
+	my $self = shift;
+
+	print STDERR "## finish_update\n" if ($self->{'debug'});
+
+	$self->_close_index;
+}
+
+sub DESTROY {
+	my $self = shift;
+	$self->finish_update;
+}
+
+=head1 PRIVATE METHODS
+
+Private methods implement internals for creating temporary file needed for
+swish++. You should have no need to call them directly, and they are here
+just to have documentation.
+
+=head2 _init_indexer
+
+Create temporary directory in which files for indexing will be created and
+start index process.
+
+  my $i->_init_indexer || die "can't start indexer";
+
+It will also create empty file C<_stopwords_> to disable stop words.
+
+=cut
+
+sub _init_indexer {
+	my $self = shift;
+
+	return if ($self->{'_index_fh'});
+
+	my $tmp_dir = tempdir( CLEANUP => 1 ) || confess "can't create temporary directory: $!";
+	$self->{'tmp_dir'} = $tmp_dir;
+
+	chdir $tmp_dir || confess "can't chdir to ".$tmp_dir.": $!";
+
+	print STDERR "## tmp_dir: $tmp_dir" if ($self->{'debug'});
+
+	my $opt = "-v " . ($self->{'debug'} || '0');
+
+	unless ($self->{'use_stopwrods'}) {
+		open(STOP, '>', "_stopwords_") || carp "can't create empty stopword file, skipping\n";
+		print STOP "  ";
+		close(STOP);
+		$opt .= " -s _stopwords_";
+	}
+
+	my $open_cmd = '| '.$self->{'index'}.' '.$opt.' -e "html:*" -i '.$self->{'index_dir'}.'/index -';
+
+	print STDERR "## init_indexer: $open_cmd\n" if ($self->{'debug'});
+
+	open($self->{'_index_fh'}, $open_cmd) || confess "can't start index with $open_cmd: $!";
+
+	chdir $self->{'cwd'} || confess "can't chdir to ".$self->{'cwd'}.": $!";
+
+	return $self->{'_index_fh'};
+}
+
+=head2 _create_doc
+
+Create temporary file and pass it's name to swish++
+
+  $i->_create_doc(
+  	path => 'path/to/store/in/index',
+	title => 'this is title in results',
+	body => 'data to story in body tag',
+	meta => {
+		'meta name' => 'data for this meta',
+		'another' => 'again more data',
+	}
+  );
+
+To delete document, just omit body and meta data.
+
+=cut
+
+sub _create_doc {
+	my $self = shift;
+
+	my $arg = {@_};
+
+	# open indexer if needed
+	$self->_init_indexer;
+
+	my $path = $self->{'tmp_dir'} || confess "no tmp_dir?";
+	$path .= '/' . $arg->{'path'};
+
+	print STDERR "## _create_doc: $path\n" if ($self->{'debug'});
+
+	open(TMP, '>', $path) || die "can't create temp file $path: $!";
+
+	print TMP '<html><head>';
+
+	$arg->{'body'} ||= '';
+
+	if ($arg->{'meta'}) {
+		foreach my $name (keys %{$arg->{'meta'}}) {
+			my $content = $arg->{'meta'}->{$name};
+			print TMP qq{<meta name="$name" content="$content">};
+			$arg->{'body'} .= " $content" if ($self->{'meta_in_body'});
+		}
+	}
+
+	if (defined($arg->{'title'})) {
+		print TMP '<title>' . ($arg->{'title'} || '') . '</title>';
+		$arg->{'body'} .= " ".$arg->{'title'} if ($self->{'meta_in_body'});
+	}
+
+	print TMP '</head><body>' . $arg->{'body'} . '</body></html>';
+	
+	close(TMP) || confess "can't close tmp file ".$arg->{'path'}.": $!";
+
+	print { $self->{'_index_fh'} } $arg->{'path'}."\n";
+}
+
+=head2 _close_index
+
+Close index after indexing.
+
+  $i->_close_index;
+
+You have to close index before searching.
+
+=cut
+
+sub _close_index {
+	my $self = shift;
+
+	return unless ($self->{'_index_fh'});
+
+	print STDERR "## close index\n" if ($self->{'debug'});
+
+	close($self->{'_index_fh'});
+	undef $self->{'_index_fh'};
+}
+
 1;
 __END__
 
@@ -135,23 +416,45 @@
 Debian version of swish++ is often old (version 5 at moment of this writing
 while version 6 is available in source code), so this module by default
 uses executable names B<index> and B<search> for self-compiled version
-instead of one from Debian package. See L<open> how to specify Debian
+instead of one from Debian package. See L<new> how to specify Debian
 default binaries B<index++> and B<search++>.
 
-=head1 SEE ALSO
+=head2 SWISH++
 
-Mention other useful documentation such as the documentation of
-related modules or operating system documentation (such as man pages
-in UNIX), or any relevant external documentation such as RFCs or
-standards.
+Aside from very good rewrite in C++, SWISH++ is fatster because it has
+claver heuristics about which data in input files are words to index and
+which are not. It's based on English language and might be best choice if
+you plan to install large amount of long text documents.
+
+However, if you plan to index all data from structured storage (e.g. RDBMS)
+you might want B<all> words from data to end up in index as opposed to just
+those which look like English words. This is especially important if you
+don't plan to index English texts with this module.
+
+With distribution build versions of SWISH++ you might have problems with
+disepearing words. To overcome this problem, you will have to compile and
+configure SWISH++ yourself (because language characteristics are
+compilation-time option).
+
+Compilation of SWISH++ is easy process well described on project's web
+pages. To see my very relaxed sample configuration take a look at C<swish++>
+directory included in distribution.
+
+=head2 SWISH++ config
+
+C<config.h> located in C<swish++> directory of this distribution is relaxed
+SWISH++ configuration that will index all words passed to it. This
+configuration is needed for B<date test> because default configuration
+doesn't recognize 2004-12-05 as date. Have in mind that your index size
+might explode.
 
-If you have a mailing list set up for your module, mention it here.
+=head1 SEE ALSO
 
-If you have a web site set up for your module, mention it here.
+C<swish++> web site L<http://homepage.mac.com/pauljlucas/software/swish/>
 
 =head1 AUTHOR
 
-Dobrica Pavlinusic, E<lt>dpavlin@E<gt>
+Dobrica Pavlinusic, E<lt>dpavlin@rot13.orgE<gt>
 
 =head1 COPYRIGHT AND LICENSE