<?php
/********************************************************************************
* include/plugin.inc.php : The base class for each Plugin (action|match)
* ----------------------
*
* This file is part of the philter distribution
* Copyright: See COPYING files that comes with this distribution
********************************************************************************/

class Plugin {
    /** constructor
     */
    function Plugin() { }

    /** runtime id.
     * this function must return 0 if the class should not have any instance
     * @returns the rtti of the object
     */
    function rtti() { return 0; }

    /** name of the plugin (to pick a choice in a select).
     * @return  a string describing the plugin
     */
    function name() { return "abstract class !!"; }

    /** gives the LEFT JOIN to add to the sql request to have all this plugin datas
     * @return  the LEFT JOIN string, "" if irrelevant
     */
    function sql_get() { return ""; }

    function sql_clean($_uid, $_rid) { }
    
    /** stores the data to the mysql database
     * @param   $_uid   the id of the filter
     * @param   $_rid   the id of the rule
     * @param   $_data  an array or a string containing all the sql data row for this plugin
     * @return  void
     */
    function sql_store($_uid, $_rid, $_data) { }
   
    /** converts the row of the mysql SELECT into a shorter and usable $data
     * @param   &$sql   a reference on the sql row
     * @return  an array with the shorter datas
     */
    function sql_to_data(&$sql) {
        $res = array();
        $res[] = $sql['pid'];
        $res[] = $sql['data'];
        return $res;
    }

    /** gives the procmailrc instruction of the data associated with this Plugin
     * @param   $_data  an array or a string containing all the sql data row for this plugin
     * @return  the procmailrc string
     */
    function to_string($_data) { return ""; }

    /** returns the function that creates the form in javascript (@see FwdPlugin for one example).
     * @return  the string containing the javascript code
     */
    function to_js() { return ""; }
}

class ActionPlugin extends Plugin {
    /** constructor */
    function ActionPlugin() { $this->Plugin(); }
    
    function sql_store($_uid, $_rid, $_data) {
        mysql_query("INSERT INTO actions SET uid='$_uid',rid='$_rid',pid='{$_data[0]}',data='{$_data[1]}'");
    }
}

class MatchPlugin extends Plugin {
    /** true if the plugin is used as global */
    var $global;

    /** constructor */
    function MatchPlugin($_glob) {
        $this->Plugin();
        $this->global=$_glob;
    }

    /** true if the plugin is used as global rule
     * overload with (return false) if the plugin can not be used as a global rule
     * overload with (return true) if the plugin can not be used as a normal rule
     * @return  true if usable as a global rule, false else
     */
    function is_global() { return $global; }
}

/********************************************************************************
* $Id$
* vim: set expandtab shiftwidth=4 tabstop=4 softtabstop=4 textwidth=100:
********************************************************************************/
?>