Commit 10affe6b authored by Amit Asaravala's avatar Amit Asaravala
Browse files

By aasarava: Beginning 5.x-2.0 development. Module is based on foundations laid by

starbow, but greatly extended by aasarava and jpsalter.

New features include ability to undo changes, to limit searches to node type and even
nodes with certain terms, to match whole words, and to designate words that come before
or after search terms, among several other changes.  See README.txt for full list of
features.
parent de4972c0
$Id$
Scanner Search and Replace
--------------------------
BEFORE YOU START:
Backup your database! Scanner Search and Replace 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.
I. INSTALATION:
1. Place the entire scanner folder in your modules directory.
2. Go to [administer -> site building -> module] and enable the scanner module.
3. Go to [administer -> user management -> access control] and apply your
preferred access settings to the scanner module. You can set which roles can
administer the module -- e.g., determine which fields can be scanned and modify
defaults -- and which roles can use the module. This is is handy if, say, you
only want the site admin to administer the module, but you want content
managers to be able to perform search and replace actions.
4. Go to the Scanner administration panel and select which fields you want to
include in search and replace actions. More information on that is available
below in the Administration Options section.
II. ADMINISTRATION OPTIONS:
You can access the Scanner admin panel two ways:
1. Go to [administer -> site configuration -> search and replace scanner].
2. Go to [administer -> content management -> search and replace scanner] and
select the "Settings" tab.
A. Fields that can be searched:
The most important part of administering Scanner is making sure you select one
or more options in the "Fields that can be searched" section. Fields are listed
in [nodetype: fieldname] format. If you only want to allow people with access
to search and replace on the Body field of the Page content type,
select [page: body].
Teasers are a special case, because they are built off the body and other
fields. Most Scanner admins will likely not select any teaser fields in
this section, and will use the "Rebuild Teasers on Replace" option (under the
"Scanner Options" section) instead. This option automatically rebuilds teasers
to reflect any changes in other fields for a given node.
However, some admins may want not want to update teasers or may want to limit teaser updates to specific content types. In the latter case, you select one or more of the [nodetype: teaser] options in the "Fields that can be searched" section.
B. Scanner Options:
In this section, you can set the defaults for several search options that
Scanner users will see when they use the search and replace form. Users will
still be able to change the options on their own, but the defaults can make
things easier for them if they're likely to only perform one kind of search most of the time.
You can also select whether teasers for nodes should be rebuilt after a
replacement has been made to the body or other fields for that node. Most
admins will select this option, because it ensures that teasers are in synch
with node content. But see section II.A above for more info on why leaving
this option unselected might be helpful.
If your site has categories set up in the Taxonomy module, you can restrict
search and replace actions to nodes that contain terms in a given category
(a.k.a "vocabulary"). Select the vocabularies that you want to allow
restricting by. When users go to the search and replace form, they will have
the option of selecting one or more terms from those vocabularies for limiting
their searches.
C. Custom Fields:
Note: This feature has not been thoroughly tested in Scanner 2. However, it
was designed to let admins specify additional fields for search and
replace that may not have shown up automatically in the "Fields that can be
searched" section. Enter only one field per line, in the following format:
[fieldname] in [tablename] of type [nodetype] on [vid|nid]
If you try this, please please please be sure to backup your database first
(as you should before you use this module anyway) -- and let us know your
feedback!
amit [at] returncontrol.com
jason [at] fivepaths.com
tao [at] starbowconsulting.com
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave,
Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute
verbatim copies of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your freedom to
share and change it. By contrast, the GNU General Public License is
intended to guarantee your freedom to share and change free software--to
make sure the software is free for all its users. This General Public License
applies to most of the Free Software Foundation's software and to any other
program whose authors commit to using it. (Some other Free Software
Foundation software is covered by the GNU Library General Public License
instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our
General Public Licenses are designed to make sure that you have the
freedom to distribute copies of free software (and charge for this service if
you wish), that you receive source code or can get it if you want it, that you
can change the software or use pieces of it in new free programs; and that
you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to
deny you these rights or to ask you to surrender the rights. These restrictions
translate to certain responsibilities for you if you distribute copies of the
software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for
a fee, you must give the recipients all the rights that you have. You must make
sure that they, too, receive or can get the source code. And you must show
them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2)
offer you this license which gives you legal permission to copy, distribute
and/or modify the software.
Also, for each author's protection and ours, we want to make certain that
everyone understands that there is no warranty for this free software. If the
software is modified by someone else and passed on, we want its recipients
to know that what they have is not the original, so that any problems
introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We
wish to avoid the danger that redistributors of a free program will individually
obtain patent licenses, in effect making the program proprietary. To prevent
this, we have made it clear that any patent must be licensed for everyone's
free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification
follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
MODIFICATION
0. This License applies to any program or other work which contains a notice
placed by the copyright holder saying it may be distributed under the terms
of this General Public License. The "Program", below, refers to any such
program or work, and a "work based on the Program" means either the
Program or any derivative work under copyright law: that is to say, a work
containing the Program or a portion of it, either verbatim or with
modifications and/or translated into another language. (Hereinafter, translation
is included without limitation in the term "modification".) Each licensee is
addressed as "you".
Activities other than copying, distribution and modification are not covered
by this License; they are outside its scope. The act of running the Program is
not restricted, and the output from the Program is covered only if its contents
constitute a work based on the Program (independent of having been made
by running the Program). Whether that is true depends on what the Program
does.
1. You may copy and distribute verbatim copies of the Program's source
code as you receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice and
disclaimer of warranty; keep intact all the notices that refer to this License
and to the absence of any warranty; and give any other recipients of the
Program a copy of this License along with the Program.
You may charge a fee for the physical act of transferring a copy, and you
may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion of it,
thus forming a work based on the Program, and copy and distribute such
modifications or work under the terms of Section 1 above, provided that you
also meet all of these conditions:
a) You must cause the modified files to carry prominent notices stating that
you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in whole or in
part contains or is derived from the Program or any part thereof, to be
licensed as a whole at no charge to all third parties under the terms of this
License.
c) If the modified program normally reads commands interactively when run,
you must cause it, when started running for such interactive use in the most
ordinary way, to print or display an announcement including an appropriate
copyright notice and a notice that there is no warranty (or else, saying that
you provide a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this License.
(Exception: if the Program itself is interactive but does not normally print such
an announcement, your work based on the Program is not required to print
an announcement.)
These requirements apply to the modified work as a whole. If identifiable
sections of that work are not derived from the Program, and can be
reasonably considered independent and separate works in themselves, then
this License, and its terms, do not apply to those sections when you distribute
them as separate works. But when you distribute the same sections as part
of a whole which is a work based on the Program, the distribution of the
whole must be on the terms of this License, whose permissions for other
licensees extend to the entire whole, and thus to each and every part
regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to
work written entirely by you; rather, the intent is to exercise the right to
control the distribution of derivative or collective works based on the
Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of a
storage or distribution medium does not bring the other work under the scope
of this License.
3. You may copy and distribute the Program (or a work based on it, under
Section 2) in object code or executable form under the terms of Sections 1
and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable source
code, which must be distributed under the terms of Sections 1 and 2 above
on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three years, to give
any third party, for a charge no more than your cost of physically performing
source distribution, a complete machine-readable copy of the corresponding
source code, to be distributed under the terms of Sections 1 and 2 above on
a medium customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer to distribute
corresponding source code. (This alternative is allowed only for
noncommercial distribution and only if you received the program in object
code or executable form with such an offer, in accord with Subsection b
above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source code
means all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation and
installation of the executable. However, as a special exception, the source
code distributed need not include anything that is normally distributed (in
either source or binary form) with the major components (compiler, kernel,
and so on) of the operating system on which the executable runs, unless that
component itself accompanies the executable.
If distribution of executable or object code is made by offering access to
copy from a designated place, then offering equivalent access to copy the
source code from the same place counts as distribution of the source code,
even though third parties are not compelled to copy the source along with the
object code.
4. You may not copy, modify, sublicense, or distribute the Program except as
expressly provided under this License. Any attempt otherwise to copy,
modify, sublicense or distribute the Program is void, and will automatically
terminate your rights under this License. However, parties who have received
copies, or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
5. You are not required to accept this License, since you have not signed it.
However, nothing else grants you permission to modify or distribute the
Program or its derivative works. These actions are prohibited by law if you
do not accept this License. Therefore, by modifying or distributing the
Program (or any work based on the Program), you indicate your acceptance
of this License to do so, and all its terms and conditions for copying,
distributing or modifying the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the original
licensor to copy, distribute or modify the Program subject to these terms and
conditions. You may not impose any further restrictions on the recipients'
exercise of the rights granted herein. You are not responsible for enforcing
compliance by third parties to this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues), conditions
are imposed on you (whether by court order, agreement or otherwise) that
contradict the conditions of this License, they do not excuse you from the
conditions of this License. If you cannot distribute so as to satisfy
simultaneously your obligations under this License and any other pertinent
obligations, then as a consequence you may not distribute the Program at all.
For example, if a patent license would not permit royalty-free redistribution
of the Program by all those who receive copies directly or indirectly through
you, then the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply and
the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or
other property right claims or to contest validity of any such claims; this
section has the sole purpose of protecting the integrity of the free software
distribution system, which is implemented by public license practices. Many
people have made generous contributions to the wide range of software
distributed through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing to
distribute software through any other system and a licensee cannot impose
that choice.
This section is intended to make thoroughly clear what is believed to be a
consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in certain
countries either by patents or by copyrighted interfaces, the original copyright
holder who places the Program under this License may add an explicit
geographical distribution limitation excluding those countries, so that
distribution is permitted only in or among countries not thus excluded. In such
case, this License incorporates the limitation as if written in the body of this
License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will be
similar in spirit to the present version, but may differ in detail to address new
problems or concerns.
Each version is given a distinguishing version number. If the Program specifies
a version number of this License which applies to it and "any later version",
you have the option of following the terms and conditions either of that
version or of any later version published by the Free Software Foundation. If
the Program does not specify a version number of this License, you may
choose any version ever published by the Free Software Foundation.
10. If you wish to incorporate parts of the Program into other free programs
whose distribution conditions are different, write to the author to ask for
permission. For software which is copyrighted by the Free Software
Foundation, write to the Free Software Foundation; we sometimes make
exceptions for this. Our decision will be guided by the two goals of
preserving the free status of all derivatives of our free software and of
promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE,
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT
PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR
AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR
ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OR INABILITY TO USE THE
PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA
OR DATA BEING RENDERED INACCURATE OR LOSSES
SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN
IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
$Id$
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
......@@ -2,4 +2,3 @@
name = Scanner
description = Do Search and Replace on the content of nodes.
<?php
// $Id$
/**
* @file
* Search and Replace Scanner install - creates necessary tables.
*/
/**
* Implementation of hook_install().
*/
function scanner_install() {
$ret = array();
switch ($GLOBALS['db_type']) {
case 'mysqli':
case 'mysql':
$ret[] = db_query("
CREATE TABLE {scanner} (
undo_id int(11) NOT NULL,
undo_data longtext NOT NULL,
undone tinyint(4) NOT NULL,
searched varchar(256) NOT NULL,
replaced varchar(256) NOT NULL,
count int(11) NOT NULL,
time int(11) NOT NULL,
PRIMARY KEY (undo_id)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;");
break;
}
if (!in_array(false, $ret)) {
drupal_set_message(t('Scanner module installed successfully.'));
}
else {
drupal_set_message(t('The installation of the scanner module was unsuccessful due to a database error. You may have to install the tables by hand.'), 'error');
}
}
/**
* Implementation of hook_uninstall().
*/
function scanner_uninstall() {
db_query('DROP TABLE {scanner}');
db_query("DELETE FROM {variable} WHERE name LIKE 'scanner_%'");
}
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment