// The contents of this file are subject to the BOINC Public License // Version 1.0 (the "License"); you may not use this file except in // compliance with the License. You may obtain a copy of the License at // http://boinc.berkeley.edu/license_1.0.txt // // Software distributed under the License is distributed on an "AS IS" // basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the // License for the specific language governing rights and limitations // under the License. // // The Original Code is the Berkeley Open Infrastructure for Network Computing. // // The Initial Developer of the Original Code is the SETI@home project. // Portions created by the SETI@home project are Copyright (C) 2002 // University of California at Berkeley. All Rights Reserved. // // Contributor(s): // #include "windows_cpp.h" #include #include #include "client_state.h" #include "client_types.h" #include "error_numbers.h" #include "file_names.h" #include "md5_file.h" #include "parse.h" #include "util.h" #include "log_flags.h" #include "filesys.h" // PERS_FILE_XFER represents a persistent file transfer. // A set of URLs is given. // // For download, the object attempts to download the file // from any of the URLs. // If one fails or is not available, try another, // using an exponential backoff policy to avoid flooding servers. // // For upload, try to upload the file to the first URL; // if that fails try the others. PERS_FILE_XFER::PERS_FILE_XFER() { nretry = 0; first_request_time = time(0); next_request_time = first_request_time; time_so_far = 0; fip = NULL; fxp = NULL; } PERS_FILE_XFER::~PERS_FILE_XFER() { if (fip) { fip->pers_file_xfer = NULL; } } int PERS_FILE_XFER::init(FILE_INFO* f, bool is_file_upload) { fxp = NULL; fip = f; is_upload = is_file_upload; xfer_done = false; return 0; } // Try to start the file transfer associated with this persistent file transfer. // int PERS_FILE_XFER::start_xfer() { FILE_XFER *file_xfer; int retval; ScopeMessages scope_messages(log_messages, ClientMessages::DEBUG_FILE_XFER); // Decide whether to start a new file transfer // if (!gstate.start_new_file_xfer()) { return ERR_IDLE_PERIOD; } // Does the file exist already? this could happen for example if we are // downloading an application which exists from a previous installation, // or if we get the same input file (which is unlikely outside the beta // test microcosm) if (!is_upload) { char pathname[256]; get_pathname(fip, pathname); double existing_size = 0; if (!file_size(pathname, existing_size) && existing_size == fip->nbytes) { // file exists already and has the right size retval = verify_downloaded_file(pathname, *fip); if (!retval) { // signature and checksum match retval = fip->set_permissions(); fip->status = FILE_PRESENT; xfer_done = true; msg_printf( fip->project, MSG_INFO, "File %s exists already, skipping download", pathname); return retval; } } } // Create a new FILE_XFER object and initialize a // download or upload for the persistent file transfer // file_xfer = new FILE_XFER; if (gstate.use_http_proxy) { file_xfer->use_http_proxy = true; safe_strcpy(file_xfer->proxy_server_name, gstate.proxy_server_name); file_xfer->proxy_server_port = gstate.proxy_server_port; } if (is_upload) { if (gstate.exit_before_upload) { exit(0); } retval = file_xfer->init_upload(*fip); } else { retval = file_xfer->init_download(*fip); } if (retval) { msg_printf( fip->project, MSG_ERROR, "Couldn't start %s for %s: error %d", (is_upload ? "upload" : "download"), fip->get_url(), retval ); handle_xfer_failure(); return retval; // TODO: do we need to do anything here? } retval = gstate.file_xfers->insert(file_xfer); fxp = file_xfer; if (retval) { msg_printf( fip->project, MSG_ERROR, "Couldn't start %s for %s: error %d", (is_upload ? "upload" : "download"), fip->get_url(), retval ); fxp->file_xfer_retval = retval; handle_xfer_failure(); delete fxp; fxp = NULL; return retval; } if (log_flags.file_xfer) { msg_printf( fip->project, MSG_INFO, "Started %s of %s", (is_upload ? "upload" : "download"), fip->name ); } scope_messages.printf("PERS_FILE_XFER::start_xfer(): URL: %s\n",fip->get_url()); return 0; } // Poll the status of this persistent file transfer. // If it's time to start it, then attempt to start it. // If it has finished or failed, then deal with it appropriately // bool PERS_FILE_XFER::poll(time_t now) { int retval; char pathname[256]; ScopeMessages scope_messages(log_messages, ClientMessages::DEBUG_FILE_XFER); if (xfer_done) { return false; } if (!fxp) { // No file xfer is active. // We must be waiting after a failure. // See if it's time to try again. // if (now >= next_request_time) { last_time = dtime(); fip->upload_offset = -1; retval = start_xfer(); return (retval == 0); } else { return false; } } if (dtime() - last_time <= 2) { time_so_far += dtime() - last_time; } last_time = dtime(); if (fxp->file_xfer_done) { scope_messages.printf( "PERS_FILE_XFER::poll(): file transfer status %d", fxp->file_xfer_retval ); if (fxp->file_xfer_retval == 0) { // The transfer finished with no errors. // if (log_flags.file_xfer) { msg_printf( fip->project, MSG_INFO, "Successfully finished %s of %s", is_upload?"upload":"download", fip->name ); } if (fip->generated_locally) { // file has been uploaded - delete if not sticky // if (!fip->sticky) { fip->delete_file(); } fip->uploaded = true; xfer_done = true; } else { // verify the file with RSA or MD5, and change permissions // get_pathname(fip, pathname); retval = verify_downloaded_file(pathname, *fip); if (retval) { msg_printf(fip->project, MSG_ERROR, "Checksum or signature error for %s", fip->name); fip->status = retval; } else { scope_messages.printf("PERS_FILE_XFER::poll(): MD5 checksum validated for %s\n", pathname); // Set the appropriate permissions depending on whether // it's an executable or normal file // retval = fip->set_permissions(); fip->status = FILE_PRESENT; } xfer_done = true; } } else if (fxp->file_xfer_retval == ERR_UPLOAD_PERMANENT) { if (log_flags.file_xfer) { msg_printf( fip->project, MSG_INFO, "Permanently failed %s of %s", is_upload?"upload":"download", fip->name ); } giveup(); } else { if (log_flags.file_xfer) { if (fip->error_msg.empty()) { msg_printf( fip->project, MSG_INFO, "Failed %s of %s", is_upload?"upload":"download", fip->name ); } else { msg_printf( fip->project, MSG_INFO, "Failed %s of %s: %s", is_upload?"upload":"download", fip->name, fip->error_msg.c_str() ); } } handle_xfer_failure(); } // remove fxp from file_xfer_set and deallocate it // gstate.file_xfers->remove(fxp); delete fxp; fxp = NULL; return true; } return false; } void PERS_FILE_XFER::giveup() { if (is_upload) { fip->status = ERR_GIVEUP_UPLOAD; } else { fip->status = ERR_GIVEUP_DOWNLOAD; } xfer_done = true; msg_printf( fip->project, MSG_ERROR, "Giving up on %s of %s", is_upload?"upload":"download", fip->name ); } // Handle a transfer failure // void PERS_FILE_XFER::handle_xfer_failure() { time_t now = time(0); // If it was a bad range request, delete the file and start over // if (fxp->file_xfer_retval == HTTP_STATUS_RANGE_REQUEST_ERROR) { fip->delete_file(); } retry_or_backoff(); // See if it's time to give up on the persistent file xfer // if ((now - first_request_time) > gstate.file_xfer_giveup_period) { giveup(); } } // Cycle to the next URL, or if we've hit all URLs in this cycle, // backoff and try again later // void PERS_FILE_XFER::retry_or_backoff() { // struct tm *newtime; time_t now; int backoff = 0; ScopeMessages scope_messages(log_messages, ClientMessages::DEBUG_FILE_XFER); now = time(0); // newtime = localtime(&now); // Cycle to the next URL to try // fip->current_url = (fip->current_url + 1)%fip->urls.size(); // If we reach the URL that we started at, then we have tried all // servers without success // if (fip->current_url == fip->start_url) { nretry++; // Do an exponential backoff of e^nretry seconds, // keeping within the bounds of pers_retry_delay_min and // pers_retry_delay_max // backoff = calculate_exponential_backoff( "pers_file_xfer", nretry, gstate.pers_retry_delay_min, gstate.pers_retry_delay_max ); next_request_time = now + backoff; } msg_printf(fip->project, MSG_INFO, "Backing off %s on transfer of file %s", timediff_format(backoff).c_str(), fip->name); // scope_messages.printf( // "PERS_FILE_XFER::retry_or_backoff(): Backing off %d seconds on transfer of file %s\n", // backoff, fip->name // ); } // Parse XML information about a single persistent file transfer // int PERS_FILE_XFER::parse(FILE* fin) { char buf[256]; while (fgets(buf, 256, fin)) { if (match_tag(buf, "")) return 0; else if (parse_int(buf, "", nretry)) continue; else if (parse_int(buf, "", first_request_time)) continue; else if (parse_int(buf, "", next_request_time)) continue; else if (parse_double(buf, "", time_so_far)) continue; else { msg_printf(fip->project, MSG_ERROR, "PERS_FILE_XFER::parse(): unrecognized: %s", buf); } } return -1; } // Write XML information about a particular persistent file transfer // int PERS_FILE_XFER::write(FILE* fout) { fprintf(fout, " \n" " %d\n" " %d\n" " %d\n" " %f\n" " \n", nretry, first_request_time, next_request_time, time_so_far ); return 0; } void PERS_FILE_XFER::suspend() { if (fxp) { if (fxp->socket) { fxp->close_socket(); fxp->socket = 0; } if (fxp->file) { fclose(fxp->file); fxp->file = 0; } gstate.file_xfers->remove(fxp); // this removes from http_op_set too delete fxp; fxp = 0; } } PERS_FILE_XFER_SET::PERS_FILE_XFER_SET(FILE_XFER_SET* p) { file_xfers = p; } // Run through the set, starting any transfers that need to be // started and deleting any that have finished // bool PERS_FILE_XFER_SET::poll() { unsigned int i; bool action = false; int now = time(0); for (i=0; ipoll(now); } if (action) gstate.set_client_state_dirty("pers_file_xfer_set poll"); return action; } // Insert a PERS_FILE_XFER object into the set. // We will decide which ones to start when we hit the polling loop // int PERS_FILE_XFER_SET::insert(PERS_FILE_XFER* pfx) { pers_file_xfers.push_back(pfx); return 0; } // Remove a PERS_FILE_XFER object from the set. // What should the action here be? // int PERS_FILE_XFER_SET::remove(PERS_FILE_XFER* pfx) { vector::iterator iter; iter = pers_file_xfers.begin(); while (iter != pers_file_xfers.end()) { if (*iter == pfx) { pers_file_xfers.erase(iter); return 0; } iter++; } msg_printf( pfx->fip->project, MSG_ERROR, "PERS_FILE_XFER_SET::remove(): not found" ); return 1; } // suspend all PERS_FILE_XFERs // void PERS_FILE_XFER_SET::suspend() { unsigned int i; for (i=0; isuspend(); } }