[D7] Device Detector

There are some errors reported by automated review tools, did you already check them? See http://pareview.sh/pareview/httpgitdrupalorgsandboxnathmonoj20142523140git

We are currently quite busy with all the project applications and we prefer projects with a review bonus. Please help reviewing and put yourself on the high priority list, then we will take a look at your project right away :-)

Also, you should get your friends, colleagues or other community members involved to review this application. Let them go through the review checklist and post a comment that sets this issue to "needs work" (they found some problems with the project) or "reviewed & tested by the community" (they found no major flaws).

I'm a robot and this is an automated message from Project Applications Scraper.

I review it's working fine for me

@dishabhadra what about automated test?
http://pareview.sh/pareview/httpgitdrupalorgsandboxnathmonoj20142523140git

Hi,

Could you please validate the input fields where you should not accept any special characters?

I tried to add special chars in "Body Common Class Name/Names " field, its accepting. But In your case, as you are going to use this as class name in tag, you should avoid special chars if I am right.

I have attached the screenshots.

Thanks,
Navaneeth

Hi monojnath,

When I configure "Device Detector Settings" and try to "Add Custom class specific to the browser :: Google Chrome" I get below error
Please provide Chrome specific Class Name/Names in required format

I tried it with class1,class2 and other comma separated class names as per examples you have given. And I am getting same error for other browser options.

Can you please look into it.

@monojnath

Your description says

Add class names, comma(,) separated for multiple class names to be added to every page on body
eg. classA,classB....

Single class name work perfectly for me. But when I add comma(,) it gives me an validation error. Please check attached screenshot.

Hi,

I have reviewed your module manually. There are few recommendations you might want to consider.

Hi monojnath,

I have checked your changes and they are fixed now.

Also remove comma(,) from your examples eg.'\/~`!@#$%^&*()_-+=\{}[]|;:"<>,.?

Everything else looks good.

Oh yes. I got confused. Those are 2 different things.

No need to remove comma(,) from examples.

Followings are few observations,

1. You have already converted path to lower in device_detector.module LN#122 and again converting coverted string at device_detector.common.inc LN#18
2. I'll encourage you to set 'device_detector_node_urls' variable converting all paths to lowecase to avoid doing so while prerocessing html device_detector.common.inc LN#21 & LN#25
3. Please update comment or correct the assignment

     // Body class container array.
     $body_classes = '';
     

4. Please remove
   

   default:
             break;

   from device_detector.module LN#198

5. Is it possible to prefix module name to following variables to have a consistency
   1. is_body_settings_chkd will change to device_detector_is_body_settings_chkd
   2. is_brwsr_settings_chkd will change to device_detector_is_brwsr_settings_chkd
   3. is_dsktp_settings_chkd will change to device_detector_is_dsktp_settings_chkd
   4. is_dvc_settings_chkd will change to device_detector_is_dvc_settings_chkd

Please lemme know if you need more info on above suggested changes.

Thanks for the review rahul,I have not found any blocker above, so moving to needs review

Thanks @naveenvalecha for correcting the status.

@monojnath, please address preview.sh comments.

Following is being copied from http://pareview.sh/pareview/httpgitdrupalorgsandboxnathmonoj20142523140git
Review of the 7.x-1.x branch (commit c8e882e):

• Coder Sniffer has found some issues with your code (please check the Drupal coding standards). See attachment.

This automated report was generated with PAReview.sh, your friendly project application review script. You can also use the online version to check your project. You have to get a review bonus to get a review from me.

FILE: ...w/drupal-7-pareview/pareview_temp/includes/device_detector.common.inc
---------------------------------------------------------------------------
FOUND 9 ERRORS AFFECTING 5 LINES
---------------------------------------------------------------------------
 73 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4
 73 | ERROR | [x] Inline comments must start with a capital letter
 73 | ERROR | [x] Inline comments must end in full-stops, exclamation
    |       |     marks, or question marks
 74 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4
 84 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4
 84 | ERROR | [x] Inline comments must start with a capital letter
 84 | ERROR | [x] Inline comments must end in full-stops, exclamation
    |       |     marks, or question marks
 85 | ERROR | [x] Line indented incorrectly; expected 2 spaces, found 4
 86 | ERROR | [x] Expected 1 newline at end of file; 0 found
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 9 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------


FILE: ...review/pareview_temp/includes/device_detector.admin.config.device.inc
---------------------------------------------------------------------------
FOUND 4 ERRORS AFFECTING 2 LINES
---------------------------------------------------------------------------
 65 | ERROR | [x] Expected 1 space after ELSEIF keyword; 0 found
 65 | ERROR | [x] There should be no white space before a closing ")"
 71 | ERROR | [x] Expected 1 space after ELSEIF keyword; 0 found
 71 | ERROR | [x] There should be no white space before a closing ")"
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------


FILE: ...eview/pareview_temp/includes/device_detector.admin.config.browser.inc
---------------------------------------------------------------------------
FOUND 14 ERRORS AFFECTING 7 LINES
---------------------------------------------------------------------------
 286 | ERROR | [x] Expected 1 space after ELSEIF keyword; 0 found
 286 | ERROR | [x] There should be no white space before a closing ")"
 311 | ERROR | [x] Expected 1 space after ELSEIF keyword; 0 found
 311 | ERROR | [x] There should be no white space before a closing ")"
 326 | ERROR | [x] Expected 1 space after ELSEIF keyword; 0 found
 326 | ERROR | [x] There should be no white space before a closing ")"
 336 | ERROR | [x] Expected 1 space after ELSEIF keyword; 0 found
 336 | ERROR | [x] There should be no white space before a closing ")"
 346 | ERROR | [x] Expected 1 space after ELSEIF keyword; 0 found
 346 | ERROR | [x] There should be no white space before a closing ")"
 356 | ERROR | [x] Expected 1 space after ELSEIF keyword; 0 found
 356 | ERROR | [x] There should be no white space before a closing ")"
 366 | ERROR | [x] Expected 1 space after ELSEIF keyword; 0 found
 366 | ERROR | [x] There should be no white space before a closing ")"
---------------------------------------------------------------------------
PHPCBF CAN FIX THE 14 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------

Time: 674ms; Memory: 16.75Mb

Source: http://pareview.sh/ - PAReview.sh online service

No blockers. Marking this as RTBC

great thanks for your time Rahul!
Manoj, Nice Module,there is a module which looks similar to this,mobile_detector can you check out and post its similarities and differences on the project page and issue summary.

Manual Review :

• Readme.txt is nice. Please remove a trailing slash from https://www.drupal.org/user/3015343/ and using the full namespace would be better https://www.drupal.org/u/monojnath
• device_detector_install : What's the need of setting the variables values here ? can't you use those as default values
• device_detector_browser_settings_form : $form['body_class_details']['device_detector_node_spfc_class'] : Where will this wrapper testprb_replace_field_div exist/come from ?
• device_detector_browser_settings_form_submit : The values that are saving in variables in this function is in complicated way. can't we decouple the code. similarly in device_detector_device_settings_form_submit
• DeviceDetectorMobileDetect : The constants are deprecated. Since this is your written code ? do those required ?
• DeviceDetectorMobileDetect : Nice list of $phoneDevices and tablet devices ? can you make them configurable? its a feature request not a blocker

Not found any blocker. I don't have d7 setup available, so did manual review from code scan. Assinging to er.pushpinderrana to do full & final review if he has time.

Automated Review

Best practice issues identified by pareview.sh / drupalcs / coder. None

Review of the 7.x-1.x branch (commit c27e3e1):

• No automated test cases were found, did you consider writing Simpletests or PHPUnit tests? This is not a requirement but encouraged for professional software development.

This automated report was generated with PAReview.sh, your friendly project application review script. You can also use the online version to check your project. You have to get a review bonus to get a review from me.

Manual Review

Individual user account

Yes: Follows the guidelines for individual user accounts.

No duplication

Yes: Does not cause module duplication and/or fragmentation.

Master Branch

Yes: Follows the guidelines for master branch.

Licensing

Yes: Follows the licensing requirements.

3rd party assets/code

Yes: Follow the guidelines for 3rd party assets/code.

README.txt/README.md

Yes: Follows the guidelines for in-project documentation and/or the README Template.

Code long/complex enough for review

Yes: Follows the guidelines for project length and complexity.

Secure code

(*)No: List of security issues identified.

1. device_detector_preprocess_html(): Below snippet code looks like its vulnerable to XSS exploits.
   

   $current_path = drupal_get_path_alias(current_path());
   $url_breakup = explode('/', $current_path);
   $last_arg = trim(implode(' ', $url_breakup));
   $body_classes .= ' ' . ((!(drupal_is_front_page())) ? strtolower($last_arg) : 'home');
    // To remove repeating classes.
       $body_classes = implode(' ', array_unique(explode(' ', $body_classes)));
       // Adding classes to html <body> tag.
       $vars['classes_array'][] = rtrim($body_classes);

   You are passing the $last_arg unsanitized to $vars['classes_array'].You need to apply check_plain() to the $last_arg. This is a security blocker. Please make sure to read https://www.drupal.org/node/28984 again.

Coding style & Drupal API usage

1. You should also really have a hook_help() with some basic info about the module.
2. HTML is better to take out of t() function.

The starred items (*) are fairly big issues and warrant going back to Needs Work. Items marked with a plus sign (+) are important and should be addressed before a stable project release. The rest of the comments in the code walkthrough are recommendations.

Please don't remove the security tag, we keep that for statistics and to show examples of security problems.

Automated Review

Best practice issues identified by pareview.sh / drupalcs / coder. None

Review of the 7.x-1.x branch (commit b8ca344):

• No automated test cases were found, did you consider writing Simpletests or PHPUnit tests? This is not a requirement but encouraged for professional software development.

This automated report was generated with PAReview.sh, your friendly project application review script. You can also use the online version to check your project. You have to get a review bonus to get a review from me.

Manual Review

My blocking issues have been addressed.
Nothing major jumped out at me when I read `git diff b8ca344..`

Been sitting at RTBC for a while now, so...

Thanks for your contribution, Monoj Nath!

I updated your account so you can promote this to a full project and also create new projects as either a sandbox or a "full" project.

Here are some recommended readings to help with excellent maintainership:

• Dries' post on Responsible maintainers
• Best practices for creating and maintaining projects
• Maintaining a drupal.org project with Git
• Commit messages - providing history and credit
• Release naming conventions.
• Helping maintainers in the issue queues

You can find lots more contributors chatting on IRC in #drupal-contribute. So, come hang out and stay involved!

Thanks, also, for your patience with the review process. Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

Thanks to the dedicated reviewer(s) as well.