2 /********************************************************************************
3 * include/plugin.inc.php : The base class for each Plugin (action|match)
4 * ----------------------
6 * This file is part of the philter distribution
7 * Copyright: See COPYING files that comes with this distribution
8 ********************************************************************************/
16 * this function must return 0 if the class should not have any instance
17 * @returns the rtti of the object
19 function rtti() { return 0; }
21 /** name of the plugin (to pick a choice in a select).
22 * @return a string describing the plugin
24 function name() { return "abstract class !!"; }
26 /** gives the LEFT JOIN to add to the sql request to have all this plugin datas
27 * @return the LEFT JOIN string, "" if irrelevant
29 function sql_get() { return ""; }
31 function sql_clean($_uid, $_rid) { }
33 /** stores the data to the mysql database
34 * @param $_uid the id of the filter
35 * @param $_rid the id of the rule
36 * @param $_data an array or a string containing all the sql data row for this plugin
39 function sql_store($_uid, $_rid, $_data) { }
41 /** converts the row of the mysql SELECT into a shorter and usable $data
42 * @param &$sql a reference on the sql row
43 * @return an array with the shorter datas
45 function sql_to_data(&$sql) {
48 $res[] = $sql['data'];
52 /** gives the procmailrc instruction of the data associated with this Plugin
53 * @param $_data an array or a string containing all the sql data row for this plugin
54 * @return the procmailrc string
56 function to_string($_data) { return ""; }
58 /** returns the function that creates the form in javascript (@see FwdPlugin for one example).
59 * @return the string containing the javascript code
61 function to_js() { return ""; }
64 class ActionPlugin
extends Plugin
{
66 function ActionPlugin() { $this->Plugin(); }
68 function sql_store($_uid, $_rid, $_data) {
69 mysql_query("INSERT INTO actions SET uid='$_uid',rid='$_rid',pid='{$_data[0]}',data='{$_data[1]}'");
73 class MatchPlugin
extends Plugin
{
74 /** true if the plugin is used as global */
78 function MatchPlugin($_glob) {
83 function sql_store($_uid, $_rid, $_data) {
85 mysql_query("INSERT INTO matches SET uid='$_uid',rid='0',pid='{$_data[0]}',data='{$_data[1]}'");
87 mysql_query("INSERT INTO matches SET uid='$_uid',rid='$_rid',pid='{$_data[0]}',data='{$_data[1]}'");
90 /** true if the plugin is used as global rule
91 * overload with (return false) if the plugin can not be used as a global rule
92 * overload with (return true) if the plugin can not be used as a normal rule
93 * @return true if usable as a global rule, false else
95 function is_global() { return $this->global; }
98 /********************************************************************************
100 * vim: set expandtab shiftwidth=4 tabstop=4 softtabstop=4 textwidth=100:
101 ********************************************************************************/