Source/WebKit2/UIProcess/API/efl/ewk_download_job.cpp

/*
 * Copyright (C) 2012 Intel Corporation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "config.h"
#include "ewk_download_job.h"

#include "DownloadProxy.h"
#include "WKAPICast.h"
#include "WKRetainPtr.h"
#include "WebURLRequest.h"
#include "ewk_download_job_private.h"
#include "ewk_url_response_private.h"
#include <Ecore.h>

using namespace WebKit;

EwkDownloadJob::EwkDownloadJob(WebKit::DownloadProxy* download, EwkViewImpl* viewImpl)
    : m_downloadProxy(download)
    , m_viewImpl(viewImpl)
    , m_state(EWK_DOWNLOAD_JOB_STATE_NOT_STARTED)
    , m_startTime(-1)
    , m_endTime(-1)
    , m_downloaded(0)
{ }

/**
 * @internal
 * Queries the identifier for this download
 */
uint64_t EwkDownloadJob::id() const
{
    return m_downloadProxy->downloadID();
}

/**
 * @internal
 * Returns the view this download is attached to.
 * The view is needed to send notification signals.
 */
EwkViewImpl* EwkDownloadJob::viewImpl() const
{
    return m_viewImpl;
}

Ewk_Download_Job_State ewk_download_job_state_get(const Ewk_Download_Job* download)
{
    EWK_OBJ_GET_IMPL_OR_RETURN(const EwkDownloadJob, download, impl, EWK_DOWNLOAD_JOB_STATE_UNKNOWN);

    return impl->state();
}

Ewk_Download_Job_State EwkDownloadJob::state() const
{
    return m_state;
}

Ewk_Url_Request* ewk_download_job_request_get(const Ewk_Download_Job* download)
{
    EWK_OBJ_GET_IMPL_OR_RETURN(const EwkDownloadJob, download, impl, 0);

    return impl->request();
}

EwkUrlRequest* EwkDownloadJob::request() const
{
    if (!m_request) {
        WKRetainPtr<WKURLRequestRef> wkURLRequest(AdoptWK, toAPI(WebURLRequest::create(m_downloadProxy->request()).leakRef()));
        m_request = EwkUrlRequest::create(wkURLRequest.get());
    }

    return m_request.get();
}

Ewk_Url_Response* ewk_download_job_response_get(const Ewk_Download_Job* download)
{
    EWK_OBJ_GET_IMPL_OR_RETURN(const EwkDownloadJob, download, impl, 0);

    return impl->response();
}

EwkUrlResponse* EwkDownloadJob::response() const
{
    return m_response.get();
}

const char* ewk_download_job_destination_get(const Ewk_Download_Job* download)
{
    EWK_OBJ_GET_IMPL_OR_RETURN(const EwkDownloadJob, download, impl, 0);

    return impl->destination();
}

const char* EwkDownloadJob::destination() const
{
    return m_destination;
}

Eina_Bool ewk_download_job_destination_set(Ewk_Download_Job* download, const char* destination)
{
    EWK_OBJ_GET_IMPL_OR_RETURN(EwkDownloadJob, download, impl, false);
    EINA_SAFETY_ON_NULL_RETURN_VAL(destination, false);

    impl->setDestination(destination);

    return true;
}

void EwkDownloadJob::setDestination(const char* destination)
{
    m_destination = destination;
}

const char* ewk_download_job_suggested_filename_get(const Ewk_Download_Job* download)
{
    EWK_OBJ_GET_IMPL_OR_RETURN(const EwkDownloadJob, download, impl, 0);

    return impl->suggestedFileName();
}

const char* EwkDownloadJob::suggestedFileName() const
{
    return m_suggestedFilename;
}

Eina_Bool ewk_download_job_cancel(Ewk_Download_Job* download)
{
    EWK_OBJ_GET_IMPL_OR_RETURN(EwkDownloadJob, download, impl, false);

    return impl->cancel();
}

bool EwkDownloadJob::cancel()
{
    if (m_state != EWK_DOWNLOAD_JOB_STATE_DOWNLOADING)
        return false;

    m_state = EWK_DOWNLOAD_JOB_STATE_CANCELLING;
    m_downloadProxy->cancel();
    return true;
}

double ewk_download_job_estimated_progress_get(const Ewk_Download_Job* download)
{
    EWK_OBJ_GET_IMPL_OR_RETURN(const EwkDownloadJob, download, impl, 0);

    return impl->estimatedProgress();
}

double EwkDownloadJob::estimatedProgress() const
{
    if (!m_response)
        return 0;

    const unsigned long contentLength = m_response->contentLength();
    if (!contentLength)
        return 0;

    return static_cast<double>(m_downloaded) / contentLength;
}

double ewk_download_job_elapsed_time_get(const Ewk_Download_Job* download)
{
    EWK_OBJ_GET_IMPL_OR_RETURN(const EwkDownloadJob, download, impl, 0);

    return impl->elapsedTime();
}

double EwkDownloadJob::elapsedTime() const
{
    // Download has not started yet.
    if (m_startTime < 0)
        return 0;

    // Download had ended, return the time elapsed between the
    // download start and the end event.
    if (m_endTime >= 0)
        return m_endTime - m_startTime;

    // Download is still going.
    return ecore_time_get() - m_startTime;
}

/**
 * @internal
 * Sets the URL @a response for this @a download.
 */
void EwkDownloadJob::setResponse(PassRefPtr<EwkUrlResponse> response)
{
    ASSERT(response);

    m_response = response;
}

/**
 * @internal
 * Sets the suggested file name for this @a download.
 */
void EwkDownloadJob::setSuggestedFileName(const char* suggestedFilename)
{
    m_suggestedFilename = suggestedFilename;
}

/**
 * @internal
 * Report a given amount of data was received.
 */
void EwkDownloadJob::incrementReceivedData(uint64_t length)
{
    m_downloaded += length;
}

/**
 * @internal
 * Sets the state of the download.
 */
void EwkDownloadJob::setState(Ewk_Download_Job_State state)
{
    m_state = state;

    switch (state) {
    case EWK_DOWNLOAD_JOB_STATE_DOWNLOADING:
        m_startTime = ecore_time_get();
        break;
    case EWK_DOWNLOAD_JOB_STATE_FAILED:
    case EWK_DOWNLOAD_JOB_STATE_CANCELLED:
    case EWK_DOWNLOAD_JOB_STATE_FINISHED:
        m_endTime = ecore_time_get();
        break;
    default:
        break;
    }
}