/[Search-Estraier]/trunk/lib/Search/Estraier.pm
This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!
ViewVC logotype

Diff of /trunk/lib/Search/Estraier.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 111 by dpavlin, Tue Feb 21 15:41:57 2006 UTC revision 156 by dpavlin, Mon May 22 14:42:10 2006 UTC
# Line 4  use 5.008; Line 4  use 5.008;
4  use strict;  use strict;
5  use warnings;  use warnings;
6    
7  our $VERSION = '0.04_3';  our $VERSION = '0.07_1';
8    
9  =head1 NAME  =head1 NAME
10    
# Line 20  Search::Estraier - pure perl module to u Line 20  Search::Estraier - pure perl module to u
20          my $node = new Search::Estraier::Node(          my $node = new Search::Estraier::Node(
21                  url => 'http://localhost:1978/node/test',                  url => 'http://localhost:1978/node/test',
22                  user => 'admin',                  user => 'admin',
23                  passwd => 'admin'                  passwd => 'admin',
24                    create => 1,
25                    label => 'Label for node',
26                    croak_on_error => 1,
27          );          );
28    
29          # create document          # create document
# Line 599  sub options { Line 602  sub options {
602  }  }
603    
604    
605    =head2 set_skip
606    
607    Set number of skipped documents from beginning of results
608    
609      $cond->set_skip(42);
610    
611    Similar to C<offset> in RDBMS.
612    
613    =cut
614    
615    sub set_skip {
616            my $self = shift;
617            $self->{skip} = shift;
618    }
619    
620    =head2 skip
621    
622    Return skip for this condition.
623    
624      print $cond->skip;
625    
626    =cut
627    
628    sub skip {
629            my $self = shift;
630            return $self->{skip};
631    }
632    
633    
634  package Search::Estraier::ResultDocument;  package Search::Estraier::ResultDocument;
635    
636  use Carp qw/croak/;  use Carp qw/croak/;
# Line 843  or in more verbose form Line 875  or in more verbose form
875    
876    my $node = new Search::HyperEstraier::Node(    my $node = new Search::HyperEstraier::Node(
877          url => 'http://localhost:1978/node/test',          url => 'http://localhost:1978/node/test',
878            user => 'admin',
879            passwd => 'admin'
880            create => 1,
881            label => 'optional node label',
882          debug => 1,          debug => 1,
883          croak_on_error => 1          croak_on_error => 1
884    );    );
# Line 855  with following arguments: Line 891  with following arguments:
891    
892  URL to node  URL to node
893    
894    =item user
895    
896    specify username for node server authentication
897    
898    =item passwd
899    
900    password for authentication
901    
902    =item create
903    
904    create node if it doesn't exists
905    
906    =item label
907    
908    optional label for new node if C<create> is used
909    
910  =item debug  =item debug
911    
912  dumps a B<lot> of debugging output  dumps a B<lot> of debugging output
# Line 885  sub new { Line 937  sub new {
937          if ($#_ == 0) {          if ($#_ == 0) {
938                  $self->{url} = shift;                  $self->{url} = shift;
939          } else {          } else {
                 my $args = {@_};  
   
940                  %$self = ( %$self, @_ );                  %$self = ( %$self, @_ );
941    
942                    $self->set_auth( $self->{user}, $self->{passwd} ) if ($self->{user});
943    
944                  warn "## Node debug on\n" if ($self->{debug});                  warn "## Node debug on\n" if ($self->{debug});
945          }          }
946    
# Line 898  sub new { Line 950  sub new {
950                  size => -1.0,                  size => -1.0,
951          };          };
952    
953            if ($self->{create}) {
954                    if (! eval { $self->name } || $@) {
955                            my $name = $1 if ($self->{url} =~ m#/node/([^/]+)/*#);
956                            croak "can't find node name in '$self->{url}'" unless ($name);
957                            my $label = $self->{label} || $name;
958                            $self->master(
959                                    action => 'nodeadd',
960                                    name => $name,
961                                    label => $label,
962                            ) || croak "can't create node $name ($label)";
963                    }
964            }
965    
966          $self ? return $self : return undef;          $self ? return $self : return undef;
967  }  }
968    
# Line 988  Add a document Line 1053  Add a document
1053    
1054    $node->put_doc( $document_draft ) or die "can't add document";    $node->put_doc( $document_draft ) or die "can't add document";
1055    
1056  Return true on success or false on failture.  Return true on success or false on failure.
1057    
1058  =cut  =cut
1059    
# Line 996  sub put_doc { Line 1061  sub put_doc {
1061          my $self = shift;          my $self = shift;
1062          my $doc = shift || return;          my $doc = shift || return;
1063          return unless ($self->{url} && $doc->isa('Search::Estraier::Document'));          return unless ($self->{url} && $doc->isa('Search::Estraier::Document'));
1064          $self->shuttle_url( $self->{url} . '/put_doc',          if ($self->shuttle_url( $self->{url} . '/put_doc',
1065                  'text/x-estraier-draft',                  'text/x-estraier-draft',
1066                  $doc->dump_draft,                  $doc->dump_draft,
1067                  undef                  undef
1068          ) == 200;          ) == 200) {
1069                    $self->_clear_info;
1070                    return 1;
1071            }
1072            return undef;
1073  }  }
1074    
1075    
# Line 1019  sub out_doc { Line 1088  sub out_doc {
1088          my $id = shift || return;          my $id = shift || return;
1089          return unless ($self->{url});          return unless ($self->{url});
1090          croak "id must be number, not '$id'" unless ($id =~ m/^\d+$/);          croak "id must be number, not '$id'" unless ($id =~ m/^\d+$/);
1091          $self->shuttle_url( $self->{url} . '/out_doc',          if ($self->shuttle_url( $self->{url} . '/out_doc',
1092                  'application/x-www-form-urlencoded',                  'application/x-www-form-urlencoded',
1093                  "id=$id",                  "id=$id",
1094                  undef                  undef
1095          ) == 200;          ) == 200) {
1096                    $self->_clear_info;
1097                    return 1;
1098            }
1099            return undef;
1100  }  }
1101    
1102    
# Line 1041  sub out_doc_by_uri { Line 1114  sub out_doc_by_uri {
1114          my $self = shift;          my $self = shift;
1115          my $uri = shift || return;          my $uri = shift || return;
1116          return unless ($self->{url});          return unless ($self->{url});
1117          $self->shuttle_url( $self->{url} . '/out_doc',          if ($self->shuttle_url( $self->{url} . '/out_doc',
1118                  'application/x-www-form-urlencoded',                  'application/x-www-form-urlencoded',
1119                  "uri=" . uri_escape($uri),                  "uri=" . uri_escape($uri),
1120                  undef                  undef
1121          ) == 200;          ) == 200) {
1122                    $self->_clear_info;
1123                    return 1;
1124            }
1125            return undef;
1126  }  }
1127    
1128    
# Line 1063  sub edit_doc { Line 1140  sub edit_doc {
1140          my $self = shift;          my $self = shift;
1141          my $doc = shift || return;          my $doc = shift || return;
1142          return unless ($self->{url} && $doc->isa('Search::Estraier::Document'));          return unless ($self->{url} && $doc->isa('Search::Estraier::Document'));
1143          $self->shuttle_url( $self->{url} . '/edit_doc',          if ($self->shuttle_url( $self->{url} . '/edit_doc',
1144                  'text/x-estraier-draft',                  'text/x-estraier-draft',
1145                  $doc->dump_draft,                  $doc->dump_draft,
1146                  undef                  undef
1147          ) == 200;          ) == 200) {
1148                    $self->_clear_info;
1149                    return 1;
1150            }
1151            return undef;
1152  }  }
1153    
1154    
# Line 1360  sub search { Line 1441  sub search {
1441          );          );
1442          return if ($rv != 200);          return if ($rv != 200);
1443    
1444          my (@docs, $hints);          my @records     = split /--------\[.*?\]--------(?::END)?\r?\n/, $resbody;
1445            my $hintsText   = splice @records, 0, 2; # starts with empty record
1446          my @lines = split(/\n/, $resbody);          my $hints               = { $hintsText =~ m/^(.*?)\t(.*?)$/gsm };
1447          return unless (@lines);  
1448            # process records
1449          my $border = $lines[0];          my $docs = [];
1450          my $isend = 0;          foreach my $record (@records)
1451          my $lnum = 1;          {
1452                    # split into keys and snippets
1453          while ( $lnum <= $#lines ) {                  my ($keys, $snippet) = $record =~ m/^(.*?)\n\n(.*?)$/s;
1454                  my $line = $lines[$lnum];  
1455                  $lnum++;                  # create document hash
1456                    my $doc                         = { $keys =~ m/^(.*?)=(.*?)$/gsm };
1457                  #warn "## $line\n";                  $doc->{'@keywords'}     = $doc->{keywords};
1458                  if ($line && $line =~ m/^\Q$border\E(:END)*$/) {                  ($doc->{keywords})      = $keys =~ m/^%VECTOR\t(.*?)$/gm;
1459                          $isend = $1;                  $doc->{snippet}         = $snippet;
1460                          last;  
1461                  }                  push @$docs, new Search::Estraier::ResultDocument(
1462                            attrs           => $doc,
1463                  if ($line =~ /\t/) {                          uri             => $doc->{'@uri'},
1464                          my ($k,$v) = split(/\t/, $line, 2);                          snippet         => $snippet,
1465                          $hints->{$k} = $v;                          keywords        => $doc->{'keywords'},
1466                  }                  );
         }  
   
         my $snum = $lnum;  
   
         while( ! $isend && $lnum <= $#lines ) {  
                 my $line = $lines[$lnum];  
                 #warn "# $lnum: $line\n";  
                 $lnum++;  
   
                 if ($line && $line =~ m/^\Q$border\E/) {  
                         if ($lnum > $snum) {  
                                 my $rdattrs;  
                                 my $rdvector;  
                                 my $rdsnippet;  
                                   
                                 my $rlnum = $snum;  
                                 while ($rlnum < $lnum - 1 ) {  
                                         #my $rdline = $self->_s($lines[$rlnum]);  
                                         my $rdline = $lines[$rlnum];  
                                         $rlnum++;  
                                         last unless ($rdline);  
                                         if ($rdline =~ /^%/) {  
                                                 $rdvector = $1 if ($rdline =~ /^%VECTOR\t(.+)$/);  
                                         } elsif($rdline =~ /=/) {  
                                                 $rdattrs->{$1} = $2 if ($rdline =~ /^(.+)=(.+)$/);  
                                         } else {  
                                                 confess "invalid format of response";  
                                         }  
                                 }  
                                 while($rlnum < $lnum - 1) {  
                                         my $rdline = $lines[$rlnum];  
                                         $rlnum++;  
                                         $rdsnippet .= "$rdline\n";  
                                 }  
                                 #warn Dumper($rdvector, $rdattrs, $rdsnippet);  
                                 if (my $rduri = $rdattrs->{'@uri'}) {  
                                         push @docs, new Search::Estraier::ResultDocument(  
                                                 uri => $rduri,  
                                                 attrs => $rdattrs,  
                                                 snippet => $rdsnippet,  
                                                 keywords => $rdvector,  
                                         );  
                                 }  
                         }  
                         $snum = $lnum;  
                         #warn "### $line\n";  
                         $isend = 1 if ($line =~ /:END$/);  
                 }  
   
         }  
   
         if (! $isend) {  
                 warn "received result doesn't have :END\n$resbody";  
                 return;  
1467          }          }
1468    
1469          #warn Dumper(\@docs, $hints);          return new Search::Estraier::NodeResult( docs => $docs, hints => $hints );
   
         return new Search::Estraier::NodeResult( docs => \@docs, hints => $hints );  
1470  }  }
1471    
1472    
# Line 1490  sub cond_to_query { Line 1515  sub cond_to_query {
1515          push @args, 'wwidth=' . $self->{wwidth};          push @args, 'wwidth=' . $self->{wwidth};
1516          push @args, 'hwidth=' . $self->{hwidth};          push @args, 'hwidth=' . $self->{hwidth};
1517          push @args, 'awidth=' . $self->{awidth};          push @args, 'awidth=' . $self->{awidth};
1518            push @args, 'skip=' . $cond->{skip} if ($cond->{skip});
1519    
1520          return join('&', @args);          return join('&', @args);
1521  }  }
# Line 1636  sub set_user { Line 1662  sub set_user {
1662          croak "mode must be number, not '$mode'" unless ($mode =~ m/^\d+$/);          croak "mode must be number, not '$mode'" unless ($mode =~ m/^\d+$/);
1663    
1664          $self->shuttle_url( $self->{url} . '/_set_user',          $self->shuttle_url( $self->{url} . '/_set_user',
1665                  'text/plain',                  'application/x-www-form-urlencoded',
1666                  'name=' . uri_escape($name) . '&mode=' . $mode,                  'name=' . uri_escape($name) . '&mode=' . $mode,
1667                  undef                  undef
1668          ) == 200;          ) == 200;
# Line 1669  sub set_link { Line 1695  sub set_link {
1695                  undef                  undef
1696          ) == 200) {          ) == 200) {
1697                  # refresh node info after adding link                  # refresh node info after adding link
1698                  $self->_set_info;                  $self->_clear_info;
1699                  return 1;                  return 1;
1700          }          }
1701            return undef;
1702  }  }
1703    
1704  =head2 admins  =head2 admins
# Line 1716  sub links { Line 1743  sub links {
1743          return $self->{inform}->{links};          return $self->{inform}->{links};
1744  }  }
1745    
1746    =head2 master
1747    
1748    Set actions on Hyper Estraier node master (C<estmaster> process)
1749    
1750      $node->master(
1751            action => 'sync'
1752      );
1753    
1754    All available actions are documented in
1755    L<http://hyperestraier.sourceforge.net/nguide-en.html#protocol>
1756    
1757    =cut
1758    
1759    my $estmaster_rest = {
1760            shutdown => {
1761                    status => 202,
1762            },
1763            sync => {
1764                    status => 202,
1765            },
1766            backup => {
1767                    status => 202,
1768            },
1769            userlist => {
1770                    status => 200,
1771                    returns => [ qw/name passwd flags fname misc/ ],
1772            },
1773            useradd => {
1774                    required => [ qw/name passwd flags/ ],
1775                    optional => [ qw/fname misc/ ],
1776                    status => 200,
1777            },
1778            userdel => {
1779                    required => [ qw/name/ ],
1780                    status => 200,
1781            },
1782            nodelist => {
1783                    status => 200,
1784                    returns => [ qw/name label doc_num word_num size/ ],
1785            },
1786            nodeadd => {
1787                    required => [ qw/name/ ],
1788                    optional => [ qw/label/ ],
1789                    status => 200,
1790            },
1791            nodedel => {
1792                    required => [ qw/name/ ],
1793                    status => 200,
1794            },
1795            nodeclr => {
1796                    required => [ qw/name/ ],
1797                    status => 200,
1798            },
1799            nodertt => {
1800                    status => 200,  
1801            },
1802    };
1803    
1804    sub master {
1805            my $self = shift;
1806    
1807            my $args = {@_};
1808    
1809            # have action?
1810            my $action = $args->{action} || croak "need action, available: ",
1811                    join(", ",keys %{ $estmaster_rest });
1812    
1813            # check if action is valid
1814            my $rest = $estmaster_rest->{$action};
1815            croak "action '$action' is not supported, available actions: ",
1816                    join(", ",keys %{ $estmaster_rest }) unless ($rest);
1817    
1818            croak "BUG: action '$action' needs return status" unless ($rest->{status});
1819    
1820            my @args;
1821    
1822            if ($rest->{required} || $rest->{optional}) {
1823    
1824                    map {
1825                            croak "need parametar '$_' for action '$action'" unless ($args->{$_});
1826                            push @args, $_ . '=' . uri_escape( $args->{$_} );
1827                    } ( @{ $rest->{required} } );
1828    
1829                    map {
1830                            push @args, $_ . '=' . uri_escape( $args->{$_} ) if ($args->{$_});
1831                    } ( @{ $rest->{optional} } );
1832    
1833            }
1834    
1835            my $uri = new URI( $self->{url} );
1836    
1837            my $resbody;
1838    
1839            my $status = $self->shuttle_url(
1840                    'http://' . $uri->host_port . '/master?action=' . $action ,
1841                    'application/x-www-form-urlencoded',
1842                    join('&', @args),
1843                    \$resbody,
1844                    1,
1845            ) or confess "shuttle_url failed";
1846    
1847            if ($status == $rest->{status}) {
1848    
1849                    # refresh node info after sync
1850                    $self->_clear_info if ($action eq 'sync' || $action =~ m/^node(?:add|del|clr)$/);
1851    
1852                    if ($rest->{returns} && wantarray) {
1853    
1854                            my @results;
1855                            my $fields = $#{$rest->{returns}};
1856    
1857                            foreach my $line ( split(/[\r\n]/,$resbody) ) {
1858                                    my @e = split(/\t/, $line, $fields + 1);
1859                                    my $row;
1860                                    foreach my $i ( 0 .. $fields) {
1861                                            $row->{ $rest->{returns}->[$i] } = $e[ $i ];
1862                                    }
1863                                    push @results, $row;
1864                            }
1865    
1866                            return @results;
1867    
1868                    } elsif ($resbody) {
1869                            chomp $resbody;
1870                            return $resbody;
1871                    } else {
1872                            return 0E0;
1873                    }
1874            }
1875    
1876            carp "expected status $rest->{status}, but got $status";
1877            return undef;
1878    }
1879    
1880  =head1 PRIVATE METHODS  =head1 PRIVATE METHODS
1881    
# Line 1746  sub _set_info { Line 1906  sub _set_info {
1906    
1907          my @lines = split(/[\r\n]/,$resbody);          my @lines = split(/[\r\n]/,$resbody);
1908    
1909          $self->{inform} = {};          $self->_clear_info;
1910    
1911          ( $self->{inform}->{name}, $self->{inform}->{label}, $self->{inform}->{dnum},          ( $self->{inform}->{name}, $self->{inform}->{label}, $self->{inform}->{dnum},
1912                  $self->{inform}->{wnum}, $self->{inform}->{size} ) = split(/\t/, shift @lines, 5);                  $self->{inform}->{wnum}, $self->{inform}->{size} ) = split(/\t/, shift @lines, 5);
# Line 1771  sub _set_info { Line 1931  sub _set_info {
1931    
1932  }  }
1933    
1934    =head2 _clear_info
1935    
1936    Clear information for node
1937    
1938      $node->_clear_info;
1939    
1940    On next call to C<name>, C<label>, C<doc_num>, C<word_num> or C<size> node
1941    info will be fetch again from Hyper Estraier.
1942    
1943    =cut
1944    sub _clear_info {
1945            my $self = shift;
1946            $self->{inform} = {
1947                    dnum => -1,
1948                    wnum => -1,
1949                    size => -1.0,
1950            };
1951    }
1952    
1953  ###  ###
1954    
1955  =head1 EXPORT  =head1 EXPORT
# Line 1787  Hyper Estraier Ruby interface on which t Line 1966  Hyper Estraier Ruby interface on which t
1966    
1967  Dobrica Pavlinusic, E<lt>dpavlin@rot13.orgE<gt>  Dobrica Pavlinusic, E<lt>dpavlin@rot13.orgE<gt>
1968    
1969    Robert Klep E<lt>robert@klep.nameE<gt> contributed refactored search code
1970    
1971  =head1 COPYRIGHT AND LICENSE  =head1 COPYRIGHT AND LICENSE
1972    
Legend:
Removed from v.111  
changed lines
  Added in v.156
  ViewVC Help
Powered by ViewVC 1.1.26