Embedded Components and Tools Blog Center » Blog Archive » How to Fix Dean Lee’s Source Code Highlight Plugin

How to Fix Dean Lee’s Source Code Highlight Plugin

Ron Fredericks writes: In my previous post, I discuss Dean Lee’s source code syntax highlighting plugin for Wordpress. It delivers all the great features of the GeSHi open-source highlight project for Wordress bloggers.

Yet some source code displayed badly - turning a developer’s nice clean style into a chaotic and messy format. I demonstrated the display problem using a perl sendmail script I plan to discuss in a future blog post. The problem had to do with some kind of whitespace word wrap issue.

I tested various features of CSS and DIV tag attributes created by Dean’s plugin and the GeSHi php code. I am happy to say, I found a simple one-line solution. My solution is in updating Dean’s CSS container class to force white space not to wrap.

Here is my solution:
Add this property to Dean’s “ch_code_container” CSS class:
white-space: nowrap;

Here is the complete update I made to my Wordpress template:
wp-content/themes/eciWidget/style.css

Code (css)
 
/* Add the following CSS styles modified from Dean’s code Highlighter */
/* Embedded Components, Inc. CSS classes update: version 1.0          */
.ch_code_container {
background-color: #f0f0f0;
border: 1px solid #C3CED9;
padding: 0px 0px 0 0;
width: 100%;
text-align: left;
font-size:1.00em;
overflow:auto;
white-space: nowrap;
}
.ch_code_container .head
{
color: #808080;
font-weight: bold;
background-color: #f0f0ff;
border-bottom: 1px solid #d0d0d0;
padding: 2px;
}
 

So now let’s see how this change affects the source code highlight format using my sendmail perl script example. Compared to the image shown in my previous post, the updated highlight plugin CSS style change solved the problem. Now all lines of source code display as one line each, with the horizontal scroll bar used to see the full text:

Code (perl)
 
#!/usr/bin/perl
##############################################################################
# FormMail                        Version 1.92                               #
# Copyright 1995-2002 Matt Wright mattw@scriptarchive.com                    #
# Created 06/09/95                Last Modified 04/21/02                     #
# Matt’s  Script Archive, Inc.:    http://www.scriptarchive.com/             #
#                                                                            #
##############################################################################
# SPAM FIX                                                                   #
# Embedded Components, Inc.:      http://www.embeddedcomponents.com          #
# Ron Fredericks                  ronf@embeddedcomponents.com                #
# Created 05/18/07                Last Modified 05/23/07                     #
#                                                                            #
# Logic: if number of Internet links exceed $spamChunksMax,                  #
# then print a default error message instead of sending email.               #
#                                                                            #
# define number of links that can appear in an email                         #
$spamChunksMax = 4;                                                          #
# define web address to include in "too many links error message"            #
$spamChunkErrorLink = "http://www.embeddedcomponents.com";                   #
# define the spam error message                                              #
$spamMessage = "Sorry, no spam today please…";                             #
#                                                                            #
# server-side spam test (search this phrase to find all script edits)        #  
#                                                                            #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1995-2002 Matthew M. Wright  All Rights Reserved.                #
#                                                                            #
# FormMail may be used and modified free of charge by anyone so long as this #
# copyright notice and the comments above remain intact.  By using this      #
# code you agree to indemnify Matthew M. Wright from any liability that      #
# might arise from its use.                                                  #
#                                                                            #
# Selling the code for this program without prior written consent is         #
# expressly forbidden.  In other words, please ask first before you try and  #
# make money off of my program.                                              #
#                                                                            #
# Obtain permission before redistributing this software over the Internet or #
# in any other medium. In all cases copyright and header must remain intact. #
##############################################################################
# ACCESS CONTROL FIX: Peter D. Thompson Yezek                                #
#                     http://www.securityfocus.com/archive/1/62033           #
##############################################################################
# Define Variables                                                           #
#      Detailed Information Found In README File.                            #
 
# $mailprog defines the location of your sendmail program on your unix       #
# system. The flags -i and -t should be passed to sendmail in order to       #
# have it ignore single dots on a line and to read message for recipients    #
 
$mailprog = ‘/usr/lib/sendmail -i -t’;
 
# @referers allows forms to be located only on servers which are defined     #
# in this field.  This security fix from the last version which allowed      #
# anyone on any server to use your FormMail script on their web site.        #
 
@referers = (’scriptarchive.com’,‘embeddedcomponents.com’);
 
# @recipients defines the e-mail addresses or domain names that e-mail can   #
# be sent to.  This must be filled in correctly to prevent SPAM and allow    #
# valid addresses to receive e-mail.  Read the documentation to find out how #
# this variable works!!!  It is EXTREMELY IMPORTANT.                         #
# @recipients = &fill_recipients(@referers);
@recipients = (‘^ronf\@embeddedcomponents\.com’);
 
# ACCESS CONTROL FIX: Peter D. Thompson Yezek                                #
# @valid_ENV allows the sysadmin to define what environment variables can    #
# be reported via the env_report directive.  This was implemented to fix     #
# the problem reported at http://www.securityfocus.com/bid/1187              #
 
@valid_ENV = (‘REMOTE_HOST’,‘REMOTE_ADDR’,‘REMOTE_USER’,‘HTTP_USER_AGENT’);
#@valid_ENV = (’REMOTE_HOST’,'REMOTE_ADDR’,'REMOTE_USER’,'HTTP_USER_AGENT’,'HTTP_REFERER’);
 
# Done                                                                       #
##############################################################################
 
# Check Referring URL
&check_url;
 
# Retrieve Date
&get_date;
 
# Parse Form Contents
&parse_form;
 
# Check Required Fields
&check_required;
 
# Send E-Mail
&send_mail;
 
# Return HTML Page or Redirect User
&return_html;
 
# NOTE rev1.91: This function is no longer intended to stop abuse, that      #
#    functionality is now embedded in the checks made on @recipients and the #
#    recipient form field.                                                   #
 
sub check_url {
 
    # Localize the check_referer flag which determines if user is valid.     #
    local($check_referer) = 0;
 
    # If a referring URL was specified, for each valid referer, make sure    #
    # that a valid referring URL was passed to FormMail.                     #
 
    if ($ENV{‘HTTP_REFERER’}) {
        foreach $referer (@referers) {
            if ($ENV{‘HTTP_REFERER’} =~ m|https?://([^/]*)$referer|i) {
                $check_referer = 1;
                last;
            }
        }
    }
    else {
        $check_referer = 1;
    }
 
    # If the HTTP_REFERER was invalid, send back an error.                   #
    if ($check_referer != 1) { &error(‘bad_referer’) }
}
 
sub get_date {
 
    # Define arrays for the day of the week and month of the year.           #
    @days   = (‘Sunday’,‘Monday’,‘Tuesday’,‘Wednesday’,
               ‘Thursday’,‘Friday’,‘Saturday’);
    @months = (‘January’,‘February’,‘March’,‘April’,‘May’,‘June’,‘July’,
               ‘August’,‘September’,‘October’,‘November’,‘December’);
 
    # Get the current time and format the hour, minutes and seconds.  Add    #
    # 1900 to the year to get the full 4 digit year.                         #
    ($sec,$min,$hour,$mday,$mon,$year,$wday) = (localtime(time))[0,1,2,3,4,5,6];
    $time = sprintf("%02d:%02d:%02d",$hour,$min,$sec);
    $year += 1900;
 
    # Format the date.                                                       #
    $date = "$days[$wday], $months[$mon] $mday, $year at $time";
 
}
 
sub parse_form {
 
    # part of server-side spam test
    # initialize our antispam counter
    $spamChunkCount = 0;
 
    # Define the configuration associative array.                            #
    %Config = (‘recipient’,”,          ’subject’,”,
               ‘email’,”,              ‘realname’,”,
               ‘redirect’,”,           ‘bgcolor’,”,
               ‘background’,”,         ‘link_color’,”,
               ‘vlink_color’,”,        ‘text_color’,”,
               ‘alink_color’,”,        ‘title’,”,
               ’sort’,”,               ‘print_config’,”,
               ‘required’,”,           ‘env_report’,”,
               ‘return_link_title’,”,  ‘return_link_url’,”,
               ‘print_blank_fields’,”, ‘missing_fields_redirect’,”);
 
    # Determine the form’s REQUEST_METHOD (GET or POST) and split the form   #
    # fields up into their name-value pairs.  If the REQUEST_METHOD was      #
    # not GET or POST, send an error.                                        #
    if ($ENV{‘REQUEST_METHOD’} eq ‘GET’) {
        # Split the name-value pairs
        @pairs = split(/&/, $ENV{‘QUERY_STRING’});
    }
    elsif ($ENV{‘REQUEST_METHOD’} eq ‘POST’) {
        # Get the input
        read(STDIN, $buffer, $ENV{‘CONTENT_LENGTH’});
 
        # Split the name-value pairs
        @pairs = split(/&/, $buffer);
    }
    else {
        &error(‘request_method’);
    }
 
    # For each name-value pair:                                              #
    foreach $pair (@pairs) {
 
        # Split the pair up into individual variables.                       #
        local($name, $value) = split(/=/, $pair);
 
        # Decode the form encoding on the name and value variables.          #
        # v1.92: remove null bytes                                           #
        $name =~ tr/+/ /;
        $name =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg;
        $name =~ tr/\0//d;
 
        $value =~ tr/+/ /;
        $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C", hex($1))/eg;
        $value =~ tr/\0//d;
        
        # part of server-side spam test
        # count number of accesses to internet this email message might have…
        $spamChunkCount = $spamChunkCount + &count_chunks($value, "href=");
        $spamChunkCount = $spamChunkCount + &count_chunks($value, "http:");
        $spamChunkCount = $spamChunkCount + &count_chunks($value, "https:");
        $spamChunkCount = $spamChunkCount + &count_chunks($value, "ftp:");
        $spamChunkCount = $spamChunkCount + &count_chunks($value, "mailto:");
 
        # If the field name has been specified in the %Config array, it will #
        # return a 1 for defined($Config{$name}}) and we should associate    #
        # this value with the appropriate configuration variable.  If this   #
        # is not a configuration form field, put it into the associative     #
        # array %Form, appending the value with a ‘, ‘ if there is already a #
        # value present.  We also save the order of the form fields in the   #
        # @Field_Order array so we can use this order for the generic sort.  #
        if (defined($Config{$name})) {
            $Config{$name} = $value;
        }
        else {
            if ($Form{$name} ne ”) {
                $Form{$name} = "$Form{$name}, $value";
            }
            else {
                push(@Field_Order,$name);
                $Form{$name} = $value;
            }
        }
    }
 
    # The next six lines remove any extra spaces or new lines from the       #
    # configuration variables, which may have been caused if your editor     #
    # wraps lines after a certain length or if you used spaces between field #
    # names or environment variables.                                        #
    $Config{‘required’} =~ s/(\s+|\n)?,(\s+|\n)?/,/g;
    $Config{‘required’} =~ s/(\s+)?\n+(\s+)?//g;
    $Config{‘env_report’} =~ s/(\s+|\n)?,(\s+|\n)?/,/g;
    $Config{‘env_report’} =~ s/(\s+)?\n+(\s+)?//g;
    $Config{‘print_config’} =~ s/(\s+|\n)?,(\s+|\n)?/,/g;
    $Config{‘print_config’} =~ s/(\s+)?\n+(\s+)?//g;
 
    # Split the configuration variables into individual field names.         #
    @Required = split(/,/,$Config{‘required’});
    @Env_Report = split(/,/,$Config{‘env_report’});
    @Print_Config = split(/,/,$Config{‘print_config’});
 
    # ACCESS CONTROL FIX: Only allow ENV variables in @valid_ENV in          #
    # @Env_Report for security reasons.                                      #
    foreach $env_item (@Env_Report) {
        foreach $valid_item (@valid_ENV) {
            if ( $env_item eq $valid_item ) { push(@temp_array, $env_item) }
        }
    } 
    @Env_Report = @temp_array;
}
 
sub check_required {
 
    # Localize the variables used in this subroutine.                        #
    local($require, @error);
 
    # The following insures that there were no newlines in any fields which  #
    # will be used in the header.                                            #
    if ($Config{’subject’} =~ /(\n|\r)/m || $Config{‘email’} =~ /(\n|\r)/m ||
        $Config{‘realname’} =~ /(\n|\r)/m || $Config{‘recipient’} =~ /(\n|\r)/m) {
        &error(‘invalid_headers’);
    }
 
    if (!$Config{‘recipient’}) {
        if (!defined(%Form)) { &error(‘bad_referer’) }
        else                 { &error(‘no_recipient’) }
    }
    else {
        # This block of code requires that the recipient address end with    #
        # a valid domain or e-mail address as defined in @recipients.        #
        $valid_recipient = 0;
        foreach $send_to (split(/,/,$Config{‘recipient’})) {
            foreach $recipient (@recipients) {
                if ($send_to =~ /$recipient$/i) {
                    push(@send_to,$send_to); last;
                }
            }
        }
        if ($#send_to < 0) { &error(’no_recipient’) }
        $Config{‘recipient’} = join(‘,’,@send_to);
    }
 
    # For each require field defined in the form:                            #
    foreach $require (@Required) {
 
        # If the required field is the email field, the syntax of the email  #
        # address if checked to make sure it passes a valid syntax.          #
        if ($require eq ‘email’ && !&check_email($Config{$require})) {
            push(@error,$require);
        }
 
        # Otherwise, if the required field is a configuration field and it   #
        # has no value or has been filled in with a space, send an error.    #
        elsif (defined($Config{$require})) {
            if ($Config{$require} eq ”) { push(@error,$require); }
        }