From 8d2b1238b4d8ebd57848fde665b7f93c3a03cd90 Mon Sep 17 00:00:00 2001 From: Dries Buytaert Date: Thu, 29 May 2003 09:15:00 +0000 Subject: - Michael Frankowski's excellent help text improvements! --- modules/statistics.module | 158 +++++++++++++--------------------------------- 1 file changed, 45 insertions(+), 113 deletions(-) (limited to 'modules/statistics.module') diff --git a/modules/statistics.module b/modules/statistics.module index d3830291e..a167c734a 100644 --- a/modules/statistics.module +++ b/modules/statistics.module @@ -68,6 +68,7 @@ function statistics_exit() { /* System hook, sets description of module in admin page */ function statistics_system($field) { $system["description"] = t("Logs access statistics for your site."); + $system["admin_help"] = t("Settings for the statistical information that Drupal will keep about the site. See site statistics for the actual information.", array("%statistics" => url("admin/statistics"))); return $system[$field]; } @@ -111,18 +112,20 @@ function statistics_link($type, $node = 0, $main = 0) { } if ($type == "admin" && (user_access("administer statistics module") || (user_access("administer statistics")))) { - $help["statistics"] = "This page gives you an at-a-glance look at your top nodes. It is useful for understanding what content on your site is the most popular."; - $help["referrers"] = "This page shows you site-wide referrer statistics. You can see 'all referrers', 'external referrers' or 'internal referrers'. Defaults to 'external'."; - $help["access"] = "This pages shows you who is accessing your website. You can see the hostnames, referrers. In particular, it is easy to inspect a user's navigation history/trail by clicking the username."; - $help["top nodes page"] = "The statistics module creates a user page that can display summaries of the day's top viewed nodes, the all time top nodes and the last nodes viewed. Each of these summaries can be enabled or disabled individually, and the number of nodes displayed for each can be configured with a drop down menu."; - $help["top nodes block"] = "The statistics module exports a block that can display the day's top viewed nodes, the all time top viewed nodes and the last nodes viewed. Each of these links can be enabled or disabled individually, and the number of nodes displayed for each can be configured with a drop down menu. If you disable all sections of this block, it will not appear."; - $help["who is online block"] = "This statistics module exports a block that can display how many user's and guests are currently online. You can configure the name of the block, the name of a sub-block for displaying names of user's currently online, how recently a user must have been active to be considered online, the maximum characters to display from a user's name and the maximum number of user names to display."; + $help["statistics"] = t("This page gives you an at-a-glance look at your top nodes. It is useful for understanding what content on your site is the most popular."); + $help["referrers"] = t("This page shows you site-wide referrer statistics. You can see 'all referrers', 'external referrers' or 'internal referrers'. Defaults to 'external'. Referrers are web sites, both your site, and other peoples, that point to your web site."); + $help["referrers-internal"] = t("This page shows you only 'internal referrers'. Links pointing to your web site, from within your web site."); + $help["referrers-external"] = t("This page shows you only 'external referrers'. Links pointing to your web site from outside your web site."); + $help["access"] = t("This pages shows you who is accessing your web site. You can see the hostnames, referrers. In particular, it is easy to inspect a user's navigation history/trail by clicking the username."); + $help["top nodes page"] = t("The statistics module creates a user page that can display summaries of the day's top viewed nodes, the all time top nodes and the last nodes viewed. Each of these summaries can be enabled or disabled individually, and the number of nodes displayed for each can be configured with a drop down menu."); + $help["top nodes block"] = t("The statistics module exports a block that can display the top viewed nodes of the day, the all time top viewed nodes and the last nodes viewed. Each of these links can be enabled or disabled individually, and the number of nodes displayed for each can be configured with a drop down menu. If you disable all sections of this block, it will not appear."); + $help["who is online block"] = t("The statistics module exports a block that can display how many user's and guests are currently online. You can configure the name of the block, the name of a sub-block for displaying names of user's currently online, how recently a user must have been active to be considered online, the maximum characters to display from a user's name and the maximum number of user names to display."); menu("admin/statistics", "site statistics", "statistics_admin", $help["statistics"], 6); menu("admin/statistics/statistics", "most popular posts", "statistics_admin", $help["statistics"]); menu("admin/statistics/referrers", "referrer log", "statistics_admin", $help["referrers"]); - menu("admin/statistics/referrers/internal", "internal referrers only", "statistics_admin", $help["referrers"]); - menu("admin/statistics/referrers/external", "external referrers only", "statistics_admin", $help["referrers"]); + menu("admin/statistics/referrers/internal", "internal referrers only", "statistics_admin", $help["referrers-internal"]); + menu("admin/statistics/referrers/external", "external referrers only", "statistics_admin", $help["referrers-external"]); menu("admin/statistics/log", "access log", "statistics_admin", $help["access"]); menu("admin/statistics/log/node", "track node", "statistics_admin", $help["access"], 0, 1); menu("admin/statistics/log/user", "track user", "statistics_admin", $help["access"], 0, 1); @@ -141,119 +144,48 @@ function statistics_link($type, $node = 0, $main = 0) { /* Administrative help page */ function statistics_help() { - ?> -

Introduction

- -

This Drupal module keeps track of numerous statistics for your site. Be warned, statistical collection does cause a little overhead, thus everything is disabled by default when this module is first installed.

- -

The statistics module counts how many times each of your nodes is viewed, also tracking where each link to the node came from (HTTP referrer). The number of times a node has been viewed can be displayed in the node's link section (next to "# comments" etc).

- -

This module also adds a configurable block that can display the day's top stories, the all time top stories, and the last stories read. Each of these supports a configurable header and number of stories.

- -

This module also adds a configurable user page that can display the day's top stories, the all time top stories, and the last stories read. Each of these supports a configurable header and number of stories.

- -

This module also adds a configurable block that displays counts of how many users and guests are currently accessing your site, as well as a list of the names of the users currently accessing your site.

- -

If you enable the node view counters, this adds 1 database query for each node that is viewed (2 queries if it's the first time the node has ever been viewed).

- -

Finally, the statistics.module allows for a congestion controlling auto-throttle mechanism. If you have enabled the throttle.module, you can read more about this mechanism .

- -

If you enable the access log, this adds 1 database query for each page that Drupal displays. Logged information includes: HTTP referrer (if any), node being accessed (if any), user ID (if any), the IP address of the user, and the time the page was viewed.

- -

As with any new module, statistics.module needs to be enabled before you can use it. Also refer to the permissions section below, as this module supports four separate permissions.

- -

View statistics

- -

This admin page gives you an at-a-glance look at your top nodes. It is useful for understanding what content on your Drupal site is the most popular. Also on this page are links to the referrer statistics for each listed node.

- -

View referrers

- -

This admin page shows you site-wide referrer statistics. You can see 'all' statistics, 'external' statistics or 'internal' statistics. Default is 'external'.

- -

Configuring the statistics module

- -

There are a couple of configuration options added to the main admin page.

- -

The first option, enable access log, allows you to turn the access log on and off. This log is used to store things like referrers and who's online. Enabling the log adds one database call per page displayed by Drupal.

- -

The second option, discard access logs older than, allows you to configure how long an access log entry is saved, after which time it is deleted from the database table.

- -

The next option, enable node view counter, allows you to turn on and off the node-counting functionality of this module. If it is turned on, an extra database query is added for each node displayed, as a counter is incremented with each node view.

- -

The next option, display node view counters, allows you to globally disable the displaying of node view counters. Additionally, a user group must have 'access statistics' permissions to view the counters.

- -

The final option is to reset the day counter. Every twenty four hours, all the day's totals are automatically reset to 0, and started again. Whatever time you click this link is the time each day that the day's totals will be reset. This requires cron. Note that clicking this link will reload the site configuration page without saving any other changes you might have made.

- -

Top nodes block

- -

This module creates a block that can display the day's top viewed nodes, the all time top viewed nodes and the last nodes viewed. Each of these links can be enabled or disabled individually, and the number of nodes displayed for each can be configured with a drop down menu. If you disable all sections of this block, it will not appear.

- -

The administrative "top nodes block" screen also allows you to assign a name to the block.

- -

Don't forget to enable the block .

- -

Top nodes page

- -

This module creates a user page that can display summaries of the day's top viewed nodes, the all time top nodes and the last nodes viewed. Each of these summaries can be enabled or disabled individually, and the number of nodes displayed for each can be configured with a drop down menu.

- -

The administrative "top nodes page" screen also allows you to assign a name for the automatically generated link to the user page. If no name is set, the link will not be displayed.

- -

Who's online block

- -

This module creates a block that can display how many user's and guests are currently online. You are able to configure the name of the block, the name of a sub-block for displaying names of user's currently online, how recently a user must have been active to be considered online, the maximum characters to display from a user's name and the maximum number of user names to display.

- -

Don't forget to enable the block .

- -

Permissions

-

This module has four permissions that need to be configured in -.

- -

If 'administer statistics' and 'access statistics' are both enabled, the user will see a link from each node to that node's referrer statistics (if enabled).

- -

Statistics module (for developers)

- -

Accessing statistics

-

To get a node's view statistics make a call to the function statistics_get($nid). When you pass in a $nid, the function returns an array with three entires: [0]=totalcount, [1]=daycount, [2]=timestamp. For example, you could use this function call to add node view counts to your theme.

- -

The module automatically adds '# reads' to each node's link section (if enabled).

- -

Top stories

-

The statistics.module provides a function 'statistics_title_list($type)' to return an array of links to any of the following: the top viewed nodes of all time, the top viewed nodes of today, the last viewed nodes. You can pass in:

- - -

Throttle

-

The function throttle_status() will return a number from 0 to 5. 0 means that there is no throttle enabled at this time. Each number above that is a progressively more throttled system... To disable a feature when a site first begins to get busy, disable it at a throttle of 2 or 3. To hold on to the bitter end, wait until 4 or 5.

-

To implement the throttle, you should do something like this: -

       $throttle = 0;
+  $output .= "
Introduction
The statistics.module keeps track of numerous statistics for your site but be warned, statistical collection does cause a little overhead, thus everything comes disabled by default.
";
+  $output .= "
The module counts how many times, and from where -- using HTTP referrer --, each of your nodes is viewed. Once we have that count the module can do the following with it:
";
+  $output .= "
Notes on using the statistics:
";
+  $output .= "
As with any new module, the statistics.module needs to be ". l("enabled", "admin/system/modules") ." before you can use it.  Also refer to the ". l("permissions section", "admin/user/permission") .", as this module supports four separate permissions.
";
+  $output .= l("
referrers log
", "admin/statistics/referrers")."
This admin page shows you site-wide referrer statistics.  You can see 'all' statistics, 'external' statistics or 'internal' statistics.  Default is 'external'.
";
+  $output .= l("
access log
", "admin/statistics/log") ."
This admin page gives you an at-a-glance look at your top nodes.  It is useful for understanding what content on your Drupal site is the most popular.  Also on this page are links to the referrer statistics for each listed node.
";
+  $output .= "
Configuring the statistics module
There are some configuration options added to the main ". l("site configuration", "admin/system/modules/statistics") ." section:
";
+  $output .= "";
+  $output .= "
Top nodes block
This module creates a block that can display the day's top viewed nodes, the all time top viewed nodes and the last nodes viewed.  Each of these links can be enabled or disabled individually, and the number of nodes displayed for each can be configured with a drop down menu.  If you disable all sections of this block, it will not appear.
";
+  $output .= "
The administrative \"top nodes block\" screen also allows you to assign a name to the block.
";
+  $output .= "
Don't forget to enable the block ". l("here", "admin/block") .".
";
+
+  $output .= "
Top nodes page
This module creates a user page that can display summaries of the day's top viewed nodes, the all time top nodes and the last nodes viewed.  Each of these summaries can be enabled or disabled individually, and the number of nodes displayed for each can be configured with a drop down menu.
";
+  $output .= "
The administrative \"top nodes page\" screen also allows you to assign a name for the automatically generated link to the user page.  If no name is set, the link will not be displayed.
";
+  $output .= "
Who's online block
This module creates a block that can display how many user's and guests are currently online.  You are able to configure the name of the block, the name of a sub-block for displaying names of user's currently online, how recently a user must have been active to be considered online, the maximum characters to display from a user's name and the maximum number of user names to display.
";
+  $output .= "
Don't forget to enable the block ". l("here", "admin/block") .".
";
+  $output .= "
Permissions
This module has four permissions that need to be configured in ". l("user permissions", "admin/user/permission") .".
";
+  $output .= "";
+  $output .= "
If 'administer statistics' and 'access statistics' are both enabled, the user will see a link from each node to that node's referrer statistics (if enabled).
";
+  $output .= "
Statistics module (for developers)
Accessing statistics
To get a node's \"view statistics\" make a call to the function statistics_get(\$nid).  When you pass in a Node ID (\$nid), the function returns an array with three entires:  [0]=totalcount, [1]=daycount, [2]=timestamp.  For example, you could use this function call to add node view counts to your theme.
";
+  $output .= "";
+  $output .= "
The module automatically adds '# reads' to each node's link section (if enabled).
";
+  $output .= "
Top stories
The statistics.module provides a function 'statistics_title_list(\$dbfield, \$dbrows)' to return an array of links to any of the following: the top viewed nodes of all time, the top viewed nodes of today, the last viewed nodes.  You can pass in:
";
+  $output .= "
\$dbrows is the number or rows you want returned in your array.
";
+  $output .= "
Throttle
The function throttle_status() will return a number from 0 to 5.  0 means that there is no throttle enabled at this time.  Each number above that is a progressively more throttled system...  To disable a feature when a site first begins to get busy, disable it at a throttle of 2 or 3.  To hold on to the bitter end, wait until 4 or 5.
";
+  $output .= "
To implement the throttle, you should do something like this:
       \$throttle = 0;
        /* verify that the statitistics module is installed */
        if (function_exists(throttle_status) {
-         $throttle = throttle_status()
+         \$throttle = throttle_status()
        }
-       if ($throttle >= $my_throttle_value) {
+       if (\$throttle >= \$my_throttle_value) {
          // throttle limit reached, disable stuff
        }
        else {
          // throttle limit not reached, execute normally
-       }

-
Note:  Even though the configuration for the throttle is handled by the 'throttle.module', the throttle logic itself is part of the 'statistics.module'.  The configuration has been separated in order to make things easier for the average site that will not be utilizing the throttling mechanism.  More information about how the throttle works can be found on the throttle.module help page.  Find the throttle help page  if you have enabled the throttle.module).

+       }

"; + $output .= "

Note: Even though the configuration for the throttle is handled by the 'throttle.module', the throttle logic itself is part of the 'statistics.module'. The configuration has been separated in order to make things easier for the average site that will not be utilizing the throttling mechanism. More information about how the throttle works can be found on the throttle.module help page. (Find the throttle help page ". l("here", "admin/help#throttle") ." if you have enabled the throttle.module).

"; + return t($output); -