[1.1.x]Views Regex Functions

Thank you for applying!

Please read Review process for security advisory coverage: What to expect → for more details and Security advisory coverage application checklist → to understand what reviewers look for. Tips for ensuring a smooth review → gives some hints for a smoother review.

The important notes are the following.

• If you have not done it yet, you should run phpcs --standard=Drupal,DrupalPractice on the project, which alone fixes most of what reviewers would report.
• For the time this application is open, only your commits are allowed.
• The purpose of this application is giving you a new drupal.org role that allows you to opt projects into security advisory coverage, either projects you already created, or projects you will create. The project status won't be changed by this application and no other user will be able to opt projects into security advisory policy.
• We only accept an application per user. If you change your mind about the project to use for this application, or it is necessary to use a different project for the application, please update the issue summary with the link to the correct project and the issue title with the project name and the branch to review.

To the reviewers

Please read How to review security advisory coverage applications → , Application workflow → , What to cover in an application review → , and Tools to use for reviews → .

The important notes are the following.

• It is preferable to wait for a Code Review Administrator before commenting on newly created applications. Code Review Administrators will do some preliminary checks that are necessary before any change on the project files is suggested.
• Reviewers should show the output of a CLI tool → only once per application.
• It may be best to have the applicant fix things before further review.

For new reviewers, I would also suggest to first read In which way the issue queue for coverage applications is different from other project queues → .

1.0 Wrong branch name

2.0 Fix phpcs issue

phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml

FILE: README.md
----------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 3 LINES
----------------------------------------------------------------------
3 | WARNING | Line exceeds 80 characters; contains 85 characters
58 | WARNING | Line exceeds 80 characters; contains 105 characters
70 | WARNING | Line exceeds 80 characters; contains 199 characters
----------------------------------------------------------------------

FILE: views_regex_functions.views.inc
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
1 | ERROR | [x] End of line character is invalid; expected "\n" but found
| | "\r\n"
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: .../views_regex_functions/src/Plugin/views/field/ViewsRegexFunctionsField.php
--------------------------------------------------------------------------------
FOUND 22 ERRORS AND 5 WARNINGS AFFECTING 23 LINES
--------------------------------------------------------------------------------
1 | ERROR | [x] End of line character is invalid; expected "\n" but found
| | "\r\n"
15 | ERROR | [x] No space found before comment text; expected "// Following
| | is Used for Testing:" but found "//Following is Used for
| | Testing:"
16 | WARNING | [x] Unused use statement
16 | ERROR | [x] Use statements should be sorted alphabetically. The first
| | wrong one is Drupal\Core\Messenger\MessengerInterface.
110 | WARNING | [ ] Unused variable $fields.
114 | WARNING | [ ] Unused variable $fields.
117 | ERROR | [x] Line indented incorrectly; expected at least 4 spaces,
| | found 0
117 | ERROR | [x] 6 spaces found before inline comment; expected "//
| | '#prefix' => '

'," but found "// '#prefix' =>
| | '
',"
173 | ERROR | [x] No space found before comment text; expected "// Make sure
| | that both the pattern and subject are not empty." but
| | found "//Make sure that both the pattern and subject are
| | not empty."
175 | ERROR | [x] Line indented incorrectly; expected 8 spaces, found 10
178 | ERROR | [x] Line indented incorrectly; expected 8 spaces, found 10
180 | ERROR | [x] Expected newline after closing brace
181 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE"
| | but found "false"
182 | ERROR | [x] Line indented incorrectly; expected 8 spaces, found 10
188 | ERROR | [x] Line indented incorrectly; expected 8 spaces, found 10
218 | WARNING | [ ] Unused private method markup()
235 | ERROR | [x] Expected 1 space after IF keyword; 0 found
236 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 8
238 | ERROR | [x] Expected 1 space after IF keyword; 0 found
239 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 8
250 | ERROR | [x] Line indented incorrectly; expected 8 spaces, found 10
254 | WARNING | [ ] Line exceeds 80 characters; contains 83 characters
254 | ERROR | [x] Inline comments must end in full-stops, exclamation marks,
| | question marks, colons, or closing parentheses
256 | ERROR | [x] Expected 1 space after IF keyword; 0 found
257 | ERROR | [x] Line indented incorrectly; expected 6 spaces, found 8
260 | ERROR | [x] Line indented incorrectly; expected 4 spaces, found 0
260 | ERROR | [x] 4 spaces found before inline comment; expected "//
| | \Drupal::messenger()->addMessage(json_encode($returnValue),
| | true);" but found "//
| | \Drupal::messenger()->addMessage(json_encode($returnValue),
| | true);"
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 23 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: ...views_regex_functions/config/schema/views_regex_functions.views.schema.yml
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
19 | ERROR | [x] Expected 1 newline at end of file; 0 found
--------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------

FILE: views_regex_functions.info.yml
------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------
7 | ERROR | [x] Expected 1 newline at end of file; 0 found
------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------

Time: 88ms; Memory: 10MB

FILE: src/Plugin/views/field/ViewsRegexFunctionsField.php

// '#prefix' => '<hr>',

// \Drupal::messenger()->addMessage(json_encode($returnValue), true);

Remove commented code.

Deleted main branch and replaced it with 1.1.x as the default branch right now.

Removed commented code.
// '#prefix' => '

',
// \Drupal::messenger()->addMessage(json_encode($returnValue), true);

Fixed PHPCS code errors and warnings.

1. 1.1.1 is a wrong name for a branch. Release branch names always end with the literal .x as described in Release branches → .

2. FILE: src/Plugin/views/field/ViewsRegexFunctionsField.php

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, DateFormatter $dateFormatter, TimeInterface $dateTime, RendererInterface $renderer) {

The documentation comment for constructors is not mandatory anymore, If it is given, the description must be Constructs a new [class name] object. where [class name] includes the class namespace.

Removed branch 1.1.1 as it is a duplicate at this point.

Removed the documentation comment from the constructor.

Rest looks fine to me.

Let’s wait for a Code Review Administrator to take a look and if everything goes fine, you will get the role.

@vishal.kadam

Thanks so much for your help!

After a review of the code I don't find any direct security risk implication.

I would implement pattern validation and timeout limits for regex operations to avoid any ReDoS, just thinking of non experienced users with administer views permissions.

• The following points are just a start and don't necessarily encompass all of the changes that may be necessary
• A specific point may just be an example and may apply in other places
• A review is about code that does not follow the coding standards, contains possible security issue, or does not correctly use the Drupal API
• The single review points are not ordered, not even by importance

src/Plugin/views/field/ViewsRegexFunctionsField.php

    $form['pattern'] = [
      '#type' => 'textarea',
      '#title' => $this->t('Pattern: <span style="font-weight: normal;">Replacement Pattern to Search For</span>&nbsp;&nbsp;<span style="color: red;">*</span>'),
      '#description' => $this->t('Pattern must be a Regular Expression (Regex).'),
      '#default_value' => $this->options['pattern'],
    ];

Textarea form elements accepts #required.

    $form['replacement'] = [
      '#type' => 'textarea',
      '#title' => $this->t('Replacement: <span style="font-weight: normal;">Replacement Text or Regex Pattern to Replace With</span>'),
      '#default_value' => $this->options['replacement'],
    ];

There is no need to apply specific CSS styles; it is also wrong, as that is a task for a theme.

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RendererInterface $renderer) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->renderer = $renderer;
  }

{@inheritdoc} is not used for class constructors.

    /**
     * @return mixed
     * Used to update the Views UI
     */
    public function adminSummary() {
        return $this->t(' @pattern on @field ', [
            '@pattern' => trim($this->options['pattern']),
            '@field' => trim($this->options['search_subject']),
        ]);
    }

Inherited methods have a simpler documentation comment. In documentation comments for functions or methods, the short and long descriptions are always before @param and @return tags.