root/jp-bread-crumb-trail/trunk/jp-bct.php

<?php
/*
Plugin Name: Bread Crumb Trail Generator
Version: 1.1 Beta
Plugin URI: http://jp.jixor.com/archives/bread-crumb-trail/
Author: Stephen Ingram
Author URI: http://jp.jixor.com/
Description: Generate a bread crumb trail. The main purpose of this plugin is to give the user some feedback as to what they are actually viewing. To call use jp_bct(); Options are 'root', 'showhome', 'before', 'after', 'divider', 'eachlink', 'current' and 'homename' (all optional). See plugin page or source for more details and instructions. Note that you can't make the current page a link. I'm aware that technically this isn't a BCT. However 99% of the time you see 'BCT' this implementation is what they are talking about.
*/

/* ************************************************************************

JP_BCT License (based on BSD license)
Copyright (c) 2005, jp.jixor.com, Stephen Ingram
All rights reserved.

        PREAMBLE

  Feel free to modify the source providing you stick the the following
conditions. Please also inform me of any modifications you make so that I
may possibly add them to the release on my site. I will credit authors
where appropriate. License may change. However this is fairly simple,
basically don't claim its your own and I'm not responsible for your use of
it.

---------------------------------------------------------------------------

        LICENSE

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1) Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

2) Neither the name of jixor.com, nor the names of its
   contributors may be used to endorse or promote products derived from this
   software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

************************************************************************ */

/*
Please report any errors or problems to me via the plugin's comments section. If you want your post to remain private just say so.

Thanks to Denis (http://www.semiologic.com/) for keeping me on my toes.

There may be some debate as to if this is actually a bct or not, I think showing the hierarchical structure of the site through a list of backlinks is a bct even it it doesnt show the exact path you have taken. I think that approach is actually foolish (usability wise) and I ahve never actually seen it anyway (other than when I tested it).
*/

// Begin editable
define(JP_BCT_CFG,'wp-content/jp-bct/jp-bct.ini'); // You may place settings in an ini file, feel free to change the path here. However when you update it will return to the default.
// End editable

function jp_bct($root='/', $showhome=TRUE, $before='<div id="bct">You\'re browsing: ', $after='</div>', $divider=' / ', $eachlink='<a href="%url%" title="Browse to: %name%">%name%</a>', $current='<strong>%name%</strong>', $homename='Home',$debug=FALSE,$pagedtext='Page ') {

        /*
        Other than debug iformation this script should be fully multilingual. You'll just have to manually specify formatting for different languages.

        'root' - The location of the root of your site. If your site is http://www.example.com/ the root should be "/". However if your site is
                http://www.example.com/userslog/ the root would be "/userslog/".
        'showhome' - Will show the bct when the user is on the home page, however it will just be the test specified by 'homename' and not a link.
        'before' - I suggest you insert your caption here. Could use something like 'You are here:', just whatever floats your boat.
        'after' - Placed after the bct.
        'divider' - Placed between each item in the bct, thats not before the first and not after the last.
        'eachlink' - Format of each link item in the bct. Uses replacments - %url% - url for the individual bct, and '%name$ - text for the bct,
                formatting applied by script.
        'current' - Format for the item representing the current page, being the last item in the bct. Replaces '%name%' only.
        'homename' - Text displayed for the home link, if you don't want to call it home then just change this.
        'debug' - Seting this will make the script always display debug information. You can however just set ?debug in your uri to enable it.
        'pagedtext' - If you are browsing multipaged article this will be added preceding the page number in the uri to make it more readable.
        */

        global $single;
        if ($single) global $name, $p, $posts;

        // Can also put settings in an ini file. Make sure if you use an ini file that its valid!
        if (file_exists('wp-content/jp-bct/jp-bct.ini')) extract(parse_ini_file('wp-content/jp-bct/jp-bct.ini')); // For auto install additional files should be here.

        if (isset($_GET['debug'])) $debug = TRUE; // You can display debug output easy.


        // FORMAT INPUT

        // Get and clean the URI.
        $uri = html_entity_decode(rawurldecode(strtolower($_SERVER['REQUEST_URI']))); // To the maxxx

        // Trim $root from the start of the URI.
        $uri = substr($uri,strlen($root));

        // If there is a page .php that is not index you'll want that, but you wont want the ext.
        if (strrpos($uri,'.')) $uri = substr($uri,0,strrpos($uri,'.'));

        // You don't want index only.
        $uri = preg_replace('/index$/','',$uri);

        // Clear out any query crap (if a file wasnt specified).
        $uri = preg_replace('/\?.*/','',$uri);

        // Remove slashes from the start and end.
        $uri = ltrim($uri,'/');

        $uri = rtrim($uri,'/');

        // Possible to improve the above script some time. Also possible the above still have a few bugs in situations I haven't thought of.

        // ==== If matches structure that has article title / is single
        // replace last elemtnt or if last element is numberic replace second last element with article title.



        ($uri != '') ? $elements = explode('/', $uri) : $counter = 0; // If the uri is not empty explode it.

        if ($elements) $counter = count($elements); // If it was exploded count the number of elements it produced.

        echo '<!-- jp_bct: uri:"'.$uri.'" - counter:"'.$counter.'" -->'; // General debug - always people in situations I haven't thought of will have some debug. Probally pointless but you know.

        if ($debug) {
                echo 'Debug:<br />Cleaned URI:'.$uri.'<br />Counter: '.$counter.'<br />Exploded: ';
                print_r($elements);
        }



        // Only show home if showhome is set or there are links in the bct.
        //      I think it would be possible to improve this section with a bit of reworking, however the current set-up seems to work fine for the moment.
        if (($showhome) and ($counter == 0)) {

                $output = $before;
                $output .= str_replace('%name%',$homename,$current);
                $output .= $after;

                echo $output . "\n";

                return;

        } elseif ($counter > 0) {

                if ($single) { // Replace slug name with real article title.

                        // Check for $name and $p (post id)

                        if ($name) { // I dont know how else you call an individual post other than via id($p) or searching and returning an exact match. I know you can browse a date that has only one item in it but I'll look into that later.

                                // I don't know much about paged articles so I'm not sure how to handle a paged situation, however I think this should work fine.
                                if (!is_numeric($elements[$counter-1])) {
                                        $elements[$counter-1] = $posts[0]->post_title;
                                } else {
                                        $elements[$counter-2] = $posts[0]->post_title;
                                        $elements[$counter-1] = $pagedtext.$elements[$counter-1]; // To make the bct more readable.
                                }

                                /* Debug Stuff
                                echo $elements[$counter-1];
                                echo '<!--';
                                print_r($posts);
                                echo '-->';
                                */

                        }

                        // Problem: If you search and it returns an exact match your view as if single however $single is not set! - I'm going to ignore this for the moment.

                }

                $output = $before;

                $linkname = $homename;
                $linkurl = $root;
                $output .= jp_getcrumb($eachlink,$divider,array('name'=>$linkname,'url'=>$linkurl)); // Home link

                for ($i=0; $i<$counter; $i++)
                {

                        $link = $elements[$i];
                        $linkname = str_replace('-',' ',ucfirst($link));

                        if ($i == ($counter-1)) {

                                $crumb = str_replace('%name%',$linkname,$current);

                        } else {

                                $linkurl = $linkurl . $link . '/';

                                $crumb = jp_getcrumb($eachlink,$divider,array('name'=>$linkname,'url'=>$linkurl));

                        }

                        $output .= $crumb;

                }

                $output .= $after;

                echo $output . "\n";

                return;

        }

}



function jp_getcrumb($eachlink,$divider,$data) // For use by jp_bct() only.
{

        $elements = array('name','url');

        $return = $eachlink;

        foreach ($elements as $element)
        {
                $replace = 'link'.$element;
                $return = str_replace('%'.$element.'%',$data[$element],$return);
        }

        if ($divider) $return .= $divider;

        return $return;

}

?>