/[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 128 by dpavlin, Mon May 8 12:00:43 2006 UTC revision 160 by dpavlin, Sat Jun 24 15:34:42 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.06_1';  our $VERSION = '0.07_2';
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 872  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 884  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 914  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 927  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 1017  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 1025  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 1048  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 1070  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 1092  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 1463  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=' . $self->{skip} if ($self->{skip});          push @args, 'skip=' . $cond->{skip} if ($cond->{skip});
1519    
1520          return join('&', @args);          return join('&', @args);
1521  }  }
# Line 1610  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 1643  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 1690  sub links { Line 1743  sub links {
1743          return $self->{inform}->{links};          return $self->{inform}->{links};
1744  }  }
1745    
1746    =head2 cacheusage
1747    
1748    Return cache usage for a node
1749    
1750      my $cache = $node->cacheusage;
1751    
1752    =cut
1753    
1754    sub cacheusage {
1755            my $self = shift;
1756    
1757            return unless ($self->{url});
1758    
1759            my $resbody;
1760            my $rv = $self->shuttle_url( $self->{url} . '/cacheusage',
1761                    'text/plain',
1762                    undef,
1763                    \$resbody,
1764            );
1765    
1766            return if ($rv != 200 || !$resbody);
1767    
1768            return $resbody;
1769    }
1770    
1771    =head2 master
1772    
1773    Set actions on Hyper Estraier node master (C<estmaster> process)
1774    
1775      $node->master(
1776            action => 'sync'
1777      );
1778    
1779    All available actions are documented in
1780    L<http://hyperestraier.sourceforge.net/nguide-en.html#protocol>
1781    
1782    =cut
1783    
1784    my $estmaster_rest = {
1785            shutdown => {
1786                    status => 202,
1787            },
1788            sync => {
1789                    status => 202,
1790            },
1791            backup => {
1792                    status => 202,
1793            },
1794            userlist => {
1795                    status => 200,
1796                    returns => [ qw/name passwd flags fname misc/ ],
1797            },
1798            useradd => {
1799                    required => [ qw/name passwd flags/ ],
1800                    optional => [ qw/fname misc/ ],
1801                    status => 200,
1802            },
1803            userdel => {
1804                    required => [ qw/name/ ],
1805                    status => 200,
1806            },
1807            nodelist => {
1808                    status => 200,
1809                    returns => [ qw/name label doc_num word_num size/ ],
1810            },
1811            nodeadd => {
1812                    required => [ qw/name/ ],
1813                    optional => [ qw/label/ ],
1814                    status => 200,
1815            },
1816            nodedel => {
1817                    required => [ qw/name/ ],
1818                    status => 200,
1819            },
1820            nodeclr => {
1821                    required => [ qw/name/ ],
1822                    status => 200,
1823            },
1824            nodertt => {
1825                    status => 200,  
1826            },
1827    };
1828    
1829    sub master {
1830            my $self = shift;
1831    
1832            my $args = {@_};
1833    
1834            # have action?
1835            my $action = $args->{action} || croak "need action, available: ",
1836                    join(", ",keys %{ $estmaster_rest });
1837    
1838            # check if action is valid
1839            my $rest = $estmaster_rest->{$action};
1840            croak "action '$action' is not supported, available actions: ",
1841                    join(", ",keys %{ $estmaster_rest }) unless ($rest);
1842    
1843            croak "BUG: action '$action' needs return status" unless ($rest->{status});
1844    
1845            my @args;
1846    
1847            if ($rest->{required} || $rest->{optional}) {
1848    
1849                    map {
1850                            croak "need parametar '$_' for action '$action'" unless ($args->{$_});
1851                            push @args, $_ . '=' . uri_escape( $args->{$_} );
1852                    } ( @{ $rest->{required} } );
1853    
1854                    map {
1855                            push @args, $_ . '=' . uri_escape( $args->{$_} ) if ($args->{$_});
1856                    } ( @{ $rest->{optional} } );
1857    
1858            }
1859    
1860            my $uri = new URI( $self->{url} );
1861    
1862            my $resbody;
1863    
1864            my $status = $self->shuttle_url(
1865                    'http://' . $uri->host_port . '/master?action=' . $action ,
1866                    'application/x-www-form-urlencoded',
1867                    join('&', @args),
1868                    \$resbody,
1869                    1,
1870            ) or confess "shuttle_url failed";
1871    
1872            if ($status == $rest->{status}) {
1873    
1874                    # refresh node info after sync
1875                    $self->_clear_info if ($action eq 'sync' || $action =~ m/^node(?:add|del|clr)$/);
1876    
1877                    if ($rest->{returns} && wantarray) {
1878    
1879                            my @results;
1880                            my $fields = $#{$rest->{returns}};
1881    
1882                            foreach my $line ( split(/[\r\n]/,$resbody) ) {
1883                                    my @e = split(/\t/, $line, $fields + 1);
1884                                    my $row;
1885                                    foreach my $i ( 0 .. $fields) {
1886                                            $row->{ $rest->{returns}->[$i] } = $e[ $i ];
1887                                    }
1888                                    push @results, $row;
1889                            }
1890    
1891                            return @results;
1892    
1893                    } elsif ($resbody) {
1894                            chomp $resbody;
1895                            return $resbody;
1896                    } else {
1897                            return 0E0;
1898                    }
1899            }
1900    
1901            carp "expected status $rest->{status}, but got $status";
1902            return undef;
1903    }
1904    
1905  =head1 PRIVATE METHODS  =head1 PRIVATE METHODS
1906    
# Line 1720  sub _set_info { Line 1931  sub _set_info {
1931    
1932          my @lines = split(/[\r\n]/,$resbody);          my @lines = split(/[\r\n]/,$resbody);
1933    
1934          $self->{inform} = {};          $self->_clear_info;
1935    
1936          ( $self->{inform}->{name}, $self->{inform}->{label}, $self->{inform}->{dnum},          ( $self->{inform}->{name}, $self->{inform}->{label}, $self->{inform}->{dnum},
1937                  $self->{inform}->{wnum}, $self->{inform}->{size} ) = split(/\t/, shift @lines, 5);                  $self->{inform}->{wnum}, $self->{inform}->{size} ) = split(/\t/, shift @lines, 5);
# Line 1745  sub _set_info { Line 1956  sub _set_info {
1956    
1957  }  }
1958    
1959    =head2 _clear_info
1960    
1961    Clear information for node
1962    
1963      $node->_clear_info;
1964    
1965    On next call to C<name>, C<label>, C<doc_num>, C<word_num> or C<size> node
1966    info will be fetch again from Hyper Estraier.
1967    
1968    =cut
1969    sub _clear_info {
1970            my $self = shift;
1971            $self->{inform} = {
1972                    dnum => -1,
1973                    wnum => -1,
1974                    size => -1.0,
1975            };
1976    }
1977    
1978  ###  ###
1979    
1980  =head1 EXPORT  =head1 EXPORT
Legend:
Removed from v.128  
changed lines
  Added in v.160
  ViewVC Help
Powered by ViewVC 1.1.26