BluetoothOppObexServerSession.java revision 9abe9c9e1ccad600b1069490293d78dfd984017b
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) { 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 try { 184 boolean pre_reject = false; 185 request = op.getReceivedHeader(); 186 if (V) Constants.logHeader(request); 187 name = (String)request.getHeader(HeaderSet.NAME); 188 length = (Long)request.getHeader(HeaderSet.LENGTH); 189 mimeType = (String)request.getHeader(HeaderSet.TYPE); 190 191 if (length == 0) { 192 if (D) Log.w(TAG, "length is 0, reject the transfer"); 193 pre_reject = true; 194 obexResponse = ResponseCodes.OBEX_HTTP_LENGTH_REQUIRED; 195 } 196 197 if (name == null || name.equals("")) { 198 if (D) Log.w(TAG, "name is null or empty, reject the transfer"); 199 pre_reject = true; 200 obexResponse = ResponseCodes.OBEX_HTTP_BAD_REQUEST; 201 } 202 203 if (!pre_reject) { 204 /* first we look for Mimetype in Android map */ 205 String extension, type; 206 int dotIndex = name.lastIndexOf("."); 207 if (dotIndex < 0) { 208 if (D) Log.w(TAG, "There is no file extension, reject the transfer"); 209 pre_reject = true; 210 obexResponse = ResponseCodes.OBEX_HTTP_BAD_REQUEST; 211 } else { 212 extension = name.substring(dotIndex + 1).toLowerCase(); 213 MimeTypeMap map = MimeTypeMap.getSingleton(); 214 type = map.getMimeTypeFromExtension(extension); 215 if (V) Log.v(TAG, "Mimetype guessed from extension " + extension + " is " + type); 216 if (type != null) { 217 mimeType = type; 218 219 } else { 220 if (mimeType == null) { 221 if (D) Log.w(TAG, "Can't get mimetype, reject the transfer"); 222 pre_reject = true; 223 obexResponse = ResponseCodes.OBEX_HTTP_UNSUPPORTED_TYPE; 224 } 225 } 226 if (mimeType != null) { 227 mimeType = mimeType.toLowerCase(); 228 } 229 } 230 } 231 232 // Reject policy: anything outside the "white list" plus unspecified 233 // MIME Types. Also reject everything in the "black list". 234 if (!pre_reject 235 && (mimeType == null 236 || !Constants.mimeTypeMatches(mimeType, 237 Constants.ACCEPTABLE_SHARE_INBOUND_TYPES) 238 || Constants.mimeTypeMatches(mimeType, 239 Constants.UNACCEPTABLE_SHARE_INBOUND_TYPES))) { 240 if (D) Log.w(TAG, "mimeType is null or in unacceptable list, reject the transfer"); 241 pre_reject = true; 242 obexResponse = ResponseCodes.OBEX_HTTP_UNSUPPORTED_TYPE; 243 } 244 245 if (pre_reject && obexResponse != ResponseCodes.OBEX_HTTP_OK) { 246 // some bad implemented client won't send disconnect 247 return obexResponse; 248 } 249 250 } catch (IOException e) { 251 Log.e(TAG, "get getReceivedHeaders error " + e); 252 return ResponseCodes.OBEX_HTTP_BAD_REQUEST; 253 } 254 255 ContentValues values = new ContentValues(); 256 257 values.put(BluetoothShare.FILENAME_HINT, name); 258 values.put(BluetoothShare.TOTAL_BYTES, length.intValue()); 259 values.put(BluetoothShare.MIMETYPE, mimeType); 260 261 if (mTransport instanceof BluetoothOppRfcommTransport) { 262 String a = ((BluetoothOppRfcommTransport)mTransport).getRemoteAddress(); 263 values.put(BluetoothShare.DESTINATION, a); 264 } else { 265 values.put(BluetoothShare.DESTINATION, "FF:FF:FF:00:00:00"); 266 } 267 268 values.put(BluetoothShare.DIRECTION, BluetoothShare.DIRECTION_INBOUND); 269 values.put(BluetoothShare.TIMESTAMP, mTimestamp); 270 271 boolean needConfirm = true; 272 /** It's not first put if !serverBlocking, so we auto accept it */ 273 if (!mServerBlocking) { 274 values.put(BluetoothShare.USER_CONFIRMATION, 275 BluetoothShare.USER_CONFIRMATION_AUTO_CONFIRMED); 276 needConfirm = false; 277 } 278 279 Uri contentUri = mContext.getContentResolver().insert(BluetoothShare.CONTENT_URI, values); 280 mLocalShareInfoId = Integer.parseInt(contentUri.getPathSegments().get(1)); 281 282 if (needConfirm) { 283 Intent in = new Intent(BluetoothShare.INCOMING_FILE_CONFIRMATION_REQUEST_ACTION); 284 in.setClassName(Constants.THIS_PACKAGE_NAME, BluetoothOppReceiver.class.getName()); 285 mContext.sendBroadcast(in); 286 } 287 288 if (V) Log.v(TAG, "insert contentUri: " + contentUri); 289 if (V) Log.v(TAG, "mLocalShareInfoId = " + mLocalShareInfoId); 290 291 if (V) Log.v(TAG, "acquire partial WakeLock"); 292 293 294 synchronized (this) { 295 if (mWakeLock.isHeld()) { 296 mPartialWakeLock.acquire(); 297 mWakeLock.release(); 298 } 299 mServerBlocking = true; 300 try { 301 302 while (mServerBlocking) { 303 wait(1000); 304 if (mCallback != null && !mTimeoutMsgSent) { 305 mCallback.sendMessageDelayed(mCallback 306 .obtainMessage(BluetoothOppObexSession.MSG_CONNECT_TIMEOUT), 307 BluetoothOppObexSession.SESSION_TIMEOUT); 308 mTimeoutMsgSent = true; 309 if (V) Log.v(TAG, "MSG_CONNECT_TIMEOUT sent"); 310 } 311 } 312 } catch (InterruptedException e) { 313 if (V) Log.v(TAG, "Interrupted in onPut blocking"); 314 } 315 } 316 if (D) Log.d(TAG, "Server unblocked "); 317 synchronized (this) { 318 if (mCallback != null && mTimeoutMsgSent) { 319 mCallback.removeMessages(BluetoothOppObexSession.MSG_CONNECT_TIMEOUT); 320 } 321 } 322 323 /* we should have mInfo now */ 324 325 /* 326 * TODO check if this mInfo match the one that we insert before server 327 * blocking? just to make sure no error happens 328 */ 329 if (mInfo.mId != mLocalShareInfoId) { 330 Log.e(TAG, "Unexpected error!"); 331 } 332 mAccepted = mInfo.mConfirm; 333 334 if (V) Log.v(TAG, "after confirm: userAccepted=" + mAccepted); 335 int status = BluetoothShare.STATUS_SUCCESS; 336 337 if (mAccepted == BluetoothShare.USER_CONFIRMATION_CONFIRMED 338 || mAccepted == BluetoothShare.USER_CONFIRMATION_AUTO_CONFIRMED) { 339 /* Confirm or auto-confirm */ 340 341 if (mFileInfo.mFileName == null) { 342 status = mFileInfo.mStatus; 343 /* TODO need to check if this line is correct */ 344 mInfo.mStatus = mFileInfo.mStatus; 345 Constants.updateShareStatus(mContext, mInfo.mId, status); 346 obexResponse = ResponseCodes.OBEX_HTTP_INTERNAL_ERROR; 347 348 } 349 350 if (mFileInfo.mFileName != null) { 351 352 ContentValues updateValues = new ContentValues(); 353 contentUri = Uri.parse(BluetoothShare.CONTENT_URI + "/" + mInfo.mId); 354 updateValues.put(BluetoothShare._DATA, mFileInfo.mFileName); 355 updateValues.put(BluetoothShare.STATUS, BluetoothShare.STATUS_RUNNING); 356 mContext.getContentResolver().update(contentUri, updateValues, null, null); 357 358 status = receiveFile(mFileInfo, op); 359 /* 360 * TODO map status to obex response code 361 */ 362 if (status != BluetoothShare.STATUS_SUCCESS) { 363 obexResponse = ResponseCodes.OBEX_HTTP_INTERNAL_ERROR; 364 } 365 Constants.updateShareStatus(mContext, mInfo.mId, status); 366 } 367 368 if (status == BluetoothShare.STATUS_SUCCESS) { 369 Message msg = Message.obtain(mCallback, BluetoothOppObexSession.MSG_SHARE_COMPLETE); 370 msg.obj = mInfo; 371 msg.sendToTarget(); 372 } else { 373 if (mCallback != null) { 374 Message msg = Message.obtain(mCallback, 375 BluetoothOppObexSession.MSG_SESSION_ERROR); 376 mInfo.mStatus = status; 377 msg.obj = mInfo; 378 msg.sendToTarget(); 379 } 380 } 381 } else if (mAccepted == BluetoothShare.USER_CONFIRMATION_DENIED 382 || mAccepted == BluetoothShare.USER_CONFIRMATION_TIMEOUT) { 383 /* user actively deny the inbound transfer */ 384 /* 385 * Note There is a question: what's next if user deny the first obj? 386 * Option 1 :continue prompt for next objects 387 * Option 2 :reject next objects and finish the session 388 * Now we take option 2: 389 */ 390 391 Log.i(TAG, "Rejected incoming request"); 392 if (mFileInfo.mFileName != null) { 393 try { 394 mFileInfo.mOutputStream.close(); 395 } catch (IOException e) { 396 Log.e(TAG, "error close file stream"); 397 } 398 new File(mFileInfo.mFileName).delete(); 399 } 400 // set status as local cancel 401 status = BluetoothShare.STATUS_CANCELED; 402 Constants.updateShareStatus(mContext, mInfo.mId, status); 403 obexResponse = ResponseCodes.OBEX_HTTP_FORBIDDEN; 404 405 Message msg = Message.obtain(mCallback); 406 msg.what = BluetoothOppObexSession.MSG_SHARE_INTERRUPTED; 407 mInfo.mStatus = status; 408 msg.obj = mInfo; 409 msg.sendToTarget(); 410 } 411 return obexResponse; 412 } 413 414 private int receiveFile(BluetoothOppReceiveFileInfo fileInfo, Operation op) { 415 /* 416 * implement receive file 417 */ 418 int status = -1; 419 BufferedOutputStream bos = null; 420 421 InputStream is = null; 422 boolean error = false; 423 try { 424 is = op.openInputStream(); 425 } catch (IOException e1) { 426 Log.e(TAG, "Error when openInputStream"); 427 status = BluetoothShare.STATUS_OBEX_DATA_ERROR; 428 error = true; 429 } 430 431 Uri contentUri = Uri.parse(BluetoothShare.CONTENT_URI + "/" + mInfo.mId); 432 433 if (!error) { 434 ContentValues updateValues = new ContentValues(); 435 updateValues.put(BluetoothShare._DATA, fileInfo.mFileName); 436 mContext.getContentResolver().update(contentUri, updateValues, null, null); 437 } 438 439 int position = 0; 440 if (!error) { 441 bos = new BufferedOutputStream(fileInfo.mOutputStream, 0x10000); 442 } 443 444 if (!error) { 445 int outputBufferSize = op.getMaxPacketSize(); 446 byte[] b = new byte[outputBufferSize]; 447 int readLength = 0; 448 long timestamp = 0; 449 try { 450 while ((!mInterrupted) && (position != fileInfo.mLength)) { 451 452 if (V) timestamp = System.currentTimeMillis(); 453 454 readLength = is.read(b); 455 456 if (readLength == -1) { 457 if (D) Log.d(TAG, "Receive file reached stream end at position" + position); 458 break; 459 } 460 461 bos.write(b, 0, readLength); 462 position += readLength; 463 464 if (V) { 465 Log.v(TAG, "Receive file position = " + position + " readLength " 466 + readLength + " bytes took " 467 + (System.currentTimeMillis() - timestamp) + " ms"); 468 } 469 470 ContentValues updateValues = new ContentValues(); 471 updateValues.put(BluetoothShare.CURRENT_BYTES, position); 472 mContext.getContentResolver().update(contentUri, updateValues, null, null); 473 } 474 } catch (IOException e1) { 475 Log.e(TAG, "Error when receiving file"); 476 /* OBEX Abort packet received from remote device */ 477 if ("Abort Received".equals(e1.getMessage())) { 478 status = BluetoothShare.STATUS_CANCELED; 479 } else { 480 status = BluetoothShare.STATUS_OBEX_DATA_ERROR; 481 } 482 error = true; 483 } 484 } 485 486 if (mInterrupted) { 487 if (D) Log.d(TAG, "receiving file interrupted by user."); 488 status = BluetoothShare.STATUS_CANCELED; 489 } else { 490 if (position == fileInfo.mLength) { 491 if (D) Log.d(TAG, "Receiving file completed for " + fileInfo.mFileName); 492 status = BluetoothShare.STATUS_SUCCESS; 493 } else { 494 if (D) Log.d(TAG, "Reading file failed at " + position + " of " + fileInfo.mLength); 495 if (status == -1) { 496 status = BluetoothShare.STATUS_UNKNOWN_ERROR; 497 } 498 } 499 } 500 501 if (bos != null) { 502 try { 503 bos.close(); 504 } catch (IOException e) { 505 Log.e(TAG, "Error when closing stream after send"); 506 } 507 } 508 return status; 509 } 510 511 private BluetoothOppReceiveFileInfo processShareInfo() { 512 if (D) Log.d(TAG, "processShareInfo() " + mInfo.mId); 513 BluetoothOppReceiveFileInfo fileInfo = BluetoothOppReceiveFileInfo.generateFileInfo( 514 mContext, mInfo.mId); 515 if (V) { 516 Log.v(TAG, "Generate BluetoothOppReceiveFileInfo:"); 517 Log.v(TAG, "filename :" + fileInfo.mFileName); 518 Log.v(TAG, "length :" + fileInfo.mLength); 519 Log.v(TAG, "status :" + fileInfo.mStatus); 520 } 521 return fileInfo; 522 } 523 524 @Override 525 public int onConnect(HeaderSet request, HeaderSet reply) { 526 527 if (D) Log.d(TAG, "onConnect"); 528 if (V) Constants.logHeader(request); 529 try { 530 byte[] uuid = (byte[])request.getHeader(HeaderSet.TARGET); 531 if (V) Log.v(TAG, "onConnect(): uuid =" + Arrays.toString(uuid)); 532 if(uuid != null) { 533 reply.setHeader(HeaderSet.WHO, uuid); 534 } 535 } catch (IOException e) { 536 Log.e(TAG, e.toString()); 537 return ResponseCodes.OBEX_HTTP_INTERNAL_ERROR; 538 } 539 mTimestamp = System.currentTimeMillis(); 540 return ResponseCodes.OBEX_HTTP_OK; 541 } 542 543 @Override 544 public void onDisconnect(HeaderSet req, HeaderSet resp) { 545 if (D) Log.d(TAG, "onDisconnect"); 546 resp.responseCode = ResponseCodes.OBEX_HTTP_OK; 547 } 548 549 private synchronized void releaseWakeLocks() { 550 if (mWakeLock.isHeld()) { 551 mWakeLock.release(); 552 } 553 if (mPartialWakeLock.isHeld()) { 554 mPartialWakeLock.release(); 555 } 556 } 557 558 @Override 559 public void onClose() { 560 if (V) Log.v(TAG, "release WakeLock"); 561 releaseWakeLocks(); 562 563 /* onClose could happen even before start() where mCallback is set */ 564 if (mCallback != null) { 565 Message msg = Message.obtain(mCallback); 566 msg.what = BluetoothOppObexSession.MSG_SESSION_COMPLETE; 567 msg.obj = mInfo; 568 msg.sendToTarget(); 569 } 570 } 571} 572