xref: /btstack/src/classic/pbap_client.c (revision 0729a915d322714d8894f919f4ae4bc7bff5e5da)
1 /*
2  * Copyright (C) 2014 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 #define __BTSTACK_FILE__ "pbap_client.c"
39 
40 // *****************************************************************************
41 //
42 #if 0
43     0x0000 = uint32(65542),
44     // BLUETOOTH_SERVICE_CLASS_PHONEBOOK_ACCESS_PSE
45     0x0001 = { uuid16(11 2f) },
46     // BLUETOOTH_PROTOCOL_L2CAP, BLUETOOTH_PROTOCOL_RFCOMM, BLUETOOTH_PROTOCOL_OBEX
47     0x0004 = { { uuid16(01 00) }, { uuid16(00 03), uint8(19) }, { uuid16(00 08) } }
48     0x0005 = { uuid16(10 02) },
49     // BLUETOOTH_SERVICE_CLASS_PHONEBOOK_ACCESS, v1.01 = 0x101
50     0x0009 = { { uuid16(11 30), uint16(257) } },
51     0x0100 = string(OBEX Phonebook Access Server
52     // BLUETOOTH_ATTRIBUTE_SUPPORTED_FEATURES -- should be 0x317 BLUETOOTH_ATTRIBUTE_PBAP_SUPPORTED_FEATURES?
53     0x0311 = uint8(3),
54     // BLUETOOTH_ATTRIBUTE_SUPPORTED_REPOSITORIES
55     0x0314 = uint8(1),
56 #endif
57 //
58 // *****************************************************************************
59 
60 #include "btstack_config.h"
61 
62 #include <stdint.h>
63 #include <stdio.h>
64 #include <stdlib.h>
65 #include <string.h>
66 
67 #include "hci_cmd.h"
68 #include "btstack_run_loop.h"
69 #include "btstack_debug.h"
70 #include "hci.h"
71 #include "btstack_memory.h"
72 #include "hci_dump.h"
73 #include "l2cap.h"
74 #include "bluetooth_sdp.h"
75 #include "classic/sdp_client_rfcomm.h"
76 #include "btstack_event.h"
77 
78 #include "classic/obex.h"
79 #include "classic/obex_iterator.h"
80 #include "classic/goep_client.h"
81 #include "classic/pbap_client.h"
82 
83 // 796135f0-f0c5-11d8-0966- 0800200c9a66
84 uint8_t pbap_uuid[] = { 0x79, 0x61, 0x35, 0xf0, 0xf0, 0xc5, 0x11, 0xd8, 0x09, 0x66, 0x08, 0x00, 0x20, 0x0c, 0x9a, 0x66};
85 const char * pbap_type = "x-bt/phonebook";
86 const char * pbap_name = "pb.vcf";
87 
88 typedef enum {
89     PBAP_INIT = 0,
90     PBAP_W4_GOEP_CONNECTION,
91     PBAP_W2_SEND_CONNECT_REQUEST,
92     PBAP_W4_CONNECT_RESPONSE,
93     PBAP_CONNECT_RESPONSE_RECEIVED,
94     PBAP_CONNECTED,
95     //
96     PBAP_W2_SEND_DISCONNECT_REQUEST,
97     PBAP_W4_DISCONNECT_RESPONSE,
98     //
99     PBAP_W2_PULL_PHONEBOOK,
100     PBAP_W4_PHONEBOOK,
101     PBAP_W2_SET_PATH_ROOT,
102     PBAP_W4_SET_PATH_ROOT_COMPLETE,
103     PBAP_W2_SET_PATH_ELEMENT,
104     PBAP_W4_SET_PATH_ELEMENT_COMPLETE,
105     PBAP_W2_GET_PHONEBOOK_SIZE,
106     PBAP_W4_GET_PHONEBOOK_SIZE_COMPLETE,
107 } pbap_state_t;
108 
109 typedef struct pbap_client {
110     pbap_state_t state;
111     uint16_t  cid;
112     bd_addr_t bd_addr;
113     hci_con_handle_t con_handle;
114     uint8_t   incoming;
115     uint16_t  goep_cid;
116     btstack_packet_handler_t client_handler;
117     const char * current_folder;
118     uint16_t set_path_offset;
119 } pbap_client_t;
120 
121 static pbap_client_t _pbap_client;
122 static pbap_client_t * pbap_client = &_pbap_client;
123 
124 static void pbap_client_emit_connected_event(pbap_client_t * context, uint8_t status){
125     uint8_t event[15];
126     int pos = 0;
127     event[pos++] = HCI_EVENT_PBAP_META;
128     pos++;  // skip len
129     event[pos++] = PBAP_SUBEVENT_CONNECTION_OPENED;
130     little_endian_store_16(event,pos,context->cid);
131     pos+=2;
132     event[pos++] = status;
133     memcpy(&event[pos], context->bd_addr, 6);
134     pos += 6;
135     little_endian_store_16(event,pos,context->con_handle);
136     pos += 2;
137     event[pos++] = context->incoming;
138     event[1] = pos - 2;
139     if (pos != sizeof(event)) log_error("goep_client_emit_connected_event size %u", pos);
140     context->client_handler(HCI_EVENT_PACKET, context->cid, &event[0], pos);
141 }
142 
143 static void pbap_client_emit_connection_closed_event(pbap_client_t * context){
144     uint8_t event[5];
145     int pos = 0;
146     event[pos++] = HCI_EVENT_PBAP_META;
147     pos++;  // skip len
148     event[pos++] = PBAP_SUBEVENT_CONNECTION_CLOSED;
149     little_endian_store_16(event,pos,context->cid);
150     pos+=2;
151     event[1] = pos - 2;
152     if (pos != sizeof(event)) log_error("pbap_client_emit_connection_closed_event size %u", pos);
153     context->client_handler(HCI_EVENT_PACKET, context->cid, &event[0], pos);
154 }
155 
156 static void pbap_client_emit_operation_complete_event(pbap_client_t * context, uint8_t status){
157     uint8_t event[6];
158     int pos = 0;
159     event[pos++] = HCI_EVENT_PBAP_META;
160     pos++;  // skip len
161     event[pos++] = PBAP_SUBEVENT_OPERATION_COMPLETED;
162     little_endian_store_16(event,pos,context->cid);
163     pos+=2;
164     event[pos++]= status;
165     event[1] = pos - 2;
166     if (pos != sizeof(event)) log_error("pbap_client_emit_can_send_now_event size %u", pos);
167     context->client_handler(HCI_EVENT_PACKET, context->cid, &event[0], pos);
168 }
169 
170 static void pbap_client_emit_phonebook_size_event(pbap_client_t * context, uint8_t status, uint16_t phonebook_size){
171     uint8_t event[8];
172     int pos = 0;
173     event[pos++] = HCI_EVENT_PBAP_META;
174     pos++;  // skip len
175     event[pos++] = PBAP_SUBEVENT_PHONEBOOK_SIZE;
176     little_endian_store_16(event,pos,context->cid);
177     pos+=2;
178     event[pos++] = status;
179     little_endian_store_16(event,pos, phonebook_size);
180     pos+=2;
181     event[1] = pos - 2;
182     if (pos != sizeof(event)) log_error("pbap_client_emit_phonebook_size_event size %u", pos);
183     context->client_handler(HCI_EVENT_PACKET, context->cid, &event[0], pos);
184 }
185 
186 static void pbap_handle_can_send_now(void){
187     uint8_t  path_element[20];
188     uint16_t path_element_start;
189     uint16_t path_element_len;
190     uint8_t  application_parameters[20];
191 
192     switch (pbap_client->state){
193         case PBAP_W2_SEND_CONNECT_REQUEST:
194             goep_client_create_connect_request(pbap_client->goep_cid, OBEX_VERSION, 0, OBEX_MAX_PACKETLEN_DEFAULT);
195             goep_client_add_header_target(pbap_client->goep_cid, 16, pbap_uuid);
196             pbap_client->state = PBAP_W4_CONNECT_RESPONSE;
197             goep_client_execute(pbap_client->goep_cid);
198             return;
199         case PBAP_W2_SEND_DISCONNECT_REQUEST:
200             goep_client_create_disconnect_request(pbap_client->goep_cid);
201             pbap_client->state = PBAP_W4_DISCONNECT_RESPONSE;
202             goep_client_execute(pbap_client->goep_cid);
203             return;
204         case PBAP_W2_PULL_PHONEBOOK:
205         case PBAP_W2_GET_PHONEBOOK_SIZE:
206             goep_client_create_get_request(pbap_client->goep_cid);
207             goep_client_add_header_type(pbap_client->goep_cid, pbap_type);
208             goep_client_add_header_name(pbap_client->goep_cid, pbap_name);
209             if (pbap_client->state == PBAP_W2_GET_PHONEBOOK_SIZE){
210                 // Regular TLV wih 1-byte len
211                 application_parameters[0] = PBAP_APPLICATION_PARAMETER_MAX_LIST_COUNT;
212                 application_parameters[1] = 2;
213                 big_endian_store_16(application_parameters, 2, 0);
214                 goep_client_add_header_application_parameters(pbap_client->goep_cid, 4, &application_parameters[0]);
215                 // state
216                 pbap_client->state = PBAP_W4_GET_PHONEBOOK_SIZE_COMPLETE;
217             } else {
218                 // state
219                 pbap_client->state = PBAP_W4_PHONEBOOK;
220             }
221             // send packet
222             goep_client_execute(pbap_client->goep_cid);
223             break;
224         case PBAP_W2_SET_PATH_ROOT:
225             goep_client_create_set_path_request(pbap_client->goep_cid, 1 << 1); // Don’t create directory
226             // On Android 4.2 Cyanogenmod, using "" as path fails
227             // goep_client_add_header_name(pbap_client->goep_cid, "");     // empty == /
228             // state
229             pbap_client->state = PBAP_W4_SET_PATH_ROOT_COMPLETE;
230             // send packet
231             goep_client_execute(pbap_client->goep_cid);
232             break;
233         case PBAP_W2_SET_PATH_ELEMENT:
234             // find '/' or '\0'
235             path_element_start = pbap_client->set_path_offset;
236             while (pbap_client->current_folder[pbap_client->set_path_offset] != '\0' &&
237                 pbap_client->current_folder[pbap_client->set_path_offset] != '/'){
238                 pbap_client->set_path_offset++;
239             }
240             // skip /
241             if (pbap_client->current_folder[pbap_client->set_path_offset] == '/'){
242                 pbap_client->set_path_offset++;
243             }
244             path_element_len = pbap_client->set_path_offset-path_element_start;
245             memcpy(path_element, &pbap_client->current_folder[path_element_start], path_element_len);
246             path_element[path_element_len] = 0;
247 
248             goep_client_create_set_path_request(pbap_client->goep_cid, 1 << 1); // Don’t create directory
249             goep_client_add_header_name(pbap_client->goep_cid, (const char *) path_element); // next element
250             // state
251             pbap_client->state = PBAP_W4_SET_PATH_ELEMENT_COMPLETE;
252             // send packet
253             goep_client_execute(pbap_client->goep_cid);
254             break;
255         default:
256             break;
257     }
258 }
259 
260 static void pbap_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
261 
262     UNUSED(channel); // ok: there is no channel
263     UNUSED(size);    // ok: handling own geop events
264 
265     obex_iterator_t it;
266     uint8_t status;
267     switch (packet_type){
268         case HCI_EVENT_PACKET:
269             switch (hci_event_packet_get_type(packet)) {
270                 case HCI_EVENT_GOEP_META:
271                     switch (hci_event_goep_meta_get_subevent_code(packet)){
272                         case GOEP_SUBEVENT_CONNECTION_OPENED:
273                             status = goep_subevent_connection_opened_get_status(packet);
274                             pbap_client->con_handle = goep_subevent_connection_opened_get_con_handle(packet);
275                             pbap_client->incoming = goep_subevent_connection_opened_get_incoming(packet);
276                             goep_subevent_connection_opened_get_bd_addr(packet, pbap_client->bd_addr);
277                             if (status){
278                                 log_info("pbap: connection failed %u", status);
279                                 pbap_client->state = PBAP_INIT;
280                                 pbap_client_emit_connected_event(pbap_client, status);
281                             } else {
282                                 log_info("pbap: connection established");
283                                 pbap_client->goep_cid = goep_subevent_connection_opened_get_goep_cid(packet);
284                                 pbap_client->state = PBAP_W2_SEND_CONNECT_REQUEST;
285                                 goep_client_request_can_send_now(pbap_client->goep_cid);
286                             }
287                             break;
288                         case GOEP_SUBEVENT_CONNECTION_CLOSED:
289                             if (pbap_client->state != PBAP_CONNECTED){
290                                 pbap_client_emit_operation_complete_event(pbap_client, OBEX_DISCONNECTED);
291                             }
292                             pbap_client->state = PBAP_INIT;
293                             pbap_client_emit_connection_closed_event(pbap_client);
294                             break;
295                         case GOEP_SUBEVENT_CAN_SEND_NOW:
296                             pbap_handle_can_send_now();
297                             break;
298                     }
299                     break;
300                 default:
301                     break;
302             }
303             break;
304         case GOEP_DATA_PACKET:
305             // TODO: handle chunked data
306 #if 0
307             obex_dump_packet(goep_client_get_request_opcode(pbap_client->goep_cid), packet, size);
308 #endif
309             switch (pbap_client->state){
310                 case PBAP_W4_CONNECT_RESPONSE:
311                     for (obex_iterator_init_with_response_packet(&it, goep_client_get_request_opcode(pbap_client->goep_cid), packet, size); obex_iterator_has_more(&it) ; obex_iterator_next(&it)){
312                         uint8_t hi = obex_iterator_get_hi(&it);
313                         if (hi == OBEX_HEADER_CONNECTION_ID){
314                             goep_client_set_connection_id(pbap_client->goep_cid, obex_iterator_get_data_32(&it));
315                         }
316                     }
317                     if (packet[0] == OBEX_RESP_SUCCESS){
318                         pbap_client->state = PBAP_CONNECTED;
319                         pbap_client_emit_connected_event(pbap_client, 0);
320                     } else {
321                         log_info("pbap: obex connect failed, result 0x%02x", packet[0]);
322                         pbap_client->state = PBAP_INIT;
323                         pbap_client_emit_connected_event(pbap_client, OBEX_CONNECT_FAILED);
324                     }
325                     break;
326                 case PBAP_W4_DISCONNECT_RESPONSE:
327                         goep_client_disconnect(pbap_client->goep_cid);
328                         break;
329                 case PBAP_W4_SET_PATH_ROOT_COMPLETE:
330                 case PBAP_W4_SET_PATH_ELEMENT_COMPLETE:
331                     if (packet[0] == OBEX_RESP_SUCCESS){
332                         if (pbap_client->current_folder){
333                             pbap_client->state = PBAP_W2_SET_PATH_ELEMENT;
334                             goep_client_request_can_send_now(pbap_client->goep_cid);
335                         } else {
336                             pbap_client_emit_operation_complete_event(pbap_client, 0);
337                         }
338                     } else if (packet[0] == OBEX_RESP_NOT_FOUND){
339                         pbap_client->state = PBAP_CONNECTED;
340                         pbap_client_emit_operation_complete_event(pbap_client, OBEX_NOT_FOUND);
341                     } else {
342                         pbap_client->state = PBAP_CONNECTED;
343                         pbap_client_emit_operation_complete_event(pbap_client, OBEX_UNKNOWN_ERROR);
344                     }
345                     break;
346                 case PBAP_W4_PHONEBOOK:
347                     for (obex_iterator_init_with_response_packet(&it, goep_client_get_request_opcode(pbap_client->goep_cid), packet, size); obex_iterator_has_more(&it) ; obex_iterator_next(&it)){
348                         uint8_t hi = obex_iterator_get_hi(&it);
349                         if (hi == OBEX_HEADER_BODY || hi == OBEX_HEADER_END_OF_BODY){
350                             uint16_t     data_len = obex_iterator_get_data_len(&it);
351                             const uint8_t  * data =  obex_iterator_get_data(&it);
352                             pbap_client->client_handler(PBAP_DATA_PACKET, pbap_client->cid, (uint8_t *) data, data_len);
353                         }
354                     }
355                     if (packet[0] == OBEX_RESP_CONTINUE){
356                         pbap_client->state = PBAP_W2_PULL_PHONEBOOK;
357                         goep_client_request_can_send_now(pbap_client->goep_cid);
358                     } else if (packet[0] == OBEX_RESP_SUCCESS){
359                         pbap_client->state = PBAP_CONNECTED;
360                         pbap_client_emit_operation_complete_event(pbap_client, 0);
361                     } else {
362                         pbap_client->state = PBAP_CONNECTED;
363                         pbap_client_emit_operation_complete_event(pbap_client, OBEX_UNKNOWN_ERROR);
364                     }
365                     break;
366                 case PBAP_W4_GET_PHONEBOOK_SIZE_COMPLETE:
367                     pbap_client->state = PBAP_CONNECTED;
368                     if (packet[0] == OBEX_RESP_SUCCESS){
369                         int have_size = 0;
370                         uint16_t phonebook_size;
371                         for (obex_iterator_init_with_response_packet(&it, goep_client_get_request_opcode(pbap_client->goep_cid), packet, size); obex_iterator_has_more(&it) ; obex_iterator_next(&it)){
372                             uint8_t hi = obex_iterator_get_hi(&it);
373                             if (hi == OBEX_HEADER_APPLICATION_PARAMETERS){
374                                 uint16_t     data_len = obex_iterator_get_data_len(&it);
375                                 const uint8_t  * data =  obex_iterator_get_data(&it);
376                                 // iterate over application headers (TLV with 1 bytes len)
377                                 unsigned int i = 0;
378                                 while (i<data_len){
379                                     uint8_t tag = data[i++];
380                                     uint8_t len = data[i++];
381                                     if (tag == PBAP_APPLICATION_PARAMETER_PHONEBOOK_SIZE && len == 2){
382                                         have_size = 1;
383                                         phonebook_size = big_endian_read_16(data, i);
384                                     }
385                                     i+=len;
386                                 }
387                             }
388                         }
389                         if (have_size){
390                             pbap_client_emit_phonebook_size_event(pbap_client, 0, phonebook_size);
391                             break;
392                         }
393                     }
394                     pbap_client_emit_phonebook_size_event(pbap_client, OBEX_UNKNOWN_ERROR, 0);
395                     break;
396                 default:
397                     break;
398             }
399             break;
400         default:
401             break;
402     }
403 }
404 
405 void pbap_client_init(void){
406     memset(pbap_client, 0, sizeof(pbap_client_t));
407     pbap_client->state = PBAP_INIT;
408     pbap_client->cid = 1;
409 }
410 
411 uint8_t pbap_connect(btstack_packet_handler_t handler, bd_addr_t addr, uint16_t * out_cid){
412     if (pbap_client->state != PBAP_INIT) return BTSTACK_MEMORY_ALLOC_FAILED;
413     pbap_client->state = PBAP_W4_GOEP_CONNECTION;
414     pbap_client->client_handler = handler;
415     uint8_t err = goep_client_create_connection(&pbap_packet_handler, addr, BLUETOOTH_SERVICE_CLASS_PHONEBOOK_ACCESS_PSE, &pbap_client->goep_cid);
416     *out_cid = pbap_client->cid;
417     if (err) return err;
418     return 0;
419 }
420 
421 uint8_t pbap_disconnect(uint16_t pbap_cid){
422     UNUSED(pbap_cid);
423     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
424     pbap_client->state = PBAP_W2_SEND_DISCONNECT_REQUEST;
425     goep_client_request_can_send_now(pbap_client->goep_cid);
426     return 0;
427 }
428 
429 uint8_t pbap_get_phonebook_size(uint16_t pbap_cid){
430     UNUSED(pbap_cid);
431     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
432     pbap_client->state = PBAP_W2_GET_PHONEBOOK_SIZE;
433     goep_client_request_can_send_now(pbap_client->goep_cid);
434     return 0;
435 }
436 
437 uint8_t pbap_pull_phonebook(uint16_t pbap_cid){
438     UNUSED(pbap_cid);
439     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
440     pbap_client->state = PBAP_W2_PULL_PHONEBOOK;
441     goep_client_request_can_send_now(pbap_client->goep_cid);
442     return 0;
443 }
444 
445 uint8_t pbap_set_phonebook(uint16_t pbap_cid, const char * path){
446     UNUSED(pbap_cid);
447     if (pbap_client->state != PBAP_CONNECTED) return BTSTACK_BUSY;
448     pbap_client->state = PBAP_W2_SET_PATH_ROOT;
449     pbap_client->current_folder = path;
450     pbap_client->set_path_offset = 0;
451     goep_client_request_can_send_now(pbap_client->goep_cid);
452     return 0;
453 }
454