Skip to content

Fix issue with backslashes being removed from entry values #2281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

AbdiTolesa
Copy link
Contributor

Copy link
Contributor

coderabbitai bot commented Mar 24, 2025

Walkthrough

The changes modify the process_entry method in the FrmEntriesController class. Previously, the method used wp_unslash($_POST) for input validation and passed raw $_POST when creating an entry. Now, it directly uses $_POST for validation and applies wp_slash($_POST) before calling the entry creation method. This update alters the data sanitization flow used during the validation and storage phases.

Changes

File(s) Change Summary
classes/controllers/FrmEntriesController.php Updated the process_entry method: replaced wp_unslash($_POST) with direct $_POST for validation and applied wp_slash($_POST) before entry creation.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Controller as FrmEntriesController
    participant Entry as FrmEntry

    User->>+Controller: Submit POST data
    Controller->>Controller: Validate input using raw $_POST
    Controller->>Controller: Prepare data using wp_slash($_POST)
    Controller->>Entry: Create entry with slashed data
    Entry-->>Controller: Return creation result
    Controller-->>User: Return response
Loading

Possibly related PRs

Suggested labels

action: needs qa, run analysis, run tests

Suggested reviewers

  • garretlaxton

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 31d53f0 and 0b157f3.

📒 Files selected for processing (1)
  • classes/controllers/FrmEntriesController.php (2 hunks)
🔇 Additional comments (3)
classes/controllers/FrmEntriesController.php (3)

620-620: Modified data sanitization approach during validation.

The change removes the wp_unslash() function when validating form data, which prevents backslashes entered by users from being stripped during the validation process.


638-638: Applied proper data escaping before entry creation.

Adding wp_slash() to the $_POST data before passing it to FrmEntry::create() ensures that user-entered backslashes are properly preserved in the database. This is the correct approach as WordPress automatically adds slashes to data before storing it in the database, and the previous implementation was likely causing backslashes to be inadvertently removed.


620-638: Verify this change fixes the backslash issue across all use cases.

The changes correctly address the issue of backslashes being removed from entry values by modifying the data handling flow. However, it's important to verify this solution works in all scenarios.

You can test this fix with the following steps:

  1. Create a form with a text field
  2. Submit the form with values containing backslashes (e.g., C:\path\to\file or This is a \"quoted\" text)
  3. Verify that the backslashes are preserved in the saved entry
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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 generate docstrings to generate docstrings for this 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.

@AbdiTolesa
Copy link
Contributor Author

AbdiTolesa commented Mar 24, 2025

@Crabcyborg This PR only covers entry create process, we can apply similar fix to Pro if it is accepted.

What I found to be causing the issue of backslashes getting removed from the entry values is that we are calling wp_unslash twice on each entry value when creating an entry and try to unslash the value in FrmEntry::prepare_entry.

Here is what I exactly mean,

When creating an entry $_POST is slashed somewhere and FrmEntriesController::process_entry is called, which unslashes the global $_POST when passing it to FrmEntryValidate::validate. Later on FrmEntriesHelper::get_posted_meta is called and that unslashes the entry meta values in the global $_POST variable for the second time. Now if you have \I'm cool in your value, only I'm cool is stored in database. That is the issue.

The values sent to the database should actually be slashed once to be retrieved properly later as in this PR but I don't have that much of confidence that it is an ideal solution. I have tried to think to come up with alternative solutions but I couldn't.

I would appreciate your thoughts on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant