From d2f4a5ee957507c06671e5ea78ed306ce021d0ee Mon Sep 17 00:00:00 2001 From: Nikias Bassen Date: Mon, 25 Jan 2010 00:24:31 +0100 Subject: [PATCH 1/2] New file_relay service implementation. --- include/Makefile.am | 1 + include/libiphone/file_relay.h | 56 +++++++++++ src/Makefile.am | 1 + src/file_relay.c | 197 ++++++++++++++++++++++++++++++++++++++++ src/file_relay.h | 40 ++++++++ 5 files changed, 295 insertions(+), 0 deletions(-) create mode 100644 include/libiphone/file_relay.h create mode 100644 src/file_relay.c create mode 100644 src/file_relay.h diff --git a/include/Makefile.am b/include/Makefile.am index 54dae0e..f871d28 100644 --- a/include/Makefile.am +++ b/include/Makefile.am @@ -1,6 +1,7 @@ nobase_include_HEADERS = libiphone/libiphone.h \ libiphone/lockdown.h \ libiphone/afc.h \ + libiphone/file_relay.h \ libiphone/notification_proxy.h \ libiphone/installation_proxy.h \ libiphone/sbservices.h \ diff --git a/include/libiphone/file_relay.h b/include/libiphone/file_relay.h new file mode 100644 index 0000000..672f1bd --- /dev/null +++ b/include/libiphone/file_relay.h @@ -0,0 +1,56 @@ +/** + * @file libiphone/file_relay.h + * @brief file_relay Implementation + * \internal + * + * Copyright (c) 2010 Nikias Bassen All Rights Reserved. + * + * This library 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 2.1 of the License, or (at your option) any later version. + * + * This library 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 this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef IFILE_RELAY_H +#define IFILE_RELAY_H + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +/* Error Codes */ +#define FILE_RELAY_E_SUCCESS 0 +#define FILE_RELAY_E_INVALID_ARG -1 +#define FILE_RELAY_E_PLIST_ERROR -2 +#define FILE_RELAY_E_MUX_ERROR -3 +#define FILE_RELAY_E_INVALID_SOURCE -4 +#define FILE_RELAY_E_STAGING_EMPTY -5 + +#define FILE_RELAY_E_UNKNOWN_ERROR -256 + +typedef int16_t file_relay_error_t; + +struct file_relay_client_int; +typedef struct file_relay_client_int *file_relay_client_t; + +file_relay_error_t file_relay_client_new(iphone_device_t device, uint16_t port, file_relay_client_t *client); +file_relay_error_t file_relay_client_free(file_relay_client_t client); + +file_relay_error_t file_relay_request_sources(file_relay_client_t client, const char **sources, iphone_connection_t *connection); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/src/Makefile.am b/src/Makefile.am index 2e92382..f68f579 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -11,6 +11,7 @@ libiphone_la_SOURCES = iphone.c iphone.h \ device_link_service.c device_link_service.h\ lockdown.c lockdown.h\ afc.c afc.h\ + file_relay.c file_relay.h\ notification_proxy.c notification_proxy.h\ installation_proxy.c installation_proxy.h\ sbservices.c sbservices.h\ diff --git a/src/file_relay.c b/src/file_relay.c new file mode 100644 index 0000000..f0e91f7 --- /dev/null +++ b/src/file_relay.c @@ -0,0 +1,197 @@ + /* + * file_relay.c + * file_relay service implementation. + * + * Copyright (c) 2010 Nikias Bassen, All Rights Reserved. + * + * This library 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 2.1 of the License, or (at your option) any later version. + * + * This library 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 this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ +#include +#include +#include "file_relay.h" +#include "property_list_service.h" +#include "debug.h" + +/** + * Creates a new file_relay client. + * + * @param device The device to connect to. + * @param port Port on device to connect to. + * @param client Reference that will point to a newly allocated + * file_relay_client_t upon successful return. + * + * @return FILE_RELAY_E_SUCCESS on success, + * FILE_RELAY_E_INVALID_ARG when one of the parameters is invalid, + * or FILE_RELAY_E_MUX_ERROR when the connection failed. + */ +file_relay_error_t file_relay_client_new(iphone_device_t device, uint16_t port, file_relay_client_t *client) +{ + if (!device || port == 0 || !client || *client) { + return FILE_RELAY_E_INVALID_ARG; + } + + property_list_service_client_t plistclient = NULL; + if (property_list_service_client_new(device, port, &plistclient) != PROPERTY_LIST_SERVICE_E_SUCCESS) { + return FILE_RELAY_E_MUX_ERROR; + } + + /* create client object */ + file_relay_client_t client_loc = (file_relay_client_t) malloc(sizeof(struct file_relay_client_int)); + client_loc->parent = plistclient; + + /* all done, return success */ + *client = client_loc; + return FILE_RELAY_E_SUCCESS; +} + +/** + * Frees a file_relay client. + * + * @param client The file_relay_client_t to free. + * + * @return FILE_RELAY_E_SUCCESS on success, + * FILE_RELAY_E_INVALID_ARG when one of client or client->parent + * is invalid, or FILE_RELAY_E_UNKNOWN_ERROR when the was an error + * freeing the parent property_list_service client. + */ +file_relay_error_t file_relay_client_free(file_relay_client_t client) +{ + if (!client) + return FILE_RELAY_E_INVALID_ARG; + + if (property_list_service_client_free(client->parent) != PROPERTY_LIST_SERVICE_E_SUCCESS) { + return FILE_RELAY_E_UNKNOWN_ERROR; + } + return FILE_RELAY_E_SUCCESS; +} + +/** + * Request data for the given sources. + * + * @param client The connected file_relay client. + * @param sources A NULL-terminated list of sources to retrieve. + * Valid sources are: + * - AppleSupport + * - Network + * - VPN + * - WiFi + * - UserDatabases + * - CrashReporter + * - tmp + * - SystemConfiguration + * @param connection The connection that has to be used for receiving the + * data using iphone_connection_receive(). The connection will be closed + * automatically by the device, but use file_relay_client_free() to clean + * up properly. + * + * @note WARNING: Don't call this function without reading the data afterwards. + * A directory mobile_file_relay.XXXX used for creating the archive will + * remain in the /tmp directory otherwise. + * + * @return FILE_RELAY_E_SUCCESS on succes, FILE_RELAY_E_INVALID_ARG when one or + * more parameters are invalid, FILE_RELAY_E_MUX_ERROR if a communication + * error occurs, FILE_RELAY_E_PLIST_ERROR when the received result is NULL + * or is not a valid plist, FILE_RELAY_E_INVALID_SOURCE if one or more + * sources are invalid, FILE_RELAY_E_STAGING_EMPTY if no data is available + * for the given sources, or FILE_RELAY_E_UNKNOWN_ERROR otherwise. + */ +file_relay_error_t file_relay_request_sources(file_relay_client_t client, const char **sources, iphone_connection_t *connection) +{ + if (!client || !client->parent || !sources || !sources[0]) { + return FILE_RELAY_E_INVALID_ARG; + } + *connection = NULL; + file_relay_error_t err = FILE_RELAY_E_UNKNOWN_ERROR; + /* set up request plist */ + plist_t array = plist_new_array(); + int i = 0; + while (sources[i]) { + plist_array_append_item(array, plist_new_string(sources[i])); + i++; + } + plist_t dict = plist_new_dict(); + plist_dict_insert_item(dict, "Sources", array); + + if (property_list_service_send_xml_plist(client->parent, dict) != PROPERTY_LIST_SERVICE_E_SUCCESS) { + debug_info("ERROR: Could not send request to device!"); + err = FILE_RELAY_E_MUX_ERROR; + goto leave; + } + plist_free(dict); + + dict = NULL; + if (property_list_service_receive_plist_with_timeout(client->parent, &dict, 60000) != PROPERTY_LIST_SERVICE_E_SUCCESS) { + debug_info("ERROR: Could not receive answer from device!"); + err = FILE_RELAY_E_MUX_ERROR; + goto leave; + } + + if (!dict) { + debug_info("ERROR: Did not receive any plist!"); + err = FILE_RELAY_E_PLIST_ERROR; + goto leave; + } + + plist_t error = plist_dict_get_item(dict, "Error"); + if (error) { + char *errmsg = NULL; + plist_get_string_val(error, &errmsg); + if (errmsg) { + if (!strcmp(errmsg, "InvalidSource")) { + debug_info("ERROR: One or more given sources are invalid!"); + err = FILE_RELAY_E_INVALID_SOURCE; + } else if (!strcmp(errmsg, "StagingEmpty")) { + debug_info("ERROR: StagingEmpty - No data available!"); + err = FILE_RELAY_E_STAGING_EMPTY; + } else { + debug_info("ERROR: Unknown error '%s'", errmsg); + } + free(errmsg); + } else { + debug_info("ERROR: Could not get error message!"); + } + goto leave; + } + + plist_t status = plist_dict_get_item(dict, "Status"); + if (!status) { + debug_info("ERROR: Unexpected plist received!"); + debug_plist(dict); + err = FILE_RELAY_E_PLIST_ERROR; + goto leave; + } + + char *ack = NULL; + plist_get_string_val(status, &ack); + if (!ack) { + debug_info("ERROR: Could not get 'Acknowledged' string!"); + goto leave; + } + + if (strcmp(ack, "Acknowledged")) { + debug_info("ERROR: Did not receive 'Acknowledged' but '%s'", ack); + goto leave; + } + free(ack); + err = FILE_RELAY_E_SUCCESS; + + *connection = client->parent->connection; + +leave: + if (dict) { + plist_free(dict); + } + return err; +} diff --git a/src/file_relay.h b/src/file_relay.h new file mode 100644 index 0000000..9b2488c --- /dev/null +++ b/src/file_relay.h @@ -0,0 +1,40 @@ + /* + * file_relay.h + * Definitions for the file_relay service + * + * Copyright (c) 2010 Nikias Bassen, All Rights Reserved. + * + * This library 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 2.1 of the License, or (at your option) any later version. + * + * This library 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 this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ +#ifndef FILE_RELAY_H +#define FILE_RELAY_H + +#include "libiphone/file_relay.h" +#include "property_list_service.h" + +/* Error Codes */ +#define FILE_RELAY_E_SUCCESS 0 +#define FILE_RELAY_E_INVALID_ARG -1 +#define FILE_RELAY_E_PLIST_ERROR -2 +#define FILE_RELAY_E_MUX_ERROR -3 + +#define FILE_RELAY_E_UNKNOWN_ERROR -256 + + +struct file_relay_client_int { + property_list_service_client_t parent; +}; + +#endif -- 1.6.3.3