getmail_plugin.inc.php 5.06 KB
Newer Older
tbrehm's avatar
tbrehm committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
<?php

/*
Copyright (c) 2007, Till Brehm, projektfarm Gmbh
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
    * Neither the name of ISPConfig nor the names of its contributors
      may be used to endorse or promote products derived from this software without
      specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

class getmail_plugin {
	
	var $plugin_name = 'getmail_plugin';
	var $class_name = 'getmail_plugin';
	
	
37
	var $getmail_config_dir = '';
tbrehm's avatar
tbrehm committed
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
	
	/*
	 	This function is called when the plugin is loaded
	*/
	
	function onLoad() {
		global $app;
		
		/*
		Register for the events
		*/
		
		$app->plugins->registerEvent('mail_get_insert','getmail_plugin','insert');
		$app->plugins->registerEvent('mail_get_update','getmail_plugin','update');
		$app->plugins->registerEvent('mail_get_delete','getmail_plugin','delete');
		
54
55
		
		
tbrehm's avatar
tbrehm committed
56
57
58
59
60
61
62
63
64
65
66
67
	}
	
	function insert($event_name,$data) {
		global $app, $conf;
		
		$this->update($event_name,$data);
		
	}
	
	function update($event_name,$data) {
		global $app, $conf;
		
68
69
70
71
72
		// load the server specific configuration options for getmail
		$app->uses("getconf");
		$getmail_config = $app->getconf->get_server_config($conf["server_id"], 'getmail');
		$this->getmail_config_dir = $getmail_config["getmail_config_dir"];
		
tbrehm's avatar
tbrehm committed
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
		// Check if the config directory exists.
		if(!is_dir($this->getmail_config_dir)) {
			$app->log("Getmail config directory '".$this->getmail_config_dir."' does not exist.",LOGLEVEL_ERROR);
		} else {
			
			// Delete the config file first, if it exists
			$this->delete($event_name,$data);
			
			// Get the new config file path
			$config_file_path = escapeshellcmd($this->getmail_config_dir.'/'.$data["new"]["source_server"].'_'.$data["new"]["source_username"].'.conf');
			if(stristr($config_file_path, "..") or stristr($config_file_path, "|") or stristr($config_file_path,";") or stristr($config_file_path,'$')) {
				$app->log("Possibly faked path for getmail config file: '$config_file_path'. File is not written.",LOGLEVEL_ERROR);
				return false;
			}

			
89
			if($data["new"]["active"] == 'y') {
tbrehm's avatar
tbrehm committed
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
				// Open master template
				$tpl = file_get_contents($conf["rootpath"].'/conf/getmail.conf.master');
			
				// Shall emails be deleted after retrieval
				if($data["new"]["source_delete"] == 'y') {
					$tpl = str_replace('{DELETE}','1',$tpl);
				} else {
					$tpl = str_replace('{DELETE}','0',$tpl);
				}
			
				// Set the data retriever
				if($data["new"]["type"] == 'pop3') {
					$tpl = str_replace('{TYPE}','SimplePOP3Retriever',$tpl);
				} elseif ($data["new"]["type"] == 'imap') {
					$tpl = str_replace('{TYPE}','SimpleIMAPRetriever',$tpl);
				}
			
				// Set server, username, password and destination.
				$tpl = str_replace('{SERVER}',$data["new"]["source_server"],$tpl);
				$tpl = str_replace('{USERNAME}',$data["new"]["source_username"],$tpl);
				$tpl = str_replace('{PASSWORD}',$data["new"]["source_password"],$tpl);
111
				$tpl = str_replace('{DESTINATION}',$data["new"]["destination"],$tpl);
tbrehm's avatar
tbrehm committed
112
113
114
115
				
				// Write the config file.
				file_put_contents($config_file_path,$tpl);
				$app->log("Writing Getmail config file: $config_file_path",LOGLEVEL_DEBUG);
tbrehm's avatar
tbrehm committed
116
				exec("chmod 400 $config_file_path");
tbrehm's avatar
tbrehm committed
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
				unset($tpl);
				unset($config_file_path);
				
			} else {
				// If record is set to inactive, we will delete the file
				if(is_file($config_file_path)) unlink($config_file_path);
			}
		}
	}
	
	function delete($event_name,$data) {
		global $app, $conf;
		
		$config_file_path = escapeshellcmd($this->getmail_config_dir.'/'.$data["old"]["source_server"].'_'.$data["old"]["source_username"].'.conf');
		if(stristr($config_file_path,"..") || stristr($config_file_path,"|") || stristr($config_file_path,";") || stristr($config_file_path,'$')) {
			$app->log("Possibly faked path for getmail config file: '$config_file_path'. File is not written.",LOGLEVEL_ERROR);
			return false;
		}
		if(is_file($config_file_path)) unlink($config_file_path);
	}
	

} // end class

?>