Main
Index 		Search
Posts 		Who's
Online 		Log
In

Home: Products: CMS Builder: Plugins & Add-ons:
headers_sent() issue with plugins and instant website

 
 


ITI
User

Aug 15, 2011, 9:19 PM

Post #1 of 9 (1319 views)
Shortcut
headers_sent() issue with plugins and instant website Can't Post
This issue relates to writing plugins and users who use Interactive Tools Instant Website.

This error is hard to reproduce and I haven't been able to do it internally. I can however with the assistance of a site visitor in the Toronto area. I can not explain why only some site visitors are affected so its a bit of a mystery.

To explain I'll have to use the Instant Website initialization file "website_init.php" which contains the line:
Code
// error checking 
if (headers_sent()) {  
    die("You must load " .basename(__FILE__). 
    " at top of file!  Make sure there are no spaces before it!\n");  
} 
// Note: this is written on a single line (line 11) in website_init.php

Some website visitors will see the error message and the web page will not be displayed.

The reason in my case was that there were active plugins that contained white space (blank lines) after the closing php tag (?>)

To ensure that the page is always displayed in your "Instant website" you can simply comment out the line with 2 forward slashes.
Code
//if (headers_sent()) { die("You must load " .basename(__FILE__). .....

What I did to test this issue was to change the "die" to sending an email instead.
Code
if(headers_sent($file,$line)) {  
  $to = $SETTINGS['adminEmail']; 
  $headers = "From: $to"; 
  $subject = "Headers Sent on ".$_SERVER['SERVER_NAME']; 
  $msg = "Headers already sent accessing: ".$_SERVER['SERVER_NAME']. 
          "\nIn $file, on line $line, from IP: ".$_SERVER['REMOTE_ADDR']; 
  mail($to,$subject,$msg,$headers); 
}
The email contains the line number in the file causing the problem. In Instant website the page still displays so there is no need to "exit". I received several emails from different IP address which indicates that this isn't isolated to just a single visitor.

Note to New Plugin developers:
Be sure you do not have any more than 1 blank line after the closing php tag in any of your plugin files.

I suspect that the use of headers_sent() in any custom code you create could also trigger this error.

I've also include information on this issue on my plugins tutorial page:
http://www.canadiandomainregistry.ca/cmsDocs/cmsPublic/

Glen
http://www.CanadianDomainRegistry.ca
ITI Internetworking Technologies Inc.

(This post was edited by ITI on Aug 16, 2011, 6:15 AM)


ross
Staff / Moderator


Aug 16, 2011, 3:32 PM

Post #2 of 9 (1227 views)
Shortcut
Re: [ITI] headers_sent() issue with plugins and instant website [In reply to] Can't Post
Hi Glenn

Thanks for looking into this! Spaces in plugins can defintiely be a problem when headers are being sent. This is something I've run into myself a few times so I am quite familiar with how frustrating that can be.

If you are still having trouble with sporadic error messages, could you shoot us over a full support ticket? I'd like to take a closer look myself :).

Thanks!
-----------------------------------------------------------
Cheers,
Ross Fairbairn - Product Specialist
support@interactivetools.com

Hire me!  Save time by getting our experts to help with your project.
Template changes, advanced features, full integration, whatever you
need. Whether you need one hour or fifty, get it done fast with
Priority Consulting: http://www.interactivetools.com/consulting/



ITI
User

Aug 16, 2011, 7:23 PM

Post #3 of 9 (1216 views)
Shortcut
Re: [ross] headers_sent() issue with plugins and instant website [In reply to] Can't Post
Hi Ross

No, I'm not having sporadic messages, I've already diagnosed and solved the problem.

The purpose behind my post was/is two fold:
1. To let you fellows at IAT and IW users know of a potential problem.
2. To identify to new and I suppose veteran plugin developers that there is a potential issue/problem when creating/saving a plugin.

The second issue is a result of IAT not having any documentation available for new users or newbie plugin developers.

You guys nailed it when you created and released CMSB and the plugin's set it apart from any other software I've worked with.

Unfortunately IAT's lack of documentation sucks which is why I created my own tutorial on Plugins. I have been writing and updating it for my own benefit and I don't mind sharing it with your community.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If I were to make a suggestion it would be that in a future release of Instant Website, you either remove the headers_sent() or set it to provide the site owner/developer a more meaningful message. The error message is meaningless to the site visitor and it doesn't even give the visitor a link to report the error to anyone.

As it stand the site owner is completely unaware that their site is not available to some visitors. A CMSB user could be using a third party plugin thus generating the error and not know about it.

Considering the page displays just fine with the headers_sent() commented out clearly suggest this should be handled in a different manner.

Since the issue is part and parcel with how to create plugins I included it in this post.

Now, if you could tell me/us why some site visitors trigger the error while others do not, I would be most interested in knowing.

In my tests, one site visitor triggers the error every time. The only thing that I know is that they have a satellite internet connection. I'm guessing that it's the satellite's request and server's response during the connection protocol that is triggering the error. However, I tested it with a buddy who has a satellite connection and there was no error so I'm really baffled. Got any ideas as to why this is the case?

Thanks for taking time to read and respond.

Glen
http://www.CanadianDomainRegistry.ca
ITI Internetworking Technologies Inc.

(This post was edited by ITI on Aug 16, 2011, 7:46 PM)


Dave
Staff / Moderator


Aug 17, 2011, 12:18 PM

Post #4 of 9 (1204 views)
Shortcut
Re: [ITI] headers_sent() issue with plugins and instant website [In reply to] Can't Post
Hi Glen,

I've updated the error message to show the source of the whitespace as so:

Code
if (headers_sent($file, $line))         { 
  die("You must load " .basename(__FILE__). " at top of file!  Make sure there are no extra spaces before 
 it (or at the end of any plugins)! Output started in $file line $line.\n"); 
}

>Now, if you could tell me/us why some site visitors
>trigger the error while others do not, I would be most
>interested in knowing.

I'm curious about that too, because I would imagine if there was extra whitespace sent it would affect all users. What was the file and line that was reported when you received errors by mail?

Thanks!

Dave Edis - Senior Developer
interactivetools.com
 


ITI
User

Aug 17, 2011, 2:25 PM

Post #5 of 9 (1202 views)
Shortcut
Re: [Dave] headers_sent() issue with plugins and instant website [In reply to] Can't Post
Hi Dave.

The problem with using "die(...)" is that the its the site visitor that is seeing error message. The site owner or developer will never know about. Unless the site visitor knows the site owner they are just going to move on to the next site.

I only became aware of the problem because the site visitor called me.

What's weird is that the page will still display even if the headers_sent() was triggered which reinforces the point that there is no need to stop execution of the script.

The initial error was a result of a plugin I had written. I have a tendency to add white space to the bottom so that I'm look at the code in the middle of the screen.

During my testing I added various amounts of new lines to different plugins at different times and my email error message always identified the last line of the file I was testing. Only active plugins generated the error. So basically the error can be caused by any plugin that has "more than one line" after the closing php tag.

I tried generating the errors by accessing the site from my neighbors cable connection, my buddies satellite connection and via W3C's validation scripts which was another form on external access. I could not generate the error.

However, during the testing stage I did receive access errors from other IP addresses other than the person who was assisting me from Toronto. This tells us that it isn't an isolated situation.

I'm still of the belief that it has to do with establishing the communication protocols during the request/response/ack stage via their ISP's satellite or possibly some weird ISP's DHCP configuration between them and their clients.
After all Telus thinks they know it all and yes they are down east as well.

I think you should consider not using die(). Even echo or print would at least allow the page to display.
As for me, I'm going to leave the email notification in place since I do have that tendency to add white space while developing.

ps. To help determine whether or not this is a real issue maybe other users of IW could use the email notification and deliberately add a few extra lines to one of their active plugins.

pps. I have created and activated a plugin with extra line feeds. Click to see if your connection displays the error.
http://www.canadiandomainregistry.ca/cmsDemo/index.php
The page will either display normally or die() and send me an email.

Glen
http://www.CanadianDomainRegistry.ca
ITI Internetworking Technologies Inc.

(This post was edited by ITI on Aug 17, 2011, 3:19 PM)


Dave
Staff / Moderator


Aug 17, 2011, 2:53 PM

Post #6 of 9 (1196 views)
Shortcut
Re: [ITI] headers_sent() issue with plugins and instant website [In reply to] Can't Post
Hi Glen,

If you send headers after you've sent content you'll get a warning from PHP regardless, so the idea with the die call is it shows just that one error and nothing else so it's more noticable instead of PHPs default warning somewhere in the page content, which looks like this: "Warning: Cannot modify header information - headers already sent by ...".

The problem with removing that line (or sending content before headers such as with whitespace in plugins) is that if header have already been sent (which means page content or whitespace has been sent) no more HTTP headers can be sent (and you can't set cookies or, session values either). So, for example, this would produce a "headers already sent" error:

Code
  print "   "; 
  ob_flush(); 
  header("HTTP/1.0 404 Not Found"); 
  print "<h1>404 Not Found</h1>"; 
  print "done";

I'm thinking it may be a server-side caching issue. That IIS sometimes hasn't yet sent the content to PHP so PHP doesn't know headers have been sent. Can you try adding this line and let me know if you get the error all the time?

Code
ob_flush(); 
if (headers_sent($file, $line))         {  
  die("You must load " .basename(__FILE__). " at top of file!  Make sure there are no extra spaces before  
 it (or at the end of any plugins)! Output started in $file line $line.\n");  
}

Anyways, with Instant Website I don't think it's matters much and it's pretty safe to remove that line. All it does is prevent you from getting a different error when the 404 code is called. So if it's not proving helpful removing it is probably the way to go.

Also, it gives me an idea that maybe we could auto-detect the whitespace at the end of plugins in CMSB init and warn developers about it.

Let me know if ob_flush() gives you different results (and if you have any extensions that automatically gzencode/compress output or anything like that.

Thanks!

Dave Edis - Senior Developer
interactivetools.com
 


ITI
User

Aug 17, 2011, 3:36 PM

Post #7 of 9 (1194 views)
Shortcut
Re: [Dave] headers_sent() issue with plugins and instant website [In reply to] Can't Post
Hi Dave

I added a link to the previous post to have people test to see if they get the error.

I did as you requested and added ob_flush().
The page failed with the error message. I refreshed a half dozen times and the error message displayed every time.

I've now commented out ob_flush() and reactivated the faulty plugin to see if users from the forums will see the page or the error.
http://www.canadiandomainregistry.ca/cmsDemo/index.php

Glen
http://www.CanadianDomainRegistry.ca
ITI Internetworking Technologies Inc.


Toledoh
Enthusiast

Aug 17, 2011, 4:45 PM

Post #8 of 9 (1190 views)
Shortcut
Re: [ITI] headers_sent() issue with plugins and instant website [In reply to] Can't Post
I see the page...
Cheers,

Tim Forrest
Toledoh Enterprises
www.toledoh.com.au


Dave
Staff / Moderator


Aug 18, 2011, 8:00 PM

Post #9 of 9 (1087 views)
Shortcut
Re: [ITI] headers_sent() issue with plugins and instant website [In reply to] Can't Post
Hmm, I did some more testing and headers_sent() seems pretty inconsistent and problematic.

I've removed it from website_init.php. Thanks for the tip! :)

Dave Edis - Senior Developer
interactivetools.com