danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Install, update and uninstall functions for the user module.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_schema().
danielebarchiesi@0:  */
danielebarchiesi@0: function user_schema() {
danielebarchiesi@0:   $schema['authmap'] = array(
danielebarchiesi@0:     'description' => 'Stores distributed authentication mapping.',
danielebarchiesi@0:     'fields' => array(
danielebarchiesi@0:       'aid' => array(
danielebarchiesi@0:         'description' => 'Primary Key: Unique authmap ID.',
danielebarchiesi@0:         'type' => 'serial',
danielebarchiesi@0:         'unsigned' => TRUE,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:       ),
danielebarchiesi@0:       'uid' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => "User's {users}.uid.",
danielebarchiesi@0:       ),
danielebarchiesi@0:       'authname' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 128,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => 'Unique authentication name.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'module' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 128,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => 'Module which is controlling the authentication.',
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'unique keys' => array(
danielebarchiesi@0:       'authname' => array('authname'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'primary key' => array('aid'),
danielebarchiesi@0:     'foreign keys' => array(
danielebarchiesi@0:       'user' => array(
danielebarchiesi@0:         'table' => 'users',
danielebarchiesi@0:         'columns' => array('uid' => 'uid'),
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $schema['role_permission'] = array(
danielebarchiesi@0:     'description' => 'Stores the permissions assigned to user roles.',
danielebarchiesi@0:     'fields' => array(
danielebarchiesi@0:       'rid' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'unsigned' => TRUE,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'description' => 'Foreign Key: {role}.rid.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'permission' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 128,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => 'A single permission granted to the role identified by rid.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'module' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => "The module declaring the permission.",
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'primary key' => array('rid', 'permission'),
danielebarchiesi@0:     'indexes' => array(
danielebarchiesi@0:       'permission' => array('permission'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'foreign keys' => array(
danielebarchiesi@0:       'role' => array(
danielebarchiesi@0:         'table' => 'roles',
danielebarchiesi@0:         'columns' => array('rid' => 'rid'),
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $schema['role'] = array(
danielebarchiesi@0:     'description' => 'Stores user roles.',
danielebarchiesi@0:     'fields' => array(
danielebarchiesi@0:       'rid' => array(
danielebarchiesi@0:         'type' => 'serial',
danielebarchiesi@0:         'unsigned' => TRUE,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'description' => 'Primary Key: Unique role ID.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'name' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 64,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => 'Unique role name.',
danielebarchiesi@0:         'translatable' => TRUE,
danielebarchiesi@0:       ),
danielebarchiesi@0:       'weight' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => 'The weight of this role in listings and the user interface.',
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'unique keys' => array(
danielebarchiesi@0:       'name' => array('name'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'primary key' => array('rid'),
danielebarchiesi@0:     'indexes' => array(
danielebarchiesi@0:       'name_weight' => array('name', 'weight'),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // The table name here is plural, despite Drupal table naming standards,
danielebarchiesi@0:   // because "user" is a reserved word in many databases.
danielebarchiesi@0:   $schema['users'] = array(
danielebarchiesi@0:     'description' => 'Stores user data.',
danielebarchiesi@0:     'fields' => array(
danielebarchiesi@0:       'uid' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'unsigned' => TRUE,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'description' => 'Primary Key: Unique user ID.',
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:       ),
danielebarchiesi@0:       'name' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 60,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => 'Unique user name.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'pass' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 128,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => "User's password (hashed).",
danielebarchiesi@0:       ),
danielebarchiesi@0:       'mail' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 254,
danielebarchiesi@0:         'not null' => FALSE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => "User's e-mail address.",
danielebarchiesi@0:       ),
danielebarchiesi@0:       'theme' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => "User's default theme.",
danielebarchiesi@0:       ),
danielebarchiesi@0:       'signature' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => "User's signature.",
danielebarchiesi@0:       ),
danielebarchiesi@0:       'signature_format' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 255,
danielebarchiesi@0:         'not null' => FALSE,
danielebarchiesi@0:         'description' => 'The {filter_format}.format of the signature.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'created' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => 'Timestamp for when user was created.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'access' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => 'Timestamp for previous time user accessed the site.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'login' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => "Timestamp for user's last login.",
danielebarchiesi@0:       ),
danielebarchiesi@0:       'status' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'size' => 'tiny',
danielebarchiesi@0:         'description' => 'Whether the user is active(1) or blocked(0).',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'timezone' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 32,
danielebarchiesi@0:         'not null' => FALSE,
danielebarchiesi@0:         'description' => "User's time zone.",
danielebarchiesi@0:       ),
danielebarchiesi@0:       'language' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 12,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => "User's default language.",
danielebarchiesi@0:       ),
danielebarchiesi@0:       'picture' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => "Foreign key: {file_managed}.fid of user's picture.",
danielebarchiesi@0:       ),
danielebarchiesi@0:       'init' => array(
danielebarchiesi@0:         'type' => 'varchar',
danielebarchiesi@0:         'length' => 254,
danielebarchiesi@0:         'not null' => FALSE,
danielebarchiesi@0:         'default' => '',
danielebarchiesi@0:         'description' => 'E-mail address used for initial account creation.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'data' => array(
danielebarchiesi@0:         'type' => 'blob',
danielebarchiesi@0:         'not null' => FALSE,
danielebarchiesi@0:         'size' => 'big',
danielebarchiesi@0:         'serialize' => TRUE,
danielebarchiesi@0:         'description' => 'A serialized array of name value pairs that are related to the user. Any form values posted during user edit are stored and are loaded into the $user object during user_load(). Use of this field is discouraged and it will likely disappear in a future version of Drupal.',
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'indexes' => array(
danielebarchiesi@0:       'access' => array('access'),
danielebarchiesi@0:       'created' => array('created'),
danielebarchiesi@0:       'mail' => array('mail'),
danielebarchiesi@0:       'picture' => array('picture'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'unique keys' => array(
danielebarchiesi@0:       'name' => array('name'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'primary key' => array('uid'),
danielebarchiesi@0:     'foreign keys' => array(
danielebarchiesi@0:       'signature_format' => array(
danielebarchiesi@0:         'table' => 'filter_format',
danielebarchiesi@0:         'columns' => array('signature_format' => 'format'),
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $schema['users_roles'] = array(
danielebarchiesi@0:     'description' => 'Maps users to roles.',
danielebarchiesi@0:     'fields' => array(
danielebarchiesi@0:       'uid' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'unsigned' => TRUE,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => 'Primary Key: {users}.uid for user.',
danielebarchiesi@0:       ),
danielebarchiesi@0:       'rid' => array(
danielebarchiesi@0:         'type' => 'int',
danielebarchiesi@0:         'unsigned' => TRUE,
danielebarchiesi@0:         'not null' => TRUE,
danielebarchiesi@0:         'default' => 0,
danielebarchiesi@0:         'description' => 'Primary Key: {role}.rid for role.',
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'primary key' => array('uid', 'rid'),
danielebarchiesi@0:     'indexes' => array(
danielebarchiesi@0:       'rid' => array('rid'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'foreign keys' => array(
danielebarchiesi@0:       'user' => array(
danielebarchiesi@0:         'table' => 'users',
danielebarchiesi@0:         'columns' => array('uid' => 'uid'),
danielebarchiesi@0:       ),
danielebarchiesi@0:       'role' => array(
danielebarchiesi@0:         'table' => 'roles',
danielebarchiesi@0:         'columns' => array('rid' => 'rid'),
danielebarchiesi@0:       ),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $schema;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_install().
danielebarchiesi@0:  */
danielebarchiesi@0: function user_install() {
danielebarchiesi@0:   // Insert a row for the anonymous user.
danielebarchiesi@0:   db_insert('users')
danielebarchiesi@0:     ->fields(array(
danielebarchiesi@0:       'uid' => 0,
danielebarchiesi@0:       'name' => '',
danielebarchiesi@0:       'mail' => '',
danielebarchiesi@0:     ))
danielebarchiesi@0:     ->execute();
danielebarchiesi@0: 
danielebarchiesi@0:   // We need some placeholders here as name and mail are uniques and data is
danielebarchiesi@0:   // presumed to be a serialized array. This will be changed by the settings
danielebarchiesi@0:   // form in the installer.
danielebarchiesi@0:   db_insert('users')
danielebarchiesi@0:     ->fields(array(
danielebarchiesi@0:       'uid' => 1,
danielebarchiesi@0:       'name' => 'placeholder-for-uid-1',
danielebarchiesi@0:       'mail' => 'placeholder-for-uid-1',
danielebarchiesi@0:       'created' => REQUEST_TIME,
danielebarchiesi@0:       'status' => 1,
danielebarchiesi@0:       'data' => NULL,
danielebarchiesi@0:     ))
danielebarchiesi@0:     ->execute();
danielebarchiesi@0: 
danielebarchiesi@0:   // Built-in roles.
danielebarchiesi@0:   $rid_anonymous = db_insert('role')
danielebarchiesi@0:     ->fields(array('name' => 'anonymous user', 'weight' => 0))
danielebarchiesi@0:     ->execute();
danielebarchiesi@0:   $rid_authenticated = db_insert('role')
danielebarchiesi@0:     ->fields(array('name' => 'authenticated user', 'weight' => 1))
danielebarchiesi@0:     ->execute();
danielebarchiesi@0: 
danielebarchiesi@0:   // Sanity check to ensure the anonymous and authenticated role IDs are the
danielebarchiesi@0:   // same as the drupal defined constants. In certain situations, this will
danielebarchiesi@0:   // not be true.
danielebarchiesi@0:   if ($rid_anonymous != DRUPAL_ANONYMOUS_RID) {
danielebarchiesi@0:     db_update('role')
danielebarchiesi@0:       ->fields(array('rid' => DRUPAL_ANONYMOUS_RID))
danielebarchiesi@0:       ->condition('rid', $rid_anonymous)
danielebarchiesi@0:       ->execute();
danielebarchiesi@0:   }
danielebarchiesi@0:   if ($rid_authenticated != DRUPAL_AUTHENTICATED_RID) {
danielebarchiesi@0:     db_update('role')
danielebarchiesi@0:       ->fields(array('rid' => DRUPAL_AUTHENTICATED_RID))
danielebarchiesi@0:       ->condition('rid', $rid_authenticated)
danielebarchiesi@0:       ->execute();
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_update_dependencies().
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_dependencies() {
danielebarchiesi@0:   // user_update_7006() updates data in the {role_permission} table, so it must
danielebarchiesi@0:   // run after system_update_7007(), which populates that table.
danielebarchiesi@0:   $dependencies['user'][7006] = array(
danielebarchiesi@0:     'system' => 7007,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // user_update_7010() needs to query the {filter_format} table to get a list
danielebarchiesi@0:   // of existing text formats, so it must run after filter_update_7000(), which
danielebarchiesi@0:   // creates that table.
danielebarchiesi@0:   $dependencies['user'][7010] = array(
danielebarchiesi@0:     'filter' => 7000,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // user_update_7012() uses the file API, which relies on the {file_managed}
danielebarchiesi@0:   // table, so it must run after system_update_7034(), which creates that
danielebarchiesi@0:   // table.
danielebarchiesi@0:   $dependencies['user'][7012] = array(
danielebarchiesi@0:     'system' => 7034,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // user_update_7013() uses the file usage API, which relies on the
danielebarchiesi@0:   // {file_usage} table, so it must run after system_update_7059(), which
danielebarchiesi@0:   // creates that table.
danielebarchiesi@0:   $dependencies['user'][7013] = array(
danielebarchiesi@0:     'system' => 7059,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $dependencies;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Utility function: grant a set of permissions to a role during update.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This function is valid for a database schema version 7000.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $rid
danielebarchiesi@0:  *   The role ID.
danielebarchiesi@0:  * @param $permissions
danielebarchiesi@0:  *   An array of permissions names.
danielebarchiesi@0:  * @param $module
danielebarchiesi@0:  *   The name of the module defining the permissions.
danielebarchiesi@0:  * @ingroup update_api
danielebarchiesi@0:  */
danielebarchiesi@0: function _update_7000_user_role_grant_permissions($rid, array $permissions, $module) {
danielebarchiesi@0:   // Grant new permissions for the role.
danielebarchiesi@0:   foreach ($permissions as $name) {
danielebarchiesi@0:     db_merge('role_permission')
danielebarchiesi@0:       ->key(array(
danielebarchiesi@0:         'rid' => $rid,
danielebarchiesi@0:         'permission' => $name,
danielebarchiesi@0:       ))
danielebarchiesi@0:       ->fields(array(
danielebarchiesi@0:         'module' => $module,
danielebarchiesi@0:       ))
danielebarchiesi@0:       ->execute();
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @addtogroup updates-6.x-to-7.x
danielebarchiesi@0:  * @{
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Increase the length of the password field to accommodate better hashes.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Also re-hashes all current passwords to improve security. This may be a
danielebarchiesi@0:  * lengthy process, and is performed batch-wise.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7000(&$sandbox) {
danielebarchiesi@0:   $sandbox['#finished'] = 0;
danielebarchiesi@0:   // Lower than DRUPAL_HASH_COUNT to make the update run at a reasonable speed.
danielebarchiesi@0:   $hash_count_log2 = 11;
danielebarchiesi@0:   // Multi-part update.
danielebarchiesi@0:   if (!isset($sandbox['user_from'])) {
danielebarchiesi@0:     db_change_field('users', 'pass', 'pass', array('type' => 'varchar', 'length' => 128, 'not null' => TRUE, 'default' => ''));
danielebarchiesi@0:     $sandbox['user_from'] = 0;
danielebarchiesi@0:     $sandbox['user_count'] = db_query("SELECT COUNT(uid) FROM {users}")->fetchField();
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     require_once DRUPAL_ROOT . '/' . variable_get('password_inc', 'includes/password.inc');
danielebarchiesi@0:     //  Hash again all current hashed passwords.
danielebarchiesi@0:     $has_rows = FALSE;
danielebarchiesi@0:     // Update this many per page load.
danielebarchiesi@0:     $count = 1000;
danielebarchiesi@0:     $result = db_query_range("SELECT uid, pass FROM {users} WHERE uid > 0 ORDER BY uid", $sandbox['user_from'], $count);
danielebarchiesi@0:     foreach ($result as $account) {
danielebarchiesi@0:       $has_rows = TRUE;
danielebarchiesi@0: 
danielebarchiesi@0:       // If the $account->pass value is not a MD5 hash (a 32 character
danielebarchiesi@0:       // hexadecimal string) then skip it.
danielebarchiesi@0:       if (!preg_match('/^[0-9a-f]{32}$/', $account->pass)) {
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       $new_hash = user_hash_password($account->pass, $hash_count_log2);
danielebarchiesi@0:       if ($new_hash) {
danielebarchiesi@0:         // Indicate an updated password.
danielebarchiesi@0:         $new_hash  = 'U' . $new_hash;
danielebarchiesi@0:         db_update('users')
danielebarchiesi@0:           ->fields(array('pass' => $new_hash))
danielebarchiesi@0:           ->condition('uid', $account->uid)
danielebarchiesi@0:           ->execute();
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     $sandbox['#finished'] = $sandbox['user_from']/$sandbox['user_count'];
danielebarchiesi@0:     $sandbox['user_from'] += $count;
danielebarchiesi@0:     if (!$has_rows) {
danielebarchiesi@0:       $sandbox['#finished'] = 1;
danielebarchiesi@0:       return t('User passwords rehashed to improve security');
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Remove the 'threshold', 'mode' and 'sort' columns from the {users} table.
danielebarchiesi@0:  *
danielebarchiesi@0:  * These fields were previously used to store per-user comment settings.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: function user_update_7001() {
danielebarchiesi@0:   db_drop_field('users', 'threshold');
danielebarchiesi@0:   db_drop_field('users', 'mode');
danielebarchiesi@0:   db_drop_field('users', 'sort');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Convert user time zones from time zone offsets to time zone names.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7002(&$sandbox) {
danielebarchiesi@0:   $sandbox['#finished'] = 0;
danielebarchiesi@0: 
danielebarchiesi@0:   // Multi-part update.
danielebarchiesi@0:   if (!isset($sandbox['user_from'])) {
danielebarchiesi@0:     db_change_field('users', 'timezone', 'timezone', array('type' => 'varchar', 'length' => 32, 'not null' => FALSE));
danielebarchiesi@0:     $sandbox['user_from'] = 0;
danielebarchiesi@0:     $sandbox['user_count'] = db_query("SELECT COUNT(uid) FROM {users}")->fetchField();
danielebarchiesi@0:     $sandbox['user_not_migrated'] = 0;
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $timezones = system_time_zones();
danielebarchiesi@0:     // Update this many per page load.
danielebarchiesi@0:     $count = 10000;
danielebarchiesi@0:     $contributed_date_module = db_field_exists('users', 'timezone_name');
danielebarchiesi@0:     $contributed_event_module = db_field_exists('users', 'timezone_id');
danielebarchiesi@0: 
danielebarchiesi@0:     $results = db_query_range("SELECT uid FROM {users} ORDER BY uid", $sandbox['user_from'], $count);
danielebarchiesi@0:     foreach ($results as $account) {
danielebarchiesi@0:       $timezone = NULL;
danielebarchiesi@0:       // If the contributed Date module has created a users.timezone_name
danielebarchiesi@0:       // column, use this data to set each user's time zone.
danielebarchiesi@0:       if ($contributed_date_module) {
danielebarchiesi@0:         $date_timezone = db_query("SELECT timezone_name FROM {users} WHERE uid = :uid", array(':uid' => $account->uid))->fetchField();
danielebarchiesi@0:         if (isset($timezones[$date_timezone])) {
danielebarchiesi@0:           $timezone = $date_timezone;
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       // If the contributed Event module has stored user time zone information
danielebarchiesi@0:       // use that information to update the user accounts.
danielebarchiesi@0:       if (!$timezone && $contributed_event_module) {
danielebarchiesi@0:         try {
danielebarchiesi@0:           $event_timezone = db_query("SELECT t.name FROM {users} u LEFT JOIN {event_timezones} t ON u.timezone_id = t.timezone WHERE u.uid = :uid", array(':uid' => $account->uid))->fetchField();
danielebarchiesi@0:           $event_timezone = str_replace(' ', '_', $event_timezone);
danielebarchiesi@0:           if (isset($timezones[$event_timezone])) {
danielebarchiesi@0:             $timezone = $event_timezone;
danielebarchiesi@0:           }
danielebarchiesi@0:         }
danielebarchiesi@0:         catch (PDOException $e) {
danielebarchiesi@0:           // Ignore error if event_timezones table does not exist or unexpected
danielebarchiesi@0:           // schema found.
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0:       if ($timezone) {
danielebarchiesi@0:         db_update('users')
danielebarchiesi@0:           ->fields(array('timezone' => $timezone))
danielebarchiesi@0:           ->condition('uid', $account->uid)
danielebarchiesi@0:           ->execute();
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $sandbox['user_not_migrated']++;
danielebarchiesi@0:         db_update('users')
danielebarchiesi@0:           ->fields(array('timezone' => NULL))
danielebarchiesi@0:           ->condition('uid', $account->uid)
danielebarchiesi@0:           ->execute();
danielebarchiesi@0:       }
danielebarchiesi@0:       $sandbox['user_from']++;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $sandbox['#finished'] = $sandbox['user_from'] / $sandbox['user_count'];
danielebarchiesi@0:     if ($sandbox['user_from'] == $sandbox['user_count']) {
danielebarchiesi@0:       if ($sandbox['user_not_migrated'] > 0) {
danielebarchiesi@0:         variable_set('empty_timezone_message', 1);
danielebarchiesi@0:         drupal_set_message(format_string('Some user time zones have been emptied and need to be set to the correct values. Use the new <a href="@config-url">time zone options</a> to choose whether to remind users at login to set the correct time zone.', array('@config-url' => url('admin/config/regional/settings'))), 'warning');
danielebarchiesi@0:       }
danielebarchiesi@0:       return t('Migrated user time zones');
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Update user settings for cancelling user accounts.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Prior to 7.x, users were not able to cancel their accounts. When
danielebarchiesi@0:  * administrators deleted an account, all contents were assigned to uid 0,
danielebarchiesi@0:  * which is the same as the 'user_cancel_reassign' method now.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7003() {
danielebarchiesi@0:   // Set the default account cancellation method.
danielebarchiesi@0:   variable_set('user_cancel_method', 'user_cancel_reassign');
danielebarchiesi@0:   // Re-assign notification setting.
danielebarchiesi@0:   if ($setting = variable_get('user_mail_status_deleted_notify', FALSE)) {
danielebarchiesi@0:     variable_set('user_mail_status_canceled_notify', $setting);
danielebarchiesi@0:     variable_del('user_mail_status_deleted_notify');
danielebarchiesi@0:   }
danielebarchiesi@0:   // Re-assign "Account deleted" mail strings to "Account canceled" mail.
danielebarchiesi@0:   if ($setting = variable_get('user_mail_status_deleted_subject', FALSE)) {
danielebarchiesi@0:     variable_set('user_mail_status_canceled_subject', $setting);
danielebarchiesi@0:     variable_del('user_mail_status_deleted_subject');
danielebarchiesi@0:   }
danielebarchiesi@0:   if ($setting = variable_get('user_mail_status_deleted_body', FALSE)) {
danielebarchiesi@0:     variable_set('user_mail_status_canceled_body', $setting);
danielebarchiesi@0:     variable_del('user_mail_status_deleted_body');
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Changes the users table to allow longer e-mail addresses.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7005(&$sandbox) {
danielebarchiesi@0:   $mail_field = array(
danielebarchiesi@0:     'type' => 'varchar',
danielebarchiesi@0:     'length' => 254,
danielebarchiesi@0:     'not null' => FALSE,
danielebarchiesi@0:     'default' => '',
danielebarchiesi@0:     'description' => "User's e-mail address.",
danielebarchiesi@0:   );
danielebarchiesi@0:   $init_field = array(
danielebarchiesi@0:     'type' => 'varchar',
danielebarchiesi@0:     'length' => 254,
danielebarchiesi@0:     'not null' => FALSE,
danielebarchiesi@0:     'default' => '',
danielebarchiesi@0:     'description' => 'E-mail address used for initial account creation.',
danielebarchiesi@0:   );
danielebarchiesi@0:   db_drop_index('users', 'mail');
danielebarchiesi@0:   db_change_field('users', 'mail', 'mail', $mail_field, array('indexes' => array('mail' => array('mail'))));
danielebarchiesi@0:   db_change_field('users', 'init', 'init', $init_field);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Add module data to {role_permission}.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7006(&$sandbox) {
danielebarchiesi@0:   $module_field = array(
danielebarchiesi@0:     'type' => 'varchar',
danielebarchiesi@0:     'length' => 255,
danielebarchiesi@0:     'not null' => TRUE,
danielebarchiesi@0:     'default' => '',
danielebarchiesi@0:     'description' => "The module declaring the permission.",
danielebarchiesi@0:   );
danielebarchiesi@0:   // Check that the field hasn't been updated in an aborted run of this
danielebarchiesi@0:   // update.
danielebarchiesi@0:   if (!db_field_exists('role_permission', 'module')) {
danielebarchiesi@0:     // Add a new field for the fid.
danielebarchiesi@0:     db_add_field('role_permission', 'module', $module_field);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Add a weight column to user roles.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7007() {
danielebarchiesi@0:   db_add_field('role', 'weight', array('type' => 'int', 'not null' => TRUE, 'default' => 0));
danielebarchiesi@0:   db_add_index('role', 'name_weight', array('name', 'weight'));
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * If 'user_register' variable was unset in Drupal 6, set it to be the same as
danielebarchiesi@0:  * the Drupal 6 default setting.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7008() {
danielebarchiesi@0:   if (!isset($GLOBALS['conf']['user_register'])) {
danielebarchiesi@0:     // Set to the Drupal 6 default, "visitors can create accounts".
danielebarchiesi@0:     variable_set('user_register', USER_REGISTER_VISITORS);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Converts fields that store serialized variables from text to blob.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7009() {
danielebarchiesi@0:   $spec = array(
danielebarchiesi@0:     'type' => 'blob',
danielebarchiesi@0:     'not null' => FALSE,
danielebarchiesi@0:     'size' => 'big',
danielebarchiesi@0:     'serialize' => TRUE,
danielebarchiesi@0:     'description' => 'A serialized array of name value pairs that are related to the user. Any form values posted during user edit are stored and are loaded into the $user object during user_load(). Use of this field is discouraged and it will likely disappear in a future version of Drupal.',
danielebarchiesi@0:   );
danielebarchiesi@0:   db_change_field('users', 'data', 'data', $spec);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Update the {user}.signature_format column.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7010() {
danielebarchiesi@0:   // Update the database column to allow NULL values.
danielebarchiesi@0:   db_change_field('users', 'signature_format', 'signature_format', array(
danielebarchiesi@0:     'type' => 'int',
danielebarchiesi@0:     'unsigned' => TRUE,
danielebarchiesi@0:     'not null' => FALSE,
danielebarchiesi@0:     'description' => 'The {filter_format}.format of the signature.',
danielebarchiesi@0:   ));
danielebarchiesi@0: 
danielebarchiesi@0:   // Replace the signature format with NULL if the signature is empty and does
danielebarchiesi@0:   // not already have a stored text format.
danielebarchiesi@0:   //
danielebarchiesi@0:   // In Drupal 6, "0" (the former FILTER_FORMAT_DEFAULT constant) could be used
danielebarchiesi@0:   // to indicate this situation, but in Drupal 7, only NULL is supported. This
danielebarchiesi@0:   // update therefore preserves the ability of user accounts which were never
danielebarchiesi@0:   // given a signature (for example, if the site did not have user signatures
danielebarchiesi@0:   // enabled, or if the user never edited their account information) to not
danielebarchiesi@0:   // have a particular text format assumed for them the first time the
danielebarchiesi@0:   // signature is edited.
danielebarchiesi@0:   db_update('users')
danielebarchiesi@0:     ->fields(array('signature_format' => NULL))
danielebarchiesi@0:     ->condition('signature', '')
danielebarchiesi@0:     ->condition('signature_format', 0)
danielebarchiesi@0:     ->execute();
danielebarchiesi@0: 
danielebarchiesi@0:   // There are a number of situations in which a Drupal 6 site could store
danielebarchiesi@0:   // content with a nonexistent text format. This includes text formats that
danielebarchiesi@0:   // had later been deleted, or non-empty content stored with a value of "0"
danielebarchiesi@0:   // (the former FILTER_FORMAT_DEFAULT constant). Drupal 6 would filter this
danielebarchiesi@0:   // content using whatever the site-wide default text format was at the moment
danielebarchiesi@0:   // the text was being displayed.
danielebarchiesi@0:   //
danielebarchiesi@0:   // In Drupal 7, this behavior is no longer supported, and all content must be
danielebarchiesi@0:   // stored with an explicit text format (or it will not be displayed when it
danielebarchiesi@0:   // is filtered). Therefore, to preserve the behavior of the site after the
danielebarchiesi@0:   // upgrade, we must replace all instances described above with the current
danielebarchiesi@0:   // value of the (old) site-wide default format at the moment of the upgrade.
danielebarchiesi@0:   $existing_formats = db_query("SELECT format FROM {filter_format}")->fetchCol();
danielebarchiesi@0:   $default_format = variable_get('filter_default_format', 1);
danielebarchiesi@0:   db_update('users')
danielebarchiesi@0:     ->fields(array('signature_format' => $default_format))
danielebarchiesi@0:     ->isNotNull('signature_format')
danielebarchiesi@0:     ->condition('signature_format', $existing_formats, 'NOT IN')
danielebarchiesi@0:     ->execute();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Placeholder function.
danielebarchiesi@0:  *
danielebarchiesi@0:  * As a fix for user_update_7011() not updating email templates to use the new
danielebarchiesi@0:  * tokens, user_update_7017() now targets email templates of Drupal 6 sites and
danielebarchiesi@0:  * already upgraded sites.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7011() {
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Add the user's pictures to the {file_managed} table and make them managed
danielebarchiesi@0:  * files.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7012(&$sandbox) {
danielebarchiesi@0: 
danielebarchiesi@0:   $picture_field = array(
danielebarchiesi@0:     'type' => 'int',
danielebarchiesi@0:     'not null' => TRUE,
danielebarchiesi@0:     'default' => 0,
danielebarchiesi@0:     'description' => "Foreign key: {file_managed}.fid of user's picture.",
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($sandbox['progress'])) {
danielebarchiesi@0:     // Check that the field hasn't been updated in an aborted run of this
danielebarchiesi@0:     // update.
danielebarchiesi@0:     if (!db_field_exists('users', 'picture_fid')) {
danielebarchiesi@0:       // Add a new field for the fid.
danielebarchiesi@0:       db_add_field('users', 'picture_fid', $picture_field);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Initialize batch update information.
danielebarchiesi@0:     $sandbox['progress'] = 0;
danielebarchiesi@0:     $sandbox['last_user_processed'] = -1;
danielebarchiesi@0:     $sandbox['max'] = db_query("SELECT COUNT(*) FROM {users} WHERE picture <> ''")->fetchField();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // As a batch operation move the photos into the {file_managed} table and
danielebarchiesi@0:   // update the {users} records.
danielebarchiesi@0:   $limit = 500;
danielebarchiesi@0:   $result = db_query_range("SELECT uid, picture FROM {users} WHERE picture <> '' AND uid > :uid ORDER BY uid", 0, $limit, array(':uid' => $sandbox['last_user_processed']));
danielebarchiesi@0:   foreach ($result as $user) {
danielebarchiesi@0:     // Don't bother adding files that don't exist.
danielebarchiesi@0:     if (file_exists($user->picture)) {
danielebarchiesi@0: 
danielebarchiesi@0:       // Check if the file already exists.
danielebarchiesi@0:       $files = file_load_multiple(array(), array('uri' => $user->picture));
danielebarchiesi@0:       if (count($files)) {
danielebarchiesi@0:         $file = reset($files);
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         // Create a file object.
danielebarchiesi@0:         $file = new stdClass();
danielebarchiesi@0:         $file->uri      = $user->picture;
danielebarchiesi@0:         $file->filename = drupal_basename($file->uri);
danielebarchiesi@0:         $file->filemime = file_get_mimetype($file->uri);
danielebarchiesi@0:         $file->uid      = $user->uid;
danielebarchiesi@0:         $file->status   = FILE_STATUS_PERMANENT;
danielebarchiesi@0:         $file = file_save($file);
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       db_update('users')
danielebarchiesi@0:         ->fields(array('picture_fid' => $file->fid))
danielebarchiesi@0:         ->condition('uid', $user->uid)
danielebarchiesi@0:         ->execute();
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Update our progress information for the batch update.
danielebarchiesi@0:     $sandbox['progress']++;
danielebarchiesi@0:     $sandbox['last_user_processed'] = $user->uid;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Indicate our current progress to the batch update system. If there's no
danielebarchiesi@0:   // max value then there's nothing to update and we're finished.
danielebarchiesi@0:   $sandbox['#finished'] = empty($sandbox['max']) ? 1 : ($sandbox['progress'] / $sandbox['max']);
danielebarchiesi@0: 
danielebarchiesi@0:   // When we're finished, drop the old picture field and rename the new one to
danielebarchiesi@0:   // replace it.
danielebarchiesi@0:   if (isset($sandbox['#finished']) && $sandbox['#finished'] == 1) {
danielebarchiesi@0:     db_drop_field('users', 'picture');
danielebarchiesi@0:     db_change_field('users', 'picture_fid', 'picture', $picture_field);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Add user module file usage entries.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7013(&$sandbox) {
danielebarchiesi@0:   if (!isset($sandbox['progress'])) {
danielebarchiesi@0:     // Initialize batch update information.
danielebarchiesi@0:     $sandbox['progress'] = 0;
danielebarchiesi@0:     $sandbox['last_uid_processed'] = -1;
danielebarchiesi@0:     $sandbox['max'] = db_query("SELECT COUNT(*) FROM {users} u WHERE u.picture <> 0")->fetchField();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Add usage entries for the user picture files.
danielebarchiesi@0:   $limit = 500;
danielebarchiesi@0:   $result = db_query_range('SELECT f.*, u.uid as user_uid FROM {users} u INNER JOIN {file_managed} f ON u.picture = f.fid WHERE u.picture <> 0 AND u.uid > :uid ORDER BY u.uid', 0, $limit, array(':uid' => $sandbox['last_uid_processed']))->fetchAllAssoc('fid', PDO::FETCH_ASSOC);
danielebarchiesi@0:   foreach ($result as $row) {
danielebarchiesi@0:     $uid = $row['user_uid'];
danielebarchiesi@0:     $file = (object) $row;
danielebarchiesi@0:     file_usage_add($file, 'user', 'user', $uid);
danielebarchiesi@0: 
danielebarchiesi@0:     // Update our progress information for the batch update.
danielebarchiesi@0:     $sandbox['progress']++;
danielebarchiesi@0:     $sandbox['last_uid_processed'] = $uid;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Indicate our current progress to the batch update system.
danielebarchiesi@0:   $sandbox['#finished'] = empty($sandbox['max']) || ($sandbox['progress'] / $sandbox['max']);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Rename the 'post comments without approval' permission.
danielebarchiesi@0:  *
danielebarchiesi@0:  * In Drupal 7, this permission has been renamed to 'skip comment approval'.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7014() {
danielebarchiesi@0:   db_update('role_permission')
danielebarchiesi@0:         ->fields(array('permission' => 'skip comment approval'))
danielebarchiesi@0:         ->condition('permission', 'post comments without approval')
danielebarchiesi@0:         ->execute();
danielebarchiesi@0: 
danielebarchiesi@0:   return t("Renamed the 'post comments without approval' permission to 'skip comment approval'.");
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Change {users}.signature_format into varchar.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7015() {
danielebarchiesi@0:   db_change_field('users', 'signature_format', 'signature_format', array(
danielebarchiesi@0:     'type' => 'varchar',
danielebarchiesi@0:     'length' => 255,
danielebarchiesi@0:     'not null' => FALSE,
danielebarchiesi@0:     'description' => 'The {filter_format}.format of the signature.',
danielebarchiesi@0:   ));
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @} End of "addtogroup updates-6.x-to-7.x".
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @addtogroup updates-7.x-extra
danielebarchiesi@0:  * @{
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Update the database to match the schema.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7016() {
danielebarchiesi@0:   // Add field default.
danielebarchiesi@0:   db_change_field('users', 'uid', 'uid', array(
danielebarchiesi@0:     'type' => 'int',
danielebarchiesi@0:     'unsigned' => TRUE,
danielebarchiesi@0:     'not null' => TRUE,
danielebarchiesi@0:     'default' => 0,
danielebarchiesi@0:   ));
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Update email templates to use new tokens.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This function upgrades customized email templates from the old !token format
danielebarchiesi@0:  * to the new core tokens format. Additionally, in Drupal 7 we no longer e-mail
danielebarchiesi@0:  * plain text passwords to users, and there is no token for a plain text
danielebarchiesi@0:  * password in the new token system. Therefore, it also modifies any saved
danielebarchiesi@0:  * templates using the old '!password' token such that the token is removed, and
danielebarchiesi@0:  * displays a warning to users that they may need to go and modify the wording
danielebarchiesi@0:  * of their templates.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7017() {
danielebarchiesi@0:   $message = '';
danielebarchiesi@0: 
danielebarchiesi@0:   $tokens = array(
danielebarchiesi@0:     '!site' => '[site:name]',
danielebarchiesi@0:     '!username' => '[user:name]',
danielebarchiesi@0:     '!mailto' => '[user:mail]',
danielebarchiesi@0:     '!login_uri' => '[site:login-url]',
danielebarchiesi@0:     '!uri_brief' => '[site:url-brief]',
danielebarchiesi@0:     '!edit_uri' => '[user:edit-url]',
danielebarchiesi@0:     '!login_url' => '[user:one-time-login-url]',
danielebarchiesi@0:     '!uri' => '[site:url]',
danielebarchiesi@0:     '!date' => '[date:medium]',
danielebarchiesi@0:     '!password' => '',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $result = db_select('variable', 'v')
danielebarchiesi@0:     ->fields('v', array('name'))
danielebarchiesi@0:     ->condition('name', db_like('user_mail_') . '%', 'LIKE')
danielebarchiesi@0:     ->execute();
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($result as $row) {
danielebarchiesi@0:     // Use variable_get() to get the unserialized value for free.
danielebarchiesi@0:     if ($value = variable_get($row->name, FALSE)) {
danielebarchiesi@0: 
danielebarchiesi@0:       if (empty($message) && (strpos($value, '!password') !== FALSE)) {
danielebarchiesi@0:         $message = t('The ability to send users their passwords in plain text has been removed in Drupal 7. Your existing email templates have been modified to remove it. You should <a href="@template-url">review these templates</a> to make sure they read properly.', array('@template-url' => url('admin/config/people/accounts')));
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       variable_set($row->name, str_replace(array_keys($tokens), $tokens, $value));
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $message;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Ensure there is an index on {users}.picture.
danielebarchiesi@0:  */
danielebarchiesi@0: function user_update_7018() {
danielebarchiesi@0:   if (!db_index_exists('users', 'picture')) {
danielebarchiesi@0:     db_add_index('users', 'picture', array('picture'));
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @} End of "addtogroup updates-7.x-extra".
danielebarchiesi@0:  */