71894c367bbdfef19023ca93ea686bc3c9065fd9
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 ""; }
30 // function sql_clean($_uid, $_rid) { }
32 /** stores the data to the mysql database
33 * @param $_uid the id of the filter
34 * @param $_rid the id of the rule
35 * @param $_data an array or a string containing all the sql data row for this plugin
38 function sql_store($_uid, $_rid, $_data) { }
40 /** converts the row of the mysql SELECT into a shorter and usable $data
41 * @param &$sql a reference on the sql row
42 * @return an array with the shorter datas
44 function sql_to_data(&$sql) {
45 if(preg_match('/^a:\d+:\{.*\}$/', $sql['data']))
46 return unserialize($sql['data']);
48 return array($sql['pid'], $sql['data']);
51 /** gives the procmailrc instruction of the data associated with this Plugin
52 * @param $_data an array or a string containing all the sql data row for this plugin
53 * @return the procmailrc string
55 function to_string($_data) { return ""; }
57 /** returns the function that creates the form in javascript (@see FwdPlugin for one example).
58 * @return the string containing the javascript code
60 function to_js() { return ""; }
63 class ActionPlugin
extends Plugin
{
65 function ActionPlugin() { $this->Plugin(); }
67 function sql_store($_uid, $_rid, $_data) {
68 if(count($_data) == 2)
71 $data = serialize($_data);
72 mysql_query("INSERT INTO ".bd()."actions SET uid='$_uid',rid='$_rid',pid='{$_data[0]}',data='$data'");
76 class MatchPlugin
extends Plugin
{
77 /** true if the plugin is used as global */
81 function MatchPlugin($_glob) {
86 function sql_store($_uid, $_rid, $_data) {
87 if(count($_data) == 2)
90 $data = serialize($_data);
92 mysql_query("INSERT INTO ".bd()."matches SET uid='$_uid',rid='0',pid='{$_data[0]}',data='$data'");
94 mysql_query("INSERT INTO ".bd()."matches SET uid='$_uid',rid='$_rid',pid='{$_data[0]}',data='$data'");
97 /** true if the plugin is used as global rule
98 * overload with (return false) if the plugin can not be used as a global rule
99 * overload with (return true) if the plugin can not be used as a normal rule
100 * @return true if usable as a global rule, false else
102 function is_global() { return $this->global; }
105 /********************************************************************************
107 * vim: set expandtab shiftwidth=4 tabstop=4 softtabstop=4 textwidth=100:
108 ********************************************************************************/