- server: rename send_file to put_file.

Factor out put_file() and get_file() functions
    so they have a C++ API as well as command-line


svn path=/trunk/boinc/; revision=23425

checkin_notes

@@ -2438,3 +2438,17 @@ David  23 Apr 2011
     sched/
         get_file.cpp
         send_file.cpp
+
+David  23 Apr 2011
+    - server: rename send_file to put_file.
+        Factor out put_file() and get_file() functions
+        so they have a C++ API as well as command-line
+
+    sched/
+        put_file.cpp
+        get_file.cpp
+        Makefile.am
+    tools/
+        backend_lib.cpp,h
+    lib/
+        common_defs.h

lib/common_defs.h

@@ -122,7 +122,7 @@ enum SUSPEND_REASON {
     SUSPEND_REASON_OS = 4096
 };
 
-// States of a result on a client.
+// Values of RESULT::state
 // THESE MUST BE IN NUMERICAL ORDER
 // (because of the > comparison in RESULT::computing_done())
 //

sched/Makefile.am

@@ -95,7 +95,7 @@ bin_PROGRAMS = \
     make_work \
     request_file_list \
     sched_driver \
-    send_file \
+    put_file \
     show_shmem \
     wu_check
 
@@ -256,8 +256,8 @@ request_file_list_LDADD = $(SERVERLIBS)
 get_file_SOURCES = get_file.cpp
 get_file_LDADD = $(SERVERLIBS)
 
-send_file_SOURCES = send_file.cpp
+put_file_SOURCES = put_file.cpp
-send_file_LDADD = $(SERVERLIBS)
+put_file_LDADD = $(SERVERLIBS)
 
 delete_file_SOURCES = delete_file.cpp
 delete_file_LDADD = $(SERVERLIBS)

sched/get_file.cpp

@@ -33,102 +33,12 @@
 #include <string>
 #include <time.h>
 
-#include "boinc_db.h"
+#include "backend_lib.h"
-#include "util.h"
-#include "str_util.h"
 
 #include "sched_config.h"
 #include "sched_util.h"
-#include "md5_file.h"
 #include "svn_version.h"
 
-int create_upload_result(
-    DB_RESULT& result, int host_id, const char * file_name
-) {
-    int retval;
-    char result_xml[BLOB_SIZE];
-
-    result.clear();
-    sprintf(result.name, "get_%s_%d_%ld", file_name, host_id, time(0));
-    result.create_time = time(0);
-    result.server_state = RESULT_SERVER_STATE_IN_PROGRESS;
-    result.hostid = host_id;
-    result.outcome = RESULT_OUTCOME_INIT;
-    result.file_delete_state = ASSIMILATE_DONE;
-    result.validate_state = VALIDATE_STATE_NO_CHECK;
-
-    sprintf(result_xml,
-        "<result>\n"
-        "    <wu_name>%s</wu_name>\n"
-        "    <name>%s</wu_name>\n"
-        "    <file_ref>\n"
-        "      <file_name>%s</file_name>\n"
-        "    </file_ref>\n"
-        "</result>\n",
-        result.name, result.name, file_name
-    );
-    strcpy(result.xml_doc_in, result_xml);
-    result.sent_time = time(0);
-    result.report_deadline = 0;
-    result.hostid = host_id;
-    retval = result.insert();
-    if (retval) {
-        fprintf(stderr, "result.insert(): %s\n", boincerror(retval));
-        return retval;
-    }
-    return 0;
-}
-
-int create_upload_message(
-    DB_RESULT& result, int host_id, const char* file_name
-) {;
-    DB_MSG_TO_HOST mth;
-    int retval;
-    mth.clear();
-    mth.create_time = time(0);
-    mth.hostid = host_id;
-    strcpy(mth.variety, "file_xfer");
-    mth.handled = false;
-    sprintf(mth.xml,
-        "<app>\n"
-        "    <name>%s</name>\n"
-        "</app>\n"
-        "<app_version>\n"
-        "    <app_name>%s</app_name>\n"
-        "    <version_num>%d00</version_num>\n"
-        "</app_version>\n"
-        "<file_info>\n"
-        "    <name>%s</name>\n"
-        "    <url>%s</url>\n"
-        "    <max_nbytes>%.0f</max_nbytes>\n"
-        "    <upload_when_present/>\n"
-        "</file_info>\n"
-        "%s"
-        "<workunit>\n"
-        "    <name>%s</name>\n"
-        "    <app_name>%s</app_name>\n"
-        "</workunit>",
-        FILE_MOVER, FILE_MOVER, BOINC_MAJOR_VERSION,
-        file_name, config.upload_url,
-        1e10, result.xml_doc_in, result.name, FILE_MOVER
-    );
-    retval = mth.insert();
-    if (retval) {
-        fprintf(stderr, "msg_to_host.insert(): %s\n", boincerror(retval));
-        return retval;
-    }
-    return 0;
-}
-
-int get_file(int host_id, const char* file_name) {
-    DB_RESULT result;
-    int retval;
-    retval = create_upload_result(result, host_id, file_name);
-    if (retval) return retval;
-    retval = create_upload_message(result, host_id, file_name);
-    return retval;
-}
-
 void usage() {
     fprintf(stderr, "Gets a file from a specific host.\n"
         "Usage: get_file [options]\n\n"

sched/put_file.cpp

@@ -0,0 +1,107 @@
+// This file is part of BOINC.
+// http://boinc.berkeley.edu
+// Copyright (C) 2008 University of California
+//
+// BOINC is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License
+// as published by the Free Software Foundation,
+// either version 3 of the License, or (at your option) any later version.
+//
+// BOINC is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+// See the GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with BOINC.  If not, see <http://www.gnu.org/licenses/>.
+
+// put_file [options]
+// --host_id N           ID of host to send to
+// --file_name name      name of file
+
+#include "config.h"
+#if HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+#include <stdlib.h>
+#include <string>
+#include <time.h>
+
+#include "backend_lib.h"
+#include "svn_version.h"
+
+#include "sched_config.h"
+#include "sched_util.h"
+
+void usage() {
+    fprintf(stderr,
+        "Usage: put_file [options]\n\n"
+        "Arrange to send a file to a host.\n"
+        "Options:\n"
+        "  --host_id id                    ID of host\n"
+        "  --file_name name                name of file to send\n"
+        "  [ -h | --help ]                 Show this help text.\n"
+        "  [ -v | --version ]              Show version information.\n"
+    );
+}
+
+int main(int argc, char** argv) {
+    int i, retval;
+    char file_name[256];
+    int host_id;
+
+    strcpy(file_name, "");
+    host_id = 0;
+
+    check_stop_daemons();
+
+    for (i=1; i<argc; i++) {
+        if (is_arg(argv[i], "host_id")) {
+            if (!argv[++i]) {
+                fprintf(stderr, "%s requires an argument\n\n", argv[--i]);
+                usage();
+                exit(1);
+            }
+            host_id = atoi(argv[i]);
+        } else if (is_arg(argv[i], "file_name")) {
+            if (!argv[++i]) {
+                fprintf(stderr, "%s requires an argument\n\n", argv[--i]);
+                usage();
+                exit(1);
+            }
+            strcpy(file_name, argv[i]);
+        } else if (!strcmp(argv[i], "-h") || !strcmp(argv[i], "--help")) {
+            usage();
+            exit(0);
+        } else if (!strcmp(argv[i], "-v") || !strcmp(argv[i], "--version")) {
+            printf("%s\n", SVN_VERSION);
+            exit(0);
+        } else {
+            usage();
+            exit(1);
+        }
+    }
+
+    if (!strlen(file_name)) {
+        usage();
+        exit(1);
+    }
+    retval = config.parse_file();
+    if (retval) {
+        fprintf(stderr, "Can't parse config.xml: %s\n", boincerror(retval));
+        exit(1);
+    }
+
+    retval = boinc_db.open(config.db_name, config.db_host, config.db_user, config.db_passwd);
+    if (retval) {
+        fprintf(stderr, "boinc_db.open failed: %s\n", boincerror(retval));
+        exit(1);
+    }
+
+    retval = put_file(host_id, file_name);
+
+    boinc_db.close();
+    return retval;
+}
+
+const char *BOINC_RCSID_f3c3c4b892 = "$Id$";

sched/send_file.cpp

@@ -1,209 +0,0 @@
-// This file is part of BOINC.
-// http://boinc.berkeley.edu
-// Copyright (C) 2008 University of California
-//
-// BOINC is free software; you can redistribute it and/or modify it
-// under the terms of the GNU Lesser General Public License
-// as published by the Free Software Foundation,
-// either version 3 of the License, or (at your option) any later version.
-//
-// BOINC is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-// See the GNU Lesser General Public License for more details.
-//
-// You should have received a copy of the GNU Lesser General Public License
-// along with BOINC.  If not, see <http://www.gnu.org/licenses/>.
-
-// send_file [options]
-// --host_id N           ID of host to send to
-// --file_name name      name of file
-
-#include "config.h"
-#if HAVE_UNISTD_H
-#include <unistd.h>
-#endif
-#include <stdlib.h>
-#include <string>
-#include <time.h>
-
-#include "boinc_db.h"
-#include "util.h"
-#include "str_util.h"
-#include "md5_file.h"
-#include "svn_version.h"
-
-#include "sched_config.h"
-#include "sched_util.h"
-
-int create_download_result(
-    DB_RESULT& result, int host_id, const char* file_name
-) {
-    int retval;
-    char result_xml[BLOB_SIZE];
-
-    result.clear();
-    sprintf(result.name, "send_%s_%d_%ld", file_name, host_id, time(0));
-    result.create_time = time(0);
-    result.server_state = RESULT_SERVER_STATE_IN_PROGRESS;
-    result.hostid = host_id;
-    result.outcome = RESULT_OUTCOME_INIT;
-    result.file_delete_state = ASSIMILATE_DONE;
-    result.validate_state = VALIDATE_STATE_NO_CHECK;
-
-    sprintf(result_xml,
-        "<result>\n"
-        "    <wu_name>%s</wu_name>\n"
-        "    <name>%s</name>\n"
-        "</result>\n",
-        result.name, result.name
-    );
-    strcpy(result.xml_doc_in, result_xml);
-    result.sent_time = time(0);
-    result.report_deadline = 0;
-    result.hostid = host_id;
-    retval = result.insert();
-    if (retval) {
-        fprintf(stderr, "result.insert(): %s\n", boincerror(retval));
-        return retval;
-    }
-    return 0;
-}
-
-int create_download_message(
-    DB_RESULT& result, int host_id, const char* file_name
-) {;
-    DB_MSG_TO_HOST mth;
-    int retval;
-    double nbytes;
-    char dirpath[256], urlpath[256], path[256], md5[33];
-    strcpy(dirpath, config.download_dir);
-    strcpy(urlpath, config.download_url);
-    mth.clear();
-    mth.create_time = time(0);
-    mth.hostid = host_id;
-    strcpy(mth.variety, "file_xfer");
-    mth.handled = false;
-    sprintf(path, "%s/%s", dirpath, file_name);
-    retval = md5_file(path, md5, nbytes);
-    if (retval) {
-        fprintf(stderr, "md5_file() error: %s\n", boincerror(retval));
-        return retval;
-    }
-    sprintf(mth.xml,
-        "<app>\n"
-        "    <name>%s</name>\n"
-        "</app>\n"
-        "<app_version>\n"
-        "    <app_name>%s</app_name>\n"
-        "    <version_num>%d00</version_num>\n"
-        "</app_version>\n"
-        "%s"
-         "<file_info>\n"
-        "    <name>%s</name>\n"
-        "    <url>%s/%s</url>\n"
-        "    <md5_cksum>%s</md5_cksum>\n"
-        "    <nbytes>%.0f</nbytes>\n"
-        "    <sticky/>\n"
-        "</file_info>\n"
-        "<workunit>\n"
-        "    <name>%s</name>\n"
-        "    <app_name>%s</app_name>\n"
-        "    <file_ref>\n"
-        "      <file_name>%s</file_name>\n"
-        "    </file_ref>\n"
-        "</workunit>",
-        FILE_MOVER, FILE_MOVER, BOINC_MAJOR_VERSION, result.xml_doc_in,
-        file_name, urlpath, file_name, md5,
-        nbytes, result.name, FILE_MOVER, file_name
-    );
-    retval = mth.insert();
-    if (retval) {
-        fprintf(stderr, "msg_to_host.insert(): %s\n", boincerror(retval));
-        return retval;
-    }
-    return 0;
-}
-
-int send_file(int host_id, const char* file_name) {
-    DB_RESULT result;
-    int retval;
-    retval = create_download_result(result, host_id, file_name);
-    if (retval) return retval;
-    retval = create_download_message(result, host_id, file_name);
-    return retval;
-}
-
-
-void usage() {
-    fprintf(stderr,
-        "Usage: send_file [options]\n\n"
-        "Arrange to send a file to a host.\n"
-        "Options:\n"
-        "  --host_id id                    ID of host\n"
-        "  --file_name name                name of file to send\n"
-        "  [ -h | --help ]                 Show this help text.\n"
-        "  [ -v | --version ]              Show version information.\n"
-    );
-}
-
-int main(int argc, char** argv) {
-    int i, retval;
-    char file_name[256];
-    int host_id;
-
-    strcpy(file_name, "");
-    host_id = 0;
-
-    check_stop_daemons();
-
-    for (i=1; i<argc; i++) {
-        if (is_arg(argv[i], "host_id")) {
-            if (!argv[++i]) {
-                fprintf(stderr, "%s requires an argument\n\n", argv[--i]);
-                usage();
-                exit(1);
-            }
-            host_id = atoi(argv[i]);
-        } else if (is_arg(argv[i], "file_name")) {
-            if (!argv[++i]) {
-                fprintf(stderr, "%s requires an argument\n\n", argv[--i]);
-                usage();
-                exit(1);
-            }
-            strcpy(file_name, argv[i]);
-        } else if (!strcmp(argv[i], "-h") || !strcmp(argv[i], "--help")) {
-            usage();
-            exit(0);
-        } else if (!strcmp(argv[i], "-v") || !strcmp(argv[i], "--version")) {
-            printf("%s\n", SVN_VERSION);
-            exit(0);
-        } else {
-            usage();
-            exit(1);
-        }
-    }
-
-    if (!strlen(file_name)) {
-        usage();
-        exit(1);
-    }
-    retval = config.parse_file();
-    if (retval) {
-        fprintf(stderr, "Can't parse config.xml: %s\n", boincerror(retval));
-        exit(1);
-    }
-
-    retval = boinc_db.open(config.db_name, config.db_host, config.db_user, config.db_passwd);
-    if (retval) {
-        fprintf(stderr, "boinc_db.open failed: %s\n", boincerror(retval));
-        exit(1);
-    }
-
-    retval = send_file(host_id, file_name);
-
-    boinc_db.close();
-    return retval;
-}
-
-const char *BOINC_RCSID_f3c3c4b892 = "$Id$";

tools/backend_lib.cpp

@@ -671,4 +671,191 @@ int create_work(
     return 0;
 }
 
+// STUFF RELATED TO FILE UPLOAD/DOWNLOAD
+
+int create_upload_result(
+    DB_RESULT& result, int host_id, const char * file_name
+) {
+    int retval;
+    char result_xml[BLOB_SIZE];
+
+    result.clear();
+    sprintf(result.name, "get_%s_%d_%ld", file_name, host_id, time(0));
+    result.create_time = time(0);
+    result.server_state = RESULT_SERVER_STATE_IN_PROGRESS;
+    result.hostid = host_id;
+    result.outcome = RESULT_OUTCOME_INIT;
+    result.file_delete_state = ASSIMILATE_DONE;
+    result.validate_state = VALIDATE_STATE_NO_CHECK;
+
+    sprintf(result_xml,
+        "<result>\n"
+        "    <wu_name>%s</wu_name>\n"
+        "    <name>%s</wu_name>\n"
+        "    <file_ref>\n"
+        "      <file_name>%s</file_name>\n"
+        "    </file_ref>\n"
+        "</result>\n",
+        result.name, result.name, file_name
+    );
+    strcpy(result.xml_doc_in, result_xml);
+    result.sent_time = time(0);
+    result.report_deadline = 0;
+    result.hostid = host_id;
+    retval = result.insert();
+    if (retval) {
+        fprintf(stderr, "result.insert(): %s\n", boincerror(retval));
+        return retval;
+    }
+    return 0;
+}
+
+int create_upload_message(
+    DB_RESULT& result, int host_id, const char* file_name
+) {;
+    DB_MSG_TO_HOST mth;
+    int retval;
+    mth.clear();
+    mth.create_time = time(0);
+    mth.hostid = host_id;
+    strcpy(mth.variety, "file_xfer");
+    mth.handled = false;
+    sprintf(mth.xml,
+        "<app>\n"
+        "    <name>%s</name>\n"
+        "</app>\n"
+        "<app_version>\n"
+        "    <app_name>%s</app_name>\n"
+        "    <version_num>%d00</version_num>\n"
+        "</app_version>\n"
+        "<file_info>\n"
+        "    <name>%s</name>\n"
+        "    <url>%s</url>\n"
+        "    <max_nbytes>%.0f</max_nbytes>\n"
+        "    <upload_when_present/>\n"
+        "</file_info>\n"
+        "%s"
+        "<workunit>\n"
+        "    <name>%s</name>\n"
+        "    <app_name>%s</app_name>\n"
+        "</workunit>",
+        FILE_MOVER, FILE_MOVER, BOINC_MAJOR_VERSION,
+        file_name, config.upload_url,
+        1e10, result.xml_doc_in, result.name, FILE_MOVER
+    );
+    retval = mth.insert();
+    if (retval) {
+        fprintf(stderr, "msg_to_host.insert(): %s\n", boincerror(retval));
+        return retval;
+    }
+    return 0;
+}
+
+int get_file(int host_id, const char* file_name) {
+    DB_RESULT result;
+    int retval;
+    retval = create_upload_result(result, host_id, file_name);
+    if (retval) return retval;
+    retval = create_upload_message(result, host_id, file_name);
+    return retval;
+}
+
+int create_download_result(
+    DB_RESULT& result, int host_id, const char* file_name
+) {
+    int retval;
+    char result_xml[BLOB_SIZE];
+
+    result.clear();
+    sprintf(result.name, "put_%s_%d_%ld", file_name, host_id, time(0));
+    result.create_time = time(0);
+    result.server_state = RESULT_SERVER_STATE_IN_PROGRESS;
+    result.hostid = host_id;
+    result.outcome = RESULT_OUTCOME_INIT;
+    result.file_delete_state = ASSIMILATE_DONE;
+    result.validate_state = VALIDATE_STATE_NO_CHECK;
+
+    sprintf(result_xml,
+        "<result>\n"
+        "    <wu_name>%s</wu_name>\n"
+        "    <name>%s</name>\n"
+        "</result>\n",
+        result.name, result.name
+    );
+    strcpy(result.xml_doc_in, result_xml);
+    result.sent_time = time(0);
+    result.report_deadline = 0;
+    result.hostid = host_id;
+    retval = result.insert();
+    if (retval) {
+        fprintf(stderr, "result.insert(): %s\n", boincerror(retval));
+        return retval;
+    }
+    return 0;
+}
+
+int create_download_message(
+    DB_RESULT& result, int host_id, const char* file_name
+) {;
+    DB_MSG_TO_HOST mth;
+    int retval;
+    double nbytes;
+    char dirpath[256], urlpath[256], path[256], md5[33];
+    strcpy(dirpath, config.download_dir);
+    strcpy(urlpath, config.download_url);
+    mth.clear();
+    mth.create_time = time(0);
+    mth.hostid = host_id;
+    strcpy(mth.variety, "file_xfer");
+    mth.handled = false;
+    sprintf(path, "%s/%s", dirpath, file_name);
+    retval = md5_file(path, md5, nbytes);
+    if (retval) {
+        fprintf(stderr, "md5_file() error: %s\n", boincerror(retval));
+        return retval;
+    }
+    sprintf(mth.xml,
+        "<app>\n"
+        "    <name>%s</name>\n"
+        "</app>\n"
+        "<app_version>\n"
+        "    <app_name>%s</app_name>\n"
+        "    <version_num>%d00</version_num>\n"
+        "</app_version>\n"
+        "%s"
+         "<file_info>\n"
+        "    <name>%s</name>\n"
+        "    <url>%s/%s</url>\n"
+        "    <md5_cksum>%s</md5_cksum>\n"
+        "    <nbytes>%.0f</nbytes>\n"
+        "    <sticky/>\n"
+        "</file_info>\n"
+        "<workunit>\n"
+        "    <name>%s</name>\n"
+        "    <app_name>%s</app_name>\n"
+        "    <file_ref>\n"
+        "      <file_name>%s</file_name>\n"
+        "    </file_ref>\n"
+        "</workunit>",
+        FILE_MOVER, FILE_MOVER, BOINC_MAJOR_VERSION, result.xml_doc_in,
+        file_name, urlpath, file_name, md5,
+        nbytes, result.name, FILE_MOVER, file_name
+    );
+    retval = mth.insert();
+    if (retval) {
+        fprintf(stderr, "msg_to_host.insert(): %s\n", boincerror(retval));
+        return retval;
+    }
+    return 0;
+}
+
+int put_file(int host_id, const char* file_name) {
+    DB_RESULT result;
+    int retval;
+    retval = create_download_result(result, host_id, file_name);
+    if (retval) return retval;
+    retval = create_download_message(result, host_id, file_name);
+    return retval;
+}
+
 const char *BOINC_RCSID_b5f8b10eb5 = "$Id$";

tools/backend_lib.h

@@ -71,4 +71,7 @@ extern int create_work(
     const char* additional_xml = NULL
 );
 
+extern int put_file(int host_id, const char* file_name);
+extern int get_file(int host_id, const char* file_name);
+
 #endif