1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
|
package api
// TODO: When setting renter settings, leave empty values unchanged instead of
// zeroing them out.
import (
"fmt"
"net/http"
"path/filepath"
"sort"
"strings"
"time"
"github.com/NebulousLabs/Sia/build"
"github.com/NebulousLabs/Sia/modules"
"github.com/NebulousLabs/Sia/modules/renter"
"github.com/NebulousLabs/Sia/types"
"github.com/julienschmidt/httprouter"
)
var (
// recommendedHosts is the number of hosts that the renter will form
// contracts with if the value is not specified explicitly in the call to
// SetSettings.
recommendedHosts = build.Select(build.Var{
Standard: uint64(50),
Dev: uint64(2),
Testing: uint64(1),
}).(uint64)
// requiredHosts specifies the minimum number of hosts that must be set in
// the renter settings for the renter settings to be valid. This minimum is
// there to prevent users from shooting themselves in the foot.
requiredHosts = build.Select(build.Var{
Standard: uint64(20),
Dev: uint64(1),
Testing: uint64(1),
}).(uint64)
// requiredParityPieces specifies the minimum number of parity pieces that
// must be used when uploading a file. This minimum exists to prevent users
// from shooting themselves in the foot.
requiredParityPieces = build.Select(build.Var{
Standard: int(12),
Dev: int(0),
Testing: int(0),
}).(int)
// requiredRedundancy specifies the minimum redundancy that will be
// accepted by the renter when uploading a file. This minimum exists to
// prevent users from shooting themselves in the foot.
requiredRedundancy = build.Select(build.Var{
Standard: float64(2),
Dev: float64(1),
Testing: float64(1),
}).(float64)
// requiredRenewWindow establishes the minimum allowed renew window for the
// renter settings. This minimum is here to prevent users from shooting
// themselves in the foot.
requiredRenewWindow = build.Select(build.Var{
Standard: types.BlockHeight(288),
Dev: types.BlockHeight(1),
Testing: types.BlockHeight(1),
}).(types.BlockHeight)
)
type (
// RenterGET contains various renter metrics.
RenterGET struct {
Settings modules.RenterSettings `json:"settings"`
FinancialMetrics RenterFinancialMetrics `json:"financialmetrics"`
CurrentPeriod types.BlockHeight `json:"currentperiod"`
}
// RenterFinancialMetrics contains metrics about how much the Renter has
// spent on storage, uploads, and downloads.
RenterFinancialMetrics struct {
// Amount of money in the allowance spent on file contracts including
// fees.
ContractSpending types.Currency `json:"contractspending"`
DownloadSpending types.Currency `json:"downloadspending"`
StorageSpending types.Currency `json:"storagespending"`
UploadSpending types.Currency `json:"uploadspending"`
// Amount of money in the allowance that has not been spent.
Unspent types.Currency `json:"unspent"`
}
// RenterContract represents a contract formed by the renter.
RenterContract struct {
// Amount of contract funds that have been spent on downloads.
DownloadSpending types.Currency `json:"downloadspending"`
// Block height that the file contract ends on.
EndHeight types.BlockHeight `json:"endheight"`
// Fees paid in order to form the file contract.
Fees types.Currency `json:"fees"`
// Public key of the host the contract was formed with.
HostPublicKey types.SiaPublicKey `json:"hostpublickey"`
// ID of the file contract.
ID types.FileContractID `json:"id"`
// A signed transaction containing the most recent contract revision.
LastTransaction types.Transaction `json:"lasttransaction"`
// Address of the host the file contract was formed with.
NetAddress modules.NetAddress `json:"netaddress"`
// Remaining funds left for the renter to spend on uploads & downloads.
RenterFunds types.Currency `json:"renterfunds"`
// Size of the file contract, which is typically equal to the number of
// bytes that have been uploaded to the host.
Size uint64 `json:"size"`
// Block height that the file contract began on.
StartHeight types.BlockHeight `json:"startheight"`
// Amount of contract funds that have been spent on storage.
StorageSpending types.Currency `json:"StorageSpending"`
// Total cost to the wallet of forming the file contract.
TotalCost types.Currency `json:"totalcost"`
// Amount of contract funds that have been spent on uploads.
UploadSpending types.Currency `json:"uploadspending"`
}
// RenterContracts contains the renter's contracts.
RenterContracts struct {
Contracts []RenterContract `json:"contracts"`
}
// DownloadQueue contains the renter's download queue.
RenterDownloadQueue struct {
Downloads []DownloadInfo `json:"downloads"`
}
// RenterFiles lists the files known to the renter.
RenterFiles struct {
Files []modules.FileInfo `json:"files"`
}
// RenterLoad lists files that were loaded into the renter.
RenterLoad struct {
FilesAdded []string `json:"filesadded"`
}
// RenterPricesGET lists the data that is returned when a GET call is made
// to /renter/prices.
RenterPricesGET struct {
modules.RenterPriceEstimation
}
// RenterShareASCII contains an ASCII-encoded .sia file.
RenterShareASCII struct {
ASCIIsia string `json:"asciisia"`
}
// DownloadInfo contains all client-facing information of a file.
DownloadInfo struct {
SiaPath string `json:"siapath"`
Destination string `json:"destination"`
Filesize uint64 `json:"filesize"`
Received uint64 `json:"received"`
StartTime time.Time `json:"starttime"`
Error string `json:"error"`
}
)
// renterHandlerGET handles the API call to /renter.
func (api *API) renterHandlerGET(w http.ResponseWriter, req *http.Request, _ httprouter.Params) {
settings := api.renter.Settings()
periodStart := api.renter.CurrentPeriod()
// calculate financial metrics from contracts. We use the special
// AllContracts method to include contracts that are offline.
var fm RenterFinancialMetrics
fm.Unspent = settings.Allowance.Funds
contracts := api.renter.(interface {
AllContracts() []modules.RenterContract
}).AllContracts()
for _, c := range contracts {
if c.StartHeight < periodStart {
continue
}
fm.ContractSpending = fm.ContractSpending.Add(c.TotalCost)
fm.DownloadSpending = fm.DownloadSpending.Add(c.DownloadSpending)
fm.UploadSpending = fm.UploadSpending.Add(c.UploadSpending)
fm.StorageSpending = fm.StorageSpending.Add(c.StorageSpending)
// total unspent is:
// allowance - (cost to form contracts) + (money left in contracts)
if fm.Unspent.Add(c.RenterFunds()).Cmp(c.TotalCost) > 0 {
fm.Unspent = fm.Unspent.Add(c.RenterFunds()).Sub(c.TotalCost)
}
}
WriteJSON(w, RenterGET{
Settings: settings,
FinancialMetrics: fm,
CurrentPeriod: periodStart,
})
}
// renterHandlerPOST handles the API call to set the Renter's settings.
func (api *API) renterHandlerPOST(w http.ResponseWriter, req *http.Request, _ httprouter.Params) {
// Scan the allowance amount.
funds, ok := scanAmount(req.FormValue("funds"))
if !ok {
WriteError(w, Error{"unable to parse funds"}, http.StatusBadRequest)
return
}
// Scan the number of hosts to use. (optional parameter)
var hosts uint64
if req.FormValue("hosts") != "" {
_, err := fmt.Sscan(req.FormValue("hosts"), &hosts)
if err != nil {
WriteError(w, Error{"unable to parse hosts: " + err.Error()}, http.StatusBadRequest)
return
}
if hosts != 0 && hosts < requiredHosts {
WriteError(w, Error{fmt.Sprintf("insufficient number of hosts, need at least %v but have %v", recommendedHosts, hosts)}, http.StatusBadRequest)
return
}
} else {
hosts = recommendedHosts
}
// Scan the period.
var period types.BlockHeight
_, err := fmt.Sscan(req.FormValue("period"), &period)
if err != nil {
WriteError(w, Error{"unable to parse period: " + err.Error()}, http.StatusBadRequest)
return
}
// Scan the renew window. (optional parameter)
var renewWindow types.BlockHeight
if req.FormValue("renewwindow") != "" {
_, err = fmt.Sscan(req.FormValue("renewwindow"), &renewWindow)
if err != nil {
WriteError(w, Error{"unable to parse renewwindow: " + err.Error()}, http.StatusBadRequest)
return
}
if renewWindow != 0 && renewWindow < requiredRenewWindow {
WriteError(w, Error{fmt.Sprintf("renew window is too small, must be at least %v blocks but have %v blocks", requiredRenewWindow, renewWindow)}, http.StatusBadRequest)
return
}
} else {
renewWindow = period / 2
}
// Set the settings in the renter.
err = api.renter.SetSettings(modules.RenterSettings{
Allowance: modules.Allowance{
Funds: funds,
Hosts: hosts,
Period: period,
RenewWindow: renewWindow,
},
})
if err != nil {
WriteError(w, Error{err.Error()}, http.StatusBadRequest)
return
}
WriteSuccess(w)
}
// renterContractsHandler handles the API call to request the Renter's contracts.
func (api *API) renterContractsHandler(w http.ResponseWriter, _ *http.Request, _ httprouter.Params) {
contracts := []RenterContract{}
for _, c := range api.renter.Contracts() {
contracts = append(contracts, RenterContract{
DownloadSpending: c.DownloadSpending,
EndHeight: c.EndHeight(),
Fees: c.TxnFee.Add(c.SiafundFee).Add(c.ContractFee),
HostPublicKey: c.HostPublicKey,
ID: c.ID,
LastTransaction: c.LastRevisionTxn,
NetAddress: c.NetAddress,
RenterFunds: c.RenterFunds(),
Size: c.LastRevision.NewFileSize,
StartHeight: c.StartHeight,
StorageSpending: c.StorageSpending,
TotalCost: c.TotalCost,
UploadSpending: c.UploadSpending,
})
}
WriteJSON(w, RenterContracts{
Contracts: contracts,
})
}
// renterDownloadsHandler handles the API call to request the download queue.
func (api *API) renterDownloadsHandler(w http.ResponseWriter, _ *http.Request, _ httprouter.Params) {
var downloads []DownloadInfo
for _, d := range api.renter.DownloadQueue() {
downloads = append(downloads, DownloadInfo{
SiaPath: d.SiaPath,
Destination: d.Destination.Destination(),
Filesize: d.Filesize,
StartTime: d.StartTime,
Received: d.Received,
Error: d.Error,
})
}
// sort the downloads by newest first
sort.Slice(downloads, func(i, j int) bool { return downloads[i].StartTime.After(downloads[j].StartTime) })
WriteJSON(w, RenterDownloadQueue{
Downloads: downloads,
})
}
// renterLoadHandler handles the API call to load a '.sia' file.
func (api *API) renterLoadHandler(w http.ResponseWriter, req *http.Request, _ httprouter.Params) {
source := req.FormValue("source")
if !filepath.IsAbs(source) {
WriteError(w, Error{"source must be an absolute path"}, http.StatusBadRequest)
return
}
files, err := api.renter.LoadSharedFiles(source)
if err != nil {
WriteError(w, Error{err.Error()}, http.StatusBadRequest)
return
}
WriteJSON(w, RenterLoad{FilesAdded: files})
}
// renterLoadAsciiHandler handles the API call to load a '.sia' file
// in ASCII form.
func (api *API) renterLoadAsciiHandler(w http.ResponseWriter, req *http.Request, _ httprouter.Params) {
files, err := api.renter.LoadSharedFilesAscii(req.FormValue("asciisia"))
if err != nil {
WriteError(w, Error{err.Error()}, http.StatusBadRequest)
return
}
WriteJSON(w, RenterLoad{FilesAdded: files})
}
// renterRenameHandler handles the API call to rename a file entry in the
// renter.
func (api *API) renterRenameHandler(w http.ResponseWriter, req *http.Request, ps httprouter.Params) {
err := api.renter.RenameFile(strings.TrimPrefix(ps.ByName("siapath"), "/"), req.FormValue("newsiapath"))
if err != nil {
WriteError(w, Error{err.Error()}, http.StatusBadRequest)
return
}
WriteSuccess(w)
}
// renterFilesHandler handles the API call to list all of the files.
func (api *API) renterFilesHandler(w http.ResponseWriter, req *http.Request, _ httprouter.Params) {
WriteJSON(w, RenterFiles{
Files: api.renter.FileList(),
})
}
// renterPricesHandler reports the expected costs of various actions given the
// renter settings and the set of available hosts.
func (api *API) renterPricesHandler(w http.ResponseWriter, req *http.Request, _ httprouter.Params) {
WriteJSON(w, RenterPricesGET{
RenterPriceEstimation: api.renter.PriceEstimation(),
})
}
// renterDeleteHandler handles the API call to delete a file entry from the
// renter.
func (api *API) renterDeleteHandler(w http.ResponseWriter, req *http.Request, ps httprouter.Params) {
err := api.renter.DeleteFile(strings.TrimPrefix(ps.ByName("siapath"), "/"))
if err != nil {
WriteError(w, Error{err.Error()}, http.StatusBadRequest)
return
}
WriteSuccess(w)
}
// renterDownloadHandler handles the API call to download a file.
func (api *API) renterDownloadHandler(w http.ResponseWriter, req *http.Request, ps httprouter.Params) {
params, err := parseDownloadParameters(w, req, ps)
if err != nil {
WriteError(w, Error{err.Error()}, http.StatusBadRequest)
return
}
if params.Async { // Create goroutine if `async` param set.
// check for errors for 5 seconds to catch validation errors (no file with
// that path, invalid parameters, insufficient hosts, etc)
errchan := make(chan error)
go func() {
errchan <- api.renter.Download(params)
}()
select {
case err = <-errchan:
if err != nil {
WriteError(w, Error{"download failed: " + err.Error()}, http.StatusInternalServerError)
return
}
case <-time.After(time.Millisecond * 100):
}
} else {
err := api.renter.Download(params)
if err != nil {
WriteError(w, Error{"download failed: " + err.Error()}, http.StatusInternalServerError)
return
}
}
if params.Httpwriter == nil {
// `httpresp=true` causes writes to w before this line is run, automatically
// adding `200 Status OK` code to response. Calling this results in a
// multiple calls to WriteHeaders() errors.
WriteSuccess(w)
return
}
}
// renterDownloadAsyncHandler handles the API call to download a file asynchronously.
func (api *API) renterDownloadAsyncHandler(w http.ResponseWriter, req *http.Request, ps httprouter.Params) {
req.ParseForm()
req.Form.Set("async", "true")
api.renterDownloadHandler(w, req, ps)
}
// parseDownloadParameters parses the download parameters passed to the
// /renter/download endpoint. Validation of these parameters is done by the
// renter.
func parseDownloadParameters(w http.ResponseWriter, req *http.Request, ps httprouter.Params) (modules.RenterDownloadParameters, error) {
destination := req.FormValue("destination")
// The offset and length in bytes.
offsetparam := req.FormValue("offset")
lengthparam := req.FormValue("length")
// Determines whether the response is written to response body.
httprespparam := req.FormValue("httpresp")
// Determines whether to return on completion of download or straight away.
// If httprespparam is present, this parameter is ignored.
asyncparam := req.FormValue("async")
// Parse the offset and length parameters.
var offset, length uint64
if len(offsetparam) > 0 {
_, err := fmt.Sscan(offsetparam, &offset)
if err != nil {
return modules.RenterDownloadParameters{}, build.ExtendErr("could not decode the offset as uint64: ", err)
}
}
if len(lengthparam) > 0 {
_, err := fmt.Sscan(lengthparam, &length)
if err != nil {
return modules.RenterDownloadParameters{}, build.ExtendErr("could not decode the offset as uint64: ", err)
}
}
// Parse the httpresp parameter.
httpresp, err := scanBool(httprespparam)
if err != nil {
return modules.RenterDownloadParameters{}, build.ExtendErr("httpresp parameter could not be parsed", err)
}
// Parse the async parameter.
async, err := scanBool(asyncparam)
if err != nil {
return modules.RenterDownloadParameters{}, build.ExtendErr("async parameter could not be parsed", err)
}
siapath := strings.TrimPrefix(ps.ByName("siapath"), "/") // Sia file name.
dp := modules.RenterDownloadParameters{
Destination: destination,
Async: async,
Length: length,
Offset: offset,
Siapath: siapath,
}
if httpresp {
dp.Httpwriter = w
}
return dp, nil
}
// renterShareHandler handles the API call to create a '.sia' file that
// shares a set of file.
func (api *API) renterShareHandler(w http.ResponseWriter, req *http.Request, ps httprouter.Params) {
destination := req.FormValue("destination")
// Check that the destination path is absolute.
if !filepath.IsAbs(destination) {
WriteError(w, Error{"destination must be an absolute path"}, http.StatusBadRequest)
return
}
err := api.renter.ShareFiles(strings.Split(req.FormValue("siapaths"), ","), destination)
if err != nil {
WriteError(w, Error{err.Error()}, http.StatusBadRequest)
return
}
WriteSuccess(w)
}
// renterShareAsciiHandler handles the API call to return a '.sia' file
// in ascii form.
func (api *API) renterShareAsciiHandler(w http.ResponseWriter, req *http.Request, ps httprouter.Params) {
ascii, err := api.renter.ShareFilesAscii(strings.Split(req.FormValue("siapaths"), ","))
if err != nil {
WriteError(w, Error{err.Error()}, http.StatusBadRequest)
return
}
WriteJSON(w, RenterShareASCII{
ASCIIsia: ascii,
})
}
// renterUploadHandler handles the API call to upload a file.
func (api *API) renterUploadHandler(w http.ResponseWriter, req *http.Request, ps httprouter.Params) {
source := req.FormValue("source")
if !filepath.IsAbs(source) {
WriteError(w, Error{"source must be an absolute path"}, http.StatusBadRequest)
return
}
// Check whether the erasure coding parameters have been supplied.
var ec modules.ErasureCoder
if req.FormValue("datapieces") != "" || req.FormValue("paritypieces") != "" {
// Check that both values have been supplied.
if req.FormValue("datapieces") == "" || req.FormValue("paritypieces") == "" {
WriteError(w, Error{"must provide both the datapieces paramaeter and the paritypieces parameter if specifying erasure coding parameters"}, http.StatusBadRequest)
return
}
// Parse the erasure coding parameters.
var dataPieces, parityPieces int
_, err := fmt.Sscan(req.FormValue("datapieces"), &dataPieces)
if err != nil {
WriteError(w, Error{"unable to read parameter 'datapieces': " + err.Error()}, http.StatusBadRequest)
return
}
_, err = fmt.Sscan(req.FormValue("paritypieces"), &parityPieces)
if err != nil {
WriteError(w, Error{"unable to read parameter 'paritypieces': " + err.Error()}, http.StatusBadRequest)
return
}
// Verify that sane values for parityPieces and redundancy are being
// supplied.
if parityPieces < requiredParityPieces {
WriteError(w, Error{fmt.Sprintf("a minimum of %v parity pieces is required, but %v parity pieces requested", parityPieces, requiredParityPieces)}, http.StatusBadRequest)
return
}
redundancy := float64(dataPieces+parityPieces) / float64(dataPieces)
if float64(dataPieces+parityPieces)/float64(dataPieces) < requiredRedundancy {
WriteError(w, Error{fmt.Sprintf("a redundancy of %.2f is required, but redundancy of %.2f supplied", redundancy, requiredRedundancy)}, http.StatusBadRequest)
return
}
// Create the erasure coder.
ec, err = renter.NewRSCode(dataPieces, parityPieces)
if err != nil {
WriteError(w, Error{"unable to encode file using the provided parameters: " + err.Error()}, http.StatusBadRequest)
return
}
}
// Call the renter to upload the file.
err := api.renter.Upload(modules.FileUploadParams{
Source: source,
SiaPath: strings.TrimPrefix(ps.ByName("siapath"), "/"),
ErasureCode: ec,
})
if err != nil {
WriteError(w, Error{"upload failed: " + err.Error()}, http.StatusInternalServerError)
return
}
WriteSuccess(w)
}
|