foldershare-8.x-1.2/foldershare.update.inc

foldershare.update.inc
<?php
 
/**
 * @file
 * Implements hooks to update the module.
 *
 * Note that comments on update functions are parsed and shown to the
 * site admin to describe an update before it is applied.
 */
 
use Drupal\Core\Database\Database;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\user\Entity\Role;
 
use Drupal\foldershare\Constants;
use Drupal\foldershare\Settings;
use Drupal\foldershare\Utilities\ConfigurationUtilities;
use Drupal\foldershare\Entity\FolderShare;
use Drupal\foldershare\ManageUsageStatistics;
use Drupal\foldershare\ManageSearch;
 
/*----------------------------------------------------------------------
 *
 * 0.5.0 to 0.5.1
 *
 *----------------------------------------------------------------------*/
 
/**
 * Update the configurations for views, search, and entity views.
 *
 * These mandatory updates support a substantial overhaul of the user
 * interface that revises the module's views, entity view page, and search
 * indexing. Upon completion, the search index will be cleared and all site
 * caches flushed.
 */
function foldershare_update_8001(&$sandbox) {
  // Restore the search configuration and clear the index.
  if (\Drupal::service('module_handler')->moduleExists('search') === TRUE) {
    ConfigurationUtilities::revertConfiguration(
      'core',
      'search.page.foldershare_search');
    search_index_clear(Constants::SEARCH_INDEX);
  }
 
  // Restore the view configuration.
  ConfigurationUtilities::revertConfiguration(
    'view',
    Constants::VIEW_LISTS);
 
  // Restore the entity display configuration.
  ConfigurationUtilities::revertConfiguration(
    'core',
    'entity_view_display.foldershare.foldershare.default');
}
 
/*----------------------------------------------------------------------
 *
 * 0.5.4 to 0.6.0
 *
 *----------------------------------------------------------------------*/
 
/**
 * Update entity structure, entity view, and views tables.
 *
 * This mandatory update removes obsolete internal entity fields, adds new
 * internal entity fields, removes a text field formatter, adds new internal
 * field formatters, adds new menu commands, and adds a share-with-public
 * permission.
 *
 * Note that the entity view page and views tables are necessarily reset.
 * Any site customizations will be lost.
 */
function foldershare_update_8002() {
  $updateManager = \Drupal::entityDefinitionUpdateManager();
  $connection    = Database::getConnection();
  $schema        = $connection->schema();
  $baseTable     = FolderShare::BASE_TABLE;
  $usageTable    = ManageUsageStatistics::USAGE_TABLE;
 
  //
  // Update all entities with 'rootfolder' to use 'folder' instead.
  // --------------------------------------------------------------
  // For all entities that use the old value, update to the new value.
  $connection->update($baseTable)
    ->condition('kind', 'rootfolder', '=')
    ->fields(['kind' => FolderShare::FOLDER_KIND])
    ->execute();
 
  //
  // Remove 'nRootFolders' column from usage table.
  // ----------------------------------------------
  // Remove the column.
  if ($schema->fieldExists($usageTable, 'nRootFolders') === TRUE) {
    $schema->dropField($usageTable, 'nRootFolders');
  }
 
  //
  // Add 'systemhidden' and 'systemdisabled' fields.
  // -----------------------------------------------
  // Update the base field definition. These definitions are copied from
  // the entity's base field definition for new installs.
  if ($schema->fieldExists($baseTable, 'systemhidden') === FALSE) {
    // System hidden field flag.
    // - Boolean.
    // - Default is FALSE.
    // - 'view' unsupported.
    // - 'form' unsupported.
    //
    // Field editing blocked by FolderShareAccessControlHandler for all users.
    $definition = BaseFieldDefinition::create('boolean')
      ->setLabel(t('System hidden'))
      ->setDescription(t('A TRUE/FALSE value indicating if the entity has been hidden by the system during special operations.'))
      ->setRequired(FALSE)
      ->setDefaultValue(FALSE)
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE);
 
    // Add the field.
    $updateManager->installFieldStorageDefinition(
      'systemhidden',
      FolderShare::ENTITY_TYPE_ID,
      FolderShare::ENTITY_TYPE_ID,
      $definition);
  }
 
  if ($schema->fieldExists($baseTable, 'systemdisabled') === FALSE) {
    // System disabled field flag.
    // - Boolean.
    // - Default is FALSE.
    // - 'view' unsupported.
    // - 'form' unsupported.
    //
    // Field editing blocked by FolderShareAccessControlHandler for all users.
    $definition = BaseFieldDefinition::create('boolean')
      ->setLabel(t('System disabled'))
      ->setDescription(t('A TRUE/FALSE value indicating if the entity has been disabled by the system during special operations.'))
      ->setRequired(FALSE)
      ->setDefaultValue(FALSE)
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE);
 
    // Add the field.
    $updateManager->installFieldStorageDefinition(
      'systemdisabled',
      FolderShare::ENTITY_TYPE_ID,
      FolderShare::ENTITY_TYPE_ID,
      $definition);
  }
 
  //
  // Update all entities to default 'systemhidden' and 'systemdisabled' values.
  // --------------------------------------------------------------------------
  // Default to FALSE.
  $connection->update(FolderShare::BASE_TABLE)
    ->fields([
      'systemhidden'   => (int) 0,
      'systemdisabled' => (int) 0,
    ])
    ->execute();
 
  //
  // Remove 'grantdisableduids' field.
  // ---------------------------------
  // Update the base field definition.
  $definition = $updateManager->getFieldStorageDefinition(
    'grantdisableduids',
    FolderShare::ENTITY_TYPE_ID);
  if ($definition !== NULL) {
    $updateManager->uninstallFieldStorageDefinition($definition);
 
    // Uninstallling a field marks the field as deleted data. Future
    // runs of CRON will delete the field data in batches until all
    // entities have been updated, and then the multi-value table
    // will be automatically dropped.
  }
 
  //
  // Flush all caches.
  // -----------------
  // Render and views now use 'systemhidden' and 'systemdisabled', so their
  // caches need to be flushed. The breadcrumb builder's interface has changed,
  // and the field formatter plugins have been updated. There are also new
  // menu commands and a new permission.
  //
  // The cache must be flushed now before we install configurations that use
  // the new field formatters, use the new menu commands, or use the new
  // permission.
  drupal_flush_all_caches();
 
  //
  // Reset views.
  // ------------
  // The new views use new field formatters, check the 'systemhidden' flag,
  // and support lists in dialogs.
  ConfigurationUtilities::revertConfiguration(
    'view',
    Constants::VIEW_LISTS);
 
  //
  // Reset entity view.
  // ------------------
  // The previous release included a text display field formatter that has
  // been removed.
  ConfigurationUtilities::revertConfiguration(
    'core',
    'entity_view_display.foldershare.foldershare.default');
 
  //
  // Enable new menu commands.
  // -------------------------
  // Insure the new menu commands are enabled by default.
  $currentCommands = Settings::getCommandMenuAllowed();
  if (in_array('foldersharecommand_delete_as_admin', $currentCommands) === FALSE) {
    $currentCommands[] = 'foldersharecommand_delete_as_admin';
  }
 
  if (in_array('foldersharecommand_delete_on_rootlist', $currentCommands) === FALSE) {
    $currentCommands[] = 'foldersharecommand_delete_on_rootlist';
  }
 
  if (in_array('foldersharecommand_release_share', $currentCommands) === FALSE) {
    $currentCommands[] = 'foldersharecommand_release_share';
  }
 
  Settings::setCommandMenuAllowed($currentCommands);
 
  //
  // Enable the share-with-public permission for roles with share permission.
  // ------------------------------------------------------------------------
  // The old "share" permission shared with others or public. The new one only
  // shares with others, and a new "share with public" permission shares with
  // the public. If user roles had the old "share" permission, give them both
  // share permissions now.
  foreach (\Drupal::entityQuery('user_role')->execute() as $roleId) {
    $role = Role::load($roleId);
    if ($role !== NULL) {
      if ($role->hasPermission(Constants::SHARE_PERMISSION) === TRUE) {
        $role->grantPermission(Constants::SHARE_PUBLIC_PERMISSION);
        $role->save();
      }
    }
  }
 
  return t('Update complete. Note that the entity view page and view lists configurations have been necessarily reset to defaults.');
}
 
/*----------------------------------------------------------------------
 *
 * 0.6.0 to 0.6.1
 *
 *----------------------------------------------------------------------*/
 
/**
 * Update default enabled commands.
 *
 * This mandatory update adds new menu commands.
 */
function foldershare_update_8003() {
  //
  // Enable new menu commands.
  // -------------------------
  // Insure the new menu commands are enabled by default.
  $currentCommands = Settings::getCommandMenuAllowed();
  if (in_array('foldersharecommand_move_as_admin', $currentCommands) === FALSE) {
    $currentCommands[] = 'foldersharecommand_move_as_admin';
  }
 
  if (in_array('foldersharecommand_move_on_rootlist', $currentCommands) === FALSE) {
    $currentCommands[] = 'foldersharecommand_move_on_rootlist';
  }
 
  Settings::setCommandMenuAllowed($currentCommands);
}
 
/**
 * Flush all caches.
 */
function foldershare_update_8004() {
  // This update is intentionally empty. Its effect is to cause all
  // caches to be flushed.
  return t('Update complete.');
}
 
/*----------------------------------------------------------------------
 *
 * 0.6.1 to 0.6.2
 *
 *----------------------------------------------------------------------*/
 
/**
 * Update views and add an internal entity type for scheduled tasks.
 *
 * This mandatory update fixes a problem with views that allowed some
 * displays to show hidden items. It also installs a new internal entity type
 * that manages scheduled background tasks.
 *
 * Note that the views lists must be reset.  Any site customizations will
 * be lost.
 */
function foldershare_update_8005() {
  //
  // Install FolderShareScheduledTask.
  // ---------------------------------
  // Get the definition for the new FolderShareScheduledTask entity
  // and install it.
  $updateManager = \Drupal::entityDefinitionUpdateManager();
  if ($updateManager->getEntityType('foldershare_scheduledtask') === NULL) {
    $typeManager = \Drupal::entityTypeManager();
    $definition = $typeManager->getDefinition(
      'foldershare_scheduledtask',
      FALSE);
 
    if ($definition !== NULL) {
      $updateManager->installEntityType($definition);
    }
  }
 
  //
  // Reset views.
  // ------------
  // All views now check the 'systemhidden' flag.
  ConfigurationUtilities::revertConfiguration(
    'view',
    Constants::VIEW_LISTS);
 
  return t('Update complete. Note that the view lists configurations have been necessarily reset to defaults.');
}
 
/*----------------------------------------------------------------------
 *
 * 0.6.2 to 0.6.3
 *
 *----------------------------------------------------------------------*/
 
/**
 * Update entity definition for internal scheduled tasks.
 *
 * This mandatory update reduces the visibility of the internal scheduled
 * task entity. This makes its fields unavailable on pages, through entity
 * references, or within views.
 */
function foldershare_update_8006() {
  // This update is intentionally empty. Its effect is to cause all
  // caches to be flushed, which will pick up changes to the entity type.
  return t('Update complete.');
}
 
/*----------------------------------------------------------------------
 *
 * 0.6.3 to 0.6.4
 *
 *----------------------------------------------------------------------*/
 
/**
 * Update entity definition for FolderShare entities.
 *
 * This mandatory update disables the static and render cache for
 * FolderShare entities.
 */
function foldershare_update_8007() {
  // This update is intentionally empty. Its effect is to cause all
  // caches to be flushed, which will pick up changes to the entity type.
  return t('Update complete.');
}
 
/*----------------------------------------------------------------------
 *
 * 0.6.4 to 0.6.5
 *
 *----------------------------------------------------------------------*/
 
/**
 * Update enabled menu commands.
 *
 * This mandatory update disables the compress and uncompress commands,
 * which are in development and not yet ready for production sites.
 */
function foldershare_update_8008() {
  // To disable the compress and uncompress commands, we need to force
  // an enable of command menu restrictions, and then intentionally not
  // list these commands in the list of allowed commands.
  Settings::setCommandMenuRestrict(TRUE);
 
  $allowedCommands = Settings::getCommandMenuAllowed();
  $keepCommands = [];
 
  foreach ($allowedCommands as $command) {
    switch ($command) {
      case 'foldersharecommand_archive':
      case 'foldersharecommand_unarchive':
        break;
 
      default:
        $keepCommands[] = $command;
        break;
    }
  }
 
  Settings::setCommandMenuAllowed($keepCommands);
 
  return t('Update complete.');
}
 
/*----------------------------------------------------------------------
 *
 * 0.6.8 to 1.2.0
 *
 *----------------------------------------------------------------------*/
 
/**
 * Updates to forms, settings, and routes.
 *
 * This mandatory update modifies search indexing, forms, usage reporting,
 * logging, hooks, and background task scheduling.  Some routes and services
 * have changed.  REST web services have been removed from this module and
 * are now available via the separate FolderShare REST module.
 */
function foldershare_update_8009() {
  // Search indexing has changed slightly. Mark everything as in need of
  // reindexing.
  ManageSearch::markForReindex();
 
  // Delete the old REST configuration now that REST has been moved to
  // a separate module.
  $configStorage = \Drupal::service('config.storage');
  $configStorage->delete('rest.resource.entity.foldershare');
 
  // The update will trigger a full cache flush will pick up the route
  // and services chasnges.
  return t('Update complete.');
}
Главная | Обратная связь
You are here

foldershare-8.x-1.2/foldershare.update.inc
