| 1 | <?php |
| 2 | /******************************************************************************** |
| 3 | * include/philter.inc.php : Philter base class |
| 4 | * ----------------------- |
| 5 | * |
| 6 | * This file is part of the philter distribution |
| 7 | * Copyright: See COPYING files that comes with this distribution |
| 8 | ********************************************************************************/ |
| 9 | |
| 10 | require_once("include/core.inc.php"); |
| 11 | |
| 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_' : ''); } |
| 15 | |
| 16 | /** Philter base configuration class |
| 17 | * This is the base class of Philter. |
| 18 | */ |
| 19 | class Philter { |
| 20 | /** philter configuration. |
| 21 | * @see config.inc.php |
| 22 | */ |
| 23 | var $config; |
| 24 | /** error string */ |
| 25 | var $err; |
| 26 | |
| 27 | /** constructor */ |
| 28 | function Philter() { |
| 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(), |
| 35 | 'i18n' => array() |
| 36 | ); |
| 37 | $this->err = ""; |
| 38 | } |
| 39 | |
| 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']); } |
| 43 | |
| 44 | /** returns the i18n string |
| 45 | * @param $_index the index of the string |
| 46 | * @returns the string or false |
| 47 | */ |
| 48 | function i18n($_index) { |
| 49 | if(isset($this->config['i18n'][$_index])) |
| 50 | return $this->config['i18n'][$_index]; |
| 51 | return false; |
| 52 | } |
| 53 | |
| 54 | /** returns the error. |
| 55 | * @return the error string |
| 56 | */ |
| 57 | function error() { |
| 58 | return $this->err; |
| 59 | } |
| 60 | |
| 61 | /** sets the error string. |
| 62 | * @return nothing |
| 63 | */ |
| 64 | function set_error($_err) { |
| 65 | $this->err = $_err; |
| 66 | } |
| 67 | |
| 68 | /** returns the database persistent connection link. |
| 69 | * it's a shortname for $this->config['db']['link'] |
| 70 | * @returns a mysql resource |
| 71 | */ |
| 72 | function link() { return $this->config['db']['link']; } |
| 73 | |
| 74 | /** init the link to the database */ |
| 75 | function pconnect() { |
| 76 | $this->config['db']['link'] = |
| 77 | mysql_pconnect( |
| 78 | $this->config['db']['host'], |
| 79 | $this->config['db']['user'], |
| 80 | $this->config['db']['pass'] |
| 81 | ); |
| 82 | mysql_select_db($this->config['db']['name'], $this->link()); |
| 83 | } |
| 84 | |
| 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 |
| 89 | */ |
| 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)); |
| 94 | fclose($f); |
| 95 | rename($file.".tmp", $file); |
| 96 | return true; |
| 97 | } |
| 98 | |
| 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 |
| 102 | */ |
| 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"; |
| 108 | return false; |
| 109 | } |
| 110 | $index = 'match_plugins'; |
| 111 | } elseif(is_subclass_of($_plugin, 'actionplugin')) { |
| 112 | $index = 'action_plugins'; |
| 113 | } else { |
| 114 | $this->err = "Philter::register_plugin : bad object"; |
| 115 | return false; |
| 116 | } |
| 117 | |
| 118 | if(isset($this->config[$index][$rtti])) { |
| 119 | $this->err = "Philter::register_plugin : a plugin is already registerd"; |
| 120 | return false; |
| 121 | } |
| 122 | |
| 123 | $this->config[$index][$rtti] = $_plugin; |
| 124 | return true; |
| 125 | } |
| 126 | |
| 127 | $this->err = "Philter::register_plugin : rtti is 0, this is an abstract class"; |
| 128 | return false; |
| 129 | } |
| 130 | |
| 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 |
| 134 | */ |
| 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"; |
| 139 | return false; |
| 140 | } |
| 141 | |
| 142 | if(!$_plugin->is_global()) { |
| 143 | $this->err = "Philter::register_global_plugin : this plugin is not global"; |
| 144 | return false; |
| 145 | } |
| 146 | |
| 147 | if(isset($this->config['global_plugins'][$rtti])) { |
| 148 | $this->err = "Philter::register_global_plugin : a plugin is already registerd"; |
| 149 | return false; |
| 150 | } |
| 151 | |
| 152 | $this->config['global_plugins'][$rtti] = $_plugin; |
| 153 | return true; |
| 154 | } |
| 155 | |
| 156 | $this->err = "Philter::register_global_plugin : rtti is 0, this is an abstract class"; |
| 157 | return false; |
| 158 | } |
| 159 | } |
| 160 | |
| 161 | /******************************************************************************** |
| 162 | * $Id$ |
| 163 | * vim: set expandtab shiftwidth=4 tabstop=4 softtabstop=4 textwidth=100: |
| 164 | ********************************************************************************/ |
| 165 | ?> |