You are here

Home » API reference » Search and Replace Scanner 5.2

README.txt in Search and Replace Scanner 5.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
Scanner Search and Replace
--------------------------

I. DESCRIPTION:

The Search and Replace Scanner can do plain text search-and-replace, or 
regular expression search-and-replace, against the title, body and CCK text 
content fields on all nodes in your system.  This is useful for finding html 
strings that Drupal's normal search will ignore. The module is very handy if you 
are fixing typos in a lot of content, changing the name of your company, or 
are changing the URL of a link included multiple times in multiple nodes, 
among other things.


II. LIMITATIONS:

1. Only works on sites using a MySQL database.

2. Large search and replace actions may not be completed on sites that are 
hosted in environments where PHP's max_execution_time variable can't be 
dynamically expanded. The module automatically attempts to expand the 
maximum execution time of a script to 10 minutes. (It's often set at 2 minutes.)  
If your Web host doesn't let you adjust this variable dynamically, you may be 
able to ask your hosting provider to make the change for your account.


III. WARNING:

This is a very powerful tool, and as such is very dangerous.  You can easily
destroy your entire site with it.  Be sure to backup your database before using 
it.  No, really.


IV. FEATURES:

1. Plain text search and replace.

2. Regular expression search and replace.

3. Case sensitive search option.

4. Plain text search allows 'whole word' matching option.  For example, 
searching for "run" with the whole word option selected will filter out 
"running" and "runs", but will match "run!".

5. You can specify text that should precede or follow the search text in order for a match to be valid.

6. Can limit search and replace to published nodes only.

7. Can search and replace on CCK text fields, in addition to node title 
and body fields.

8. Searches can be limited to specific fields in specific node types.

9. Searches can be further limited by nodes containing specific taxonomy terms.

10. Will save a new node revision when a replacement is made, in case you want 
to revert a change.

11. Provides an Undo option that lets you revert all nodes that were udpated in 
a specific replacement action.

12. Can dynamically update teasers after replacements in other fields, or can 
by updated manually, or not at all.

13. Will dynamically expand PHP's maximum execution time for scripts up to 
10 minutes on servers that support it. This allows complex queries on large 
bodies of content.

14. Search results for searches and replacements can be themed.


V. TODO / KNOWN BUGS:

1. Provide better highlighting for search results. Right now there's a known 
bug where multiple search terms on the same line aren't all highlighted. (The 
hit count is correct, though, and all items are replaced correctly.)

2. Perform more thorough testing of the "custom field" feature.


VI. INSTALLATION AND ADMINISTRATION:

See INSTALL.txt for installation and administration instructions.


VII. CREDITS:

Version 5.x-2.0 by:
   - Amit Asaravala
     Drupal username: aasarava
     http://www.returncontrol.com
     amit [at] returncontrol.com
   - Jason Salter
     Drupal username: jpsalter
     http://www.fivepaths.com
     jason [at] fivepaths.com
   - Sponsored by Five Paths Consulting
     http://www.fivepaths.com

Version 5.x-1.0 by:
   -  Tao Starbow
     Drupal username: starbow
     http://www.starbowconsulting.com
     tao [at] starbowconsulting.com

File

README.txt
View source 
  1. 

  2. Scanner Search and Replace

  3. --------------------------

  4. 

  5. I. DESCRIPTION:

  6. 

  7. The Search and Replace Scanner can do plain text search-and-replace, or 

  8. regular expression search-and-replace, against the title, body and CCK text 

  9. content fields on all nodes in your system.  This is useful for finding html 

  10. strings that Drupal's normal search will ignore. The module is very handy if you 

  11. are fixing typos in a lot of content, changing the name of your company, or 

  12. are changing the URL of a link included multiple times in multiple nodes, 

  13. among other things.

  14. 

  15. 

  16. II. LIMITATIONS:

  17. 

  18. 1. Only works on sites using a MySQL database.

  19. 

  20. 2. Large search and replace actions may not be completed on sites that are 

  21. hosted in environments where PHP's max_execution_time variable can't be 

  22. dynamically expanded. The module automatically attempts to expand the 

  23. maximum execution time of a script to 10 minutes. (It's often set at 2 minutes.)  

  24. If your Web host doesn't let you adjust this variable dynamically, you may be 

  25. able to ask your hosting provider to make the change for your account.

  26. 

  27. 

  28. III. WARNING:

  29. 

  30. This is a very powerful tool, and as such is very dangerous.  You can easily

  31. destroy your entire site with it.  Be sure to backup your database before using 

  32. it.  No, really.

  33. 

  34. 

  35. IV. FEATURES:

  36. 

  37. 1. Plain text search and replace.

  38. 

  39. 2. Regular expression search and replace.

  40. 

  41. 3. Case sensitive search option.

  42. 

  43. 4. Plain text search allows 'whole word' matching option.  For example, 

  44. searching for "run" with the whole word option selected will filter out 

  45. "running" and "runs", but will match "run!".

  46. 

  47. 5. You can specify text that should precede or follow the search text in order for a match to be valid.

  48. 

  49. 6. Can limit search and replace to published nodes only.

  50. 

  51. 7. Can search and replace on CCK text fields, in addition to node title 

  52. and body fields.

  53. 

  54. 8. Searches can be limited to specific fields in specific node types.

  55. 

  56. 9. Searches can be further limited by nodes containing specific taxonomy terms.

  57. 

  58. 10. Will save a new node revision when a replacement is made, in case you want 

  59. to revert a change.

  60. 

  61. 11. Provides an Undo option that lets you revert all nodes that were udpated in 

  62. a specific replacement action.

  63. 

  64. 12. Can dynamically update teasers after replacements in other fields, or can 

  65. by updated manually, or not at all.

  66. 

  67. 13. Will dynamically expand PHP's maximum execution time for scripts up to 

  68. 10 minutes on servers that support it. This allows complex queries on large 

  69. bodies of content.

  70. 

  71. 14. Search results for searches and replacements can be themed.

  72. 

  73. 

  74. V. TODO / KNOWN BUGS:

  75. 

  76. 1. Provide better highlighting for search results. Right now there's a known 

  77. bug where multiple search terms on the same line aren't all highlighted. (The 

  78. hit count is correct, though, and all items are replaced correctly.)

  79. 

  80. 2. Perform more thorough testing of the "custom field" feature.

  81. 

  82. 

  83. VI. INSTALLATION AND ADMINISTRATION:

  84. 

  85. See INSTALL.txt for installation and administration instructions.

  86. 

  87. 

  88. VII. CREDITS:

  89. 

  90. Version 5.x-2.0 by:

  91.    - Amit Asaravala

  92.      Drupal username: aasarava

  93.      http://www.returncontrol.com

  94.      amit [at] returncontrol.com

  95.    - Jason Salter

  96.      Drupal username: jpsalter

  97.      http://www.fivepaths.com

  98.      jason [at] fivepaths.com

  99.    - Sponsored by Five Paths Consulting

  100.      http://www.fivepaths.com

  101. 

  102. Version 5.x-1.0 by:

  103.    -  Tao Starbow

  104.      Drupal username: starbow

  105.      http://www.starbowconsulting.com

  106.      tao [at] starbowconsulting.com

  107. 

  108.