2 /********************************************************************************
3 * include/philter.inc.php : Philter base class
4 * -----------------------
6 * This file is part of the philter distribution
7 * Copyright: See COPYING files that comes with this distribution
8 ********************************************************************************/
10 require_once("include/core.inc.php");
12 function i18n($_index) { global $philter; echo $philter->i18n($_index); }
13 function _i18n($_index) { global $philter; return $philter->i18n($_index); }
14 function bd() { global $philter; return ($philter->is_advanced() ?
'tmp_' : ''); }
16 /** Philter base configuration class
17 * This is the base class of Philter.
20 /** philter configuration.
29 $this->config
= array(
30 'db' => array('host', 'name', 'user', 'pwd', 'link'),
31 'path' => array('procmail', 'spool'),
32 'match_plugins' => array(),
33 'action_plugins' => array(),
34 'global_plugins' => array(),
40 function is_advanced() { return isset($_SESSION['philter_adv']); }
41 function set_advanced() { $_SESSION['philter_adv'] = true
; }
42 function del_advanced() { unset($_SESSION['philter_adv']); }
44 /** returns the i18n string
45 * @param $_index the index of the string
46 * @returns the string or false
48 function i18n($_index) {
49 if(isset($this->config
['i18n'][$_index]))
50 return $this->config
['i18n'][$_index];
54 /** returns the error.
55 * @return the error string
61 /** sets the error string.
64 function set_error($_err) {
68 /** returns the database persistent connection link.
69 * it's a shortname for $this->config['db']['link']
70 * @returns a mysql resource
72 function link() { return $this->config
['db']['link']; }
74 /** init the link to the database */
76 $this->config
['db']['link'] =
78 $this->config
['db']['host'],
79 $this->config
['db']['user'],
80 $this->config
['db']['pass']
82 mysql_select_db($this->config
['db']['name'], $this->link());
85 /** function that writes the procmailrc.
86 * @param &$procmail the string containing the procmail filter
87 * @param $filename the base filename of the procmailrc filter
88 * @return true if all is ok
90 function write_procmailrc(&$procmail, $filename) {
91 $file = $this->config
['path']['spool']."/".$filename;
92 $f = fopen($file.".tmp", "w");
93 fwrite($f, $procmail, strlen($procmail));
95 rename($file.".tmp", $file);
99 /** function that register a new Plugin
100 * @param $_plugin an instance of the plugin
101 * @return true if all is ok, read error() else
103 function register_plugin($_plugin) {
104 if($rtti = $_plugin->rtti()) {
105 if(is_subclass_of($_plugin, 'matchplugin')) {
106 if($_plugin->is_global()) {
107 $this->err
= "Philter::register_plugin : this plugin is global";
110 $index = 'match_plugins';
111 } elseif(is_subclass_of($_plugin, 'actionplugin')) {
112 $index = 'action_plugins';
114 $this->err
= "Philter::register_plugin : bad object";
118 if(isset($this->config
[$index][$rtti])) {
119 $this->err
= "Philter::register_plugin : a plugin is already registerd";
123 $this->config
[$index][$rtti] = $_plugin;
127 $this->err
= "Philter::register_plugin : rtti is 0, this is an abstract class";
131 /** function that register plugin as a global rule
132 * @param $_plugin an instance of the plugin
133 * @return true if all is ok, read error() else
135 function register_global_plugin($_plugin) {
136 if($rtti = $_plugin->rtti()) {
137 if(!is_subclass_of($_plugin, 'matchplugin')) {
138 $this->err
= "Philter::register_global_plugin : bad object";
142 if(!$_plugin->is_global()) {
143 $this->err
= "Philter::register_global_plugin : this plugin is not global";
147 if(isset($this->config
['global_plugins'][$rtti])) {
148 $this->err
= "Philter::register_global_plugin : a plugin is already registerd";
152 $this->config
['global_plugins'][$rtti] = $_plugin;
156 $this->err
= "Philter::register_global_plugin : rtti is 0, this is an abstract class";
161 /********************************************************************************
163 * vim: set expandtab shiftwidth=4 tabstop=4 softtabstop=4 textwidth=100:
164 ********************************************************************************/