class ImporterService in Path redirect import 8
Class ImporterService.
@package Drupal\path_redirect_import
Hierarchy
- class \Drupal\path_redirect_import\ImporterService
Expanded class hierarchy of ImporterService
3 files declare their use of ImporterService
- PathRedirectImport.php in src/
Commands/ PathRedirectImport.php - path_redirect_import.drush.inc in ./
path_redirect_import.drush.inc - Drush commands for the pat_redirect_import module.
- RedirectImportForm.php in src/
Form/ RedirectImportForm.php
1 string reference to 'ImporterService'
1 service uses ImporterService
File
- src/
ImporterService.php, line 15
Namespace
Drupal\path_redirect_importView source
class ImporterService {
/**
* List of status messages to be output in screen.
*
* @var array
*/
public static $messages = [];
public static $options = [];
/**
* Main method: execute parsing and saving of redirects.
*
* @param mixed $file
* Either a Drupal file object (ui) or a path to a file (drush).
* @param str[] $options
* User-supplied default flags.
*/
public static function import($file, array $options) {
// Parse the CSV file into a readable array.
$data = self::read($file, $options);
self::$options = $options;
// Perform Drupal-specific validation logic on each row.
$data = array_filter($data, [
'self',
'preSave',
]);
if ($options['suppress_messages'] != 1 && !empty(self::$messages['warning'])) {
// Messaging/logging is separated out in case we want to suppress these.
foreach (self::$messages['warning'] as $warning) {
\Drupal::messenger()
->addWarning($warning, 'warning');
}
}
if (empty($data)) {
\Drupal::messenger()
->addWarning(t('The uploaded file contains no rows with compatible redirect data. No redirects have imported. Compare your file to <a href=":sample">this sample data.</a>', [
':sample' => '/' . drupal_get_path('module', 'path_redirect_import') . '/redirect-example-file.csv',
]));
}
else {
if (PHP_SAPI == 'cli' && function_exists('drush_main')) {
foreach ($data as $redirect_array) {
self::save($redirect_array, $options['override'], []);
}
}
else {
// Save valid redirects.
foreach ($data as $row) {
$operations[] = [
[
'\\Drupal\\path_redirect_import\\ImporterService',
'save',
],
[
$row,
$options['override'],
],
];
}
$batch = [
'title' => t('Saving Redirects'),
'operations' => $operations,
'finished' => [
'\\Drupal\\path_redirect_import\\ImporterService',
'finish',
],
'file' => drupal_get_path('module', 'path_redirect_import') . '/path_redirect_import.module',
];
batch_set($batch);
}
}
}
/**
* Batch API callback.
*/
public static function finish($success, $results, $operations) {
if ($success) {
$message = t('Redirects processed.');
}
else {
$message = t('Finished with an error.');
}
\Drupal::messenger()
->addStatus($message);
}
/**
* Convert CSV file into readable PHP array.
*
* @param mixed $file
* A Drupal file object.
* @param str[] $options
* User-passed defaults.
*
* @return str[]
* Keyed array of redirects, in the format
* [source, redirect, status_code, language].
*/
protected static function read($file, array $options = []) {
if (PHP_SAPI == 'cli' && function_exists('drush_main')) {
$filepath = $file;
}
else {
$filepath = \Drupal::service('file_system')
->realpath($file
->getFileUri());
}
if (!($f = fopen($filepath, 'r'))) {
return [
'success' => FALSE,
'message' => [
t('Unable to read the file'),
],
];
}
$options += [
'delimiter' => ',',
'no_headers' => FALSE,
'override' => FALSE,
'status_code' => '301',
'language' => Language::LANGCODE_NOT_SPECIFIED,
];
$line_no = 0;
$messages = [];
$success = FALSE;
$data = [];
while ($line = fgetcsv($f, 0, $options['delimiter'])) {
$message = [];
$line_no++;
if ($line_no == 1 && !$options['no_headers']) {
\Drupal::messenger()
->addMessage(t('Skipping the header row.'));
continue;
}
if (!is_array($line)) {
self::$messages['warning'][] = t('Line @line_no is invalid; bypassed.', [
'@line_no' => $line_no,
]);
continue;
}
if (empty($line[0]) || empty($line[1])) {
self::$messages['warning'][] = t('Line @line_no contains invalid data; bypassed.', [
'@line_no' => $line_no,
]);
continue;
}
if (empty($line[2])) {
$line[2] = $options['status_code'];
}
else {
$redirect_options = redirect_status_code_options();
if (!isset($redirect_options[$line[2]])) {
self::$messages['warning'][] = t('Line @line_no contains invalid status code; bypassed.', [
'@line_no' => $line_no,
]);
continue;
}
}
if (empty($line[3]) || !\Drupal::moduleHandler()
->moduleExists('language')) {
$line[3] = $options['language'];
}
elseif (!self::isValidLanguage($line[3])) {
self::$messages['warning'][] = t('Line @line_no contains an invalid language code; bypassed.', [
'@line_no' => $line_no,
]);
continue;
}
// Build a row of data.
$data[$line_no] = [
'source' => self::stripLeadingSlash($line[0]),
'redirect' => isset($line[1]) ? self::stripLeadingSlash($line[1]) : NULL,
'status_code' => $line[2],
'language' => isset($line[3]) ? $line[3] : $options['language'],
];
}
fclose($f);
return $data;
}
/**
* Check for problematic data and remove or clean up.
*
* @param str[] $row
* Keyed array of redirects, in the format
* [source, redirect, status_code, language].
*
* @return bool
* A TRUE/FALSE value to be used by array_filter.
*/
public static function preSave(array $row) {
// Disallow redirects from <front>.
if ($row['source'] == '<front>') {
self::$messages['warning'][] = t('You cannot create a redirect from the front page. Bypassing "@source".', [
'@source' => $row['source'],
]);
return FALSE;
}
// Disallow redirects from anchor fragments.
if (strpos($row['source'], '#') !== FALSE) {
self::$messages['warning'][] = t('Redirects from anchor fragments (i.e., with "#) are not allowed. Bypassing "@source".', [
'@source' => $row['source'],
]);
return FALSE;
}
// Disallow redirects to nonexistent internal paths.
if (self::internalPathMissing($row['redirect']) && self::$options['allow_nonexistent'] == 0) {
self::$messages['warning'][] = t('The destination path "@redirect" does not exist on the site. Redirect from "@source" bypassed.', [
'@redirect' => $row['redirect'],
'@source' => $row['source'],
]);
return FALSE;
}
// Disallow infinite redirects.
if (self::sourceIsDestination($row)) {
self::$messages['warning'][] = t('You are attempting to redirect "@redirect" to itself. Bypassed, as this will result in an infinite loop.', [
'@redirect' => $row['redirect'],
]);
return FALSE;
}
return TRUE;
}
/**
* Save an individual redirect entity, if no redirect already exists.
*
* @param str[] $redirect_array
* Keyed array of redirects, in the format
* [source, redirect, status_code, language].
* @param bool $override
* A 1 indicates that existing redirects should be updated.
*/
public static function save(array $redirect_array, $override) {
if ($redirects = self::redirectExists($redirect_array)) {
if ($override == 1) {
$redirect = reset($redirects);
$message_type = 'Updated';
}
else {
return;
}
}
else {
$message_type = 'Added';
$parsed_url = UrlHelper::parse(trim($redirect_array['source']));
$path = isset($parsed_url['path']) ? $parsed_url['path'] : NULL;
$query = isset($parsed_url['query']) ? $parsed_url['query'] : NULL;
/** @var \Drupal\redirect\Entity\Redirect $redirect */
$redirectEntityManager = \Drupal::service('entity.manager')
->getStorage('redirect');
$redirect = $redirectEntityManager
->create();
$redirect
->setSource($path, $query);
}
// Currently, the Redirect module's setRedirect function assumes
// all paths are internal. If external, we will use redirect_redirect->set.
if (parse_url($redirect_array['redirect'], PHP_URL_SCHEME)) {
$redirect->redirect_redirect
->set(0, [
'uri' => $redirect_array['redirect'],
]);
}
else {
$redirect
->setRedirect($redirect_array['redirect']);
}
$redirect
->setStatusCode($redirect_array['status_code']);
$redirect
->setLanguage($redirect_array['language']);
$redirect
->save();
\Drupal::messenger()
->addStatus(t('@message_type redirect from @source to @redirect', [
'@message_type' => $message_type,
'@source' => $redirect_array['source'],
'@redirect' => $redirect_array['redirect'],
]));
}
/**
* Remove leading slash, if present.
*
* @param string $path
* A user-supplied URL path.
*
* @return string
* A URL without the leading slash.
*/
protected static function stripLeadingSlash($path) {
if (strpos($path, '/') === 0) {
return substr($path, 1);
}
return $path;
}
/**
* Add leading slash, if not present.
*
* @param string $path
* A user-supplied URL path.
*
* @return string
* A URL with the leading slash.
*/
protected static function addLeadingSlash($path) {
if (strpos($path, '/') !== 0) {
return '/' . $path;
}
return $path;
}
/**
* Check if the path is internal, and if so, if it is missing.
*
* @param string $destination
* A user-supplied URL path.
*
* @return bool
* TRUE on missing internal path, FALSE otherwise.
*/
protected static function internalPathMissing($destination) {
if ($destination == '<front>') {
return FALSE;
}
$parsed = parse_url($destination);
if (!isset($parsed['scheme'])) {
// Check for aliases *including* named anchors/query strings.
$alias = self::addLeadingSlash($destination);
$normal_path = \Drupal::service('path.alias_manager')
->getPathByAlias($alias);
if ($alias != $normal_path) {
return FALSE;
}
// Check for aliases *excluding* named anchors/query strings.
if (isset($parsed['path'])) {
$alias = self::addLeadingSlash($parsed['path']);
$normal_path = \Drupal::service('path.alias_manager')
->getPathByAlias($alias);
if ($alias != $normal_path) {
return FALSE;
}
}
// Get the route object from the redirect location.
try {
/* @var \Symfony\Cmf\Component\Routing\ChainRouter $router */
$router = \Drupal::service('router');
$route = $router
->match($alias);
} catch (\Exception $e) {
return TRUE;
}
}
return FALSE;
}
/**
* Check for infinite loops.
*
* @param str[] $row
* Keyed array of redirects, in the format
* [source, redirect, status_code, language].
*
* @return bool
* TRUE if Redirect source is the same that destination. FALSE otherwise.
*/
protected static function sourceIsDestination(array $row) {
// Check if the user-supplied source & redirect are identical.
if ($row['source'] == $row['redirect']) {
return TRUE;
}
// Now check if the the resulting Drupal location would be identical.
try {
$parsed = parse_url($row['redirect']);
if (!isset($parsed['scheme'])) {
// If the destination is an internal link, prepare it.
$row['redirect'] = 'internal:' . self::addLeadingSlash($row['redirect']);
}
$source_url = Url::fromUri('internal:/' . $row['source']);
$redirect_url = Url::fromUri($row['redirect']);
// It is relevant to do this comparison only in case the source path has
// a valid route. Otherwise the validation will fail on the redirect path
// being an invalid route.
if ($source_url
->toString() == $redirect_url
->toString()) {
return TRUE;
}
// We still need to check external links, if the user has entered
// /node/3 => http://example.com/node/3.
$host = \Drupal::request()
->getSchemeAndHttpHost();
if ($host . $source_url
->toString() == $redirect_url
->toString()) {
return TRUE;
}
} catch (\InvalidArgumentException $e) {
// Do nothing, we want to only compare the resulting URLs.
}
return FALSE;
}
/**
* Check if a redirect already exists for this source path.
*
* @param str[] $row
* Keyed array of redirects, in the format
* [source, redirect, status_code, language].
*
* @return mixed
* FALSE if the redirect does not exist, array of redirect objects
* if it does.
*/
protected static function redirectExists(array $row) {
// @todo memoize the query.
$parsed_url = UrlHelper::parse(trim($row['source']));
$path = isset($parsed_url['path']) ? $parsed_url['path'] : NULL;
$query = isset($parsed_url['query']) ? $parsed_url['query'] : NULL;
$hash = Redirect::generateHash($path, $query, $row['language']);
// Search for duplicate.
$redirects = \Drupal::entityTypeManager()
->getStorage('redirect')
->loadByProperties([
'hash' => $hash,
]);
if (!empty($redirects)) {
return $redirects;
}
return FALSE;
}
/**
* Check if the string is a valid langcode.
*
* @param string $langcode
* A string to check.
*
* @return bool
* Whether the langcode is valid.
*/
protected static function isValidLanguage($langcode) {
if (\Drupal::moduleHandler()
->moduleExists('language')) {
if (!empty($langcode) && in_array($langcode, self::validLanguages())) {
return TRUE;
}
}
return FALSE;
}
/**
* Retrieve languages in the system.
*
* @return str[]
* A list of langcodes known to the system.
*/
protected static function validLanguages() {
$languages = \Drupal::languageManager()
->getLanguages();
$languages = array_keys($languages);
$defaultLockedLanguages = \Drupal::languageManager()
->getDefaultLockedLanguages();
$defaultLockedLanguages = array_keys($defaultLockedLanguages);
return array_merge($languages, $defaultLockedLanguages);
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
ImporterService:: |
public static | property | List of status messages to be output in screen. | |
|
ImporterService:: |
public static | property | ||
|
ImporterService:: |
protected static | function | Add leading slash, if not present. | |
|
ImporterService:: |
public static | function | Batch API callback. | |
|
ImporterService:: |
public static | function | Main method: execute parsing and saving of redirects. | |
|
ImporterService:: |
protected static | function | Check if the path is internal, and if so, if it is missing. | |
|
ImporterService:: |
protected static | function | Check if the string is a valid langcode. | |
|
ImporterService:: |
public static | function | Check for problematic data and remove or clean up. | |
|
ImporterService:: |
protected static | function | Convert CSV file into readable PHP array. | |
|
ImporterService:: |
protected static | function | Check if a redirect already exists for this source path. | |
|
ImporterService:: |
public static | function | Save an individual redirect entity, if no redirect already exists. | |
|
ImporterService:: |
protected static | function | Check for infinite loops. | |
|
ImporterService:: |
protected static | function | Remove leading slash, if present. | |
|
ImporterService:: |
protected static | function | Retrieve languages in the system. |