AMule Project FAQ - User contributions [en]

Hash

2006-12-22T20:19:38Z

212.238.218.165: fxs

<center>'''English''' | [[Hash-hu|Magyar]] | [[Hash-es|Spanish]]
</center>

'''hashes''' are mathematical algorithms which generate a unique code for a piece of data. They are used to uniquely identify files or groups of data.

In the [[FAQ_ed2k|ed2k network]], the most commonly used type of hash is the [[MD4 hash]], although [http://www.faqs.org/rfcs/rfc3174.html SHA-1] hashes are also used.

Hash

2006-12-22T20:17:52Z

212.238.218.165: fxs

<center>'''English''' | [[Hash-hu|Magyar]] | [[Hash-es|Spanish]]
</center>

A '''hash''' is mathematical algorithms which generate a unique code for a file. They are used to uniquely identify data or groups of data.

In the [[FAQ_ed2k|ed2k network]], the most commonly used type of hash is the [[MD4 hash]], although [http://www.faqs.org/rfcs/rfc3174.html SHA-1] hashes are also used.

ALinkCreator

2006-12-22T20:15:32Z

212.238.218.165: expand a little

<center>
'''English''' | [[ALinkCreator-de|Deutsch]] | [[ALinkCreator-es|Spanish]]
</center>

'''ALinkCreator (ALC)''' is an application which will give you the [[ed2k link]] for files. It supports all of the ed2k links optional values and is very fast at [[hash]]ing files.

There are two versions of ALinkCreator: the GUI version (windowed-style interface) named "alc", and the command line version (text-only interface) named "[[aLinkCreatorConsole|alcc]]".

=== Installing ALinkCreator ===

Many of not most distros have an aMule package in their repositories. If you install aMule by means of RPM, DEB, or other package management system, ALinkCreator will be included in the installation.

This is the easiest and preferred method of installing ALinkCreator.

=== Compiling ALinkCreator ===

If you have not installed aMule by means of a package, you will need to compile it from source.

ALinkCreator is not compiled separately; it is compiled at the same time you compile aMule by using the --enable-alc flag when you run configure. (See the [[Main Page]] for links to pages on compiling aMule for various operating systems).

User:Colin

2006-12-22T03:16:53Z

212.238.218.165: awk ver

Satisfied amule user since September 2004.
----
I am also known as '''ezeltje''' in the forum (''ezel'' means "mule" in Dutch, in case anyone is wondering).

Things I have done there:

* created the [[Events]] pages with the example script
* reorganized [[AMuleWeb]] and rewrote the intro
* expanded [[AMuleCMD]]

and other smaller fixes elsewhere...

---

== amuleCVSfx ==

Here is a simple script to remove the obligatory command-line parameter you need to use to run aMule CVS:

<pre>
#!/bin/bash
#
# This script removes from the source code the arbitrary command-line parameter
# required to launch aMule CVS.
# Run it in the ../amule-cvs directory. It will make a backup of the original file.
#
FileIn=src/amule.cpp
FileOut=_^$$.tmp
[ -e $FileOut ] && rm -f $FileOut
awk < "$FileIn" > "$FileOut" '
Found < 1 && /.!cmdline\.Found/ {
n = 4
print "// ------ Commented out by amuleCVSfx ------"
Found = 1
}
n > 0 {
$0 = "// " $0
n--
}
{print}'
mv -f $FileIn $FileIn~ 2>&1
mv -f $FileOut $FileIn 2>&1
# end

</pre>
You can view the changes with this command:
<pre>
$ diff -b --side-by-side --suppress-common-lines src/amule.cpp src/amule.cpp~
</pre>

Events

2006-12-01T15:57:41Z

212.238.218.165: fxs

'''Events''' are actions aMule can take upon when certain things happen. This actions can be configured on the Events tab of the [[Preferences]] notebook.

There are two kinds of Events supported at the moment:
* Download completed
* New chat session

When one of these events is triggered, you can configure aMule to execute a
* core command
* GUI command

=== Download completed ===

When a Download completed event is triggered, four variables can be accessed:
* %NAME - the name of the downloaded file with full path
* %FILE - the name of the downloaded file without path
* %HASH - the ed2k hash of the downloaded file
* %SIZE - the size in bytes of the downloaded file

=== New chat session ===

When a New chat session event is triggered, one variable can be accessed:
* %Sender - username of the person initiating the chat

=== Syntax ===

To call an external script, enter the script name in the core command field, followed by the optional variables. For example:

:MyScript.sh %NAME %FILE %HASH %SIZE

'''Note:''' If the filename contains spaces, the variable names should be enclosed in quotes like this:

:MyScript.sh "%NAME" "%FILE" %HASH %SIZE

You need to make sure your script in your PATH or that you supply the pathname.

== Examples ==
Here is a bash script which will send you an email every time a download is completed. To use it, enter your email address where indicated and save it to a location in your PATH. Then add this line:

:doneDL.sh "%NAME" "%FILE" %HASH %SIZE

to the Core command field of the Download completed section of the Events page. It will now be invoked everytime aMule finishes a download.

#!/bin/bash
#
# doneDL.sh - sends an email upon completion of an aMule download
# Used in conjuction with aMule's Event feature
#
# Call like this: doneDL.sh "%NAME" "%FILE" %HASH %SIZE
#
# Enter your email address here:
eMail=
#
NameShort=$1
NameLong=$2
Hash=$3
Size=$4
{
echo aMule completed this download:
echo ------------------------------
echo
echo File: "$NameLong"
echo Hash: $Hash
echo -n "Time: "
date | awk '{print $4 " " $5}'
echo -n Size: $Size bytes
if [ $Size -gt 102400 ] ; then echo " ("$(($(($Size / 1024)) / 1024)) "Mb)" ; fi
echo
echo --------------------------------------------------------------------
cas
echo -n "Resident memory: "
echo $(ps u -C amule --no-headers | awk '{print $6}') kB
echo -n "Virtual memory: "
echo $(ps u -C amule --no-headers | awk '{print $5}') kB
echo --------------------------------------------------------------------
} | mail -s "$NameShort" $eMail

__NOTOC__

Events

2006-12-01T15:56:32Z

212.238.218.165: fxs

'''Events''' are actions aMule can take upon when certain things happen. This actions can be configured on the Events tab of the [[Preferences]] notebook.

There are two kinds of Events supported at the moment:
* Download completed
* New chat session

When one of these events is triggered, you can configure aMule to execute a
* core command
* GUI command

=== Download completed ===

When a Download completed event is triggered, four variables can be accessed:
* %NAME - the name of the downloaded file with full path
* %FILE - the name of the downloaded file without path
* %HASH - the ed2k hash of the downloaded file
* %SIZE - the size in bytes of the downloaded file

=== New chat session ===

When a New chat session event is triggered, one variable can be accessed:
* %Sender - username of the person initiating the chat

=== Syntax ===

To call an external script, enter the script name in the core command field, followed by the optional variables. For example:

:MyScript.sh %NAME %FILE %HASH %SIZE

'''Note:''' If the filename contains spaces, the variable names should be enclosed in quotes like this:

:MyScript.sh "%NAME" "%FILE" %HASH %SIZE

You need to make sure your script in your PATH or that you supply the pathname.

== Examples ==
Here is a bash script which will send you an email every time a download is completed. To use it, enter your email address where indicated and save it to a location in your PATH. Then add this line:

:doneDL.sh "%NAME" "%FILE" %HASH %SIZE

to the Core command field of the Download completed section of the Events page. It will now be invoked everytime aMule finishes a download.

#!/bin/bash
#
# doneDL.sh - sends an email upon completion of an aMule download
# Used in conjuction with aMule's Event feature
#
# Call like this: doneDL.sh "%NAME" "%FILE" %HASH %SIZE
#
# Enter your email address here:
eMail=
#
NameShort=$1
NameLong=$2
Hash=$3
Size=$4
{
echo aMule completed this download:
echo ------------------------------
echo
echo File: "$NameLong"
echo Hash: $Hash
echo -n "Time: "
date | awk '{print $4 " " $5}'
echo Size: $Size bytes "("$(($(($Size / 1024)) / 1024)) "Mb)"
echo
echo --------------------------------------------------------------------
cas
echo -n "Resident memory: "
echo $(ps u -C amule --no-headers | awk '{print $5}') kB
echo -n "Virtual memory: "
echo $(ps u -C amule --no-headers | awk '{print $6}') kB
echo --------------------------------------------------------------------
} | mail -s "$NameShort" $eMail

__NOTOC__

Webcache

2005-02-09T14:32:03Z

212.238.218.165: copyedit english

== Description ==

The idea of webcache is to upload the shared data into an ISP proxy and leave it there for other [[client]]s to download.

The description of the scheme can be found with full details in the [http://forum.emule-project.net/index.php?showtopic=14768 original post]. Plus, there are lot's of additional documentation pages all around the net; [http://www.google.com Google] is your friend ;)

== History ==

The idea began on 13 April 2003 at [http://forum.emule-project.net eMule's forums] when [mailto:sufcrusher@zonnet.nl sufcrusher] posted [http://forum.emule-project.net/index.php?showtopic=14768 this post]. The history can be followed there up to the first [[eMule]] mods implementing it.

== Pros and cons ==

=== Pros ===

* The most evident pro, and the main purpose of it, is that web proxies have a lot of bandwidth and very high speed so the data sharing speeds should be greatly boosted.

* Also, [[P2P]] [[client]]s generate heavy traffic on ISPs since they open and close lots of connections in very little time and send/receive large amounts of data. Using webcache would stop these connections from going through the ISPs since they would only get to the ISPs' proxies.

=== Cons ===

* Since all your data (or some of it) would pass through your ISP's proxy, your ISP would know what you are sharing, so your privacy would suffer greatly.

* It is not clear whether using ISPs' web proxies for things other than web data is legal. Even if it was in your country, legislation are different from state to state, so [[client]]s try to conform to the broadest possible range of legislation to keep their users from having unpleasant experiencies with the law. Also, allthough the webcache feature might be better for your ISP, it can be bad if the traffic is too high, so you might have your ISP breaking the contract with you and leaving you without connection.

* Like it or not, webcache at large scale becomes a DDoS to the ISP's http cache servers. The ISPs' clients will notice a worse quality of the service, and ISPs will blame the webcache, being right. What's worse: [[P2P]] developers that support webcache could be sued for developing DDoS tools and invite people to use it, ISPs can say they are losing clients because of the quality the lost in their services, and so, [[P2P]] developer teams could have big problems.

* The [[P2P]] networks are being heavily tracked by some governments since they believe they are used for illegal purposes. There is a popular saying: "if it works, don't touch it". Well, that applies it here.

== Implementing webcache ==

There are already some [[client]]s out there supporting webcache. Most of them are [[eMule]] mods. We do '''NOT''' recommend using them. These mods bring down the [[P2P]] reputation and by using them you contribute in doing so.

== Regarding [[aMule]] ==

Discussions about implementing webcache feature into [[aMule]] have appeared many times in [http://forum.amule.org aMule's forums] although maybe the most relevant is [http://www.amule-project.net/amule/thread.php?threadid=3513 this one].

Anyway, until further (and highly unlikely) news, neither [[aMule]] nor [[eMule]] are going to officially support webcache in any future release.