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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<?php
require_once 'Net/IMSP/Auth.php';
/**
* Net_IMSP_Options Class - provides an interface to IMSP server-based
* options storage.
*
* Required parameters:<pre>
* 'username' Username to logon to IMSP server as.
* 'password' Password for current user.
* 'auth_method' The authentication method to use to login.
* 'server' The hostname of the IMSP server.
* 'port' The port of the IMSP server.</pre>
*
* $Horde: framework/Net_IMSP/IMSP/Options.php,v 1.3.2.20 2009/01/06 15:23:27 jan Exp $
*
* Copyright 2004-2009 The Horde Project (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.
*
* @author Michael Rubinsky <mrubinsk@horde.org>
* @package Net_IMSP
*/
class Net_IMSP_Options {
/**
* Net_IMSP object.
*
* @var Net_IMSP
*/
var $_imsp;
/**
* Parameter list.
*
* @var array
*/
var $_params;
/**
* Constructor function.
*
* @param array $params Hash containing IMSP parameters.
*/
function Net_IMSP_Options($params)
{
$this->_params = $params;
}
/**
* Initialization function to be called after object is returned.
* This allows errors to occur and not break the script.
*
* @return mixed True on success PEAR_Error on failure.
*/
function init()
{
if (!isset($this->_imsp)) {
$auth = &Net_IMSP_Auth::singleton($this->_params['auth_method']);
$this->_imsp = $auth->authenticate($this->_params);
}
if (is_a($this->_imsp, 'PEAR_Error')) {
return $this->_imsp;
}
$this->_imsp->writeToLog('Net_IMSP_Options initialized.', __FILE__,
__LINE__, PEAR_LOG_DEBUG);
return true;
}
/**
* Function sends a GET command to IMSP server and retrieves values.
*
* @param string $optionName Name of option to retrieve. Accepts '*'
* as wild card.
*
* @return mixed Associative array containing option=>value pairs or
* PEAR_Error.
*/
function get($optionName)
{
$options = array();
$result = $this->_imsp->imspSend("GET $optionName", true, true);
if (is_a($result, 'PEAR_Error')) {
return $result;
}
$server_response = $this->_imsp->imspReceive();
if (is_a($server_response, 'PEAR_Error')) {
return $server_response;
}
while (preg_match("/^\* OPTION/", $server_response)) {
/* First, check for a {}. */
if (preg_match(IMSP_OCTET_COUNT, $server_response, $tempArray)) {
$temp = explode(' ', $server_response);
$options[$temp[2]] = $this->_imsp->receiveStringLiteral($tempArray[2]);
$this->_imsp->imspReceive();
} else {
$temp = explode(' ', $server_response);
$options[$temp[2]] = trim($temp[3]);
$i = 3;
$lastChar = "";
$nextElement = trim($temp[3]);
/* Was the value quoted and spaced? */
if ((substr($nextElement,0,1) == '"') &&
(substr($nextElement,strlen($nextElement) - 1, 1) != '"')) {
do {
$nextElement = $temp[$i+1];
$lastChar = substr($nextElement,
strlen($nextElement) - 1, 1);
$options[$temp[2]] .= ' ' . $nextElement;
if ($lastChar == '"') {
$done = true;
} else {
$done = false;
$lastChar = substr($temp[$i+2],
strlen($temp[$i+2]) - 1, 1);
$i++;
}
} while ($lastChar != '"');
if (!$done) {
$nextElement = $temp[$i+1];
$options[$temp[2]] .= ' ' . $nextElement;
}
}
}
$server_response = $this->_imsp->imspReceive();
if (is_a($server_response, 'PEAR_Error')) {
return $server_response;
}
}
if ($server_response != 'OK') {
return $this->_imsp->imspError('Did not receive the expected response from the server.',
__FILE__, __LINE__);
}
$this->_imsp->writeToLog('GET command OK.', __FILE__, __LINE__, PEAR_LOG_DEBUG);
return $options;
}
/**
* Function sets an option value on the IMSP server.
*
* @param string $optionName Name of option to set.
* @param string $optionValue Value to assign.
*
* @return mixed True or PEAR_Error.
*/
function set($optionName, $optionValue)
{
/* Send the beginning of the command. */
$result = $this->_imsp->imspSend("SET $optionName ", true, false);
/* Send $optionValue as a literal {}? */
if (preg_match(IMSP_MUST_USE_LITERAL, $optionValue)) {
$biValue = sprintf("{%d}", strlen($optionValue));
$result = $this->_imsp->imspSend($biValue, false, true);
if (is_a($result, 'PEAR_Error')) {
return $result;
}
if (!preg_match("/^\+/",
$this->_imsp->imspReceive())) {
return $this->_imsp->imspError('Did not receive expected command continuation response from IMSP server.',
__FILE__, __LINE__);
}
}
/* Now send the rest of the command. */
$result = $this->_imsp->imspSend($optionValue, false, true);
if (is_a($result, 'PEAR_Error')) {
return $result;
}
$server_response = $this->_imsp->imspReceive();
if (is_a($server_response, 'PEAR_Error')) {
return $server_response;
} elseif ($server_response != 'OK') {
return $this->_imsp->imspError('The option could not be set on the IMSP server.', __FILE__, __LINE__);
}
$this->_imsp->writeToLog('SET command OK.', __FILE__, __LINE__, PEAR_LOG_DEBUG);
return true;
}
/**
* Sets the log information in the Net_IMSP object.
*
* @param array $params The log parameters.
*
* @return mixed True on success PEAR_Error on failure.
*/
function setLogger($params)
{
if (isset($this->_imsp)) {
return $this->_imsp->setLogger($params);
} else {
return $this->_imsp->imspError('The IMSP log could not be initialized.');
}
}
function logout()
{
$this->_imsp->logout();
}
}
|
