Index: plugin.php =================================================================== RCS file: plugin.php diff -N plugin.php --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ plugin.php 12 Oct 2009 20:04:33 -0000 @@ -0,0 +1,173 @@ +'), + )); + + $output .= theme('item_list', array('items' => $links)); + } + // If a batch is running, let it run. + elseif (isset($_GET['batch'])) { + $output = _batch_page(); + } + else { + if (empty($_SESSION['plugin_op'])) { + $output = t("It appears you have reached this page in error."); + } + elseif (!$batch = batch_get()) { + // We have a batch to process, show the filetransfer form. + $output = drupal_render(drupal_get_form('plugin_filetransfer_form')); + } + } + // We defer the display of messages until all updates are done. + $show_messages = !(($batch = batch_get()) && isset($batch['running'])); +} +else { + $output = plugin_access_denied_page(); +} + +if (!empty($output)) { + print theme('update_page', array('content' => $output, 'show_messages' => $show_messages)); +} + cvs diff: Diffing includes Index: includes/plugin.inc =================================================================== RCS file: includes/plugin.inc diff -N includes/plugin.inc --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ includes/plugin.inc 12 Oct 2009 18:43:57 -0000 @@ -0,0 +1,359 @@ + '

', + '#markup' => t('To continue 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 (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(t("Error, this type of connection protocol (%backend) doesn't exist.", array('%backend' => $backend))); + } + $filetransfer->connect(); + } + catch (Exception $e) { + form_set_error('connection_settings', $e->getMessage()); + } + } +} + +/** + * Submit function to handle server creds being entered. + * + * @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 set up. + if (db_is_active()) { + $connection_settings = array(); + foreach ($form_state['values']['connection_settings'][$filetransfer_backend] as $key => $value) { + // We do *not* want to store passwords in the database, unless the + // backend explicitly says so via the magic #filetransfer_save form + // property. Otherwise, we store everything that's not explicitly + // marked with #filetransfer_save set to FALSE. + if (!isset($form['connection_settings'][$filetransfer_backend][$key]['#filetransfer_save'])) { + if ($form['connection_settings'][$filetransfer_backend][$key]['#type'] != 'password') { + $connection_settings[$key] = $value; + } + } + // The attribute is defined, so only save if set to TRUE. + elseif ($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]); + + try { + // Create the modules and themes directories if needed. + _plugin_manager_create_and_setup_directories($ft); + } catch (Exception $e) { + drupal_set_message($e->getMessage(), 'error'); + return; + } + + // 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 all of the types of + * projects that can be operated on. + * + * @param FileTransfer $filetransfer + */ +function _plugin_manager_create_and_setup_directories($filetransfer) { + $updater_classes = update_get_updaters(); + + foreach ($updater_classes as $class) { + $parent_dir = ''; + + $install_location = call_user_func("{$class}::getInstallDirectory"); + // Make the parent dir writable if need be and create the dir. + if (!is_dir($install_location)) { + $parent_dir = dirname($install_location); + if (!is_writable($parent_dir)) { + @chmod($parent_dir, 0755); + /** + * It is expected that this will fail if the conf_dir() + * is owned by the FTP user. If the FTP user == web server, + * it will succeed. + */ + } + try { + $filetransfer->createDirectory($install_location); + plugin_make_world_executable($filetransfer, $install_location); + } + catch (FileTransferException $e) { + /** + * Probably still not writable. Try to chmod and do it again. + * @todo: Make a new exception class so we can catch it differently. + */ + try { + $old_perms = substr(sprintf('%o', fileperms($parent_dir)), -4); + $filetransfer->chmod($parent_dir, 0755); + $filetransfer->createDirectory($install_location); + plugin_make_world_executable($filetransfer, $install_location); + + // Put the permissions back + $filetransfer->chmod($parent_dir, intval($old_perms, 8)); + } + catch (FileTransferException $e) { + $message = t($e->getMessage(), $e->arguments); + $throw_message = t('Unable to create %directory due to the following: %reason', array('%directory' => $install_location, '%reason' => $message)); + throw new Exception($throw_message); + } + } + // Put the parent directory back. + @chmod($parent_dir, 0555); + } + } +} + +/** + * Ensures that the provided directory is executable by the server + * + * @param FileTransfer $filetransfer + * A FileTransfer classes used to chmod + * @param string $directory + * The directory to set + * @param bool $recursive + * If the chmod should be applied recursively. + * + * @throws FileTransferException + * If the FileTransfer being used doesn't support chmod + * or there is some other error. + * + * @return void + */ +function plugin_make_world_executable(&$filetransfer, $directory, $recursive = TRUE) { + if (!is_executable($directory)) { + // Set it to read + execute. + $new_perms = substr(sprintf('%o', fileperms($directory)), -4, -1) . "5"; + $filetransfer->chmod($directory, intval($new_perms, 8), $recursive); + } +} + +/** + * 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 .= ''; + } + } + $output .= '
'; + } + return $output; +} + + +/** + * Runs the batch operation specified in $_SESSION['plugin_op'] + * + * @global string $base_url + * @param FileTransfer $filetransfer + */ +function plugin_manager_run_batch($filetransfer) { + global $base_url; + drupal_set_title('Installing updates'); + $batch = $_SESSION['plugin_op']; + unset($_SESSION['plugin_op']); + foreach ($batch['operations'] as $key => $args) { + // Add the filetransfer class to the existing batch which was defined elsewhere. + // This is obviously not pretty, but don't know a better method. + $function = $args[0]; + if ($function == 'update_batch_copy_project') { + $batch['operations'][$key][1][] = $filetransfer; + } + } + + batch_set($batch); + batch_process($base_url . '/plugin.php', $base_url . '/plugin.php?batch=1'); +} cvs diff: Diffing includes/database cvs diff: Diffing includes/database/mysql cvs diff: Diffing includes/database/pgsql cvs diff: Diffing includes/database/sqlite cvs diff: Diffing includes/filetransfer Index: includes/filetransfer/ftp.inc =================================================================== RCS file: /Users/wright/drupal/local_repo/drupal/includes/filetransfer/ftp.inc,v retrieving revision 1.6 diff -u -p -r1.6 ftp.inc --- includes/filetransfer/ftp.inc 28 Aug 2009 07:51:55 -0000 1.6 +++ includes/filetransfer/ftp.inc 12 Oct 2009 05:08:34 -0000 @@ -5,6 +5,15 @@ * Connection class using the FTP URL wrapper. */ class FileTransferFTPWrapper extends FileTransfer { + + public function __construct($jail, $username, $password, $hostname, $port) { + $this->username = $username; + $this->password = $password; + $this->hostname = $hostname; + $this->port = $port; + parent::__construct($jail); + } + function connect() { $this->connection = 'ftp://' . urlencode($this->username) . ':' . urlencode($this->password) . '@' . $this->hostname . ':' . $this->port . '/'; if (!is_dir($this->connection)) { @@ -19,29 +28,29 @@ class FileTransferFTPWrapper extends Fil } function createDirectoryJailed($directory) { - if (!@drupal_mkdir($directory)) { + if (!@drupal_mkdir($this->connection . $directory)) { $exception = new FileTransferException('Cannot create directory @directory.', NULL, array('@directory' => $directory)); throw $exception; } } function removeDirectoryJailed($directory) { - if (is_dir($directory)) { - $dh = opendir($directory); + if (is_dir($this->connection . $directory)) { + $dh = opendir($this->connection . $directory); while (($resource = readdir($dh)) !== FALSE) { if ($resource == '.' || $resource == '..') { continue; } $full_path = $directory . DIRECTORY_SEPARATOR . $resource; - if (is_file($full_path)) { + if (is_file($this->connection . $full_path)) { $this->removeFile($full_path); } - elseif (is_dir($full_path)) { + elseif (is_dir($this->connection . $full_path)) { $this->removeDirectory($full_path . '/'); } } closedir($dh); - if (!rmdir($directory)) { + if (!rmdir($this->connection . $directory)) { $exception = new FileTransferException('Cannot remove @directory.', NULL, array('@directory' => $directory)); throw $exception; } @@ -70,15 +79,18 @@ class FileTransferFTPWrapper extends Fil } /** - * This is impossible with the stream wrapper, - * So we cheat and use the other implementation + * This is impossible with the stream wrapper, so an exception is thrown. + * + * If the ftp extenstion is available, we will cheat and use it. * - * @staticvar FileTransferFTPExtension $ftp_ext_file_transfer * @param string $path * @param long $mode * @param bool $recursive */ function chmodJailed($path, $mode, $recursive) { + if (!function_exists('ftp_connect')) { + throw new FileTransferException('Unable to set permissions on @path. Change umask settings on server to be world executable.', array('@path' => $path)); + } static $ftp_ext_file_transfer; if (!$ftp_ext_file_transfer) { cvs diff: Diffing modules/update Index: modules/update/update.admin.inc =================================================================== RCS file: modules/update/update.admin.inc diff -N modules/update/update.admin.inc --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ modules/update/update.admin.inc 12 Oct 2009 16:54:13 -0000 @@ -0,0 +1,735 @@ + 'submit', + '#name' => 'process_updates', + '#value' => t('Install updates'), + '#weight' => 100, + ); + } + return $form; +} + +/** + * Build the form for the first page in the update form workflow. + * + * This presents a table with all plugins that have available updates with + * checkboxes to select which ones to upgrade. + * + * @param $context + * String representing the context from which we're trying to update, can be: + * 'module', 'theme' or 'report'. + * @return + * Form array for the first page of the update form. + */ +function _update_update_form_select_plugins($context) { + $form['#theme'] = 'update_available_updates_form'; + + $available = update_get_available(TRUE); + if (empty($available)) { + $form['message'] = array( + '#markup' => t('There was a problem getting update information. Please try again later.'), + ); + return $form; + } + + 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['#attached']['css'][] = drupal_get_path('module', 'update') . '/update.css'; + + // This will be a nested array. The first key is the kind of project, which + // can be either 'enabled', 'disabled', 'manual-enabled' (enabled add-ons + // which require manual updates, such as core or -dev projects) or + // 'manual-disabled' (disabled add-ons that need a manual update). Then, + // each subarray is an array of projects of that type, indexed by project + // short name, and containing an array of data for cells in that project's + // row in the appropriate table. + $projects = array(); + + 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 up2date already. + if ($project['status'] == UPDATE_CURRENT) { + continue; + } + // The project name to display can vary based on the info we have. + if (!empty($project['title'])) { + if (!empty($project['link'])) { + $project_name = l($project['title'], $project['link']); + } + else { + $project_name = check_plain($project['title']); + } + } + elseif (!empty($project['info']['name'])) { + $project_name = check_plain($project['info']['name']); + } + else { + $project_name = check_plain($name); + } + if ($project['project_type'] == 'theme' || $project['project_type'] == 'theme-disabled') { + $project_name .= ' ' . t('(Theme)'); + } + + if (empty($project['recommended'])) { + // If we don't know what to recommend they upgrade to, we should skip + // the project entirely. + continue; + } + + $recommended_release = $project['releases'][$project['recommended']]; + $recommended_version = $recommended_release['version'] . ' ' . l(t('(Release notes)'), $recommended_release['release_link'], array('attributes' => array('title' => t('Release notes for @project_name', array('@project_name' => $project_name))))); + if ($recommended_release['version_major'] != $project['existing_major']) { + $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.') . '
'; + } + + // Create an entry for this project. + $entry = array( + 'title' => $project_name, + 'installed_version' => $project['existing_version'], + 'recommended_version' => $recommended_version, + ); + + switch ($project['status']) { + case UPDATE_NOT_SECURE: + case UPDATE_REVOKED: + $entry['title'] .= ' ' . t('(Security Update)'); + $entry['#weight'] = -2; + $type = 'security'; + break; + + case UPDATE_NOT_SUPPORTED: + $type = 'unsupported'; + $entry['title'] .= ' ' . t('(Unsupported)'); + $entry['#weight'] = -1; + break; + + case UPDATE_UNKNOWN: + case UPDATE_NOT_FETCHED: + case UPDATE_NOT_CHECKED: + case UPDATE_NOT_CURRENT: + $type = 'recommended'; + break; + + default: + // Jump out of the switch and onto the next project in foreach. + continue 2; + } + + $entry['#attributes'] = array('class' => array('update-' . $type)); + + // Based on what kind of project this is, save the entry into the + // appropriate subarray. + switch ($project['project_type']) { + case 'core': + // Core is always enabled, but need manual updates at this time. + $projects['manual-enabled'][$name] = $entry; + break; + + case 'module': + case 'theme': + // Projects which are dev versions with no stable release need + // to be upgrade manually. + if (($project['install_type'] == 'dev' && $recommended_release['version_extra'] == 'dev')) { + $projects['manual-enabled'][$name] = $entry; + } + else { + $projects['enabled'][$name] = $entry; + } + break; + + case 'module-disabled': + case 'theme-disabled': + // Projects which are dev versions with no stable release need + // to be upgrade manually. + if (($project['install_type'] == 'dev' && $recommended_release['version_extra'] == 'dev')) { + $projects['manual-disabled'][$name] = $entry; + } + else { + $projects['disabled'][$name] = $entry; + } + break; + } + } + + if (empty($projects)) { + $form['message'] = array( + '#markup' => t('All of your projects are up to date.'), + ); + return $form; + } + + $headers = array( + 'title' => array( + 'data' => t('Name'), + 'class' => array('update-project-name'), + ), + 'installed_version' => t('Installed version'), + 'recommended_version' => t('Recommended version'), + ); + + if (!empty($projects['enabled'])) { + $form['projects'] = array( + '#type' => 'tableselect', + '#header' => $headers, + '#options' => $projects['enabled'], + ); + if (count($projects) > 1) { + $form['projects']['#prefix'] = '

' . t('Enabled add-ons') . '

'; + } + } + + if (!empty($projects['disabled'])) { + $form['disabled_projects'] = array( + '#type' => 'tableselect', + '#header' => $headers, + '#options' => $projects['disabled'], + '#weight' => 1, + ); + if (count($projects) > 1) { + $form['disabled_projects']['#prefix'] = '

' . t('Disabled add-ons') . '

'; + } + } + + // If either table has been printed yet, we need a submit button and to + // validate the checkboxes. + if (!empty($projects['enabled']) || !empty($projects['disabled'])) { + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Install these updates'), + '#weight' => 10, + ); + $form['#validate'][] = 'update_update_form_select_plugins_validate'; + } + + if (!empty($projects['manual-enabled'])) { + $prefix = '

' . t('Add-ons requiring manual updates') . '

'; + $prefix .= '

' . t('Updates of Drupal core or development releases are not supported at this time.') . '

'; + $form['manual_updates'] = array( + '#type' => 'markup', + '#markup' => theme('table', array('header' => $headers, 'rows' => $projects['manual-enabled'])), + '#prefix' => $prefix, + '#weight' => 20, + ); + } + + if (!empty($projects['manual-disabled'])) { + $prefix = '

' . t('Disabled add-ons requiring manual updates') . '

'; + $prefix .= '

' . t('Updates of Drupal core or development releases are not supported at this time.') . '

'; + $form['manual_disabled'] = array( + '#type' => 'markup', + '#markup' => theme('table', array('header' => $headers, 'rows' => $projects['manual-disabled'])), + '#prefix' => $prefix, + '#weight' => 25, + ); + } + + return $form; +} + +/** + * Validation callback to ensure that at least one plugin is selected. + */ +function update_update_form_select_plugins_validate($form, &$form_state) { + if (!empty($form_state['values']['projects'])) { + $enabled = array_filter($form_state['values']['projects']); + } + if (!empty($form_state['values']['disabled_projects'])) { + $disabled = array_filter($form_state['values']['disabled_projects']); + } + if (empty($enabled) && empty($disabled)) { + form_set_error('projects', t('You must select at least one plugin to update.')); + } +} + +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) { + // @TODO: Present some type of warning when updating multi-site used modules. + // 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, + ), + ); + } + + $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($base_url . '/plugin.php'); + 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; + } + + $archive_tar = new Archive_Tar(drupal_realpath($local_cache)); + + $files = $archive_tar->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($base_url . '/plugin.php'); + 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 (!isset($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); + _update_batch_create_message($context['results']['log'][$project], $e->getMessage(), 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; +} + +/** + * 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']; +} + +/** + * Helper function to create a structure of log messages similar to update.php + * + * @todo: Improve the update.php structure, or just fix this problem, or decide + * that plugin.php should never run updates. + * + * @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. + * + * @param $variables + * form: The form. + * + * @ingroup themeable + */ +function theme_update_available_updates_form($variables) { + extract($variables); + $last = variable_get('update_last_check', 0); + $output = theme('update_last_check', array('last' => $last)); + $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(array($available_backends[$method]['class'], 'factory'), array(DRUPAL_ROOT, $settings)); + return $filetransfer; +} + +/** + * Coppies a file from $url to the temporary directory for updates. + * + * If the file has already been downloaded, returns the the local path. + * + * @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; + } +} + + +/** + * Gets 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; +} \ No newline at end of file Index: modules/update/update.css =================================================================== RCS file: /Users/wright/drupal/local_repo/drupal/modules/update/update.css,v retrieving revision 1.5 diff -u -p -r1.5 update.css --- modules/update/update.css 29 Apr 2009 03:57:21 -0000 1.5 +++ modules/update/update.css 12 Oct 2009 05:08:34 -0000 @@ -108,3 +108,38 @@ table.update, .update .check-manually { padding-left: 1em; /* LTR */ } + + +table tbody tr.update-security, +table tbody tr.update-unsupported { + background: #fcc; +} + +table tbody tr.update-manual input{ + display: none; +} + +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; +} Index: modules/update/update.info =================================================================== RCS file: /Users/wright/drupal/local_repo/drupal/modules/update/update.info,v retrieving revision 1.6 diff -u -p -r1.6 update.info --- modules/update/update.info 26 Sep 2009 17:03:13 -0000 1.6 +++ modules/update/update.info 12 Oct 2009 05:08:34 -0000 @@ -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 Index: modules/update/update.js =================================================================== RCS file: modules/update/update.js diff -N modules/update/update.js --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ modules/update/update.js 12 Oct 2009 20:15:49 -0000 @@ -0,0 +1,45 @@ +// $Id$ + +/** + * @file + * Conditionally hide or show the appropriate settings and saved defaults + * on the file transfer connection settings form. + */ + +(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) { + self = $(this); + $(this).hide(); + $(":checkbox", $(this).parent().parent()).bind('change', function(e) { + if (this.checked) { + self.dialog("open"); + var buttons = {} + buttons[Drupal.t("Ok")] = function() { $(this).dialog("close"); }; + buttons[Drupal.t("Cancel")] = function() { alert('cancel'); $(this).dialog("close"); }; + self.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); Index: modules/update/update.module =================================================================== RCS file: /Users/wright/drupal/local_repo/drupal/modules/update/update.module,v retrieving revision 1.48 diff -u -p -r1.48 update.module --- modules/update/update.module 8 Oct 2009 15:40:33 -0000 1.48 +++ modules/update/update.module 12 Oct 2009 16:54:35 -0000 @@ -67,11 +67,13 @@ define('UPDATE_MAX_FETCH_ATTEMPTS', 2); function update_help($path, $arg) { switch ($path) { case 'admin/reports/updates': - 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; + return '

' . 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.') . '

'; + + case 'admin/appearance/install': + case 'admin/config/modules/install': + case 'admin/reports/updates/install': + return '

' . t('To install a new module or theme, either upload the .tar.gz file that you have downloaded, or paste the URL of a .tar.gz you wish to install. You can find modules and themes at http://drupal.org.', array('@module_url' => 'http://drupal.org/project/modules', '@theme_url' => 'http://drupal.org/project/themes', '@drupal_org_url' => 'http://drupal.org')) . '

'; + case 'admin/appearance': case 'admin/config/modules': include_once DRUPAL_ROOT . '/includes/install.inc'; @@ -88,9 +90,13 @@ function update_help($path, $arg) { } } + case 'admin/appearance/update': + case 'admin/config/modules/update': + case 'admin/reports/updates/update': + case 'admin/reports/updates/update': case 'admin/reports/updates/settings': case 'admin/reports/status': - // These two pages don't need additional nagging. + // These pages don't need additional nagging. break; case 'admin/help#update': @@ -146,6 +152,7 @@ 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', @@ -155,16 +162,80 @@ function update_menu() { 'file' => 'update.fetch.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', + ); + + // We want action links for updating plugins at a few different locations: + // both the module and theme administration pages, and on the available + // updates report itself. The menu items will be identical, except for their + // paths, so we just define them in a loop. We pass in a string indicating + // what context we're entering the action from, so that we can customize the + // appearance as needed. + $paths = array( + 'report' => 'admin/reports/updates', + 'module' => 'admin/config/modules', + 'theme' => 'admin/appearance', + ); + foreach ($paths as $context => $path) { + $items[$path . '/install'] = array( + 'title' => 'Install', + 'description' => 'Install new modules and themes', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('update_install_form', $context), + 'access callback' => 'update_plugin_manager_access', + 'access arguments' => array(), + 'weight' => 25, + 'type' => MENU_LOCAL_ACTION, + 'file' => 'update.admin.inc', + ); + $items[$path . '/update'] = array( + 'title' => 'Update', + 'description' => 'Update your installed modules and themes', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('update_update_form', $context), + 'access callback' => 'update_plugin_manager_access', + 'access arguments' => array(), + 'weight' => 20, + 'type' => MENU_LOCAL_ACTION, + 'file' => 'update.admin.inc', + ); + } + return $items; } /** - * Implement the hook_theme() registry. + * Determine if the current user can access plugin-manager menu items. + * + * This is used as a menu system access callback. It both enforces the + * 'administer software updates' permission and the global killswitch for the + * plugin manager. + * + * @see update_menu() + */ +function update_plugin_manager_access() { + return user_access('administer software updates') && variable_get('plugin_manager_enabled', TRUE); +} + +/** + * Implement hook_theme(). */ function update_theme() { return array( - 'update_settings' => array( + 'update_available_updates_form' => array( 'arguments' => array('form' => NULL), + 'file' => 'update.admin.inc', + ), + 'update_last_check' => array( + 'arguments' => array('last' => NULL), ), 'update_report' => array( 'arguments' => array('data' => NULL), @@ -536,6 +607,30 @@ function _update_project_status_sort($a, } /** + * Render the HTML to display the last time we checked for update data. + * + * In addition to properly formating the given timestamp, this function also + * provides a "Check manually" link that refreshes the available update and + * redirects back to the same page. + * + * @param $variables + * 'last': The timestamp when the site last checked for available updates. + * + * @see theme_update_report() + * @see theme_update_available_updates_form() + * + * @ingroup themeable + */ +function theme_update_last_check($variables) { + $last = $variables['last']; + $output = '
'; + $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', array('query' => drupal_get_destination())) . ')'; + $output .= "
\n"; + return $output; +} + +/** * @defgroup update_status_cache Private update status cache system * @{ * Index: modules/update/update.report.inc =================================================================== RCS file: /Users/wright/drupal/local_repo/drupal/modules/update/update.report.inc,v retrieving revision 1.24 diff -u -p -r1.24 update.report.inc --- modules/update/update.report.inc 9 Oct 2009 01:00:06 -0000 1.24 +++ modules/update/update.report.inc 12 Oct 2009 16:54:17 -0000 @@ -29,9 +29,7 @@ function theme_update_report($variables) $data = $variables['data']; $last = variable_get('update_last_check', 0); - $output = '
' . ($last ? t('Last checked: @timestamp (@time ago)', array('@time' => format_interval(REQUEST_TIME - $last), '@timestamp' => format_date($last))) : t('Last checked: never')); - $output .= ' (' . l(t('Check manually'), 'admin/reports/updates/check') . ')'; - $output .= "
\n"; + $output = theme('update_last_check', array('last' => $last)); if (!is_array($data)) { $output .= '

' . $data . '

'; Index: modules/update/update.test =================================================================== RCS file: /Users/wright/drupal/local_repo/drupal/modules/update/update.test,v retrieving revision 1.6 diff -u -p -r1.6 update.test --- modules/update/update.test 10 Oct 2009 07:57:02 -0000 1.6 +++ modules/update/update.test 12 Oct 2009 16:38:36 -0000 @@ -45,7 +45,6 @@ class UpdateTestHelper extends DrupalWeb */ protected function standardTests() { $this->assertRaw('

' . t('Drupal core') . '

'); - $this->assertRaw(l(t('Check manually'), 'admin/reports/updates/check'), t('Link to check available updates manually appears.')); $this->assertRaw(l(t('Drupal'), 'http://example.com/project/drupal'), t('Link to the Drupal project appears.')); $this->assertNoText(t('No available releases found')); } Index: modules/update/updaters.inc =================================================================== RCS file: modules/update/updaters.inc diff -N modules/update/updaters.inc --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ modules/update/updaters.inc 12 Oct 2009 08:41:24 -0000 @@ -0,0 +1,432 @@ +source = $source; + $this->name = self::getProjectName($source); + $this->title = self::getProjectTitle($source); + } + + /** + * Return an Updater of the appropriate type depending on the source. + * + * If a directory is provided which contains a module, will return a + * ModuleUpdater. + * + * @param string $source + * Directory of a Drupal project. + * + * @return object 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); + } + + /** + * Determine which Updater class can operate on the given directory. + * + * @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"); + } + + /** + * Figure out what the most important (or only) info file is in a directory. + * + * Since there is no enforcement of which info file is the project's "main" + * info file, this will get one with the same name as the directory, or the + * first one it finds. Not ideal, 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)) { + // Info file Has the same name as the directory, return it. + return $info_file->uri; + } + } + // Otherwise, return the first one. + $info_file = array_shift($info_files); + return $info_file->uri; + } + + /** + * Get the name of the project directory (basename). + * + * @todo: It would be nice, if projects contained an info file which could + * provide their canonical name. + * + * @param string $directory + * @return string + */ + public static function getProjectName($directory) { + return basename($directory); + } + + /** + * Return the project name from a Drupal info file. + * + * @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']; + } + + /** + * Store the default parameters for the Updater. + * + * @param array $overrides + * An array of overrides for the default parameters. + * @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. Used for moving files + * to the server. + * @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 to delete the install directory. + throw new UpdaterError("Fatal error in update, cowardly refusing to wipe out the install directory"); + } + + // Note: If the project is installed in sites/all, it will not be + // deleted. It will be installed in sites/default as that will override + // the sites/all reference and not break other sites which are using it. + if (is_dir($args['install_dir'] . '/' . $this->name)) { + // Remove the existing installed file. + $ft->removeDirectory($args['install_dir'] . '/' . $this->name); + } + + // Copy the directory in place. + $ft->copyDirectory($this->source, $args['install_dir']); + plugin_make_world_executable($ft, $args['install_dir'] . '/' . $this->name); + // 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(), $e->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']); + plugin_make_world_executable($ft, $args['install_dir'] . '/' . $this->name); + // 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 UpdaterError(t("File Transfer failed, reason: !reason", array('!reason' => t($e->getMessage(), $e->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() { + + } + + /** + * Returns an array of links to pages that should be visited post operation. + * + * @return array + * Links which provide actions to take after the install is finished. + */ + function postInstallTasks() { + return array(); + } + + /** + * Returns an array of links to pages that should be visited post operation. + * + * @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); + } + + static function canUpdateDirectory($directory) { + if (file_scan_directory($directory, '/.*\.module/')) { + return TRUE; + } + return FALSE; + } + + static function canUpdate($project_name) { + return (bool) drupal_get_path('module', $project_name); + } + + /** + * @todo: Not implemented + * @return + */ + function getSchemaUpdates() { + 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(); + } + + function postInstallTasks() { + return array( + l(t('Enable newly added modules in !project', array('!project' => $this->title)), 'admin/config/modules'), + ); + } + + function postUpdateTasks() { + // @todo: If there are schema updates. + return array( + l(t('Run database updates for !project', array('!project' => $this->title)), 'update.php'), + ); + } + +} + +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); + } + + static function canUpdateDirectory($directory) { + // This is a lousy test, but don't know how else to confirm it is a theme. + if (file_scan_directory($directory, '/.*\.module/')) { + return FALSE; + } + return TRUE; + } + + static function canUpdate($project_name) { + return (bool) drupal_get_path('theme', $project_name); + } + + 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'), + ); + } +} + +/** + * @TODO: implement this. + */ +class ProfileUpdater extends Updater { + function installProject() { + + } +} + +class UpdaterError extends Exception { + +} + cvs diff: Diffing modules/update/tests