1 /*
2  * Copyright (c) 2008-2009, Motorola, Inc.
3  *
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * - Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * - Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * - Neither the name of the Motorola, Inc. nor the names of its contributors
17  * may be used to endorse or promote products derived from this software
18  * without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 package com.android.bluetooth.opp;
34 
35 import java.io.IOException;
36 import java.util.regex.Pattern;
37 
38 import javax.obex.HeaderSet;
39 
40 import android.content.ContentValues;
41 import android.content.Context;
42 import android.content.Intent;
43 import android.net.Uri;
44 import android.util.Log;
45 
46 /**
47  * Bluetooth OPP internal constants definition
48  */
49 public class Constants {
50     /** Tag used for debugging/logging */
51     public static final String TAG = "BluetoothOpp";
52 
53     /**
54      * The intent that gets sent when the service must wake up for a retry Note:
55      * only retry Outbound transfer
56      */
57     public static final String ACTION_RETRY = "android.btopp.intent.action.RETRY";
58 
59     /** the intent that gets sent when clicking a successful transfer */
60     public static final String ACTION_OPEN = "android.btopp.intent.action.OPEN";
61 
62     /** the intent that gets sent when clicking outbound transfer notification */
63     public static final String ACTION_OPEN_OUTBOUND_TRANSFER = "android.btopp.intent.action.OPEN_OUTBOUND";
64 
65     /** the intent that gets sent when clicking a inbound transfer notification */
66     public static final String ACTION_OPEN_INBOUND_TRANSFER = "android.btopp.intent.action.OPEN_INBOUND";
67 
68     /** the intent that gets sent from the Settings app to show the received files */
69     public static final String ACTION_OPEN_RECEIVED_FILES = "android.btopp.intent.action.OPEN_RECEIVED_FILES";
70 
71     /** the intent that whitelists a remote bluetooth device for auto-receive confirmation (NFC) */
72     public static final String ACTION_WHITELIST_DEVICE = "android.btopp.intent.action.WHITELIST_DEVICE";
73 
74     /** the intent that can be sent by handover requesters to stop a BTOPP transfer */
75     public static final String ACTION_STOP_HANDOVER = "android.btopp.intent.action.STOP_HANDOVER_TRANSFER";
76 
77     /** the intent extra to show all received files in the transfer history */
78     public static final String EXTRA_SHOW_ALL_FILES = "android.btopp.intent.extra.SHOW_ALL";
79 
80     /** the intent that gets sent when clicking an incomplete/failed transfer */
81     public static final String ACTION_LIST = "android.btopp.intent.action.LIST";
82 
83     /** the intent that is used for initiating a handover transfer */
84     public static final String ACTION_HANDOVER_SEND =
85             "android.nfc.handover.intent.action.HANDOVER_SEND";
86 
87     /** the intent that is used for initiating a multi-uri handover transfer */
88     public static final String ACTION_HANDOVER_SEND_MULTIPLE =
89             "android.nfc.handover.intent.action.HANDOVER_SEND_MULTIPLE";
90 
91     /** the intent that is used for indicating an incoming transfer*/
92     public static final String ACTION_HANDOVER_STARTED =
93             "android.nfc.handover.intent.action.HANDOVER_STARTED";
94 
95     /** intent action used to indicate the progress of a handover transfer */
96     public static final String ACTION_BT_OPP_TRANSFER_PROGRESS =
97             "android.nfc.handover.intent.action.TRANSFER_PROGRESS";
98 
99     /** intent action used to indicate the completion of a handover transfer */
100     public static final String ACTION_BT_OPP_TRANSFER_DONE =
101             "android.nfc.handover.intent.action.TRANSFER_DONE";
102 
103     /** intent extra used to indicate the success of a handover transfer */
104     public static final String EXTRA_BT_OPP_TRANSFER_STATUS =
105             "android.nfc.handover.intent.extra.TRANSFER_STATUS";
106 
107     /** intent extra used to indicate the address associated with the transfer */
108     public static final String EXTRA_BT_OPP_ADDRESS =
109             "android.nfc.handover.intent.extra.ADDRESS";
110 
111     public static final String EXTRA_BT_OPP_OBJECT_COUNT =
112             "android.nfc.handover.intent.extra.OBJECT_COUNT";
113 
114     public static final int COUNT_HEADER_UNAVAILABLE = -1;
115     public static final int HANDOVER_TRANSFER_STATUS_SUCCESS = 0;
116 
117     public static final int HANDOVER_TRANSFER_STATUS_FAILURE = 1;
118 
119     /** intent extra used to indicate the direction of a handover transfer */
120     public static final String EXTRA_BT_OPP_TRANSFER_DIRECTION =
121             "android.nfc.handover.intent.extra.TRANSFER_DIRECTION";
122 
123     public static final int DIRECTION_BLUETOOTH_INCOMING = 0;
124 
125     public static final int DIRECTION_BLUETOOTH_OUTGOING = 1;
126 
127     /** intent extra used to provide a unique ID for the transfer */
128     public static final String EXTRA_BT_OPP_TRANSFER_ID =
129             "android.nfc.handover.intent.extra.TRANSFER_ID";
130 
131     /** intent extra used to provide progress of the transfer */
132     public static final String EXTRA_BT_OPP_TRANSFER_PROGRESS =
133             "android.nfc.handover.intent.extra.TRANSFER_PROGRESS";
134 
135     /** intent extra used to provide the Uri where the data was stored
136      * by the handover transfer */
137     public static final String EXTRA_BT_OPP_TRANSFER_URI =
138             "android.nfc.handover.intent.extra.TRANSFER_URI";
139 
140     /** intent extra used to provide the mime-type of the data in
141      *  the handover transfer */
142     public static final String EXTRA_BT_OPP_TRANSFER_MIMETYPE =
143             "android.nfc.handover.intent.extra.TRANSFER_MIME_TYPE";
144 
145     /** permission needed to be able to receive handover status requests */
146     public static final String HANDOVER_STATUS_PERMISSION =
147             "android.permission.NFC_HANDOVER_STATUS";
148 
149     /** intent extra that indicates this transfer is a handover from another
150       * transport (NFC, WIFI)
151       */
152     public static final String EXTRA_CONNECTION_HANDOVER =
153             "com.android.intent.extra.CONNECTION_HANDOVER";
154 
155     /**
156      * the intent that gets sent when deleting the incoming file confirmation notification
157      */
158     public static final String ACTION_HIDE = "android.btopp.intent.action.HIDE";
159 
160     /**
161      * the intent that gets sent when accepting the incoming file confirmation notification
162      */
163     public static final String ACTION_ACCEPT = "android.btopp.intent.action.ACCEPT";
164 
165     /**
166      * the intent that gets sent when declining the incoming file confirmation notification
167      */
168     public static final String ACTION_DECLINE = "android.btopp.intent.action.DECLINE";
169 
170     /**
171      * the intent that gets sent when deleting the notifications of outbound and
172      * inbound completed transfer
173      */
174     public static final String ACTION_COMPLETE_HIDE = "android.btopp.intent.action.HIDE_COMPLETE";
175 
176     /**
177      * the intent that gets sent when clicking a incoming file confirm
178      * notification
179      */
180     public static final String ACTION_INCOMING_FILE_CONFIRM = "android.btopp.intent.action.CONFIRM";
181 
182     public static final String THIS_PACKAGE_NAME = "com.android.bluetooth";
183 
184     /**
185      * The column that is used to remember whether the media scanner was invoked
186      */
187     public static final String MEDIA_SCANNED = "scanned";
188 
189     public static final int MEDIA_SCANNED_NOT_SCANNED = 0;
190 
191     public static final int MEDIA_SCANNED_SCANNED_OK = 1;
192 
193     public static final int MEDIA_SCANNED_SCANNED_FAILED = 2;
194 
195     /**
196      * The MIME type(s) of we could share to other device.
197      */
198     /*
199      * TODO: define correct type list
200      */
201     public static final String[] ACCEPTABLE_SHARE_OUTBOUND_TYPES = new String[] {
202         "image/*", "text/x-vcard",
203     };
204 
205     /**
206      * The MIME type(s) of we could not share to other device. TODO: define
207      * correct type list
208      */
209     public static final String[] UNACCEPTABLE_SHARE_OUTBOUND_TYPES = new String[] {
210         "virus/*",
211     };
212 
213     /**
214      * The MIME type(s) of we could accept from other device.
215      * This is in essence a "white list" of acceptable types.
216      * Today, restricted to images, audio, video and certain text types.
217      */
218     public static final String[] ACCEPTABLE_SHARE_INBOUND_TYPES = new String[] {
219         "image/*",
220         "video/*",
221         "audio/*",
222         "text/x-vcard",
223         "text/plain",
224         "text/html",
225         "text/xml",
226         "application/zip",
227         "application/vnd.ms-excel",
228         "application/msword",
229         "application/vnd.ms-powerpoint",
230         "application/pdf",
231         "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
232         "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
233         "application/vnd.openxmlformats-officedocument.presentationml.presentation",
234         "application/x-hwp",
235     };
236 
237     /**
238      * The MIME type(s) of we could not accept from other device. TODO: define
239      * correct type list
240      */
241     public static final String[] UNACCEPTABLE_SHARE_INBOUND_TYPES = new String[] {
242         "text/x-vcalendar",
243     };
244 
245     /** Where we store Bluetooth received files on the external storage */
246     public static final String DEFAULT_STORE_SUBDIR = "/bluetooth";
247 
248     /**
249      * Debug level logging
250      */
251     public static final boolean DEBUG = true;
252 
253     /**
254      * Verbose level logging
255      */
256     public static final boolean VERBOSE = false;
257 
258     /** use TCP socket instead of Rfcomm Socket to develop */
259     public static final boolean USE_TCP_DEBUG = false;
260 
261     /** use simple TCP server started from TestActivity */
262     public static final boolean USE_TCP_SIMPLE_SERVER = false;
263 
264     /** Test TCP socket port */
265     public static final int TCP_DEBUG_PORT = 6500;
266 
267     /** use emulator to debug */
268     public static final boolean USE_EMULATOR_DEBUG = false;
269 
270     public static final int MAX_RECORDS_IN_DATABASE = 1000;
271 
272     public static final int BATCH_STATUS_PENDING = 0;
273 
274     public static final int BATCH_STATUS_RUNNING = 1;
275 
276     public static final int BATCH_STATUS_FINISHED = 2;
277 
278     public static final int BATCH_STATUS_FAILED = 3;
279 
280     public static final String BLUETOOTHOPP_NAME_PREFERENCE = "btopp_names";
281 
282     public static final String BLUETOOTHOPP_CHANNEL_PREFERENCE = "btopp_channels";
283 
284     public static String filename_SEQUENCE_SEPARATOR = "-";
285 
updateShareStatus(Context context, int id, int status)286     public static void updateShareStatus(Context context, int id, int status) {
287         Uri contentUri = Uri.parse(BluetoothShare.CONTENT_URI + "/" + id);
288         ContentValues updateValues = new ContentValues();
289         updateValues.put(BluetoothShare.STATUS, status);
290         context.getContentResolver().update(contentUri, updateValues, null, null);
291         Constants.sendIntentIfCompleted(context, contentUri, status);
292     }
293 
294     /*
295      * This function should be called whenever transfer status change to
296      * completed.
297      */
sendIntentIfCompleted(Context context, Uri contentUri, int status)298     public static void sendIntentIfCompleted(Context context, Uri contentUri, int status) {
299         if (BluetoothShare.isStatusCompleted(status)) {
300             Intent intent = new Intent(BluetoothShare.TRANSFER_COMPLETED_ACTION);
301             intent.setClassName(THIS_PACKAGE_NAME, BluetoothOppReceiver.class.getName());
302             intent.setDataAndNormalize(contentUri);
303             context.sendBroadcast(intent);
304         }
305     }
306 
mimeTypeMatches(String mimeType, String[] matchAgainst)307     public static boolean mimeTypeMatches(String mimeType, String[] matchAgainst) {
308         for (String matchType : matchAgainst) {
309             if (mimeTypeMatches(mimeType, matchType)) {
310                 return true;
311             }
312         }
313         return false;
314     }
315 
mimeTypeMatches(String mimeType, String matchAgainst)316     public static boolean mimeTypeMatches(String mimeType, String matchAgainst) {
317         Pattern p = Pattern.compile(matchAgainst.replaceAll("\\*", "\\.\\*"),
318                 Pattern.CASE_INSENSITIVE);
319         return p.matcher(mimeType).matches();
320     }
321 
logHeader(HeaderSet hs)322     public static void logHeader(HeaderSet hs) {
323         Log.v(TAG, "Dumping HeaderSet " + hs.toString());
324         try {
325 
326             Log.v(TAG, "COUNT : " + hs.getHeader(HeaderSet.COUNT));
327             Log.v(TAG, "NAME : " + hs.getHeader(HeaderSet.NAME));
328             Log.v(TAG, "TYPE : " + hs.getHeader(HeaderSet.TYPE));
329             Log.v(TAG, "LENGTH : " + hs.getHeader(HeaderSet.LENGTH));
330             Log.v(TAG, "TIME_ISO_8601 : " + hs.getHeader(HeaderSet.TIME_ISO_8601));
331             Log.v(TAG, "TIME_4_BYTE : " + hs.getHeader(HeaderSet.TIME_4_BYTE));
332             Log.v(TAG, "DESCRIPTION : " + hs.getHeader(HeaderSet.DESCRIPTION));
333             Log.v(TAG, "TARGET : " + hs.getHeader(HeaderSet.TARGET));
334             Log.v(TAG, "HTTP : " + hs.getHeader(HeaderSet.HTTP));
335             Log.v(TAG, "WHO : " + hs.getHeader(HeaderSet.WHO));
336             Log.v(TAG, "OBJECT_CLASS : " + hs.getHeader(HeaderSet.OBJECT_CLASS));
337             Log.v(TAG, "APPLICATION_PARAMETER : " + hs.getHeader(HeaderSet.APPLICATION_PARAMETER));
338         } catch (IOException e) {
339             Log.e(TAG, "dump HeaderSet error " + e);
340         }
341     }
342 }
343