TextLinkAds | The Leader in Text Link Search Engine Optimization

Serendipity Installation Instructions

Signup and Site Submission Required to fully install plugin.

Create a file named local_57784.xml that is writable by the web server. The file should be blank and it should be located in the same directory as the script below. On unix you would CHMOD 666 on windows you will need to access your custom control panel to set the permissions or contact your hosting company.
Create a folder named "/plugins/serendipity_event_textlinkads/" in your root Serendipity directory. Now copy the code below and save it as "serendipity_event_textlinkads.php" in that directory (/plugins/serendipity_event_textlinkads/serendipity_event_textlinkads.php).
After the file has been uploaded, you will see the plugin appear in your Serendipity plugin manager. Now you simply need to use the smarty code {serendipity_hookPlugin hook="external_service_textlinkads" hookAll="true"} to place the ads.

Package Info

Embeds Text Link Ads advertisements into your page. You need to edit the Smarty .tpl file of your template to indicate where the ad should be placed, otherwise it will not appear on your site. Use this Smarty code to place the ad: {serendipity_hookPlugin hook="external_service_textlinkads" hookAll="true"}

Version 2.0.2

Ad Code

<?php

// Probe for a language include with constants. Still include defines later on, if some constants were missing
$probelang = dirname(__FILE__) . '/' . $serendipity['charset'] . 'lang_' . $serendipity['lang'] . '.inc.php';
if (file_exists($probelang)) {
    include $probelang;
}

@define('PLUGIN_EVENT_TEXTLINKADS_TITLE', 'Text Link Ads');
@define('PLUGIN_EVENT_TEXTLINKADS_DESC', 'Embeds Text Link Ads advertisements into your page. You need to edit the Smarty .tpl file of your template to indicate where the ad should be placed, otherwise it will not appear on your site. Use this Smarty code to place the ad: {serendipity_hookPlugin hook="external_service_textlinkads" hookAll="true"}');
@define('PLUGIN_EVENT_TEXTLINKADS_HTMLID', '57784');
@define('PLUGIN_EVENT_TEXTLINKADS_XMLFILENAME', 'local_57784.xml');

class serendipity_event_textlinkads extends serendipity_event
{
    var $title = PLUGIN_EVENT_TEXTLINKADS_TITLE;

    function introspect(&$propbag)
    {
        global $serendipity;

        $propbag->add('name', PLUGIN_EVENT_TEXTLINKADS_TITLE);
        $propbag->add('description', PLUGIN_EVENT_TEXTLINKADS_DESC);
        $propbag->add('stackable', true);
        $propbag->add('author', 'TLA Plugins');
        $propbag->add('requirements', array('serendipity' => '0.8', 'smarty' => '2.6.7', 'php' => '4.1.0'));
        $propbag->add('groups', array('EXTERNAL_SERVICES'));
        $propbag->add('version', '2.0.2');
        $propbag->add('configuration', array('htmlid', 'xmlfilename'));
        $propbag->add('event_hooks', array('css' => true, 'external_service_textlinkads' => true));
    }

    function introspect_config_item($name, &$propbag)
    {
        switch($name) {
            case 'htmlid':
                $propbag->add('type', 'string');
                $propbag->add('name', PLUGIN_EVENT_TEXTLINKADS_HTMLID);
                $propbag->add('description', '');
                $propbag->add('default', '57784');
                break;

            case 'xmlfilename':
                $propbag->add('type', 'string');
                $propbag->add('name', PLUGIN_EVENT_TEXTLINKADS_XMLFILENAME);
                $propbag->add('description', '');
                $propbag->add('default', 'local_57784.xml');
                break;

            default:
                return false;
        }

        return true;
    }

    /* BEGIN FOREIGN CODE */
    function tla_ads()
    {
        global $serendipity;

        // Number of seconds before connection to XML times out
        // (This can be left the way it is)
        $CONNECTION_TIMEOUT = 10;

        // Local file to store XML
        // This file MUST be writable by web server
        // You should create a blank file and CHMOD it to 666
        $LOCAL_FILENAME = $serendipity['serendipityPath'] . $this->get_config('xmlfilename');

        if (!file_exists($LOCAL_FILENAME)) {
            @touch($LOCAL_FILENAME);
            @chmod($LOCAL_FILENAME, 0666);
        }

        if (!file_exists($LOCAL_FILENAME)) {
            echo "Script error: $LOCAL_FILENAME does not exist. Please create a blank file named $LOCAL_FILENAME.";
            return false;
        }

        if (!is_writable($LOCAL_FILENAME)) {
            echo "Script error: $LOCAL_FILENAME is not writable. Please set write permissions on $LOCAL_FILENAME.";
            return false;
        }

        if (filemtime($LOCAL_FILENAME) < (time() - 3600) || filesize($LOCAL_FILENAME) < 3) {
            $url = 'http://www.text-link-ads.com/xml.php?k=XXXXXXJOINtextlinkadsFORKEYXXXXXX&l=serendipity-tla-2.0.2';

            if (function_exists('json_decode') && is_array(json_decode('{"a":1}', true))) {
                $url .= '&f=json';
            }
            
            $this->tla_updateLocal($url, $LOCAL_FILENAME, $CONNECTION_TIMEOUT);
        }

        $xml = $this->tla_getLocal($LOCAL_FILENAME);
        $links = $this->tla_decode($xml);

        if ($links && is_array($links)) {
            echo "\n<ul>\n";
            foreach ($links as $link) {
                if (isset($link['PostID']) && $link['PostID'] > 0) {
                    continue;
                }

                echo "<li>" . ($link['BeforeText'] ? $link['BeforeText'] . ' ' : '') . '<a href="' . $link['URL'] . '">' . $link['Text'] . '</a>' . ($link['AfterText'] ? ' ' . $link['AfterText'] : '') . "</li>\n";
            }
            echo '</ul>';
        }
    }

    function tla_updateLocal($url, $file, $time_out)
    {
        touch($file);

        if ($xml = $this->file_get_contents_tla($url, $time_out)) {
            if ($handle = fopen($file, 'w')) {
                fwrite($handle, $xml);
                fclose($handle);
            }
        }
    }

    function tla_getLocal($file)
    {
        if (function_exists('file_get_contents')) {
            return file_get_contents($file);
        }
    
        $contents = '';
        if ($handle = fopen($file, 'r')) {
            $contents = fread($handle, filesize($file) + 1);
            fclose($handle);
        }

        return $contents;
    }

    function file_get_contents_tla($url, $time_out)
    {
        $result = '';
        $url = parse_url($url);

        if ($handle = @fsockopen($url['host'], 80)) {
            if (function_exists('socket_set_timeout')) {
                socket_set_timeout($handle, $time_out, 0);
            } else if (function_exists('stream_set_timeout')) {
                stream_set_timeout($handle, $time_out, 0);
            }

            fwrite($handle, 'GET ' . $url['path'] . '?' . $url['query'] . " HTTP/1.0\r\nHost: " . $url['host'] . "\r\nConnection: Close\r\n\r\n");
            while (!feof($handle)) {
                $result .= @fread($handle, 40960);
            }
            fclose($handle);
        }

        $return = '';
        $capture = false;
        foreach (explode("\n", $result) as $line) {
            $char = substr(trim($line), 0, 1);
            if ($char == '[' || $char == '<') {
                $capture = true;
            }

            if ($capture) {
                $return .= $line . "\n";
            }
        }

        return $return;
    }

    function tla_decode($str)
    {
        if (!function_exists('html_entity_decode')) {
            function html_entity_decode($string)
            {
               // replace numeric entities
               $string = preg_replace('~&#x([0-9a-f]+);~ei', 'chr(hexdec("\1"))', $string);
               $string = preg_replace('~&#([0-9]+);~e', 'chr(\1)', $string);
               // replace literal entities
               $trans_tbl = get_html_translation_table(HTML_ENTITIES);
               $trans_tbl = array_flip($trans_tbl);
               return strtr($string, $trans_tbl);
            }
        }

        if (substr($str, 0, 1) == '[') {
            $arr = json_decode($str, true);
            foreach ($arr as $i => $a) {
                foreach ($a as $k => $v) {
                    $arr[$i][$k] = $this->tla_decode_str($v);
                }
            }

            return $arr;
        }

        $out = '';
        $retarr = '';

        preg_match_all("/<(.*?)>(.*?)</", $str, $out, PREG_SET_ORDER);
        $n = 0;
        while (isset($out[$n])) {
            $retarr[$out[$n][1]][] = $this->tla_decode_str($out[$n][0]);
            $n++;
        }

        if (!$retarr) {
            return false;
        }

        $arr = array();
        $count = count($retarr['URL']);
        for ($i = 0; $i < $count; $i++) {
            $arr[] = array(
                'BeforeText' => $retarr['BeforeText'][$i],
                'URL' => $retarr['URL'][$i],
                'Text' => $retarr['Text'][$i],
                'AfterText' => $retarr['AfterText'][$i],
            );
        }

        return $arr;
    }

    function tla_decode_str($str)
    {
        $search_ar = array('&#60;', '&#62;', '&#34;');
        $replace_ar = array('<', '>', '"');
        return str_replace($search_ar, $replace_ar, html_entity_decode(strip_tags($str)));
    }
    /* END FOREIGN CODE */

    function generate_content(&$title)
    {
        $title = $this->title;
    }

    function event_hook($event, &$bag, &$eventData, $addData = null)
    {
        global $serendipity;

        $hooks = &$bag->get('event_hooks');

        if (isset($hooks[$event])) {
            switch($event) {
                case 'css':
                    $id = $this->get_config('htmlid');
                    return true;
                    break;

                case 'external_service_textlinkads':
                    $this->tla_ads();
                    return true;
                    break;

                default:
                    return false;
                    break;
            }
        } else {
            return false;
        }
    }
}
?>