Ismael.pm: a Perl module to control YaCy-peers

Author: Marc Nause
Licence: LGPL
Version: 0.6.5 (29.November.2008) (changelog)

Beware! This version of Ismael.pm does not work with current releases of YaCy. I am currently working on an updated version. Please contact me if you need a working version and I can provide you with a dev version.

What can Ismael.pm do?

Ismael.pm is an easy to use module that allows to gather information about YaCy-peers and to use several functions of YaCy-peers.

What is YaCy?

If you don't know what YaCy is, you probably don't have any need to use Ismael.pm yet. YaCy is a p2p-based distributed Web Search Engine. You can get more information regarding YaCy at http://yacy.net/.

How to install Isamel.pm

Download Ismael.pm from http://ismael.audioattack.de/download/ismael-0.6.5.tar.gz.

To use Isamel.pm, simply unpack it and place it in the directory the Perl script that is supposed to use Isamel.pm is located in. Another place to put Isamel.pm is one of the directories in @INC which you can display by running "perl -V".

Ismael.pm requires the modules LWP::UserAgent and HTTP::Request.

Ismael.pm's commands

Ismael provides this commands:

Example

Here is an example that shows how the commands can be used.

#!/usr/bin/perl

#Tell the programm to use Ismael.
use Ismael;

#Here we create a new object. The peer can be reached at http://4o4.dyndns.org:8080
$peer = Ismael->new(url=>'http://4o4.dyndns.org:8080');

#Here we add the peer owner's username and password.
$success = $peer->setProperties(user=>'admin',pass=>'xxxxxxxx');
if($success) {print "setProperties: OK\n";}
else {print "setProperties: ".$peer->errstr()."\n";}

#Here we ask for a single property.
$property = $peer->getProperty(yourppm);
print "PPM: $property\n";

#Here we ask for several properties.
($yourppm, $yourname) = $peer->getProperties(yourppm,yourname);
print "PPM: $yourppm, Peername: $yourname\n";

#Now we refresh the data of the peer.
$success = $peer->getData();
if($success) {print "getData: OK\n";}
else {print "getData: ".$peer->errstr()."\n";}

#Here we add a new job to the peers crawling queue.
$success = $peer->addJob(url=>'http://yacy.net',depth=>'2',filter=>'.*yacy.*');
#BTW: The default filter is .*
if($success) {print "addJob: OK\n";}
else {print "addJob: ".$peer->errstr()."\n";}

#Here we add the same job again. An error Message will be displayed.
$success = $peer->addJob(url=>'http://yacy.net',depth=>'2',filter=>'.*yacy.*');
#BTW: The default filter is .*
if($success) {print "addJob: OK\n";}
else {print "addJob: ".$peer->errstr()."\n";}

#Here we pause crawling.
$success = $peer->pauseCrawling();
if($success) {print "pauseCrawling: OK\n";}
else {print "pauseCrawling: ".$peer->errstr()."\n";}

#Here we resume crawling.
$success = $peer->resumeCrawling();
if($success) {print "resumeCrawling: OK\n";}
else {print "resumeCrawling: ".$peer->errstr()."\n";}

#Here we start a search
@search = $peer->search(search=>'spaghetti',time=>'6',resource=>'global',order=>'YBR-Date-Quality',urlmaskfilter=>'.*',topwords=>'off');
$i = 0;
$length = scalar(@search);
while($i < $length){
    print $search[$i][0]."\n".$search[$i][1]."\n".$search[$i][2]."\n".$search[$i][3]."\n\n";
    $i++;
}

#Here we start a search which also returns topwords
@search = $peer->search(search=>'spaghetti',topwords=>'on');
$i = 0;
$length = scalar(@search);
while($i < $length-1){
    print $search[$i][0]."\n".$search[$i][1]."\n".$search[$i][2]."\n".$search[$i][3]."\n\n";
    $i++;
}
# Print topwords...
if($search[$i][0]){
    @topwords = split /,/, $search[$i][0];
    for($j=0;$j < scalar(@topwords);$j++){
    print $topwords[$j]."\n";
    }
}

# Now we turn off index distribution
$success = $peer->setTransferProperties(indexDistribute=>'off');
if($success) {print "Turned off index distribution!\n";}
else {print "Error while turning off index distribution: ".$peer->errstr()."\n";}

# ... and now we turn it on again.
$success = $peer->setTransferProperties(indexDistribute=>'on');
if($success) {print "Turned on index distribution!\n";}
else {print "Error while turning on index distribution: ".$peer->errstr()."\n";}

#Let's ping!
if($peer->ping()){
    print "Peer is online!";
}
else{
    print "Peer is offline!";
}

#Now we stop the peer!
$success = $peer->stop();
if($success) {print "stop: OK\n";}
else {print "stop: ".$peer->errstr()."\n";}