Strip unexpected characters from CSS output var names

[Crabcyborg]

Related Slack conversation https://strategy11.slack.com/archives/C799A2R61/p1732218176807229

This should help prevent broken CSS issues.

[coderabbitai]

Walkthrough

The pull request introduces a new private static method, clean_var_name, to the FrmStylesHelper class, designed to sanitize variable names by removing non-alphanumeric characters, underscores, and hyphens. This method replaces the previous inline sanitization within the output_vars method. Additionally, the css_var_prepare_value method is updated with a new @since annotation for version 6.14, along with minor documentation adjustments throughout the class to clarify the new method's purpose.

Changes

File	Change Summary
classes/helpers/FrmStylesHelper.php	- Added private static function clean_var_name($var_name) for variable name sanitization.
	- Updated output_vars to use self::clean_var_name instead of inline sanitization.
	- Added @since 6.14 annotation to css_var_prepare_value.
	- Minor adjustments to comments and documentation throughout the class.

Possibly related PRs

• Disable form CSS in visual styler more safely #2073: The changes in this PR involve the FrmStylesController class, which is related to style management, similar to the FrmStylesHelper class in the main PR that introduces a method for sanitizing variable names used in styles.

Warning

Rate limit exceeded

@Crabcyborg has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 12 minutes and 19 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ded4439 and ade3b6d.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

classes/helpers/FrmStylesHelper.php (1)

453-461: LGTM! Consider adding input validation

The new method effectively sanitizes CSS variable names. However, consider adding input validation to ensure the input is a string.

 private static function clean_var_name( $var_name ) {
+    if ( ! is_string( $var_name ) ) {
+        return '';
+    }
     return preg_replace( '/[^a-zA-Z0-9_-]/', '', $var_name );
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ded4439 and ade3b6d.

📒 Files selected for processing (1)

• classes/helpers/FrmStylesHelper.php (1 hunks)

🔇 Additional comments (1)

classes/helpers/FrmStylesHelper.php (1)

448-448: LGTM! Security improvement for CSS variable names

The addition of clean_var_name method call improves security by ensuring CSS variable names contain only valid characters.