You are here

Home » API reference » Link checker 6.2

README.txt in Link checker 6.2

Same filename and directory in other branches
  1. 5.2 README.txt
  2. 5 README.txt
  3. 7 README.txt
Link Checker
------------

Installation:

1. Place the entire linkchecker folder into your modules directory.
2. Go to Administer -> Site building -> Modules and enable the Link checker module.
3. Go to Administer -> Site configuration -> Link checker and enable the node types to scan.
4. Check all HTML tags that should be scanned.
5. Adjust the other parameters if the defaults don't suit your needs.
6. Save configuration
7. Wait for cron to check all your links... this may take some time! :-)

If links are broken they appear under Administer -> Reports -> Broken links.

If not, make sure the cron is configured and running properly on your Drupal
installation. The Link checker module also logs somewhat useful info about it's
activity under Administer -> Reports -> Recent log entries.


Required:

1. For internal URL extraction you need to make sure that Cron always get called
   with your real public site URL (for e.g. http://example.com/cron.php). Make
   sure it's never executed with http://localhost/cron.php or any other
   hostnames or ports, not available from public. Otherwise all links may be
   reported as broken and cannot verified as they should be.

   To make sure it always works - it's required to configure the $base_url in
   the sites settings.php with your public sites URL. Better safe than sorry!


Known issues:

There are a lot of known issues in drupal_http_request(). These have been solved
in HTTPRL. As a workaround it's recommended to use HTTPRL in linkchecker.

Issues list:
 
* #997648: drupal_http_request() always calls fread() one more time than necessary
* #164365-12: drupal_http_request() does handle (invalid) non-absolute redirects
* #205969-11: drupal_http_request() assumes presence of Reason-Phrase in response Status-Line
* #371495: Error message from drupal_http_request() not UTF8 encoded
* #193073-11: drupal_http_request - socket not initialized
* #106506-8: drupal_http_request() does not handle 'chunked' responses - Make it support HTTP 1.1
* #1096890-15: drupal_http_request should return error if reaches max allowed redirects
* #875342-21: drupal_http_request() should pick up X-Drupal-Assertion-* HTTP headers
* #965078-31: HTTP request checking is unreliable and should be removed in favor of watchdog() calls
* #336367: HTTP client should protect commas when folding (compatibility with legacy HTTP/1.0)
* #45338: log fsockopen errors to watchdog


Other

* Drupal 6.14 only: A critical core bug has been introduced by #193383:
  set_time_limit: Centralize calls and prevent warnings and errors that stops
  link checker from verifying links. Apply the available D6 hotfix in #111 or
  update to Drupal 6.15+ to fix your installation.

File

README.txt
View source 
  1. 

  2. Link Checker

  3. ------------

  4. 

  5. Installation:

  6. 

  7. 1. Place the entire linkchecker folder into your modules directory.

  8. 2. Go to Administer -> Site building -> Modules and enable the Link checker module.

  9. 3. Go to Administer -> Site configuration -> Link checker and enable the node types to scan.

  10. 4. Check all HTML tags that should be scanned.

  11. 5. Adjust the other parameters if the defaults don't suit your needs.

  12. 6. Save configuration

  13. 7. Wait for cron to check all your links... this may take some time! :-)

  14. 

  15. If links are broken they appear under Administer -> Reports -> Broken links.

  16. 

  17. If not, make sure the cron is configured and running properly on your Drupal

  18. installation. The Link checker module also logs somewhat useful info about it's

  19. activity under Administer -> Reports -> Recent log entries.

  20. 

  21. 

  22. Required:

  23. 

  24. 1. For internal URL extraction you need to make sure that Cron always get called

  25.    with your real public site URL (for e.g. http://example.com/cron.php). Make

  26.    sure it's never executed with http://localhost/cron.php or any other

  27.    hostnames or ports, not available from public. Otherwise all links may be

  28.    reported as broken and cannot verified as they should be.

  29. 

  30.    To make sure it always works - it's required to configure the $base_url in

  31.    the sites settings.php with your public sites URL. Better safe than sorry!

  32. 

  33. 

  34. Known issues:

  35. 

  36. There are a lot of known issues in drupal_http_request(). These have been solved

  37. in HTTPRL. As a workaround it's recommended to use HTTPRL in linkchecker.

  38. 

  39. Issues list:

  40.  

  41. * #997648: drupal_http_request() always calls fread() one more time than necessary

  42. * #164365-12: drupal_http_request() does handle (invalid) non-absolute redirects

  43. * #205969-11: drupal_http_request() assumes presence of Reason-Phrase in response Status-Line

  44. * #371495: Error message from drupal_http_request() not UTF8 encoded

  45. * #193073-11: drupal_http_request - socket not initialized

  46. * #106506-8: drupal_http_request() does not handle 'chunked' responses - Make it support HTTP 1.1

  47. * #1096890-15: drupal_http_request should return error if reaches max allowed redirects

  48. * #875342-21: drupal_http_request() should pick up X-Drupal-Assertion-* HTTP headers

  49. * #965078-31: HTTP request checking is unreliable and should be removed in favor of watchdog() calls

  50. * #336367: HTTP client should protect commas when folding (compatibility with legacy HTTP/1.0)

  51. * #45338: log fsockopen errors to watchdog

  52. 

  53. 

  54. Other

  55. 

  56. * Drupal 6.14 only: A critical core bug has been introduced by #193383:

  57.   set_time_limit: Centralize calls and prevent warnings and errors that stops

  58.   link checker from verifying links. Apply the available D6 hotfix in #111 or

  59.   update to Drupal 6.15+ to fix your installation.