BluetoothOppObexServerSession.java revision 01b3991ff968cbc8300fdaf42bbe3f5614ac4c56
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.BufferedOutputStream; 36import java.io.File; 37import java.io.IOException; 38import java.io.InputStream; 39import java.util.Arrays; 40 41import android.content.ContentValues; 42import android.content.Context; 43import android.content.Intent; 44import android.net.Uri; 45import android.os.Handler; 46import android.os.Message; 47import android.os.PowerManager; 48import android.os.PowerManager.WakeLock; 49import android.util.Log; 50import android.webkit.MimeTypeMap; 51 52import javax.obex.HeaderSet; 53import javax.obex.ObexTransport; 54import javax.obex.Operation; 55import javax.obex.ResponseCodes; 56import javax.obex.ServerRequestHandler; 57import javax.obex.ServerSession; 58 59/** 60 * This class runs as an OBEX server 61 */ 62public class BluetoothOppObexServerSession extends ServerRequestHandler implements 63 BluetoothOppObexSession { 64 65 private static final String TAG = "BtOppObexServer"; 66 private static final boolean D = Constants.DEBUG; 67 private static final boolean V = Constants.VERBOSE; 68 69 private ObexTransport mTransport; 70 71 private Context mContext; 72 73 private Handler mCallback = null; 74 75 /* status when server is blocking for user/auto confirmation */ 76 private boolean mServerBlocking = true; 77 78 /* the current transfer info */ 79 private BluetoothOppShareInfo mInfo; 80 81 /* info id when we insert the record */ 82 private int mLocalShareInfoId; 83 84 private int mAccepted = BluetoothShare.USER_CONFIRMATION_PENDING; 85 86 private boolean mInterrupted = false; 87 88 private ServerSession mSession; 89 90 private long mTimestamp; 91 92 private BluetoothOppReceiveFileInfo mFileInfo; 93 94 private WakeLock mWakeLock; 95 96 private WakeLock mPartialWakeLock; 97 98 boolean mTimeoutMsgSent = false; 99 100 public BluetoothOppObexServerSession(Context context, ObexTransport transport) { 101 mContext = context; 102 mTransport = transport; 103 PowerManager pm = (PowerManager)mContext.getSystemService(Context.POWER_SERVICE); 104 mWakeLock = pm.newWakeLock(PowerManager.FULL_WAKE_LOCK | PowerManager.ACQUIRE_CAUSES_WAKEUP 105 | PowerManager.ON_AFTER_RELEASE, TAG); 106 mPartialWakeLock = pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, TAG); 107 } 108 109 public void unblock() { 110 mServerBlocking = false; 111 } 112 113 /** 114 * Called when connection is accepted from remote, to retrieve the first 115 * Header then wait for user confirmation 116 */ 117 public void preStart() { 118 if (D) Log.d(TAG, "acquire full WakeLock"); 119 mWakeLock.acquire(); 120 try { 121 if (D) Log.d(TAG, "Create ServerSession with transport " + mTransport.toString()); 122 mSession = new ServerSession(mTransport, this, null); 123 } catch (IOException e) { 124 Log.e(TAG, "Create server session error" + e); 125 } 126 } 127 128 /** 129 * Called from BluetoothOppTransfer to start the "Transfer" 130 */ 131 public void start(Handler handler, int numShares) { 132 if (D) Log.d(TAG, "Start!"); 133 mCallback = handler; 134 135 } 136 137 /** 138 * Called from BluetoothOppTransfer to cancel the "Transfer" Otherwise, 139 * server should end by itself. 140 */ 141 public void stop() { 142 /* 143 * TODO now we implement in a tough way, just close the socket. 144 * maybe need nice way 145 */ 146 if (D) Log.d(TAG, "Stop!"); 147 mInterrupted = true; 148 if (mSession != null) { 149 try { 150 mSession.close(); 151 mTransport.close(); 152 } catch (IOException e) { 153 Log.e(TAG, "close mTransport error" + e); 154 } 155 } 156 mCallback = null; 157 mSession = null; 158 } 159 160 public void addShare(BluetoothOppShareInfo info) { 161 if (D) Log.d(TAG, "addShare for id " + info.mId); 162 mInfo = info; 163 mFileInfo = processShareInfo(); 164 } 165 166 @Override 167 public int onPut(Operation op) { 168 if (D) Log.d(TAG, "onPut " + op.toString()); 169 HeaderSet request; 170 String name, mimeType; 171 Long length; 172 173 int obexResponse = ResponseCodes.OBEX_HTTP_OK; 174 175 /** 176 * For multiple objects, reject further objects after user deny the 177 * first one 178 */ 179 if (mAccepted == BluetoothShare.USER_CONFIRMATION_DENIED) { 180 return ResponseCodes.OBEX_HTTP_FORBIDDEN; 181 } 182 183 String destination; 184 if (mTransport instanceof BluetoothOppRfcommTransport) { 185 destination = ((BluetoothOppRfcommTransport)mTransport).getRemoteAddress(); 186 } else { 187 destination = "FF:FF:FF:00:00:00"; 188 } 189 boolean isWhitelisted = BluetoothOppManager.getInstance(mContext). 190 isWhitelisted(destination); 191 192 try { 193 boolean pre_reject = false; 194 195 request = op.getReceivedHeader(); 196 if (V) Constants.logHeader(request); 197 name = (String)request.getHeader(HeaderSet.NAME); 198 length = (Long)request.getHeader(HeaderSet.LENGTH); 199 mimeType = (String)request.getHeader(HeaderSet.TYPE); 200 201 if (length == 0) { 202 if (D) Log.w(TAG, "length is 0, reject the transfer"); 203 pre_reject = true; 204 obexResponse = ResponseCodes.OBEX_HTTP_LENGTH_REQUIRED; 205 } 206 207 if (name == null || name.equals("")) { 208 if (D) Log.w(TAG, "name is null or empty, reject the transfer"); 209 pre_reject = true; 210 obexResponse = ResponseCodes.OBEX_HTTP_BAD_REQUEST; 211 } 212 213 if (!pre_reject) { 214 /* first we look for Mimetype in Android map */ 215 String extension, type; 216 int dotIndex = name.lastIndexOf("."); 217 if (dotIndex < 0 && mimeType == null) { 218 if (D) Log.w(TAG, "There is no file extension or mime type," + 219 "reject the transfer"); 220 pre_reject = true; 221 obexResponse = ResponseCodes.OBEX_HTTP_BAD_REQUEST; 222 } else { 223 extension = name.substring(dotIndex + 1).toLowerCase(); 224 MimeTypeMap map = MimeTypeMap.getSingleton(); 225 type = map.getMimeTypeFromExtension(extension); 226 if (V) Log.v(TAG, "Mimetype guessed from extension " + extension + " is " + type); 227 if (type != null) { 228 mimeType = type; 229 230 } else { 231 if (mimeType == null) { 232 if (D) Log.w(TAG, "Can't get mimetype, reject the transfer"); 233 pre_reject = true; 234 obexResponse = ResponseCodes.OBEX_HTTP_UNSUPPORTED_TYPE; 235 } 236 } 237 if (mimeType != null) { 238 mimeType = mimeType.toLowerCase(); 239 } 240 } 241 } 242 243 // Reject policy: anything outside the "white list" plus unspecified 244 // MIME Types. Also reject everything in the "black list". 245 if (!pre_reject 246 && (mimeType == null 247 || (!isWhitelisted && !Constants.mimeTypeMatches(mimeType, 248 Constants.ACCEPTABLE_SHARE_INBOUND_TYPES)) 249 || Constants.mimeTypeMatches(mimeType, 250 Constants.UNACCEPTABLE_SHARE_INBOUND_TYPES))) { 251 if (D) Log.w(TAG, "mimeType is null or in unacceptable list, reject the transfer"); 252 pre_reject = true; 253 obexResponse = ResponseCodes.OBEX_HTTP_UNSUPPORTED_TYPE; 254 } 255 256 if (pre_reject && obexResponse != ResponseCodes.OBEX_HTTP_OK) { 257 // some bad implemented client won't send disconnect 258 return obexResponse; 259 } 260 261 } catch (IOException e) { 262 Log.e(TAG, "get getReceivedHeaders error " + e); 263 return ResponseCodes.OBEX_HTTP_BAD_REQUEST; 264 } 265 266 ContentValues values = new ContentValues(); 267 268 values.put(BluetoothShare.FILENAME_HINT, name); 269 values.put(BluetoothShare.TOTAL_BYTES, length.intValue()); 270 values.put(BluetoothShare.MIMETYPE, mimeType); 271 272 values.put(BluetoothShare.DESTINATION, destination); 273 274 values.put(BluetoothShare.DIRECTION, BluetoothShare.DIRECTION_INBOUND); 275 values.put(BluetoothShare.TIMESTAMP, mTimestamp); 276 277 boolean needConfirm = true; 278 /** It's not first put if !serverBlocking, so we auto accept it */ 279 if (!mServerBlocking && (mAccepted == BluetoothShare.USER_CONFIRMATION_CONFIRMED || 280 mAccepted == BluetoothShare.USER_CONFIRMATION_AUTO_CONFIRMED)) { 281 values.put(BluetoothShare.USER_CONFIRMATION, 282 BluetoothShare.USER_CONFIRMATION_AUTO_CONFIRMED); 283 needConfirm = false; 284 } 285 286 if (isWhitelisted) { 287 values.put(BluetoothShare.USER_CONFIRMATION, 288 BluetoothShare.USER_CONFIRMATION_HANDOVER_CONFIRMED); 289 needConfirm = false; 290 291 } 292 293 Uri contentUri = mContext.getContentResolver().insert(BluetoothShare.CONTENT_URI, values); 294 mLocalShareInfoId = Integer.parseInt(contentUri.getPathSegments().get(1)); 295 296 if (needConfirm) { 297 Intent in = new Intent(BluetoothShare.INCOMING_FILE_CONFIRMATION_REQUEST_ACTION); 298 in.setClassName(Constants.THIS_PACKAGE_NAME, BluetoothOppReceiver.class.getName()); 299 mContext.sendBroadcast(in); 300 } 301 302 if (V) Log.v(TAG, "insert contentUri: " + contentUri); 303 if (V) Log.v(TAG, "mLocalShareInfoId = " + mLocalShareInfoId); 304 305 if (V) Log.v(TAG, "acquire partial WakeLock"); 306 307 308 synchronized (this) { 309 if (mWakeLock.isHeld()) { 310 mPartialWakeLock.acquire(); 311 mWakeLock.release(); 312 } 313 mServerBlocking = true; 314 try { 315 316 while (mServerBlocking) { 317 wait(1000); 318 if (mCallback != null && !mTimeoutMsgSent) { 319 mCallback.sendMessageDelayed(mCallback 320 .obtainMessage(BluetoothOppObexSession.MSG_CONNECT_TIMEOUT), 321 BluetoothOppObexSession.SESSION_TIMEOUT); 322 mTimeoutMsgSent = true; 323 if (V) Log.v(TAG, "MSG_CONNECT_TIMEOUT sent"); 324 } 325 } 326 } catch (InterruptedException e) { 327 if (V) Log.v(TAG, "Interrupted in onPut blocking"); 328 } 329 } 330 if (D) Log.d(TAG, "Server unblocked "); 331 synchronized (this) { 332 if (mCallback != null && mTimeoutMsgSent) { 333 mCallback.removeMessages(BluetoothOppObexSession.MSG_CONNECT_TIMEOUT); 334 } 335 } 336 337 /* we should have mInfo now */ 338 339 /* 340 * TODO check if this mInfo match the one that we insert before server 341 * blocking? just to make sure no error happens 342 */ 343 if (mInfo.mId != mLocalShareInfoId) { 344 Log.e(TAG, "Unexpected error!"); 345 } 346 mAccepted = mInfo.mConfirm; 347 348 if (V) Log.v(TAG, "after confirm: userAccepted=" + mAccepted); 349 int status = BluetoothShare.STATUS_SUCCESS; 350 351 if (mAccepted == BluetoothShare.USER_CONFIRMATION_CONFIRMED 352 || mAccepted == BluetoothShare.USER_CONFIRMATION_AUTO_CONFIRMED 353 || mAccepted == BluetoothShare.USER_CONFIRMATION_HANDOVER_CONFIRMED) { 354 /* Confirm or auto-confirm */ 355 356 if (mFileInfo.mFileName == null) { 357 status = mFileInfo.mStatus; 358 /* TODO need to check if this line is correct */ 359 mInfo.mStatus = mFileInfo.mStatus; 360 Constants.updateShareStatus(mContext, mInfo.mId, status); 361 obexResponse = ResponseCodes.OBEX_HTTP_INTERNAL_ERROR; 362 363 } 364 365 if (mFileInfo.mFileName != null) { 366 367 ContentValues updateValues = new ContentValues(); 368 contentUri = Uri.parse(BluetoothShare.CONTENT_URI + "/" + mInfo.mId); 369 updateValues.put(BluetoothShare._DATA, mFileInfo.mFileName); 370 updateValues.put(BluetoothShare.STATUS, BluetoothShare.STATUS_RUNNING); 371 mContext.getContentResolver().update(contentUri, updateValues, null, null); 372 373 status = receiveFile(mFileInfo, op); 374 /* 375 * TODO map status to obex response code 376 */ 377 if (status != BluetoothShare.STATUS_SUCCESS) { 378 obexResponse = ResponseCodes.OBEX_HTTP_INTERNAL_ERROR; 379 } 380 Constants.updateShareStatus(mContext, mInfo.mId, status); 381 } 382 383 if (status == BluetoothShare.STATUS_SUCCESS) { 384 Message msg = Message.obtain(mCallback, BluetoothOppObexSession.MSG_SHARE_COMPLETE); 385 msg.obj = mInfo; 386 msg.sendToTarget(); 387 } else { 388 if (mCallback != null) { 389 Message msg = Message.obtain(mCallback, 390 BluetoothOppObexSession.MSG_SESSION_ERROR); 391 mInfo.mStatus = status; 392 msg.obj = mInfo; 393 msg.sendToTarget(); 394 } 395 } 396 } else if (mAccepted == BluetoothShare.USER_CONFIRMATION_DENIED 397 || mAccepted == BluetoothShare.USER_CONFIRMATION_TIMEOUT) { 398 /* user actively deny the inbound transfer */ 399 /* 400 * Note There is a question: what's next if user deny the first obj? 401 * Option 1 :continue prompt for next objects 402 * Option 2 :reject next objects and finish the session 403 * Now we take option 2: 404 */ 405 406 Log.i(TAG, "Rejected incoming request"); 407 if (mFileInfo.mFileName != null) { 408 try { 409 mFileInfo.mOutputStream.close(); 410 } catch (IOException e) { 411 Log.e(TAG, "error close file stream"); 412 } 413 new File(mFileInfo.mFileName).delete(); 414 } 415 // set status as local cancel 416 status = BluetoothShare.STATUS_CANCELED; 417 Constants.updateShareStatus(mContext, mInfo.mId, status); 418 obexResponse = ResponseCodes.OBEX_HTTP_FORBIDDEN; 419 420 Message msg = Message.obtain(mCallback); 421 msg.what = BluetoothOppObexSession.MSG_SHARE_INTERRUPTED; 422 mInfo.mStatus = status; 423 msg.obj = mInfo; 424 msg.sendToTarget(); 425 } 426 return obexResponse; 427 } 428 429 private int receiveFile(BluetoothOppReceiveFileInfo fileInfo, Operation op) { 430 /* 431 * implement receive file 432 */ 433 int status = -1; 434 BufferedOutputStream bos = null; 435 436 InputStream is = null; 437 boolean error = false; 438 try { 439 is = op.openInputStream(); 440 } catch (IOException e1) { 441 Log.e(TAG, "Error when openInputStream"); 442 status = BluetoothShare.STATUS_OBEX_DATA_ERROR; 443 error = true; 444 } 445 446 Uri contentUri = Uri.parse(BluetoothShare.CONTENT_URI + "/" + mInfo.mId); 447 448 if (!error) { 449 ContentValues updateValues = new ContentValues(); 450 updateValues.put(BluetoothShare._DATA, fileInfo.mFileName); 451 mContext.getContentResolver().update(contentUri, updateValues, null, null); 452 } 453 454 int position = 0; 455 if (!error) { 456 bos = new BufferedOutputStream(fileInfo.mOutputStream, 0x10000); 457 } 458 459 if (!error) { 460 int outputBufferSize = op.getMaxPacketSize(); 461 byte[] b = new byte[outputBufferSize]; 462 int readLength = 0; 463 long timestamp = 0; 464 try { 465 while ((!mInterrupted) && (position != fileInfo.mLength)) { 466 467 if (V) timestamp = System.currentTimeMillis(); 468 469 readLength = is.read(b); 470 471 if (readLength == -1) { 472 if (D) Log.d(TAG, "Receive file reached stream end at position" + position); 473 break; 474 } 475 476 bos.write(b, 0, readLength); 477 position += readLength; 478 479 if (V) { 480 Log.v(TAG, "Receive file position = " + position + " readLength " 481 + readLength + " bytes took " 482 + (System.currentTimeMillis() - timestamp) + " ms"); 483 } 484 485 ContentValues updateValues = new ContentValues(); 486 updateValues.put(BluetoothShare.CURRENT_BYTES, position); 487 mContext.getContentResolver().update(contentUri, updateValues, null, null); 488 } 489 } catch (IOException e1) { 490 Log.e(TAG, "Error when receiving file"); 491 /* OBEX Abort packet received from remote device */ 492 if ("Abort Received".equals(e1.getMessage())) { 493 status = BluetoothShare.STATUS_CANCELED; 494 } else { 495 status = BluetoothShare.STATUS_OBEX_DATA_ERROR; 496 } 497 error = true; 498 } 499 } 500 501 if (mInterrupted) { 502 if (D) Log.d(TAG, "receiving file interrupted by user."); 503 status = BluetoothShare.STATUS_CANCELED; 504 } else { 505 if (position == fileInfo.mLength) { 506 if (D) Log.d(TAG, "Receiving file completed for " + fileInfo.mFileName); 507 status = BluetoothShare.STATUS_SUCCESS; 508 } else { 509 if (D) Log.d(TAG, "Reading file failed at " + position + " of " + fileInfo.mLength); 510 if (status == -1) { 511 status = BluetoothShare.STATUS_UNKNOWN_ERROR; 512 } 513 } 514 } 515 516 if (bos != null) { 517 try { 518 bos.close(); 519 } catch (IOException e) { 520 Log.e(TAG, "Error when closing stream after send"); 521 } 522 } 523 return status; 524 } 525 526 private BluetoothOppReceiveFileInfo processShareInfo() { 527 if (D) Log.d(TAG, "processShareInfo() " + mInfo.mId); 528 BluetoothOppReceiveFileInfo fileInfo = BluetoothOppReceiveFileInfo.generateFileInfo( 529 mContext, mInfo.mId); 530 if (V) { 531 Log.v(TAG, "Generate BluetoothOppReceiveFileInfo:"); 532 Log.v(TAG, "filename :" + fileInfo.mFileName); 533 Log.v(TAG, "length :" + fileInfo.mLength); 534 Log.v(TAG, "status :" + fileInfo.mStatus); 535 } 536 return fileInfo; 537 } 538 539 @Override 540 public int onConnect(HeaderSet request, HeaderSet reply) { 541 542 if (D) Log.d(TAG, "onConnect"); 543 if (V) Constants.logHeader(request); 544 Long objectCount = null; 545 try { 546 byte[] uuid = (byte[])request.getHeader(HeaderSet.TARGET); 547 if (V) Log.v(TAG, "onConnect(): uuid =" + Arrays.toString(uuid)); 548 if(uuid != null) { 549 return ResponseCodes.OBEX_HTTP_NOT_ACCEPTABLE; 550 } 551 552 objectCount = (Long) request.getHeader(HeaderSet.COUNT); 553 } catch (IOException e) { 554 Log.e(TAG, e.toString()); 555 return ResponseCodes.OBEX_HTTP_INTERNAL_ERROR; 556 } 557 String destination; 558 if (mTransport instanceof BluetoothOppRfcommTransport) { 559 destination = ((BluetoothOppRfcommTransport)mTransport).getRemoteAddress(); 560 } else { 561 destination = "FF:FF:FF:00:00:00"; 562 } 563 boolean isHandover = BluetoothOppManager.getInstance(mContext). 564 isWhitelisted(destination); 565 if (isHandover) { 566 // Notify the handover requester file transfer has started 567 Intent intent = new Intent(Constants.ACTION_HANDOVER_STARTED); 568 if (objectCount != null) { 569 intent.putExtra(Constants.EXTRA_BT_OPP_OBJECT_COUNT, objectCount.intValue()); 570 } else { 571 intent.putExtra(Constants.EXTRA_BT_OPP_OBJECT_COUNT, 572 Constants.COUNT_HEADER_UNAVAILABLE); 573 } 574 intent.putExtra(Constants.EXTRA_BT_OPP_ADDRESS, destination); 575 mContext.sendBroadcast(intent, Constants.HANDOVER_STATUS_PERMISSION); 576 } 577 mTimestamp = System.currentTimeMillis(); 578 return ResponseCodes.OBEX_HTTP_OK; 579 } 580 581 @Override 582 public void onDisconnect(HeaderSet req, HeaderSet resp) { 583 if (D) Log.d(TAG, "onDisconnect"); 584 resp.responseCode = ResponseCodes.OBEX_HTTP_OK; 585 } 586 587 private synchronized void releaseWakeLocks() { 588 if (mWakeLock.isHeld()) { 589 mWakeLock.release(); 590 } 591 if (mPartialWakeLock.isHeld()) { 592 mPartialWakeLock.release(); 593 } 594 } 595 596 @Override 597 public void onClose() { 598 if (V) Log.v(TAG, "release WakeLock"); 599 releaseWakeLocks(); 600 601 /* onClose could happen even before start() where mCallback is set */ 602 if (mCallback != null) { 603 Message msg = Message.obtain(mCallback); 604 msg.what = BluetoothOppObexSession.MSG_SESSION_COMPLETE; 605 msg.obj = mInfo; 606 msg.sendToTarget(); 607 } 608 } 609} 610