' . t('The Ubercare EDI FTP module provides an FTP Export Delivery Method. The user must provide valid FTP account credentials to use for uploading to an FTP server.') . '
'; + + return $output; + } +} + +/** + * Implements hook_form_FORM_ID_alter(). + */ +function uc_edi_ftp_form_uc_edi_export_delivery_methods_form_alter(&$form, &$form_state) { + $form['#validate'][] = 'uc_edi_ftp_export_delivery_method_form_validate'; +} + +/******************************************************************************* + * Hook Functions (Ubercart) + ******************************************************************************/ + +/** + * Implementation of hook_uc_edi_export_delivery_methods(). + */ +function uc_edi_ftp_uc_edi_export_delivery_methods() { + $methods[] = array( + 'id' => 'ftp', + 'title' => t('FTP'), + 'description' => t('Deliver export files to an FTP server.'), + 'callbacks' => array( + 'help' => 'uc_edi_ftp_export_delivery_method_help', + 'settings' => 'uc_edi_ftp_export_delivery_method_form', + 'submit' => 'uc_edi_ftp_export_delivery_method_submit', + ), + ); + + return $methods; +} + +/****************************************************************************** + * Module and Helper Functions + *****************************************************************************/ + +/** + * Callback function for the FTP export delivery method help. + * + * @return + * HTML link to the FTP delivery method help page followed by a short + * description. + */ +function uc_edi_ftp_export_delivery_method_help() { + return t('FTP: Deliver export files to an FTP server.', array('!url' => url('admin/help/uc_edi_ftp'))); +} + +/** + * Callback function for the FTP export delivery method form. + * + * @return + * An un-rendered settings form for the FTP export delivery method. + */ +function uc_edi_ftp_export_delivery_method_form() { + $form['ftp']['uc_edi_ftp_host'] = array( + '#type' => 'textfield', + '#title' => t('Host'), + '#description' => t("The FTP server address. This parameter shouldn't have any trailing slashes and shouldn't be prefixed with ftp://."), + '#default_value' => variable_get('uc_edi_ftp_host', ''), + ); + $form['ftp']['uc_edi_ftp_port'] = array( + '#type' => 'textfield', + '#title' => t('Port'), + '#description' => t('If omitted, the default FTP port (21) will be used.'), + '#maxlength' => 5, + '#size' => 5, + '#default_value' => variable_get('uc_edi_ftp_port', '21'), + ); + $form['ftp']['uc_edi_ftp_user'] = array( + '#type' => 'textfield', + '#title' => t('Username'), + '#default_value' => variable_get('uc_edi_ftp_user', ''), + ); + $form['ftp']['uc_edi_ftp_pass'] = array( + '#type' => 'password', + '#title' => t('Password'), + '#description' => t('The FTP account password.'), + '#default_value' => variable_get('uc_edi_ftp_pass', ''), + ); + $form['ftp']['uc_edi_ftp_path'] = array( + '#type' => 'textfield', + '#title' => t('Path'), + '#description' => t('The path to the directory the files should be uploaded to.'), + '#default_value' => variable_get('uc_edi_ftp_path', ''), + ); + + return $form; +} + +/** + * Handles validation of the Ubercart EDI e-mail export delivery method form. + * + * @see uc_edi_ftp_export_delivery_method_form() + */ +function uc_edi_ftp_export_delivery_method_form_validate($form, &$form_state) { + if ($form_state['values']['uc_edi_export_delivery_method_ftp']) { + $host = $form_state['values']['uc_edi_ftp_host']; + if (!$host) { + form_set_error('uc_edi_ftp_host', $host); + } + $port = $form_state['values']['uc_edi_ftp_port']; + $user = $form_state['values']['uc_edi_ftp_user']; + if (!$user) { + form_set_error('uc_edi_ftp_user', $user); + } + $pass = $form_state['values']['uc_edi_ftp_pass']; + if (!$pass) { + form_set_error('uc_edi_ftp_pass', $pass); + } + + // If there are no errors so far. + if (!form_get_errors()) { + // Log into the ftp server. + $ftp = uc_edi_ftp_login($host, $port, $user, $pass); + + // If the connection failed. + if (!$ftp) { + form_set_error('ftp', t('Failed to authenticate.')); + } + else { + // Close the FTP connection. + @ftp_close($ftp); + } + } + } +} + +/** + * Log in to an FTP server. + * + * @param $host + * The FTP server address. + * @param $port + * The FTP connection port. + * @param $user + * The FTP username. + * @param $pass + * The FTP password. + * + * @return + * Valid FTP object. + */ +function uc_edi_ftp_login($host, $port, $user, $pass) { + // Open an FTP connection with the server. + if ($ftp = @ftp_connect($host, $port)) { + // Log onto the FTP server. + if (@ftp_login($ftp, $user, $pass)) { + // Enable passive mode. + @ftp_pasv($ftp, TRUE); + + return $ftp; + } + else { + @ftp_close($ftp); + } + } + + return FALSE; +} + +/** + * Callback function for the FTP export delivery method submission. + * + * @return + * TRUE if the file was submitted successfully, otherwise false. + */ +function uc_edi_ftp_export_delivery_method_submit($filepath, $filename) { + // Get FTP credentials. + $host = variable_get('uc_edi_ftp_host', ''); + $port = variable_get('uc_edi_ftp_port', 21); + $user = variable_get('uc_edi_ftp_user', ''); + $pass = variable_get('uc_edi_ftp_pass', ''); + $path = variable_get('uc_edi_ftp_path', ''); + + // Log into the FTP server. + if ($ftp = uc_edi_ftp_login($host, $port, $user, $pass)) { + // If a path has been specified. + if ($path) { + // Try changing to the specified path. + if (@ftp_chdir($ftp, $path)) { + watchdog('uc_edi_ftp', 'Problem changing the working directory to the specified path. Please verify the directory exists and the account has access.', array(), WATCHDOG_ERROR); + } + } + + // Send the file to the server. + if (@ftp_put($ftp, $filename, $filepath, FTP_ASCII)) { + // Close the FTP connection. + @ftp_close($ftp); + + watchdog('uc_edi_ftp', t('EDI export saved to the FTP server.')); + return TRUE; + } + else { + watchdog('uc_edi_ftp', 'Problem saving the file to the FTP server. Please verify the account has write permissions.', array(), WATCHDOG_ERROR); + } + } + else { + watchdog('uc_edi_ftp', 'Problem loging into the FTP server. Check your FTP export delivery method settings and the FTP server settings.', array(), WATCHDOG_ERROR); + } + + return FALSE; +}