diff --git a/includes/plugin.inc b/includes/plugin.inc new file mode 100644 index 0000000..5d64168 --- /dev/null +++ b/includes/plugin.inc @@ -0,0 +1,280 @@ + TRUE)); + + $form['#attached']['css'][] = drupal_get_path('module', 'update') . '/update.css'; + $form['#attached']['js'][] = drupal_get_path('module', 'update') . '/update.js'; + // Get all the available ways to transfer files. + $available_backends = module_invoke_all('filetransfer_backends'); + if (!count($available_backends)) { + // @TODO: Clean up this error handling + drupal_set_message(t('Unable to continue, no available methods of file transfer'), 'error'); + return array(); + } + + uasort($available_backends, 'drupal_sort_weight'); + + // Decide on a default backend. + if (isset($form_state['values']['connection_settings']['update_filetransfer_default'])) { + $update_filetransfer_default = $form_state['values']['connection_settings']['update_filetransfer_default']; + } + elseif ($update_filetransfer_default = variable_get('update_filetransfer_default', NULL)); + else { + $update_filetransfer_default = key($available_backends); + } + + $form['information']['main_header'] = array( + '#prefix' => '

', + '#markup' => t('To upload your plugin please provide your server connection details'), + '#suffix' => '

', + ); + + $form['connection_settings']['#tree'] = TRUE; + $form['connection_settings']['update_filetransfer_default'] = array( + '#type' => 'select', + '#title' => t('Connection method'), + '#default_value' => $update_filetransfer_default, + '#weight' => -10, + ); + + /** + * Here we create two submit buttons. For a JS enabled client, + * they will only ever see submit_process. + * + * However, if a client doesn't have JS enabled, they will see submit_connection + * on the first form (whden picking what filetranfer type to use, and + * submit_process on the second one (which leads to the actual operation) + * + */ + $form['submit_connection'] = array( + '#prefix' => "
", + '#name' => 'enter_connection_settings', // This is later changed in JS. + '#type' => 'submit', + '#value' => t('Enter connetion settings'), // As is this. @see update.js. + '#weight' => 100, + ); + + $form['submit_process'] = array( + '#name' => 'process_updates', // This is later changed in JS. + '#type' => 'submit', + '#value' => t('Process Updates'), // As is this. @see update.js + '#weight' => 100, + '#attributes' => array('style' => 'display:none'), + ); + + // Build a hidden fieldset for each one. + foreach ($available_backends as $name => $backend) { + $form['connection_settings']['update_filetransfer_default']['#options'][$name] = $backend['title']; + $form['connection_settings'][$name] = array ( + '#type' => 'fieldset', + '#attributes' => array('class' => "filetransfer-$name filetransfer"), + '#title' => t('@backend connection settings', array('@backend' => $backend['title'])), + ); + + $current_settings = variable_get("update_filetransfer_connection_settings_" . $name, array()); + $form['connection_settings'][$name] += system_get_filetransfer_settings_form($name, $current_settings); + + // Start non-JS code. + if (isset($form_state['values']['connection_settings']['update_filetransfer_default']) && $form_state['values']['connection_settings']['update_filetransfer_default'] == $name) { + /** + * This means the form has been submitted by a non-JS user, and they have + * choosen a transfer type. + */ + + // If the user switches from JS to non-JS, Drupal (and Batch API) will barf. + // This is a known bug: http://drupal.org/node/229825. + setcookie('has_js', '', time() - 3600, '/'); + unset($_COOKIE['has_js']); + + // Change the submit button to the submit_process one. + $form['submit_process']['#attributes'] = array(); + unset($form['submit_connection']); + // + // Active the proper filetransfer settings form. + $form['connection_settings'][$name]['#attributes']['style'] = 'display:block'; + // Disable the select box. + $form['connection_settings']['update_filetransfer_default']['#disabled'] = TRUE; + + // Create a button for changing the type of connection. + $form['connection_settings']['change_connection_type'] = array ( + '#name' => 'change_connection_type', + '#type' => 'submit', + '#value' => t('Change connection type'), + '#weight' => -5, + '#attributes' => array('class' => 'filetransfer-change-connection-type'), + ); + } + //End non-JS code + } + return $form; +} + +/** + * Validate function for the main update form. + * + * @see update_update_form + */ +function plugin_filetransfer_form_validate($form, &$form_state) { + if ($form_state['clicked_button']['#name'] == 'process_updates') { + if (isset($form_state['values']['connection_settings'])) { + $backend = $form_state['values']['connection_settings']['update_filetransfer_default']; + $filetransfer = update_get_filetransfer($backend, $form_state['values']['connection_settings'][$backend]); + try { + if (!$filetransfer) { + throw new Exception($backend . " error, this type of connection protocol doesn't exist."); + } + $filetransfer->connect(); + } + catch(Exception $e) { + form_set_error('connection_settings', $e->getMessage()); + } + } + } +} + +/** + * Submit function for the main update form. + * + * @see update_update_form + */ +function plugin_filetransfer_form_submit($form, &$form_state) { + global $base_url; + switch ($form_state['clicked_button']['#name']) { + case 'process_updates': + + // Save the connection settings to the DB. + $filetransfer_backend = $form_state['values']['connection_settings']['update_filetransfer_default']; + + // If the database is available then try to save our settings. We have to make sure it is available + // since this code could potentially (will likely) be called during the installation process, before + // the database is setup. + if (db_is_active()) { + $connection_settings = array(); + foreach ($form_state['values']['connection_settings'][$filetransfer_backend] as $key => $value) { + if (!isset($form['connection_settings'][$filetransfer_backend][$key]['#filetransfer_save']) || + $form['connection_settings'][$filetransfer_backend][$key]['#filetransfer_save']) { + $connection_settings[$key] = $value; + } + } + // Set this one as the default update method. + variable_set('update_filetransfer_default', $filetransfer_backend); + // Save the connection settings minus the password. + variable_set("update_filetransfer_connection_settings_" . $filetransfer_backend, $connection_settings); + + // chmod the modules directory to 755 + $ft = update_get_filetransfer($filetransfer_backend, $form_state['values']['connection_settings'][$filetransfer_backend]); + + // I don't like doing this, but I don't know how else to store this information but in the session. + // See plugin.php for the consumption and deletion of this dangerous variable. + // Should also have some sort of forced clearing I suppose. + + $_SESSION['filetransfer_settings'] = $form_state['values']['connection_settings'][$filetransfer_backend]; + + _plugin_manager_create_and_setup_directories($ft, 0777); + + // Now run the batch. + plugin_manager_run_batch($ft); + } + break; + + case 'enter_connection_settings': + $form_state['rebuild'] = TRUE; + break; + + case 'change_connection_type': + $form_state['rebuild'] = TRUE; + unset($form_state['values']['connection_settings']['update_filetransfer_default']); + break; + } +} + +/** + * Creates the installation directories for different types of updates + * + * @param $filetransfer + * @param $mode + */ +function _plugin_manager_create_and_setup_directories($filetransfer, $mode = 0755) { + $updater_classes = update_get_updaters(); + + foreach ($updater_classes as $class) { + $install_location = call_user_func("{$class}::getInstallDirectory"); + // Make the parent dir writable if need be and create the dir. + if (!is_dir($install_location) && !is_writable(dirname($install_location))) { + $filetransfer->chmod(dirname($install_location), $mode, FALSE); + $filetransfer->createDirectory($install_location); + } + $filetransfer->chmod($install_location, $mode, FALSE); + } +} + +/** + * Blantantly (and shamefully) (and regrettably) ripped from update.php. + * + * Interim measure, this code is not very clear. + * @param array $messages + * @return string Report similar to update.php + */ +function get_plugin_report($messages) { + $output = ""; + // Output a list of queries executed + if (!empty($messages)) { + $output .= '
'; + $output .= '

The following actions were executed

'; + foreach ($messages as $module => $updates) { + $output .= '

' . $module . '

'; + foreach ($updates as $number => $queries) { + if ($number != '#abort') { + $output .= '

Update #' . $number . '

'; + $output .= '
    '; + foreach ($queries as $query) { + if ($query['success']) { + $output .= '
  • ' . $query['query'] . '
    • '; + } + else { + $output .= '
  • Failed: ' . $query['query'] . '
    • '; + } + } + if (!count($queries)) { + $output .= '
  • No queries
    • '; + } + } + $output .= '
'; + } + } + $output .= '
'; + } + return $output; +} + +function plugin_manager_run_batch($filetransfer) { + global $base_url; + drupal_set_title('Installing updates'); + $batch = $_SESSION['plugin_op']; + foreach ($batch['operations'] as $key => $args) { + // Add the filetransfer class + $function = $args[0]; + if ($function == 'update_batch_copy_project') { + $batch['operations'][$key][1][] = $filetransfer; + } + } + + batch_set($batch); + batch_process(url($base_url . '/plugin.php', array('absolute' => TRUE)), url($base_url . '/plugin.php', array('absolute' => TRUE, 'query' => array('batch' => 1)))); +} diff --git a/modules/system/system.module b/modules/system/system.module index f216497..d9ad707 100644 --- a/modules/system/system.module +++ b/modules/system/system.module @@ -1393,27 +1393,30 @@ function system_filetransfer_backend_form_ssh() { * Helper function because SSH and FTP backends share the same elements */ function _system_filetransfer_backend_form_common() { + $form = array(); + $form['hostname'] = array ( '#type' => 'textfield', '#title' => t('Host'), '#default_value' => 'localhost', ); - - $form['port'] = array ( + + $form['port'] = array( '#type' => 'textfield', '#title' => t('Port'), '#default_value' => NULL, ); - $form['username'] = array ( + $form['username'] = array( '#type' => 'textfield', '#title' => t('Username'), ); - $form['password'] = array ( + $form['password'] = array( '#type' => 'password', '#title' => t('Password'), '#description' => t('This is not saved in the database and is only used to test the connection'), + '#filetransfer_save' => FALSE, ); return $form; diff --git a/modules/update/update.admin.inc b/modules/update/update.admin.inc new file mode 100644 index 0000000..83d26ec --- /dev/null +++ b/modules/update/update.admin.inc @@ -0,0 +1,611 @@ + 'submit', + '#name' => 'process_updates', + '#value' => t('Install these updates'), + '#weight' => 100, + ); + } + return $form; +} + +/** + * The first page of the update form. + * This displays available updates in the form of a table. + */ +function _update_update_form_update_table() { + drupal_add_css('misc/ui/ui.all.css'); + drupal_add_css('misc/ui/ui.dialog.css'); + drupal_add_js('misc/ui/ui.core.js', array('weight' => JS_LIBRARY + 5)); + drupal_add_js('misc/ui/ui.dialog.js', array('weight' => JS_LIBRARY + 6)); + $form['#attached_js'][] = DRUPAL_ROOT . '/misc/plugin.js'; + + $form['#theme'] = 'update_available_updates_form'; + $form['projects'] = array(); + // First step. + $options = array(); + $available = update_get_available(TRUE); + if ($available) { + module_load_include('inc', 'update', 'update.compare'); + $project_data = update_calculate_project_data($available); + foreach ($project_data as $name => $project) { + // Filter out projects which are dev versions, updated or core + if (($project['install_type'] == 'dev') || ($project['project_type'] == 'core') || $project['status'] == UPDATE_CURRENT) { + continue; + } + $options[$name]['title'] = l($project['title'], $project['link']); + if ($project['project_type'] == 'theme') { + $options[$name]['title'] .= ' ' . t('(Theme)'); + } + $options[$name]['installed_version'] = $project['existing_version']; + $recommended_version = $project['releases'][$project['recommended']]; + $options[$name]['recommended_version'] = $recommended_version['version'] . ' ' . l(t('(Release notes)'), $recommended_version['release_link'], array('attributes' => array('title' => t('Release notes for @project_name', array('@project_name' => $project['title']))))); + if ($recommended_version['version_major'] != $project['existing_major']) { + $options[$name]['recommended_version'] .= '
' . t('This update is a major version update which means that it may not be backwards compatible with your currently running version. It is recommended that you read the release notes and proceed at your own risk.') . '
'; + } + + switch ($project['status']) { + case UPDATE_NOT_SECURE: + case UPDATE_REVOKED: + $options[$name]['title'] .= ' ' . t('(Security Update)'); + $options[$name]['#weight'] = -2; + $type = 'security'; + break; + case UPDATE_NOT_SUPPORTED: + $type = 'unsupported'; + $options[$name]['title'] .= ' ' . t('(Unsupported)'); + $options[$name]['#weight'] = -1; + break; + case UPDATE_UNKNOWN: + case UPDATE_NOT_FETCHED: + case UPDATE_NOT_CHECKED: + case UPDATE_NOT_CURRENT: + $type = 'recommended'; + break; + default: + // Continues out of the switch and then out of the foreach. + continue 2; + } + $options[$name]['#attributes'] = array('class' => array('update-' . $type)); + } + } + else { + $form['message'] = array( + '#markup' => t('There was a problem getting update information. Please try again later.'), + ); + return $form; + } + + if (!count($options)) { + $form['message'] = array( + '#markup' => t('All of your projects are up to date.'), + ); + return $form; + } + + $form['#attached_css'][] = drupal_get_path('module', 'update') . '/update.css'; + + $headers = array('title' => array('data' => t('Name'), 'class' => array('update-project-name')), 'installed_version' => t('Installed version'), 'recommended_version' => t('Recommended version')); + // This is the kill switch for being able to perform updates + if (update_plugin_manager_access()) { + $form['projects'] = array( + '#type' => 'tableselect', + '#options' => $options, + '#header' => $headers, + ); + + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Install these updates'), + '#weight' => 100, + ); + } + else { + $form['projects'] = array(); + $form['projects']['#type'] = "markup"; + $form['projects']['#markup'] = theme('table', $headers, $options); + } + + return $form; +} + +function _update_update_form_display_steps() { + $form['information']['#weight'] = -100; + $form['information']['backup_header'] = array( + '#prefix' => '

', + '#markup' => t('Step 1: Backup your site'), + '#suffix' => '

', + ); + + $form['information']['backup_message'] = array( + '#prefix' => '

', + '#markup' => t('We do not currently have a web based backup tool. Learn more about how to take a backup.', array('@backup_url' => url('http://drupal.org/node/22281'))), + '#suffix' => '

', + ); + + $form['information']['maint_header'] = array( + '#prefix' => '

', + '#markup' => t('Step 2: Enter maintenance mode'), + '#suffix' => '

', + ); + + $form['information']['maint_message'] = array( + '#prefix' => '

', + '#markup' => t('It is strongly recommended that you put your site into maintenance mode while performing an update.'), + '#suffix' => '

', + ); + + $form['information']['site_offline'] = array( + '#title' => t('Perform updates with site in maintenance mode'), + '#type' => 'checkbox', + '#default_value' => TRUE, + ); + + return $form; +} + +/** + * Submit function for the main update form. + * + * @see update_update_form() + */ +function update_update_form_submit($form, &$form_state) { + global $base_url; + switch ($form_state['clicked_button']['#name']) { + case 'process_updates': + + $operations = array(); + foreach ($form_state['storage']['projects'] as $project) { + // Put this in the begining (download everything first) + $operations[] = array('update_batch_get_project', array($project)); + $latest_version = _update_get_recommended_version($project); + // This is the .tar.gz from d.o. + $url = $latest_version['download_link']; + + $operations[] = array( + 'update_batch_copy_project', + array( + $project, + $url, + ), + ); + + $operations[] = array('update_batch_update_project', array($project)); + } + + $batch = array( + 'title' => t('Installing updates'), + 'init_message' => t('Preparing update operation'), + 'operations' => $operations, + 'finished' => 'update_batch_finished', + 'file' => drupal_get_path('module', 'update') . '/update.admin.inc', + ); + + $_SESSION['plugin_op'] = $batch; + + if ($form_state['values']['site_offline'] == TRUE) { + // Put site in offline mode. + variable_set('site_offline', TRUE); + } + drupal_goto(url($base_url . '/plugin.php', array('absolute' => TRUE))); + return; + + break; + + default: + $form_state['rebuild'] = TRUE; + // This is the first page, and store the list of selected projects + $form_state['storage']['projects'] = array_keys(array_filter($form_state['values']['projects'])); + break; + } +} + + +function update_install_form(&$form_state) { + $form = array(); + + $form['project_url'] = array( + '#type' => 'textfield', + '#title' => t('URL'), + '#description' => t('Paste the url to a Drupal module or theme archive (.tar.gz) here to install it. (e.g http://ftp.drupal.org/files/projects/projectname.tar.gz)'), + ); + + $form['information'] = array( + '#prefix' => '', + '#markup' => 'Or', + '#suffix' => '', + ); + + $form['project_upload'] = array( + '#type' => 'file', + '#title' => t('Upload a module or theme'), + '#description' => t('Upload a Drupal module or theme (in .tar.gz format) to install it.'), + ); + + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Install'), + ); + + return $form; +} + +function update_install_form_validate($form, &$form_state) { + if (!($form_state['values']['project_url'] XOR !empty($_FILES['files']['name']['project_upload']))) { + form_set_error('project_url', t('Unable to continue, please provide a url or upload a module / theme')); + return; + //$data = drupal_http_request($form_state['values']['url']); + } +} + +function update_install_form_submit($form, &$form_state) { + global $base_url; + + if ($form_state['values']['project_url']) { + $field = 'project_url'; + $local_cache = update_get_file($form_state['values']['project_url']); + if (!$local_cache) { + form_set_error($field, t('Unable to retreive Drupal project from %url', array('%url' => $form_state['values']['project_url']))); + return; + } + } + elseif ($_FILES['files']['name']['project_upload']) { + $field = 'project_upload'; + // @todo: add some validators here. + $finfo = file_save_upload($field, array(), NULL, FILE_EXISTS_REPLACE); + // @todo: find out if the module is already instealled, if so, throw an error. + $local_cache = $finfo->uri; + } + + watchdog('update', 'Un-tarring ' . drupal_realpath($local_cache)); + + $a = new Archive_Tar(drupal_realpath($local_cache)); + + $files = $a->listContent(); + if (!$files) { + form_set_error($field, t('Provided URL is not a .tar.gz archive', array('%url' => $form_state['values']['url']))); + return; + } + + $project = drupal_substr($files[0]['filename'],0,-1); // Unfortunately, we can only use the directory name for this. :( + + $project_location = DRUPAL_ROOT . '/' . file_directory_path('temporary') . '/update-extraction/' . $project; + update_untar(drupal_realpath($local_cache)); + + $updater = Updater::factory($project_location); + $project_title = Updater::getProjectTitle($project_location); + + if (!$project) { + form_set_error($field, t('Unable to determine %project name', array('%project' => $project_title))); + } + + if ($updater->isInstalled()) { + form_set_error($field, t('%project is already installed', array('%project' => $project_title))); + return; + } + + $operations = array(); + $operations[] = array( + 'update_batch_copy_project', + array( + $project, + $local_cache, + ), + ); + + $batch = array( + 'title' => t('Installing %project', array('%project' => $project_title)), + 'init_message' => t('Preparing update operation'), + 'operations' => $operations, + 'finished' => 'update_batch_finished', + 'file' => drupal_get_path('module', 'update') . '/update.admin.inc', + ); + + $_SESSION['plugin_op'] = $batch; + drupal_goto(url($base_url . '/plugin.php', array('absolute' => TRUE))); + return; + +} + +/** + * Batch operations related to installing / updating projects + */ + +/** + * Batch operation: download a project and put it in a temporary cache. + * + * @param string $project name of the project being installed + * @param array &$context BatchAPI storage + * + * @return void; + */ +function update_batch_get_project($project, &$context) { + if (!isset($context['results']['log'])) { + $context['results']['log'] = array(); + } + if (!isset($context['results']['log'][$project])) { + $context['results']['log'][$project] = array(); + } + if (!isset($context['sandbox']['started'])) { + $context['sandbox']['started'] = TRUE; + $context['message'] = t('Downloading %project', array('%project' => $project)); + $context['finished'] = 0; + return; + } + $latest_version = _update_get_recommended_version($project); + if ($local_cache = update_get_file($latest_version['download_link'])) { + watchdog('update', 'Downloaded %project to %local_cache', array('%project' => $project, '%local_cache' => $local_cache)); + } + else { + $context['success'] = FALSE; + $content['results'][$project][] = t('Failed to download %project', array('%project' => $project)); + } +} + + +/** + * Batch operation: copy a project to it's proper place. + * For updates, will locate the current project and replace it. + * For new installs, will download and try to determine the type from the info file + * and then place it variable_get(update_default_{$type}_location) i.e. update_default_module_location(). + * + * @todo Fix the $project param (refactor) + * @param string $project Either name of the project being installed or a + * @param string $url Location of a tarball to install if recommended version of $project not required + * @param string $filetransfer FileTransfer class + * @param array &$context BatchAPI storage + * + * @return void + */ +function update_batch_copy_project($project, $url, $filetransfer, &$context) { + + // Initialize some variables + if (!isset($context['results']['log'])) { + $context['results']['log'] = array(); + } + + if (!$context['results']['tasks']) { + $context['results']['tasks'] = array(); + } + + /** + * Unfortuantely, because the batch API uses a session and a connection + * pointer will be lost between requests, when doing an update of multiple + * modules, we need to unset the connection pointer to re-init a connect. + */ + unset($filetransfer->connection); + + if (!isset($context['results']['log'][$project])) { + $context['results']['log'][$project] = array(); + } + + if (!empty($context['results']['log'][$project]['#abort'])) { + $context['#finished'] = 1; + return; + } + + $local_cache = update_get_file($url); + + // This extracts the file into the standard place. + try { + update_untar($local_cache); + } + catch (Exception $e) { + _update_batch_create_message($context['results']['log'][$project], $e->getMessage(), FALSE); + $context['results']['log'][$project]['#abort'] = TRUE; + return; + } + + $project_source_dir = DRUPAL_ROOT . '/' . file_directory_path('temporary') . '/update-extraction/' . $project; + $updater = Updater::factory($project_source_dir); + + try { + if ($updater->isInstalled()) { + // This is an update. + $tasks = $updater->update($filetransfer); + } + else { + $tasks = $updater->install($filetransfer); + } + } + catch (UpdaterError $e) { + _update_batch_create_message($context['results']['log'][$project], t("Error installing / updating)"), FALSE); + $context['results']['log'][$project]['#abort'] = TRUE; + return; + } + + _update_batch_create_message($context['results']['log'][$project], t('Installed %project_name successfully', array('%project_name' => $project))); + $context['results']['tasks'] += $tasks; + + $context['finished'] = 1; +} + +/** + * Set the batch to run the update functions. + */ +function update_batch_update_project($project, &$context) { + + if (!empty($context['results']['log'][$project]['#abort'])) { + $context['#finished'] = 1; + return; + } + + if (_update_get_project_type($project) != 'module') { + $context['finished'] = 1; + return; + } + $operations = array(); + require_once './includes/update.inc'; + + foreach (_update_get_schema_updates($project) as $update) { + update_do_one($project, $update, $context); + } +} + +/** + * Batch callback for when the batch is finished. + */ +function update_batch_finished($success, $results) { + foreach ($results['log'] as $module => $messages) { + if (!empty($messages['#abort'])) { + $success = FALSE; + } + } + $_SESSION['update_batch_results']['success'] = $success; + $_SESSION['update_batch_results']['messages'] = $results['log']; + $_SESSION['update_batch_results']['tasks'] = $results['tasks']; +} + +/** + * + * Very stupid function to provide compatibility with update.php's + * silly functions + * Some better error handling is needed, but batch API doesn't seem to support any. + * + * @param array $project_results + * @param string $message + * @param bool $success + */ +function _update_batch_create_message(&$project_results, $message, $success = TRUE) { + $next_number = count($project_results) + 1; + $project_results[$next_number] = array(array('query' => $message, 'success' => $success)); +} + +/** + * Theme main updates page. + * + * @ingroup themeable + */ +function theme_update_available_updates_form($form) { + $last = variable_get('update_last_check', 0); + $output = '
' . ($last ? t('Last checked: @time ago', array('@time' => format_interval(REQUEST_TIME - $last))) : t('Last checked: never')); + $output .= ' (' . l(t('Check manually'), 'admin/reports/updates/check') . ')'; + $output .= "
\n"; + $output .= drupal_render_children($form); + return $output; +} + +/** + * Untar a file, using the Archive_Tar class. + * + * @param string $file the filename you wish to extract + * + * @return void + * @throws Exception on failure. + */ +function update_untar($file) { + $extraction_dir = DRUPAL_ROOT . '/' . file_directory_path('temporary') . '/update-extraction'; + if (!file_exists($extraction_dir)) { + mkdir($extraction_dir); + } + $archive_tar = new Archive_Tar(drupal_realpath($file)); + if (!$archive_tar->extract($extraction_dir)) { + throw new Exception(t('Unable to extact %file', array('%file' => $file))); + } +} + +/** + * Get a filetransfer class. + * + * @param $method + * The filetransfer method to get the class for. + * @param $overrides + * A set of overrides over the defaults. + */ +function update_get_filetransfer($method, $overrides = array()) { + // Fire up the connection class + $settings = variable_get("update_filetransfer_connection_settings_" . $method, array()); + $settings = array_merge($settings, $overrides); + $available_backends = module_invoke_all('filetransfer_backends'); + $filetransfer = call_user_func_array($available_backends[$method]['class'] . '::factory', array(DRUPAL_ROOT, $settings)); + return $filetransfer; +} + +/** + * Get a file from the server, or if it was already downloaded, get the local + * path to the file. + * + * @param $url + * The URL of the file on the server. + * + * @return string Path to local file + */ +function update_get_file($url) { + $parsed_url = parse_url($url); + $remote_schemes = array('http', 'https', 'ftp', 'ftps', 'smb', 'nfs'); + if (!in_array($parsed_url['scheme'], $remote_schemes)) { + // This is a local file, just return the path. + return drupal_realpath($url); + } + + // Check the cache and download the file if needed. + $local = 'temporary://update-cache/' . basename($parsed_url['path']); + + if (!file_exists(DRUPAL_ROOT . '/' . file_directory_path('temporary') . '/update-cache/')) { + mkdir(DRUPAL_ROOT . '/' . file_directory_path('temporary') . '/update-cache/'); + } + + if (!file_exists($local)) { + return system_retrieve_file($url, $local); + } + else { + return $local; + } +} + + +/** + * Get's the latest recommended release of a project. This function will + * prioritize updates on the same branch as the current version. + * + * @param string $name Name of the project + * @return array An array of information about the latest recommended + * release of the project + */ +function _update_get_recommended_version($name) { + if ($available = update_get_available(FALSE)) { + module_load_include('inc', 'update', 'update.compare'); + $project_data = update_calculate_project_data($available); + $project = $project_data[$name]; + return $project['releases'][$project['recommended']]; + } +} +/** + * Returns a list of classes which implement the DrupalUpdater interface + * + * @return array + */ +function update_get_updaters() { + $updaters = drupal_static(__FUNCTION__); + if (!$updaters) { + $updaters = array(); + foreach(get_declared_classes() as $class) { + if (in_array('DrupalProjectUpdater', class_implements($class))) { + $updaters[] = $class; + } + } + } + return $updaters; +} diff --git a/modules/update/update.css b/modules/update/update.css index 5a3e1e5..cd8ae83 100644 --- a/modules/update/update.css +++ b/modules/update/update.css @@ -108,3 +108,34 @@ table.update, .update .check-manually { padding-left: 1em; /* LTR */ } + + +table tbody tr.update-security, +table tbody tr.update-unsupported { + background: #fcc; +} + +th.update-project-name { + width: 50%; +} + +.connection-settings-update-filetransfer-default-wrapper { + float:left; +} + +#edit-submit-connection { + clear: both; +} + +.filetransfer { + display:none; + clear:both; +} + +#edit-connection-settings-change-connection-type { + margin: 2.6em 0.5em 0em 1em; +} + +.update-major-version-warning { + color:#ff0000; +} \ No newline at end of file diff --git a/modules/update/update.fetch.inc b/modules/update/update.fetch.inc index 2340200..4629158 100644 --- a/modules/update/update.fetch.inc +++ b/modules/update/update.fetch.inc @@ -46,7 +46,7 @@ function _update_refresh() { // to clear out the stale data at this point. _update_cache_clear('update_available_releases'); - $max_fetch_attempts = variable_get('update_max_fetch_attempts', UPDATE_MAX_FETCH_ATTEMPTS); + $max_fetch_attempts = variable_get('update_max_fetch_attempts', UPDATE_MAX_FETCH_ATTEMPTS); foreach ($projects as $key => $project) { $url = _update_build_fetch_url($project, $site_key); diff --git a/modules/update/update.info b/modules/update/update.info index 76be843..deb6094 100644 --- a/modules/update/update.info +++ b/modules/update/update.info @@ -6,6 +6,9 @@ package = Core core = 7.x files[] = update.compare.inc files[] = update.fetch.inc +files[] = update.admin.inc +files[] = updaters.inc +files[] = update.js files[] = update.install files[] = update.module files[] = update.report.inc diff --git a/modules/update/update.js b/modules/update/update.js new file mode 100644 index 0000000..86af5c6 --- /dev/null +++ b/modules/update/update.js @@ -0,0 +1,38 @@ +// $Id$ +(function ($) { + +Drupal.behaviors.updateFileTransferForm = { + attach: function(context) { + $('#edit-connection-settings-update-filetransfer-default').change(function() { + $('.filetransfer').hide().filter('.filetransfer-' + $(this).val()).show(); + }); + $('.filetransfer').hide().filter('.filetransfer-' + $('#edit-connection-settings-update-filetransfer-default').val()).show(); + + // Hide any major version warnings, make a jquery UI dialog when checked. + + $('.update-major-version-warning').each(function (elem) { + that = $(this); + $(this).hide(); + $(":checkbox", $(this).parent().parent()).bind('change', function(e) { + if (this.checked) { + that.dialog("open"); + var buttons = {} + buttons[Drupal.t("Ok")] = function() { $(this).dialog("close"); }; + buttons[Drupal.t("Cancel")] = function() { alert('cancel'); $(this).dialog("close"); }; + that.dialog({'buttons': buttons}); + } + }); + }); + + // Removes the float on the select box (used for non-JS interface) + if($('.connection-settings-update-filetransfer-default-wrapper').length > 0) { + console.log($('.connection-settings-update-filetransfer-default-wrapper')); + $('.connection-settings-update-filetransfer-default-wrapper').css('float', 'none'); + } + // Hides the submit button for non-js users + $('#edit-submit-connection').hide(); + $('#edit-submit-process').show(); + } +} + +})(jQuery); diff --git a/modules/update/update.module b/modules/update/update.module index f18e966..7af8a69 100644 --- a/modules/update/update.module +++ b/modules/update/update.module @@ -67,10 +67,22 @@ define('UPDATE_MAX_FETCH_ATTEMPTS', 2); function update_help($path, $arg) { switch ($path) { case 'admin/reports/updates': + case 'admin/reports/full': global $base_url; $output = '

' . t('Here you can find information about available updates for your installed modules and themes. Note that each module or theme is part of a "project", which may or may not have the same name, and might include multiple modules or themes within it.') . '

'; - $output .= '

' . t('To extend the functionality or to change the look of your site, a number of contributed modules and themes are available.', array('@modules' => 'http://drupal.org/project/modules', '@themes' => 'http://drupal.org/project/themes')) . '

'; - $output .= '

' . t('Each time Drupal core or a contributed module or theme is updated, it is important that update.php is run.', array('@update-php' => url($base_url . '/update.php', array('external' => TRUE)))) . '

'; + + return $output; + + case 'admin/reports/updates/install': + global $base_url; + $help = <<modules and themes at +http://drupal.org. +EOF; + $output = '

' . t($help, array('@module_url' => 'http://drupal.org/project/modules', '@theme_url' => 'http://drupal.org/project/themes')) . '

'; + return $output; case 'admin/appearance': case 'admin/config/modules': @@ -127,18 +139,48 @@ function update_menu() { $items = array(); $items['admin/reports/updates'] = array( - 'title' => 'Available updates', - 'description' => 'Get a status report about available updates for your installed modules and themes.', - 'page callback' => 'update_status', + 'title' => 'Updates and Add-ons', + 'description' => 'Keep your installed modules and themes up to date and install new ones.', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('update_update_form'), 'access arguments' => array('administer site configuration'), 'weight' => 10, - 'file' => 'update.report.inc', + 'type' => MENU_NORMAL_ITEM, + 'file' => 'update.admin.inc', ); - $items['admin/reports/updates/list'] = array( - 'title' => 'List', + + $items['admin/reports/updates/updater'] = array( + 'title' => 'Update', + 'description' => 'Update your installed modules and themes', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('update_update_form'), 'access arguments' => array('administer site configuration'), + 'weight' => 10, 'type' => MENU_DEFAULT_LOCAL_TASK, + 'file' => 'update.admin.inc', + ); + + $items['admin/reports/updates/full'] = array( + 'title' => 'Full update report', + 'description' => 'A comprehensive list of all modules installed on your system and their status.', + 'page callback' => 'update_status', + 'access arguments' => array('administer site configuration'), + 'weight' => 30, + 'type' => MENU_LOCAL_TASK, + 'file' => 'update.report.inc', + ); + + $items['admin/update'] = array( + 'title' => 'Updating your site', + 'description' => 'Second step of site update / new project install', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('update_update_form'), + 'access arguments' => array('administer site configuration'), + 'weight' => 10, + 'type' => MENU_CALLBACK, + 'file' => 'update.admin.inc', ); + $items['admin/reports/updates/settings'] = array( 'title' => 'Settings', 'page callback' => 'drupal_get_form', @@ -146,7 +188,9 @@ function update_menu() { 'access arguments' => array('administer site configuration'), 'file' => 'update.settings.inc', 'type' => MENU_LOCAL_TASK, + 'weight' => 50, ); + $items['admin/reports/updates/check'] = array( 'title' => 'Manual update check', 'page callback' => 'update_manual_status', @@ -155,16 +199,42 @@ function update_menu() { 'file' => 'update.fetch.inc', ); + $items['admin/config/modules/install'] = array( + 'title' => 'Install', + 'description' => 'Install new modules and themes', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('update_install_form'), + 'access callback' => 'update_plugin_manager_access', + 'access arguments' => array(), + 'weight' => 20, + 'type' => MENU_LOCAL_TASK, + 'file' => 'update.admin.inc', + ); + + $items['admin/appearance/install'] = array( + 'title' => 'Install', + 'description' => 'Install', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('update_install_form'), + 'access callback' => 'update_plugin_manager_access', + 'access arguments' => array(), + 'weight' => 20, + 'type' => MENU_LOCAL_TASK, + 'file' => 'update.admin.inc', + ); + return $items; } + /** - * Implement the hook_theme() registry. + * Implements hook_theme(). */ function update_theme() { return array( - 'update_settings' => array( + 'update_available_updates_form' => array( 'arguments' => array('form' => NULL), + 'file' => 'update.admin.inc', ), 'update_report' => array( 'arguments' => array('data' => NULL), @@ -645,6 +715,12 @@ function update_flush_caches() { return array(); } + +function update_plugin_manager_access() { + return variable_get('plugin_manager_enabled', TRUE); +} + + /** * @} End of "defgroup update_status_cache". */ diff --git a/modules/update/updaters.inc b/modules/update/updaters.inc new file mode 100644 index 0000000..1c7c5e7 --- /dev/null +++ b/modules/update/updaters.inc @@ -0,0 +1,392 @@ +source = $source; + $this->name = self::getProjectName($source); + $this->title = self::getProjectTitle($source); + } + + /** + * Returns an Updater of the approiate type depending on the source provided. + * + * @param string $source Directory of a Drupal project + * @return object Child of Updater + */ + static function factory($source) { + if (is_dir($source)) { + $updater = self::getUpdaterFromDirectory($source); + } + else { + throw new UpdaterError('Unable to determine the type of the source directory'); + } + return new $updater($source); + } + + /** + * Determines the project type (and assocaited updater class) + * from the available Updater child classes. + * + * @param string $directory Extracted Drupal project. + * @return string The class name which can work with this project type. + */ + static function getUpdaterFromDirectory($directory) { + // Gets a list of possible implementing classes + $updaters = update_get_updaters(); + foreach ($updaters as $updater) { + if (call_user_func("{$updater}::canUpdateDirectory", $directory)) { + return $updater; + } + } + throw new UpdaterError("Cannot determine the type of project"); + } + + /** + * Since there is no enforcement of which info file is the project's info file + * This will get one with the same name as the directory, or the first one it + * finds. Sucks, yes. But needs a larger solution. + * + * @param string $directory + * Directory to search in + * @return string + * Path to the info file + */ + public static function findInfoFile($directory) { + $info_files = file_scan_directory($directory, '/.*\.info/'); + if (!$info_files) { + return FALSE; + } + foreach ($info_files as $info_file) { + if (drupal_substr($info_file->filename, 0, -5) == basename($directory)) { + // Has the same name as the directory, is prefered. + return $info_file->uri; + } + } + // Return the first one. + $info_file = array_shift($info_files); + return $info_file->uri; + } + + /** + * Gets the name of the project directory (basename). + * + * @param string $directory + * @return string + */ + public static function getProjectName($directory) { + return basename($directory); + } + + + /** + * From the info file of a project, gets the project name + * + * @param string $directory + * Directory to search for the info file. + * @return string + */ + public static function getProjectTitle($directory) { + $info_file = self::findInfoFile($directory); + $info = drupal_parse_info_file($info_file); + if (!$info) { + //@TODO: Add the variables, t(), etc + throw new UpdaterError("Unable to parse info file"); + } + return $info['name']; + } + + /** + * Stores default parameters for the Updater. + * + * @param array $overrides + * An array of overrides. + * @return array + * An array of configuration parameters for an update or install operation + */ + private function getInstallArgs($overrides = array()) { + $args = array( + 'make_backup' => FALSE, + 'install_dir' => $this->getInstallDirectory(), + 'backup_dir' => $this->getBackupDir(), + ); + return array_merge($args, $overrides); + } + + /** + * Updates a Drupal project, returns a list of next actions + * + * @param FileTransfer $ft + * Object which is a child of FileTransfer + * @param array $overrides + * An array of settings to override defaults + * @see self::getInstallArgs + * @return array + * An array of links which the user may need to complete the update + */ + public function update(&$ft, $overrides = array()) { + try { + // Establish arguments with possible overrides. + $args = $this->getInstallArgs($overrides); + + // Take a Backup. + if ($args['make_backup']) { + $this->makeBackup($args['install_dir'], $args['backup_dir']); + } + + if (!$this->name) { + //This is bad, don't want delte the install dir. + throw new UpdaterError("Fatal error in update, cowardly refusing to wipe out the install directory"); + } + + // Remove the existing installed file. + $ft->removeDirectory($args['install_dir'] . '/' . $this->name); + // Copy the directory in place. + $ft->copyDirectory($this->source, $args['install_dir']); + // Run the updates + // @TODO: decide if we want to implement this. + $this->postUpdate(); + // For now, just return a list of links of things to do. + return $this->postUpdateTasks(); + } catch (FileTransferException $e) { + throw new UpdaterError(t("File Transfer failed, reason: !reason", array ('!reason' => t($e->getMessage(), $this->arguments)))); + } + } + + /** + * Installs a Drupal project, returns a list of next actions + * + * @param FileTransfer $ft + * Object which is a child of FileTransfer + * @param array $overrides + * An array of settings to override defaults + * @see self::getInstallArgs + * @return array + * An array of links which the user may need to complete the install + */ + public function install(&$ft, $overrides = array()) { + try { + // Establish arguments with possible overrides. + $args = $this->getInstallArgs($overrides); + // Copy the directory in place. + $ft->copyDirectory($this->source, $args['install_dir']); + // Potentially enable something? + // @TODO: decide if we want to implement this. + $this->postInstall(); + // For now, just return a list of links of things to do. + return $this->postInstallTasks(); + } + catch (FileTransferException $e) { + throw new UpdateError(t("File Transfer failed, reason: !reason", array ('!reason' => t($e->getMessage(), $this->arguments)))); + } + } + + function makeBackup(&$ft, $from, $to) { + //@TODO: Not implemented + } + + function getBackupDir() { + return file_directory_path('temporary'); + } + + /** + * Needs to be overridden by children to work + * Actions to take after the update is complete. + */ + function postUpdate() { + + } + + /** + * Needs to be overridden by children to work + * Actions to take after the install is complete. + */ + function postInstall() { + + } + + /** + * + * @return array Links which provide actions to take after the install is finished. + */ + function postInstallTasks() { + return array(); + } + + /** + * + * @return array Links which provide actions to take after the update is finished. + */ + function postUpdateTasks() { + return array(); + } +} + +class ModuleUpdater extends Updater implements DrupalProjectUpdater{ + + static function getInstallDirectory() { + return DRUPAL_ROOT . '/' . conf_path() . '/modules'; + } + + function isInstalled() { + return (bool) drupal_get_path('module', $this->name); + } + + function installProject() { + + } + + static function canUpdateDirectory($directory) { + if (file_scan_directory($directory, '/.*\.module/')) { + return TRUE; + } + return FALSE; + } + + function getSchemeUpdates() { + require_once './includes/install.inc'; + require_once './includes/update.inc'; + + if (_update_get_project_type($project) != 'module') { + return array(); + } + module_load_include('install', $project); + + if (!$updates = drupal_get_schema_versions($project)) { + return array(); + } + $updates_to_run = array(); + $modules_with_updates = update_get_update_list(); + if ($updates = $modules_with_updates[$project]) { + if ($updates['start']) { + return $updates['pending']; + } + } + return array(); + } + + /** + * @return array Links which provide actions to take after the install is finished. + */ + function postInstallTasks() { + + return array ( + l(t('Enable newly added modules in !project', array('!project' => $this->title)), 'admin/config/modules'), + ); + } + +} + +class ThemeUpdater extends Updater implements DrupalProjectUpdater{ + public $installDirectory; + + static function getInstallDirectory() { + return DRUPAL_ROOT . '/' . conf_path() . '/themes'; + } + + function isInstalled() { + return (bool) drupal_get_path('theme', $this->name); + } + + function installProject() { + + } + + static function canUpdateDirectory($directory) { + // This is a shitty test, but don't know how else to confirm + if (file_scan_directory($directory, '/.*\.module/')) { + return FALSE; + } + return TRUE; + } + + function postInstall() { + // Update the system table. + system_get_theme_data(); + + // Active the theme + db_update('system') + ->fields(array('status' => 1)) + ->condition('type', 'theme') + ->condition('name', $this->name) + ->execute(); + } + + function postInstallTasks() { + return array ( + l(t('Set the !project theme as default', array('!project' => $this->title)), 'admin/appearance'), + ); + } + + function postUpdateTasks() { + // If there are schema updates + return array ( + l(t('Run database updates for !project', array('!project' => $this->title)), 'update.php'), + ); + } +} + +/** + * @TODO: implement this. + */ +class ProfileUpdater extends Updater { + function installProject() { + + } +} + +class UpdaterError extends Exception { + +} +?> diff --git a/plugin.php b/plugin.php new file mode 100644 index 0000000..e93b427 --- /dev/null +++ b/plugin.php @@ -0,0 +1,134 @@ +uid != 1) { + print theme('update_page', $output, !$progress_page); + exit; + } + global $base_url; + + //module_list(TRUE, FALSE, $module_list); + + // Turn error reporting back on. From now on, only fatal errors (which are + // not passed through the error handler) will cause a message to be printed. + ini_set('display_errors', TRUE); + + + drupal_load_updates(); + + update_fix_d7_requirements(); + update_fix_compatibility(); + + if (isset($_SESSION['update_batch_results']) && $results = $_SESSION['update_batch_results']) { + // If this variable is set it means that the user entered FTP details because + // they needed to chmod the sites/default/* dirs. We want to set them back. + if (isset($_SESSION['filetransfer_settings'])) { + $filetransfer_settings = $_SESSION['filetransfer_settings']; + + // This contains the user's sensative credentials, we have to make sure + // that it gets unset. + unset($_SESSION['filetransfer_settings']); + + $filetransfer_backend = variable_get('update_filetransfer_default', NULL); + $ft = update_get_filetransfer($filetransfer_backend, $filetransfer_settings); + // This sets the permissions to non-writable for everyone. + _plugin_manager_create_and_setup_directories($ft, 0755); + } + + //Clear the session out; + unset($_SESSION['update_batch_results']); + + //Add the update.php functions and css + include_once './includes/update.inc'; + drupal_add_css('modules/system/maintenance.css'); + + if ($results['success']) { + variable_set('site_offline', FALSE); + drupal_set_message(t("Update was completed successfully! Your site has been taken out of maintenance mode.")); + } + else { + drupal_set_message(t("Update failed! See the log below for more information. Your site is still in maintenance mode"), 'error'); + } + + $output = ""; + $output .= get_plugin_report($results['messages']); + drupal_set_title('Update complete'); + + $links = array(); + if (is_array($results['tasks'])) { + $links += $results['tasks']; + } + + + $links = array_merge($links, array( + l('Administration pages', 'admin'), + l('Front page', ''), + )); + + $output .= theme('item_list', $links); + + print theme('update_page', $output); + return; + } + + if (isset($_GET['batch'])) { + $output = _batch_page(); + } else { + + if (empty($_SESSION['plugin_op'])) { + $output = t("It appears you have reached this page in error."); + print theme('update_page', $output); + return; + } + elseif (!$batch = batch_get()) { + // We have a batch to process, show the filetransfer form. + $output = drupal_render(drupal_get_form('plugin_filetransfer_form')); + } + } + + if (!empty($output)) { + // We defer the display of messages until all updates are done. + $progress_page = ($batch = batch_get()) && isset($batch['running']); + print theme('update_page', $output, !$progress_page); + } +}