NAME

Net::Rapidshare - Perl interface to the Rapidshare API

VERSION

This document describes Net::Rapidshare version 0.07

SYNOPSIS

use Net::Rapidshare;

## Initialize with account info
my $rs = Net::Rapidshare->new(
	type => 'prem',
	login => 'mylogin',
	password => 'mypassword'
);

## Initialize and then add account info
my $rs = Net::Rapidshare->new();
$rs->type('col');
$rs->login('mylogin');
$rs->password('mypassword');

## Initialize with a cookie
my $rs = Net::Rapidshare->new(
	cookie => 'ASJHDGSASJDHAKSD6543.....',
);
# OR
my $rs = Net::Rapidshare->new();
$rs->cookie('JHASGDASAAKSJHD65465.....');

DESCRIPTION

This module provides a Perl interface to the Rapidshare API. You can view the full API Documentation at http://images.rapidshare.com/apidoc.txt.

Note: Always make sure you do not make more API calls than necessary. Rapidshare servers use a IP-based credit system, which will ban a IP making very many small requests or just a few unnecessary big requests. Everything you do will add POINTS to your IP address. If you exceed a certain point limit, API calls are denied for 30 minutes. If you exceed this limit multiple times, your account is banned as well.

Note: v0.05 includes changes to various methods to reflect Rapidshares API updates. The changes can potentially break existing code. Please read the 'Changes' file for more details.

METHODS

new

new(\%options)

Construct a new Net::Rapidshare object

my $rs = my $rs = Net::Rapidshare->new();
my $rs = my $rs = Net::Rapidshare->new(\%options);

Options allowed:

"type" - Account Type

"login" - Account Login

"password" - Account Password

"cookie" - Rapidshare Cookie string

type

type($type)

Get or set the type of account. Use col for Collector and prem for Premium accounts. Free accounts are not supported.

login

login($user)

Get or set account login

password

password($mypwd)

Get or set account password

cookie

cookie($cookie_string)

Get or set authentication cookie. Setting a cookie causes it to override account type/login/password.

unsecure

Use http instead of https for all API calls. This is the default

$rs->unsecure;

secure

Use https instead of http for all API calls. Using this will double your points for all API calls.

$rs->secure;

proxy

proxy($proxy_server)

Get or set a proxy server

API METHODS

Account

getapicpu

Returns the current and maximum allowed Rapidshare API CPU usage. Your account maybe banned if you go over. It is a good idea to check it before/after intensive operations.

my ($curr, $max) = $rs->getapicpu or die $rs->errstr;

getaccountdetails

getaccountdetails(\%options)

Returns a hash (or reference) containing your account details.

my %account = $rs->getaccountdetails(
	withrefstring => 1,
	withcookie => 1,
) or die $rs->errstr;

Options:

withrefstring Returned hash includes a key 'refstring' with your referrer string as its value

withcookie Returned hash includes a key 'cookie' with your Rapidshare cookie as its value

Returned Hash contains following keys -

Premium Account: accountid, type, servertime, addtime, validuntil, username, directstart, protectfiles, rsantihack, plustrafficmode, mirrors, jsconfig, email, lots, fpoints, ppoints, curfiles, curspace, bodkb, premkbleft, ppointrate, refstring, cookie

Collectors Account: accountid, type, servertime, addtime, username, email, jsconfig, rsantihack, lots, fpoints, ppoints, curfiles, curspace, ppointrate, refstring, cookie

setaccountdetails(\%options)

Update your Rapidshare account information.

$rs->setaccountdetails(
    email => 'john@smith.com',
    newpassword =>
        'secret',    # you might want to use secure if setting password
    directstart => 1,
    mirror      => 'l3',
) or die $rs->errstr;

email: Required. Your email ID
newpassword: Optional. New account password
username: Optional. New username/alias
mirror: Optional. Choose what mirrors you want to use. Comma seperated list
directstart: Optional. Direct downloads, requested files are saved without redirection via RapidShare. '0' to disable, '1' to enable. Skipping disables it.
jsconfig: Optional. A custom value, which can be set as you like. Max. 64 alphanumeric characters.
plustrafficmode: Optional. Modes valid are 0=No auto conversion. 1=Only TrafficShare conversion. 2=Only RapidPoints conversion. 3=Both conversions available.

enablersantihack({'noemail' => 1});

Enabled the RS AntiHack mode. This mode is highly recommended for every account, as it makes account manipulations impossible without unlocking it first. If the 'noemail' option is true, then an email with unlock code is not sent.

my $unlock_code = $rs->enablersantihack or die $rs->errstr;

sendrsantihackmail

Sends an email to the email ID on your account containing unlock code.

$rs->sendrsantihackmail or die $rs->errstr;

disablersantihack($unlock_code)

Disables the RS AntiHack mode, allowing account changes

$rs->disablersantihack('unlock code') or die $rs->errstr;

buylots

Exchanges RapidPoints to lots. You will get one lot for 50 RapidPoints. You cannot own more than 50.000 lots.

Return total number of lots after buying.

my $num_of_lots = $rs->buylots('how many') or die $rs->errstr;

masspoll($pollid, $vote)

Cast your vote in a (running) mass poll.

$rs->masspoll(
    '34534535342',    # Poll ID
    '10'             # Vote
) or die $rs->errstr;

Files

nextuploadserver

Get the next upload server. Returns a full Rapidshare URL

my $upload_server = $rs->nextuploadserver or die $rs->errstr;

checkincomplete($fileid, $killcode)

Check if a file has been uploaded successfully. Returns size on server

my $size_on_server = $rs->checkincomplete(
    '1234323423',          # File ID
    '25298475092437502'    # Kill Code
) or die $rs->errstr;

listfiles(\%options)

List all the files in your account. This is API Points intensive. Use sparingly.

my @rows = $rs->listfiles(
    fields => "killcode,name,size",
    order  => 'size'
) or die $rs->errstr;
foreach (@rows) {
    my ( $fileid, $killcode, $name, $size ) = split( /,/, $_ );
    print "Found $name ($size) with ID $fileid and KillCode $killcode\n";
}

Returns 'NONE' or an array (or reference) of results. Each element will contain a comma separated list of file ID and requested fields

realfolder

Realfolder ID to list files from. Defaults to all

filename

List all files who's file names are that specified. Helps in finding dupes

fileids

A comma seperated list of fileids to list

fields

Fields to include in the result list. fileid is always included. This should be a comma separated string.

You can use any of the following => downloads,lastdownload,filename,size,killcode,serverid,type,x,y,realfolder, bodtype,killdeadline,uploadtime,ip,md5hex.

order

Order your results by any of the fields queried

desc

Result is in descending order when '1'. Defaults to '0'

renamefile($fileid, $killcode, $newname)

Rename a file

$rs->renamefile(
    '23424342',            # file ID
    'newname'              # New name
) or die $rs->errtsr;

deletefiles($file1,$file2,...)

delefiles(\@files)

Delete files

$rs->deletefiles(
    "476535874,34959483,94354533"    # File IDs, can also use an ARRAY REF
) or die $rs->errstr;

movefilestorealfolder($folderid, $file1, $file2, ....)

movefilestorealfolder($folderid, \@files)

Move files to a specified folder

$rs->movefilestorealfolder(
    "876453453",                     # Target Folder ID
    "476535874,34959483,94354533"    # File IDs, can also use an ARRAY REF
) or die $rs->errstr;

filemigrator(\%options)

Transfer files between accounts

my $response = $rs->filemigrator(
    fromtype     => 'col',           # Source accnt type
    fromlogin    => 'collector',     # Source accnt login
    frompassword => 'password',      # Source accnt password

    totype     => 'prem',            # Target account type
    tologin    => 'premium',         # Target account login
    topassword => 'passwd',          # Target account password

    fileids => [ '32524354', '423452345' ],    # File IDs.
) or die $rs->errstr;
my ($number_of_files_moved,     $files_in_src_accnt_before,
    $space_in_src_accnt_before, $files_in_tgt_accnt_before,
    $space_in_tgt_accnt_before, $files_in_src_accnt_after,
    $space_in_src_accnt_after,  $files_in_tgt_accnt_after,
    $space_in_tgt_accnt_after,
) = split( /,/, $response );

Returns a comma separated string with -

1:Number of moved files
2:Files in source account before action
3:Space in source account before action
4:Files in target account before action
5:Space in target account before action
6:Files in source account after action
7:Space in source account after action
8:Files in target account after action
9:Space in target account after action

Moving a linked list returns only #1 above.

Options:

fromtype: Source account type. free/col/prem
fromlogin, frompassword: Source account credentials. Not required if fromtype is free.
totype: Target account type. prem/col
tologin,topassword: Target account credentials
fileids: Array REF of file ids to move or '*' for all. Linked list ID if moving linked lists
linkedlists: set to '1' if moving a linked list
acceptfee: Set to '1' indicating that you have accepted the fee of 300 points which will be deducted from the target account. This call will fail unless accepted.

trafficsharetype($tstype, \@fileids)

Set the Traffic Share type (0=off 1=on 2=on with encryption 101=on with logging 102=on with logging and encryption)

$rs->trafficsharetype(
    '101',                                     # On with logging
    [ '87346543', '945934534' ]                # File IDs
) or die $rs->errstr;

checkfiles(\@fileids, \@filenames)

checkfiles(\@fileids, \@filenames, $md5)

Check if file exists on server and is downloadable. Returns a data structure containing each file's information. Also includes file MD5sums if $md5 is true.

my $response = $rs->checkfiles(
    [ '87463528345', '982736452345' ],         # File IDs
    ['name1, name2'],                          # Corresponding names
) or die $rs->errstr;
foreach ( keys %{$response} ) {
    my $id     = $_;
    my $status = $response->{$_}->{status};
    my $name   = $response->{$_}->{name};
    my $server = $response->{$_}->{server};
    my $mirror = $response->{$_}->{mirror};

    next if ($status eq '0' or $status eq '4');

    my $file_to_load =
        "http://rs${server}${mirror}.rapidshare.com/${id}/${name}";
}

The Status value can be -

0=File not found
1=File OK (Downloading possible without any logging)
2=File OK (TrafficShare direct download without any logging)
3=Server down
4=File marked as illegal
5=Anonymous file locked, because it has more than 10 downloads already
6=File OK (TrafficShare direct download with enabled logging. Read our privacy policy to see what is logged.)

Folders

addrealfolder($name)

addrealfolder($name, $parent)

Add a new Folder

$rs->addrealfolder(
    'newfolder',    # Folder Name
    '1'             # Parent ID, defaults to 0
) or die $rs->errstr;

moverealfolder($folderid, $parent)

Move a folder.

$rs->moverealfolder(
    '657634345',    # Folder ID
    '2',            # New Parent, defaults to 0
) or die $rs->errstr;

renamerealfolder($folderid, $newname)

Rename a Folder

$rs->renamerealfolder(
    '87365345',     # Folder ID
    'new name'      # New folder name
) or die $rs->errstr;

delrealfolder($folderid)

Delete a folder

$rs->delrealfolder(
    '87652'         # Folder ID
) or die $rs->errstr;

Logs

trafficsharelogs($fileid)

Get the traffic share logs for a file

my ( $start_time, $stop_time, $size, $starting_position, $bytes_downloaded,
    $range, $custom )
    = $rs->trafficsharelogs('fileid')
    or die $rs->errstr;

trafficsharebandwidth($start_time, $end_time)

Get the traffic share logs for you account

my (@rows) = $rs->trafficsharebandwidth( 'start_time', 'end_time' )
    or die $rs->errstr;
foreach (@rows) { my ( $timestamp, $kbps ) = split( /,/, $_ ); }

getpointlogs

Gets details about your earned RapidPoints

my @rows = $rs->getpointlogs or die $rs->errstr;
foreach (@rows) {
    my ( $date, $free_points, $prem_points ) = split( /,/, $_ );
}

getreferrerlogs

Gets details about your earned Referrer Points

my @rows = $rs->getreferrerlogs or die $rs->errstr;
foreach (@rows) { my ( $timestamp, $refpoints, $fileid, $confirmed ) = split( /,/, $_ ); }

Link Lists

newlinklist(\%options)

Create a new Link List. Returns the link list ID

my $new_ll_id = $rs->newlinklist(
    name     => 'newlist',             # Name
    headline => 'my new link list',    # Headline
    nickname => 'll1',                 # Nickname
    password => 'secret',              # Password
) or die $rs->errstr;

newlinklistsubfolder(\%options)

Create a sub link list (sub folder). Returns the sub folder ID

my $new_sub_id = $rs->newlinklistsubfolder(
    folderid    => 'MJHG67',           # Parent link list ID
    name        => 'newsublist',       # Name
    description => 'new links',        # Description
    password    => 'secret',           # Password
) or die $rs->errstr;

copyfilestolinklist(\%options)

Add files to a link list

$rs->copyfilestolinklist(
    folderid => 'MJHG67',                       # Parent link list ID
    fileids => [ '73876221', '7876523523' ],    # File IDs
) or die $rs->errstr;

editlinklist(\%options)

Edit a link list

$rs->editlinklist(
    folderid => 'HDKS778',                      # Link list ID
    name     => 'newlist',                      # Name
    headline => 'my new link list',             # Headline
    nickname => 'll1',                          # Nickname
    password => 'secret',                       # Password
) or die $rs->errstr;

editlinklistentry(\%options)

Edit either a file or a sub folder in a link list

## Edit a file entry
$rs->editlinklistentry(
    folderid    => 'HFGSK87',                   # Link list ID
    fileid      => '876872345',                 # File ID
    description => 'hey, get this file',        # Description
) or die $rs->errstr;

Options -

folderid : The Link list ID that contains the entries

fileid : This can either be a file ID or a sub folder ID

description : Optional. Description will be applied to the fileid

password : Optional. Secure a sub folder with the password. This option is invalid when fileid is a file and not a sub folder

getlinklist

getlinklist(\%options)

Get a listing of all of your link lists and (optionally) all link list entries. Returns a Data structure with each entry's details

my $lists = $rs->getlinklist or die $rs->errstr;
my @ids = keys %{$lists};
foreach my $id (@ids) {
    my $name     = $list->{$id}->{name};
    my $headline = $list->{$id}->{headline};
}

Options -

folderid : When provided with a folder ID, the returned list will contain the following details all entries in that link list.

'subfolderid'   The sub folder ID. '0' means root
'fileid'        File ID or Sub folder ID
'name'          Name
'size'          Size
'description'   Description
'addtime'       Time entry was added (UNIX)

showsubs : When set to true, the returned data structure will return all of the link lists as well as all entries within those lists. This cannot be used with folderid. The following details are returned for each link list

'subfolderid'   The sub folder ID. '0' means root
'name'          File or Sub folder Name
'headline'      Headline
'views'         Number of views
'lastview'      Last viewed time (UNIX)
'password'      Password
'nickname'      Nickname

deletelinklistentries(\%options)

Delete file or sub folder entries

$rs->deletelinklistentries(
    folderid => 'HHSKL76',                      # Link list ID
    fileids => [ '73876221', '7876523523' ],    # File IDs to delete
) or die $rs->errstr;

fileids can be sub folder IDs as well.

deletelinklist($linklistid)

Delete a link list

$rs->deletelinklist('JHSDS7') or die $rs->errstr;

Rewards

getreward

Get details of your active reward. Only one reward can be active at a time on your account.

my (
$reward_id,		# Reward ID
$time,			# Unix timestamp when ordered
$email,			# Email used at time of ordering
$active_ppr,	# Active PPointRate
$data			# Data needed to deliver reward. Used by setreward
) = $rs->getreward() or die $rs->errstr;

setreward($reward_id, $reward_data)

Saves details about your ordered RapidShare reward

$rs->setreward($reward_id, $reward_data) or die $rs->errstr;

ERROR HANDLING

All methods return 'undef' and set $obj->errstr on errors. The $obj->errstr will also contain any errors reported by Rapidshare.

DEPENDENCIES

LWP::UserAgent

HTML::Entities

SUPPORT

Please report any bugs or feature requests at http://github.com/mithun/perl-net-rapidshare/issues

AUTHOR

Mithun Ayachit <mithun at cpan dot org>

LICENCE AND COPYRIGHT

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

To install Net::Rapidshare, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Net::Rapidshare

CPAN shell

perl -MCPAN -e shell
install Net::Rapidshare

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)