Most recent edit on 2008-06-06 21:10:05 by MatthewToseland [link]

Additions:
<td>See <a href="EarlyEncode">EarlyEncode</a></td>

Deletions:
<td>See EarlyEncode</td>

---

Edited on 2008-06-06 21:09:17 by MatthewToseland [link]

Additions:
<td>See EarlyEncode</td>

Deletions:
<td>Whether to aggressively encode the file's data in order to produce a key earlier (way before it would be fetchable; not generally recommended but useful for testing).</td>

---

Edited on 2007-07-14 19:26:27 by NextGens [#1535: Remove all references to KSK@gpl.txt on the website]

Additions:
<td>This is an existing freenet URI such as <span style="color:green">KSK@sample.txt</span>. The idea is that you insert a new key that redirects to this one.</td>

Deletions:
<td>This is an existing freenet URI such as <span style="color:green">KSK@gpl.txt</span>. The idea is that you insert a new key that redirects to this one.</td>

---

Edited on 2007-05-29 19:25:35 by MatthewToseland [fix link]

Additions:
<td>If true, insert a <a href="BinaryBlobs">binary blob</a> (a collection of keys used in the downloading of a specific key or site). Implies no metadata, no URI.</td>

Deletions:
<td>If true, insert a binary blob (a collection of keys used in the downloading of a specific key or site). Implies no metadata, no URI.</td>

---

Edited on 2007-05-29 19:24:53 by MatthewToseland [BinaryBlob]

Additions:
BinaryBlob=false
<td>BinaryBlob</td>
<td>If true, insert a binary blob (a collection of keys used in the downloading of a specific key or site). Implies no metadata, no URI.</td>

---

Edited on 2007-04-18 12:55:38 by MatthewToseland [Identifier not ClientToken in FileHash]

Additions:
<td>This field will allow you to override any TestDDA restriction if you provide a hash of the content which should be inserted. It should be computed like that : Base64Encode(SHA256( NodeHello.identifier + '-' + Identifier + '-' + content)). That setting has been introduced in 1027.</td>

Deletions:
<td>This field will allow you to override any TestDDA restriction if you provide a hash of the content which should be inserted. It should be computed like that : Base64Encode(SHA256( NodeHello.identifier + '-' + ClientToken + '-' + content)). That setting has been introduced in 1027.</td>

---

Edited on 2007-04-14 20:43:32 by NextGens [add a delimiter]

Additions:
<td>This field will allow you to override any TestDDA restriction if you provide a hash of the content which should be inserted. It should be computed like that : Base64Encode(SHA256( NodeHello.identifier + '-' + ClientToken + '-' + content)). That setting has been introduced in 1027.</td>

Deletions:
<td>This field will allow you to override any TestDDA restriction if you provide a hash of the content which should be inserted. It should be computed like that : Base64Encode(SHA256( NodeHello.identifier + ClientToken + content)). That setting has been introduced in 1027.</td>

---

Edited on 2007-04-14 19:23:06 by NextGens [Add FileHash]

Additions:
FileHash=Base64String
<td>FileHash</td>
<td align="left">a Base64 encoded SHA256 hash of the content you want the node to insert (only useful if you use UploadFrom=disk)</td>
<td>This field will allow you to override any TestDDA restriction if you provide a hash of the content which should be inserted. It should be computed like that : Base64Encode(SHA256( NodeHello.identifier + ClientToken + content)). That setting has been introduced in 1027.</td>

---

Edited on 2007-04-13 21:41:34 by NextGens [fix the link]

Additions:
<td>Whether the FCP message includes the actual data, just the disk filename and path, or a redirection to an existing freenet key. If you upload from disk, you have to do a <a href="FCP2p0TestDDARequest"> TestDDARequest</a>.</td>

Deletions:
<td>Whether the FCP message includes the actual data, just the disk filename and path, or a redirection to an existing freenet key. If you upload from disk, you have to do a TestDDARequest .</td>

---

Edited on 2007-04-13 21:39:00 by NextGens [add a note for testDDA]

Additions:
<td>Whether the FCP message includes the actual data, just the disk filename and path, or a redirection to an existing freenet key. If you upload from disk, you have to do a TestDDARequest .</td>

Deletions:
<td>Whether the FCP message includes the actual data, just the disk filename and path, or a redirection to an existing freenet key</td>

---

Edited on 2007-03-30 00:31:57 by AlexLehm

Additions:
<td>Indicates the end of the message. If UploadFrom is <span style="color:green">direct</span>, then the data follows this line. (Immediately after the newline).</td>

Deletions:
<td>Indicates the end of the message. If UploadFrom is <span style="color:green">direct</span>, then the data follows this line. (Immediately after the newline).</td>

---

Edited on 2006-11-08 18:37:00 by MatthewToseland [point to SingleFileManifests page]

Additions:
A filename may be specified using the TargetFilename option. This is mostly useful with CHKs. The effect is to create a single file manifest which contains only the filename given, and points to the data just inserted. Thus the provided filename becomes the last part of the URI, and must be provided when fetching the data. See here for details.

Deletions:
A filename may be specified using the TargetFilename option. This is mostly useful with CHKs. The effect is to create a single file manifest which contains only the filename given, and points to the data just inserted. Thus the provided filename becomes the last part of the URI. The data must be fetched using the filename. So you might insert a file as CHK@ with TargetFilename set to "test.html", and the node would return in a GeneratedURI message a URI of CHK@blah,blah,blah/test.html. Note that adding arbitrary strings to freenet URIs is not permitted. (It works at present but not for much longer). This is to make freenet URIs behave like other kinds of URIs.

---

Edited on 2006-11-08 18:31:27 by MatthewToseland [explaining single file manifests]

Additions:
A filename may be specified using the TargetFilename option. This is mostly useful with CHKs. The effect is to create a single file manifest which contains only the filename given, and points to the data just inserted. Thus the provided filename becomes the last part of the URI. The data must be fetched using the filename. So you might insert a file as CHK@ with TargetFilename set to "test.html", and the node would return in a GeneratedURI message a URI of CHK@blah,blah,blah/test.html. Note that adding arbitrary strings to freenet URIs is not permitted. (It works at present but not for much longer). This is to make freenet URIs behave like other kinds of URIs.

Deletions:
A filename may be specified using the TargetFilename option. This is mostly useful with CHKs. The effect is to create a single file manifest which contains only the filename given, and points to the data just inserted. This must be fetched using the filename specified.

---

Edited on 2006-11-08 18:28:47 by MatthewToseland

Additions:
A filename may be specified using the TargetFilename option. This is mostly useful with CHKs. The effect is to create a single file manifest which contains only the filename given, and points to the data just inserted. This must be fetched using the filename specified.

Deletions:
A filename may be specified using the TargetFilename option. This is mostly useful with CHKs. The effect is to create a single file manifest which contains only the filename given, and points to the data just inserted. This must be fetched using the filename specified.

---

Edited on 2006-11-08 18:28:34 by MatthewToseland

Additions:
It is used to specify an insert into Freenet of a single file. This may be provided by referring to a file on disk, including the data directly, or redirecting to another key.
A filename may be specified using the TargetFilename option. This is mostly useful with CHKs. The effect is to create a single file manifest which contains only the filename given, and points to the data just inserted. This must be fetched using the filename specified.

Deletions:
It is used to specify an insert into Freenet of either a file, some directly included data, or a redirection.

---

Edited on 2006-10-04 20:01:45 by MatthewToseland [hmmm maybe the old way was better? fix for now...]

Additions:
<td>Indicates the end of the message. If UploadFrom is <span style="color:green">direct</span>, then the data follows this line. (Immediately after the newline).</td>

Deletions:
<td>Data</td>
<td align="left">No value</td>
<td>Marks the start of the data. The actual data follows immediately after this line.</td>
<td>Indicates the end of the message. Required in all cases. DataLength determines the length of the trailing field, <b>not</b> the length of the message itself. Note that this can in fact be indicated by any string not including "=" or a newline (CR, LF, or CRLF).</td>

---

Edited on 2006-10-04 19:59:46 by MatthewToseland [style]

Deletions:
<td align="left">True or false</td>

---

Edited on 2006-10-04 19:58:27 by MatthewToseland [put spacer in]

Additions:
<td colspan="5"></td>

---

Edited on 2006-10-04 19:57:51 by MatthewToseland [fix EndMessage]

Additions:
<td>Indicates the end of the message. Required in all cases. DataLength determines the length of the trailing field, <b>not</b> the length of the message itself. Note that this can in fact be indicated by any string not including "=" or a newline (CR, LF, or CRLF).</td>

Deletions:
<td colspan="5">Only valid if UploadFrom is <span style="color:green">redirect</span> or <span style="color:green">disk</span>:</td>
<td>Indicates the end of the message. Note that this is not required when UploadFrom=direct, since the message end is determined by
the DataLength field.</td>

---

Oldest known version of this page was edited on 2006-10-04 19:56:15 by MatthewToseland []

ClientPut

This is a message of the Freenet Client Protocol 2.0 (FCP 2.0).
It is sent from a client program to the Freenet node.

It is used to specify an insert into Freenet of either a file, some directly included data, or a redirection.

Example

Field	Possible values	Mandatory?	Default	Description
URI	CHK@ KSK@name SSK@privateKey/docname-1 USK@privateKey/docname/0/	Yes		The type of key to insert. When inserting an SSK key, you explicitly specifiy the version number. For a USK key, use a zero and it should automatically use the correct version number.
Metadata.ContentType	Any MIME type	No	application/octet-stream	The MIME type of the data being inserted. For text, if charset is not specified, node should auto-detect it and force the auto-detected version
Identifier	Arbitrary text string	Yes		This is just for client to be able to identify files that have been inserted.
Verbosity	Bitmask. At present only bits 1 and 512 are supported.	No	0	0: report when complete, 1: SimpleProgress messages, 512: send StartedCompression and FinishedCompression messages
MaxRetries	Integer -1 to 999999+?	No	?	Number of times to retry if the first time doesn't work. -1 means retry forever.
PriorityClass	Number 0 (maximum priority) to 6 (minimum priority)	No	2 (Semi-interactive priority class)	How to prioritise the insert.
GetCHKOnly	false, true	No	false	If set to true, it won't actually insert the data, just return the key it would generate. If the key is USK, you may want to transform it into a SSK, to prevent the node spending time searching for an unused index.
Global	true, false	No	false	Whether the insert is visible on the global queue or not.
DontCompress	true, false	No		Hint to node: don't try to compress the data, it's already compressed
ClientToken	Arbitrary string	No		Sent back to client on the PersistentPut if this is a persistent request
Persistence	connection, reboot, forever	No	connection	Whether the insert stays on the queue across new client connections, freenet restarts, or forever
TargetFilename	A filename (no slashes)	No	Extracted from URI or Filename	Filename to be appended to a CHK insert. Technically it creates a one-file manifest with this filename pointing to the file being uploaded. Ignored for all types other than CHK, since other types have human-readable filenames anyway. Empty means no filename.
EarlyEncode	True or false	No	False	Whether to aggressively encode the file's data in order to produce a key earlier (way before it would be fetchable; not generally recommended but useful for testing).
UploadFrom	direct, disk, redirect	No	direct	Whether the FCP message includes the actual data, just the disk filename and path, or a redirection to an existing freenet key
Only valid if UploadFrom is direct:
DataLength	Integer from 0 to ?	Yes		The length of the data file being included in this FCP message
Data	No value	Yes		Marks the start of the data. The actual data follows immediately after this line.
Only valid if UploadFrom is disk:
Filename	The full path of a file	Yes		The full name and path of the file you wish to insert to Freenet
Only valid if UploadFrom is redirect:
TargetURI	A freenet URI	Yes		This is an existing freenet URI such as KSK@gpl.txt. The idea is that you insert a new key that redirects to this one.
Only valid if UploadFrom is redirect or disk:
EndMessage				Indicates the end of the message. Note that this is not required when UploadFrom=direct, since the message end is determined by the DataLength field.