' . $e->getMessage() . '
', '@handbook_url' => 'http://drupal.org/documentation/install/modules-themes', ))); } } -} + } -/** - * Form submission handler for authorize_filetransfer_form(). - * - * @see authorize_filetransfer_form() - * @see authorize_filetransfer_validate() + /** + * {@inheritdoc} */ -function authorize_filetransfer_form_submit($form, &$form_state) { + public function submitForm(array &$form, array &$form_state) { switch ($form_state['triggering_element']['#name']) { case 'process_updates': @@ -255,16 +197,16 @@ function authorize_filetransfer_form_submit($form, &$form_state) { } } // Set this one as the default authorize method. - \Drupal::config('system.authorize')->set('filetransfer_default', $filetransfer_backend); + $this->config('system.authorize')->set('filetransfer_default', $filetransfer_backend); // Save the connection settings minus the password. - \Drupal::config('system.authorize')->set('filetransfer_connection_settings_' . $filetransfer_backend, $connection_settings); + $this->config('system.authorize')->set('filetransfer_connection_settings_' . $filetransfer_backend, $connection_settings); - $filetransfer = authorize_get_filetransfer($filetransfer_backend, $form_state['values']['connection_settings'][$filetransfer_backend]); + $filetransfer = $this->getFiletransfer($filetransfer_backend, $form_state['values']['connection_settings'][$filetransfer_backend]); // Now run the operation. - authorize_run_operation($filetransfer); + $this->runOperation($filetransfer); } - catch (Exception $e) { + catch (\Exception $e) { // If there is no database available, we don't care and just skip // this part entirely. } @@ -280,23 +222,9 @@ function authorize_filetransfer_form_submit($form, &$form_state) { unset($form_state['values']['connection_settings']['authorize_filetransfer_default']); break; } -} - -/** - * Runs the operation specified in $_SESSION['authorize_operation']. - * - * @param $filetransfer - * The FileTransfer object to use for running the operation. - */ -function authorize_run_operation($filetransfer) { - $operation = $_SESSION['authorize_operation']; - unset($_SESSION['authorize_operation']); - - require_once DRUPAL_ROOT . '/' . $operation['file']; - call_user_func_array($operation['callback'], array_merge(array($filetransfer), $operation['arguments'])); -} + } -/** + /** * Gets a FileTransfer class for a specific transfer method and settings. * * @param $backend @@ -304,11 +232,11 @@ function authorize_run_operation($filetransfer) { * @param $settings * Array of settings for the FileTransfer. * - * @return + * @return \Drupal\Core\FileTransfer\FileTransfer|bool * An instantiated FileTransfer object for the requested method and settings, * or FALSE if there was an error finding or instantiating it. */ -function authorize_get_filetransfer($backend, $settings = array()) { + protected function getFiletransfer($backend, $settings = array()) { $filetransfer = FALSE; if (!empty($_SESSION['authorize_filetransfer_info'][$backend])) { $backend_info = $_SESSION['authorize_filetransfer_info'][$backend]; @@ -317,4 +245,79 @@ function authorize_get_filetransfer($backend, $settings = array()) { } } return $filetransfer; + } + + /** + * Generates the Form API array for a given connection backend's settings. + * + * @param string $backend + * The name of the backend (e.g. 'ftp', 'ssh', etc). + * + * @return array + * Form API array of connection settings for the given backend. + * + * @see hook_filetransfer_backends() + */ + protected function addConnectionSettings($backend) { + $auth_connection_config = $this->config('system.authorize')->get('filetransfer_connection_settings_' . $backend); + $defaults = $auth_connection_config ? $auth_connection_config : array(); + $form = array(); + + // Create an instance of the file transfer class to get its settings form. + $filetransfer = $this->getFiletransfer($backend); + if ($filetransfer) { + $form = $filetransfer->getSettingsForm(); + } + // Fill in the defaults based on the saved settings, if any. + $this->setConnectionSettingsDefaults($form, NULL, $defaults); + return $form; + } + + /** + * Sets the default settings on a file transfer connection form recursively. + * + * The default settings for the file transfer connection forms are saved in + * the database. The settings are stored as a nested array in the case of a + * settings form that has details or otherwise uses a nested structure. + * Therefore, to properly add defaults, we need to walk through all the + * children form elements and process those defaults recursively. + * + * @param $element + * Reference to the Form API form element we're operating on. + * @param $key + * The key for our current form element, if any. + * @param array $defaults + * The default settings for the file transfer backend we're operating on. + */ + protected function setConnectionSettingsDefaults(&$element, $key, array $defaults) { + // If we're operating on a form element which isn't a details, and we have + // a default setting saved, stash it in #default_value. + if (!empty($key) && isset($defaults[$key]) && isset($element['#type']) && $element['#type'] != 'details') { + $element['#default_value'] = $defaults[$key]; + } + // Now, we walk through all the child elements, and recursively invoke + // ourselves on each one. Since the $defaults settings array can be nested + // (because of #tree, any values inside details will be nested), if + // there's a subarray of settings for the form key we're currently + // processing, pass in that subarray to the recursive call. Otherwise, just + // pass on the whole $defaults array. + foreach (Element::children($element) as $child_key) { + $this->setConnectionSettingsDefaults($element[$child_key], $child_key, ((isset($defaults[$key]) && is_array($defaults[$key])) ? $defaults[$key] : $defaults)); + } + } + + /** + * Runs the operation specified in $_SESSION['authorize_operation']. + * + * @param $filetransfer + * The FileTransfer object to use for running the operation. + */ + protected function runOperation($filetransfer) { + $operation = $_SESSION['authorize_operation']; + unset($_SESSION['authorize_operation']); + + require_once DRUPAL_ROOT . '/' . $operation['file']; + call_user_func_array($operation['callback'], array_merge(array($filetransfer), $operation['arguments'])); + } + }