Browse Source

added text_formats_report contrib module

Bachir Soussi Chiadmi 4 years ago
parent
commit
50d08c7efd

+ 339 - 0
sites/all/modules/contrib/admin/text_formats_report/LICENSE.txt

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 Lesser 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
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

+ 36 - 0
sites/all/modules/contrib/admin/text_formats_report/inc/text_formats_report.field_page.inc

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * @file
+ */
+
+module_load_include('inc', 'text_formats_report', 'inc/text_formats_report');
+
+/**
+ * Menu callback.
+ */
+function text_formats_report_field_page($field_name) {
+  if (!isset($_GET['formats']) || empty($_GET['formats'])) {
+    return drupal_not_found();
+  }
+
+  $field_name = check_plain($field_name);
+  $filter_formats = $_GET['formats'];
+
+  // In case only one format passed via url.
+  if (is_string($filter_formats)) {
+    $filter_formats = array($filter_formats);
+  }
+  foreach ($filter_formats as $key => $format) {
+    $filter_formats[$key] = check_plain($format);
+  }
+
+  $records = text_formats_report_get_field_usage($field_name, $filter_formats);
+
+  return theme('text_formats_report_field_stats', array(
+      'stats' => $records,
+      'filter_formats' => $filter_formats,
+      'field_name' => $field_name
+    )
+  );
+}

+ 265 - 0
sites/all/modules/contrib/admin/text_formats_report/inc/text_formats_report.inc

@@ -0,0 +1,265 @@
+<?php
+
+/**
+ * @file Helper functions for text_formats_report module.
+ */
+
+/**
+ * Helper function to fetch the filter_format filter list for an array of
+ * filter formats.
+ *
+ * @param array $filter_formats
+ *         Set of filter_formats ids.
+ *
+ * @return array
+ *         Rows of filter_list_format() results for each filter_format provided.
+ */
+function text_formats_report_filter_format_filter_list($filter_formats = array()) {
+  $filter_formats_info = array();
+  foreach ($filter_formats as $filter_format) {
+    $filter_formats_info[$filter_format] = filter_list_format($filter_format);
+  }
+  return $filter_formats_info;
+}
+
+/**
+ * Gathers the stats fby filter format.
+ *
+ * @param $filter_formats all if none passed in.
+ * @param $field_names all if none passed in.
+ *
+ * @return array
+ *          (
+ *            'filter_format' => array(
+ *              'bundles',
+ *              'fields',
+ *              'fields_usage',
+ *            ),
+ *          )
+ */
+function text_formats_report_fetch_stats($filter_formats = array(), $field_names = array()) {
+  if (empty($field_names)) {
+    $candiate_fields = text_formats_report_get_field_configs();
+    foreach ($candiate_fields as $field) {
+      $field_names[] = $field['field_name'];
+    }
+  }
+
+  $stats = array();
+  foreach ($filter_formats as $filter_format) {
+    $stats[$filter_format] = array(
+      'bundles' => array(),
+      'fields' => array(),
+      'total_content' => 0,
+    );
+  }
+
+  foreach ($field_names as $field_name) {
+    $records = text_formats_report_get_field_usage($field_name, $filter_formats);
+
+    foreach ($records as $record) {
+      foreach ($filter_formats as $filter_format) {
+        if ($record->format == $filter_format) {
+          $stats[$filter_format]['total_content']++;
+          $field_label = l($field_name, 'admin/reports/text-formats/field/' . $field_name, array('query' => array('formats' => $filter_format)));
+          $stats[$filter_format]['bundles'][] = $record->bundle;
+          $stats[$filter_format]['fields'][] = $field_label;
+        }
+      }
+    }
+  }
+
+  // Calculate some stats per filter_format.
+  foreach ($stats as $filter_format => $row) {
+    $bundles = array_count_values($stats[$filter_format]['bundles']);
+    $stats[$filter_format]['bundles'] = $bundles;
+
+    $fields = array_count_values($stats[$filter_format]['fields']);
+    $stats[$filter_format]['fields'] = $fields;
+  }
+
+  return $stats;
+}
+
+/**
+ * Gathers the stats fby filter format.
+ *
+ * @param $filter_formats all if none passed in.
+ * @param $field_names all if none passed in.
+ *
+ * @return Array $stats
+ */
+function text_formats_report_fetch_stats_for_csv($filter_formats = array(), $field_names = array()) {
+  if (empty($field_names)) {
+    $candiate_fields = text_formats_report_get_field_configs();
+    foreach ($candiate_fields as $field) {
+      $field_names[] = $field['field_name'];
+    }
+  }
+
+  $stats = array();
+  $stats[] = array(t('Entity Id'), t('Entity type'), t('Bundle'), t('Field name'), t('Text format'), t('Path'), 'Content');
+
+  foreach ($field_names as $field_name) {
+    $records = text_formats_report_get_field_usage($field_name, $filter_formats);
+    foreach ($records as $record) {
+      $path = '';
+      if ($record->entity_type == 'node') {
+        $path = '/node/' . $record->entity_id;
+      }
+      $stats[] = array($record->entity_id, $record->entity_type, $record->bundle, $field_name, $record->format, $path, $record->value);
+    }
+  }
+  return $stats;
+}
+
+/**
+ * Helper function to get available input formats as form options.
+ *
+ * @return Array filter_format.format => filter_format.name
+ */
+function text_formats_report_filter_format_options() {
+  // Get list of all input formats.
+  $query = db_query('SELECT format, name FROM {filter_format}');
+  $records = $query->fetchAll();
+  foreach ($records as $record) {
+    $options[$record->format] = $record->name;
+  }
+  return $options;
+}
+
+/**
+ * Helper function to retrieve the custom blocks using specified filter formats.
+ *
+ * @param array $filter_formats
+ *   filter_format.format to check for.
+ *
+ * @return array
+ *          (
+ *            array('bid', 'info', 'format'),
+ *          )
+ */
+function text_formats_report_get_custom_blocks($filter_formats) {
+  $custom_blocks = array();
+  $query = db_select('block_custom', 'b')
+    ->condition('b.format', $filter_formats)
+    ->fields('b', array('bid', 'info', 'format'))
+    ->execute();
+  if ($query->rowCount() > 0) {
+    while ($row = $query->fetchAssoc()) {
+      $custom_blocks[] = $row;
+    }
+  }
+  return $custom_blocks;
+}
+
+/**
+ * Helper function to retrieve the fields configured to use 'text',
+ * 'text_with_summary' or'text_long' filter_formats.
+ *
+ * @return array
+ *         Rows from the field_config table including field_name, id and type.
+ */
+function text_formats_report_get_field_configs() {
+  $field_names = array();
+  $query = db_select('field_config', 'fc')
+    ->condition('fc.type', array('text', 'text_with_summary', 'text_long'))
+    ->fields('fc', array('field_name', 'id', 'type'))
+    ->execute();
+  if ($query->rowCount() > 0) {
+    while ($row = $query->fetchAssoc()) {
+      $field_names[] = $row;
+    }
+  }
+  return $field_names;
+}
+
+/**
+ * Retrieves entries from the field_data_$field_name tables using the specified
+ * filter_formats.
+ *
+ * @param string $field_name
+ * @param array $filter_formats
+ *   all if none passed in.
+ */
+function text_formats_report_get_field_usage($field_name, $filter_formats = array()) {
+  $filter_formats = empty($filter_formats) ? array_keys(text_formats_report_filter_format_options()) : $filter_formats;
+
+  $format_column = $field_name . '_format';
+  $value_column = $field_name . '_value';
+
+  $filter = "";
+  if (!empty($filter_formats)) {
+    $formats_query_string = '(';
+    foreach ($filter_formats as $format) {
+      $formats_query_string .= "'$format',";
+    }
+    $formats_query_string = rtrim($formats_query_string, ",");
+    $formats_query_string .= ')';
+    $filter = " WHERE $format_column IN $formats_query_string";
+  }
+
+  $result = db_query("SELECT entity_id,entity_type, bundle, $format_column as format, $value_column as value FROM {field_data_$field_name}" . $filter);
+  return $result->fetchAll();
+}
+
+/**
+ * Helper function that prepares array for theme_table.
+ *
+ * @param array $data
+ *         [row] => header-label => row value.
+ * @param array $header
+ *
+ * @return String output from theme_table.
+ */
+function text_formats_report_prepare_table($data, $header = array()) {
+  // Construct the table headers array if necessary.
+  if (empty($header)) {
+    foreach ($data as $row) {
+      foreach ($row as $title => $content) {
+        $header[] = $title;
+      }
+      break;
+    }
+  }
+
+  // Construct the table rows data array.
+  $row_id = 0;
+  $rows = array();
+  foreach ($data as $row) {
+    foreach ($row as $title => $content) {
+      if ($title == 'value') {
+        $content = htmlentities($content);
+      }
+      $rows[$row_id][] = $content;
+    }
+    $row_id++;
+  }
+
+  return array(
+    'header' => $header,
+    'rows' => $rows,
+  );
+}
+
+/**
+ * Helper function that prepares a label => value array for theme_table.
+ *
+ * @param array $data
+ * @param array $header
+ *
+ * @return String output from theme_table.
+ */
+function text_formats_report_prepare_simple_table($data, $header = array()) {
+  $data = (array) $data;
+  $rows = array();
+
+  foreach ($data as $label => $value) {
+    $rows[] = array('<strong>' . $label . '</strong>', $value);
+  }
+
+  return array(
+    'header' => $header,
+    'rows' => $rows,
+  );
+}

+ 133 - 0
sites/all/modules/contrib/admin/text_formats_report/inc/text_formats_report.page.inc

@@ -0,0 +1,133 @@
+<?php
+
+/**
+ * @file
+ */
+
+module_load_include('inc', 'text_formats_report', 'inc/text_formats_report');
+
+/**
+ * Menu callback.
+ *
+ * Provides input formats report form.
+ */
+function text_formats_report_page_form($form, &$form_state) {
+
+  $filter_format_options = text_formats_report_filter_format_options();
+
+  $form['formats'] = array(
+    '#type' => 'checkboxes',
+    '#title' => t("Select the text format(s) to analyze"),
+    '#options' => $filter_format_options,
+    '#required' => TRUE,
+    '#default_value' => array(),
+  );
+  $form['submit'] = array(
+    '#value' => t("View"),
+    '#type' => 'submit',
+    '#ajax' => array(
+      'callback' => 'text_formats_report_page_form_submit_ajax_handler',
+      'effect' => 'fade',
+      'wrapper' => 'js-format-stats',
+    ),
+  );
+  $form['download'] = array(
+    '#value' => t("Download CSV"),
+    '#type' => 'submit',
+  );
+
+  $form['js-format-stats'] = array(
+    '#markup' => '<div id="js-format-stats"></div>',
+  );
+
+  $form['#attached']['library'][] = array('system', 'ui.tabs');
+
+  return $form;
+}
+
+/**
+ * Form submit handler.
+ */
+function text_formats_report_page_form_submit($form, &$form_state) {
+  if ($form_state['values']['op'] == t("Download CSV")) {
+    text_formats_report_page_form_download($form, $form_state);
+  }
+}
+
+/**
+ * Form 'View' submit ajax handler.
+ */
+function text_formats_report_page_form_submit_ajax_handler($form, &$form_state) {
+  $selected_formats = array();
+  if (!empty($form_state['values']) && isset($form_state['values']['formats'])) {
+    foreach ($form_state['values']['formats'] as $format) {
+      if ($format) {
+        $selected_formats[] = $format;
+      }
+    }
+  }
+  $content = '<div id="js-format-stats">';
+
+  // Selecting formats is required.
+  if (empty($selected_formats)) {
+    return array(
+      '#type' => 'ajax',
+      '#commands' => array(
+        ajax_command_replace('#js-format-stats', $content . '</div>'),
+      ),
+    );
+  }
+
+  $selected_formats_filter_lists = text_formats_report_filter_format_filter_list($selected_formats);
+  $custom_blocks = text_formats_report_get_custom_blocks($selected_formats);
+  $entities = text_formats_report_fetch_stats($selected_formats);
+
+  $content .= theme('text_formats_report_stats', array(
+    'entities' => $entities,
+    'custom_blocks' => $custom_blocks,
+    'filter_formats_filter_lists' => $selected_formats_filter_lists,
+  ));
+
+  $content .= '</div>';
+
+  $result = array(
+    '#type' => 'ajax',
+    '#commands' => array(
+      ajax_command_replace('#js-format-stats', $content),
+      ajax_command_invoke('#filter-format-tabs', 'tabs'),
+    ),
+  );
+  return $result;
+}
+
+/**
+ * Serves the data for the selected filter formats as a csv file and exits.
+ */
+function text_formats_report_page_form_download($form, &$form_state) {
+  $selected_formats = array();
+  if (!empty($form_state['values']) && isset($form_state['values']['formats'])) {
+    foreach ($form_state['values']['formats'] as $format) {
+      if ($format) {
+        $selected_formats[] = $format;
+      }
+    }
+  }
+
+  // @todo include the custom blocks in the csv file.
+  // $custom_blocks = text_formats_report_get_custom_blocks($selected_formats);
+  $stats = text_formats_report_fetch_stats_for_csv($selected_formats);
+  $file_name = "export-" . date("d-m-Y-H-i") . ".csv";
+
+  drupal_add_http_header('Content-type', 'application/csv; charset=ISO-8859-1');
+  drupal_add_http_header('Content-Disposition', "attachment; filename=$file_name");
+
+  $output = fopen('php://output', 'w');
+  fputcsv($output, array(t("Showing data for the filter formats: @formats", array('@formats' => implode(', ', $selected_formats)))));
+  fputcsv($output, array(''));
+
+  foreach ($stats as $row) {
+    fputcsv($output, $row);
+  }
+
+  drupal_exit();
+}

+ 11 - 0
sites/all/modules/contrib/admin/text_formats_report/text_formats_report.info

@@ -0,0 +1,11 @@
+name = Text formats report
+description = Provides overview of usage on text formats
+core = 7.x
+configure = admin/reports/text-formats
+
+; Information added by Drupal.org packaging script on 2017-09-10
+version = "7.x-1.2"
+core = "7.x"
+project = "text_formats_report"
+datestamp = "1505066645"
+

+ 47 - 0
sites/all/modules/contrib/admin/text_formats_report/text_formats_report.module

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * Implements hook_menu().
+ */
+function text_formats_report_menu() {
+  $items['admin/reports/text-formats'] = array(
+    'title' => 'Text formats',
+    'description' => "Analyze the usage of the available text formats on this site.",
+    'page callback' => 'drupal_get_form',
+    'page arguments' => array('text_formats_report_page_form'),
+    'access arguments' => array('administer site configuration'),
+    'file' => 'inc/text_formats_report.page.inc',
+  );
+  $items['admin/reports/text-formats/field/%'] = array(
+    'title' => 'Text formats by field',
+    'page callback' => 'text_formats_report_field_page',
+    'page arguments' => array(4),
+    'access arguments' => array('administer site configuration'),
+    'file' => 'inc/text_formats_report.field_page.inc',
+  );
+  return $items;
+}
+
+/**
+ * Implements hook_theme().
+ */
+function text_formats_report_theme($existing, $type, $theme, $path) {
+  return array(
+    'text_formats_report_stats' => array(
+      'variables' => array(
+        'entities' => array(),
+        'custom_blocks' => array(),
+        'filter_formats_filter_lists' => array(),
+      ),
+      'file' => 'theme/text_formats_report_stats.theme.inc'
+    ),
+    'text_formats_report_field_stats' => array(
+      'variables' => array(
+        'stats' => array(),
+        'filter_formats' => array(),
+        'field_name' => '',
+      ),
+      'file' => 'theme/text_formats_report_field_stats.theme.inc'
+    ),
+  );
+}

+ 51 - 0
sites/all/modules/contrib/admin/text_formats_report/theme/text_formats_report_field_stats.theme.inc

@@ -0,0 +1,51 @@
+<?php
+
+/**
+ * @file
+ */
+
+/**
+ * Preprocess function for theme_text_formats_report_field_stats();.
+ */
+
+/**
+ *
+ */
+function template_preprocess_text_formats_report_field_stats(&$variables) {
+  $entities = array();
+  $bundles = array();
+  $records = $variables['stats'];
+
+  // Gather some more insight from the data.
+  foreach ($records as $record) {
+    $record->{t('Field name')} = $variables['field_name'];
+    $entities[] = $record;
+    $bundles[] = $record->bundle;
+  }
+
+  $variables['bundles_count'] = array_count_values($bundles);
+  $variables['total_bundles'] = count($variables['bundles_count']);
+  $variables['total_entities'] = array_sum($variables['bundles_count']);
+  $variables['entities'] = $entities;
+}
+
+/**
+ * Theme implementation.
+ *
+ * @see template_preprocess_text_formats_report_field_stats()
+ */
+function theme_text_formats_report_field_stats(&$variables) {
+  if (count($variables['entities']) < 1) {
+    return '<p>' . t("No data found.") . '</p>';
+  }
+
+  $content = '<h2>' . t("Entity bundles using the field <em>@fieldname</em> (@count)", array('@fieldname' => $variables['field_name'], '@count' => $variables['total_bundles'])) . '</h2>';
+  $content .= '<p>' . t("Using the text format: <em>@formats</em>", array('@formats' => implode(', ', $variables['filter_formats']))) . '</p>';
+  $content .= theme('table', text_formats_report_prepare_simple_table($variables['bundles_count'], array('Bundle name', 'Entities')));
+
+  $content .= '<h2>' . t("Content for <em>@fieldname</em> (@count)", array('@fieldname' => $variables['field_name'], '@count' => $variables['total_entities'])) . '</h2>';
+  $content .= '<p>' . t("Using the text format: <em>@formats</em>", array('@formats' => implode(', ', $variables['filter_formats']))) . '</p>';
+  $content .= theme('table', text_formats_report_prepare_table($variables['entities'], array(t('Entity ID'), t('Entity type'), t('Bundle'), t('Text format'), t('Content'), t('Field name'))));
+
+  return $content;
+}

+ 77 - 0
sites/all/modules/contrib/admin/text_formats_report/theme/text_formats_report_stats.theme.inc

@@ -0,0 +1,77 @@
+<?php
+
+/**
+ * @file
+ */
+
+/**
+ * Preprocess function for theme_text_formats_report_stats();.
+ */
+
+/**
+ *
+ */
+function template_preprocess_text_formats_report_stats(&$variables) {
+  // Prepare just the filter titles per filter format.
+  $filter_lists = $variables['filter_formats_filter_lists'];
+  $filter_lists_titles = array();
+  foreach ($filter_lists as $filter_format => $row) {
+    foreach ($row as $filter) {
+      if ($filter->status == 1) {
+        $filter_lists_titles[] = check_plain($filter->title);
+      }
+    }
+    $variables['filter_formats_filter_lists'][$filter_format] = $filter_lists_titles;
+  }
+}
+
+/**
+ * Theme implementation.
+ *
+ * @see template_preprocess_text_formats_report_stats()
+ */
+function theme_text_formats_report_stats(&$variables) {
+  $content = '';
+
+  $content .= '<h2>' . t("Custom blocks using the formats") . '</h2>';
+  $content .= (empty($variables['custom_blocks'])) ? '<p>' . t("None") . '</p>' : theme('table', text_formats_report_prepare_table($variables['custom_blocks']));
+
+  $entities = (isset($variables['entities'])) ? $variables['entities'] : array();
+  if (empty($entities)) {
+    return $content;
+  }
+
+  $tabs_list = '';
+  $tabs_content = '';
+  // Used for ui.tabs navigation.
+  $id = 0;
+  foreach ($entities as $filter_format => $row) {
+    $id++;
+    $tabs_list .= '<li><a href="#tabs-' . $id . '">' . $filter_format . '</a></li>';
+    $tabs_content .= '<div id="tabs-' . $id . '">';
+
+    $tabs_content .= '<p><strong>' . t("Total entities using <em>@format</em>: ", array('@format' => $filter_format)) . '</strong><em>' . $entities[$filter_format]['total_content'] . '</em></p>';
+
+    $tabs_content .= theme('item_list', array(
+        'items' => $variables['filter_formats_filter_lists'][$filter_format],
+        'title' => t('Filters enabled for <em>@format</em> (@count)', array('@format' => $filter_format, '@count' => count($variables['filter_formats_filter_lists'][$filter_format]))),
+      )
+    );
+    $tabs_content .= '<p>' . l(t("Configure @format", array('@format' => $filter_format)), "admin/config/content/formats/$filter_format") . '</p>';
+
+    $tabs_content .= '<h3>' . t("Bundles using <em>@format</em> (@count)", array('@format' => $filter_format, '@count' => count($entities[$filter_format]['bundles']))) . '</h3>';
+    $tabs_content .= theme('table', text_formats_report_prepare_simple_table($entities[$filter_format]['bundles'], array('Bundle name', 'Entities')));
+
+    $tabs_content .= '<h3>' . t("Fields using <em>@format</em> (@count)", array('@format' => $filter_format, '@count' => count($entities[$filter_format]['fields']))) . '</h3>';
+    $tabs_content .= '<p><em>' . t("Click on the field names to see the content in them.") . '</em></p>';
+    $tabs_content .= theme('table', text_formats_report_prepare_simple_table($entities[$filter_format]['fields'], array('Field name', 'Entities')));
+    $tabs_content .= '</div>';
+  }
+
+  $content .= '<div id="filter-format-tabs">';
+  $content .= '<div id="tab-list" class="item-list"><ul>' . $tabs_list . '</ul></div>';
+  $content .= '<div id="tab-content">' . $tabs_content . '</div>';
+  $content .= '</div>';
+
+  return $content;
+}