net/url_request/url_request_ftp_job.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "net/url_request/url_request_ftp_job.h"
   6
   7 #include "base/compiler_specific.h"
   8 #include "base/location.h"
   9 #include "base/single_thread_task_runner.h"
  10 #include "base/strings/utf_string_conversions.h"
  11 #include "base/thread_task_runner_handle.h"
  12 #include "net/base/auth.h"
  13 #include "net/base/host_port_pair.h"
  14 #include "net/base/load_flags.h"
  15 #include "net/base/net_errors.h"
  16 #include "net/base/net_util.h"
  17 #include "net/ftp/ftp_auth_cache.h"
  18 #include "net/ftp/ftp_response_info.h"
  19 #include "net/ftp/ftp_transaction_factory.h"
  20 #include "net/http/http_response_headers.h"
  21 #include "net/http/http_transaction_factory.h"
  22 #include "net/url_request/url_request.h"
  23 #include "net/url_request/url_request_context.h"
  24 #include "net/url_request/url_request_error_job.h"
  25
  26 namespace net {
  27
  28 URLRequestFtpJob::URLRequestFtpJob(
  29     URLRequest* request,
  30     NetworkDelegate* network_delegate,
  31     FtpTransactionFactory* ftp_transaction_factory,
  32     FtpAuthCache* ftp_auth_cache)
  33     : URLRequestJob(request, network_delegate),
  34       priority_(DEFAULT_PRIORITY),
  35       proxy_service_(request_->context()->proxy_service()),
  36       pac_request_(NULL),
  37       http_response_info_(NULL),
  38       read_in_progress_(false),
  39       ftp_transaction_factory_(ftp_transaction_factory),
  40       ftp_auth_cache_(ftp_auth_cache),
  41       weak_factory_(this) {
  42   DCHECK(proxy_service_);
  43   DCHECK(ftp_transaction_factory);
  44   DCHECK(ftp_auth_cache);
  45 }
  46
  47 URLRequestFtpJob::~URLRequestFtpJob() {
  48   if (pac_request_)
  49     proxy_service_->CancelPacRequest(pac_request_);
  50 }
  51
  52 bool URLRequestFtpJob::IsSafeRedirect(const GURL& location) {
  53   // Disallow all redirects.
  54   return false;
  55 }
  56
  57 bool URLRequestFtpJob::GetMimeType(std::string* mime_type) const {
  58   if (proxy_info_.is_direct()) {
  59     if (ftp_transaction_->GetResponseInfo()->is_directory_listing) {
  60       *mime_type = "text/vnd.chromium.ftp-dir";
  61       return true;
  62     }
  63   } else {
  64     // No special handling of MIME type is needed. As opposed to direct FTP
  65     // transaction, we do not get a raw directory listing to parse.
  66     return http_transaction_->GetResponseInfo()->
  67         headers->GetMimeType(mime_type);
  68   }
  69   return false;
  70 }
  71
  72 void URLRequestFtpJob::GetResponseInfo(HttpResponseInfo* info) {
  73   if (http_response_info_)
  74     *info = *http_response_info_;
  75 }
  76
  77 HostPortPair URLRequestFtpJob::GetSocketAddress() const {
  78   if (proxy_info_.is_direct()) {
  79     if (!ftp_transaction_)
  80       return HostPortPair();
  81     return ftp_transaction_->GetResponseInfo()->socket_address;
  82   } else {
  83     if (!http_transaction_)
  84       return HostPortPair();
  85     return http_transaction_->GetResponseInfo()->socket_address;
  86   }
  87 }
  88
  89 void URLRequestFtpJob::SetPriority(RequestPriority priority) {
  90   priority_ = priority;
  91   if (http_transaction_)
  92     http_transaction_->SetPriority(priority);
  93 }
  94
  95 void URLRequestFtpJob::Start() {
  96   DCHECK(!pac_request_);
  97   DCHECK(!ftp_transaction_);
  98   DCHECK(!http_transaction_);
  99
 100   int rv = OK;
 101   if (request_->load_flags() & LOAD_BYPASS_PROXY) {
 102     proxy_info_.UseDirect();
 103   } else {
 104     DCHECK_EQ(request_->context()->proxy_service(), proxy_service_);
 105     rv = proxy_service_->ResolveProxy(
 106         request_->url(),
 107         request_->load_flags(),
 108         &proxy_info_,
 109         base::Bind(&URLRequestFtpJob::OnResolveProxyComplete,
 110                    base::Unretained(this)),
 111         &pac_request_,
 112         NULL,
 113         request_->net_log());
 114
 115     if (rv == ERR_IO_PENDING)
 116       return;
 117   }
 118   OnResolveProxyComplete(rv);
 119 }
 120
 121 void URLRequestFtpJob::Kill() {
 122   if (ftp_transaction_)
 123     ftp_transaction_.reset();
 124   if (http_transaction_)
 125     http_transaction_.reset();
 126   URLRequestJob::Kill();
 127   weak_factory_.InvalidateWeakPtrs();
 128 }
 129
 130 void URLRequestFtpJob::OnResolveProxyComplete(int result) {
 131   pac_request_ = NULL;
 132
 133   if (result != OK) {
 134     OnStartCompletedAsync(result);
 135     return;
 136   }
 137
 138   // Remove unsupported proxies from the list.
 139   proxy_info_.RemoveProxiesWithoutScheme(
 140       ProxyServer::SCHEME_DIRECT |
 141       ProxyServer::SCHEME_HTTP |
 142       ProxyServer::SCHEME_HTTPS);
 143
 144   // TODO(phajdan.jr): Implement proxy fallback, http://crbug.com/171495 .
 145   if (proxy_info_.is_direct())
 146     StartFtpTransaction();
 147   else if (proxy_info_.is_http() || proxy_info_.is_https())
 148     StartHttpTransaction();
 149   else
 150     OnStartCompletedAsync(ERR_NO_SUPPORTED_PROXIES);
 151 }
 152
 153 void URLRequestFtpJob::StartFtpTransaction() {
 154   // Create a transaction.
 155   DCHECK(!ftp_transaction_);
 156
 157   ftp_request_info_.url = request_->url();
 158   ftp_transaction_.reset(ftp_transaction_factory_->CreateTransaction());
 159
 160   // No matter what, we want to report our status as IO pending since we will
 161   // be notifying our consumer asynchronously via OnStartCompleted.
 162   SetStatus(URLRequestStatus(URLRequestStatus::IO_PENDING, 0));
 163   int rv;
 164   if (ftp_transaction_) {
 165     rv = ftp_transaction_->Start(
 166         &ftp_request_info_,
 167         base::Bind(&URLRequestFtpJob::OnStartCompleted,
 168                    base::Unretained(this)),
 169         request_->net_log());
 170     if (rv == ERR_IO_PENDING)
 171       return;
 172   } else {
 173     rv = ERR_FAILED;
 174   }
 175   // The transaction started synchronously, but we need to notify the
 176   // URLRequest delegate via the message loop.
 177   OnStartCompletedAsync(rv);
 178 }
 179
 180 void URLRequestFtpJob::StartHttpTransaction() {
 181   // Create a transaction.
 182   DCHECK(!http_transaction_);
 183
 184   // Do not cache FTP responses sent through HTTP proxy.
 185   request_->SetLoadFlags(request_->load_flags() |
 186                          LOAD_DISABLE_CACHE |
 187                          LOAD_DO_NOT_SAVE_COOKIES |
 188                          LOAD_DO_NOT_SEND_COOKIES);
 189
 190   http_request_info_.url = request_->url();
 191   http_request_info_.method = request_->method();
 192   http_request_info_.load_flags = request_->load_flags();
 193
 194   int rv = request_->context()->http_transaction_factory()->CreateTransaction(
 195       priority_, &http_transaction_);
 196   if (rv == OK) {
 197     rv = http_transaction_->Start(
 198         &http_request_info_,
 199         base::Bind(&URLRequestFtpJob::OnStartCompleted,
 200                   base::Unretained(this)),
 201         request_->net_log());
 202     if (rv == ERR_IO_PENDING)
 203       return;
 204   }
 205   // The transaction started synchronously, but we need to notify the
 206   // URLRequest delegate via the message loop.
 207   OnStartCompletedAsync(rv);
 208 }
 209
 210 void URLRequestFtpJob::OnStartCompleted(int result) {
 211   // Clear the IO_PENDING status
 212   SetStatus(URLRequestStatus());
 213
 214   // Note that ftp_transaction_ may be NULL due to a creation failure.
 215   if (ftp_transaction_) {
 216     // FTP obviously doesn't have HTTP Content-Length header. We have to pass
 217     // the content size information manually.
 218     set_expected_content_size(
 219         ftp_transaction_->GetResponseInfo()->expected_content_size);
 220   }
 221
 222   if (result == OK) {
 223     if (http_transaction_) {
 224       http_response_info_ = http_transaction_->GetResponseInfo();
 225       SetProxyServer(http_response_info_->proxy_server);
 226
 227       if (http_response_info_->headers->response_code() == 401 ||
 228           http_response_info_->headers->response_code() == 407) {
 229         HandleAuthNeededResponse();
 230         return;
 231       }
 232     }
 233     NotifyHeadersComplete();
 234   } else if (ftp_transaction_ &&
 235              ftp_transaction_->GetResponseInfo()->needs_auth) {
 236     HandleAuthNeededResponse();
 237     return;
 238   } else {
 239     NotifyDone(URLRequestStatus(URLRequestStatus::FAILED, result));
 240   }
 241 }
 242
 243 void URLRequestFtpJob::OnStartCompletedAsync(int result) {
 244   base::ThreadTaskRunnerHandle::Get()->PostTask(
 245       FROM_HERE, base::Bind(&URLRequestFtpJob::OnStartCompleted,
 246                             weak_factory_.GetWeakPtr(), result));
 247 }
 248
 249 void URLRequestFtpJob::OnReadCompleted(int result) {
 250   read_in_progress_ = false;
 251   if (result == 0) {
 252     NotifyDone(URLRequestStatus());
 253   } else if (result < 0) {
 254     NotifyDone(URLRequestStatus(URLRequestStatus::FAILED, result));
 255   } else {
 256     // Clear the IO_PENDING status
 257     SetStatus(URLRequestStatus());
 258   }
 259   NotifyReadComplete(result);
 260 }
 261
 262 void URLRequestFtpJob::RestartTransactionWithAuth() {
 263   DCHECK(auth_data_.get() && auth_data_->state == AUTH_STATE_HAVE_AUTH);
 264
 265   // No matter what, we want to report our status as IO pending since we will
 266   // be notifying our consumer asynchronously via OnStartCompleted.
 267   SetStatus(URLRequestStatus(URLRequestStatus::IO_PENDING, 0));
 268
 269   int rv;
 270   if (proxy_info_.is_direct()) {
 271     rv = ftp_transaction_->RestartWithAuth(
 272         auth_data_->credentials,
 273         base::Bind(&URLRequestFtpJob::OnStartCompleted,
 274                    base::Unretained(this)));
 275   } else {
 276     rv = http_transaction_->RestartWithAuth(
 277         auth_data_->credentials,
 278         base::Bind(&URLRequestFtpJob::OnStartCompleted,
 279                    base::Unretained(this)));
 280   }
 281   if (rv == ERR_IO_PENDING)
 282     return;
 283
 284   OnStartCompletedAsync(rv);
 285 }
 286
 287 LoadState URLRequestFtpJob::GetLoadState() const {
 288   if (proxy_info_.is_direct()) {
 289     return ftp_transaction_ ?
 290         ftp_transaction_->GetLoadState() : LOAD_STATE_IDLE;
 291   } else {
 292     return http_transaction_ ?
 293         http_transaction_->GetLoadState() : LOAD_STATE_IDLE;
 294   }
 295 }
 296
 297 bool URLRequestFtpJob::NeedsAuth() {
 298   return auth_data_.get() && auth_data_->state == AUTH_STATE_NEED_AUTH;
 299 }
 300
 301 void URLRequestFtpJob::GetAuthChallengeInfo(
 302     scoped_refptr<AuthChallengeInfo>* result) {
 303   DCHECK(NeedsAuth());
 304
 305   if (http_response_info_) {
 306     *result = http_response_info_->auth_challenge;
 307     return;
 308   }
 309
 310   scoped_refptr<AuthChallengeInfo> auth_info(new AuthChallengeInfo);
 311   auth_info->is_proxy = false;
 312   auth_info->challenger = HostPortPair::FromURL(request_->url());
 313   // scheme and realm are kept empty.
 314   DCHECK(auth_info->scheme.empty());
 315   DCHECK(auth_info->realm.empty());
 316   result->swap(auth_info);
 317 }
 318
 319 void URLRequestFtpJob::SetAuth(const AuthCredentials& credentials) {
 320   DCHECK(ftp_transaction_ || http_transaction_);
 321   DCHECK(NeedsAuth());
 322
 323   auth_data_->state = AUTH_STATE_HAVE_AUTH;
 324   auth_data_->credentials = credentials;
 325
 326   if (ftp_transaction_) {
 327     ftp_auth_cache_->Add(request_->url().GetOrigin(),
 328                          auth_data_->credentials);
 329   }
 330
 331   RestartTransactionWithAuth();
 332 }
 333
 334 void URLRequestFtpJob::CancelAuth() {
 335   DCHECK(ftp_transaction_ || http_transaction_);
 336   DCHECK(NeedsAuth());
 337
 338   auth_data_->state = AUTH_STATE_CANCELED;
 339
 340   // Once the auth is cancelled, we proceed with the request as though
 341   // there were no auth.  Schedule this for later so that we don't cause
 342   // any recursing into the caller as a result of this call.
 343   OnStartCompletedAsync(OK);
 344 }
 345
 346 UploadProgress URLRequestFtpJob::GetUploadProgress() const {
 347   return UploadProgress();
 348 }
 349
 350 bool URLRequestFtpJob::ReadRawData(IOBuffer* buf,
 351                                    int buf_size,
 352                                    int *bytes_read) {
 353   DCHECK_NE(buf_size, 0);
 354   DCHECK(bytes_read);
 355   DCHECK(!read_in_progress_);
 356
 357   int rv;
 358   if (proxy_info_.is_direct()) {
 359     rv = ftp_transaction_->Read(buf, buf_size,
 360                                 base::Bind(&URLRequestFtpJob::OnReadCompleted,
 361                                            base::Unretained(this)));
 362   } else {
 363     rv = http_transaction_->Read(buf, buf_size,
 364                                  base::Bind(&URLRequestFtpJob::OnReadCompleted,
 365                                             base::Unretained(this)));
 366   }
 367
 368   if (rv >= 0) {
 369     *bytes_read = rv;
 370     return true;
 371   }
 372
 373   if (rv == ERR_IO_PENDING) {
 374     read_in_progress_ = true;
 375     SetStatus(URLRequestStatus(URLRequestStatus::IO_PENDING, 0));
 376   } else {
 377     NotifyDone(URLRequestStatus(URLRequestStatus::FAILED, rv));
 378   }
 379   return false;
 380 }
 381
 382 void URLRequestFtpJob::HandleAuthNeededResponse() {
 383   GURL origin = request_->url().GetOrigin();
 384
 385   if (auth_data_.get()) {
 386     if (auth_data_->state == AUTH_STATE_CANCELED) {
 387       NotifyHeadersComplete();
 388       return;
 389     }
 390
 391     if (ftp_transaction_ && auth_data_->state == AUTH_STATE_HAVE_AUTH)
 392       ftp_auth_cache_->Remove(origin, auth_data_->credentials);
 393   } else {
 394     auth_data_ = new AuthData;
 395   }
 396   auth_data_->state = AUTH_STATE_NEED_AUTH;
 397
 398   FtpAuthCache::Entry* cached_auth = NULL;
 399   if (ftp_transaction_ && ftp_transaction_->GetResponseInfo()->needs_auth)
 400     cached_auth = ftp_auth_cache_->Lookup(origin);
 401   if (cached_auth) {
 402     // Retry using cached auth data.
 403     SetAuth(cached_auth->credentials);
 404   } else {
 405     // Prompt for a username/password.
 406     NotifyHeadersComplete();
 407   }
 408 }
 409
 410 }  // namespace net