Constants.java revision fd1da115cbf09b7dd9bca3c7d3a4fb816a835dc5 
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
33package com.android.bluetooth.opp;
34
35import java.io.IOException;
36import java.util.regex.Pattern;
37
38import javax.obex.HeaderSet;
39
40import android.content.ContentValues;
41import android.content.Context;
42import android.content.Intent;
43import android.net.Uri;
44import android.util.Log;
45
46/**
47 * Bluetooth OPP internal constants definition
48 */
49public 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.btopp.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.btopp.intent.action.HANDOVER_SEND_MULTIPLE";
90
91    /** intent action used to indicate the progress of a handover transfer */
92    public static final String ACTION_BT_OPP_TRANSFER_PROGRESS =
93            "android.btopp.intent.action.BT_OPP_TRANSFER_PROGRESS";
94
95    /** intent action used to indicate the completion of a handover transfer */
96    public static final String ACTION_BT_OPP_TRANSFER_DONE =
97            "android.btopp.intent.action.BT_OPP_TRANSFER_DONE";
98
99    /** intent extra used to indicate the success of a handover transfer */
100    public static final String EXTRA_BT_OPP_TRANSFER_STATUS =
101            "android.btopp.intent.extra.BT_OPP_TRANSFER_STATUS";
102
103    /** intent extra used to indicate the address associated with the transfer */
104    public static final String EXTRA_BT_OPP_ADDRESS =
105            "android.btopp.intent.extra.BT_OPP_ADDRESS";
106
107    public static final int HANDOVER_TRANSFER_STATUS_SUCCESS = 0;
108
109    public static final int HANDOVER_TRANSFER_STATUS_FAILURE = 1;
110
111    /** intent extra used to indicate the direction of a handover transfer */
112    public static final String EXTRA_BT_OPP_TRANSFER_DIRECTION =
113            "android.btopp.intent.extra.BT_OPP_TRANSFER_DIRECTION";
114
115    public static final int DIRECTION_BLUETOOTH_INCOMING = 0;
116
117    public static final int DIRECTION_BLUETOOTH_OUTGOING = 1;
118
119    /** intent extra used to provide a unique ID for the transfer */
120    public static final String EXTRA_BT_OPP_TRANSFER_ID =
121            "android.btopp.intent.extra.BT_OPP_TRANSFER_ID";
122
123    /** intent extra used to provide progress of the transfer */
124    public static final String EXTRA_BT_OPP_TRANSFER_PROGRESS =
125            "android.btopp.intent.extra.BT_OPP_TRANSFER_PROGRESS";
126
127    /** intent extra used to provide the Uri where the data was stored
128     * by the handover transfer */
129    public static final String EXTRA_BT_OPP_TRANSFER_URI =
130            "android.btopp.intent.extra.BT_OPP_TRANSFER_URI";
131
132    /** intent extra used to provide the mime-type of the data in
133     *  the handover transfer */
134    public static final String EXTRA_BT_OPP_TRANSFER_MIMETYPE =
135            "android.btopp.intent.extra.BT_OPP_TRANSFER_MIMETYPE";
136
137    /** permission needed to be able to receive handover status requests */
138    public static final String HANDOVER_STATUS_PERMISSION =
139            "com.android.permission.HANDOVER_STATUS";
140
141    /** intent extra that indicates this transfer is a handover from another
142      * transport (NFC, WIFI)
143      */
144    public static final String EXTRA_CONNECTION_HANDOVER =
145            "com.android.intent.extra.CONNECTION_HANDOVER";
146
147    /**
148     * the intent that gets sent when deleting the incoming file confirmation
149     * notification
150     */
151    public static final String ACTION_HIDE = "android.btopp.intent.action.HIDE";
152
153    /**
154     * the intent that gets sent when deleting the notifications of outbound and
155     * inbound completed transfer
156     */
157    public static final String ACTION_COMPLETE_HIDE = "android.btopp.intent.action.HIDE_COMPLETE";
158
159    /**
160     * the intent that gets sent when clicking a incoming file confirm
161     * notification
162     */
163    public static final String ACTION_INCOMING_FILE_CONFIRM = "android.btopp.intent.action.CONFIRM";
164
165    public static final String THIS_PACKAGE_NAME = "com.android.bluetooth";
166
167    /**
168     * The column that is used to remember whether the media scanner was invoked
169     */
170    public static final String MEDIA_SCANNED = "scanned";
171
172    public static final int MEDIA_SCANNED_NOT_SCANNED = 0;
173
174    public static final int MEDIA_SCANNED_SCANNED_OK = 1;
175
176    public static final int MEDIA_SCANNED_SCANNED_FAILED = 2;
177
178    /**
179     * The MIME type(s) of we could share to other device.
180     */
181    /*
182     * TODO: define correct type list
183     */
184    public static final String[] ACCEPTABLE_SHARE_OUTBOUND_TYPES = new String[] {
185        "image/*", "text/x-vcard",
186    };
187
188    /**
189     * The MIME type(s) of we could not share to other device. TODO: define
190     * correct type list
191     */
192    public static final String[] UNACCEPTABLE_SHARE_OUTBOUND_TYPES = new String[] {
193        "virus/*",
194    };
195
196    /**
197     * The MIME type(s) of we could accept from other device.
198     * This is in essence a "white list" of acceptable types.
199     * Today, restricted to images, audio, video and certain text types.
200     */
201    public static final String[] ACCEPTABLE_SHARE_INBOUND_TYPES = new String[] {
202        "image/*",
203        "video/*",
204        "audio/*",
205        "text/x-vcard",
206        "text/plain",
207        "text/html",
208        "application/zip",
209        "application/vnd.ms-excel",
210        "application/msword",
211        "application/vnd.ms-powerpoint",
212        "application/pdf",
213    };
214
215    /**
216     * The MIME type(s) of we could not accept from other device. TODO: define
217     * correct type list
218     */
219    public static final String[] UNACCEPTABLE_SHARE_INBOUND_TYPES = new String[] {
220        "text/x-vcalendar",
221    };
222
223    /** Where we store Bluetooth received files on the external storage */
224    public static final String DEFAULT_STORE_SUBDIR = "/bluetooth";
225
226    /**
227     * Debug level logging
228     */
229    public static final boolean DEBUG = true;
230
231    /**
232     * Verbose level logging
233     */
234    public static final boolean VERBOSE = false;
235
236    /** use TCP socket instead of Rfcomm Socket to develop */
237    public static final boolean USE_TCP_DEBUG = false;
238
239    /** use simple TCP server started from TestActivity */
240    public static final boolean USE_TCP_SIMPLE_SERVER = false;
241
242    /** Test TCP socket port */
243    public static final int TCP_DEBUG_PORT = 6500;
244
245    /** use emulator to debug */
246    public static final boolean USE_EMULATOR_DEBUG = false;
247
248    public static final int MAX_RECORDS_IN_DATABASE = 1000;
249
250    public static final int BATCH_STATUS_PENDING = 0;
251
252    public static final int BATCH_STATUS_RUNNING = 1;
253
254    public static final int BATCH_STATUS_FINISHED = 2;
255
256    public static final int BATCH_STATUS_FAILED = 3;
257
258    public static final String BLUETOOTHOPP_NAME_PREFERENCE = "btopp_names";
259
260    public static final String BLUETOOTHOPP_CHANNEL_PREFERENCE = "btopp_channels";
261
262    public static String filename_SEQUENCE_SEPARATOR = "-";
263
264    public static void updateShareStatus(Context context, int id, int status) {
265        Uri contentUri = Uri.parse(BluetoothShare.CONTENT_URI + "/" + id);
266        ContentValues updateValues = new ContentValues();
267        updateValues.put(BluetoothShare.STATUS, status);
268        context.getContentResolver().update(contentUri, updateValues, null, null);
269        Constants.sendIntentIfCompleted(context, contentUri, status);
270    }
271
272    /*
273     * This function should be called whenever transfer status change to
274     * completed.
275     */
276    public static void sendIntentIfCompleted(Context context, Uri contentUri, int status) {
277        if (BluetoothShare.isStatusCompleted(status)) {
278            Intent intent = new Intent(BluetoothShare.TRANSFER_COMPLETED_ACTION);
279            intent.setClassName(THIS_PACKAGE_NAME, BluetoothOppReceiver.class.getName());
280            intent.setData(contentUri);
281            context.sendBroadcast(intent);
282        }
283    }
284
285    public static boolean mimeTypeMatches(String mimeType, String[] matchAgainst) {
286        for (String matchType : matchAgainst) {
287            if (mimeTypeMatches(mimeType, matchType)) {
288                return true;
289            }
290        }
291        return false;
292    }
293
294    public static boolean mimeTypeMatches(String mimeType, String matchAgainst) {
295        Pattern p = Pattern.compile(matchAgainst.replaceAll("\\*", "\\.\\*"),
296                Pattern.CASE_INSENSITIVE);
297        return p.matcher(mimeType).matches();
298    }
299
300    public static void logHeader(HeaderSet hs) {
301        Log.v(TAG, "Dumping HeaderSet " + hs.toString());
302        try {
303
304            Log.v(TAG, "COUNT : " + hs.getHeader(HeaderSet.COUNT));
305            Log.v(TAG, "NAME : " + hs.getHeader(HeaderSet.NAME));
306            Log.v(TAG, "TYPE : " + hs.getHeader(HeaderSet.TYPE));
307            Log.v(TAG, "LENGTH : " + hs.getHeader(HeaderSet.LENGTH));
308            Log.v(TAG, "TIME_ISO_8601 : " + hs.getHeader(HeaderSet.TIME_ISO_8601));
309            Log.v(TAG, "TIME_4_BYTE : " + hs.getHeader(HeaderSet.TIME_4_BYTE));
310            Log.v(TAG, "DESCRIPTION : " + hs.getHeader(HeaderSet.DESCRIPTION));
311            Log.v(TAG, "TARGET : " + hs.getHeader(HeaderSet.TARGET));
312            Log.v(TAG, "HTTP : " + hs.getHeader(HeaderSet.HTTP));
313            Log.v(TAG, "WHO : " + hs.getHeader(HeaderSet.WHO));
314            Log.v(TAG, "OBJECT_CLASS : " + hs.getHeader(HeaderSet.OBJECT_CLASS));
315            Log.v(TAG, "APPLICATION_PARAMETER : " + hs.getHeader(HeaderSet.APPLICATION_PARAMETER));
316        } catch (IOException e) {
317            Log.e(TAG, "dump HeaderSet error " + e);
318        }
319    }
320}
321