1 | <?php |
---|
2 | /** |
---|
3 | * The MCVE:: class provides functions for communicating with a MCVE server. |
---|
4 | * |
---|
5 | * @author Quinn Comendant <quinn@strangecode.com> |
---|
6 | * @version 1.0 |
---|
7 | */ |
---|
8 | class MCVE { |
---|
9 | |
---|
10 | var $username; |
---|
11 | var $password; |
---|
12 | var $host = 'localhost'; |
---|
13 | var $ip_port = 8333; |
---|
14 | var $ssl_port = 8444; |
---|
15 | var $ca_bundle_file = '/usr/share/ssl/certs/ca-bundle.crt'; |
---|
16 | var $connect_method = 'ip'; |
---|
17 | var $timeout = 10; |
---|
18 | var $blocking = 1; |
---|
19 | var $connected = false; |
---|
20 | var $conn; |
---|
21 | |
---|
22 | function MCVE($username, $password) |
---|
23 | { |
---|
24 | // Ensure PHP was compiled with the MCVE functions. |
---|
25 | if (!extension_loaded('mcve')) { |
---|
26 | trigger_error('MCVE class instantiation failed: MCVE extension not available.', E_USER_WARNING); |
---|
27 | die; |
---|
28 | } |
---|
29 | $this->username = $username; |
---|
30 | $this->password = $password; |
---|
31 | } |
---|
32 | |
---|
33 | function _connect() |
---|
34 | { |
---|
35 | if ($this->connected) { |
---|
36 | return true; |
---|
37 | } |
---|
38 | |
---|
39 | // Initialize SSL structures and definitions. |
---|
40 | MCVE_InitEngine($ca_bundle_file); |
---|
41 | |
---|
42 | // Allocate Connection Structures |
---|
43 | $this->conn = MCVE_InitConn(); |
---|
44 | |
---|
45 | // Set Connection Method and Locations |
---|
46 | switch ($this->connect_method) { |
---|
47 | case 'ip' : |
---|
48 | if (!MCVE_SetIP($this->conn, $this->host, $this->ip_port)) { |
---|
49 | App::logMsg('Could not set method to IP.', LOG_ERR, __FILE__, __LINE__); |
---|
50 | return false; |
---|
51 | } |
---|
52 | break; |
---|
53 | case 'ssl' : |
---|
54 | if (!MCVE_SetSSL($this->conn, $this->host, $this->ssl_port)) { |
---|
55 | App::logMsg('Could not set method to IP.', LOG_ERR, __FILE__, __LINE__); |
---|
56 | return false; |
---|
57 | } |
---|
58 | break; |
---|
59 | case 'dropfile' : |
---|
60 | if (!MCVE_SetDropFile($this->conn, '/var/mcve/trans')) { |
---|
61 | App::logMsg('Could not set method to IP.', LOG_ERR, __FILE__, __LINE__); |
---|
62 | return false; |
---|
63 | } |
---|
64 | break; |
---|
65 | default : |
---|
66 | App::logMsg('Connection method not defined.', LOG_ERR, __FILE__, __LINE__); |
---|
67 | } |
---|
68 | |
---|
69 | // Put connection into non-blocking mode, meaning that the client must |
---|
70 | // loop waiting for the transaction to complete. You should always specify |
---|
71 | // this function with your blocking preference as the default is currently |
---|
72 | // non-blocking, but future versions of php_mcve will default to blocking. |
---|
73 | if (!MCVE_SetBlocking($this->conn, $this->blocking)) { |
---|
74 | App::logMsg('Could not set blocking mode.', LOG_ERR, __FILE__, __LINE__); |
---|
75 | return false; |
---|
76 | } |
---|
77 | |
---|
78 | // Maximum of 30s per transaction allowed. Timeout occurs on server-end, not client-end |
---|
79 | if (!MCVE_SetTimeout($this->conn, $this->timeout)) { |
---|
80 | App::logMsg('Could not set timeout.', LOG_ERR, __FILE__, __LINE__); |
---|
81 | return false; |
---|
82 | } |
---|
83 | |
---|
84 | // Connect to MCVE, if there's an error, print the exact reason for connection failure |
---|
85 | if (!MCVE_Connect($this->conn)) { |
---|
86 | $error = MCVE_ConnectionError($this->conn); |
---|
87 | App::logMsg("Connection failed: $error. Are you sure the MCVE engine is running?", LOG_ERR, __FILE__, __LINE__); |
---|
88 | return false; |
---|
89 | } |
---|
90 | |
---|
91 | $this->connected = true; |
---|
92 | } |
---|
93 | |
---|
94 | function beginTrans() |
---|
95 | { |
---|
96 | $this->_connect(); |
---|
97 | $tid = MCVE_TransNew($this->conn); // Allocate memory for sending a transaction. |
---|
98 | $this->transParam($tid, MC_USERNAME, $this->username); |
---|
99 | $this->transParam($tid, MC_PASSWORD, $this->password); |
---|
100 | return $tid; |
---|
101 | } |
---|
102 | |
---|
103 | function transParam($tid, $key, $var1, $var2=null) |
---|
104 | { |
---|
105 | if (!isset($var2)) { |
---|
106 | return MCVE_TransParam($this->conn, $tid, $key, $var1); |
---|
107 | } else { |
---|
108 | return MCVE_TransParam($this->conn, $tid, $key, $var1, $var2); |
---|
109 | } |
---|
110 | |
---|
111 | } |
---|
112 | |
---|
113 | function sendTrans($tid, $type='', $hide_msg=false) |
---|
114 | { |
---|
115 | // Finalize structuring of to MCVE and ready it to be sent |
---|
116 | if (!MCVE_TransSend($this->conn, $tid)) { |
---|
117 | App::logMsg('Transaction improperly structured, possibly not enough info.', LOG_ERR, __FILE__, __LINE__); |
---|
118 | return false; |
---|
119 | } |
---|
120 | |
---|
121 | // Perform actual communication with MCVE engine. |
---|
122 | // If blocking method is used, loop until transaction is complete |
---|
123 | if ($this->blocking != 1) { |
---|
124 | while (MCVE_CheckStatus($this->conn, $tid) != MCVE_DONE) { |
---|
125 | MCVE_Monitor($this->conn); // Perform communication on connection |
---|
126 | MCVE_uwait(10000); // Microsecond thread-safe sleep timer. Better than usleep() |
---|
127 | } |
---|
128 | } |
---|
129 | |
---|
130 | $ret_status = MCVE_ReturnStatus($this->conn, $tid); |
---|
131 | $ret_code = MCVE_ReturnCode($this->conn, $tid); |
---|
132 | $ret_text = mcve_text_code($ret_code); |
---|
133 | $verbiage = MCVE_TransactionText($this->conn, $tid); |
---|
134 | |
---|
135 | // Check to see if transaction was successful or not using a strict success/fail function |
---|
136 | if ($ret_status == MCVE_FAIL) { |
---|
137 | App::raiseMsg(sprintf('MCVE %s failure: %s %s', $type, $ret_text, ('' == $verbiage ? '' : '(' . trim($verbiage) . ')')), MSG_WARNING, __FILE__, __LINE__); |
---|
138 | return false; |
---|
139 | } else if ($ret_status == MCVE_SUCCESS) { |
---|
140 | if (!$hide_msg) { |
---|
141 | App::raiseMsg(sprintf(_("MCVE %s success: %s %s"), $type, $ret_text, ('' == $verbiage ? '' : '(' . trim($verbiage) . ')')), MSG_SUCCESS, __FILE__, __LINE__); |
---|
142 | } |
---|
143 | App::logMsg(sprintf(_("MCVE success details. Auth: %s; Batch: %s; Item: %s; TTID: %s; AVS: %s; CV: %s."), |
---|
144 | MCVE_TransactionAuth($this->conn, $tid), |
---|
145 | MCVE_TransactionBatch($this->conn, $tid), |
---|
146 | MCVE_TransactionItem($this->conn, $tid), |
---|
147 | MCVE_TransactionID($this->conn, $tid), |
---|
148 | mcve_text_avs(MCVE_TransactionAVS($this->conn, $tid)), |
---|
149 | mcve_text_cv(MCVE_TransactionCV($this->conn, $tid)) |
---|
150 | ), LOG_DEBUG, __FILE__, __LINE__); |
---|
151 | return true; |
---|
152 | } else { |
---|
153 | App::logMsg(sprintf('Transaction failed. Unknown return code: %s', $ret_status), LOG_ERR, __FILE__, __LINE__); |
---|
154 | return false; |
---|
155 | } |
---|
156 | } |
---|
157 | |
---|
158 | function disconnect($tid) |
---|
159 | { |
---|
160 | if ($this->connected) { |
---|
161 | // Optional, clean up memory by transaction ... This is done automatically by |
---|
162 | // MCVE_DestroyConn though |
---|
163 | MCVE_DeleteTrans($this->conn, $tid); |
---|
164 | |
---|
165 | // Clean up and close MCVE. |
---|
166 | MCVE_DestroyConn($this->conn); |
---|
167 | MCVE_DestroyEngine(); |
---|
168 | |
---|
169 | $this->connected = false; |
---|
170 | } |
---|
171 | } |
---|
172 | } |
---|
173 | // End of class. |
---|
174 | |
---|
175 | ?> |
---|