You are here

README.txt in Forward 6


        FORWARD MODULE - README
______________________________________________________________________________

NAME:       Forward
AUTHORS:    Sean Robertson <seanr@ngpsoftware.com>
            Peter Feddo
______________________________________________________________________________


DESCRIPTION

Adds a "forward this page" link to each node. This module allows users to
forward a link to a specific node on your site to a friend.  You can customize
the default form field values and even view a running count of the emails sent
so far using the forward module.


INSTALLATION

Step 1) Download latest release from http://drupal.org/project/forward

Step 2)
  Extract the package into your 'modules' directory.


Step 3)
  Enable the forward module.

  Go to "administer >> build >> modules" and put a checkmark in the 'status' column next
  to 'forward'.


Step 4)
  Go to "administer >> site configuration >> forward" to configure the module.
  
  If you wish to customize the emails, copy 'forward.tpl.php' into your theme directory.
  Then you can customize the function as needed and those changes will only appear went
  sent by a user using that theme.

  If you upgraded from an earlier version of Forward, your site may be configured
  to use the older theme functions in forward.theme (you can change this in the
  forward settings page).  If so, follow these instructions:

  Edit 'forward.theme' to change the look and feel of your emails.  You can also
  create different themes for different phptemplate themes with by copying the
  contents of 'forward.theme' into your theme's 'template.php' file and
  prepending the function name with 'phptemplate_'.  Then you can customize the
  function as needed and those changes will only appear went sent by a user using
  that theme.  For more information, see the Drupal handbook:

  http://drupal.org/node/11811


Step 5)
  Enable permissions appropriate to your site.

  The forward module provides several permissions:
   - 'access forward': allow user to forward pages.
   - 'access epostcard': allow user to send an epostcard.
   - 'override email address': allow logged in user to change sender address.
   - 'administer forward': allow user to configure forward.
   - 'override flood control': allow user to bypass flood control on send.

  Note that you need to enable 'access forward' for users who should be able to
  send emails using the forward module.


Step 6)
  Go to "administer >> logs >> forward tracking" to view forward usage statistics.


DYNAMIC BLOCK ACCESS CONTROL

The 6.x-1.21 release of the Forward module added a new security field
for administators on the Forward configuration page named Dynamic Block
Access Control.  This field allows the administrator to control which
permissions are used when Drupal applies access control checks to the nodes,
comments or users listed in the Dynamic Block.  Several access control
options are available, including a bypass option.  The bypass option allows
the email recipient to possibly view node titles, comment titles, or user
names that only privileged users should see. The bypass option should not
normally be selected, but is provided for sites that used prior versions
of Forward and rely on the access bypass to operate correctly.

IMPORTANT: Because the default for the new field is to apply access control,
administrators of sites that rely on the access bypass to operate correctly
need to visit the Forward configuration page and explicitly select the bypass
option after upgrading from versions of Forward prior to 6.x-1.21.


CLICKTHROUGH COUNTER FLOOD CONTROL

The Forward module tracks clicks from links in sent emails to determine which
nodes get the most clickthroughs.  The method used could allow someone to
manipulate clickthrough counts via CSRF - for example, placing an image on
a website with a src tag that points to the clickthrough counter link.  The
module uses flood control to limit the number of clickthroughs from a given
IP address in a given time period to migitate this possibility.


CREDITS & SUPPORT

Special thanks to Jeff Miccolis of developmentseed.org for supplying the
tracking features and various other edits.  Thanks also to Nick White for his
EmailPage module, some code from which was used in this module, as well as the
numerous other users who have submitted issues and patches for forward.

All issues with this module should be reported via the following form:
http://drupal.org/node/add/project_issue/forward

______________________________________________________________________________
http://www.ngpsystems.com

File

README.txt
View source
  1. FORWARD MODULE - README
  2. ______________________________________________________________________________
  3. NAME: Forward
  4. AUTHORS: Sean Robertson
  5. Peter Feddo
  6. ______________________________________________________________________________
  7. DESCRIPTION
  8. Adds a "forward this page" link to each node. This module allows users to
  9. forward a link to a specific node on your site to a friend. You can customize
  10. the default form field values and even view a running count of the emails sent
  11. so far using the forward module.
  12. INSTALLATION
  13. Step 1) Download latest release from http://drupal.org/project/forward
  14. Step 2)
  15. Extract the package into your 'modules' directory.
  16. Step 3)
  17. Enable the forward module.
  18. Go to "administer >> build >> modules" and put a checkmark in the 'status' column next
  19. to 'forward'.
  20. Step 4)
  21. Go to "administer >> site configuration >> forward" to configure the module.
  22. If you wish to customize the emails, copy 'forward.tpl.php' into your theme directory.
  23. Then you can customize the function as needed and those changes will only appear went
  24. sent by a user using that theme.
  25. If you upgraded from an earlier version of Forward, your site may be configured
  26. to use the older theme functions in forward.theme (you can change this in the
  27. forward settings page). If so, follow these instructions:
  28. Edit 'forward.theme' to change the look and feel of your emails. You can also
  29. create different themes for different phptemplate themes with by copying the
  30. contents of 'forward.theme' into your theme's 'template.php' file and
  31. prepending the function name with 'phptemplate_'. Then you can customize the
  32. function as needed and those changes will only appear went sent by a user using
  33. that theme. For more information, see the Drupal handbook:
  34. http://drupal.org/node/11811
  35. Step 5)
  36. Enable permissions appropriate to your site.
  37. The forward module provides several permissions:
  38. - 'access forward': allow user to forward pages.
  39. - 'access epostcard': allow user to send an epostcard.
  40. - 'override email address': allow logged in user to change sender address.
  41. - 'administer forward': allow user to configure forward.
  42. - 'override flood control': allow user to bypass flood control on send.
  43. Note that you need to enable 'access forward' for users who should be able to
  44. send emails using the forward module.
  45. Step 6)
  46. Go to "administer >> logs >> forward tracking" to view forward usage statistics.
  47. DYNAMIC BLOCK ACCESS CONTROL
  48. The 6.x-1.21 release of the Forward module added a new security field
  49. for administators on the Forward configuration page named Dynamic Block
  50. Access Control. This field allows the administrator to control which
  51. permissions are used when Drupal applies access control checks to the nodes,
  52. comments or users listed in the Dynamic Block. Several access control
  53. options are available, including a bypass option. The bypass option allows
  54. the email recipient to possibly view node titles, comment titles, or user
  55. names that only privileged users should see. The bypass option should not
  56. normally be selected, but is provided for sites that used prior versions
  57. of Forward and rely on the access bypass to operate correctly.
  58. IMPORTANT: Because the default for the new field is to apply access control,
  59. administrators of sites that rely on the access bypass to operate correctly
  60. need to visit the Forward configuration page and explicitly select the bypass
  61. option after upgrading from versions of Forward prior to 6.x-1.21.
  62. CLICKTHROUGH COUNTER FLOOD CONTROL
  63. The Forward module tracks clicks from links in sent emails to determine which
  64. nodes get the most clickthroughs. The method used could allow someone to
  65. manipulate clickthrough counts via CSRF - for example, placing an image on
  66. a website with a src tag that points to the clickthrough counter link. The
  67. module uses flood control to limit the number of clickthroughs from a given
  68. IP address in a given time period to migitate this possibility.
  69. CREDITS & SUPPORT
  70. Special thanks to Jeff Miccolis of developmentseed.org for supplying the
  71. tracking features and various other edits. Thanks also to Nick White for his
  72. EmailPage module, some code from which was used in this module, as well as the
  73. numerous other users who have submitted issues and patches for forward.
  74. All issues with this module should be reported via the following form:
  75. http://drupal.org/node/add/project_issue/forward
  76. ______________________________________________________________________________
  77. http://www.ngpsystems.com