base-tags.inc.php

Go to the documentation of this file.

<?
abstract class BaseTags extends MyModule
{
    protected $tagTable;

    protected $joinerTable;
    
    public $plural;

    public $objectId = 0;

    public static $cachePopularTags = true;

    public static $popularTagsCacheLife = 3600;
    
    public static $cacheRelatedTags = true;

    public static $relatedTagsCacheLife = 3600;

    public static $weightStyles = array(
        'font-size: 35px;',
        'font-size: 25px;',
        'font-size: 20px;', 
        'font-side: 16px;',
        'font-size: 11px;'
    );

    public function __construct($id, $tagTable, $joinerTable)
    {
        $this->english = 'tag';
        $this->plural = 'tags';
        
        $this->tagTable = $tagTable;
        $this->joinerTable = $joinerTable;
        $this->objectId = (int)$id;
    } 

    public function getPagesXml()
    {
        $xml = parent::getPagesXml();
        $xml .= <<<XML
            <page name="view">
                <param name="tag" regex="/^\w*$/" required="1" />
            </page>
XML;
        return $xml;
     }

    public function initViewPage()
    {
        $tag = $this->params('tag');

        if (!$this->findTag($tag))
            throw new PageError("The tag $tag does not exist.");

        $this->pageTitle = self::prettyTag($tag);

        //we wanna cache the view page
        $this->doCachePage = true;
    }

    public function drawViewPage()
    {
        $this->drawRelatedTags();
    }

    public function drawRelatedTags()
    {
        echo "<h3>Related " . ucfirst($this->plural) . "</h3>\n";
        echo "<p>" . $this->getRelatedTagsList($this->params('tag')) . "</p>";
    }

    public function initMainPage()
    {
        $this->pageTitle = 'Popular ' . ucfirst($this->plural);

        $this->doCachePage = true;
    }

    public function drawMainPage()
    {
        echo "<p>" . $this->getWeightedPopularTagsList() . "</p>";
    }

    public static function cleanTag($tag)
    {
        //trip it!
        $tag = trim($tag);

        //make all whitespace be underscores.
        $tag = preg_replace("/\s/", "_", $tag);
        
        //anything not a 'word' character (alphanumeric, underscore) gets removed.
        $tag = preg_replace("/\W/", "", $tag);

        return $tag;
    }

    public static function prettyTag($tag)
    {
        return str_replace("_", " ", $tag);
    }

    public function addTag($tag)
    {
        //clean it.
        $tag = self::cleanTag($tag);

        //look for it.
        $id = $this->findTag($tag);
        
        //if we didnt get it...
        if (!$id)
            $id = $this->insertTag($tag);

        //give them the id.
        return $id;
    }

    protected function insertTag($tag)
    {
        $tag = self::cleanTag($tag);

        //insert it into the db.
        $id = dbExecute("
            INSERT INTO $this->tagTable
                (tag)
            VALUES
                ('$tag')
        ", true);

        return $id;
    }

    public function deleteTag($tag)
    {
        //clean it...
        $tag = self::cleanTag($tag);

        //delete it.
        $rows = dbExecute("
            DELETE FROM $this->tagTable
            WHERE tag = '$tag'
            LIMIT 1
        ", -1);

        return $rows;
    }

    public function findTag($tag)
    {
        //clean it...
        $tag = self::cleanTag($tag);
    
        //search it.
        $rs = dbQuery("
            SELECT id
            FROM $this->tagTable
            WHERE tag = '$tag'
        ");

        //get it.
        if (dbGetNumRows($rs))
        {
            $ar = dbFetchAssoc($rs);
            return $ar['id'];
        }
            
        //oops, no id!
        return false;
    }

    public function getTags()
    {
        $tags = array();

        //only do it if we have an id.
        if ($this->objectId)
        {
            $where = $this->getTagsWhere();
            
            //do our query.
            $rs = dbQuery("
                SELECT t.id, t.tag
                FROM $this->tagTable t
                INNER JOIN $this->joinerTable j
                    ON t.id = j.tag_id
                $where
                ORDER BY t.tag
            ");

            //fetch it!
            while ($ar = dbFetchAssoc($rs))
                $tags[$ar['id']] = $ar['tag'];
        }

        //send them home.
        return $tags;
    }

    function delete()
    {
        dbExecute("
            DELETE FROM $this->joinerTable WHERE object_id = $this->objectId 
        ");
    }

    protected function getTagsWhere()
    {
        return "WHERE j.object_id = '$this->objectId'";
    }

    public function getPrettyTags()
    {
        $tags = $this->getTags();

        foreach ($tags AS &$tag)
            $tag = self::prettyTag($tag);

        return $tags;
    }

    public function getObjectsSql($tagId)
    {
        //our query
        return "
            SELECT distinct(z.object_id)
            FROM $this->joinerTable z
            WHERE z.tag_id = '$tagId'
        ";
    }

    public function getPopularTags($count = 30)
    {
        //heres our lookup sql.
        $popularSql = "
            SELECT t.tag, count(j.object_id) AS popularity
            FROM $this->tagTable t
            INNER JOIN $this->joinerTable j
                ON t.id = j.tag_id
            GROUP BY t.tag
            ORDER BY popularity DESC
            LIMIT $count
        ";
        $key = "BaseJumper:tags:popular:" . sha1($popularSql);

        //try the cache.
        if (self::$cachePopularTags)
            $tags = CacheBot::get($key, self::$popularTagsCacheLife);
    
        //did we get them?
        if (!$tags)
        {
            $tags = array();
            
            //do our query...
            $rs = dbQuery($popularSql);
            
            //get our array.
            while ($ar = dbFetchAssoc($rs))
                $tags[] = $ar['tag'];

            //save it back to the cache.
            if (self::$cachePopularTags)
                CacheBot::set($key, $tags, self::$popularTagsCacheLife);
        }

        //send it home.
        return $tags;
    }

    public function getPopularTagsList($count = 60)
    {
        //inital stuff.
        $tags = $this->getPopularTags($count);

        //link up!
        $links = $this->getLinkedTags($tags);

        //get 'er done.
        return implode(", ", $links);
    }
    
    public function getWeightedPopularTagsList($count = 100)
    {
        //inital stuff.
        $tags = $this->getPopularTags($count);

        //link up!
        $links = $this->getLinkedTags($tags);

        //loop thru and get the weighted stuff
        $i = 0;
        foreach ($links AS $link)
        {
            if ($i < 5)
            {
                $class = "WeightedTagHighest";
                $style = self::$weightStyles[0];
            }
            else if ($i < 20)
            {
                $class = "WeightedTagHigh";
                $style = self::$weightStyles[1];
            }
            else if ($i < 40)
            {
                $class = "WeightedTagMedium";
                $style = self::$weightStyles[2];
            }
            else if ($i < 65)
            {
                $class = "WeightedTagLow";
                $style = self::$weightStyles[3];
            }
            else
            {
                $class = "WeightedTagLowest";
                $style = self::$weightStyles[4];
            }
            
            $weighted[] = "<span class=\"$class\" style=\"$style\">$link</span>";

            $i++;
        }

        //get 'er done.
        return implode(" ", $weighted);
    }

    protected function getTagFieldParams()
    {
        return array(
            'id' => strtolower(get_class($this)),
            'value' => implode(", ", $this->getPrettyTags()),
            'title' => "Enter $this->plural<br/>(separated by commas)",
            'class' => 'BaseTags',
            'width' => '100%',
            'height' => '100px',
        );
    }
    
    protected function getPopularFieldParams()
    {
        return array(
            'title' => "Popular $this->plural<br/>(click to add)",
            'text' => $this->getFormPopularCloud()
        );
    }

    public function updateTagsForm($form)
    {
        //get our data.
        $data = $form->getData(strtolower(get_class($this)));
        $dataRs = explode(",", $data);

        //pass it off to our updater.
        $this->updateTags($dataRs);
    }

    public function updateTags($data)
    {
        //initialization
        $old = $this->getTags();
        $newTags = array();
        $oldTags = array();
        
        //clean them.
        if (count($old))
            foreach ($old AS $tag)
                $oldTags[] = self::cleanTag($tag);
        if (count($data))
            foreach ($data AS $tag)
                $newTags[] = self::cleanTag($tag);

        //add the news ones!
        if (count($newTags))
        {
            foreach ($newTags AS $tag)
            {
                if (!in_array($tag, $oldTags))
                    $this->addTagLink($tag);
            }
        }
        
        //delete the old tags...
        if (count($oldTags))
        {
            foreach ($oldTags AS $tag)
            {
                if (!in_array($tag, $newTags))
                    $this->removeTagLink($tag);
            }
        }
    }

    public function addTagLink($tag)
    {
        $tag = self::cleanTag($tag);

        //is it a tag?
        if ($tag != '')
        {
            //find/create tag.
            $tagId = $this->addTag($tag);
            
            //insert it.
            if ($tagId)
                $this->addTagLinkDb($tagId);
        }
    }

    protected function addTagLinkDb($tagId)
    {
        dbExecute("
            INSERT INTO $this->joinerTable
                (tag_id, object_id)
            VALUES
                ('$tagId', '$this->objectId')
        ");
    }

    public function removeTagLink($tag)
    {
        //get our tag id.
        $tagId = $this->findTag($tag);
        
        //delete it.
        if ($tagId)
            $this->removeTagLinkDb($tagId);
    }
    
    public function removeTagLinkDb($tagId)
    {
        dbExecute("
            DELETE FROM $this->joinerTable
            WHERE tag_id = '$tagId'
                AND object_id = '$this->objectId'
        ");
    }

    public function getRelatedTags($tag)
    {
        //get our tag and object.
        $tagId = $this->findTag($tag);

        $sql = "
            SELECT t.tag, count(t.tag) AS popularity
            FROM $this->tagTable t
            INNER JOIN $this->joinerTable j
                ON t.id = j.tag_id
            WHERE j.object_id IN (" . $this->getObjectsSql($tagId) . ")
                AND j.tag_id != '$tagId'
            GROUP BY t.tag
            ORDER BY popularity DESC, t.tag
            LIMIT 30
        ";
        $key = "BaseJumper:tags:popular:" . sha1($sql);

        //try the cache.
        if (self::$cacheRelatedTags)
            $tags = CacheBot::get($key, self::$relatedTagsCacheLife);
    
        //did we get them?
        if (!$tags)
        {
            //init.
            $tags = array();
        
            //did we get it?
            if ($tagId)
            {
                //do our query to find what tags the other objects that use our tag
                $tagRs = dbQuery($sql);

                //get the tags.
                while ($tagAr = dbFetchAssoc($tagRs))
                    $tags[] = $tagAr['tag'];
                
                //save it!
                if (self::$cacheRelatedTags)
                    CacheBot::set($key, $tags, self::$relatedTagsCacheLife);
            }
        }

        return $tags;
    }

    public function getLinkedTags($tags)
    {
        $links = array();

        if (count($tags))
        {
            //create links.
            foreach ($tags AS $tag)
                $links[] = $this->getLink(".view?tag=$tag", self::prettyTag($tag));
        }

        return $links;
    }

    public function getTagList($tags = null)
    {
        //inital stuff.
        if ($tags === null)
            $tags = $this->getTags();

        //link up!
        $links = $this->getLinkedTags($tags);

        //get 'er done.
        return implode(", ", $links);
    }
    
    public function getRelatedTagsList($tag)
    {
        $tags = $this->getRelatedTags($tag);

        //link up!
        $links = $this->getLinkedTags($tags);

        //get 'er done.
        return implode(", ", $links);
    }

    protected function getFormPopularCloud()
    {
        //get our tags.
        $tags = $this->getTags();
        $popular = $this->getPopularTags();

        //get the ones that we arent using already.
        $usable = array_diff($popular, $tags);

        //create our links..
        if (count($usable))
        {
            foreach ($usable AS $tag)
                $links[] = "<a href=\"#\" onClick=\"return addTagToForm('" . strtolower(get_class($this)) . "', '" .
                    self::prettyTag($tag) . "');\">" . self::prettyTag($tag) . "</a>";
        
            return implode(", ", $links);
        }

        return "No popular $this->plural found.";
    }
    
    public function addTagField($form)
    {
        $form->add('TextAreaField', strtolower(get_class($this)), $this->getTagFieldParams()); 
    }

    public function addPopularTagField($form)
    {
        $this->needsJs("lib/js/tags.js");
        $form->add('LabelField', 'popular_' . strtolower(get_class($this)), $this->getPopularFieldParams());
    }

    public function addTagFields($form)
    {
        $this->addTagField($form);
        $this->addPopularTagField($form);
    }
    
    public function getCreateTableSql()
    {
        $tagFields = implode(",\n", $this->getTagFieldsArray());
        $tagIndexes = implode(",\n", $this->getTagIndexesArray());
        $sql = "CREATE TABLE IF NOT EXISTS $this->tagTable\n(\n$tagFields,\n$tagIndexes\n);\n";
        
        $joinerFields = implode(",\n", $this->getJoinerFieldsArray());
        $joinerIndexes = implode(",\n", $this->getJoinerIndexesArray());
        $sql .= "CREATE TABLE IF NOT EXISTS $this->joinerTable\n(\n$joinerFields,\n$joinerIndexes\n);\n";

        return $sql;
    }

    public function getTagFieldsArray()
    {
        $fields = array(
            "id" => "id INT(11) not null auto_increment",
            "tag" => "tag varchar(64) default '' not null"
        );

        return $fields;
    }

    public function getTagIndexesArray()
    {
        $fields = array(
            "id" => "PRIMARY KEY(id)",
            "tag" => "KEY (tag)"
        );

        return $fields;
    }
    
    public function getJoinerFieldsArray()
    {
        $fields = array(
            "tag_id" => "tag_id INT(11) not null default 0",
            "object_id" => "object_id INT(11) not null default 0",
        );

        return $fields;
    }

    public function getJoinerIndexesArray()
    {
        $fields = array(
            "tag_id" => "KEY(tag_id)",
            "object_id" => "KEY(object_id)",
        );

        return $fields;
    }
}
?>

---