From 11c9fa051a049f9ea49af1ccb48018a0aa2b970e Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Fri, 16 Mar 2012 12:16:59 -0500 Subject: [PATCH] Ported to Drupal 7. --- .cvsignore | 1 - LICENSE.txt | 274 ---------------------------------- README.txt | 32 ++--- qa_checklist.admin.inc | 142 ++++++++++++++++++ qa_checklist.css | 12 ++ qa_checklist.info | 4 + qa_checklist.install | 385 ++++++++++++++++++++++++++++++++++++++++++++++++ qa_checklist.module | 56 +++++++ qachecklist.admin.inc | 134 ----------------- qachecklist.css | 12 -- qachecklist.info | 4 - qachecklist.install | 195 ------------------------ qachecklist.module | 46 ------ 13 files changed, 609 insertions(+), 688 deletions(-) delete mode 100644 .cvsignore delete mode 100644 LICENSE.txt create mode 100644 qa_checklist.admin.inc create mode 100644 qa_checklist.css create mode 100644 qa_checklist.info create mode 100644 qa_checklist.install create mode 100644 qa_checklist.module delete mode 100644 qachecklist.admin.inc delete mode 100644 qachecklist.css delete mode 100644 qachecklist.info delete mode 100644 qachecklist.install delete mode 100644 qachecklist.module diff --git a/.cvsignore b/.cvsignore deleted file mode 100644 index 3a4edf6..0000000 --- a/.cvsignore +++ /dev/null @@ -1 +0,0 @@ -.project diff --git a/LICENSE.txt b/LICENSE.txt deleted file mode 100644 index 2c095c8..0000000 --- a/LICENSE.txt +++ /dev/null @@ -1,274 +0,0 @@ -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 diff --git a/README.txt b/README.txt index fbb5965..fc23a30 100644 --- a/README.txt +++ b/README.txt @@ -3,42 +3,30 @@ CONTENTS OF THIS FILE --------------------- * Description and Benefits - * Upgrading from 1.x * Installation and Usage - * More Information DESCRIPTION AND BENEFITS ------------------------ The QA Checklist module provides a list of good QA actions that you should -take to maximize the presence of your website in the major search engines. It -provides little functionality itself but rather it helps you keep track of what -needs to be done and what has been completed already. - -Search Engines Drive 90% of the traffic on the web. The more "findable" you are, -the easier it is for you to get customers. This module helps you with on-page -QA - a necessary component of a good online marketing campaign. +take to ensure optimal performance of your web site. It provides little +functionality itself but rather helps you keep track of what needs to be done +and what has been completed already. INSTALLATION AND USAGE ---------------------- -See http://drupal.org/getting-started/5/install-contrib for instructions on -how to install or update Drupal modules. +See http://drupal.org/documentation/install/modules-themes/modules-7 for +instructions on how to install or update Drupal modules. Summary: -1. Download and extract the module package into your sites/all/modules directory. -2. Go to admin/build/modules and enable the "QA Checklist" module which should - be in the 'Other' category. -3. To start using the QA Checklist, go to admin/settings/qachecklist. The +1. Download and extract the module package into your sites/all/modules + directory. +2. Go to admin/modules and enable the "QA Checklist" module which should be in + the 'Other' category. +3. To start using the QA Checklist, go to admin/config/system/qa-checklist. The module should automatically check if you have already installed any of the modules required for a task. 4. Start checking off some tasks! - -Optional: -- Install the Vertical Tabs module (http://drupal.org/project/vertical_tabs) to - help improve your QA Checklist interface. It helps collapse the interface - into vertical tabs instead of one huge long list of fieldsets. This module - also works on the add or edit content forms, which is helpful for your site's - content creators and editors! \ No newline at end of file diff --git a/qa_checklist.admin.inc b/qa_checklist.admin.inc new file mode 100644 index 0000000..c77e0ba --- /dev/null +++ b/qa_checklist.admin.inc @@ -0,0 +1,142 @@ + 'submit', + '#value' => t('Save'), + ); + + // Fetch modules and groups from database. + $query = "SELECT id, name, description FROM {qa_checklist_group} ORDER BY id"; + + $result = db_query($query); + $group_id = 0; + + // Vertical tab element. + $form['qa_checklist'] = array( + '#type' => 'vertical_tabs', + ); + + // Every group is a fieldset. + foreach ($result as $data) { + $group_id = intval($data->id); + + $form['group_' . $group_id] = array( + '#type' => 'fieldset', + '#title' => t($data->name), + '#collapsible' => TRUE, + '#description' => t($data->description), + '#group' => 'qa_checklist', + ); + + $res = db_query("SELECT download, enable, configure, module, completed, id, name, uid FROM {qa_checklist_task} WHERE group_id = :group_id ORDER BY order_id", array(':group_id' => $group_id)); + foreach ($res as $row) { + $row->links = array(); + + if ($row->completed) { + // Show when and who completed this task. + $row->links[] = t('Completed on %date by !username', array( + '%date' => format_date($row->completed, 'small'), + '!username' => theme('username', array('account' => user_load($row->uid))), + )); + } + else { + // Show non-completed sub-tasks. + if ($row->download) { + $row->links[] = l(t('Download'), $row->download, array('attributes' => array('target' => '_blank'))); + } + if ($row->enable) { + $row->links[] = l(t('Enable'), $row->enable); + } + } + + if ($row->configure && (!$row->module || module_exists($row->module))) { + // Show the link to configure if this isn't a module or module is + // enabled. + $row->links[] = l(t('Configure'), $row->configure); + } + + $task = $form['group_' . $group_id]['qa_checklist_task_' . $row->id] = array( + '#type' => 'checkbox', + '#title' => t($row->name), + '#default_value' => $row->completed || ($row->module && module_exists($row->module)), + '#description' => join(' | ', $row->links), + ); + if (strpos($row->name, 'Clean URLs') === 0) { + $task['#disabled'] = !variable_get('clean_url', 0); + $task['#default_value'] |= variable_get('clean_url', 0); + } + } + } + + $form['extras'] = array( + '#type' => 'fieldset', + '#title' => t('Extras'), + '#collapsible' => TRUE, + '#group' => 'qa_checklist', + ); + $form['extras']['qa_checklist_link'] = array( + '#type' => 'checkbox', + '#title' => t('Link to InteractiveQA to thank them for this module.'), + '#default_value' => variable_get('qa_checklist_link', 0), + '#description' => t('A small link will appear at the very bottom of your website. You can disable it at any time by un-checking this box. We really appreciate it!'), + ); + $form['extras']['qa_checklist_thanks'] = array( + '#type' => 'checkbox', + '#title' => t('Thank you for using the QA Checklist. If you need professional QA for your site, contact us at @iqa.', array('@iqa' => 'interactiveqa.com')), + '#default_value' => variable_get('qa_checklist_thanks', 0), + '#description' => t(''), + ); + + $form['save'] = array( + '#type' => 'submit', + '#value' => t('Save'), + '#weight' => 100, + ); + + $form['save_above']['#attributes']['class'][] = 'js-hide'; + + return $form; +} + +/** + * Submit callback for qa_checklist_admin_settings(). + */ +function qa_checklist_admin_settings_submit($form, &$form_state) { + global $user; + + $count = 0; + foreach ($form_state['values'] as $key => $value) { + if (preg_match('/qa_checklist_task_(\d*)/', $key, $id)) { + $id = $id['1']; + $current = (bool) db_query("SELECT completed FROM {qa_checklist_task} WHERE id = :id", array( + ':id' => $id, + ))->fetchField(); + if ($current != $value) { + // If the checkbox changed states, update the record. + db_query("UPDATE {qa_checklist_task} SET completed = :completed, uid = :uid WHERE id = :id", array( + ':completed' => ($value ? time() : 0), + ':uid' => $user->uid, + ':id' => $id, + )); + $count++; + } + } + } + + // Special values not in database. + variable_set('qa_checklist_link', $form_state['values']['qa_checklist_link']); + variable_set('qa_checklist_thanks', $form_state['values']['qa_checklist_thanks']); + + drupal_set_message(format_plural($count, 'Updated @count task successfully.', 'Updated @count tasks successfully.')); +} diff --git a/qa_checklist.css b/qa_checklist.css new file mode 100644 index 0000000..e8ece27 --- /dev/null +++ b/qa_checklist.css @@ -0,0 +1,12 @@ + +div.qa_checklist_item { + clear: both; +} + +div.qa_checklist_item div, +div.qa_checklist_item label, +div.qa_checklist_item p { + display: inline; + margin-bottom: 0; + margin-top: 0; +} diff --git a/qa_checklist.info b/qa_checklist.info new file mode 100644 index 0000000..44a6c16 --- /dev/null +++ b/qa_checklist.info @@ -0,0 +1,4 @@ +name = QA Checklist +description = A Quality Assurance checklist for Drupal +core = 7.x +configure = admin/config/system/qa-checklist diff --git a/qa_checklist.install b/qa_checklist.install new file mode 100644 index 0000000..4344f1a --- /dev/null +++ b/qa_checklist.install @@ -0,0 +1,385 @@ + 'qa_checklist_group', + 'fields' => array( + 'id' => array( + 'type' => 'serial', + 'size' => 'tiny', + 'not null' => TRUE, + 'description' => 'id', + 'disp-width' => '4', + ), + 'name' => array( + 'type' => 'varchar', + 'length' => '255', + 'not null' => TRUE, + 'description' => 'name', + 'default' => '', + ), + 'description' => array( + 'type' => 'varchar', + 'length' => '255', + 'not null' => TRUE, + 'description' => 'description', + 'default' => '', + ), + ), + 'primary key' => array('id'), + ); + $schema['qa_checklist_task'] = array( + 'description' => 'qa_checklist_task', + 'fields' => array( + 'id' => array( + 'type' => 'serial', + 'size' => 'tiny', + 'not null' => TRUE, + 'description' => 'id', + ), + 'group_id' => array( + 'type' => 'int', + 'size' => 'tiny', + 'not null' => TRUE, + 'default' => 0, + 'description' => 'group_id', + ), + 'name' => array( + 'type' => 'varchar', + 'length' => '255', + 'not null' => TRUE, + 'description' => 'name', + 'default' => '', + ), + 'module' => array( + 'type' => 'varchar', + 'length' => '255', + 'not null' => TRUE, + 'description' => 'module', + 'default' => '', + ), + 'download' => array( + 'type' => 'varchar', + 'length' => '255', + 'not null' => TRUE, + 'description' => 'download', + 'default' => '', + ), + 'enable' => array( + 'type' => 'varchar', + 'length' => '255', + 'not null' => TRUE, + 'description' => 'enable', + 'default' => '', + ), + 'configure' => array( + 'type' => 'varchar', + 'length' => '255', + 'not null' => TRUE, + 'description' => 'configure', + 'default' => '', + ), + 'order_id' => array( + 'type' => 'int', + 'size' => 'tiny', + 'not null' => TRUE, + 'description' => 'order id', + 'default' => 0, + ), + 'completed' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => 'UNIX timestamp of when this task was completed, or 0 if the task has not yet been completed.', + ), + 'uid' => array( + 'type' => 'int', + 'unsigned' => TRUE, + 'not null' => TRUE, + 'default' => 0, + 'description' => 'The {user}.uid of the account that completed this task.', + ), + ), + 'primary key' => array('id'), + ); + return $schema; +} + +/** + * Implements hook_install(). + */ +function qa_checklist_install() { + $checklist = array(); + + $checklist[] = array( + 'name' => 'Other Checklists', + 'description' => 'Ensure that other Drupal checklists are installed and completed', + 'tasks' => array( + array( + 'name' => 'Security Review', + 'module' => 'security_review', + 'download' => 'http://drupal.org/project/security_review', + 'enable' => 'admin/modules', + 'configure' => 'admin/reports/security-review', + 'order_id' => 1, + ), + array( + 'name' => 'SEO Checklist', + 'module' => 'seo_checklist', + 'download' => 'http://drupal.org/project/seo_checklist', + 'enable' => 'admin/modules', + 'configure' => 'admin/config/search/seochecklist', + 'order_id' => 2, + ), + ), + ); + + $checklist[] = array( + 'name' => 'Other Modules', + 'description' => 'Other important Drupal modules', + 'tasks' => array( + array( + 'name' => 'Backup and Migrate', + 'module' => 'backup_migrate', + 'download' => 'http://drupal.org/project/backup_migrate', + 'enable' => 'admin/modules', + 'configure' => 'admin/config/system/backup_migrate', + 'order_id' => 1, + ), + array( + 'name' => 'Backup and Migrate Files', + 'module' => 'backup_migrate_files', + 'download' => 'http://drupal.org/project/backup_migrate_files', + 'enable' => 'admin/modules', + 'order_id' => 2, + ), + array( + 'name' => 'DB Maintenance', + 'module' => 'db_maintenance', + 'download' => 'http://drupal.org/project/db_maintenance', + 'enable' => 'admin/modules', + 'configure' => 'admin/config/system/db_maintenance', + 'order_id' => 3, + ), + ), + ); + + $checklist[] = array( + 'name' => 'Server Optimization', + 'description' => 'Make sure your server is running Drupal as best it can.', + 'tasks' => array( + array( + 'name' => 'Review web server configuration - for Apache, check max clients settings and enabled modules.', + 'order_id' => 1, + ), + array( + 'name' => 'Review database configuration - for MySQL, adjust cache size and other settings as necessary.', + 'order_id' => 2, + ), + array( + 'name' => 'Review PHP configuration - adjust max memory and max execution as necessary.', + 'order_id' => 3, + ), + array( + 'name' => 'Install and configure PHP opcode cache.', + 'order_id' => 4, + ), + array( + 'name' => 'OPTIONAL: install and configure reverse proxy cache.', + 'order_id' => 5, + ), + ), + ); + + $checklist[] = array( + 'name' => 'Drupal Optimization', + 'description' => 'Install modules and configure Drupal to run at top speed.', + 'tasks' => array( + array( + 'name' => 'Enable caching.', + 'configure' => 'admin/config/development/performance', + 'order_id' => 1, + ), + // JavaScript Aggregator are not yet available for Drupal 7. + /* + array( + 'name' => 'Javascript Aggregator', + 'module' => 'javascript_aggregator', + 'download' => 'http://drupal.org/project/javascript_aggregator', + 'enable' => 'admin/modules', + 'configure' => '', + 'order_id' => 4, + ), + */ + ), + ); + + $checklist[] = array( + 'name' => 'User Settings', + 'description' => 'Review user settings.', + 'tasks' => array( + array( + 'name' => 'Set administrator role.', + 'configure' => 'admin/config/people/accounts', + 'order_id' => 1, + ), + array( + 'name' => 'Confirm user registration settings.', + 'configure' => 'admin/config/people/accounts', + 'order_id' => 2, + ), + array( + 'name' => 'Confirm email settings.', + 'configure' => 'admin/config/people/accounts', + 'order_id' => 3, + ), + ), + ); + + $checklist[] = array( + 'name' => 'User Permissions', + 'description' => 'Review user permissions.', + 'tasks' => array( + array( + 'name' => 'Filter Permissions', + 'module' => 'filter_perms', + 'download' => 'http://drupal.org/project/filter_perms', + 'enable' => 'admin/modules', + 'order_id' => 1, + ), + // Better Permissions is not yet available for Drupal 7. + /* + array( + 'name' => 'Better Permissions', + 'module' => 'better_perms', + 'download' => 'http://drupal.org/project/better_perms', + 'enable' => 'admin/modules', + 'order_id' => 2, + ), + */ + array( + 'name' => 'Read Managing Drupal Permissions.', + 'order_id' => 3, + ), + array( + 'name' => 'Review and revise user permissions.', + 'configure' => 'admin/people/permissions', + 'order_id' => 4, + ), + ), + ); + + $checklist[] = array( + 'name' => 'In Case You Forgot', + 'description' => 'Some tasks to remember', + 'tasks' => array( + array( + 'name' => 'Review and revise user permissions.', + 'configure' => 'admin/people/permissions', + 'order_id' => 1, + ), + array( + 'name' => 'Check Drupal status log for issues. (Make sure dblog module is enabled.)', + 'enable' => 'admin/modules', + 'configure' => 'admin/reports/dblog', + 'order_id' => 2, + ), + array( + 'name' => 'Check update page for Drupal updates. (Make sure update module is enabled.)', + 'enable' => 'admin/modules', + 'configure' => 'admin/reports/updates', + 'order_id' => 3, + ), + array( + 'name' => 'Check update page for contributed module updates. (Make sure update module is enabled.)', + 'enable' => 'admin/modules', + 'configure' => 'admin/reports/updates', + 'order_id' => 4, + ), + ), + ); + + $checklist[] = array( + 'name' => 'Getting Ready', + 'description' => 'A few things to do before deployment', + 'tasks' => array( + array( + 'name' => 'Disable devel modules.', + 'order_id' => 1, + ), + array( + 'name' => 'Set a maintenance theme - add $conf[\'maintenance_theme\'] = \'mytheme\'; to settings.php.', + 'order_id' => 1, + ), + array( + 'name' => 'Clean CSS files with CSS tidy. (recommended for future development)', + 'order_id' => 1, + ), + array( + 'name' => 'Disable theme registry rebuild.', + 'order_id' => 1, + ), + array( + 'name' => 'Turn off PHP error display.', + 'order_id' => 1, + ), + array( + 'name' => 'Change all necessary Drupal/MySQL/SSH passwords.', + 'order_id' => 1, + ), + array( + 'name' => 'Remove temporary users and content.', + 'configure' => '', + 'order_id' => 1, + ), + array( + 'name' => 'Setup site emails.', + 'configure' => '', + 'order_id' => 1, + ), + ), + ); + + $checklist[] = array( + 'name' => 'Deployment', + 'description' => 'Tasks to be done when launching the site', + 'tasks' => array( + array( + 'name' => 'Setup HTTP redirect in settings.php.', + 'order_id' => 1, + ), + array( + 'name' => 'Setup cron job.', + 'order_id' => 1, + ), + ), + ); + + $group_id = 1; + foreach ($checklist as $group) { + drupal_write_record('qa_checklist_group', $group); + foreach ($group['tasks'] as $task) { + $task['group_id'] = $group_id; + drupal_write_record('qa_checklist_task', $task); + } + $group_id++; + } +} + +/** + * Implements hook_uninstall(). + */ +function qa_checklist_uninstall() { + drupal_uninstall_schema('qa_checklist'); + variable_del('qa_checklist_link'); + variable_del('qa_checklist_thanks'); +} diff --git a/qa_checklist.module b/qa_checklist.module new file mode 100644 index 0000000..4cdc70a --- /dev/null +++ b/qa_checklist.module @@ -0,0 +1,56 @@ +' . t("Check off each QA-related task as you complete it. Don't forget to click the Save button!") . '

'; + } +} + +/** + * Implements hook_permission(). + */ +function qa_checklist_permission() { + // Only link to the QA Checklist if the user who is viewing this will have + // access to that page. + $qa_checklist_link = user_access('access qa checklist') ? l(t('QA Checklist'), 'admin/config/system/qa-checklist') : t('QA Checklist'); + return array( + 'access qa checklist' => array( + 'title' => t("Access !qa_checklist_link", array( + '!qa_checklist_link' => $qa_checklist_link, + )), + 'description' => t('Access the QA Checklist and check off tasks'), + ), + ); +} + +/** + * Implements hook_menu(). + */ +function qa_checklist_menu() { + $items['admin/config/system/qa-checklist'] = array( + 'title' => 'QA Checklist', + 'description' => 'Keep track of your Drupal QA tasks.', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('qa_checklist_admin_settings'), + 'access arguments' => array('access qa checklist'), + 'file' => 'qa_checklist.admin.inc', + ); + return $items; +} + +/** + * Implements hook_footer(). + */ +function qa_checklist_footer($main = 0) { + if (variable_get('qa_checklist_link', 0)) { + return '
Drupal QA
'; + } +} diff --git a/qachecklist.admin.inc b/qachecklist.admin.inc deleted file mode 100644 index c38255d..0000000 --- a/qachecklist.admin.inc +++ /dev/null @@ -1,134 +0,0 @@ - 'submit', - '#value' => t('Save'), - ); - - // Fetch modules and groups from database. - $query = "SELECT id, name, description FROM {qa_group} ORDER BY id"; - - $result = db_query($query); - $group_id = 0; - - // Every group is a fieldset. - while ($data = db_fetch_object($result)) { - $group_id = intval($data->id); - - $form['group_' . $group_id] = array( - '#type' => 'fieldset', - '#title' => t($data->name), - '#collapsible' => TRUE, - '#description' => t($data->description), - '#group' => 'qachecklist', - ); - - $res = db_query("SELECT download, enable, configure, module, completed, id, name, uid FROM {qa_checklist} WHERE group_id = %d ORDER BY order_id", $group_id); - while ($row = db_fetch_object($res)) { - $row->links = array(); - - if ($row->completed) { - // Show when and who completed this task. - $row->links[] = t('Completed on %date by !username', array('%date' => format_date($row->completed, 'small'), '!username' => theme('username', user_load($row->uid)))); - } - else { - // Show non-completed sub-tasks. - if ($row->download) { - $row->links[] = l(t('Download'), $row->download, array('attributes' => array('target' => '_blank'))); - } - if ($row->enable) { - $row->links[] = l(t('Enable'), $row->enable); - } - } - - if ($row->configure && (!$row->module || module_exists($row->module))) { - // Show the link to configure if this isn't a module or module is enabled. - $row->links[] = l(t('Configure'), $row->configure); - } - - $task = $form['group_' . $group_id]['qachecklist_task_' . $row->id] = array( - '#type' => 'checkbox', - '#title' => t($row->name), - '#default_value' => $row->completed || ($row->module && module_exists($row->module)), - '#description' => join(' | ', $row->links), - ); - if (strpos($row->name, 'Clean URLs') === 0) { - $task['#disabled'] = !variable_get('clean_url', 0); - $task['#default_value'] |= variable_get('clean_url', 0); - } - } - } - - $form['extras'] = array( - '#type' => 'fieldset', - '#title' => t('Extras'), - '#collapsible' => TRUE, - '#group' => 'qachecklist', - ); - $form['extras']['qa_checklist_link'] = array( - '#type' => 'checkbox', - '#title' => t('Link to InteractiveQA to thank them for this module.'), - '#default_value' => variable_get('qa_checklist_link', 0), - '#description' => t('A small link will appear at the very bottom of your website. You can disable it at any time by un-checking this box. We really appreciate it!'), - ); - $form['extras']['qa_checklist_thanks'] = array( - '#type' => 'checkbox', - '#title' => t('Thank you for using the QA Checklist. If you need professional QA for your site, contact us at @iqa.', array('@iqa' => 'interactiveqa.com')), - '#default_value' => variable_get('qa_checklist_thanks', 0), - '#description' => t(''), - ); - - $form['save'] = array( - '#type' => 'submit', - '#value' => t('Save'), - '#weight' => 100, - ); - - if (module_exists('vertical_tabs')) { - $form['#pre_render'][] = 'vertical_tabs_form_pre_render'; - $form['save_above']['#attributes']['class'] = 'js-hide'; - } - else { - drupal_set_message(t('Your QA Checklist interface (in addition to your content and content type edit pages) will be greatly enhanced by installing the Vertical Tabs module.', array('@vertical-tabs' => 'http://drupal.org/project/vertical_tabs')), 'status', FALSE); - } - - return $form; -} - -/** - * Submit callback for qachecklist_admin_settings(). - */ -function qachecklist_admin_settings_submit($form, &$form_state) { - global $user; - - $count = 0; - foreach ($form_state['values'] as $key => $value) { - if (preg_match('/qachecklist_task_/', $key)) { - $key = explode('_', $key); - $key = $key[2]; - $current = (bool) db_result(db_query("SELECT completed FROM {qa_checklist} WHERE id = %d", $key)); - if ($current != $value) { - // If the checkbox changed states, update the record. - db_query("UPDATE {qa_checklist} SET completed = %d, uid = %d WHERE id = %d", ($value ? time() : 0), $user->uid, $key); - $count++; - } - } - } - - // Special values not in database. - variable_set('qa_checklist_link', $form_state['values']['qa_checklist_link']); - variable_set('qa_checklist_thanks', $form_state['values']['qa_checklist_thanks']); - - drupal_set_message(format_plural($count, 'Updated @count task successfully.', 'Updated @count tasks successfully.')); -} diff --git a/qachecklist.css b/qachecklist.css deleted file mode 100644 index 2dd68f0..0000000 --- a/qachecklist.css +++ /dev/null @@ -1,12 +0,0 @@ - -div.qachecklist_item { - clear:both; -} - -div.qachecklist_item div, -div.qachecklist_item label, -div.qachecklist_item p { - display:inline; - margin-bottom:0; - margin-top:0; -} \ No newline at end of file diff --git a/qachecklist.info b/qachecklist.info deleted file mode 100644 index 65d23d0..0000000 --- a/qachecklist.info +++ /dev/null @@ -1,4 +0,0 @@ -name = QA Checklist -description = A Quality Assurance checklist for Drupal. -core = 6.x -recommends[] = vertical_tabs \ No newline at end of file diff --git a/qachecklist.install b/qachecklist.install deleted file mode 100644 index b9e19d9..0000000 --- a/qachecklist.install +++ /dev/null @@ -1,195 +0,0 @@ - 'qa_group', - 'fields' => array( - 'id' => array( - 'type' => 'serial', - 'size' => 'tiny', - 'not null' => TRUE, - 'description' => 'id', - 'disp-width' => '4' - ), - 'name' => array( - 'type' => 'varchar', - 'length' => '255', - 'not null' => TRUE, - 'description' => 'name', - 'default' => '' - ), - 'description' => array( - 'type' => 'varchar', - 'length' => '255', - 'not null' => TRUE, - 'description' => 'description', - 'default' => '' - ), - ), - 'primary key' => array('id'), - ); - $schema['qa_checklist'] = array( - 'description' => 'qa_checklist', - 'fields' => array( - 'id' => array( - 'type' => 'serial', - 'size' => 'tiny', - 'not null' => TRUE, - 'description' => 'id', - ), - 'group_id' => array( - 'type' => 'int', - 'size' => 'tiny', - 'not null' => TRUE, - 'default' => 0, - 'description' => 'group_id', - ), - 'name' => array( - 'type' => 'varchar', - 'length' => '255', - 'not null' => TRUE, - 'description' => 'name', - 'default' => '', - ), - 'module' => array( - 'type' => 'varchar', - 'length' => '255', - 'not null' => TRUE, - 'description' => 'module', - 'default' => '', - ), - 'download' => array( - 'type' => 'varchar', - 'length' => '255', - 'not null' => TRUE, - 'description' => 'download', - 'default' => '', - ), - 'enable' => array( - 'type' => 'varchar', - 'length' => '255', - 'not null' => TRUE, - 'description' => 'enable', - 'default' => '', - ), - 'configure' => array( - 'type' => 'varchar', - 'length' => '255', - 'not null' => TRUE, - 'description' => 'configure', - 'default' => '', - ), - 'order_id' => array( - 'type' => 'int', - 'size' => 'tiny', - 'not null' => TRUE, - 'description' => 'order id', - 'default' => 0, - ), - 'completed' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'default' => 0, - 'description' => 'UNIX timestamp of when this task was completed, or 0 if the task has not yet been completed.', - ), - 'uid' => array( - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - 'default' => 0, - 'description' => 'The {user}.uid of the account that completed this task.', - ), - ), - 'primary key' => array('id'), - ); - return $schema; -} - -/** - * Implementation of hook_install(). - */ -function qachecklist_install() { - drupal_install_schema('qachecklist'); - - $task_fields = "(id, group_id, name, module, download, enable, configure, order_id)"; - - // Other Checklists - db_query("INSERT INTO {qa_group} VALUES (1, 'Other Checklists', 'Ensure that other Drupal checklists are installed and completed.')"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (1, 1, 'Security Review', 'security_review', 'http://drupal.org/project/security_review', 'admin/build/modules', '', 1)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (2, 1, 'SEO Checklist', 'seo_checklist', 'http://drupal.org/project/seo_checklist', 'admin/build/modules', '', 2)"); - - // Other Modules - db_query("INSERT INTO {qa_group} VALUES (2, 'Other Modules', 'Other important Drupal modules.')"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (3, 2, 'Backup and Migrate', 'backup_migrate', 'http://drupal.org/project/backup_migrate', 'admin/build/modules', '', 1)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (4, 2, 'Backup and Migrate Files', 'backup_migrate_files', 'http://drupal.org/project/backup_migrate_files', 'admin/build/modules', '', 2)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (5, 2, 'DB Maintenance', 'db_maintenance', 'http://drupal.org/project/db_maintenance', 'admin/build/modules', '', 3)"); - - // Server Optimization - db_query("INSERT INTO {qa_group} VALUES (3, 'Server Optimization', 'Make sure your server is running Drupal as best it can.')"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (6, 3, 'Review web server configuration - for Apache, check max clients settings and enabled modules', '', '', '', '', 1)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (7, 3, 'Review database configuration - for MySQL, adjust cache size and other settings as necessary', '', '', '', '', 2)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (8, 3, 'Review PHP configuration - adjust max memory and max execution as necessary', '', '', '', '', 3)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (9, 3, 'Install and configure PHP opcode cache', '', '', '', '', 4)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (10, 3, 'OPTIONAL: install and configure reverse proxy cache', '', '', '', '', 5)"); - - // Drupal Optimization - db_query("INSERT INTO {qa_group} VALUES (4, 'Drupal Optimization', 'Install modules and configure Drupal to run at top speed.')"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (11, 4, 'Enable caching', '', '', '', '', 1)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (12, 4, 'Enable page compression', '', '', '', '', 2)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (13, 4, 'CSS Gzip', 'css_gzip', 'http://drupal.org/project/css_gzip', 'admin/build/modules', '', 3)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (14, 4, 'Javascript Aggregator', 'javascript_aggregator', 'http://drupal.org/project/javascript_aggregator', 'admin/build/modules', '', 4)"); - - // User Settings - db_query("INSERT INTO {qa_group} VALUES (5, 'User Settings', 'Review user settings.')"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (15, 5, 'Confirm user registration settings.', '', '', '', '', 1)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (16, 5, 'Confirm email settings.', '', '', '', '', 2)"); - - // User Permissions - db_query("INSERT INTO {qa_group} VALUES (6, 'User Permissions', 'Review user permissions.')"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (17, 6, 'Filter Permissions', 'filter_perms', 'http://drupal.org/project/filter_perms', 'admin/build/modules', '', 1)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (18, 6, 'Better Permissions', 'better_perms', 'http://drupal.org/project/better_perms', 'admin/build/modules', '', 2)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (19, 6, 'Admin Role module', 'adminrole', 'http://drupal.org/project/adminrole', 'admin/build/modules', '', 3)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (20, 6, 'Read: Managing Drupal Permissions', '', 'http://drupal.org/node/22275', '', '', 4)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (21, 6, 'Review and revise user permissions.', '', '', '', '', 5)"); - - // In Case You Forgot - db_query("INSERT INTO {qa_group} VALUES (7, 'In Case You Forgot', 'Some tasks to remember.')"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (22, 7, 'Review and revise user permissions.', '', '', '', '', 1)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (23, 7, 'Check Drupal status log for issues.', '', '', '', '', 2)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (24, 7, 'Check update page for Drupal updates.', '', '', '', '', 3)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (25, 7, 'Check update page for contributed module updates.', '', '', '', '', 4)"); - - // Getting Ready - db_query("INSERT INTO {qa_group} VALUES (8, 'Getting Ready', 'A few things to do before deployment.')"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (26, 8, 'Disable devel modules.', '', '', '', '', 1)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (27, 8, 'Set a maintenance theme - add \$conf[\'maintenance_theme\'] = \'mytheme\'; to settings.php.', '', '', '', '', 2)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (28, 8, 'Clean CSS files with CSS tidy. (recommended for future development)', '', '', '', '', 3)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (29, 8, 'Disable theme registry rebuild.', '', '', '', '', 4)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (30, 8, 'Turn off PHP error display.', '', '', '', '', 5)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (31, 8, 'Change all necessary Drupal/MySQL/SSH passwords.', '', '', '', '', 6)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (32, 8, 'Remove temporary users and content.', '', '', '', '', 7)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (33, 8, 'Setup site emails.', '', '', '', '', 8)"); - - // Deployment - db_query("INSERT INTO {qa_group} VALUES (9, 'Deployment', 'Tasks to be done when launching the site.')"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (34, 9, 'Setup HTTP redirect in settings.php.', '', '', '', '', 1)"); - db_query("INSERT INTO {qa_checklist} $task_fields VALUES (35, 9, 'Setup cron job.', '', '', '', '', 2)"); -} - -/** - * Implementation of hook_uninstall(). - */ -function qachecklist_uninstall() { - drupal_uninstall_schema('qachecklist'); - variable_del('qa_checklist_link'); - variable_del('qa_checklist_thanks'); -} \ No newline at end of file diff --git a/qachecklist.module b/qachecklist.module deleted file mode 100644 index 3529072..0000000 --- a/qachecklist.module +++ /dev/null @@ -1,46 +0,0 @@ -' . t('Check off each QA-related task as you complete it. Do not forget to click the Save button!') . '

'; - } -} - -/** - * Implementation of hook_perm(). - */ -function qachecklist_perm() { - return array('access qachecklist content'); -} - -/** - * Implementation of hook_menu(). - */ -function qachecklist_menu() { - $items['admin/settings/qachecklist'] = array( - 'title' => 'QA Checklist', - 'description' => 'Keep track of your Drupal QA tasks.', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('qachecklist_admin_settings'), - 'access arguments' => array('access qachecklist content'), - 'file' => 'qachecklist.admin.inc', - ); - return $items; -} - -/** - * Implementation of hook_footer(). - */ -function qachecklist_footer($main = 0) { - if (variable_get('qa_checklist_link', 0)) { - return '
Drupal QA
'; - } -} \ No newline at end of file -- 1.7.4.1