Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 1 | /* Asterisk's AMI interface functions in TTCN-3 |
| 2 | * (C) 2024 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de> |
| 3 | * Author: Pau Espin Pedrol <pespin@sysmocom.de> |
| 4 | * All rights reserved. |
| 5 | * |
| 6 | * Released under the terms of GNU General Public License, Version 2 or |
| 7 | * (at your option) any later version. |
| 8 | * |
| 9 | * SPDX-License-Identifier: GPL-2.0-or-later |
| 10 | */ |
| 11 | |
| 12 | /* |
| 13 | * https://docs.asterisk.org/Configuration/Interfaces/Asterisk-Manager-Interface-AMI/AMI-v2-Specification/ |
| 14 | */ |
| 15 | module AMI_Functions { |
| 16 | |
| 17 | import from Misc_Helpers all; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 18 | import from Osmocom_Types all; |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 19 | import from IPL4asp_Types all; |
| 20 | import from IPL4asp_PortType all; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 21 | import from Socket_API_Definitions all; |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 22 | import from TCCConversion_Functions all; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 23 | |
| 24 | modulepar { |
| 25 | float mp_ami_prompt_timeout := 10.0; |
| 26 | } |
| 27 | |
| 28 | const charstring AMI_FIELD_ACTION := "Action"; |
Pau Espin Pedrol | 941ca3c | 2024-05-09 16:46:58 +0200 | [diff] [blame] | 29 | const charstring AMI_FIELD_ACTION_ID := "ActionID"; |
Pau Espin Pedrol | e98f441 | 2024-05-17 19:33:46 +0200 | [diff] [blame] | 30 | const charstring AMI_FIELD_EVENT := "Event"; |
Pau Espin Pedrol | 0c5c647 | 2024-05-21 13:13:49 +0200 | [diff] [blame^] | 31 | const charstring AMI_FIELD_INFO := "Info"; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 32 | const charstring AMI_FIELD_USERNAME := "Username"; |
| 33 | const charstring AMI_FIELD_SECRET := "Secret"; |
| 34 | const charstring AMI_FIELD_RESPONSE := "Response"; |
| 35 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 36 | /* Extensions: */ |
| 37 | const charstring AMI_FIELD_REGISTRATION := "Registration"; |
| 38 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 39 | type record AMI_Field { |
| 40 | charstring key, |
| 41 | charstring val |
Pau Espin Pedrol | de7a485 | 2024-04-19 16:20:45 +0200 | [diff] [blame] | 42 | } with { |
| 43 | encode "TEXT" |
| 44 | variant "SEPARATOR(': ', ':\s+')" |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 45 | }; |
Pau Espin Pedrol | de7a485 | 2024-04-19 16:20:45 +0200 | [diff] [blame] | 46 | |
| 47 | type set of AMI_Field AMI_Msg with { |
| 48 | encode "TEXT" |
| 49 | variant "SEPARATOR('\r\n', '(\r\n)|[\n]')" |
| 50 | variant "END('\r\n', '(\r\n)|[\n]')" |
| 51 | }; |
| 52 | |
| 53 | external function enc_AMI_Msg(in AMI_Msg msg) return charstring |
| 54 | with { extension "prototype(convert) encode(TEXT)" } |
| 55 | external function dec_AMI_Msg(in charstring stream) return AMI_Msg |
| 56 | with { extension "prototype(convert) decode(TEXT)" } |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 57 | |
| 58 | template (value) AMI_Field |
| 59 | ts_AMI_Field(template (value) charstring key, |
| 60 | template (value) charstring val) := { |
| 61 | key := key, |
| 62 | val := val |
| 63 | }; |
| 64 | |
| 65 | template (present) AMI_Field |
| 66 | tr_AMI_Field(template (present) charstring key := ?, |
| 67 | template (present) charstring val := ?) := { |
| 68 | key := key, |
| 69 | val := val |
| 70 | }; |
| 71 | |
| 72 | /* |
| 73 | * Field Templates: |
| 74 | */ |
| 75 | |
| 76 | template (value) AMI_Field |
| 77 | ts_AMI_Field_Action(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_ACTION, val); |
| 78 | template (value) AMI_Field |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 79 | ts_AMI_Field_ActionId(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_ACTION_ID, val); |
| 80 | template (value) AMI_Field |
Pau Espin Pedrol | e98f441 | 2024-05-17 19:33:46 +0200 | [diff] [blame] | 81 | ts_AMI_Field_Event(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_EVENT, val); |
| 82 | template (value) AMI_Field |
Pau Espin Pedrol | 0c5c647 | 2024-05-21 13:13:49 +0200 | [diff] [blame^] | 83 | ts_AMI_Field_Info(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_INFO, val); |
| 84 | template (value) AMI_Field |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 85 | ts_AMI_Field_Username(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_USERNAME, val); |
| 86 | template (value) AMI_Field |
| 87 | ts_AMI_Field_Secret(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_SECRET, val); |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 88 | /* Extensions: */ |
| 89 | template (value) AMI_Field |
| 90 | ts_AMI_Field_Registration(template (value) charstring val) := ts_AMI_Field(AMI_FIELD_REGISTRATION, val); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 91 | |
| 92 | template (present) AMI_Field |
Pau Espin Pedrol | 21c084f | 2024-05-09 16:42:16 +0200 | [diff] [blame] | 93 | tr_AMI_Field_Action(template (present) charstring val := ?) := tr_AMI_Field(pattern @nocase AMI_FIELD_ACTION, val); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 94 | template (present) AMI_Field |
Pau Espin Pedrol | 21c084f | 2024-05-09 16:42:16 +0200 | [diff] [blame] | 95 | tr_AMI_Field_ActionId(template (present) charstring val := ?) := tr_AMI_Field(pattern @nocase AMI_FIELD_ACTION_ID, val); |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 96 | template (present) AMI_Field |
Pau Espin Pedrol | e98f441 | 2024-05-17 19:33:46 +0200 | [diff] [blame] | 97 | tr_AMI_Field_Event(template (present) charstring val := ?) := tr_AMI_Field(pattern @nocase AMI_FIELD_EVENT, val); |
| 98 | template (present) AMI_Field |
Pau Espin Pedrol | 0c5c647 | 2024-05-21 13:13:49 +0200 | [diff] [blame^] | 99 | tr_AMI_Field_Info(template (present) charstring val := ?) := tr_AMI_Field(pattern @nocase AMI_FIELD_INFO, val); |
| 100 | template (present) AMI_Field |
Pau Espin Pedrol | 21c084f | 2024-05-09 16:42:16 +0200 | [diff] [blame] | 101 | tr_AMI_Field_Username(template (present) charstring val := ?) := tr_AMI_Field(pattern @nocase AMI_FIELD_USERNAME, val); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 102 | template (present) AMI_Field |
Pau Espin Pedrol | 21c084f | 2024-05-09 16:42:16 +0200 | [diff] [blame] | 103 | tr_AMI_Field_Secret(template (present) charstring val := ?) := tr_AMI_Field(pattern @nocase AMI_FIELD_SECRET, val); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 104 | template (present) AMI_Field |
Pau Espin Pedrol | 21c084f | 2024-05-09 16:42:16 +0200 | [diff] [blame] | 105 | tr_AMI_Field_Response(template (present) charstring val := ?) := tr_AMI_Field(pattern @nocase AMI_FIELD_RESPONSE, val); |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 106 | /* Extensions: */ |
| 107 | template (present) AMI_Field |
Pau Espin Pedrol | 21c084f | 2024-05-09 16:42:16 +0200 | [diff] [blame] | 108 | tr_AMI_Field_Registration(template (present) charstring val := ?) := tr_AMI_Field(pattern @nocase AMI_FIELD_REGISTRATION, val); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 109 | |
| 110 | |
| 111 | template (present) AMI_Field |
Pau Espin Pedrol | 21c084f | 2024-05-09 16:42:16 +0200 | [diff] [blame] | 112 | tr_AMI_Field_ResponseSuccess := tr_AMI_Field(pattern @nocase AMI_FIELD_RESPONSE, "Success"); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 113 | |
| 114 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 115 | /*********************** |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 116 | * Message Templates: |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 117 | ***********************/ |
| 118 | |
| 119 | /* |
| 120 | * ACTIONS |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 121 | */ |
| 122 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 123 | /* Action: Login |
| 124 | * Username: <value> |
| 125 | * Secret: <value> |
| 126 | */ |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 127 | template (value) AMI_Msg |
Pau Espin Pedrol | 77976a6 | 2024-05-08 21:17:38 +0200 | [diff] [blame] | 128 | ts_AMI_Action_Login(charstring username, |
| 129 | charstring secret, |
| 130 | template (value) charstring action_id := "0001") := { |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 131 | ts_AMI_Field_Action("Login"), |
Pau Espin Pedrol | 77976a6 | 2024-05-08 21:17:38 +0200 | [diff] [blame] | 132 | ts_AMI_Field_ActionId(action_id), |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 133 | ts_AMI_Field_Username(username), |
| 134 | ts_AMI_Field_Secret(secret) |
| 135 | }; |
| 136 | |
| 137 | template (present) AMI_Msg |
| 138 | tr_AMI_Action_Login(template(present) charstring username := ?, |
Pau Espin Pedrol | 77976a6 | 2024-05-08 21:17:38 +0200 | [diff] [blame] | 139 | template(present) charstring secret := ?, |
| 140 | template (present) charstring action_id := ?) := superset( |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 141 | tr_AMI_Field_Action("Login"), |
Pau Espin Pedrol | 77976a6 | 2024-05-08 21:17:38 +0200 | [diff] [blame] | 142 | tr_AMI_Field_ActionId(action_id), |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 143 | tr_AMI_Field_Username(username), |
| 144 | tr_AMI_Field_Secret(secret) |
| 145 | ); |
| 146 | |
Pau Espin Pedrol | 0c5c647 | 2024-05-21 13:13:49 +0200 | [diff] [blame^] | 147 | /* Action: PJSIPAccessNetworkInfo |
| 148 | * Registration: volte_ims |
| 149 | * Info: 3GPP-E-UTRAN-FDD; utran-cell-id-3gpp=2380100010000101 |
| 150 | */ |
| 151 | template (value) AMI_Msg |
| 152 | ts_AMI_Action_PJSIPAccessNetworkInfo(template (value) charstring registration := "volte_ims", |
| 153 | template (value) charstring info := "", |
| 154 | template (value) charstring action_id := "0001") := { |
| 155 | ts_AMI_Field_Action("PJSIPAccessNetworkInfo"), |
| 156 | ts_AMI_Field_ActionId(action_id), |
| 157 | ts_AMI_Field_Registration(registration), |
| 158 | ts_AMI_Field_Info(info) |
| 159 | }; |
| 160 | function f_ami_gen_PJSIPAccessNetworkInfo_Info_EUTRAN(charstring uli_str) return charstring { |
| 161 | return "3GPP-E-UTRAN-FDD; utran-cell-id-3gpp=" & uli_str; |
| 162 | } |
| 163 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 164 | /* Action: PJSIPRegister |
| 165 | * ActionID: <value> |
| 166 | * Registration: volte_ims |
| 167 | */ |
| 168 | template (value) AMI_Msg |
| 169 | ts_AMI_Action_PJSIPRegister(template (value) charstring registration := "volte_ims", |
| 170 | template (value) charstring action_id := "0001") := { |
| 171 | ts_AMI_Field_Action("PJSIPRegister"), |
| 172 | ts_AMI_Field_ActionId(action_id), |
| 173 | ts_AMI_Field_Registration(registration) |
| 174 | }; |
| 175 | template (present) AMI_Msg |
| 176 | tr_AMI_Action_PJSIPRegister(template (present) charstring registration := ?, |
| 177 | template (present) charstring action_id := ?) := { |
| 178 | tr_AMI_Field_Action("PJSIPRegister"), |
| 179 | tr_AMI_Field_ActionId(action_id), |
| 180 | tr_AMI_Field_Registration(registration) |
| 181 | }; |
| 182 | |
| 183 | /* |
| 184 | * RESPONSES |
| 185 | */ |
| 186 | |
| 187 | /* Response: Success |
| 188 | */ |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 189 | template (present) AMI_Msg |
| 190 | tr_AMI_Response_Success := superset( |
| 191 | tr_AMI_Field_ResponseSuccess |
| 192 | ); |
| 193 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 194 | /* Response: Success |
| 195 | * ActionId: <value> |
| 196 | */ |
| 197 | template (present) AMI_Msg |
| 198 | tr_AMI_Response_Success_ActionId(template (present) charstring action_id := ?) := superset( |
| 199 | tr_AMI_Field_ResponseSuccess, |
| 200 | tr_AMI_Field_ActionId(action_id) |
| 201 | ); |
| 202 | |
Pau Espin Pedrol | e98f441 | 2024-05-17 19:33:46 +0200 | [diff] [blame] | 203 | /* |
| 204 | * EVENTS |
| 205 | */ |
| 206 | template (present) AMI_Msg |
| 207 | tr_AMI_Event(template (present) charstring ev_name := ?) := superset( |
| 208 | tr_AMI_Field_Event(ev_name) |
| 209 | ); |
| 210 | |
| 211 | /* Event: FullyBooted |
| 212 | * Privilege: system,all |
| 213 | * Status: Fully Booted |
| 214 | * Uptime: 4 |
| 215 | * LastReload: 4 * |
| 216 | */ |
| 217 | template (present) AMI_Msg |
| 218 | tr_AMI_Event_FullyBooted := tr_AMI_Event("FullyBooted"); |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 219 | |
| 220 | /*********************** |
| 221 | * Adapter: |
| 222 | ***********************/ |
| 223 | |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 224 | type record AMI_Adapter_Parameters { |
| 225 | charstring remote_host, |
| 226 | IPL4asp_Types.PortNumber remote_port, |
| 227 | charstring local_host, |
| 228 | IPL4asp_Types.PortNumber local_port, |
| 229 | charstring welcome_str |
| 230 | } |
| 231 | |
| 232 | const AMI_Adapter_Parameters c_default_AMI_Adapter_pars := { |
| 233 | remote_host := "127.0.0.1", |
| 234 | remote_port := 5038, |
| 235 | local_host := "0.0.0.0", |
| 236 | local_port := 0, |
| 237 | welcome_str := "Asterisk Call Manager/9.0.0\r\n" |
| 238 | }; |
| 239 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 240 | type port AMI_Msg_PT message { |
| 241 | inout AMI_Msg; |
| 242 | } with { extension "internal" }; |
| 243 | |
| 244 | type component AMI_Adapter_CT { |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 245 | port IPL4asp_PT IPL4; |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 246 | port AMI_Msg_PT CLIENT; |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 247 | var AMI_Adapter_Parameters g_pars; |
| 248 | |
| 249 | /* Connection identifier of the client itself */ |
| 250 | var IPL4asp_Types.ConnectionId g_self_conn_id := -1; |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 251 | } |
| 252 | |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 253 | /* Function to use to connect as client to a remote IPA Server */ |
| 254 | private function f_AMI_Adapter_connect() runs on AMI_Adapter_CT { |
| 255 | var IPL4asp_Types.Result res; |
| 256 | map(self:IPL4, system:IPL4); |
| 257 | res := IPL4asp_PortType.f_IPL4_connect(IPL4, g_pars.remote_host, g_pars.remote_port, |
| 258 | g_pars.local_host, g_pars.local_port, 0, { tcp:={} }); |
| 259 | if (not ispresent(res.connId)) { |
| 260 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 261 | log2str("Could not connect AMI socket from ", g_pars.local_host, " port ", |
| 262 | g_pars.local_port, " to ", g_pars.remote_host, " port ", g_pars.remote_port, |
| 263 | "; check your configuration")); |
| 264 | } |
| 265 | g_self_conn_id := res.connId; |
| 266 | log("AMI connected, ConnId=", g_self_conn_id) |
| 267 | } |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 268 | |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 269 | private function f_ASP_RecvFrom_msg_to_charstring(ASP_RecvFrom rx_rf) return charstring { |
| 270 | return oct2char(rx_rf.msg); |
| 271 | } |
| 272 | |
| 273 | /* Function to use to connect as client to a remote IPA Server */ |
| 274 | private function f_AMI_Adapter_wait_rx_welcome_str() runs on AMI_Adapter_CT { |
| 275 | var ASP_RecvFrom rx_rf; |
| 276 | var charstring rx_str; |
| 277 | timer Twelcome := 3.0; |
| 278 | |
| 279 | Twelcome.start; |
| 280 | alt { |
| 281 | [] IPL4.receive(ASP_RecvFrom:?) -> value rx_rf { |
| 282 | rx_str := f_ASP_RecvFrom_msg_to_charstring(rx_rf); |
| 283 | if (g_pars.welcome_str != rx_str) { |
| 284 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 285 | log2str("AMI Welcome message mismatch: '", rx_str, |
| 286 | "' vs exp '", g_pars.welcome_str, "'")); |
| 287 | } |
| 288 | } |
| 289 | [] Twelcome.timeout { |
| 290 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 291 | log2str("AMI Welcome timeout")); |
| 292 | } |
| 293 | } |
| 294 | Twelcome.stop; |
| 295 | log("AMI Welcome message received: '", rx_str, "'"); |
| 296 | } |
| 297 | |
| 298 | private function dec_AMI_Msg_ext(charstring txt) return AMI_Msg { |
| 299 | log("AMI dec: '", txt, "'"); |
| 300 | /* TEXT Enc/dec is not happy with empty values, workaround it: */ |
| 301 | var charstring patched_txt := f_str_replace(txt, "Challenge: \r\n", ""); |
| 302 | patched_txt := f_str_replace(patched_txt, "AccountCode: \r\n", ""); |
| 303 | patched_txt := f_str_replace(patched_txt, "Value: \r\n", ""); |
| 304 | patched_txt := f_str_replace(patched_txt, "DestExten: \r\n", ""); |
| 305 | patched_txt := f_str_replace(patched_txt, "Exten: \r\n", ""); |
| 306 | patched_txt := f_str_replace(patched_txt, "Extension: \r\n", ""); |
Pau Espin Pedrol | bf0e14d | 2024-05-16 18:34:13 +0200 | [diff] [blame] | 307 | patched_txt := f_str_replace(patched_txt, "Hint: \r\n", ""); |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 308 | |
| 309 | /* "AppData" field sometimes has a value containing separator ": ", which makes |
| 310 | * TEXT dec not happy. Workaround it for now by removing the whole field line: |
| 311 | * "AppData: 5,0502: Call pjsip endpoint from 0501\r\n" |
| 312 | */ |
| 313 | var integer pos := f_strstr(patched_txt, "AppData: ", 0); |
| 314 | if (pos >= 0) { |
| 315 | var integer pos_end := f_strstr(patched_txt, "\r\n", pos) + lengthof("\r\n"); |
| 316 | var charstring to_remove := substr(patched_txt, pos, pos_end - pos); |
| 317 | patched_txt := f_str_replace(patched_txt, to_remove, ""); |
| 318 | } |
| 319 | |
| 320 | log("AMI patched dec: '", patched_txt, "'"); |
| 321 | return dec_AMI_Msg(patched_txt); |
| 322 | } |
| 323 | |
| 324 | function f_AMI_Adapter_main(AMI_Adapter_Parameters pars := c_default_AMI_Adapter_pars) |
| 325 | runs on AMI_Adapter_CT { |
| 326 | var AMI_Msg msg; |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 327 | var charstring rx, buf := ""; |
| 328 | var integer fd; |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 329 | var ASP_RecvFrom rx_rf; |
| 330 | var ASP_Event rx_ev; |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 331 | |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 332 | g_pars := pars; |
| 333 | |
| 334 | f_AMI_Adapter_connect(); |
| 335 | |
| 336 | f_AMI_Adapter_wait_rx_welcome_str(); |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 337 | |
| 338 | while (true) { |
| 339 | |
| 340 | alt { |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 341 | [] IPL4.receive(ASP_RecvFrom:?) -> value rx_rf { |
| 342 | var charstring rx_str := f_ASP_RecvFrom_msg_to_charstring(rx_rf); |
| 343 | log("AMI rx: '", rx_str, "'"); |
| 344 | buf := buf & rx_str; |
| 345 | log("AMI buf: '", buf, "'"); |
| 346 | |
| 347 | /* If several messages come together */ |
| 348 | var boolean last_is_complete := f_str_endswith(buf, "\r\n\r\n"); |
| 349 | var Misc_Helpers.ro_charstring msgs := f_str_split(buf, "\r\n\r\n"); |
| 350 | log("AMI split: ", msgs); |
| 351 | if (lengthof(msgs) > 0) { |
| 352 | for (var integer i := 0; i < lengthof(msgs) - 1; i := i + 1) { |
| 353 | var charstring txt := msgs[i] & "\r\n"; |
| 354 | msg := dec_AMI_Msg_ext(txt); |
| 355 | CLIENT.send(msg); |
| 356 | } |
| 357 | if (last_is_complete) { |
| 358 | var charstring txt := msgs[lengthof(msgs) - 1] & "\r\n"; |
| 359 | msg := dec_AMI_Msg_ext(txt); |
| 360 | CLIENT.send(msg); |
| 361 | buf := ""; |
| 362 | } else { |
| 363 | buf := msgs[lengthof(msgs) - 1]; |
| 364 | } |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 365 | } |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 366 | log("AMI remain buf: '", buf, "'"); |
| 367 | } |
| 368 | [] IPL4.receive(ASP_ConnId_ReadyToRelease:?) { |
| 369 | } |
| 370 | |
| 371 | [] IPL4.receive(ASP_Event:?) -> value rx_ev { |
| 372 | log("Rx AMI ASP_Event: ", rx_ev); |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 373 | } |
| 374 | [] CLIENT.receive(AMI_Msg:?) -> value msg { |
| 375 | /* TODO: in the future, queue Action if there's already one Action in transit, to fullfill AMI requirements. */ |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 376 | var charstring tx_txt := enc_AMI_Msg(msg) & "\r\n"; |
| 377 | |
| 378 | var ASP_SendTo tx := { |
| 379 | connId := g_self_conn_id, |
| 380 | remName := g_pars.remote_host, |
| 381 | remPort := g_pars.remote_port, |
| 382 | proto := { tcp := {} }, |
| 383 | msg := char2oct(tx_txt) |
| 384 | }; |
| 385 | IPL4.send(tx); |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 386 | } |
| 387 | } |
| 388 | } |
| 389 | } |
| 390 | |
| 391 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 392 | /* |
| 393 | * Functions: |
| 394 | */ |
| 395 | |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 396 | /* Generate a random "ActionId" value: */ |
| 397 | function f_gen_action_id() return charstring { |
| 398 | return hex2str(f_rnd_hexstring(16)); |
| 399 | } |
| 400 | |
| 401 | function f_ami_msg_find(AMI_Msg msg, |
| 402 | template (present) charstring key := ?) |
| 403 | return template (omit) AMI_Field { |
| 404 | var integer i; |
| 405 | |
| 406 | for (i := 0; i < lengthof(msg); i := i + 1) { |
| 407 | if (not ispresent(msg[i])) { |
| 408 | continue; |
| 409 | } |
| 410 | if (match(msg[i].key, key)) { |
| 411 | return msg[i]; |
| 412 | } |
| 413 | } |
| 414 | return omit; |
| 415 | } |
| 416 | |
| 417 | function f_ami_msg_find_or_fail(AMI_Msg msg, |
| 418 | template (present) charstring key := ?) |
| 419 | return AMI_Field { |
| 420 | var template (omit) AMI_Field field; |
| 421 | field := f_ami_msg_find(msg, key); |
| 422 | if (istemplatekind(field, "omit")) { |
| 423 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 424 | log2str("Key ", key, " not found in ", msg)); |
| 425 | } |
| 426 | return valueof(field); |
| 427 | } |
| 428 | |
| 429 | function f_ami_msg_get_value(AMI_Msg msg, |
| 430 | template (present) charstring key := ?) |
| 431 | return template (omit) charstring { |
| 432 | var template (omit) AMI_Field field; |
| 433 | field := f_ami_msg_find(msg, key); |
| 434 | if (istemplatekind(field, "omit")) { |
| 435 | return omit; |
| 436 | } |
| 437 | return field.val; |
| 438 | } |
| 439 | |
| 440 | function f_ami_msg_get_value_or_fail(AMI_Msg msg, |
| 441 | template (present) charstring key := ?) |
| 442 | return template charstring { |
| 443 | var AMI_Field field; |
| 444 | field := f_ami_msg_find_or_fail(msg, key); |
| 445 | return field.val; |
| 446 | } |
| 447 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 448 | function f_ami_transceive_ret(AMI_Msg_PT pt, template (value) AMI_Msg tx_msg, float rx_timeout := 10.0) return AMI_Msg { |
| 449 | var AMI_Msg rx_msg; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 450 | timer T; |
| 451 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 452 | T.start(rx_timeout); |
| 453 | pt.send(tx_msg); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 454 | alt { |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 455 | [] pt.receive(AMI_Msg:?) -> value rx_msg; |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 456 | [] T.timeout { |
| 457 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 458 | log2str("AMI Response timeout: ", tx_msg)); |
| 459 | } |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 460 | } |
| 461 | T.stop; |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 462 | return rx_msg; |
| 463 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 464 | } |
| 465 | |
Pau Espin Pedrol | e98f441 | 2024-05-17 19:33:46 +0200 | [diff] [blame] | 466 | altstep as_ami_rx_ignore(AMI_Msg_PT pt) |
| 467 | { |
| 468 | var AMI_Msg msg; |
| 469 | [] pt.receive(AMI_Msg:?) -> value msg { |
| 470 | log("Ignoring AMI message := ", msg); |
| 471 | repeat; |
| 472 | } |
| 473 | } |
| 474 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 475 | private altstep as_ami_rx_fail(AMI_Msg_PT pt, template AMI_Msg exp_msg := *) |
| 476 | { |
| 477 | var AMI_Msg msg; |
| 478 | [] pt.receive(AMI_Msg:?) -> value msg { |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 479 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 480 | log2str("Received unexpected AMI message := ", msg, "\nvs exp := ", exp_msg)); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 481 | } |
| 482 | } |
| 483 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 484 | altstep as_ami_expect_msg(AMI_Msg_PT pt, template (present) AMI_Msg msg_expect, boolean fail_others := true) |
| 485 | { |
| 486 | [] pt.receive(msg_expect); |
| 487 | [fail_others] as_ami_rx_fail(pt, msg_expect); |
| 488 | } |
| 489 | |
| 490 | function f_ami_transceive_match(AMI_Msg_PT pt, |
| 491 | template (value) AMI_Msg tx_msg, |
| 492 | template (present) AMI_Msg exp_ret := ?, |
| 493 | boolean fail_others := true, |
| 494 | float rx_timeout := 10.0) return AMI_Msg { |
| 495 | var AMI_Msg rx_msg; |
| 496 | timer T; |
| 497 | |
| 498 | T.start(rx_timeout); |
| 499 | pt.send(tx_msg); |
| 500 | alt { |
| 501 | [] pt.receive(exp_ret) -> value rx_msg; |
| 502 | [not fail_others] pt.receive(AMI_Msg:?) -> value rx_msg { |
| 503 | log("AMI: Ignoring Rx msg ", rx_msg); |
| 504 | repeat; |
| 505 | } |
| 506 | [fail_others] as_ami_rx_fail(pt, exp_ret); |
| 507 | [] T.timeout { |
| 508 | Misc_Helpers.f_shutdown(__BFILE__, __LINE__, fail, |
| 509 | log2str("AMI Response timeout: ", tx_msg)); |
| 510 | } |
| 511 | } |
| 512 | T.stop; |
| 513 | return rx_msg; |
| 514 | } |
| 515 | |
| 516 | function f_ami_transceive_match_response_success(AMI_Msg_PT pt, |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 517 | template (value) AMI_Msg tx_msg) { |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 518 | var template (present) AMI_Msg exp_resp; |
| 519 | var template (omit) charstring action_id := f_ami_msg_get_value(valueof(tx_msg), AMI_FIELD_ACTION_ID); |
| 520 | if (isvalue(action_id)) { |
| 521 | exp_resp := tr_AMI_Response_Success_ActionId(action_id); |
| 522 | } else { |
| 523 | exp_resp := tr_AMI_Response_Success; |
| 524 | } |
| 525 | f_ami_transceive_match(pt, tx_msg, exp_resp); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 526 | } |
| 527 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 528 | function f_ami_action_login(AMI_Msg_PT pt, charstring username, charstring secret) { |
Pau Espin Pedrol | 77976a6 | 2024-05-08 21:17:38 +0200 | [diff] [blame] | 529 | var charstring reg_action_id := f_gen_action_id(); |
| 530 | f_ami_transceive_match_response_success(pt, ts_AMI_Action_Login(username, secret, reg_action_id)); |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 531 | } |
| 532 | |
Pau Espin Pedrol | 0c5c647 | 2024-05-21 13:13:49 +0200 | [diff] [blame^] | 533 | function f_ami_action_PJSIPAccessNetworkInfo(AMI_Msg_PT pt, |
| 534 | template (value) charstring registration, |
| 535 | template (value) charstring info) { |
| 536 | var charstring reg_action_id := f_gen_action_id(); |
| 537 | f_ami_transceive_match_response_success(pt, ts_AMI_Action_PJSIPAccessNetworkInfo(registration, info, reg_action_id)); |
| 538 | } |
| 539 | |
Pau Espin Pedrol | bcb4e82 | 2024-04-26 20:16:47 +0200 | [diff] [blame] | 540 | function f_ami_action_PJSIPRegister(AMI_Msg_PT pt, charstring register) { |
Pau Espin Pedrol | 4362dbd | 2024-04-26 19:31:27 +0200 | [diff] [blame] | 541 | var charstring reg_action_id := f_gen_action_id(); |
| 542 | f_ami_transceive_match_response_success(pt, ts_AMI_Action_PJSIPRegister(register, reg_action_id)); |
| 543 | } |
| 544 | |
Pau Espin Pedrol | 01f1df8 | 2024-05-08 16:55:55 +0200 | [diff] [blame] | 545 | private function f_ami_selftest_decode(charstring txt) { |
| 546 | log("Text to decode: '", txt, "'"); |
| 547 | var AMI_Msg msg := dec_AMI_Msg(txt); |
| 548 | log("AMI_Msg decoded: ", msg); |
| 549 | } |
| 550 | |
| 551 | function f_ami_selftest() { |
| 552 | f_ami_selftest_decode("AppData: 5,0502: Call pjsip endpoint from 0501\r\n"); |
| 553 | } |
| 554 | |
Pau Espin Pedrol | 54b614a | 2024-04-17 18:58:36 +0200 | [diff] [blame] | 555 | } |